@squiz/db-lib 1.2.1-alpha.107 → 1.2.1-alpha.89

package/CHANGELOG.md

@@ -3,118 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [1.2.1-alpha.107](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.107) (2022-09-21)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.106](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.106) (2022-09-02)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.105](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.105) (2022-08-26)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.104](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.104) (2022-08-23)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.103](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.103) (2022-08-23)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.102](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.102) (2022-08-23)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.101](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.101) (2022-08-19)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.100](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.100) (2022-08-18)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.99](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.99) (2022-08-18)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.98](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.98) (2022-08-17)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.97](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.97) (2022-08-17)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.96](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.96) (2022-08-12)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.95](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.95) (2022-08-10)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
-## [1.2.1-alpha.90](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.89...v1.2.1-alpha.90) (2022-08-05)
-
-**Note:** Version bump only for package @squiz/db-lib
-
-
-
-
-
 ## [1.2.1-alpha.89](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.88...v1.2.1-alpha.89) (2022-08-05)
 
 **Note:** Version bump only for package @squiz/db-lib

package/package.json

@@ -1,36 +1,37 @@
 {
   "name": "@squiz/db-lib",
-  "version": "1.2.1-alpha.107",
+  "version": "1.2.1-alpha.89",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
+    "start": "node ./lib/index.js",
     "compile": "node build.js && npx tsc",
     "lint": "eslint ./src --ext .ts",
-    "test": "jest -c jest.config.ts --passWithNoTests",
+    "test": "echo \"tested in integration\"",
+    "test:integration___": "jest -c jest.config.ts",
     "test:update-snapshots": "jest -c jest.config.ts --updateSnapshot",
     "clean": "rimraf \".tsbuildinfo\" \"./lib\""
   },
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@types/jest": "28.1.8",
+    "@types/jest": "28.1.6",
     "@types/node": "17.0.27",
     "@types/pg": "8.6.5",
-    "esbuild": "0.15.6",
-    "eslint": "8.22.0",
+    "esbuild": "0.14.49",
+    "eslint": "8.18.0",
     "fs-extra": "10.1.0",
     "jest": "28.1.3",
     "rimraf": "3.0.2",
-    "ts-jest": "28.0.8",
+    "ts-jest": "28.0.5",
     "ts-loader": "9.3.1",
-    "ts-node": "10.9.1",
+    "ts-node": "10.8.1",
     "typescript": "4.7.4"
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "3.121.0",
-    "@squiz/dx-logger-lib": "^1.2.1-alpha.107",
+    "@aws-sdk/client-secrets-manager": "^3.121.0",
     "dotenv": "16.0.1",
-    "pg": "8.7.3"
+    "pg": "^8.7.3"
   },
-  "gitHead": "dc09e24c89b0f6d6afd23e958523cf9c9add89ec"
+  "gitHead": "d42ff3393c6e336ee05519872dbb58112ef045d1"
 }

package/src/AbstractRepository.ts

@@ -14,46 +14,34 @@ export interface Writer<T> {
 
 export type Repository<T> = Reader<T> & Writer<T>;
 
-export type PageResult<T> = {
-  items: T[];
-  totalCount: number;
-  pageSize: number;
-};
-
-export type SortDirection = 'desc' | 'asc';
-export const DEFAULT_PAGE_SIZE = 20;
-
-export abstract class AbstractRepository<T, ObjT extends T> implements Reader<T>, Writer<T> {
+export abstract class AbstractRepository<T> implements Reader<T>, Writer<T> {
   protected tableName: string;
 
-  /** object where the key is the model property name amd the value is sql column name */
   protected modelPropertyToSqlColumn: { [key in keyof T]: string };
-  /** object where the key is the sql column name and the value is the model property name */
-  protected sqlColumnToModelProperty: { [key: string]: string };
+  protected sqlColumnToModelProperty: { [key: string]: keyof T };
 
   constructor(
     protected repositories: Repositories,
     protected pool: Pool,
     tableName: string,
     mapping: { [key in keyof T]: string },
-    protected classRef: { new (data?: Record<string, unknown>): ObjT },
+    protected classRef: { new (): T },
   ) {
     this.tableName = `"${tableName}"`;
 
     this.modelPropertyToSqlColumn = mapping;
-
     this.sqlColumnToModelProperty = Object.entries(mapping).reduce((prev, curr) => {
-      const [modelProp, columnName] = curr as [string, string];
+      const [modelProp, columnName] = curr as [keyof T, string];
       prev[columnName] = modelProp;
       return prev;
-    }, {} as { [key: string]: string });
+    }, {} as { [key: string]: keyof T });
   }
 
   protected async getConnection(): Promise<PoolClient> {
     return await this.pool.connect();
   }
 
-  async create(value: ObjT, transactionClient: PoolClient | null = null): Promise<T> {
+  async create(value: Partial<T>, transactionClient: PoolClient | null = null): Promise<T> {
     const columns = Object.keys(value)
       .map((a) => `"${this.modelPropertyToSqlColumn[a as keyof T]}"`)
       .join(', ');
@@ -125,16 +113,16 @@ export abstract class AbstractRepository<T, ObjT extends T> implements Reader<T>
     return sql;
   }
 
-  protected async executeQueryRaw(
+  protected async executeQuery(
     query: string,
     values: any[],
     transactionClient: PoolClient | null = null,
-  ): Promise<any[]> {
+  ): Promise<T[]> {
     const client = transactionClient ?? (await this.getConnection());
     try {
       const result = await client.query(query, values);
 
-      return result.rows;
+      return result.rows.map((a) => this.createAndHydrateModel(a));
     } finally {
       if (client && !transactionClient) {
         client.release();
@@ -142,24 +130,14 @@ export abstract class AbstractRepository<T, ObjT extends T> implements Reader<T>
     }
   }
 
-  protected async executeQuery(
-    query: string,
-    values: any[],
-    transactionClient: PoolClient | null = null,
-  ): Promise<T[]> {
-    const rows = await this.executeQueryRaw(query, values, transactionClient);
-    return rows.map((a) => this.createAndHydrateModel(a));
-  }
-
   protected createAndHydrateModel(row: any): T {
-    const inputData: Record<string, unknown> = {};
+    const model = new this.classRef();
 
     for (const key of Object.keys(row)) {
-      const translatedKey = this.sqlColumnToModelProperty[key];
-      inputData[translatedKey] = row[key];
+      model[this.sqlColumnToModelProperty[key]] = row[key];
     }
 
-    return new this.classRef(inputData);
+    return model;
   }
 
   async findOne(item: Partial<T>): Promise<T | undefined> {
@@ -194,61 +172,4 @@ export abstract class AbstractRepository<T, ObjT extends T> implements Reader<T>
 
     return result;
   }
-
-  async getCount(item: Partial<T> | null = null): Promise<number> {
-    let whereClause = '';
-    if (item) {
-      whereClause = `WHERE ${this.createWhereStringFromPartialModel(item)}`;
-    }
-    const result = await this.executeQueryRaw(
-      `SELECT count(*)
-      FROM ${this.tableName} ${whereClause}`,
-      item ? Object.values(item) : [],
-    );
-    return parseInt(result[0].count);
-  }
-
-  async getPage(
-    pageNumber: number,
-    sortBy: (keyof T)[] = [],
-    direction: SortDirection = 'asc',
-    pageSize: number | null = null,
-    item: Partial<T> | null = null,
-  ): Promise<PageResult<T>> {
-    if (pageSize === null) {
-      pageSize = DEFAULT_PAGE_SIZE;
-    }
-    if (pageNumber <= 0) {
-      throw new Error(`Page number value cannot be less than 1`);
-    }
-    if (pageSize <= 0) {
-      throw new Error(`Page size value cannot be less than 1`);
-    }
-    let whereClause = '';
-    if (item) {
-      whereClause = `WHERE ${this.createWhereStringFromPartialModel(item)}`;
-    }
-
-    let orderByClause = '';
-    if (sortBy.length) {
-      orderByClause = `ORDER BY ${sortBy
-        .map((a) => this.modelPropertyToSqlColumn[a as keyof T])
-        .join(',')} ${direction}`;
-    }
-    const offset = (pageNumber - 1) * pageSize;
-
-    const items = await this.executeQuery(
-      `SELECT *
-      FROM ${this.tableName} ${whereClause} ${orderByClause}
-      OFFSET ${offset}
-      LIMIT ${pageSize}`,
-      item ? Object.values(item) : [],
-    );
-
-    return {
-      items,
-      totalCount: await this.getCount(item),
-      pageSize,
-    };
-  }
 }

package/src/Migrator.ts

@@ -1,15 +1,11 @@
 import fs from 'fs/promises';
 import { PoolClient } from 'pg';
 import path from 'path';
-import os from 'os';
-import { getLogger } from '@squiz/dx-logger-lib';
 
 // Be carful about changing this value. This needs to be consistent across deployments
 // this ID is used to signal other running instances that a migration is executing.
 const MIGRATION_ADVISORY_LOCK = 4569465;
 
-const logger = getLogger({ name: 'db-migrator', meta: { pid: process.pid, hostname: os.hostname() } });
-
 export class Migrator {
   constructor(protected migrationDir: string, protected migrationList: string[], protected pool: PoolClient) {}
 
@@ -29,15 +25,15 @@ export class Migrator {
   protected async applyMigration(migration: string, sql: string) {
     try {
       const result = await this.pool.query(sql);
-      logger.info('Applying ' + migration);
+      console.log(process.pid, 'Applying ' + migration);
 
       if (result.rowCount !== undefined) {
-        logger.info('affected rows', result.rowCount);
+        console.log(process.pid, '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);
+      console.log(process.pid, 'error occurred running migration', migration, e);
       throw e;
     }
   }
@@ -83,18 +79,18 @@ export class Migrator {
       const lockObtained = await this.tryToObtainLock();
 
       if (lockObtained === false) {
-        logger.info('migration already running');
+        console.log(process.pid, 'migration already running');
         await sleep(500);
         return await this.migrate();
       }
 
       await this.runMigrations();
-      logger.info('completed migration');
+      console.log(process.pid, 'completed migration');
       await this.releaseLock();
 
       this.dispose();
     } catch (e) {
-      logger.info('migration failed releasing lock');
+      console.log(process.pid, 'migration failed releasing lock');
       await this.releaseLock();
       throw e;
     }
@@ -105,11 +101,11 @@ export class Migrator {
     const pending = await this.getPending(this.migrationList, appliedMigrations);
 
     if (pending.length === 0) {
-      logger.info('No pending migrations');
+      console.log(process.pid, 'No pending migrations');
       return;
     }
 
-    logger.info('Pending migrations:\n\t', pending.join('\n\t'));
+    console.log(process.pid, 'Pending migrations:\n\t', pending.join('\n\t'));
 
     for (const migration of pending) {
       await this.runMigration(migration);
@@ -125,7 +121,7 @@ export class Migrator {
 
       await this.pool.query('COMMIT');
     } catch (e) {
-      logger.error('migration failed', migration, e);
+      console.log(process.pid, 'migration failed', migration, e);
       await this.pool.query('ROLLBACK');
       throw e;
     }

package/src/index.ts

@@ -3,8 +3,3 @@ export * from './ConnectionManager';
 export * from './Migrator';
 export * from './Repositories';
 export * from './getConnectionInfo';
-
-// Postgres
-export * from './PostgresErrorCodes';
-
-export { Pool } from 'pg';

package/tsconfig.json

@@ -7,11 +7,7 @@
     "emitDeclarationOnly": true,
     "rootDir": "./src"
   },
-  "references": [
-    {
-      "path": "../dx-logger-lib"
-    }
-  ],
+  "references": [],
   "include": ["src/**/*.ts", "src/**/*.json"],
   "exclude": ["jest.config.ts"]
 }

package/lib/AbstractRepository.d.ts

@@ -1,53 +0,0 @@
-import { PoolClient, Pool } from 'pg';
-import { Repositories } from './Repositories';
-export interface Reader<T> {
-    find(item: Partial<T>): Promise<T[]>;
-    findOne(id: string | Partial<T>): Promise<T | undefined>;
-}
-export interface Writer<T> {
-    create(value: Partial<T>): Promise<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> = {
-    items: T[];
-    totalCount: number;
-    pageSize: number;
-};
-export declare 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> {
-    protected repositories: Repositories;
-    protected pool: Pool;
-    protected classRef: {
-        new (data?: Record<string, unknown>): ObjT;
-    };
-    protected tableName: string;
-    /** object where the key is the model property name amd the value is sql column name */
-    protected modelPropertyToSqlColumn: {
-        [key in keyof T]: string;
-    };
-    /** object where the key is the sql column name and the value is the model property name */
-    protected sqlColumnToModelProperty: {
-        [key: string]: string;
-    };
-    constructor(repositories: Repositories, pool: Pool, tableName: string, mapping: {
-        [key in keyof T]: string;
-    }, classRef: {
-        new (data?: Record<string, unknown>): ObjT;
-    });
-    protected getConnection(): Promise<PoolClient>;
-    create(value: ObjT, transactionClient?: PoolClient | null): Promise<T>;
-    update(where: Partial<T>, newValue: Partial<T>, transactionClient?: PoolClient | null): Promise<T[]>;
-    delete(where: Partial<T>, transactionClient?: PoolClient | null): Promise<number>;
-    protected createWhereStringFromPartialModel(values: Partial<T>, initialIndex?: number): string;
-    protected executeQueryRaw(query: string, values: any[], transactionClient?: PoolClient | null): Promise<any[]>;
-    protected executeQuery(query: string, values: any[], transactionClient?: PoolClient | null): Promise<T[]>;
-    protected createAndHydrateModel(row: any): T;
-    findOne(item: Partial<T>): Promise<T | undefined>;
-    find(item: Partial<T>): Promise<T[]>;
-    findAll(): Promise<T[]>;
-    getCount(item?: Partial<T> | null): Promise<number>;
-    getPage(pageNumber: number, sortBy?: (keyof T)[], direction?: SortDirection, pageSize?: number | null, item?: Partial<T> | null): Promise<PageResult<T>>;
-}

package/lib/ConnectionManager.d.ts

@@ -1,25 +0,0 @@
-import { Pool } from 'pg';
-import { PoolClient } from 'pg';
-import { Repositories } from './Repositories';
-export interface DbConnection {
-    user: string;
-    password: string;
-    host: string;
-    port: number;
-    database: string;
-}
-export interface ConnectionStringObj {
-    connectionString: string;
-}
-export declare type TransactionClient = PoolClient;
-export declare class ConnectionManager<T extends Repositories> {
-    protected applicationName: string;
-    protected migrationDirectory: string;
-    protected migrationList: string[];
-    readonly pool: Pool;
-    readonly repositories: T;
-    constructor(applicationName: string, connection: string | DbConnection, migrationDirectory: string, migrationList: string[], repositoryCreator: (dbManager: ConnectionManager<T>) => T);
-    applyMigrations(): Promise<void>;
-    close(): Promise<void>;
-    executeInTransaction<T>(func: (client: TransactionClient) => Promise<T>): Promise<T>;
-}

package/lib/Migrator.d.ts

@@ -1,18 +0,0 @@
-import { PoolClient } from 'pg';
-export declare class Migrator {
-    protected migrationDir: string;
-    protected migrationList: string[];
-    protected pool: PoolClient;
-    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 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 runMigration(migration: string): Promise<void>;
-    protected dispose(): void;
-}