pgsql-test/esm/utils.js

pgsql-test offers isolated, role-aware, and rollback-friendly PostgreSQL environments for integration tests — giving developers realistic test coverage without external state pollution

import { extractPgErrorFields, formatPgErrorFields, formatPgError } from '@pgpmjs/types';
// Re-export PostgreSQL error formatting utilities
export { extractPgErrorFields, formatPgErrorFields, formatPgError };
/**
 * Extract the error code from an error message.
 *
 * Enhanced error messages from PgTestClient include additional context on subsequent lines
 * (Where, Query, Values, etc.). This function returns only the first line, which contains
 * the actual error code raised by PostgreSQL.
 *
 * @param message - The error message (may contain multiple lines with debug context)
 * @returns The first line of the error message (the error code)
 *
 * @example
 * // Error message with enhanced context:
 * // "NONEXISTENT_TYPE\nWhere: PL/pgSQL function...\nQuery: INSERT INTO..."
 * getErrorCode(err.message) // => "NONEXISTENT_TYPE"
 */
export function getErrorCode(message) {
    return message.split('\n')[0];
}
const uuidRegexp = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
const idReplacement = (v, idHash) => {
    if (!v)
        return v;
    if (!idHash)
        return '[ID]';
    const key = String(v);
    return idHash[key] !== undefined ? `[ID-${idHash[key]}]` : '[ID]';
};
function mapValues(obj, fn) {
    return Object.entries(obj).reduce((acc, [key, value]) => {
        acc[key] = fn(value, key);
        return acc;
    }, {});
}
export const pruneDates = (row) => mapValues(row, (v, k) => {
    if (!v) {
        return v;
    }
    if (v instanceof Date) {
        return '[DATE]';
    }
    else if (typeof v === 'string' &&
        /(_at|At)$/.test(k) &&
        /^20[0-9]{2}-[0-9]{2}-[0-9]{2}/.test(v)) {
        return '[DATE]';
    }
    return v;
});
export const pruneIds = (row, idHash) => mapValues(row, (v, k) => (k === 'id' || (typeof k === 'string' && k.endsWith('_id'))) &&
    (typeof v === 'string' || typeof v === 'number')
    ? idReplacement(v, idHash)
    : v);
export const pruneIdArrays = (row) => mapValues(row, (v, k) => typeof k === 'string' && k.endsWith('_ids') && Array.isArray(v)
    ? `[UUIDs-${v.length}]`
    : v);
export const pruneUUIDs = (row) => mapValues(row, (v, k) => {
    if (typeof v !== 'string') {
        return v;
    }
    if (['uuid', 'queue_name'].includes(k) && uuidRegexp.test(v)) {
        return '[UUID]';
    }
    if (k === 'gravatar' && /^[0-9a-f]{32}$/i.test(v)) {
        return '[gUUID]';
    }
    return v;
});
export const pruneHashes = (row) => mapValues(row, (v, k) => typeof k === 'string' &&
    k.endsWith('_hash') &&
    typeof v === 'string' &&
    v.startsWith('$')
    ? '[hash]'
    : v);
export const pruneSchemas = (row) => mapValues(row, (v, k) => typeof v === 'string' && /^zz-/.test(v) ? '[schemahash]' : v);
export const prunePeoplestamps = (row) => mapValues(row, (v, k) => k.endsWith('_by') && typeof v === 'string' ? '[peoplestamp]' : v);
export const pruneTokens = (row) => mapValues(row, (v, k) => (k === 'token' || k.endsWith('_token')) && typeof v === 'string'
    ? '[token]'
    : v);
export const composePruners = (...pruners) => (row) => pruners.reduce((acc, pruner) => pruner(acc), row);
// Default pruners used by prune/snapshot (without IdHash)
export const defaultPruners = [
    pruneTokens,
    prunePeoplestamps,
    pruneDates,
    pruneIdArrays,
    pruneUUIDs,
    pruneHashes
];
// Compose pruners and apply pruneIds with IdHash support
export const prune = (row, idHash) => {
    const pruned = composePruners(...defaultPruners)(row);
    return pruneIds(pruned, idHash);
};
// Factory to create a snapshot function with custom pruners
export const createSnapshot = (pruners) => {
    const pruneFn = composePruners(...pruners);
    const snap = (obj, idHash) => {
        if (Array.isArray(obj)) {
            return obj.map((el) => snap(el, idHash));
        }
        else if (obj && typeof obj === 'object') {
            const pruned = pruneFn(obj);
            const prunedWithIds = pruneIds(pruned, idHash);
            return mapValues(prunedWithIds, (v) => snap(v, idHash));
        }
        return obj;
    };
    return snap;
};
export const snapshot = createSnapshot(defaultPruners);