#4378 - Ecert Cancellation - UI & Ministry Access (2/2) #5108

andrewsignori-aot · 2025-08-27T20:01:54Z

Created new role student-cancel-disbursement-schedule.
Created new API endpoint for disbursement schedules (placeholder for upcoming PR).
Included in the assessment summary API payload the below new values:
- disbursementReceipt[n]Received: indicates if a receipt was received. Note: full-time final awards are retrieved when a receipt is received, and part-time are displayed upon e-Cert creation. This new variable indicates when a receipt was received, not when a final award was returned.
- disbursementReceipt[n]HasAwards: added to indicate when an award is present in the payload. Previously, only awards were present in this payload, and they were dynamically created. Adding the boolean makes it easier to identify when awards are present, avoiding inspecting the object structure as was done before. The examples for the payloads with the new variables were updated and can be seen across many E2E tests.
Created a new component StatusInfoDisbursementCancellation to display the information when a disbursement is cancelled, following a similar idea from the StatusInfoEnrolment.
Created a new component CancelDisbursementSchedule following the same idea from ConfirmEnrolment.
Created the generic modal user-note-confirm-modal to allow modal confirmation, including a user note. Its usage can be checked in the CancelDisbursementSchedule.vue.

Please note

1. Changes executed in the methods retrieving the data for the summary page were executed, trying to keep the current dynamic behavior. Additional changes can be made to make a hybrid object model between dynamic and non-dynamic properties, but it was not considered worthwhile as part of this effort.
2. Some UI changes are pending decision, but no major adaptations are expected.

Ministry View

Full-time, Final award, e-Cert `Sent`, no receipts

Full-time, Final award, e-Cert `Rejected`, no receipts

Full-time, Final award, e-Cert `Pending`, no receipts

Full-time, Final award, e-Cert `Pending`, with receipts

Cancel eCert modal

Buttons and icons adjustments

.../assessment/_tests_/e2e/assessment.students.controller.getAssessmentAwardDetails.e2e-spec.ts

dheepak-aot · 2025-09-03T13:04:00Z

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

+/**
+ * Indicates which disbursement schedule statuses have
+ * the potential to generate a receipt.
+ */


Is Rejected considered as a potential status to generate e-cert? If no, can we update the description and also the constant name?

Rejected is considered a status where receipts could exist, which means that Sent or Reject disbursements may have receipts associated with a disbursement.
Is the use of the word "generate" misleading? I can rephrase as

Indicates which disbursement schedule statuses are expected to have some receipts generated.

Comment improved.

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

dheepak-aot · 2025-09-03T15:59:28Z

...pps/api/src/route-controllers/disbursement-schedule/disbursement-schedule.aest.controller.ts

+    console.log(
+      "Cancelling disbursement schedule:",
+      disbursementScheduleId,
+      payload,
+    );
+  }


Please remove the console log.

Part of the temporary code to be replaced with the real implementation. I did not see any harm in keeping it.

Remove to prevent noise in the PR.

dheepak-aot · 2025-09-03T16:01:52Z

sources/packages/backend/apps/api/src/route-controllers/index.ts

+export * from "./disbursement-schedule/disbursement-schedule.aest.controller";
+export * from "./disbursement-schedule/models/disbursement-schedule.dto";


Will it be better if we import the DTO before the controller so that when we use imports from index we could potentially avoid conflicts.

I did not understand this at first, but is there any technical reason to enforce the order?

bidyashish

Looks good,
Please look at comments.

bidyashish · 2025-09-03T19:07:13Z

...llers/assessment/_tests_/e2e/assessment.institutions.controller.getAssessmentNOA.e2e-spec.ts

    // Arrange
    const [enrolmentDate1, enrolmentDate2] = [addDays(1), addDays(30)];
+    const [statusUpdatedOn1, statusUpdatedOn2] = [addDays(2), addDays(31)];
    // Student has an application to the institution eligible for NOA.


[addDays(2), addDays(31)]; whats the need to make it to 31.

The idea was to ensure the dates were different to ensure the expected ones would be returned.

sources/packages/web/src/components/common/AssessmentAwardDetails.vue

sources/packages/web/src/services/DisbursementScheduleService.ts

dheepak-aot · 2025-09-03T20:20:49Z

sources/packages/web/src/composables/useModalDialog.ts

 import { Ref, ref } from "vue";

-export function useModalDialog<T, TParameter = any>() {
+export function useModalDialog<T, TParameter = unknown>() {


dheepak-aot · 2025-09-03T20:21:20Z

sources/packages/web/src/components/common/students/applicationDetails/AssessmentAward.vue

+    :allow-disbursement-cancellation="allowDisbursementCancellation"
    :allow-final-award-extended-information="allowFinalAwardExtendedInformation"
-    @confirmEnrolment="$emit('confirmEnrolment', $event)"
+    @confirm-enrolment="$emit('confirmEnrolment', $event)"


sources/packages/web/src/components/common/modals/UserNoteConfirmModal.vue

sonarqubecloud · 2025-09-03T20:48:41Z

Quality Gate failed

Failed conditions
6.0% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

github-actions · 2025-09-03T20:49:34Z

Backend Unit Tests Coverage Report

Totals
Statements:	21.44% ( 4123 / 19227 )
Methods:	9.5% ( 233 / 2452 )
Lines:	24.81% ( 3570 / 14391 )
Branches:	13.42% ( 320 / 2384 )

github-actions · 2025-09-03T20:49:49Z

E2E Workflow Workers Coverage Report

Totals
Statements:	74.32% ( 897 / 1207 )
Methods:	77.14% ( 108 / 140 )
Lines:	77.19% ( 697 / 903 )
Branches:	56.1% ( 92 / 164 )

github-actions · 2025-09-03T20:52:44Z

E2E Queue Consumers Coverage Report

Totals
Statements:	86.43% ( 1548 / 1791 )
Methods:	84.62% ( 176 / 208 )
Lines:	88.75% ( 1278 / 1440 )
Branches:	65.73% ( 94 / 143 )

github-actions · 2025-09-03T20:53:22Z

E2E SIMS API Coverage Report

Totals
Statements:	74.12% ( 7416 / 10006 )
Methods:	71.65% ( 905 / 1263 )
Lines:	77.55% ( 5747 / 7411 )
Branches:	57.36% ( 764 / 1332 )

dheepak-aot

Thanks for making the changes and bringing improvements to existing framework. Looks good 👍

UI + API, work in-progress

59731d0

andrewsignori-aot self-assigned this Aug 27, 2025

andrewsignori-aot added SIMS-Api SIMS-Api Web portal labels Aug 27, 2025

andrewsignori-aot added 12 commits August 27, 2025 17:10

Created the generic modal for notes.

60265e9

Close to final UI

de7e65f

Pre-review adjustments

9ec587f

Fixed institution E2E tests

7a9f637

Fix AEST tests

99cf518

Fix students E2Es

1029884

Fixed institution getAssessmentNOA

4c485c2

Fix student getAssessmentNOA

70eff32

Receipts flags and E2E improvements

bbf0b7a

Fix AssessmentStudentsController E2E tests

b27eb91

Fix AssessmentInstitutionsController E2E tests

c0ed435

UI adjustments

4c8c645

andrewsignori-aot marked this pull request as ready for review August 30, 2025 00:52

dheepak-aot self-requested a review September 3, 2025 12:25