Merge branch 'main' into feature/#2510-e-cert-individual-student-processing-part-2

Author: andrewsignori-aot

devops/openshift/api-deploy.yml

@@ -241,8 +241,8 @@ objects:
             resource:
               name: cpu
               target:
-                type: AverageValue
-                averageValue: "0.18"
+                type: Utilization
+                averageUtilization: 80
           - type: Resource
             resource:
               name: memory

devops/openshift/forms-deploy.yml

@@ -175,8 +175,8 @@ objects:
             resource:
               name: cpu
               target:
-                type: AverageValue
-                averageValue: "0.8"
+                type: Utilization
+                averageUtilization: 50
           - type: Resource
             resource:
               name: memory

devops/openshift/queue-consumers-deploy.yml

@@ -252,8 +252,8 @@ objects:
             resource:
               name: cpu
               target:
-                type: AverageValue
-                averageValue: "0.18"
+                type: Utilization
+                averageUtilization: 80
           - type: Resource
             resource:
               name: memory

devops/openshift/web-deploy.yml

@@ -98,8 +98,8 @@ objects:
             resource:
               name: cpu
               target:
-                type: AverageValue
-                averageValue: "0.18"
+                type: Utilization
+                averageUtilization: 80
           - type: Resource
             resource:
               name: memory

devops/openshift/workers-deploy.yml

@@ -100,8 +100,8 @@ objects:
             resource:
               name: cpu
               target:
-                type: AverageValue
-                averageValue: "0.18"
+                type: Utilization
+                averageUtilization: 80
           - type: Resource
             resource:
               name: memory

sources/packages/backend/apps/api/src/main.ts

@@ -10,6 +10,8 @@ import { setGlobalPipes } from "./utilities/auth-utils";
 import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
 import { Request, Response } from "express";
 import { KeycloakConfig } from "@sims/auth/config";
+import helmet from "helmet";
+import { SystemUsersService } from "@sims/services";
 
 async function bootstrap() {
   await KeycloakConfig.load();
@@ -21,9 +23,22 @@ async function bootstrap() {
   const logger = await app.resolve(LoggerService);
   app.useLogger(logger);
 
+  logger.log("Loading system user...");
+  const systemUsersService = app.get(SystemUsersService);
+  await systemUsersService.loadSystemUser();
+
   // Setting global prefix
   app.setGlobalPrefix("api");
 
+  // Using helmet.
+  app.use(helmet());
+
+  // Adding headers not covered by helmet.
+  app.use((_, res, next) => {
+    res.setHeader("Cache-Control", "no-cache");
+    next();
+  });
+
   // Exception filter
   const { httpAdapter } = app.get(HttpAdapterHost);
   app.useGlobalFilters(new AppAllExceptionsFilter(httpAdapter));

sources/packages/backend/apps/api/src/services/application-offering-change-request/application-offering-change-request.service.ts

@@ -504,7 +504,7 @@ export class ApplicationOfferingChangeRequestService {
       const applicationOfferingChangeRequest = await transactionEntityManager
         .getRepository(ApplicationOfferingChangeRequest)
         .save(newRequest);
-      const systemUser = await this.systemUsersService.systemUser();
+      const systemUser = this.systemUsersService.systemUser;
       await this.notificationActionsService.saveApplicationOfferingChangeRequestInProgressWithStudentNotification(
         {
           givenNames: application.student.user.firstName,
@@ -607,7 +607,7 @@ export class ApplicationOfferingChangeRequestService {
         .getRepository(ApplicationOfferingChangeRequest)
         .save(applicationOfferingChangeRequest);
       // Send the application offering change request completed notification.
-      const systemUser = await this.systemUsersService.systemUser();
+      const systemUser = this.systemUsersService.systemUser;
       const user = applicationOfferingChangeRequest.application.student.user;
       await this.notificationActionsService.saveApplicationOfferingChangeRequestCompleteNotification(
         {

sources/packages/backend/apps/api/src/testHelpers/testing-modules/testing-modules-helper.ts

@@ -9,7 +9,7 @@ import {
   overrideImportsMetadata,
 } from "@sims/test-utils";
 import { QueueModule } from "@sims/services/queue";
-import { ZeebeModule } from "@sims/services";
+import { SystemUsersService, ZeebeModule } from "@sims/services";
 import { DiscoveryModule } from "@golevelup/nestjs-discovery";
 import { KeycloakConfig } from "@sims/auth/config";
 
@@ -45,6 +45,11 @@ export async function createTestingAppModule(): Promise<CreateTestingModuleResul
   const nestApplication = module.createNestApplication();
   setGlobalPipes(nestApplication);
   await nestApplication.init();
+
+  // Load system user.
+  const systemUsersService = nestApplication.get(SystemUsersService);
+  await systemUsersService.loadSystemUser();
+
   const dataSource = module.get(DataSource);
   return {
     nestApplication,

sources/packages/backend/apps/api/test/jest-e2e.json

@@ -10,7 +10,7 @@
   "transform": {
     "^.+\\.(t|j)s$": "ts-jest"
   },
-  "testTimeout": 60000,
+  "testTimeout": 90000,
   "workerIdleMemoryLimit": 0.2,
   "setupFiles": [
     "<rootDir>/../../env-setup.js"

sources/packages/backend/apps/db-migrations/src/migrations/1699574723306-AddAssessmentWorkflowQueueRetry.ts

@@ -0,0 +1,21 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+import { getSQLFileData } from "../utilities/sqlLoader";
+
+export class AddAssessmentWorkflowQueueRetry1699574723306
+  implements MigrationInterface
+{
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      getSQLFileData("Add-assessment-workflow-queue-retry.sql", "Queue"),
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      getSQLFileData(
+        "Rollback-add-assessment-workflow-queue-retry.sql",
+        "Queue",
+      ),
+    );
+  }
+}

sources/packages/backend/apps/db-migrations/src/sql/Queue/Add-assessment-workflow-queue-retry.sql

@@ -0,0 +1,14 @@
+INSERT INTO
+    sims.queue_configurations(queue_name, queue_configuration)
+VALUES
+    (
+        'assessment-workflow-queue-retry',
+        '{
+            "cron": "0 0 * * * ?",
+            "retry": 3,
+            "cleanUpPeriod": 2592000000,
+            "retryInterval": 180000,
+            "dashboardReadonly": false,
+            "amountHoursAssessmentRetry": 6
+        }' :: json
+    );

sources/packages/backend/apps/db-migrations/src/sql/Queue/Rollback-add-assessment-workflow-queue-retry.sql

@@ -0,0 +1,4 @@
+DELETE FROM
+  sims.queue_configurations
+WHERE
+  queue_name = 'assessment-workflow-queue-retry';

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

@@ -8,10 +8,21 @@ 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";
 
 (async () => {
   const app = await NestFactory.create(QueueConsumersModule);
   const config = app.get<ConfigService>(ConfigService);
+
+  // Get the injected logger.
+  const logger = await app.resolve(LoggerService);
+  app.useLogger(logger);
+
+  logger.log("Loading system user...");
+  const systemUsersService = app.get(SystemUsersService);
+  await systemUsersService.loadSystemUser();
+
   // Queue service.
   const queueService = app.get<QueueService>(QueueService);
   const queues = await queueService.queueConfigurationModel();

sources/packages/backend/apps/queue-consumers/src/processors/assessment/_tests_/cancel-application-assessment.processor.e2e-spec.ts

@@ -11,7 +11,10 @@ import {
 import { CancelApplicationAssessmentProcessor } from "../cancel-application-assessment.processor";
 import { DataSource, Repository } from "typeorm";
 import {
+  createE2EDataSources,
   createFakeDisbursementOveraward,
+  E2EDataSources,
+  saveFakeApplication,
   saveFakeApplicationDisbursements,
 } from "@sims/test-utils";
 import {
@@ -20,13 +23,15 @@ import {
   DisbursementSchedule,
   DisbursementScheduleStatus,
   StudentAssessment,
+  StudentAssessmentStatus,
 } from "@sims/sims-db";
 import * as faker from "faker";
 
 describe(
   describeProcessorRootTest(QueueNames.CancelApplicationAssessment),
   () => {
     let app: INestApplication;
+    let db: E2EDataSources;
     let processor: CancelApplicationAssessmentProcessor;
     let zbClientMock: ZBClient;
     let appDataSource: DataSource;
@@ -47,6 +52,7 @@ describe(
       disbursementScheduleRepo = dataSource.getRepository(DisbursementSchedule);
       // Processor under test.
       processor = app.get(CancelApplicationAssessmentProcessor);
+      db = createE2EDataSources(dataSource);
     });
 
     beforeEach(() => {
@@ -73,6 +79,8 @@ describe(
       // Adjust assessment.
       const studentAssessment = application.currentAssessment;
       studentAssessment.assessmentWorkflowId = workflowInstanceId;
+      studentAssessment.studentAssessmentStatus =
+        StudentAssessmentStatus.CancellationQueued;
       await studentAssessmentRepo.save(application.currentAssessment);
       // Adjust disbursements.
       const [firstDisbursement, secondDisbursement] =
@@ -138,6 +146,9 @@ describe(
         { applicationStatus: ApplicationStatus.Overwritten },
       );
       const studentAssessment = application.currentAssessment;
+      studentAssessment.studentAssessmentStatus =
+        StudentAssessmentStatus.CancellationQueued;
+      await db.studentAssessment.save(studentAssessment);
       // Queued job.
       const job = createMock<Job<CancelAssessmentQueueInDTO>>({
         data: { assessmentId: studentAssessment.id },
@@ -154,6 +165,30 @@ describe(
       expect(result.summary).toContain("Assessment cancelled with success.");
     });
 
+    it(`Should log a warning message when the assessment has status different than ${StudentAssessmentStatus.CancellationQueued}.`, async () => {
+      // Arrange
+      const application = await saveFakeApplication(appDataSource);
+      const studentAssessment = application.currentAssessment;
+
+      // Queued job.
+      const job = createMock<Job<CancelAssessmentQueueInDTO>>({
+        data: { assessmentId: studentAssessment.id },
+      });
+
+      // Act
+      const result = await processor.cancelAssessment(job);
+
+      // Assert
+      expect(zbClientMock.cancelProcessInstance).not.toHaveBeenCalled();
+      expect(result.warnings).toContain(
+        `Assessment id ${job.data.assessmentId} is not in ${StudentAssessmentStatus.CancellationQueued} status.`,
+      );
+      expect(result.summary).toContain(
+        "Workflow cancellation process not executed due to the assessment cancellation not being in the correct status.",
+      );
+      expect(job.discard).toBeCalled();
+    });
+
     it("Should throw an error and call job.discard when the application is not in the expected status.", async () => {
       // Arrange
       const errorMessage = `Application must be in the ${ApplicationStatus.Cancelled} or ${ApplicationStatus.Overwritten} state to have the assessment cancelled.`;
@@ -164,6 +199,9 @@ describe(
         { applicationStatus: ApplicationStatus.Completed },
       );
       const studentAssessment = application.currentAssessment;
+      studentAssessment.studentAssessmentStatus =
+        StudentAssessmentStatus.CancellationQueued;
+      await db.studentAssessment.save(studentAssessment);
       // Queued job.
       const job = createMock<Job<CancelAssessmentQueueInDTO>>({
         data: { assessmentId: studentAssessment.id },