Refactor .gitignore and app.module.ts, and remove unnecessary migration files

Author: tacxou

.gitignore

@@ -43,3 +43,5 @@ documentation/*
 app/.idea/modules.xml
 app/.idea/app.iml
 app/.idea/inspectionProfiles/Project_Default.xml
+
+migrations.lock

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/jobs/1729092595-employee-number.ts

@@ -0,0 +1,32 @@
+import { Logger } from "@nestjs/common"
+import { InjectConnection } from "@nestjs/mongoose"
+import { Connection } from "mongoose"
+
+export default class EmployeeNumber1729092595 {
+  public constructor(@InjectConnection() private connection: Connection) {
+
+  }
+
+  public async up(): Promise<void> {
+    Logger.log('EmployeeNumber1729092595 up')
+
+    Logger.log('this.connection.readyState', this.connection.readyState)
+
+    return new Promise((resolve) => {
+      const interval = setInterval(() => {
+        Logger.log('EmployeeNumber1729092595 up in progress')
+      }, 1_000)
+
+      setTimeout(() => {
+        clearInterval(interval)
+        Logger.log('EmployeeNumber1729092595 up done')
+1729092595
+        resolve()
+      }, 5_000)
+    })
+  }
+
+  public async down(): Promise<void> {
+    Logger.log('EmployeeNumber1729092595 down')
+  }
+}

…ns/jobs/1316027432511-employee-number.ts …tions/jobs/1729092660-employee-number.tssrc/migrations/jobs/1316027432511-employee-number.ts renamed to src/migrations/jobs/1729092660-employee-number.ts src/migrations/jobs/1316027432511-employee-number.ts renamed to src/migrations/jobs/1729092660-employee-number.ts

@@ -2,31 +2,31 @@ import { Logger } from "@nestjs/common"
 import { InjectConnection } from "@nestjs/mongoose"
 import { Connection } from "mongoose"
 
-export default class EmployeeNumber1616027432511 {
+export default class EmployeeNumber1729092660 {
   public constructor(@InjectConnection() private connection: Connection) {
 
   }
 
   public async up(): Promise<void> {
-    Logger.log('EmployeeNumber1616027432511 up')
+    Logger.log('EmployeeNumber1729092660 up')
 
     Logger.log('this.connection.readyState', this.connection.readyState)
 
     return new Promise((resolve) => {
       const interval = setInterval(() => {
-        Logger.log('EmployeeNumber1616027432511 up in progress')
+        Logger.log('EmployeeNumber1729092660 up in progress')
       }, 1_000)
 
       setTimeout(() => {
         clearInterval(interval)
-        Logger.log('EmployeeNumber1616027432511 up done')
+        Logger.log('EmployeeNumber1729092660 up done')
 
         resolve()
       }, 5_000)
     })
   }
 
   public async down(): Promise<void> {
-    Logger.log('EmployeeNumber1616027432511 down')
+    Logger.log('EmployeeNumber1729092660 down')
   }
 }

src/migrations/jobs/nonvalidfile.ts

@@ -0,0 +1,20 @@
+import readline from 'readline';
+
+export function startLoader(message) {
+  let currentFrame = 0;
+  const spinnerFrames = ['-', '\\', '|', '/'];
+
+  const loaderInterval = setInterval(() => {
+    readline.cursorTo(process.stdout, 0);
+    process.stdout.write(`${spinnerFrames[currentFrame]} ${message} `);
+    currentFrame = (currentFrame + 1) % spinnerFrames.length;
+  }, 100);
+
+  return loaderInterval;
+}
+
+export function stopLoader(loaderInterval) {
+  clearInterval(loaderInterval);
+  readline.cursorTo(process.stdout, 0);
+  process.stdout.clearLine(0);
+}

src/migrations/migration-loader.function.ts

@@ -1,39 +1,17 @@
-import { DynamicModule, Logger, Module } from '@nestjs/common';
-import { glob } from 'glob';
-import chalk from 'chalk';
+import { DynamicModule, Module } from '@nestjs/common';
 import { MigrationsService } from './migrations.service';
+import { RunMigrationService } from './run-migration.service';
 
 @Module({
-  imports: [],
   providers: [
     MigrationsService,
+    RunMigrationService,
   ],
 })
 export class MigrationsModule {
   public static async register(): Promise<DynamicModule> {
-    const jobs = [];
-    const files = await glob(`./jobs/*.js`, {
-      cwd: __dirname,
-      root: __dirname,
-    });
-
-    for (const file of files) {
-      const migration = await import(`${__dirname}/${file}`);
-
-      if (!migration.default) {
-        Logger.log(chalk.yellow(`Migration ${chalk.bold('<' + file + '>')} does not have a default export !`));
-        return;
-      }
-
-      jobs.push(migration.default);
-    }
-
     return {
       module: this,
-      providers: [
-        ...Reflect.getMetadata('providers', this),
-        ...jobs,
-      ],
     }
   }
 }

src/migrations/migrations.module.ts

@@ -1,74 +1,100 @@
 import { Injectable, Logger, OnModuleInit } from '@nestjs/common'
-import { InjectModel } from '@nestjs/mongoose'
-import { Model } from 'mongoose'
 import { glob } from 'glob'
-import readline from 'readline'
 import chalk from 'chalk'
-
-function startLoader(message) {
-  let currentFrame = 0;
-  const spinnerFrames = ['-', '\\', '|', '/'];
-
-  const loaderInterval = setInterval(() => {
-    readline.cursorTo(process.stdout, 0);
-    process.stdout.write(`${spinnerFrames[currentFrame]} ${message} `);
-    currentFrame = (currentFrame + 1) % spinnerFrames.length;
-  }, 100);
-
-  return loaderInterval;
-}
-
-function stopLoader(loaderInterval) {
-  clearInterval(loaderInterval);
-  readline.cursorTo(process.stdout, 0);
-  process.stdout.clearLine(0);
-}
+import { ModuleRef } from '@nestjs/core'
+import { startLoader, stopLoader } from './migration-loader.function'
+import { readFile, writeFile } from 'fs/promises'
 
 @Injectable()
 export class MigrationsService implements OnModuleInit {
   private readonly logger = new Logger(`${chalk.bold.red(MigrationsService.name)}\x1b[33m`)
 
   protected migrations = new Map<string, any>()
 
-  public constructor() { }
+  public constructor(private readonly moduleRef: ModuleRef) { }
 
   public async onModuleInit() {
-    await this.runMigrations()
-  }
-
-  public async runMigrations() {
+    await this._checkMigrationLockFile()
     this.logger.log(chalk.yellow('Checking migrations files...'));
-    await this._loadMigrationsFiles()
-
+    await this._loadMigrationsFiles();
 
     const loader = startLoader('Migration en cours...');
     await this._executeMigrations();
     stopLoader(loader);
   }
 
+  private async _checkMigrationLockFile() {
+    let migrationTimestamp = 0
+
+    try {
+      const migration = await readFile('./migrations.lock', 'utf-8')
+      console.log('migration', migration)
+    } catch (error) {
+      this.logger.warn(chalk.red('No migration lock file found.'))
+    }
+
+    if (migrationTimestamp === 0) {
+      try {
+        await writeFile('./migrations.lock', migrationTimestamp.toString())
+        this.logger.log(chalk.green('Migration lock file created.'))
+      } catch (error) {
+        this.logger.error(chalk.red('Error while creating migration lock file !'))
+      }
+    }
+  }
+
   private async _loadMigrationsFiles() {
-    const files = await glob(`./migrations/*.js`, {
+    const currentTimestamp = 1729092659
+    // const currentTimestamp = Date.now()
+    let files = await glob(`./jobs/*.js`, {
       cwd: __dirname,
       root: __dirname,
     });
 
+    files = files.filter((file) => {
+      const [timestampMatch] = file.match(/\d{10,}/) || []
+
+      if (!timestampMatch) {
+        this.logger.warn(chalk.yellow(`Migration ${chalk.bold('<' + file.replace(/.js$/, '') + '>')} does not have a timestamp in the filename !`));
+        return;
+      }
+
+      if (parseInt(timestampMatch) < currentTimestamp) {
+        this.logger.debug(chalk.yellow(`Migration ${chalk.bold('<' + file.replace(/.js$/, '') + '>')} are already executed !`));
+        return false;
+      }
+
+      return true
+    })
+
+    files = files.sort((a, b) => {
+      const [aTimestamp] = a.match(/\d{10,}/) || []
+      const [bTimestamp] = b.match(/\d{10,}/) || []
+
+      return parseInt(aTimestamp) - parseInt(bTimestamp)
+    })
+
     for (const file of files) {
       const migration = await import(`${__dirname}/${file}`);
+      const [timestampMatch] = file.match(/\d{10,}/) || []
+
+      console.log('file', timestampMatch)
 
       if (!migration.default) {
         this.logger.log(chalk.yellow(`Migration ${chalk.bold('<' + file + '>')} does not have a default export !`));
         return;
       }
 
-      this.migrations.set(file, migration)
+      this.migrations.set(timestampMatch, migration)
     }
   }
 
   private async _executeMigrations() {
-    console.log('this.migrations.keys()', this.migrations.keys())
     for (const key of this.migrations.keys()) {
+      this.logger.log(chalk.yellow(`Running migration ${chalk.bold('<' + key + '>')}...`));
+
       const migration = this.migrations.get(key);
-      const instance = new migration.default();
+      const instance = await this.moduleRef.create(migration.default);
 
       if (typeof instance.up !== 'function') {
         this.logger.log(chalk.yellow(`Migration ${chalk.bold('<' + key + '>')} does not have an up method !`));
@@ -78,5 +104,7 @@ export class MigrationsService implements OnModuleInit {
       this.logger.log(chalk.yellow(`Running migration ${chalk.bold('<' + key + '>')}...`));
       await instance.up();
     }
+
+    this.logger.log(chalk.green('All migrations done.'));
   }
 }

src/migrations/migrations.service.ts

@@ -0,0 +1,6 @@
+import { Injectable } from "@nestjs/common";
+
+@Injectable()
+export class RunMigrationService {
+
+}