pgsql-test 2.14.10 → 2.14.12

package/README.md

@@ -631,6 +631,44 @@ const { conn, db, teardown } = await getConnections({
 });
 ```
 
+## Snapshot Utilities
+
+The `pgsql-test/utils` module provides utilities for sanitizing database query results for snapshot testing. These helpers replace dynamic values (IDs, UUIDs, dates, hashes) with stable placeholders, making snapshots deterministic.
+
+```ts
+import { snapshot } from 'pgsql-test/utils';
+
+const result = await db.any('SELECT * FROM users');
+expect(snapshot(result)).toMatchSnapshot();
+```
+
+### Available Functions
+
+| Function | Description |
+|----------|-------------|
+| `snapshot(obj)` | Recursively prunes all dynamic values from an object or array |
+| `prune(obj)` | Applies all prune functions to a single object |
+| `pruneDates(obj)` | Replaces `Date` objects and date strings (fields ending in `_at` or `At`) with `[DATE]` |
+| `pruneIds(obj)` | Replaces `id` and `*_id` fields with `[ID]` |
+| `pruneIdArrays(obj)` | Replaces `*_ids` array fields with `[UUIDs-N]` |
+| `pruneUUIDs(obj)` | Replaces UUID strings in `uuid` and `queue_name` fields with `[UUID]` |
+| `pruneHashes(obj)` | Replaces `*_hash` fields starting with `$` with `[hash]` |
+
+### Example
+
+```ts
+import { snapshot, pruneIds, pruneDates } from 'pgsql-test/utils';
+
+// Full sanitization
+const users = await db.any('SELECT * FROM users');
+expect(snapshot(users)).toMatchSnapshot();
+
+// Selective sanitization
+const row = await db.one('SELECT id, name, created_at FROM users WHERE id = $1', [1]);
+const sanitized = pruneDates(pruneIds(row));
+// { id: '[ID]', name: 'Alice', created_at: '[DATE]' }
+```
+
 ---
 
 ## Education and Tutorials

package/esm/index.js

@@ -4,3 +4,4 @@ export * from './manager';
 export * from './roles';
 export * from './seed';
 export * from './test-client';
+export { snapshot } from './utils';

package/esm/utils.js

@@ -0,0 +1,57 @@
+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) => (!v ? v : '[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) => mapValues(row, (v, k) => (k === 'id' || (typeof k === 'string' && k.endsWith('_id'))) &&
+    (typeof v === 'string' || typeof v === 'number')
+    ? idReplacement(v)
+    : 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 prune = (obj) => pruneHashes(pruneUUIDs(pruneIds(pruneIdArrays(pruneDates(obj)))));
+export const snapshot = (obj) => {
+    if (Array.isArray(obj)) {
+        return obj.map(snapshot);
+    }
+    else if (obj && typeof obj === 'object') {
+        return mapValues(prune(obj), snapshot);
+    }
+    return obj;
+};

package/index.d.ts

@@ -4,3 +4,4 @@ export * from './manager';
 export * from './roles';
 export * from './seed';
 export * from './test-client';
+export { snapshot } from './utils';

package/index.js

@@ -14,9 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.snapshot = void 0;
 __exportStar(require("./admin"), exports);
 __exportStar(require("./connect"), exports);
 __exportStar(require("./manager"), exports);
 __exportStar(require("./roles"), exports);
 __exportStar(require("./seed"), exports);
 __exportStar(require("./test-client"), exports);
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "snapshot", { enumerable: true, get: function () { return utils_1.snapshot; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgsql-test",
-  "version": "2.14.10",
+  "version": "2.14.12",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "description": "pgsql-test offers isolated, role-aware, and rollback-friendly PostgreSQL environments for integration tests — giving developers realistic test coverage without external state pollution",
   "main": "index.js",
@@ -57,19 +57,19 @@
   "devDependencies": {
     "@types/pg": "^8.15.2",
     "@types/pg-copy-streams": "^1.2.5",
-    "makage": "^0.1.6"
+    "makage": "^0.1.8"
   },
   "dependencies": {
-    "@launchql/core": "^2.17.4",
-    "@launchql/env": "^2.5.5",
-    "@launchql/logger": "^1.1.11",
-    "@launchql/server-utils": "^2.6.7",
-    "@launchql/types": "^2.8.5",
+    "@launchql/core": "^2.17.6",
+    "@launchql/env": "^2.5.6",
+    "@launchql/logger": "^1.1.12",
+    "@launchql/server-utils": "^2.6.8",
+    "@launchql/types": "^2.8.6",
     "csv-parse": "^6.1.0",
     "pg": "^8.16.0",
-    "pg-cache": "^1.4.7",
+    "pg-cache": "^1.4.8",
     "pg-copy-streams": "^7.0.0",
-    "pg-env": "^1.1.6"
+    "pg-env": "^1.1.7"
   },
-  "gitHead": "e85e82c301d859ff7e2317bf07345156af9ff8d1"
+  "gitHead": "3812f24a480b2035b3413ec7fecfe492f294e590"
 }

package/utils.d.ts

@@ -0,0 +1,9 @@
+type AnyObject = Record<string, any>;
+export declare const pruneDates: (row: AnyObject) => AnyObject;
+export declare const pruneIds: (row: AnyObject) => AnyObject;
+export declare const pruneIdArrays: (row: AnyObject) => AnyObject;
+export declare const pruneUUIDs: (row: AnyObject) => AnyObject;
+export declare const pruneHashes: (row: AnyObject) => AnyObject;
+export declare const prune: (obj: AnyObject) => AnyObject;
+export declare const snapshot: (obj: unknown) => unknown;
+export {};

package/utils.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.snapshot = exports.prune = exports.pruneHashes = exports.pruneUUIDs = exports.pruneIdArrays = exports.pruneIds = exports.pruneDates = void 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) => (!v ? v : '[ID]');
+function mapValues(obj, fn) {
+    return Object.entries(obj).reduce((acc, [key, value]) => {
+        acc[key] = fn(value, key);
+        return acc;
+    }, {});
+}
+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;
+});
+exports.pruneDates = pruneDates;
+const pruneIds = (row) => mapValues(row, (v, k) => (k === 'id' || (typeof k === 'string' && k.endsWith('_id'))) &&
+    (typeof v === 'string' || typeof v === 'number')
+    ? idReplacement(v)
+    : v);
+exports.pruneIds = pruneIds;
+const pruneIdArrays = (row) => mapValues(row, (v, k) => typeof k === 'string' && k.endsWith('_ids') && Array.isArray(v)
+    ? `[UUIDs-${v.length}]`
+    : v);
+exports.pruneIdArrays = pruneIdArrays;
+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;
+});
+exports.pruneUUIDs = pruneUUIDs;
+const pruneHashes = (row) => mapValues(row, (v, k) => typeof k === 'string' &&
+    k.endsWith('_hash') &&
+    typeof v === 'string' &&
+    v.startsWith('$')
+    ? '[hash]'
+    : v);
+exports.pruneHashes = pruneHashes;
+const prune = (obj) => (0, exports.pruneHashes)((0, exports.pruneUUIDs)((0, exports.pruneIds)((0, exports.pruneIdArrays)((0, exports.pruneDates)(obj)))));
+exports.prune = prune;
+const snapshot = (obj) => {
+    if (Array.isArray(obj)) {
+        return obj.map(exports.snapshot);
+    }
+    else if (obj && typeof obj === 'object') {
+        return mapValues((0, exports.prune)(obj), exports.snapshot);
+    }
+    return obj;
+};
+exports.snapshot = snapshot;