rake-db 2.3.6 → 2.3.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rake-db",
-  "version": "2.3.6",
+  "version": "2.3.8",
   "description": "Migrations tool for Postgresql DB",
   "homepage": "https://orchid-orm.netlify.app/guide/migration-setup-and-overview.html",
   "repository": {
@@ -42,7 +42,7 @@
   "dependencies": {
     "enquirer": "^2.3.6",
     "pluralize": "^8.0.0",
-    "pqb": "0.9.4"
+    "pqb": "0.9.6"
   },
   "devDependencies": {
     "@swc/core": "^1.2.210",

package/src/commands/migrateOrRollback.test.ts

@@ -2,7 +2,6 @@ import { migrate, rollback } from './migrateOrRollback';
 import { createSchemaMigrations, migrationConfigDefaults } from '../common';
 import { getMigrationFiles } from '../common';
 import { Adapter, noop, TransactionAdapter } from 'pqb';
-import { Migration } from '../migration/migration';
 import { change } from '../migration/change';
 import { asMock } from '../test-utils';
 
@@ -32,7 +31,7 @@ Adapter.prototype.transaction = (cb) => {
 };
 
 const transactionQueryMock = jest.fn();
-Migration.prototype.query = transactionQueryMock;
+TransactionAdapter.prototype.query = transactionQueryMock;
 
 const requireTsMock = jest.fn();
 const config = {
@@ -82,9 +81,11 @@ describe('migrateOrRollback', () => {
 
       expect(transactionQueryMock).toBeCalledWith(
         `INSERT INTO "schemaMigrations" VALUES ('2')`,
+        undefined,
       );
       expect(transactionQueryMock).toBeCalledWith(
         `INSERT INTO "schemaMigrations" VALUES ('3')`,
+        undefined,
       );
 
       expect(config.logger.log).toBeCalledWith('file2 migrated');
@@ -181,6 +182,7 @@ describe('migrateOrRollback', () => {
       expect(transactionQueryMock).toBeCalledTimes(1);
       expect(transactionQueryMock).toBeCalledWith(
         `DELETE FROM "schemaMigrations" WHERE version = '2'`,
+        undefined,
       );
 
       expect(config.logger.log).toBeCalledTimes(1);

package/src/commands/migrateOrRollback.ts

@@ -14,7 +14,7 @@ import {
   change,
   getCurrentChangeCallback,
 } from '../migration/change';
-import { Migration } from '../migration/migration';
+import { createMigrationInterface } from '../migration/migration';
 
 const migrateOrRollback = async (
   options: MaybeArray<AdapterOptions>,
@@ -78,7 +78,13 @@ const processMigration = async (
   appCodeUpdaterCache: object,
 ) => {
   await db.transaction(async (tx) => {
-    const db = new Migration(tx, up, config, options, appCodeUpdaterCache);
+    const db = createMigrationInterface(
+      tx,
+      up,
+      config,
+      options,
+      appCodeUpdaterCache,
+    );
     setCurrentMigration(db);
     setCurrentMigrationUp(up);
 
@@ -92,7 +98,7 @@ const processMigration = async (
 
     await getCurrentPromise();
     await (up ? saveMigratedVersion : removeMigratedVersion)(
-      db,
+      db.adapter,
       file.version,
       config,
     );

package/src/migration/changeTable.ts

@@ -18,7 +18,7 @@ import {
   ChangeTableOptions,
   ColumnComment,
   DropMode,
-  Migration,
+  MigrationBase,
   MigrationColumnTypes,
   runCodeUpdater,
 } from './migration';
@@ -198,7 +198,7 @@ export type TableChangeData = Record<
 >;
 
 export const changeTable = async (
-  migration: Migration,
+  migration: MigrationBase,
   up: boolean,
   tableName: string,
   options: ChangeTableOptions,
@@ -216,7 +216,7 @@ export const changeTable = async (
 
   const queries = astToQueries(ast);
   for (const query of queries) {
-    await migration.query(query);
+    await migration.adapter.query(query);
   }
 
   await runCodeUpdater(migration, ast);

package/src/migration/createTable.ts

@@ -12,7 +12,7 @@ import {
 import {
   ColumnComment,
   ColumnsShapeCallback,
-  Migration,
+  MigrationBase,
   runCodeUpdater,
   TableOptions,
 } from './migration';
@@ -33,7 +33,7 @@ const types = Object.assign(Object.create(columnTypes), {
 });
 
 export const createTable = async (
-  migration: Migration,
+  migration: MigrationBase,
   up: boolean,
   tableName: string,
   options: TableOptions,
@@ -54,7 +54,7 @@ export const createTable = async (
 
   const queries = astToQueries(ast);
   for (const query of queries) {
-    await migration.query(query);
+    await migration.adapter.query(query);
   }
 
   await runCodeUpdater(migration, ast);

package/src/migration/migration.ts

@@ -7,17 +7,16 @@ import {
   IndexOptions,
   logParamToLogObject,
   MaybeArray,
-  QueryArraysResult,
   QueryInput,
   QueryLogObject,
-  QueryResult,
-  QueryResultRow,
   Sql,
   TransactionAdapter,
-  TypeParsers,
   raw,
   TextColumn,
   AdapterOptions,
+  createDb,
+  columnTypes,
+  DbResult,
 } from 'pqb';
 import { createTable } from './createTable';
 import { changeTable, TableChangeData, TableChanger } from './changeTable';
@@ -64,38 +63,53 @@ export type ExtensionOptions = {
   cascade?: boolean;
 };
 
-export class Migration extends TransactionAdapter {
-  public log?: QueryLogObject;
+export type Migration = DbResult<typeof columnTypes> & MigrationBase;
 
-  constructor(
-    tx: TransactionAdapter,
-    public up: boolean,
-    public options: RakeDbConfig,
-    public adapterOptions: AdapterOptions,
-    public appCodeUpdaterCache: object,
-  ) {
-    super(tx, tx.client, tx.types);
-    this.log = logParamToLogObject(options.logger || console, options.log);
-  }
+export const createMigrationInterface = (
+  tx: TransactionAdapter,
+  up: boolean,
+  options: RakeDbConfig,
+  adapterOptions: AdapterOptions,
+  appCodeUpdaterCache: object,
+) => {
+  const adapter = new TransactionAdapter(tx, tx.client, tx.types);
+  const { query, arrays } = adapter;
+  const log = logParamToLogObject(options.logger || console, options.log);
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  async query<T extends QueryResultRow = any>(
-    query: QueryInput,
-    types: TypeParsers = this.types,
-    log = this.log,
-  ): Promise<QueryResult<T>> {
-    return wrapWithLog(log, query, () => super.query(query, types));
-  }
+  adapter.query = ((q, types) => {
+    return wrapWithLog(log, q, () => query.call(adapter, q, types));
+  }) as typeof adapter.query;
+
+  adapter.arrays = ((q, types) => {
+    return wrapWithLog(log, q, () => arrays.call(adapter, q, types));
+  }) as typeof adapter.arrays;
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  async arrays<R extends any[] = any[]>(
-    query: QueryInput,
-    types: TypeParsers = this.types,
-    log = this.log,
-  ): Promise<QueryArraysResult<R>> {
-    return wrapWithLog(log, query, () => super.arrays(query, types));
+  const db = createDb({ adapter, columnTypes }) as unknown as Migration;
+
+  const { prototype: proto } = MigrationBase;
+  for (const key of Object.getOwnPropertyNames(proto)) {
+    (db as unknown as Record<string, unknown>)[key] =
+      proto[key as keyof typeof proto];
   }
 
+  return Object.assign(db, {
+    adapter,
+    log,
+    up,
+    options,
+    adapterOptions,
+    appCodeUpdaterCache,
+  });
+};
+
+export class MigrationBase {
+  public adapter!: TransactionAdapter;
+  public log?: QueryLogObject;
+  public up!: boolean;
+  public options!: RakeDbConfig;
+  public adapterOptions!: AdapterOptions;
+  public appCodeUpdaterCache!: object;
+
   createTable(
     tableName: string,
     options: TableOptions,
@@ -158,7 +172,7 @@ export class Migration extends TransactionAdapter {
       to: t,
     };
 
-    await this.query(
+    await this.adapter.query(
       `ALTER TABLE ${quoteWithSchema({
         schema: ast.fromSchema,
         name: ast.from,
@@ -335,7 +349,7 @@ const wrapWithLog = async <Result>(
 };
 
 const addColumn = (
-  migration: Migration,
+  migration: MigrationBase,
   up: boolean,
   tableName: string,
   columnName: string,
@@ -347,7 +361,7 @@ const addColumn = (
 };
 
 const addIndex = (
-  migration: Migration,
+  migration: MigrationBase,
   up: boolean,
   tableName: string,
   columns: MaybeArray<string | IndexColumnOptions>,
@@ -359,7 +373,7 @@ const addIndex = (
 };
 
 const addForeignKey = (
-  migration: Migration,
+  migration: MigrationBase,
   up: boolean,
   tableName: string,
   columns: [string, ...string[]],
@@ -373,7 +387,7 @@ const addForeignKey = (
 };
 
 const addPrimaryKey = (
-  migration: Migration,
+  migration: MigrationBase,
   up: boolean,
   tableName: string,
   columns: string[],
@@ -385,7 +399,7 @@ const addPrimaryKey = (
 };
 
 const createSchema = async (
-  migration: Migration,
+  migration: MigrationBase,
   up: boolean,
   name: string,
 ) => {
@@ -395,7 +409,7 @@ const createSchema = async (
     name,
   };
 
-  await migration.query(
+  await migration.adapter.query(
     `${ast.action === 'create' ? 'CREATE' : 'DROP'} SCHEMA "${name}"`,
   );
 
@@ -403,7 +417,7 @@ const createSchema = async (
 };
 
 const createExtension = async (
-  migration: Migration,
+  migration: MigrationBase,
   up: boolean,
   name: string,
   options: ExtensionOptions & {
@@ -430,19 +444,19 @@ const createExtension = async (
     }${ast.cascade ? ' CASCADE' : ''}`;
   }
 
-  await migration.query(query);
+  await migration.adapter.query(query);
 
   await runCodeUpdater(migration, ast);
 };
 
 const queryExists = (
-  db: Migration,
+  db: MigrationBase,
   sql: { text: string; values: unknown[] },
 ) => {
-  return db.query(sql).then(({ rowCount }) => rowCount > 0);
+  return db.adapter.query(sql).then(({ rowCount }) => rowCount > 0);
 };
 
-export const runCodeUpdater = (migration: Migration, ast: RakeDbAst) => {
+export const runCodeUpdater = (migration: MigrationBase, ast: RakeDbAst) => {
   return migration.options.appCodeUpdater?.({
     ast,
     options: migration.adapterOptions,

package/src/migration/migrationUtils.ts

@@ -284,7 +284,7 @@ export const getPrimaryKeysOfTable = async (
   db: Migration,
   tableName: string,
 ): Promise<{ name: string; type: string }[]> => {
-  const { rows } = await db.query<{ name: string; type: string }>(
+  const { rows } = await db.adapter.query<{ name: string; type: string }>(
     {
       text: `SELECT
   pg_attribute.attname AS name,
@@ -300,8 +300,7 @@ WHERE
   indisprimary`,
       values: [tableName],
     },
-    db.types,
-    undefined,
+    db.adapter.types,
   );
 
   return rows;

package/src/test-utils.ts

@@ -1,4 +1,4 @@
-import { Migration } from './migration/migration';
+import { createMigrationInterface, Migration } from './migration/migration';
 import { MaybeArray, toArray, TransactionAdapter } from 'pqb';
 
 export const asMock = (fn: unknown) => fn as jest.Mock;
@@ -8,7 +8,7 @@ let db: Migration | undefined;
 export const getDb = () => {
   if (db) return db;
 
-  db = new Migration(
+  db = createMigrationInterface(
     {} as unknown as TransactionAdapter,
     true,
     {
@@ -21,7 +21,7 @@ export const getDb = () => {
     {},
     {},
   );
-  db.query = queryMock;
+  db.adapter.query = queryMock;
   return db;
 };
 

package/src/pull/getColumnByType.ts

@@ -1,15 +0,0 @@
-import { ColumnType, ColumnTypesBase } from 'pqb';
-
-export const getColumnsByTypesMap = (types: ColumnTypesBase) => {
-  const map: Record<string, new () => ColumnType> = {};
-  for (const key in types) {
-    const type = types[key] as unknown as new () => ColumnType;
-    if (type instanceof ColumnType) {
-      map[type.dataType] = type;
-      if (type.typeAlias) {
-        map[type.typeAlias] = type;
-      }
-    }
-  }
-  return map;
-};