@vida-global/core 2.2.0 → 2.2.1

package/lib/activeRecord/README.md

@@ -72,6 +72,8 @@ Wire up the migration CLI by adding scripts to `package.json`:
 
 Generate a migration with `npm run db:create_migration createUsers`. Pass `-- --databaseId metrics` to scope the migration to a non-default database. Run `npm run db:migrate` to apply migrations or `npm run db:rollback` to undo the most recent one.
 
+Migration files are named `<timestamp>_<description>.js`, with the database id appended before the extension when one is given — for example `1754500000000_createUsers.js` or `1754500000000_createUsers.metrics.js`. The leading timestamp is the version recorded in `migration_versions` and the order migrations run in, so files sort chronologically by name. Files that don't match this pattern are ignored.
+
 ```js
 module.exports = {
     up: async function() {
@@ -102,7 +104,7 @@ createTable(tableName, details, { timestamps, paranoid })
 dropTable(tableName)
 addColumn(tableName, columnName, columnDetails)
 removeColumn(tableName, columnName)
-addIndex(tableName, fields, { concurrently, unique, name, where })
+addIndex(tableName, fields, { concurrently, unique, name, using, where })
 removeIndex(tableName, indexNameOrAttributes, concurrently=false)
 renameColumn(tableName, oldName, newName)
 changeColumn(tableName, columnName, dataTypeOrOptions)
@@ -111,9 +113,30 @@ changeColumn(tableName, columnName, dataTypeOrOptions)
 **Conventions:**
 
 - `createTable` adds an auto-increment `id` primary key and `created_at` / `updated_at` columns by default. Pass `{ timestamps: false }` to skip the timestamps.
-- Pass `{ paranoid: true }` to add a nullable `deleted_at` column. Models over that table soft delete: `initializationOptions` turns on `paranoid` for any table whose schema has `deleted_at`, so `destroy()` sets the column and ordinary queries skip the row. Unique indexes on a paranoid table should be partial — `where: { deleted_at: null }` — or a deleted row will still block re-creating the same one.
+- Pass `{ paranoid: true }` to `createTable` to add a nullable `deleted_at` column for soft deletes.
+- Models over that table soft delete without any extra configuration: `initializationOptions` turns on Sequelize's `paranoid` for any table whose schema has `deleted_at` alongside the timestamp columns, so `destroy()` sets `deleted_at` and ordinary queries skip the row. A table created with `{ paranoid: true, timestamps: false }` has the column but does not qualify.
+- Unique indexes on a paranoid table should be partial — `where: { deleted_at: null }` — or a soft-deleted row will still block re-creating the same one.
+- An index created without a `name` gets `idx_<table>_<columns>`, so `addIndex('users', ['team_id', 'email'])` creates `idx_users_team_id_email`. `removeIndex` applies the same default, which means an index added by its columns can be dropped by its columns. Postgres truncates identifiers at 63 characters, so name long multi-column indexes explicitly.
 - Column names are automatically converted to snake_case, so `teamId` in the details object becomes `team_id` in the database.
-- Each migration runs inside a transaction.
+- Each migration runs inside a transaction, so a migration that throws part way through leaves the database untouched.
+
+Postgres refuses a few statements inside a transaction block — `CREATE INDEX CONCURRENTLY` and `DROP INDEX CONCURRENTLY` most of all. A migration that needs one of those opts out of the transaction entirely:
+
+```js
+module.exports = {
+    transactional: false,
+
+    up: async function() {
+        await this.addIndex('users', ['team_id'], { concurrently: true });
+    },
+
+    down: async function() {
+        await this.removeIndex('users', ['team_id'], true);
+    }
+}
+```
+
+An opted-out migration is **not** rolled back if it fails, so keep it to the single statement that needs it and put everything else in its own migration.
 
 
 ## Models

package/lib/activeRecord/db/migration.js

@@ -101,7 +101,7 @@ function generateMigrationFile(description, databaseId) {
 
 
 function fileNameForMigration(description, databaseId) {
-    const name     = `${description}_${new Date().getTime()}`;
+    const name     = `${new Date().getTime()}_${description}`;
     const dbSuffix = databaseId ? `.${databaseId}` : '';
     return `${name}${dbSuffix}.js`;
 }
@@ -113,7 +113,7 @@ function fileNameForMigration(description, databaseId) {
 function getMigrations() {
     const files = fs.readdirSync(utils.migrationsDirectory);
     const migrations = files.map(f => {
-        const m = f.match(/_(?<version>\d+)(\.(?<databaseId>\w+))?\.js$/);
+        const m = f.match(/^(?<version>\d+)_[^.]+(\.(?<databaseId>\w+))?\.js$/);
         if (!m) return;
         return {fileName: f, databaseId: m.groups.databaseId, version: m.groups.version};
     });

package/lib/activeRecord/db/migrator.js

@@ -8,6 +8,7 @@ class Migrator {
     #connection;
     #fileName;
     #migrationModule;
+    #transaction = null;
 
     DataTypes = Sequelize.DataTypes;
     Operators = Op;
@@ -22,19 +23,32 @@ class Migrator {
     async run() {
         if (!this.migrationModule.up) throw new Error('Missing migration `up`');
 
-        const migrator = this;
-        await this.#connection.queryInterface.transaction(async () => {
-            await migrator.migrationModule.up.call(migrator);
-        });
+        await this.perform(() => this.migrationModule.up.call(this));
     }
 
 
     async rollback() {
         if (!this.migrationModule.down) return;
 
-        const migrator = this;
-        await this.#connection.queryInterface.transaction(async () => {
-            await migrator.migrationModule.down.call(migrator);
+        await this.perform(() => this.migrationModule.down.call(this));
+    }
+
+
+    async perform(callback) {
+        if (!this.transactional) return await callback();
+
+        await this.performInTransaction(callback);
+    }
+
+
+    async performInTransaction(callback) {
+        await this.#connection.queryInterface.transaction(async transaction => {
+            this.#transaction = transaction;
+            try {
+                await callback();
+            } finally {
+                this.#transaction = null;
+            }
         });
     }
 
@@ -58,6 +72,14 @@ class Migrator {
     }
 
 
+    // Migrations opt out with `transactional: false`. Needed for statements Postgres refuses to
+    // run inside a transaction block, most notably CREATE/DROP INDEX CONCURRENTLY. An opted-out
+    // migration is not rolled back when it fails.
+    get transactional() {
+        return this.migrationModule.transactional !== false;
+    }
+
+
     importMigrationModule() {
         const filePath = `${utils.migrationsDirectory}/${this.#fileName}`;
         return require(filePath);
@@ -77,7 +99,7 @@ class Migrator {
         }
 
         details = this.normalizeTableDetails(details);
-        await this.#sequelizeQueryInterface.createTable(tableName, details);
+        await this.#sequelizeQueryInterface.createTable(tableName, details, this.queryOptions);
     }
 
 
@@ -116,8 +138,6 @@ class Migrator {
     }
 
 
-    // Records use soft deletes when the table has this column: initializationOptions turns paranoid
-    // on for any model whose schema includes it.
     get deletedAtColumn() {
         return {
             deleted_at: {
@@ -128,25 +148,25 @@ class Migrator {
 
 
     async dropTable(tableName) {
-        await this.#sequelizeQueryInterface.dropTable(tableName);
+        await this.#sequelizeQueryInterface.dropTable(tableName, this.queryOptions);
     }
 
 
     async addColumn(tableName, columnName, columnDetails) {
-        await this.#sequelizeQueryInterface.addColumn(tableName, columnName, columnDetails);
+        await this.#sequelizeQueryInterface.addColumn(tableName, columnName, columnDetails, this.queryOptions);
     }
 
 
     async removeColumn(tableName, columnName) {
-        await this.#sequelizeQueryInterface.removeColumn(tableName, columnName);
+        await this.#sequelizeQueryInterface.removeColumn(tableName, columnName, this.queryOptions);
     }
 
 
-    async addIndex(tableName, fields, { concurrently, unique, name, using, where }) {
-        const options = {fields: fields};
+    async addIndex(tableName, fields, { concurrently, unique, name, using, where }={}) {
+        const options = {fields: fields, ...this.queryOptions};
+        options.name = name || this.defaultIndexName(tableName, fields);
         if (concurrently) options.concurrently = true;
         if (unique)       options.unique       = true;
-        if (name)         options.name         = name;
         if (using)        options.using        = using;
         if (where)        options.where        = where;
 
@@ -155,20 +175,53 @@ class Migrator {
 
 
     async removeIndex(tableName, indexNameOrAttributes, concurrently=false) {
-        const options = {};
+        const options   = this.queryOptions;
         if (concurrently) options.concurrently = true;
-        await this.#sequelizeQueryInterface.removeIndex(tableName, indexNameOrAttributes, options);
+
+        const indexName = this.indexNameFor(tableName, indexNameOrAttributes);
+        await this.#sequelizeQueryInterface.removeIndex(tableName, indexName, options);
+    }
+
+
+    /***********************************************************************************************
+    * INDEX NAMING
+    ***********************************************************************************************/
+    // Indexes created without an explicit name get `idx_<table>_<columns>`. removeIndex applies the
+    // same default so an index can be dropped by its columns, the way it was added.
+    indexNameFor(tableName, indexNameOrAttributes) {
+        if (typeof indexNameOrAttributes === 'string') return indexNameOrAttributes;
+        return this.defaultIndexName(tableName, indexNameOrAttributes);
+    }
+
+
+    defaultIndexName(tableName, fields) {
+        const columnNames = fields.map(field => this.indexColumnName(field));
+        return `idx_${tableName}_${columnNames.join('_')}`;
+    }
+
+
+    indexColumnName(field) {
+        if (typeof field === 'string') return field;
+        return field.name;
     }
 
 
     async renameColumn(tableName, oldName, newName) {
         newName = underscore(newName);
-        await this.#sequelizeQueryInterface.renameColumn(tableName, oldName, newName);
+        await this.#sequelizeQueryInterface.renameColumn(tableName, oldName, newName, this.queryOptions);
     }
 
 
     async changeColumn(tableName, columnName, dataTypeOrOptions) {
-        await this.#sequelizeQueryInterface.changeColumn(tableName, columnName, dataTypeOrOptions);
+        await this.#sequelizeQueryInterface.changeColumn(tableName, columnName, dataTypeOrOptions, this.queryOptions);
+    }
+
+
+    /***********************************************************************************************
+    * QUERY OPTIONS
+    ***********************************************************************************************/
+    get queryOptions() {
+        return { transaction: this.#transaction };
     }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vida-global/core",
-    "version": "2.2.0",
+    "version": "2.2.1",
     "description": "Core libraries for supporting Vida development",
     "author": "",
     "license": "ISC",

package/test/activeRecord/db/migrator.test.js

@@ -45,6 +45,97 @@ describe('Migrator', () => {
     });
 
 
+    describe('Migrator transaction threading', () => {
+        it ('passes the open transaction to operations run inside `up`', async () => {
+            const tableName = Helpers.randomString();
+
+            await Helpers.runInMigration(async function() {
+                await this.createTable(tableName, {});
+            });
+
+            expect(Helpers.mockQueryInterface.createTable).toHaveBeenCalledWith(
+                tableName,
+                expect.any(Object),
+                Helpers.inTransaction,
+            );
+        });
+
+        it ('passes the open transaction to operations run inside `down`', async () => {
+            const tableName = Helpers.randomString();
+            Helpers.migrationModule.down.mockImplementationOnce(async function() {
+                await this.dropTable(tableName);
+            });
+
+            await Helpers.migrator.rollback();
+
+            expect(Helpers.mockQueryInterface.dropTable).toHaveBeenCalledWith(tableName, Helpers.inTransaction);
+        });
+
+        it ('clears the transaction once the migration finishes', async () => {
+            const tableName = Helpers.randomString();
+
+            await Helpers.runInMigration(async function() {});
+            await Helpers.migrator.dropTable(tableName);
+
+            expect(Helpers.mockQueryInterface.dropTable).toHaveBeenCalledWith(tableName, Helpers.noTransaction);
+        });
+
+        it ('clears the transaction when the migration throws', async () => {
+            const tableName = Helpers.randomString();
+
+            await expect(Helpers.runInMigration(async function() {
+                throw new Error('migration blew up');
+            })).rejects.toThrow('migration blew up');
+            await Helpers.migrator.dropTable(tableName);
+
+            expect(Helpers.mockQueryInterface.dropTable).toHaveBeenCalledWith(tableName, Helpers.noTransaction);
+        });
+    });
+
+
+    describe('Migrator opting out of the transaction', () => {
+        afterEach(() => {
+            delete Helpers.migrationModule.transactional;
+        });
+
+        it ('runs `up` outside a transaction when the migration sets transactional to false', async () => {
+            const tableName = Helpers.randomString();
+            Helpers.migrationModule.transactional = false;
+
+            await Helpers.runInMigration(async function() {
+                await this.addIndex(tableName, ['name'], { concurrently: true });
+            });
+
+            expect(Helpers.transactionSpy).not.toHaveBeenCalled();
+            expect(Helpers.mockQueryInterface.addIndex).toHaveBeenCalledWith(tableName, {
+                fields: ['name'],
+                name: `idx_${tableName}_name`,
+                concurrently: true,
+                ...Helpers.noTransaction,
+            });
+        });
+
+        it ('runs `down` outside a transaction when the migration sets transactional to false', async () => {
+            const tableName = Helpers.randomString();
+            Helpers.migrationModule.transactional = false;
+            Helpers.migrationModule.down.mockImplementationOnce(async function() {
+                await this.dropTable(tableName);
+            });
+
+            await Helpers.migrator.rollback();
+
+            expect(Helpers.transactionSpy).not.toHaveBeenCalled();
+            expect(Helpers.mockQueryInterface.dropTable).toHaveBeenCalledWith(tableName, Helpers.noTransaction);
+        });
+
+        it ('still uses a transaction when transactional is unset', async () => {
+            await Helpers.migrator.run();
+
+            expect(Helpers.transactionSpy).toHaveBeenCalledTimes(1);
+        });
+    });
+
+
     describe('Migrator#createTable', () => {
         const defaultColumns = {
             id: { allowNull: false, autoIncrement: true, primaryKey: true, type: 'INTEGER' },
@@ -58,10 +149,10 @@ describe('Migrator', () => {
 
             await Helpers.migrator.createTable(tableName, details);
 
-            expect(Helpers.mockQueryInterface.createTable).toHaveBeenCalledWith(tableName, details);
+            expect(Helpers.mockQueryInterface.createTable).toHaveBeenCalledWith(tableName, details, Helpers.noTransaction);
         });
 
-        it ('adds a deleted_at column for paranoid tables', async () => {
+        it ('adds a nullable deleted_at column when paranoid is set', async () => {
             const tableName = Helpers.randomString();
             const details = { ...defaultColumns };
 
@@ -70,16 +161,27 @@ describe('Migrator', () => {
             expect(Helpers.mockQueryInterface.createTable).toHaveBeenCalledWith(tableName, {
                 ...defaultColumns,
                 deleted_at: { allowNull: true, type: 'DATE' },
-            });
+            }, Helpers.noTransaction);
         });
 
-        it ('leaves deleted_at off tables that are not paranoid', async () => {
+        it ('omits deleted_at when paranoid is not set', async () => {
             const tableName = Helpers.randomString();
-            const details = { ...defaultColumns };
 
-            await Helpers.migrator.createTable(tableName, details);
+            await Helpers.migrator.createTable(tableName, { ...defaultColumns });
 
-            expect(Helpers.mockQueryInterface.createTable).toHaveBeenCalledWith(tableName, defaultColumns);
+            const [, columns] = Helpers.mockQueryInterface.createTable.mock.calls[0];
+            expect(columns).not.toHaveProperty('deleted_at');
+        });
+
+        it ('adds deleted_at alongside timestamps: false', async () => {
+            const tableName = Helpers.randomString();
+
+            await Helpers.migrator.createTable(tableName, {}, { paranoid: true, timestamps: false });
+
+            const [, columns] = Helpers.mockQueryInterface.createTable.mock.calls[0];
+            expect(columns).toHaveProperty('deleted_at');
+            expect(columns).not.toHaveProperty('created_at');
+            expect(columns).not.toHaveProperty('updated_at');
         });
 
         it ('snake_cases created table columns', async () => {
@@ -91,7 +193,7 @@ describe('Migrator', () => {
             expect(Helpers.mockQueryInterface.createTable).toHaveBeenCalledWith(tableName, {
                 ...defaultColumns,
                 my_column: 1,
-            });
+            }, Helpers.noTransaction);
         });
     });
 
@@ -116,7 +218,7 @@ describe('Migrator', () => {
 
             await Helpers.migrator.renameColumn(tableName, oldName, 'myColumn');
 
-            expect(Helpers.mockQueryInterface.renameColumn).toHaveBeenCalledWith(tableName, oldName, 'my_column');
+            expect(Helpers.mockQueryInterface.renameColumn).toHaveBeenCalledWith(tableName, oldName, 'my_column', Helpers.noTransaction);
         });
     });
 
@@ -129,12 +231,12 @@ describe('Migrator', () => {
         ])('builds addIndex options for %s', async (_label, options) => {
             const tableName = Helpers.randomString();
             const fields = [Helpers.randomString(), Helpers.randomString()];
-            const expectedOptions = { fields };
+            const expectedOptions = { fields, ...Helpers.noTransaction };
 
             if (options.concurrently) expectedOptions.concurrently = true;
             if (options.unique) expectedOptions.unique = true;
             if (options.where) expectedOptions.where = options.where;
-            if (options.name) expectedOptions.name = options.name;
+            expectedOptions.name = options.name || `idx_${tableName}_${fields.join('_')}`;
             if (options.using) expectedOptions.using = options.using;
 
             await Helpers.migrator.addIndex(tableName, fields, options);
@@ -147,8 +249,8 @@ describe('Migrator', () => {
 
     describe('Migrator#removeIndex', () => {
         it.each([
-            ['default options', false, {}],
-            ['concurrently', true, { concurrently: true }],
+            ['default options', false, { transaction: null }],
+            ['concurrently', true, { concurrently: true, transaction: null }],
         ])('passes removeIndex options for %s', async (_label, concurrently, expectedOptions) => {
             const tableName = Helpers.randomString();
             const fields = [Helpers.randomString(), Helpers.randomString()];
@@ -158,9 +260,54 @@ describe('Migrator', () => {
             expect(Helpers.mockQueryInterface.removeIndex).toHaveBeenCalledTimes(1);
             expect(Helpers.mockQueryInterface.removeIndex).toHaveBeenCalledWith(
                 tableName,
-                fields,
+                `idx_${tableName}_${fields.join('_')}`,
                 expectedOptions,
             );
         });
+
+        it ('leaves an explicit index name alone', async () => {
+            const tableName = Helpers.randomString();
+            const indexName = Helpers.randomString();
+
+            await Helpers.migrator.removeIndex(tableName, indexName);
+
+            expect(Helpers.mockQueryInterface.removeIndex).toHaveBeenCalledWith(
+                tableName,
+                indexName,
+                Helpers.noTransaction,
+            );
+        });
+    });
+
+
+    describe('Migrator#defaultIndexName', () => {
+        it ('builds idx_<table>_<columns> from a single column', () => {
+            expect(Helpers.migrator.defaultIndexName('users', ['team_id'])).toBe('idx_users_team_id');
+        });
+
+        it ('joins multiple columns with underscores', () => {
+            expect(Helpers.migrator.defaultIndexName('users', ['team_id', 'email'])).toBe('idx_users_team_id_email');
+        });
+
+        it ('reads the column name off object-style fields', () => {
+            const fields = ['team_id', { name: 'email', order: 'DESC' }];
+
+            expect(Helpers.migrator.defaultIndexName('users', fields)).toBe('idx_users_team_id_email');
+        });
+    });
+
+
+    describe('Migrator#addIndex default naming', () => {
+        it ('names an index when no options are passed at all', async () => {
+            const tableName = Helpers.randomString();
+
+            await Helpers.migrator.addIndex(tableName, ['team_id']);
+
+            expect(Helpers.mockQueryInterface.addIndex).toHaveBeenCalledWith(tableName, {
+                fields: ['team_id'],
+                name: `idx_${tableName}_team_id`,
+                ...Helpers.noTransaction,
+            });
+        });
     });
 });

package/test/activeRecord/helpers/migrator.js

@@ -13,6 +13,9 @@ const connectionConfig   = { database: ' ', host: ' ', password: ' ', username:
 const migrationModule    = { up: jest.fn(), down: jest.fn() };
 const randomNumber       = TestHelpers.Faker.Math.randomNumber
 const randomString       = TestHelpers.Faker.Text.randomString;
+const transaction        = { id: randomString() };
+const noTransaction      = { transaction: null };
+const inTransaction      = { transaction };
 const mockQueryInterface = {
     createTable: jest.fn(),
     dropTable: jest.fn(),
@@ -52,7 +55,7 @@ jest.spyOn(migrator, 'migrationModule', 'get').mockImplementation(() => migratio
 
 
 const transactionSpy = jest.spyOn(QueryInterface.prototype, 'transaction');
-transactionSpy.mockImplementation(callback => callback());
+transactionSpy.mockImplementation(callback => callback(transaction));
 
 
 /***************************************************************************************************
@@ -61,18 +64,29 @@ transactionSpy.mockImplementation(callback => callback());
 async function expectQueryInterfaceCall(methodName, args) {
     await migrator[methodName](...args);
     expect(mockQueryInterface[methodName]).toHaveBeenCalledTimes(1);
-    expect(mockQueryInterface[methodName]).toHaveBeenCalledWith(...args);
+    expect(mockQueryInterface[methodName]).toHaveBeenCalledWith(...args, noTransaction);
+}
+
+
+// Runs `operation` from inside a migration's `up` so it sees the open transaction.
+async function runInMigration(operation) {
+    migrationModule.up.mockImplementationOnce(operation);
+    await migrator.run();
 }
 
 
 module.exports = {
   expectQueryInterfaceCall,
   ...Fixtures,
+  inTransaction,
   migrationModule,
   migrator,
   mockQueryInterface,
+  noTransaction,
   randomColumnDetails,
   randomNumber,
   randomString,
+  runInMigration,
+  transaction,
   transactionSpy,
 };