rake-db 2.2.3 → 2.2.4

package/src/commands/migrateOrRollback.test.ts

@@ -3,6 +3,8 @@ 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';
 
 jest.mock('../common', () => ({
   ...jest.requireActual('../common'),
@@ -23,6 +25,7 @@ Adapter.prototype.arrays = getMigratedVersionsArrayMock;
 
 const queryMock = jest.fn();
 Adapter.prototype.query = queryMock;
+queryMock.mockImplementation(() => undefined);
 
 Adapter.prototype.transaction = (cb) => {
   return cb({} as unknown as TransactionAdapter);
@@ -43,17 +46,32 @@ const config = {
   },
 };
 
+const createTableCallback = () => {
+  change(async (db) => {
+    await db.createTable('table', (t) => ({
+      id: t.serial().primaryKey(),
+    }));
+  });
+};
+
+let migrationFiles: { path: string; version: string }[] = [];
+asMock(getMigrationFiles).mockImplementation(() => migrationFiles);
+
+let migratedVersions: string[] = [];
+getMigratedVersionsArrayMock.mockImplementation(() => ({
+  rows: migratedVersions.map((version) => [version]),
+}));
+
 describe('migrateOrRollback', () => {
   beforeEach(() => {
     jest.clearAllMocks();
+    requireTsMock.mockImplementation(() => undefined);
   });
 
   describe('migrate', () => {
     it('should work properly', async () => {
-      (getMigrationFiles as jest.Mock).mockReturnValueOnce(files);
-      getMigratedVersionsArrayMock.mockResolvedValueOnce({ rows: [['1']] });
-      queryMock.mockReturnValueOnce(undefined);
-      requireTsMock.mockResolvedValue(undefined);
+      migrationFiles = files;
+      migratedVersions = ['1'];
 
       await migrate(options, config, []);
 
@@ -74,7 +92,7 @@ describe('migrateOrRollback', () => {
     });
 
     it('should create migrations table if it not exist', async () => {
-      (getMigrationFiles as jest.Mock).mockReturnValueOnce([]);
+      migrationFiles = [];
       getMigratedVersionsArrayMock.mockRejectedValueOnce({ code: '42P01' });
       (createSchemaMigrations as jest.Mock).mockResolvedValueOnce(undefined);
 
@@ -86,16 +104,72 @@ describe('migrateOrRollback', () => {
       expect(transactionQueryMock).not.toBeCalled();
       expect(config.logger.log).not.toBeCalled();
     });
+
+    it('should call appCodeUpdater only on the first run', async () => {
+      migrationFiles = [files[0]];
+      migratedVersions = [];
+      requireTsMock.mockImplementationOnce(createTableCallback);
+      const appCodeUpdater = jest.fn();
+
+      await migrate(
+        [options, options],
+        { ...config, appCodeUpdater, useCodeUpdater: true },
+        [],
+      );
+
+      expect(appCodeUpdater).toBeCalledTimes(1);
+    });
+
+    it('should not call appCodeUpdater when useCodeUpdater is set to false in config', async () => {
+      migrationFiles = [files[0]];
+      migratedVersions = [];
+      requireTsMock.mockImplementation(createTableCallback);
+      const appCodeUpdater = jest.fn();
+
+      await migrate(
+        options,
+        { ...config, appCodeUpdater, useCodeUpdater: false },
+        [],
+      );
+
+      expect(appCodeUpdater).not.toBeCalled();
+    });
+
+    it('should not call appCodeUpdater when having argument --code false', async () => {
+      migrationFiles = [files[0]];
+      migratedVersions = [];
+      requireTsMock.mockImplementation(createTableCallback);
+      const appCodeUpdater = jest.fn();
+
+      await migrate(
+        options,
+        { ...config, appCodeUpdater, useCodeUpdater: true },
+        ['--code', 'false'],
+      );
+
+      expect(appCodeUpdater).not.toBeCalled();
+    });
+
+    it('should call appCodeUpdater when having argument --code', async () => {
+      migrationFiles = [files[0]];
+      migratedVersions = [];
+      requireTsMock.mockImplementation(createTableCallback);
+      const appCodeUpdater = jest.fn();
+
+      await migrate(
+        options,
+        { ...config, appCodeUpdater, useCodeUpdater: false },
+        ['--code'],
+      );
+
+      expect(appCodeUpdater).toBeCalled();
+    });
   });
 
   describe('rollback', () => {
     it('should work properly', async () => {
-      (getMigrationFiles as jest.Mock).mockReturnValueOnce(files.reverse());
-      getMigratedVersionsArrayMock.mockResolvedValueOnce({
-        rows: [['1'], ['2']],
-      });
-      queryMock.mockReturnValueOnce(undefined);
-      requireTsMock.mockResolvedValue(undefined);
+      migrationFiles = files.reverse();
+      migratedVersions = ['1', '2'];
 
       await rollback(options, config, []);
 
@@ -114,7 +188,7 @@ describe('migrateOrRollback', () => {
     });
 
     it('should create migrations table if it not exist', async () => {
-      (getMigrationFiles as jest.Mock).mockReturnValueOnce([]);
+      migrationFiles = [];
       getMigratedVersionsArrayMock.mockRejectedValueOnce({ code: '42P01' });
       (createSchemaMigrations as jest.Mock).mockResolvedValueOnce(undefined);
 

package/src/commands/migrateOrRollback.ts

@@ -22,10 +22,25 @@ const migrateOrRollback = async (
   args: string[],
   up: boolean,
 ) => {
+  config = { ...config };
   const files = await getMigrationFiles(config, up);
 
-  const argCount = args[0] === 'all' ? Infinity : parseInt(args[0]);
-  let count = isNaN(argCount) ? (up ? Infinity : 1) : argCount;
+  let count = up ? Infinity : 1;
+  let argI = 0;
+  const num = args[0] === 'all' ? Infinity : parseInt(args[0]);
+  if (!isNaN(num)) {
+    argI++;
+    count = num;
+  }
+
+  const arg = args[argI];
+  if (arg === '--code') {
+    config.useCodeUpdater = args[argI + 1] !== 'false';
+  }
+
+  if (!config.useCodeUpdater) delete config.appCodeUpdater;
+
+  const appCodeUpdaterCache = {};
 
   for (const opts of toArray(options)) {
     const db = new Adapter(opts);
@@ -41,12 +56,14 @@ const migrateOrRollback = async (
 
         if (count-- <= 0) break;
 
-        await processMigration(db, up, file, config);
+        await processMigration(db, up, file, config, opts, appCodeUpdaterCache);
         config.logger?.log(`${file.path} ${up ? 'migrated' : 'rolled back'}`);
       }
     } finally {
       await db.close();
     }
+    // use appCodeUpdater only for the first provided options
+    delete config.appCodeUpdater;
   }
 };
 
@@ -57,9 +74,11 @@ const processMigration = async (
   up: boolean,
   file: MigrationFile,
   config: RakeDbConfig,
+  options: AdapterOptions,
+  appCodeUpdaterCache: object,
 ) => {
   await db.transaction(async (tx) => {
-    const db = new Migration(tx, up, config);
+    const db = new Migration(tx, up, config, options, appCodeUpdaterCache);
     setCurrentMigration(db);
     setCurrentMigrationUp(up);
 

package/src/common.ts

@@ -15,9 +15,14 @@ export type RakeDbConfig = {
   requireTs(path: string): void;
   noPrimaryKey?: NoPrimaryKeyOption;
   appCodeUpdater?: AppCodeUpdater;
+  useCodeUpdater?: boolean;
 } & QueryLogOptions;
 
-export type AppCodeUpdater = (ast: RakeDbAst) => Promise<void>;
+export type AppCodeUpdater = (params: {
+  ast: RakeDbAst;
+  options: AdapterOptions;
+  cache: object;
+}) => Promise<void>;
 
 export const migrationConfigDefaults = {
   migrationsPath: path.resolve(process.cwd(), 'src', 'migrations'),
@@ -25,6 +30,7 @@ export const migrationConfigDefaults = {
   requireTs: require,
   log: true,
   logger: console,
+  useCodeUpdaterByDefault: true,
 };
 
 export const getMigrationConfigWithDefaults = (

package/src/migration/changeTable.ts

@@ -20,6 +20,7 @@ import {
   DropMode,
   Migration,
   MigrationColumnTypes,
+  runCodeUpdater,
 } from './migration';
 import { RakeDbAst } from '../ast';
 import { quoteTable } from '../common';
@@ -218,7 +219,7 @@ export const changeTable = async (
     await migration.query(query);
   }
 
-  await migration.options.appCodeUpdater?.(ast);
+  await runCodeUpdater(migration, ast);
 };
 
 const makeAst = (

package/src/migration/createTable.ts

@@ -13,6 +13,7 @@ import {
   ColumnComment,
   ColumnsShapeCallback,
   Migration,
+  runCodeUpdater,
   TableOptions,
 } from './migration';
 import {
@@ -56,7 +57,7 @@ export const createTable = async (
     await migration.query(query);
   }
 
-  await migration.options.appCodeUpdater?.(ast);
+  await runCodeUpdater(migration, ast);
 };
 
 const makeAst = (

package/src/migration/migration.ts

@@ -17,6 +17,7 @@ import {
   TypeParsers,
   raw,
   TextColumn,
+  AdapterOptions,
 } from 'pqb';
 import { createTable } from './createTable';
 import { changeTable, TableChangeData, TableChanger } from './changeTable';
@@ -67,6 +68,8 @@ export class Migration extends TransactionAdapter {
     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);
@@ -186,7 +189,7 @@ export class Migration extends TransactionAdapter {
       `ALTER TABLE ${quoteTable(ast.from)} RENAME TO "${ast.to}"`,
     );
 
-    await this.options.appCodeUpdater?.(ast);
+    await runCodeUpdater(this, ast);
   }
 
   addColumn(
@@ -417,7 +420,7 @@ const createSchema = async (
     `${ast.action === 'create' ? 'CREATE' : 'DROP'} SCHEMA "${name}"`,
   );
 
-  await migration.options.appCodeUpdater?.(ast);
+  await runCodeUpdater(migration, ast);
 };
 
 const createExtension = async (
@@ -450,7 +453,7 @@ const createExtension = async (
 
   await migration.query(query);
 
-  await migration.options.appCodeUpdater?.(ast);
+  await runCodeUpdater(migration, ast);
 };
 
 const queryExists = (
@@ -459,3 +462,11 @@ const queryExists = (
 ) => {
   return db.query(sql).then(({ rowCount }) => rowCount > 0);
 };
+
+export const runCodeUpdater = (migration: Migration, ast: RakeDbAst) => {
+  return migration.options.appCodeUpdater?.({
+    ast,
+    options: migration.adapterOptions,
+    cache: migration.appCodeUpdaterCache,
+  });
+};

package/src/rakeDb.ts

@@ -39,17 +39,30 @@ Commands:
   drop                    drop databases
   reset                   drop, create and migrate databases
   g, generate             generate migration file, see below
-  migrate                 migrate all pending migrations
+  migrate                 migrate pending migrations
   rollback                rollback the last migrated
   no or unknown command   prints this message
   
+Migrate arguments:
+  no arguments            run all pending migrations
+  number                  run specific number of pending migrations
+
+Rollback arguments:
+  no arguments            rollback one last applied migration
+  number                  rollback specific number of applied migrations
+  all                     rollback all applied migrations
+
+Migrate and rollback common arguments:
+  --code                  run code updater, overrides \`useCodeUpdater\` option
+  --code false            do not run code updater
+  
 Generate arguments:
 - (required) first argument is migration name
-  * create*      template for create table
-  * change*      template for change table
-  * add*To*      template for add columns
-  * remove*From* template for remove columns
-  * drop*        template for drop table
+  * create*               template for create table
+  * change*               template for change table
+  * add*To*               template for add columns
+  * remove*From*          template for remove columns
+  * drop*                 template for drop table
 
 - other arguments considered as columns with types and optional methods:
   rake-db g createTable id:serial.primaryKey name:text.nullable

package/src/test-utils.ts

@@ -1,18 +1,26 @@
 import { Migration } from './migration/migration';
 import { MaybeArray, toArray, TransactionAdapter } from 'pqb';
 
+export const asMock = (fn: unknown) => fn as jest.Mock;
+
 let db: Migration | undefined;
 
 export const getDb = () => {
   if (db) return db;
 
-  db = new Migration({} as unknown as TransactionAdapter, true, {
-    log: false,
-    migrationsPath: 'migrations-path',
-    migrationsTable: 'schemaMigrations',
-    requireTs: require,
-    appCodeUpdater: appCodeUpdaterMock,
-  });
+  db = new Migration(
+    {} as unknown as TransactionAdapter,
+    true,
+    {
+      log: false,
+      migrationsPath: 'migrations-path',
+      migrationsTable: 'schemaMigrations',
+      requireTs: require,
+      appCodeUpdater: appCodeUpdaterMock,
+    },
+    {},
+    {},
+  );
   db.query = queryMock;
   return db;
 };