Merge branch 'main' into fix/#3881-validate-user-account

Author: dheepak-aot

sources/packages/backend/apps/queue-consumers/src/bull-board/bull-board-queues-registration.module.ts

@@ -0,0 +1,45 @@
+import { Inject, LoggerService, Module, OnModuleInit } from "@nestjs/common";
+import { ModuleRef } from "@nestjs/core";
+import { BULL_BOARD_INSTANCE, BullBoardInstance } from "@bull-board/nestjs";
+import { QueueService } from "@sims/services/queue/queue.service";
+import { InjectLogger } from "@sims/utilities/logger";
+import { getQueueToken } from "@nestjs/bull";
+import { Queue } from "bull";
+import { BullAdapter } from "@bull-board/api/bullAdapter";
+
+@Module({})
+export class BullBoardQueuesRegistrationModule implements OnModuleInit {
+  constructor(
+    private readonly moduleRef: ModuleRef,
+    private readonly queueService: QueueService,
+    @Inject(BULL_BOARD_INSTANCE)
+    private readonly board: BullBoardInstance,
+  ) {}
+
+  /**
+   * Adds all queues to the bull board during application initialization
+   * checking if the queue is active and if it is a scheduler.
+   */
+  async onModuleInit(): Promise<void> {
+    const queues = await this.queueService.queueConfigurationModel();
+    queues.forEach((queue) => {
+      if (!queue.isActive && queue.isScheduler) {
+        this.logger.log(`Queue service '${queue.name}' is inactive.`);
+        return;
+      }
+      const queueProvider = this.moduleRef.get<Queue>(
+        getQueueToken(queue.name),
+        {
+          strict: false,
+        },
+      );
+      const queueAdapter = new BullAdapter(queueProvider, {
+        readOnlyMode: queue.dashboardReadonly,
+      });
+      this.board.addQueue(queueAdapter);
+    });
+  }
+
+  @InjectLogger()
+  logger: LoggerService;
+}

sources/packages/backend/apps/queue-consumers/src/bull-board/bull-board-queues.module.ts

@@ -0,0 +1,58 @@
+import { Module } from "@nestjs/common";
+import { BullBoardModule, BullBoardModuleOptions } from "@bull-board/nestjs";
+import { ConfigModule, ConfigService } from "@sims/utilities/config";
+import * as basicAuth from "express-basic-auth";
+import { ExpressAdapter } from "@bull-board/express";
+import { BULL_BOARD_ROUTE } from "../constants";
+import { BullBoardQueuesRegistrationModule } from "./bull-board-queues-registration.module";
+
+/**
+ * Bull board related modules to allow the dashboard to be registered.
+ */
+@Module({
+  imports: [
+    BullBoardModule.forRootAsync({
+      imports: [ConfigModule],
+      useFactory: bullBoardModuleFactory,
+      inject: [ConfigService],
+    }),
+    BullBoardQueuesRegistrationModule,
+  ],
+  exports: [BullBoardModule, BullBoardQueuesRegistrationModule],
+})
+export class BullBoardQueuesModule {}
+
+/**
+ * Builds the Bull Board module options to register the dashboard in a dynamic way.
+ * @param configService service with the configuration of the application.
+ * @returns Bull Board module options with the dashboard route,
+ * authentication middleware and the board options.
+ */
+async function bullBoardModuleFactory(
+  configService: ConfigService,
+): Promise<BullBoardModuleOptions> {
+  const queueDashboardUsers = {};
+  queueDashboardUsers[configService.queueDashboardCredential.userName] =
+    configService.queueDashboardCredential.password;
+  const authMiddleware = basicAuth({
+    users: queueDashboardUsers,
+    challenge: true,
+  });
+  return {
+    route: BULL_BOARD_ROUTE,
+    adapter: ExpressAdapter,
+    middleware: authMiddleware,
+    boardOptions: {
+      uiConfig: {
+        boardTitle: "SIMS-Queues",
+        boardLogo: {
+          path: "https://sims.studentaidbc.ca/favicon-32x32.png",
+        },
+        favIcon: {
+          default: "https://sims.studentaidbc.ca/favicon-16x16.png",
+          alternative: "https://sims.studentaidbc.ca/favicon-32x32.png",
+        },
+      },
+    },
+  };
+}

sources/packages/backend/apps/queue-consumers/src/constants/index.ts

@@ -0,0 +1,2 @@
+export * from "./error-code.constants";
+export * from "./system-configurations.constants";

sources/packages/backend/apps/queue-consumers/src/constants/system-configurations.constants.ts

@@ -0,0 +1,4 @@
+/**
+ * Bull Dashboard route.
+ */
+export const BULL_BOARD_ROUTE = "admin/queues";

sources/packages/backend/apps/queue-consumers/src/main.ts

@@ -1,13 +1,7 @@
 import "../../../env-setup";
-import { QueueService } from "@sims/services/queue";
 import { ConfigService } from "@sims/utilities/config";
-import { createBullBoard } from "@bull-board/api";
-import { BullAdapter } from "@bull-board/api/bullAdapter";
-import { ExpressAdapter } from "@bull-board/express";
 import { NestFactory } from "@nestjs/core";
-import { Queue } from "bull";
 import { QueueConsumersModule } from "./queue-consumers.module";
-import * as basicAuth from "express-basic-auth";
 import { LoggerService } from "@sims/utilities/logger";
 import { SystemUsersService } from "@sims/services";
 
@@ -23,40 +17,5 @@ import { SystemUsersService } from "@sims/services";
   const systemUsersService = app.get(SystemUsersService);
   await systemUsersService.loadSystemUser();
 
-  // Queue service.
-  const queueService = app.get<QueueService>(QueueService);
-  const queues = await queueService.queueConfigurationModel();
-  // Create bull board UI dashboard for queue management.
-  const serverAdapter = new ExpressAdapter();
-  serverAdapter.setBasePath("/admin/queues");
-  const bullBoardQueues: BullAdapter[] = [];
-  queues.forEach((queue) => {
-    if (!queue.isActive && queue.isScheduler) {
-      logger.log(`Queue service "${queue.name}" is inactive.`);
-    } else {
-      bullBoardQueues.push(
-        new BullAdapter(app.get<Queue>(`BullQueue_${queue.name}`), {
-          readOnlyMode: queue.dashboardReadonly,
-        }),
-      );
-    }
-  });
-  createBullBoard({
-    queues: bullBoardQueues,
-    serverAdapter,
-  });
-  // Bull board user for basic authentication.
-  const queueDashboardUsers = {};
-  queueDashboardUsers[config.queueDashboardCredential.userName] =
-    config.queueDashboardCredential.password;
-  app.use(
-    "/admin/queues",
-    basicAuth({
-      users: queueDashboardUsers,
-      challenge: true,
-    }),
-    serverAdapter.getRouter(),
-  );
-
   await app.listen(config.queueConsumersPort);
 })();

sources/packages/backend/apps/queue-consumers/src/queue-consumers.module.ts

@@ -78,13 +78,15 @@ import { CASSupplierIntegrationService } from "./services/cas-supplier/cas-suppl
 import { VirusScanProcessor } from "./processors/virus-scan/virus-scan.processor";
 import { CASService } from "@sims/integrations/cas/cas.service";
 import { ObjectStorageService } from "@sims/integrations/object-storage";
+import { BullBoardQueuesModule } from "./bull-board/bull-board-queues.module";
 
 // TODO: Removed ATBCResponseIntegrationScheduler in providers, the queuename from enum and the decorators of the processor as part of #2539.
 @Module({
   imports: [
     GlobalHttpModule,
     DatabaseModule,
     QueueModule,
+    BullBoardQueuesModule,
     ZeebeModule.forRoot(),
     IER12IntegrationModule,
     ECEIntegrationModule,

sources/packages/backend/apps/queue-consumers/test/helpers/testing-modules/testing-modules-helper.ts

@@ -2,13 +2,15 @@ import { INestApplication } from "@nestjs/common";
 import { Test, TestingModule } from "@nestjs/testing";
 import { DataSource } from "typeorm";
 import { QueueConsumersModule } from "../../../src/queue-consumers.module";
+import { BullBoardQueuesModule } from "../../../src/bull-board/bull-board-queues.module";
 import { SshService } from "@sims/integrations/services";
 import { overrideImportsMetadata } from "@sims/test-utils";
 import {
   QueueModuleMock,
   createObjectStorageServiceMock,
   createSSHServiceMock,
   createZeebeModuleMock,
+  BullBoardQueuesModuleMock,
 } from "@sims/test-utils/mocks";
 import * as Client from "ssh2-sftp-client";
 import { DeepMocked, createMock } from "@golevelup/ts-jest";
@@ -45,6 +47,10 @@ export async function createTestingAppModule(): Promise<CreateTestingModuleResul
       replace: QueueModule,
       by: QueueModuleMock,
     },
+    {
+      replace: BullBoardQueuesModule,
+      by: BullBoardQueuesModuleMock,
+    },
     {
       replace: ZeebeModule,
       by: createZeebeModuleMock(),

sources/packages/backend/libs/test-utils/src/mocks/bull-board-queues-module-mock.ts

@@ -0,0 +1,9 @@
+import { Global, Module } from "@nestjs/common";
+
+/**
+ * Mock to entirely replace the Bull Board queues module
+ * that are not part of the E2E tests.
+ */
+@Global()
+@Module({})
+export class BullBoardQueuesModuleMock {}

sources/packages/backend/libs/test-utils/src/mocks/index.ts

@@ -2,3 +2,4 @@ export * from "./ssh-service-mock";
 export * from "./queue-module-mock";
 export * from "./zeebe-client-mock";
 export * from "./object-storage-service-mock";
+export * from "./bull-board-queues-module-mock";

sources/packages/backend/package-lock.json

@@ -43,9 +43,10 @@
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.663.0",
-    "@bull-board/api": "^5.15.1",
-    "@bull-board/express": "^5.15.1",
-    "@bull-board/ui": "^5.15.1",
+    "@bull-board/api": "^6.5.2",
+    "@bull-board/express": "^6.5.2",
+    "@bull-board/nestjs": "^6.5.2",
+    "@bull-board/ui": "^6.5.2",
     "@camunda8/sdk": "^8.6.13",
     "@golevelup/nestjs-discovery": "^4.0.0",
     "@nestjs/axios": "^3.0.2",