#1979 - Request an Offering Change - Ministry View Pending Offerings

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

@@ -67,6 +67,7 @@ import {
   ApplicationExceptionControllerService,
   StudentAppealControllerService,
   RestrictionControllerService,
+  ApplicationOfferingChangeRequestAESTController,
 } from "./route-controllers";
 import { AuthModule } from "./auth/auth.module";
 import {
@@ -109,6 +110,7 @@ import {
     UserAESTController,
     ConfirmationOfEnrollmentAESTController,
     OverawardAESTController,
+    ApplicationOfferingChangeRequestAESTController,
   ],
   providers: [
     ApplicationExceptionControllerService,

sources/packages/backend/apps/api/src/route-controllers/application-offering-change-request/_tests_/e2e/application-offering-change-request.aest.controller.getAllInProgressApplications.e2e-spec.ts

@@ -0,0 +1,271 @@
+import { HttpStatus, INestApplication } from "@nestjs/common";
+import * as request from "supertest";
+import {
+  AESTGroups,
+  BEARER_AUTH_TYPE,
+  createTestingAppModule,
+  getAESTToken,
+} from "../../../../testHelpers";
+import {
+  E2EDataSources,
+  createE2EDataSources,
+  saveFakeApplicationOfferingRequestChange,
+} from "@sims/test-utils";
+import { ApplicationOfferingChangeRequestStatus } from "@sims/sims-db";
+import { FieldSortOrder, getISODateOnlyString } from "@sims/utilities";
+import { getUserFullName } from "../../../../utilities";
+
+describe("ApplicationOfferingChangeRequestAESTController(e2e)-getAllInProgressApplications", () => {
+  let app: INestApplication;
+  let db: E2EDataSources;
+
+  beforeAll(async () => {
+    const { nestApplication, dataSource } = await createTestingAppModule();
+    app = nestApplication;
+    db = createE2EDataSources(dataSource);
+  });
+
+  it("Should return all in progress application offering change requests when requested.", async () => {
+    // Arrange
+
+    // Student 1 has an in progress with student application offering change request.
+    const inProgressWithStudentApplicationOfferingChange1 =
+      await saveFakeApplicationOfferingRequestChange(db);
+    // Student 2 has an in progress with SABC application offering change request.
+    const inProgressWithSABCApplicationOfferingChange =
+      await saveFakeApplicationOfferingRequestChange(db, null, {
+        initialValues: {
+          applicationOfferingChangeRequestStatus:
+            ApplicationOfferingChangeRequestStatus.InProgressWithSABC,
+        },
+      });
+    // Student 3 has an in progress with student application offering change request.
+    const inProgressWithStudentApplicationOfferingChange2 =
+      await saveFakeApplicationOfferingRequestChange(db);
+    // Student 4 has an completed application, that has an approved application offering change request.
+    const approvedApplicationOfferingChange =
+      await saveFakeApplicationOfferingRequestChange(db, null, {
+        initialValues: {
+          applicationOfferingChangeRequestStatus:
+            ApplicationOfferingChangeRequestStatus.Approved,
+        },
+      });
+
+    const applicationApprovedApplicationOfferingChange =
+      approvedApplicationOfferingChange.application;
+    const applicationInProgressWithStudentApplicationOfferingChange1 =
+      inProgressWithStudentApplicationOfferingChange1.application;
+    const applicationInProgressWithStudentApplicationOfferingChange2 =
+      inProgressWithStudentApplicationOfferingChange2.application;
+    const applicationInProgressWithSABCApplicationOfferingChange =
+      inProgressWithSABCApplicationOfferingChange.application;
+
+    applicationApprovedApplicationOfferingChange.student.user.firstName =
+      "Ministry Offering Change Test 1";
+    applicationInProgressWithStudentApplicationOfferingChange1.student.user.firstName =
+      "Ministry Offering Change Test 2";
+    applicationInProgressWithStudentApplicationOfferingChange2.student.user.firstName =
+      "Ministry Offering Change Test 3";
+    applicationInProgressWithSABCApplicationOfferingChange.student.user.firstName =
+      "Ministry Offering Change Test 4";
+
+    await db.user.save([
+      applicationApprovedApplicationOfferingChange.student.user,
+      applicationInProgressWithStudentApplicationOfferingChange1.student.user,
+      applicationInProgressWithStudentApplicationOfferingChange2.student.user,
+      applicationInProgressWithSABCApplicationOfferingChange.student.user,
+    ]);
+
+    const endpoint = `/aest/application-offering-change-request/in-progress?page=0&pageLimit=10&sortField=status&sortOrder=${FieldSortOrder.DESC}&searchCriteria=Ministry Offering Change Test `;
+
+    // Act/Assert
+    await request(app.getHttpServer())
+      .get(endpoint)
+      .auth(
+        await getAESTToken(AESTGroups.BusinessAdministrators),
+        BEARER_AUTH_TYPE,
+      )
+      .expect(HttpStatus.OK)
+      .expect({
+        results: [
+          {
+            id: inProgressWithSABCApplicationOfferingChange.id,
+            applicationNumber:
+              applicationInProgressWithSABCApplicationOfferingChange.applicationNumber,
+            applicationId:
+              applicationInProgressWithSABCApplicationOfferingChange.id,
+            studyStartDate:
+              applicationInProgressWithSABCApplicationOfferingChange
+                .currentAssessment.offering.studyStartDate,
+            studyEndDate:
+              applicationInProgressWithSABCApplicationOfferingChange
+                .currentAssessment.offering.studyEndDate,
+            fullName: getUserFullName(
+              applicationInProgressWithSABCApplicationOfferingChange.student
+                .user,
+            ),
+            status:
+              inProgressWithSABCApplicationOfferingChange.applicationOfferingChangeRequestStatus,
+            createdAt: getISODateOnlyString(
+              applicationInProgressWithSABCApplicationOfferingChange.createdAt,
+            ),
+            studentId:
+              applicationInProgressWithSABCApplicationOfferingChange.student.id,
+          },
+          {
+            id: inProgressWithStudentApplicationOfferingChange1.id,
+            applicationNumber:
+              applicationInProgressWithStudentApplicationOfferingChange1.applicationNumber,
+            applicationId:
+              applicationInProgressWithStudentApplicationOfferingChange1.id,
+            studyStartDate:
+              applicationInProgressWithStudentApplicationOfferingChange1
+                .currentAssessment.offering.studyStartDate,
+            studyEndDate:
+              applicationInProgressWithStudentApplicationOfferingChange1
+                .currentAssessment.offering.studyEndDate,
+            fullName: getUserFullName(
+              applicationInProgressWithStudentApplicationOfferingChange1.student
+                .user,
+            ),
+            status:
+              inProgressWithStudentApplicationOfferingChange2.applicationOfferingChangeRequestStatus,
+            createdAt: getISODateOnlyString(
+              applicationInProgressWithStudentApplicationOfferingChange1.createdAt,
+            ),
+            studentId:
+              applicationInProgressWithStudentApplicationOfferingChange1.student
+                .id,
+          },
+          {
+            id: inProgressWithStudentApplicationOfferingChange2.id,
+            applicationNumber:
+              applicationInProgressWithStudentApplicationOfferingChange2.applicationNumber,
+            applicationId:
+              applicationInProgressWithStudentApplicationOfferingChange2.id,
+            studyStartDate:
+              applicationInProgressWithStudentApplicationOfferingChange2
+                .currentAssessment.offering.studyStartDate,
+            studyEndDate:
+              applicationInProgressWithStudentApplicationOfferingChange2
+                .currentAssessment.offering.studyEndDate,
+            fullName: getUserFullName(
+              applicationInProgressWithStudentApplicationOfferingChange2.student
+                .user,
+            ),
+            status:
+              inProgressWithStudentApplicationOfferingChange2.applicationOfferingChangeRequestStatus,
+            createdAt: getISODateOnlyString(
+              applicationInProgressWithStudentApplicationOfferingChange2.createdAt,
+            ),
+            studentId:
+              applicationInProgressWithStudentApplicationOfferingChange2.student
+                .id,
+          },
+        ],
+        count: 3,
+      });
+  });
+
+  it("Should return all matching in progress application offering change requests filtered by the search criteria when requested.", async () => {
+    // Arrange
+
+    // Student 1 has an in progress with student application offering change request.
+    await saveFakeApplicationOfferingRequestChange(db);
+    // Student 2 has an in progress with SABC application offering change request.
+    const inProgressWithSABCApplicationOfferingChange =
+      await saveFakeApplicationOfferingRequestChange(db, null, {
+        initialValues: {
+          applicationOfferingChangeRequestStatus:
+            ApplicationOfferingChangeRequestStatus.InProgressWithSABC,
+        },
+      });
+    // Student 3 has an in progress with student application offering change request.
+    const inProgressWithStudentApplicationOfferingChange2 =
+      await saveFakeApplicationOfferingRequestChange(db);
+
+    const applicationInProgressWithStudentApplicationOfferingChange2 =
+      inProgressWithStudentApplicationOfferingChange2.application;
+    const applicationInProgressWithSABCApplicationOfferingChange =
+      inProgressWithSABCApplicationOfferingChange.application;
+
+    applicationInProgressWithStudentApplicationOfferingChange2.student.user.firstName =
+      "Ministry Offering Change Search Criteria Test 1";
+    applicationInProgressWithSABCApplicationOfferingChange.student.user.firstName =
+      "Ministry Offering Change Search Criteria Test 2";
+
+    await db.user.save([
+      applicationInProgressWithStudentApplicationOfferingChange2.student.user,
+      applicationInProgressWithSABCApplicationOfferingChange.student.user,
+    ]);
+
+    const endpoint = `/aest/application-offering-change-request/in-progress?page=0&pageLimit=10&sortField=status&sortOrder=${FieldSortOrder.DESC}&searchCriteria=Ministry Offering Change Search Criteria Test `;
+
+    // Act/Assert
+    await request(app.getHttpServer())
+      .get(endpoint)
+      .auth(
+        await getAESTToken(AESTGroups.BusinessAdministrators),
+        BEARER_AUTH_TYPE,
+      )
+      .expect(HttpStatus.OK)
+      .expect({
+        results: [
+          {
+            id: inProgressWithSABCApplicationOfferingChange.id,
+            applicationNumber:
+              applicationInProgressWithSABCApplicationOfferingChange.applicationNumber,
+            applicationId:
+              applicationInProgressWithSABCApplicationOfferingChange.id,
+            studyStartDate:
+              applicationInProgressWithSABCApplicationOfferingChange
+                .currentAssessment.offering.studyStartDate,
+            studyEndDate:
+              applicationInProgressWithSABCApplicationOfferingChange
+                .currentAssessment.offering.studyEndDate,
+            fullName: getUserFullName(
+              applicationInProgressWithSABCApplicationOfferingChange.student
+                .user,
+            ),
+            status:
+              inProgressWithSABCApplicationOfferingChange.applicationOfferingChangeRequestStatus,
+            createdAt: getISODateOnlyString(
+              applicationInProgressWithSABCApplicationOfferingChange.createdAt,
+            ),
+            studentId:
+              applicationInProgressWithSABCApplicationOfferingChange.student.id,
+          },
+          {
+            id: inProgressWithStudentApplicationOfferingChange2.id,
+            applicationNumber:
+              applicationInProgressWithStudentApplicationOfferingChange2.applicationNumber,
+            applicationId:
+              applicationInProgressWithStudentApplicationOfferingChange2.id,
+            studyStartDate:
+              applicationInProgressWithStudentApplicationOfferingChange2
+                .currentAssessment.offering.studyStartDate,
+            studyEndDate:
+              applicationInProgressWithStudentApplicationOfferingChange2
+                .currentAssessment.offering.studyEndDate,
+            fullName: getUserFullName(
+              applicationInProgressWithStudentApplicationOfferingChange2.student
+                .user,
+            ),
+            status:
+              inProgressWithStudentApplicationOfferingChange2.applicationOfferingChangeRequestStatus,
+            createdAt: getISODateOnlyString(
+              applicationInProgressWithStudentApplicationOfferingChange2.createdAt,
+            ),
+            studentId:
+              applicationInProgressWithStudentApplicationOfferingChange2.student
+                .id,
+          },
+        ],
+        count: 2,
+      });
+  });
+
+  afterAll(async () => {
+    await app?.close();
+  });
+});

sources/packages/backend/apps/api/src/route-controllers/application-offering-change-request/application-offering-change-request.aest.controller.ts

@@ -0,0 +1,72 @@
+import { Controller, Get, Query } from "@nestjs/common";
+import { ApiTags } from "@nestjs/swagger";
+import { AuthorizedParties } from "../../auth/authorized-parties.enum";
+import { AllowAuthorizedParty, Groups } from "../../auth/decorators";
+import { ClientTypeBaseRoute } from "../../types";
+import { PaginatedResultsAPIOutDTO } from "../models/pagination.dto";
+import BaseController from "../BaseController";
+import {
+  AllInProgressOfferingChangePaginationOptionsAPIInDTO,
+  AllInProgressApplicationOfferingChangesAPIOutDTO,
+} from "./models/application-offering-change-request.dto";
+import { ApplicationOfferingChangeRequestService } from "../../services";
+import { ApplicationOfferingChangeRequestStatus } from "@sims/sims-db";
+import { UserGroups } from "../../auth";
+import { getUserFullName } from "../../utilities";
+import { getISODateOnlyString } from "@sims/utilities";
+
+/**
+ * Application offering change request controller for ministry client.
+ */
+@AllowAuthorizedParty(AuthorizedParties.aest)
+@Groups(UserGroups.AESTUser)
+@Controller("application-offering-change-request")
+@ApiTags(`${ClientTypeBaseRoute.AEST}-application-offering-change-request`)
+export class ApplicationOfferingChangeRequestAESTController extends BaseController {
+  constructor(
+    private readonly applicationOfferingChangeRequestService: ApplicationOfferingChangeRequestService,
+  ) {
+    super();
+  }
+
+  /**
+   * Get all in progress application offering change requests.
+   * @param pagination options to execute the pagination.
+   * @returns list and count of in progress application offering change requests.
+   */
+  @Get("in-progress")
+  async getAllInProgressApplications(
+    @Query() pagination: AllInProgressOfferingChangePaginationOptionsAPIInDTO,
+  ): Promise<
+    PaginatedResultsAPIOutDTO<AllInProgressApplicationOfferingChangesAPIOutDTO>
+  > {
+    const offeringChange =
+      await this.applicationOfferingChangeRequestService.getSummaryByStatus(
+        [
+          ApplicationOfferingChangeRequestStatus.InProgressWithSABC,
+          ApplicationOfferingChangeRequestStatus.InProgressWithStudent,
+        ],
+        pagination,
+      );
+    return {
+      results: offeringChange.results.map((eachOfferingChange) => {
+        const offering =
+          eachOfferingChange.application.currentAssessment.offering;
+        return {
+          id: eachOfferingChange.id,
+          applicationNumber: eachOfferingChange.application.applicationNumber,
+          applicationId: eachOfferingChange.application.id,
+          studyStartDate: offering.studyStartDate,
+          studyEndDate: offering.studyEndDate,
+          fullName: getUserFullName(
+            eachOfferingChange.application.student.user,
+          ),
+          status: eachOfferingChange.applicationOfferingChangeRequestStatus,
+          createdAt: getISODateOnlyString(eachOfferingChange.createdAt),
+          studentId: eachOfferingChange.application.student.id,
+        };
+      }),
+      count: offeringChange.count,
+    };
+  }
+}