Refactor migrations module and service

Author: tacxou

src/migrations/jobs/1729092595-employee-number.ts

@@ -0,0 +1,34 @@
+import { Logger } from "@nestjs/common"
+import { InjectConnection, InjectModel } from "@nestjs/mongoose"
+import { Connection, Model } from "mongoose"
+
+export default class EmployeeNumber1729517173 {
+  private readonly logger = new Logger(EmployeeNumber1729517173.name)
+
+  public constructor(
+    @InjectConnection() private mongo: Connection,
+  ) {
+  }
+
+  public async up(): Promise<void> {
+    this.logger.log('EmployeeNumber1729092660 up started')
+
+    await this._migrateEmployeeNumberToArray()
+  }
+
+  private async _migrateEmployeeNumberToArray(): Promise<void> {
+    const identities = await this.mongo.collection('identities').find();
+
+    for await (const identity of identities) {
+      const employeeNumber = identity.inetOrgPerson.employeeNumber;
+
+      if (typeof employeeNumber === 'string') {
+        this.logger.log(`Migrating employeeNumber for identity ${identity._id}`);
+        identity.inetOrgPerson.employeeNumber = [employeeNumber];
+        this.mongo.collection('identities').updateOne({ _id: identity._id }, { $set: { 'inetOrgPerson.employeeNumber': [employeeNumber] } });
+      }
+    }
+
+    this.logger.log('Migration terminée avec succès');
+  }
+}

src/migrations/jobs/1729092660-employee-number.ts

@@ -149,33 +149,29 @@ export class MigrationsService implements OnModuleInit {
         await instance.up();
       } catch (e) {
         this.logger.error(chalk.red(`Error while running migration ${chalk.bold('<' + key + '>')} !`));
-        this.logger.error(e);
-        break;
+        this.logger.error(e.message, e.stack);
+        return;
       }
 
-      try {
-        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 !`));
-        this.logger.error(e);
-        break
-      }
+      this._writeMigrationLockFile(key, migrationTimestamp);
     }
 
     this.logger.log(chalk.blue('All migrations done.'));
   }
 
-  private async _validateMigration(migration: any) {
-    if (!migration.default) {
-      this.logger.log(chalk.yellow(`Migration ${chalk.bold('<' + migration + '>')} does not have a default export !`));
-      return false;
+  private async _writeMigrationLockFile(migrationKey: string, migrationTimestamp: string) {
+    try {
+      await writeFile(this.lockLocation, migrationTimestamp);
+      await this.mongo.collection('migrations').insertOne({
+        timestamp: parseInt(migrationTimestamp),
+        comment: `Migration ${migrationKey} executed`,
+      })
+      this.logger.log(chalk.blue(`Migration ${chalk.bold('<' + migrationKey + '>')} done.`));
+    } catch (e) {
+      this.logger.error(chalk.red(`Error while updating migration lock file !`));
+      this.logger.error(e);
+
+      throw new Error('Error while updating migration lock file !');
     }
-
-    return true;
   }
 }