feat: add afterUpSuccess method to migrations

Allows to run something after the MongoDB transaction, only if it was successful.

Author: targos

adonis-typings/migration.ts

@@ -24,6 +24,7 @@ declare module '@ioc:Zakodium/Mongodb/Migration' {
       callback: (db: Db, client: ClientSession) => Promise<void>,
     ): void;
     public abstract up(): void;
+    public afterUpSuccess?(): unknown;
     public execUp(session: ClientSession): Promise<void>;
   }
 }

commands/MongodbMigrate.ts

@@ -2,12 +2,12 @@ import { inject } from '@adonisjs/core/build/standalone';
 import { ObjectId } from 'mongodb';
 
 import { DatabaseContract } from '@ioc:Zakodium/Mongodb/Database';
+import Migration from '@ioc:Zakodium/Mongodb/Migration';
 
 import MigrationCommand, {
   migrationCollectionName,
   migrationLockCollectionName,
 } from './util/MigrationCommand';
-import Migration from '@ioc:Zakodium/Mongodb/Migration';
 
 interface IMigration {
   _id: ObjectId | undefined;
@@ -123,6 +123,17 @@ export default class MongodbMigrate extends MigrationCommand {
         break;
       }
 
+      if (migration.afterUpSuccess) {
+        try {
+          await migration.afterUpSuccess();
+        } catch (error) {
+          this.logger.warning(`Migration's afterUpSuccess call failed`);
+          // TODO: See if there can be a way in Ace commands to print error stack traces
+          // eslint-disable-next-line no-console
+          console.warn(error);
+        }
+      }
+
       successfullyExecuted++;
     }
 

src/Migration.ts

@@ -173,6 +173,7 @@ export default function createMigration(Database: DatabaseContract): any {
     }
 
     public abstract up(): void;
+    public afterUpSuccess?(): void;
   }
 
   return Migration;