Refactor migrations module and service

Author: tacxou

src/app.module.ts

@@ -94,7 +94,7 @@ import { MigrationsModule } from './migrations/migrations.module';
     CoreModule.register(),
     ManagementModule.register(),
     SettingsModule.register(),
-    // MigrationsModule.register(),
+    MigrationsModule.register(),
   ],
   controllers: [AppController],
   providers: [

src/migrations/migrations.module.ts

@@ -1,11 +1,9 @@
 import { DynamicModule, Module } from '@nestjs/common';
 import { MigrationsService } from './migrations.service';
-import { RunMigrationService } from './run-migration.service';
 
 @Module({
   providers: [
     MigrationsService,
-    RunMigrationService,
   ],
 })
 export class MigrationsModule {

src/migrations/migrations.service.ts

@@ -5,16 +5,24 @@ import { ModuleRef } from '@nestjs/core'
 import { startLoader, stopLoader } from './migration-loader.function'
 import { readFile, writeFile } from 'fs/promises'
 import { posix } from 'path'
+import { ConfigService } from '@nestjs/config'
+import { Connection } from 'mongoose'
+import { InjectConnection } from '@nestjs/mongoose'
 
 @Injectable()
 export class MigrationsService implements OnModuleInit {
   private readonly logger = new Logger(`${chalk.bold.red(MigrationsService.name)}\x1b[33m`)
 
+  protected lockLocation: string
   protected migrations = new Map<string, any>()
 
-  protected lockLocation = posix.join(process.cwd(), 'migrations.lock')
+  public constructor(
+    @InjectConnection() private readonly mongo: Connection,
+    private readonly moduleRef: ModuleRef,
+    private readonly config: ConfigService,
 
-  public constructor(private readonly moduleRef: ModuleRef) {
+  ) {
+    this.lockLocation = posix.join(this.config.get('factorydrive.options.disks.local.config.root', '/tmp'), 'migrations.lock')
   }
 
   public async onModuleInit() {
@@ -33,22 +41,43 @@ export class MigrationsService implements OnModuleInit {
     let currentTimestamp = 0
 
     try {
-      const migration = await readFile(this.lockLocation, 'utf-8')
-      currentTimestamp = parseInt(migration, 10)
+      const migration = await readFile(this.lockLocation, 'utf-8');
+      currentTimestamp = parseInt(migration, 10);
       this.logger.log(chalk.blue(`Migration lock state is <${currentTimestamp}> !`));
     } catch (error) {
-      this.logger.warn(chalk.red('No migration lock file found.'))
+      this.logger.warn(chalk.red('No migration lock file found.'));
     }
 
+    const dbMigration = await this.mongo.collection('migrations').findOne({}, { sort: { timestamp: -1 } });
+
     if (currentTimestamp === 0) {
-      try {
-        await writeFile(this.lockLocation, currentTimestamp.toString())
-        this.logger.log(chalk.green('Migration lock file created.'))
-      } catch (error) {
-        this.logger.error(chalk.red('Error while creating migration lock file !'))
+      if (dbMigration) {
+        try {
+          this.logger.warn(chalk.yellow('No migration lock file found. Creating one with the last migration timestamp...'));
+          await writeFile(this.lockLocation, dbMigration.timestamp.toString());
+          this.logger.log(chalk.green('Migration lock file created.'));
+        } catch (error) {
+          this.logger.error(chalk.red('Error while creating migration lock file !'));
+        }
+      } else {
+        try {
+          await writeFile(this.lockLocation, currentTimestamp.toString());
+          this.logger.log(chalk.green('Migration lock file created.'));
+        } catch (error) {
+          this.logger.error(chalk.red('Error while creating migration lock file !'));
+        }
       }
     }
 
+    if (!dbMigration && currentTimestamp !== 0) {
+      this.logger.error(chalk.red('Database is not up to date with the migrations files !'));
+      await this.mongo.collection('migrations').insertOne({
+        timestamp: currentTimestamp,
+        comment: 'Synchronization with the migration lock file',
+      });
+      this.logger.log(chalk.green('Database updated with the current migration lock file !'));
+    }
+
     return currentTimestamp
   }
 
@@ -99,6 +128,11 @@ export class MigrationsService implements OnModuleInit {
       return;
     }
 
+    if (!this.migrations.size) {
+      this.logger.log(chalk.blue('No migrations to execute.'));
+      return;
+    }
+
     for (const key of this.migrations.keys()) {
       const [migrationTimestamp] = key.match(/\d{10,}/) || []
 
@@ -120,7 +154,11 @@ export class MigrationsService implements OnModuleInit {
       }
 
       try {
-        await writeFile('./migrations.lock', migrationTimestamp);
+        await writeFile(this.lockLocation, migrationTimestamp);
+        await this.mongo.collection('migrations').insertOne({
+          timestamp: parseInt(migrationTimestamp),
+          comment: `Migration ${key} executed`,
+        })
         this.logger.log(chalk.blue(`Migration ${chalk.bold('<' + key + '>')} done.`));
       } catch (e) {
         this.logger.error(chalk.red(`Error while updating migration lock file !`));