#3768 - CAS Supplier Updates Report - Saving Snapshot (#4011)

## Added Saving the Snapshot

- [x] Created shared service to centralize the logic of extracting the
snapshot from student data.
- [x] Added saving snapshot when get supplier returns matching supplier
and site.
[cas-active-supplier-and-site-found-processor](https://github.com/bcgov/SIMS/blob/e8289820812b2c90258b8672124c5eee510569ea/sources/packages/backend/apps/queue-consumers/src/services/cas-supplier/cas-evaluation-result-processor/cas-active-supplier-and-site-found-processor.ts#L34)
- [x] Added saving snapshot when no supplier found AND supplier and site
created.
[cas-active-supplier-not-found-processor](https://github.com/bcgov/SIMS/blob/e8289820812b2c90258b8672124c5eee510569ea/sources/packages/backend/apps/queue-consumers/src/services/cas-supplier/cas-evaluation-result-processor/cas-active-supplier-not-found-processor.ts#L95)
- [x] Added saving snapshot when Active supplier found but site not
found AND new site created.
[cas-active-supplier-found-processor.ts](https://github.com/bcgov/SIMS/blob/f06eee1f706e2cc1498caa5a89be9fec91eb6ba2/sources/packages/backend/apps/queue-consumers/src/services/cas-supplier/cas-evaluation-result-processor/cas-active-supplier-found-processor.ts#L67)
- [x] Added saving snapshot when ministry is manually adding a verified
supplier.


![image](https://github.com/user-attachments/assets/2fdcdba4-7fe9-452d-b9d9-6eb4fdc58ce2)

Author: dheepak-aot

sources/packages/backend/apps/api/src/app.aest.module.ts

@@ -96,6 +96,7 @@ import {
   RestrictionSharedService,
   MSFAANumberSharedService,
   AssessmentSequentialProcessingService,
+  CASSupplierSharedService,
 } from "@sims/services";
 import { ECertIntegrationModule } from "@sims/integrations/esdc-integration";
 
@@ -194,6 +195,7 @@ import { ECertIntegrationModule } from "@sims/integrations/esdc-integration";
     ApplicationRestrictionBypassService,
     CRAIncomeVerificationService,
     SupportingUserService,
+    CASSupplierSharedService,
   ],
 })
 export class AppAESTModule {}

sources/packages/backend/apps/api/src/constants/error-code.constants.ts

@@ -239,3 +239,7 @@ export const APPLICATION_RESTRICTION_BYPASS_NOT_FOUND =
  */
 export const APPLICATION_RESTRICTION_BYPASS_IS_NOT_ACTIVE =
   "APPLICATION_RESTRICTION_BYPASS_IS_NOT_ACTIVE";
+/**
+ * Student not found error code.
+ */
+export const STUDENT_NOT_FOUND = "STUDENT_NOT_FOUND";

sources/packages/backend/apps/api/src/route-controllers/cas-supplier/cas-supplier.aest.controller.ts

@@ -23,6 +23,8 @@ import {
 import { CASSupplierService, StudentService } from "../../services";
 import { ClientTypeBaseRoute } from "../../types";
 import { PrimaryIdentifierAPIOutDTO } from "../models/primary.identifier.dto";
+import { STUDENT_NOT_FOUND } from "../../constants";
+import { CustomNamedError } from "@sims/utilities";
 
 /**
  * CAS supplier controller.
@@ -87,16 +89,22 @@ export class CASSupplierAESTController extends BaseController {
     @Param("studentId", ParseIntPipe) studentId: number,
     @UserToken() userToken: IUserToken,
   ): Promise<PrimaryIdentifierAPIOutDTO> {
-    const studentExist = await this.studentService.studentExists(studentId);
-    if (!studentExist) {
-      throw new NotFoundException("Student not found.");
+    try {
+      const casSupplier = await this.casSupplierService.addCASSupplier(
+        studentId,
+        payload.supplierNumber,
+        payload.supplierSiteCode,
+        userToken.userId,
+      );
+      return { id: casSupplier.id };
+    } catch (error: unknown) {
+      if (
+        error instanceof CustomNamedError &&
+        error.name === STUDENT_NOT_FOUND
+      ) {
+        throw new NotFoundException(error.message);
+      }
+      throw error;
     }
-    const casSupplier = await this.casSupplierService.addCASSupplier(
-      studentId,
-      payload.supplierNumber,
-      payload.supplierSiteCode,
-      userToken.userId,
-    );
-    return { id: casSupplier.id };
   }
 }

sources/packages/backend/apps/api/src/services/cas-supplier/cas-supplier.service.ts

@@ -1,13 +1,17 @@
 import { Injectable } from "@nestjs/common";
 import { InjectRepository } from "@nestjs/typeorm";
+import { StudentService } from "../../services";
 import {
   CASSupplier,
   Student,
   SupplierAddress,
   SupplierStatus,
   User,
 } from "@sims/sims-db";
+import { CustomNamedError } from "@sims/utilities";
+import { STUDENT_NOT_FOUND } from "../../constants";
 import { Repository } from "typeorm";
+import { CASSupplierSharedService } from "@sims/services";
 
 Injectable();
 export class CASSupplierService {
@@ -16,6 +20,8 @@ export class CASSupplierService {
     private readonly casSupplierRepo: Repository<CASSupplier>,
     @InjectRepository(Student)
     private readonly studentRepo: Repository<Student>,
+    private readonly studentService: StudentService,
+    private readonly casSupplierSharedService: CASSupplierSharedService,
   ) {}
 
   /**
@@ -56,9 +62,12 @@ export class CASSupplierService {
     supplierSiteCode: string,
     auditUserId: number,
   ): Promise<CASSupplier> {
+    const student = await this.studentService.getStudentById(studentId);
+    if (!student) {
+      throw new CustomNamedError("Student not found.", STUDENT_NOT_FOUND);
+    }
     const now = new Date();
     const auditUser = { id: auditUserId } as User;
-    const student = { id: studentId } as Student;
 
     // Create manual verified CAS Supplier.
     const manualVerifiedSupplier = new CASSupplier();
@@ -73,6 +82,13 @@ export class CASSupplierService {
     manualVerifiedSupplier.isValid = true;
     manualVerifiedSupplier.createdAt = now;
     manualVerifiedSupplier.creator = auditUser;
+    manualVerifiedSupplier.studentProfileSnapshot =
+      this.casSupplierSharedService.getStudentProfileSnapshot(
+        student.user.firstName,
+        student.user.lastName,
+        student.sinValidation.sin,
+        student.contactInfo.address,
+      );
 
     // Set manual verified CAS Supplier for the student.
     student.casSupplier = manualVerifiedSupplier;

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

@@ -43,6 +43,7 @@ import {
   GlobalHttpModule,
   AssessmentSequentialProcessingService,
   ClamAVService,
+  CASSupplierSharedService,
 } from "@sims/services";
 import { DatabaseModule } from "@sims/sims-db";
 import { IER12IntegrationModule } from "@sims/integrations/institution-integration/ier12-integration";
@@ -160,6 +161,7 @@ import { BullBoardQueuesModule } from "./bull-board/bull-board-queues.module";
     CASPreValidationsProcessor,
     CASActiveSupplierFoundProcessor,
     CASActiveSupplierAndSiteFoundProcessor,
+    CASSupplierSharedService,
   ],
   controllers: [HealthController],
 })

sources/packages/backend/apps/queue-consumers/src/services/cas-supplier/cas-evaluation-result-processor/cas-active-supplier-and-site-found-processor.ts

@@ -1,6 +1,6 @@
 import { Injectable } from "@nestjs/common";
 import { InjectRepository } from "@nestjs/typeorm";
-import { SystemUsersService } from "@sims/services";
+import { CASSupplierSharedService, SystemUsersService } from "@sims/services";
 import { CASSupplier, SupplierStatus } from "@sims/sims-db";
 import { ProcessSummary } from "@sims/utilities/logger";
 import {
@@ -20,6 +20,7 @@ export class CASActiveSupplierAndSiteFoundProcessor extends CASEvaluationResultP
     private readonly systemUsersService: SystemUsersService,
     @InjectRepository(CASSupplier)
     private readonly casSupplierRepo: Repository<CASSupplier>,
+    private readonly casSupplierSharedService: CASSupplierSharedService,
   ) {
     super();
   }
@@ -56,6 +57,13 @@ export class CASActiveSupplierAndSiteFoundProcessor extends CASEvaluationResultP
         siteProtected: address.siteprotected,
         lastUpdated: new Date(address.lastupdated),
       };
+      const studentProfileSnapshot =
+        this.casSupplierSharedService.getStudentProfileSnapshot(
+          studentSupplier.firstName,
+          studentSupplier.lastName,
+          studentSupplier.sin,
+          studentSupplier.address,
+        );
       const now = new Date();
       const systemUser = this.systemUsersService.systemUser;
       const supplierToUpdate = evaluationResult.activeSupplier;
@@ -71,6 +79,7 @@ export class CASActiveSupplierAndSiteFoundProcessor extends CASEvaluationResultP
           lastUpdated: new Date(supplierToUpdate.lastupdated),
           supplierAddress: supplierAddressToUpdate,
           supplierStatus: SupplierStatus.Verified,
+          studentProfileSnapshot,
           supplierStatusUpdatedOn: now,
           isValid: true,
           updatedAt: now,

sources/packages/backend/apps/queue-consumers/src/services/cas-supplier/cas-evaluation-result-processor/cas-active-supplier-found-processor.ts

@@ -1,6 +1,6 @@
 import { Injectable } from "@nestjs/common";
 import { InjectRepository } from "@nestjs/typeorm";
-import { SystemUsersService } from "@sims/services";
+import { CASSupplierSharedService, SystemUsersService } from "@sims/services";
 import { CASSupplier, SupplierAddress, SupplierStatus } from "@sims/sims-db";
 import { ProcessSummary } from "@sims/utilities/logger";
 import {
@@ -25,6 +25,7 @@ export class CASActiveSupplierFoundProcessor extends CASEvaluationResultProcesso
     @InjectRepository(CASSupplier)
     private readonly casSupplierRepo: Repository<CASSupplier>,
     private readonly casService: CASService,
+    private readonly casSupplierSharedService: CASSupplierSharedService,
   ) {
     super();
   }
@@ -78,6 +79,13 @@ export class CASActiveSupplierFoundProcessor extends CASEvaluationResultProcesso
         status: "ACTIVE",
         lastUpdated: now,
       };
+      const studentProfileSnapshot =
+        this.casSupplierSharedService.getStudentProfileSnapshot(
+          studentSupplier.firstName,
+          studentSupplier.lastName,
+          studentSupplier.sin,
+          studentSupplier.address,
+        );
       const updateResult = await this.casSupplierRepo.update(
         {
           id: studentSupplier.casSupplierID,
@@ -90,6 +98,7 @@ export class CASActiveSupplierFoundProcessor extends CASEvaluationResultProcesso
           lastUpdated: new Date(supplierToUpdate.lastupdated),
           supplierAddress: supplierAddressToUpdate,
           supplierStatus: SupplierStatus.Verified,
+          studentProfileSnapshot,
           supplierStatusUpdatedOn: now,
           isValid: true,
           updatedAt: now,

sources/packages/backend/apps/queue-consumers/src/services/cas-supplier/cas-evaluation-result-processor/cas-active-supplier-not-found-processor.ts

@@ -1,6 +1,6 @@
 import { Injectable } from "@nestjs/common";
 import { InjectRepository } from "@nestjs/typeorm";
-import { SystemUsersService } from "@sims/services";
+import { CASSupplierSharedService, SystemUsersService } from "@sims/services";
 import { CASSupplier, SupplierStatus } from "@sims/sims-db";
 import { ProcessSummary } from "@sims/utilities/logger";
 import {
@@ -25,6 +25,7 @@ export class CASActiveSupplierNotFoundProcessor extends CASEvaluationResultProce
     private readonly systemUsersService: SystemUsersService,
     @InjectRepository(CASSupplier)
     private readonly casSupplierRepo: Repository<CASSupplier>,
+    private readonly casSupplierSharedService: CASSupplierSharedService,
   ) {
     super();
   }
@@ -71,6 +72,13 @@ export class CASActiveSupplierNotFoundProcessor extends CASEvaluationResultProce
       const [submittedAddress] = result.submittedData.SupplierAddress;
       const now = new Date();
       const systemUser = this.systemUsersService.systemUser;
+      const studentProfileSnapshot =
+        this.casSupplierSharedService.getStudentProfileSnapshot(
+          studentSupplier.firstName,
+          studentSupplier.lastName,
+          studentSupplier.sin,
+          studentSupplier.address,
+        );
       const updateResult = await this.casSupplierRepo.update(
         {
           id: studentSupplier.casSupplierID,
@@ -91,6 +99,7 @@ export class CASActiveSupplierNotFoundProcessor extends CASEvaluationResultProce
             lastUpdated: now,
           },
           supplierStatus: SupplierStatus.Verified,
+          studentProfileSnapshot,
           supplierStatusUpdatedOn: now,
           isValid: true,
           updatedAt: now,

sources/packages/backend/libs/services/src/cas-supplier/cas-supplier.shared.service.ts

@@ -0,0 +1,31 @@
+import { Injectable } from "@nestjs/common";
+import { AddressInfo, StudentProfileSnapshot } from "@sims/sims-db";
+
+Injectable();
+export class CASSupplierSharedService {
+  /**
+   * Get a snapshot of the student profile.
+   * @param firstName student first name.
+   * @param lastName student last name.
+   * @param sin student sin.
+   * @param addressInfo student address.
+   * @returns student profile snapshot.
+   */
+  getStudentProfileSnapshot(
+    firstName: string,
+    lastName: string,
+    sin: string,
+    addressInfo: AddressInfo,
+  ): StudentProfileSnapshot {
+    return {
+      firstName: firstName,
+      lastName: lastName,
+      sin: sin,
+      addressLine1: addressInfo.addressLine1,
+      city: addressInfo.city,
+      province: addressInfo.provinceState,
+      postalCode: addressInfo.postalCode,
+      country: addressInfo.country,
+    };
+  }
+}

sources/packages/backend/libs/services/src/index.ts

@@ -36,3 +36,4 @@ export * from "./student-loan-balance/student-loan-balance-shared.service";
 export * from "./clamav/services/clamav.service";
 export * from "./clamav/models/clamav.models";
 export * from "./clamav/clam-antivirus.module";
+export * from "./cas-supplier/cas-supplier.shared.service";

sources/packages/backend/libs/sims-db/src/entities/cas-supplier.model.ts

@@ -163,7 +163,7 @@ export interface SupplierAddress {
 /**
  * Student profile snapshot information.
  */
-interface StudentProfileSnapshot {
+export interface StudentProfileSnapshot {
   firstName: string;
   lastName: string;
   sin: string;