pgsql-test 2.20.8 → 2.22.0

package/connect.js

@@ -9,6 +9,7 @@ const pgsql_client_1 = require("pgsql-client");
 const admin_1 = require("./admin");
 const manager_1 = require("./manager");
 const seed_1 = require("./seed");
+const utils_1 = require("./utils");
 let manager;
 const getPgRootAdmin = (config, connOpts = {}) => {
     const opts = (0, pg_env_1.getPgEnvOptions)({
@@ -76,9 +77,9 @@ const getConnections = async (cn = {}, seedAdapters = [seed_1.seed.pgpm()]) => {
             });
         }
         catch (error) {
-            const err = error;
-            const msg = err && (err.stack || err.message) ? (err.stack || err.message) : String(err);
-            process.stderr.write(`[pgsql-test] Seed error (continuing): ${msg}\n`);
+            // Format the error with PostgreSQL extended fields for better debugging
+            const formatted = (0, utils_1.formatPgError)(error);
+            process.stderr.write(`[pgsql-test] Seed error (continuing):\n${formatted}\n`);
             // continue without teardown to allow caller-managed lifecycle
         }
     }

package/esm/connect.js

@@ -6,6 +6,7 @@ import { getDefaultRole } from 'pgsql-client';
 import { DbAdmin } from './admin';
 import { PgTestConnector } from './manager';
 import { seed } from './seed';
+import { formatPgError } from './utils';
 let manager;
 export const getPgRootAdmin = (config, connOpts = {}) => {
     const opts = getPgEnvOptions({
@@ -72,9 +73,9 @@ export const getConnections = async (cn = {}, seedAdapters = [seed.pgpm()]) => {
             });
         }
         catch (error) {
-            const err = error;
-            const msg = err && (err.stack || err.message) ? (err.stack || err.message) : String(err);
-            process.stderr.write(`[pgsql-test] Seed error (continuing): ${msg}\n`);
+            // Format the error with PostgreSQL extended fields for better debugging
+            const formatted = formatPgError(error);
+            process.stderr.write(`[pgsql-test] Seed error (continuing):\n${formatted}\n`);
             // continue without teardown to allow caller-managed lifecycle
         }
     }

package/esm/index.js

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

package/esm/test-client.js

@@ -3,9 +3,36 @@ import { insertJsonMap } from 'pgsql-seed';
 import { loadCsvMap } from 'pgsql-seed';
 import { loadSqlFiles } from 'pgsql-seed';
 import { deployPgpm } from 'pgsql-seed';
+import { formatPgError } from './utils';
 export class PgTestClient extends PgClient {
+    testOpts;
     constructor(config, opts = {}) {
         super(config, opts);
+        this.testOpts = opts;
+    }
+    /**
+     * Check if enhanced errors are enabled. Defaults to true.
+     * Can be disabled by setting enhancedErrors: false in options.
+     */
+    shouldEnhanceErrors() {
+        // Default to true unless explicitly disabled via option
+        return this.testOpts.enhancedErrors !== false;
+    }
+    /**
+     * Override query to enhance PostgreSQL errors with extended fields.
+     * When enhancedErrors is enabled, errors will include detail, hint, where, position, etc.
+     */
+    async query(query, values) {
+        try {
+            return await super.query(query, values);
+        }
+        catch (err) {
+            if (this.shouldEnhanceErrors()) {
+                // Enhance the error message with PostgreSQL extended fields
+                err.message = formatPgError(err, { query, values });
+            }
+            throw err;
+        }
     }
     async beforeEach() {
         await this.begin();

package/esm/utils.js

@@ -1,3 +1,24 @@
+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)

package/index.d.ts

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

package/index.js

@@ -14,7 +14,7 @@ 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;
+exports.getErrorCode = exports.snapshot = void 0;
 __exportStar(require("./admin"), exports);
 __exportStar(require("./connect"), exports);
 __exportStar(require("./manager"), exports);
@@ -22,3 +22,4 @@ __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; } });
+Object.defineProperty(exports, "getErrorCode", { enumerable: true, get: function () { return utils_1.getErrorCode; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgsql-test",
-  "version": "2.20.8",
+  "version": "2.22.0",
   "author": "Constructive <developers@constructive.io>",
   "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",
@@ -55,20 +55,21 @@
     "test:watch": "jest --watch"
   },
   "devDependencies": {
+    "@pgpmjs/core": "4.7.1",
     "@types/pg": "^8.16.0",
     "@types/pg-copy-streams": "^1.2.5",
-    "makage": "^0.1.9"
+    "makage": "^0.1.10"
   },
   "dependencies": {
-    "@pgpmjs/env": "^2.9.1",
-    "@pgpmjs/logger": "^1.3.6",
-    "@pgpmjs/server-utils": "^2.8.13",
-    "@pgpmjs/types": "^2.13.0",
+    "@pgpmjs/env": "^2.9.2",
+    "@pgpmjs/logger": "^1.3.7",
+    "@pgpmjs/server-utils": "^2.8.14",
+    "@pgpmjs/types": "^2.14.0",
     "pg": "^8.16.3",
-    "pg-cache": "^1.6.13",
-    "pg-env": "^1.2.4",
-    "pgsql-client": "^1.1.8",
-    "pgsql-seed": "^0.2.10"
+    "pg-cache": "^1.6.14",
+    "pg-env": "^1.2.5",
+    "pgsql-client": "^1.1.10",
+    "pgsql-seed": "^0.2.12"
   },
-  "gitHead": "e53cd1f303d796268d94b47e95cde30916e39c1f"
+  "gitHead": "acb072b93704ad5218dd2c38306680f3750ead09"
 }

package/test-client.d.ts

@@ -2,9 +2,28 @@ import { PgConfig } from 'pg-env';
 import { PgClient, PgClientOpts } from 'pgsql-client';
 import { type JsonSeedMap } from 'pgsql-seed';
 import { type CsvSeedMap } from 'pgsql-seed';
-export type PgTestClientOpts = PgClientOpts;
+import { QueryResult } from 'pg';
+export type PgTestClientOpts = PgClientOpts & {
+    /**
+     * Enable enhanced PostgreSQL error messages with extended fields.
+     * Defaults to true. Errors will include detail, hint, where, position, etc.
+     * Can be disabled by setting enhancedErrors: false.
+     */
+    enhancedErrors?: boolean;
+};
 export declare class PgTestClient extends PgClient {
+    protected testOpts: PgTestClientOpts;
     constructor(config: PgConfig, opts?: PgTestClientOpts);
+    /**
+     * Check if enhanced errors are enabled. Defaults to true.
+     * Can be disabled by setting enhancedErrors: false in options.
+     */
+    private shouldEnhanceErrors;
+    /**
+     * Override query to enhance PostgreSQL errors with extended fields.
+     * When enhancedErrors is enabled, errors will include detail, hint, where, position, etc.
+     */
+    query<T = any>(query: string, values?: any[]): Promise<QueryResult<T>>;
     beforeEach(): Promise<void>;
     afterEach(): Promise<void>;
     /**

package/test-client.js

@@ -6,9 +6,36 @@ const pgsql_seed_1 = require("pgsql-seed");
 const pgsql_seed_2 = require("pgsql-seed");
 const pgsql_seed_3 = require("pgsql-seed");
 const pgsql_seed_4 = require("pgsql-seed");
+const utils_1 = require("./utils");
 class PgTestClient extends pgsql_client_1.PgClient {
+    testOpts;
     constructor(config, opts = {}) {
         super(config, opts);
+        this.testOpts = opts;
+    }
+    /**
+     * Check if enhanced errors are enabled. Defaults to true.
+     * Can be disabled by setting enhancedErrors: false in options.
+     */
+    shouldEnhanceErrors() {
+        // Default to true unless explicitly disabled via option
+        return this.testOpts.enhancedErrors !== false;
+    }
+    /**
+     * Override query to enhance PostgreSQL errors with extended fields.
+     * When enhancedErrors is enabled, errors will include detail, hint, where, position, etc.
+     */
+    async query(query, values) {
+        try {
+            return await super.query(query, values);
+        }
+        catch (err) {
+            if (this.shouldEnhanceErrors()) {
+                // Enhance the error message with PostgreSQL extended fields
+                err.message = (0, utils_1.formatPgError)(err, { query, values });
+            }
+            throw err;
+        }
     }
     async beforeEach() {
         await this.begin();

package/utils.d.ts

@@ -1,3 +1,21 @@
+import { extractPgErrorFields, formatPgErrorFields, formatPgError, type PgErrorFields, type PgErrorContext } from '@pgpmjs/types';
+export { extractPgErrorFields, formatPgErrorFields, formatPgError, type PgErrorFields, type PgErrorContext };
+/**
+ * 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 declare function getErrorCode(message: string): string;
 export type IdHash = Record<string, number | string>;
 type AnyObject = Record<string, any>;
 export declare const pruneDates: (row: AnyObject) => AnyObject;
@@ -14,4 +32,3 @@ export declare const defaultPruners: Pruner[];
 export declare const prune: (row: AnyObject, idHash?: IdHash) => AnyObject;
 export declare const createSnapshot: (pruners: Pruner[]) => (obj: unknown, idHash?: IdHash) => unknown;
 export declare const snapshot: (obj: unknown, idHash?: IdHash) => unknown;
-export {};

package/utils.js

@@ -1,6 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.snapshot = exports.createSnapshot = exports.prune = exports.defaultPruners = exports.composePruners = exports.pruneTokens = exports.prunePeoplestamps = exports.pruneSchemas = exports.pruneHashes = exports.pruneUUIDs = exports.pruneIdArrays = exports.pruneIds = exports.pruneDates = void 0;
+exports.snapshot = exports.createSnapshot = exports.prune = exports.defaultPruners = exports.composePruners = exports.pruneTokens = exports.prunePeoplestamps = exports.pruneSchemas = exports.pruneHashes = exports.pruneUUIDs = exports.pruneIdArrays = exports.pruneIds = exports.pruneDates = exports.formatPgError = exports.formatPgErrorFields = exports.extractPgErrorFields = void 0;
+exports.getErrorCode = getErrorCode;
+const types_1 = require("@pgpmjs/types");
+Object.defineProperty(exports, "extractPgErrorFields", { enumerable: true, get: function () { return types_1.extractPgErrorFields; } });
+Object.defineProperty(exports, "formatPgErrorFields", { enumerable: true, get: function () { return types_1.formatPgErrorFields; } });
+Object.defineProperty(exports, "formatPgError", { enumerable: true, get: function () { return types_1.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"
+ */
+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)