@orion-js/migrations 3.6.6 → 3.6.8

package/lib/MigrationsService.d.ts

@@ -1,8 +1,9 @@
 import { MigrationExecutable } from './service';
+import { ExecutionContext } from '@orion-js/dogs';
 export declare class MigrationsService {
     private migrationsRepo;
     getNextMigration(migrationsList: MigrationExecutable[]): Promise<MigrationExecutable>;
-    runMigrations(migrationsList: MigrationExecutable[]): Promise<void>;
-    runMigration(func: () => Promise<void>): Promise<void>;
-    runAsTransaction(func: () => Promise<void>): Promise<void>;
+    runMigrations(migrationsList: MigrationExecutable[], context: ExecutionContext): Promise<void>;
+    runMigration(func: (context: ExecutionContext) => Promise<void>, context: ExecutionContext): Promise<void>;
+    runAsTransaction(func: (context: ExecutionContext) => Promise<void>, context: ExecutionContext): Promise<void>;
 }

package/lib/MigrationsService.js

@@ -22,36 +22,36 @@ let MigrationsService = exports.MigrationsService = class MigrationsService {
             return migrationExecutable;
         }
     }
-    async runMigrations(migrationsList) {
+    async runMigrations(migrationsList, context) {
         const next = await this.getNextMigration(migrationsList);
         if (!next)
             return;
         logger_1.logger.info('[orionjs/migrations] Running migration...', { name: next.name });
         if (next.useMongoTransactions) {
-            await this.runAsTransaction(next.runMigration);
+            await this.runAsTransaction(next.runMigration, context);
         }
         else {
-            await this.runMigration(next.runMigration);
+            await this.runMigration(next.runMigration, context);
         }
         logger_1.logger.info('[orionjs/migrations] Migration executed correctly', { name: next.name });
         await this.migrationsRepo.saveCompletedMigration(next.name);
-        await this.runMigrations(migrationsList);
+        await this.runMigrations(migrationsList, context);
     }
-    async runMigration(func) {
+    async runMigration(func, context) {
         try {
-            await func();
+            await func(context);
         }
         catch (error) {
             logger_1.logger.error('[orionjs/migrations] Error running migration', error);
             throw error;
         }
     }
-    async runAsTransaction(func) {
+    async runAsTransaction(func, context) {
         const { client } = this.migrationsRepo.collection.client;
         const session = client.startSession();
         await session.withTransaction(async () => {
             try {
-                await func();
+                await func(context);
             }
             catch (error) {
                 logger_1.logger.error('[orionjs/migrations] Error running migration, will abort transaction', error);

package/lib/index.test.js

@@ -28,11 +28,12 @@ describe('Migrations end to end', () => {
         ], MoveUsersMigrationService);
         const migrationExecutables = (0, loadMigrations_1.loadMigrations)([MoveUsersMigrationService], { omitJob: true });
         const instance = (0, services_1.getInstance)(MigrationsService_1.MigrationsService);
-        await instance.runMigrations(migrationExecutables);
-        await instance.runMigrations(migrationExecutables);
-        await instance.runMigrations(migrationExecutables);
-        await instance.runMigrations(migrationExecutables);
-        await instance.runMigrations(migrationExecutables);
+        const context = {};
+        await instance.runMigrations(migrationExecutables, context);
+        await instance.runMigrations(migrationExecutables, context);
+        await instance.runMigrations(migrationExecutables, context);
+        await instance.runMigrations(migrationExecutables, context);
+        await instance.runMigrations(migrationExecutables, context);
         expect(executions).toBe(1);
     });
     it('should not set a migration completed if it fails', async () => {
@@ -50,8 +51,9 @@ describe('Migrations end to end', () => {
         ], MoveUsersMigrationService);
         const migrationExecutables = (0, loadMigrations_1.loadMigrations)([MoveUsersMigrationService], { omitJob: true });
         const instance = (0, services_1.getInstance)(MigrationsService_1.MigrationsService);
+        const context = {};
         try {
-            await instance.runMigrations(migrationExecutables);
+            await instance.runMigrations(migrationExecutables, context);
         }
         catch { }
         const migrationsRepo = (0, services_1.getInstance)(Repo_1.MigrationsRepo);

package/lib/loadMigrations/index.js

@@ -18,9 +18,9 @@ function loadMigrations(migrationServices, options) {
             orionjsRunMigrations: (0, dogs_1.defineJob)({
                 type: 'recurrent',
                 runEvery: 30 * 1000,
-                async resolve() {
+                async resolve(params, context) {
                     const instance = (0, services_1.getInstance)(MigrationsService_1.MigrationsService);
-                    await instance.runMigrations(migrations);
+                    await instance.runMigrations(migrations, context);
                 }
             })
         }

package/lib/service/index.d.ts

@@ -1,9 +1,10 @@
+import { ExecutionContext } from '@orion-js/dogs';
 export interface MigrationServiceOptions {
     name: string;
     useMongoTransactions: false;
 }
 export declare function MigrationService(options: MigrationServiceOptions): ClassDecorator;
 export type MigrationExecutable = {
-    runMigration(): Promise<void>;
+    runMigration(context: ExecutionContext): Promise<void>;
 } & MigrationServiceOptions;
 export declare function getMigrationsFromServices(services: any[]): MigrationExecutable[];

package/lib/service/index.js

@@ -19,9 +19,9 @@ function getMigrationsFromServices(services) {
         const options = service.prototype.options;
         return {
             ...options,
-            runMigration: async () => {
+            runMigration: async (context) => {
                 const instance = (0, services_1.getInstance)(service);
-                return await instance.runMigration();
+                return await instance.runMigration(context);
             }
         };
     });

package/lib/service/index.test.js

@@ -10,9 +10,11 @@ const _1 = require(".");
 describe('Migration as IOC', () => {
     it('should create a migration service', async () => {
         let didRun = false;
+        let didExtend = false;
         let MoveUsersMigrationService = class MoveUsersMigrationService {
-            async runMigration() {
+            async runMigration(context) {
                 didRun = true;
+                context.extendLockTime(1000);
             }
         };
         MoveUsersMigrationService = __decorate([
@@ -25,9 +27,14 @@ describe('Migration as IOC', () => {
         let lastName = null;
         for (const { runMigration, name } of migrations) {
             lastName = name;
-            await runMigration();
+            await runMigration({
+                extendLockTime: time => {
+                    didExtend = true;
+                }
+            });
         }
         expect(lastName).toBe('moveUsers');
         expect(didRun).toBe(true);
+        expect(didExtend).toBe(true);
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/migrations",
-  "version": "3.6.6",
+  "version": "3.6.8",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -40,5 +40,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "909ed69b06dd958b2f30f5b5446afce6a34bef51"
+  "gitHead": "90170d94e2b04b940ac2d1272f77e139fa56ecd8"
 }