Merge branch 'main' into feature/#1959-Staging-SIMS-Prod-Environment

Author: guru-aot

devops/Makefile

@@ -43,7 +43,7 @@ define DB_MIGRATIONS
 endef
 
 define DB_MIGRATIONS_JOB_NAME
-"db.migrations"
+"$(HOST_PREFIX)db.migrations"
 endef
 
 define API
@@ -322,12 +322,12 @@ run-db-migrations:
 		| oc -n $(NAMESPACE) apply -f - 
 
 wait-for-db-migrations: 
-	while [ "$$(oc get job $(DB_MIGRATIONS_JOB_NAME) -o=jsonpath='{.status.conditions[?(@.type=="Complete")].status}' || echo "None")" != "True" ] && [ "$$WAIT_TIME" -lt "$$MAX_WAIT" ]; do sleep 5; WAIT_TIME=$$((WAIT_TIME+5)); done
-	if [ "$$(oc get job $(DB_MIGRATIONS_JOB_NAME) -o=jsonpath='{.status.conditions[?(@.type=="Complete")].status}' || echo "None")" != "True" ]; then echo "Error: Job $(DB_MIGRATIONS_JOB_NAME) failed to complete within the specified timeout"; exit 1; fi
+	while [ "$$(oc -n $(NAMESPACE) get job $(DB_MIGRATIONS_JOB_NAME) -o=jsonpath='{.status.conditions[?(@.type=="Complete")].status}' || echo "None")" != "True" ] && [ "$$WAIT_TIME" -lt "$$MAX_WAIT" ]; do sleep 5; WAIT_TIME=$$((WAIT_TIME+5)); done
+	if [ "$$(oc -n $(NAMESPACE) get job $(DB_MIGRATIONS_JOB_NAME) -o=jsonpath='{.status.conditions[?(@.type=="Complete")].status}' || echo "None")" != "True" ]; then echo "Error: Job $(DB_MIGRATIONS_JOB_NAME) failed to complete within the specified timeout"; exit 1; fi
 
 delete-db-migrations:
-	@if [ -n "$(shell oc get job $(DB_MIGRATIONS_JOB_NAME) -o name 2>/dev/null)" ]; then \
-		oc delete job $(DB_MIGRATIONS_JOB_NAME); \
+	@if [ -n "$(shell oc -n $(NAMESPACE) get job $(DB_MIGRATIONS_JOB_NAME) -o name 2>/dev/null)" ]; then \
+		oc -n $(NAMESPACE) delete job $(DB_MIGRATIONS_JOB_NAME); \
 			echo "Job deleted."; \
 	else \
 		echo "Job not found."; \

sources/packages/backend/apps/api/src/route-controllers/assessment/_tests_/e2e/assessment.institutions.controller.getAssessmentAwardDetails.e2e-spec.ts

@@ -96,11 +96,11 @@ describe("AssessmentInstitutionsController(e2e)-getAssessmentAwardDetails", () =
         disbursement.valueAmount;
       disbursementReceiptsValues.push(
         createFakeDisbursementReceiptValue(
-          { disbursementReceipt },
           {
             grantType: disbursement.valueCode,
             grantAmount: disbursement.valueAmount,
           },
+          { disbursementReceipt },
         ),
       );
     });

sources/packages/backend/apps/api/src/route-controllers/assessment/_tests_/e2e/assessment.institutions.controller.getRequestedAssessmentSummary.e2e-spec.ts

@@ -29,17 +29,24 @@ import {
   StudentAppealStatus,
 } from "@sims/sims-db";
 import { saveStudentApplicationForCollegeC } from "../../../student/_tests_/e2e/student.institutions.utils";
+import { createFakeOfferingRequestChange } from "@sims/test-utils/factories/offering-change-request";
+import { TestingModule } from "@nestjs/testing";
+import { EducationProgramOfferingService } from "../../../../../src/services";
 
 describe("AssessmentInstitutionsController(e2e)-getRequestedAssessmentSummary", () => {
   let app: INestApplication;
   let db: E2EDataSources;
   let collegeF: Institution;
   let collegeFLocation: InstitutionLocation;
+  let appModule: TestingModule;
 
   beforeAll(async () => {
-    const { nestApplication, dataSource } = await createTestingAppModule();
+    const { nestApplication, module, dataSource } =
+      await createTestingAppModule();
     app = nestApplication;
+    appModule = module;
     db = createE2EDataSources(dataSource);
+
     // College F.
     const { institution: collegeF } = await getAuthRelatedEntities(
       db.dataSource,
@@ -106,6 +113,72 @@ describe("AssessmentInstitutionsController(e2e)-getRequestedAssessmentSummary",
       ]);
   });
 
+  it(
+    "Should not get the 'offering change' assessment requests details in the request summary " +
+      "for an eligible application when an eligible public institution user tries to access it and " +
+      "student offering change is pending with the ministry.",
+    async () => {
+      // Arrange
+
+      // Student has an application to the institution.
+      const student = await saveFakeStudent(db.dataSource);
+
+      const currentMSFAA = createFakeMSFAANumber(
+        { student },
+        {
+          state: MSFAAStates.Signed,
+        },
+      );
+      await db.msfaaNumber.save(currentMSFAA);
+      const application = await saveFakeApplicationDisbursements(
+        db.dataSource,
+        {
+          institution: collegeF,
+          institutionLocation: collegeFLocation,
+          student,
+          msfaaNumber: currentMSFAA,
+        },
+        { applicationStatus: ApplicationStatus.Completed },
+      );
+
+      // Create pending offering change.
+      const offeringRequestOfferings = createFakeOfferingRequestChange({
+        currentOffering: application.currentAssessment.offering,
+      });
+      const [, requestedOffering] = await db.educationProgramOffering.save(
+        offeringRequestOfferings,
+      );
+      const endpoint = `/institutions/assessment/student/${student.id}/application/${application.id}/requests`;
+      const institutionUserToken = await getInstitutionToken(
+        InstitutionTokenTypes.CollegeFUser,
+      );
+
+      // Act/Assert
+      await request(app.getHttpServer())
+        .get(endpoint)
+        .auth(institutionUserToken, BEARER_AUTH_TYPE)
+        .expect(HttpStatus.OK)
+        .expect([]);
+
+      // Checking the same scenario with the educationProgramOfferingService service, to make sure that a fake offering change was created.
+      const educationProgramOfferingService = appModule.get(
+        EducationProgramOfferingService,
+      );
+      const offeringChange =
+        await educationProgramOfferingService.getOfferingRequestsByApplicationId(
+          application.id,
+          student.id,
+        );
+
+      expect(offeringChange).toMatchObject({
+        id: requestedOffering.id,
+        submittedDate: requestedOffering.submittedDate,
+        offeringStatus: requestedOffering.offeringStatus,
+        educationProgram: { id: requestedOffering.educationProgram.id },
+      });
+    },
+  );
+
   it("Should throw forbidden error when the institution type is not BC Public.", async () => {
     // Arrange
     // Student submitting an application to College C.

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

@@ -40,6 +40,9 @@ export class AssessmentAESTController extends BaseController {
   ): Promise<RequestAssessmentSummaryAPIOutDTO[]> {
     return this.assessmentControllerService.requestedStudentAssessmentSummary(
       applicationId,
+      {
+        includeOfferingChanges: true,
+      },
     );
   }
 

sources/packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

@@ -320,32 +320,40 @@ export class AssessmentControllerService {
    * Get all pending and declined requests related to an application which would result
    * a new assessment when that request is approved.
    * @param applicationId application id.
-   * @param studentId student id.
+   * @param options options for request assessments,
+   * - `studentId` student id.
+   * - `includeOfferingChanges` will decide whether to include assessment
+   * request for offering change.
    * @returns assessment requests or exceptions for the student application.
    */
   async requestedStudentAssessmentSummary(
     applicationId: number,
-    studentId?: number,
+    options?: {
+      studentId?: number;
+      includeOfferingChanges?: boolean;
+    },
   ): Promise<RequestAssessmentSummaryAPIOutDTO[]> {
     const requestAssessmentSummary: RequestAssessmentSummaryAPIOutDTO[] = [];
-    const offeringChange =
-      await this.educationProgramOfferingService.getOfferingRequestsByApplicationId(
-        applicationId,
-        studentId,
-      );
-    if (offeringChange) {
-      requestAssessmentSummary.push({
-        id: offeringChange.id,
-        submittedDate: offeringChange.submittedDate,
-        status: offeringChange.offeringStatus,
-        requestType: RequestAssessmentTypeAPIOutDTO.OfferingRequest,
-        programId: offeringChange.educationProgram.id,
-      });
+    if (options?.includeOfferingChanges) {
+      const offeringChange =
+        await this.educationProgramOfferingService.getOfferingRequestsByApplicationId(
+          applicationId,
+          options?.studentId,
+        );
+      if (offeringChange) {
+        requestAssessmentSummary.push({
+          id: offeringChange.id,
+          submittedDate: offeringChange.submittedDate,
+          status: offeringChange.offeringStatus,
+          requestType: RequestAssessmentTypeAPIOutDTO.OfferingRequest,
+          programId: offeringChange.educationProgram.id,
+        });
+      }
     }
     const applicationExceptions =
       await this.applicationExceptionService.getExceptionsByApplicationId(
         applicationId,
-        studentId,
+        options?.studentId,
         ApplicationExceptionStatus.Pending,
         ApplicationExceptionStatus.Declined,
       );
@@ -363,7 +371,7 @@ export class AssessmentControllerService {
     }
     const appeals = await this.getPendingAndDeniedAppeals(
       applicationId,
-      studentId,
+      options?.studentId,
     );
     return requestAssessmentSummary.concat(appeals);
   }

sources/packages/backend/apps/api/src/route-controllers/assessment/assessment.institutions.controller.ts

@@ -49,7 +49,7 @@ export class AssessmentInstitutionsController extends BaseController {
   ): Promise<RequestAssessmentSummaryAPIOutDTO[]> {
     return this.assessmentControllerService.requestedStudentAssessmentSummary(
       applicationId,
-      studentId,
+      { studentId },
     );
   }
 

sources/packages/backend/libs/test-utils/src/factories/disbursement-receipt-value.ts

@@ -1,26 +1,29 @@
 import { DisbursementReceipt, DisbursementReceiptValue } from "@sims/sims-db";
+import faker from "faker";
 
 /**
  * Create fake disbursement receipt value.
+ * @param initialValues initial values that need to be assigned
+ * while creating a fake disbursement receipt value.
  * @param relations dependencies.
  * - `disbursementReceipt` related disbursement receipt.
- * @param options options
- * - `grantType` type of grant to be created.
- * - `grantAmount` grant amount to be created.
  * @returns disbursement receipt value.
  */
 export function createFakeDisbursementReceiptValue(
+  initialValues: Partial<DisbursementReceiptValue>,
   relations: {
     disbursementReceipt: DisbursementReceipt;
   },
-  options: {
-    grantType: string;
-    grantAmount: number;
-  },
 ): DisbursementReceiptValue {
   const disbursementReceiptValue = new DisbursementReceiptValue();
-  disbursementReceiptValue.grantType = options.grantType;
-  disbursementReceiptValue.grantAmount = options.grantAmount;
+  disbursementReceiptValue.grantType =
+    initialValues.grantType ?? faker.random.alpha({ count: 4 });
+  disbursementReceiptValue.grantAmount =
+    initialValues.grantAmount ??
+    faker.random.number({
+      min: 1000,
+      max: 9999,
+    });
   disbursementReceiptValue.disbursementReceipt = relations.disbursementReceipt;
   return disbursementReceiptValue;
 }

sources/packages/backend/libs/test-utils/src/factories/offering-change-request.ts

@@ -0,0 +1,33 @@
+import { EducationProgramOffering, OfferingStatus } from "@sims/sims-db";
+
+/**
+ * Create a fake offering request change.
+ * @param options options:
+ *  - `currentOffering` current offering, which is requested for the changed, which is
+ * already saved in the DB.
+ * @returns the current and requested offering.
+ */
+export function createFakeOfferingRequestChange(options: {
+  currentOffering: EducationProgramOffering;
+}): EducationProgramOffering[] {
+  const now = new Date();
+  const requestedOfferingId = options.currentOffering.id;
+  const requestedOffering = options.currentOffering;
+  delete requestedOffering.id;
+  requestedOffering.offeringStatus = OfferingStatus.ChangeAwaitingApproval;
+  requestedOffering.parentOffering =
+    options.currentOffering.parentOffering ??
+    ({ id: requestedOfferingId } as EducationProgramOffering);
+  requestedOffering.precedingOffering = {
+    id: requestedOfferingId,
+  } as EducationProgramOffering;
+  requestedOffering.createdAt = now;
+  requestedOffering.submittedDate = now;
+
+  // Update the status and audit details of current offering.
+  const precedingOffering = new EducationProgramOffering();
+  precedingOffering.id = requestedOfferingId;
+  precedingOffering.offeringStatus = OfferingStatus.ChangeUnderReview;
+  precedingOffering.updatedAt = now;
+  return [precedingOffering, requestedOffering];
+}

sources/packages/web/src/views/institution/student/applicationDetails/InstitutionAssessmentsSummary.vue

@@ -17,7 +17,7 @@
     <history-assessment
       :applicationId="applicationId"
       :studentId="studentId"
-      :viewRequestTypes="assessmentRequestTypes"
+      :viewRequestTypes="assessmentRequestViewTypes"
       @viewStudentAppeal="goToStudentAppeal"
       @viewAssessment="gotToViewAssessment"
       @viewApplicationException="goToApplicationException"
@@ -51,10 +51,8 @@ export default defineComponent({
   setup(props) {
     const router = useRouter();
     // The assessment trigger types for which the request form must be visible by default.
-    const assessmentRequestTypes = [
+    const assessmentRequestViewTypes = [
       AssessmentTriggerType.StudentAppeal,
-      AssessmentTriggerType.OfferingChange,
-      AssessmentTriggerType.ScholasticStandingChange,
       AssessmentTriggerType.OriginalAssessment,
     ];
 
@@ -103,7 +101,7 @@ export default defineComponent({
       goToStudentAppeal,
       gotToViewAssessment,
       goToApplicationException,
-      assessmentRequestTypes,
+      assessmentRequestViewTypes,
       backRoute,
     };
   },