@mikro-orm/migrations 7.3.0-dev.15 → 7.3.0-dev.17

package/Migrator.d.ts

@@ -13,6 +13,8 @@ export declare class Migrator extends AbstractMigrator<AbstractSqlDriver> {
     protected getDefaultGenerator(): IMigrationGenerator;
     private getSnapshotPath;
     protected init(): Promise<void>;
+    /** Runs the callback while holding the migration lock (if enabled and supported by the driver). */
+    private runLocked;
     /**
      * @inheritDoc
      */

package/Migrator.js

@@ -63,6 +63,46 @@ export class Migrator extends AbstractMigrator {
             await this.storage.ensureTable();
         }
     }
+    /** Runs the callback while holding the migration lock (if enabled and supported by the driver). */
+    async runLocked(cb) {
+        const lock = this.options.lock ? this.driver.getPlatform().getSchemaHelper().getMigrationLockSQL() : undefined;
+        if (!lock) {
+            return cb();
+        }
+        const poolMax = this.config.get('pool').max;
+        if (poolMax != null && poolMax < 2) {
+            throw new Error('The migration lock needs at least 2 pooled connections, as it holds one for the whole run');
+        }
+        // the database has to exist before a connection can be reserved, creating it may reconnect
+        await this.#schemaGenerator.ensureDatabase();
+        const connection = this.driver.getConnection();
+        const name = this.options.tableName;
+        const deadline = Date.now() + (this.options.lockTimeout ?? Infinity);
+        // a session-level lock on a reserved connection spans all transactions of the run, while its queries keep using the pool
+        return connection
+            .getClient()
+            .connection()
+            .execute(async (db) => {
+            let waiting = false;
+            while (!(await connection.execute(lock.acquire, [name], 'get', db)).locked) {
+                if (Date.now() >= deadline) {
+                    throw new Error(`Timed out after ${this.options.lockTimeout} ms waiting for the migration lock`);
+                }
+                if (!waiting && !this.options.silent) {
+                    const logger = this.config.getLogger();
+                    logger.log('migrator', 'Waiting for the migration lock held by another run', { enabled: true });
+                }
+                waiting = true;
+                await new Promise(resolve => setTimeout(resolve, Math.min(500, deadline - Date.now())));
+            }
+            try {
+                return await cb();
+            }
+            finally {
+                await connection.execute(lock.release, [name], 'run', db);
+            }
+        });
+    }
     /**
      * @inheritDoc
      */
@@ -148,7 +188,7 @@ export class Migrator extends AbstractMigrator {
         };
     }
     async runMigrations(method, options) {
-        const result = await super.runMigrations(method, options);
+        const result = await this.runLocked(() => super.runMigrations(method, options));
         if (result.length > 0 && this.options.snapshot && this.options.snapshotOnMigrate) {
             const ctx = Utils.isObject(options) ? options.transaction : undefined;
             const { skipTables, skipViews } = this.config.get('schemaGenerator');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/migrations",
-  "version": "7.3.0-dev.15",
+  "version": "7.3.0-dev.17",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "keywords": [
     "data-mapper",
@@ -47,13 +47,13 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.3.0-dev.15"
+    "@mikro-orm/sql": "7.3.0-dev.17"
   },
   "devDependencies": {
     "@mikro-orm/core": "^7.2.3"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.3.0-dev.15"
+    "@mikro-orm/core": "7.3.0-dev.17"
   },
   "engines": {
     "node": ">= 22.17.0"