feat(migrations): add migrations module (#1143)

package.json

@@ -14,8 +14,7 @@
     "test": "jest --watch",
     "test:ci": "jest --ci --maxWorkers 4",
     "test:e2e": "NODE_ENV=test jest --config e2e.jest.config.ts --forceExit --runInBand",
-    "release": "release-it",
-    "migrate": "migrate"
+    "release": "release-it"
   },
   "dependencies": {
     "@hapi/joi": "17.1.1",
@@ -29,6 +28,7 @@
     "@nestjs/schedule": "1.0.1",
     "@nestjs/serve-static": "2.2.2",
     "@nestjs/websockets": "8.0.6",
+    "app-root-path": "3.0.0",
     "async-mutex": "0.3.1",
     "cache-manager": "3.4.4",
     "class-transformer": "0.4.0",

src/app.module.ts

@@ -23,6 +23,7 @@ import { PluginsModule } from './plugins/plugins.module';
 import { LogReceiverModule } from './log-receiver/log-receiver.module';
 import { createMongoDbUri } from './utils/create-mongo-db-uri';
 import { MongooseModule } from '@nestjs/mongoose';
+import { MigrationsModule } from './migrations/migrations.module';
 
 @Module({
   imports: [
@@ -69,6 +70,7 @@ import { MongooseModule } from '@nestjs/mongoose';
     ConfigurationModule,
     PluginsModule.configure(),
     LogReceiverModule,
+    MigrationsModule,
   ],
   controllers: [AppController],
   providers: [AppService],

src/migrations/migration.store.ts

@@ -0,0 +1,11 @@
+// https://github.com/tj/node-migrate/blob/main/examples/custom-state-storage/mongo-state-storage.js
+
+interface MigrationSet {
+  lastRun: string;
+  migrations: any[];
+}
+
+export interface MigrationStore {
+  load: (callback: (error: any, data: MigrationSet) => any) => any;
+  save: (set: MigrationSet, callback: (error: any, result: any) => any) => any;
+}

src/migrations/migrations.module.ts

@@ -0,0 +1,17 @@
+import { Module } from '@nestjs/common';
+import { getConnectionToken } from '@nestjs/mongoose';
+import { Connection } from 'mongoose';
+import { MigrationsService } from './services/migrations.service';
+import { MongoDbStore } from './stores/mongo-db.store';
+
+@Module({
+  providers: [
+    {
+      provide: 'MIGRATION_STORE',
+      inject: [getConnectionToken()],
+      useFactory: (connection: Connection) => new MongoDbStore(connection),
+    },
+    MigrationsService,
+  ],
+})
+export class MigrationsModule {}

src/migrations/services/migrations.service.ts

@@ -0,0 +1,48 @@
+import {
+  Inject,
+  Injectable,
+  Logger,
+  OnApplicationBootstrap,
+} from '@nestjs/common';
+import { MigrationStore } from '../migration.store';
+import { load } from 'migrate';
+import { resolve as pathResolve } from 'path';
+import * as appRoot from 'app-root-path';
+
+@Injectable()
+export class MigrationsService implements OnApplicationBootstrap {
+  private logger = new Logger(MigrationsService.name);
+
+  constructor(
+    @Inject('MIGRATION_STORE') private migrationStore: MigrationStore,
+  ) {}
+
+  async onApplicationBootstrap() {
+    this.logger.log('running migrations...');
+    await this.runMigrations();
+    this.logger.log('migrations run successfully');
+  }
+
+  private async runMigrations() {
+    return new Promise<void>((resolve, reject) => {
+      load(
+        {
+          stateStore: this.migrationStore,
+          migrationsDirectory: pathResolve(appRoot.toString(), 'migrations'),
+        },
+        (error, set) => {
+          if (error) {
+            return reject(error);
+          }
+
+          set.up((error) => {
+            if (error) {
+              return reject(error);
+            }
+            resolve();
+          });
+        },
+      );
+    });
+  }
+}

src/migrations/stores/mongo-db.store.ts

@@ -0,0 +1,30 @@
+import { Connection } from 'mongoose';
+import { MigrationStore } from '../migration.store';
+
+export class MongoDbStore implements MigrationStore {
+  constructor(private connection: Connection) {}
+
+  async load(callback) {
+    const data = await this.connection.db.collection('migrations').findOne({});
+    return callback(null, data ?? {});
+  }
+
+  async save(data, callback) {
+    const result = await this.connection.db.collection('migrations').updateOne(
+      {},
+      {
+        $set: {
+          lastRun: data.lastRun,
+        },
+        $push: {
+          migrations: { $each: data.migrations },
+        },
+      },
+      {
+        upsert: true,
+      },
+    );
+
+    return callback(null, result);
+  }
+}