@squiz/db-lib 1.2.10 → 1.2.12

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.12](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.12) (2022-11-24)
+
+**Note:** Version bump only for package @squiz/db-lib
+
+
+
+
+
+## [1.2.11](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.11) (2022-11-11)
+
+**Note:** Version bump only for package @squiz/db-lib
+
+
+
+
+
 ## [1.2.10](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.10) (2022-11-09)
 
 **Note:** Version bump only for package @squiz/db-lib

package/lib/AbstractRepository.d.ts

@@ -9,15 +9,15 @@ export interface Writer<T> {
     update(where: Partial<T>, newValue: Partial<T>): Promise<T[]>;
     delete(where: Partial<T>): Promise<number>;
 }
-export declare type Repository<T> = Reader<T> & Writer<T>;
-export declare type PageResult<T> = {
+export type Repository<T> = Reader<T> & Writer<T>;
+export type PageResult<T> = {
     items: T[];
     totalCount: number;
     pageSize: number;
 };
-export declare type SortDirection = 'desc' | 'asc';
+export type SortDirection = 'desc' | 'asc';
 export declare const DEFAULT_PAGE_SIZE = 20;
-export declare abstract class AbstractRepository<T, ObjT extends T> implements Reader<T>, Writer<T> {
+export declare abstract class AbstractRepository<T extends object, ObjT extends T> implements Reader<T>, Writer<T> {
     protected repositories: Repositories;
     protected pool: Pool;
     protected classRef: {

package/lib/ConnectionManager.d.ts

@@ -11,7 +11,7 @@ export interface DbConnection {
 export interface ConnectionStringObj {
     connectionString: string;
 }
-export declare type TransactionClient = PoolClient;
+export type TransactionClient = PoolClient;
 export declare class ConnectionManager<T extends Repositories> {
     protected applicationName: string;
     protected migrationDirectory: string;

package/lib/Migrator.d.ts

@@ -6,13 +6,15 @@ export declare class Migrator {
     constructor(migrationDir: string, migrationList: string[], pool: PoolClient);
     protected ensureMigrationTableExists(): Promise<import("pg").QueryResult<any>>;
     protected getAppliedMigrations(): Promise<any[]>;
-    protected applyMigration(migration: string, sql: string): Promise<void>;
+    protected doSqlMigration(migration: string, sql: string): Promise<void>;
     protected getPending(migrationsList: string[], appliedMigrations: string[]): Promise<string[]>;
     protected getSql(migration: string): Promise<string>;
     protected tryToObtainLock(): Promise<boolean>;
     protected releaseLock(): Promise<void>;
     migrate(): Promise<any>;
     protected runMigrations(): Promise<void>;
+    protected doScriptMigration(migration: string): Promise<void>;
     protected runMigration(migration: string): Promise<void>;
+    protected doMigrationWork(migration: string): Promise<void>;
     protected dispose(): void;
 }

package/lib/Repositories.d.ts

@@ -1,2 +1,2 @@
 import { Repository } from './AbstractRepository';
-export declare type Repositories = Record<string, Repository<any>>;
+export type Repositories = Record<string, Repository<any>>;

package/lib/index.js

@@ -3778,7 +3778,7 @@ var require_pg_pool = __commonJS({
           } else {
             this.log("new client connected");
             if (this.options.maxLifetimeSeconds !== 0) {
-              setTimeout(() => {
+              const maxLifetimeTimeout = setTimeout(() => {
                 this.log("ending client due to expired lifetime");
                 this._expired.add(client);
                 const idleIndex = this._idle.findIndex((idleItem) => idleItem.client === client);
@@ -3791,6 +3791,8 @@ var require_pg_pool = __commonJS({
                   );
                 }
               }, this.options.maxLifetimeSeconds * 1e3);
+              maxLifetimeTimeout.unref();
+              client.once("end", () => clearTimeout(maxLifetimeTimeout));
             }
             return this._acquireClient(client, pendingItem, idleListener, true);
           }
@@ -3897,20 +3899,24 @@ var require_pg_pool = __commonJS({
           };
           client.once("error", onError);
           this.log("dispatching query");
-          client.query(text, values, (err2, res) => {
-            this.log("query dispatched");
-            client.removeListener("error", onError);
-            if (clientReleased) {
-              return;
-            }
-            clientReleased = true;
-            client.release(err2);
-            if (err2) {
-              return cb(err2);
-            } else {
+          try {
+            client.query(text, values, (err2, res) => {
+              this.log("query dispatched");
+              client.removeListener("error", onError);
+              if (clientReleased) {
+                return;
+              }
+              clientReleased = true;
+              client.release(err2);
+              if (err2) {
+                return cb(err2);
+              }
               return cb(void 0, res);
-            }
-          });
+            });
+          } catch (err2) {
+            client.release(err2);
+            return cb(err2);
+          }
         });
         return response.result;
       }
@@ -5473,6 +5479,7 @@ var require_combine = __commonJS({
 var require_safe_stable_stringify = __commonJS({
   "../dx-logger-lib/node_modules/safe-stable-stringify/index.js"(exports, module2) {
     "use strict";
+    var { hasOwnProperty } = Object.prototype;
     var stringify = configure();
     stringify.configure = configure;
     stringify.stringify = stringify;
@@ -5481,7 +5488,7 @@ var require_safe_stable_stringify = __commonJS({
     exports.configure = configure;
     module2.exports = stringify;
     var strEscapeSequencesRegExp = /[\u0000-\u001f\u0022\u005c\ud800-\udfff]|[\ud800-\udbff](?![\udc00-\udfff])|(?:[^\ud800-\udbff]|^)[\udc00-\udfff]/;
-    var strEscapeSequencesReplacer = /[\u0000-\u001f\u0022\u005c\ud800-\udfff]|[\ud800-\udbff](?![\udc00-\udfff])|(?:[^\ud800-\udbff]|^)[\udc00-\udfff]/g;
+    var strEscapeSequencesReplacer = new RegExp(strEscapeSequencesRegExp, "g");
     var meta = [
       "\\u0000",
       "\\u0001",
@@ -5601,13 +5608,13 @@ var require_safe_stable_stringify = __commonJS({
           last = i + 1;
         } else if (point >= 55296 && point <= 57343) {
           if (point <= 56319 && i + 1 < str.length) {
-            const point2 = str.charCodeAt(i + 1);
-            if (point2 >= 56320 && point2 <= 57343) {
+            const nextPoint = str.charCodeAt(i + 1);
+            if (nextPoint >= 56320 && nextPoint <= 57343) {
               i++;
               continue;
             }
           }
-          result += `${str.slice(last, i)}${`\\u${point.toString(16)}`}`;
+          result += `${str.slice(last, i)}\\u${point.toString(16)}`;
           last = i + 1;
         }
       }
@@ -5632,7 +5639,7 @@ var require_safe_stable_stringify = __commonJS({
     var typedArrayPrototypeGetSymbolToStringTag = Object.getOwnPropertyDescriptor(
       Object.getPrototypeOf(
         Object.getPrototypeOf(
-          new Uint8Array()
+          new Int8Array()
         )
       ),
       Symbol.toStringTag
@@ -5652,8 +5659,8 @@ var require_safe_stable_stringify = __commonJS({
       return res;
     }
     function getCircularValueOption(options) {
-      if (options && Object.prototype.hasOwnProperty.call(options, "circularValue")) {
-        var circularValue = options.circularValue;
+      if (hasOwnProperty.call(options, "circularValue")) {
+        const circularValue = options.circularValue;
         if (typeof circularValue === "string") {
           return `"${circularValue}"`;
         }
@@ -5672,8 +5679,9 @@ var require_safe_stable_stringify = __commonJS({
       return '"[Circular]"';
     }
     function getBooleanOption(options, key) {
-      if (options && Object.prototype.hasOwnProperty.call(options, key)) {
-        var value = options[key];
+      let value;
+      if (hasOwnProperty.call(options, key)) {
+        value = options[key];
         if (typeof value !== "boolean") {
           throw new TypeError(`The "${key}" argument must be of type boolean`);
         }
@@ -5681,8 +5689,9 @@ var require_safe_stable_stringify = __commonJS({
       return value === void 0 ? true : value;
     }
     function getPositiveIntegerOption(options, key) {
-      if (options && Object.prototype.hasOwnProperty.call(options, key)) {
-        var value = options[key];
+      let value;
+      if (hasOwnProperty.call(options, key)) {
+        value = options[key];
         if (typeof value !== "number") {
           throw new TypeError(`The "${key}" argument must be of type number`);
         }
@@ -5704,15 +5713,39 @@ var require_safe_stable_stringify = __commonJS({
     function getUniqueReplacerSet(replacerArray) {
       const replacerSet = /* @__PURE__ */ new Set();
       for (const value of replacerArray) {
-        if (typeof value === "string") {
-          replacerSet.add(value);
-        } else if (typeof value === "number") {
+        if (typeof value === "string" || typeof value === "number") {
           replacerSet.add(String(value));
         }
       }
       return replacerSet;
     }
+    function getStrictOption(options) {
+      if (hasOwnProperty.call(options, "strict")) {
+        const value = options.strict;
+        if (typeof value !== "boolean") {
+          throw new TypeError('The "strict" argument must be of type boolean');
+        }
+        if (value) {
+          return (value2) => {
+            let message = `Object can not safely be stringified. Received type ${typeof value2}`;
+            if (typeof value2 !== "function")
+              message += ` (${value2.toString()})`;
+            throw new Error(message);
+          };
+        }
+      }
+    }
     function configure(options) {
+      options = { ...options };
+      const fail = getStrictOption(options);
+      if (fail) {
+        if (options.bigint === void 0) {
+          options.bigint = false;
+        }
+        if (!("circularValue" in options)) {
+          options.circularValue = Error;
+        }
+      }
       const circularValue = getCircularValueOption(options);
       const bigint = getBooleanOption(options, "bigint");
       const deterministic = getBooleanOption(options, "deterministic");
@@ -5821,11 +5854,17 @@ ${originalIndentation}`;
             return `{${res}}`;
           }
           case "number":
-            return isFinite(value) ? String(value) : "null";
+            return isFinite(value) ? String(value) : fail ? fail(value) : "null";
           case "boolean":
             return value === true ? "true" : "false";
+          case "undefined":
+            return void 0;
           case "bigint":
-            return bigint ? String(value) : void 0;
+            if (bigint) {
+              return String(value);
+            }
+          default:
+            return fail ? fail(value) : void 0;
         }
       }
       function stringifyArrayReplacer(key, value, stack, replacer, spacer, indentation) {
@@ -5908,11 +5947,17 @@ ${originalIndentation}`;
             return `{${res}}`;
           }
           case "number":
-            return isFinite(value) ? String(value) : "null";
+            return isFinite(value) ? String(value) : fail ? fail(value) : "null";
           case "boolean":
             return value === true ? "true" : "false";
+          case "undefined":
+            return void 0;
           case "bigint":
-            return bigint ? String(value) : void 0;
+            if (bigint) {
+              return String(value);
+            }
+          default:
+            return fail ? fail(value) : void 0;
         }
       }
       function stringifyIndent(key, value, stack, spacer, indentation) {
@@ -6013,11 +6058,17 @@ ${originalIndentation}`;
             return `{${res}}`;
           }
           case "number":
-            return isFinite(value) ? String(value) : "null";
+            return isFinite(value) ? String(value) : fail ? fail(value) : "null";
           case "boolean":
             return value === true ? "true" : "false";
+          case "undefined":
+            return void 0;
           case "bigint":
-            return bigint ? String(value) : void 0;
+            if (bigint) {
+              return String(value);
+            }
+          default:
+            return fail ? fail(value) : void 0;
         }
       }
       function stringifySimple(key, value, stack) {
@@ -6101,11 +6152,17 @@ ${originalIndentation}`;
             return `{${res}}`;
           }
           case "number":
-            return isFinite(value) ? String(value) : "null";
+            return isFinite(value) ? String(value) : fail ? fail(value) : "null";
           case "boolean":
             return value === true ? "true" : "false";
+          case "undefined":
+            return void 0;
           case "bigint":
-            return bigint ? String(value) : void 0;
+            if (bigint) {
+              return String(value);
+            }
+          default:
+            return fail ? fail(value) : void 0;
         }
       }
       function stringify2(value, replacer, space) {
@@ -7679,9 +7736,9 @@ var require_buffer_list = __commonJS({
   }
 });
 
-// ../dx-logger-lib/node_modules/string_decoder/node_modules/safe-buffer/index.js
+// ../dx-logger-lib/node_modules/safe-buffer/index.js
 var require_safe_buffer = __commonJS({
-  "../dx-logger-lib/node_modules/string_decoder/node_modules/safe-buffer/index.js"(exports, module2) {
+  "../dx-logger-lib/node_modules/safe-buffer/index.js"(exports, module2) {
     var buffer = require("buffer");
     var Buffer2 = buffer.Buffer;
     function copyProps(src, dst) {
@@ -15052,7 +15109,7 @@ var require_tslib = __commonJS({
         function step(op) {
           if (f)
             throw new TypeError("Generator is already executing.");
-          while (_)
+          while (g && (g = 0, op[0] && (_ = 0)), _)
             try {
               if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done)
                 return t;
@@ -31175,14 +31232,13 @@ var Migrator = class {
       return row.id;
     });
   }
-  async applyMigration(migration, sql) {
+  async doSqlMigration(migration, sql) {
     try {
       const result = await this.pool.query(sql);
       logger.info("Applying " + migration);
       if (result.rowCount !== void 0) {
         logger.info("affected rows", result.rowCount);
       }
-      await this.pool.query("insert into __migrations__ (id) values ($1)", [migration]);
     } catch (e) {
       logger.info("error occurred running migration", migration, e);
       throw e;
@@ -31252,11 +31308,24 @@ var Migrator = class {
       await this.runMigration(migration);
     }
   }
+  async doScriptMigration(migration) {
+    const migrationScript = import_path.default.join(this.migrationDir, migration);
+    const migrationFunc = require(migrationScript);
+    let callable;
+    if (migrationFunc instanceof Function) {
+      callable = migrationFunc;
+    } else if (migrationFunc.default instanceof Function) {
+      callable = migrationFunc.default;
+    } else {
+      throw new Error(`${migrationScript} isn't callable`);
+    }
+    await callable(this.pool, logger);
+  }
   async runMigration(migration) {
     try {
       await this.pool.query("BEGIN");
-      const sql = await this.getSql(migration);
-      await this.applyMigration(migration, sql);
+      await this.doMigrationWork(migration);
+      await this.pool.query("insert into __migrations__ (id) values ($1)", [migration]);
       await this.pool.query("COMMIT");
     } catch (e) {
       logger.error("migration failed", migration, e);
@@ -31264,6 +31333,16 @@ var Migrator = class {
       throw e;
     }
   }
+  async doMigrationWork(migration) {
+    if (migration.endsWith(".sql")) {
+      const sql = await this.getSql(migration);
+      await this.doSqlMigration(migration, sql);
+    } else if (migration.endsWith(".js")) {
+      await this.doScriptMigration(migration);
+    } else {
+      throw new Error(`${migration} as an invalid migration extension`);
+    }
+  }
   dispose() {
     return this.pool.release();
   }