#5525 - Update Disbursement Report to include Forecast Date #5579

tiago-graf · 2026-01-05T23:05:16Z

Changes Includes a new migration to update SQL of the report "Disbursement_Report" in the database. The new SQL includes a "Forecast Date" Column.

Rollback test:

Copilot

Pull request overview

This PR updates the Disbursement Report to include a new "Forecast Date" column, which displays the scheduled disbursement date alongside the actual disbursement date. The change is implemented through a database migration that updates the SQL query stored in the report configuration table.

Adds "Forecast Date" column (from ds.disbursement_date) as the first column in all three UNION queries
Provides both forward migration (to add the column) and rollback migration (to remove it)
Maintains existing report ordering and filtering logic

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
`1767653404966-UpdateDisbursementReportForecastDate.ts`	TypeScript migration class that executes the SQL update and rollback scripts
`Update-disbursements-report-forecast-date.sql`	SQL script that adds the "Forecast Date" column to all three UNION queries in the disbursement report
`Rollback-update-disbursements-report-forecast-date.sql`	SQL script that removes the "Forecast Date" column to revert to the previous report version

...ges/backend/apps/db-migrations/src/sql/Reports/Update-disbursements-report-forecast-date.sql

...kend/apps/db-migrations/src/migrations/1767653404966-UpdateDisbursementReportForecastDate.ts

Copilot

Pull request overview

Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.

...kend/apps/db-migrations/src/migrations/1767653404966-UpdateDisbursementReportForecastDate.ts

dheepak-aot · 2026-01-06T17:17:10Z

...kend/apps/db-migrations/src/migrations/1767653404966-UpdateDisbursementReportForecastDate.ts

+export class UpdateDisbursementReportForecastDate1767653404966 implements MigrationInterface {
+  /**
+   * Update the disbursement reports to include the "Forecast Date" column.
+   * @param queryRunner  the query runner.


Please remove the additional space between the param and comment.

dheepak-aot · 2026-01-06T17:18:53Z

sources/packages/backend/package-lock.json

      }
    }
  }
-}


Can we not include this file if this is not necessary?

dheepak-aot · 2026-01-06T17:25:37Z

PR looks good. Please add a E2E test.

dheepak-aot · 2026-01-06T21:28:42Z

...api/src/route-controllers/report/_tests_/e2e/report.aest.controller.exportReport.e2e-spec.ts

+    const student = application.student;
+    const sinValidation = createFakeSINValidation({
+      student,
+    });
+    student.sinValidation = sinValidation;
+    await db.student.save(student);
+    await db.sinValidation.save(sinValidation);


saveFakeStudent can replace all the work done here. Please use a student created from saveFakeStudent in saveFakeApplicationDisbursements line 1387 and SIN validation will be automatically taken care.

dheepak-aot

Thanks for making the changes. Looks good.

weskubo-cgi

Changes look great. Tested report with migration and rollback. Just a few very minor comments.

...kend/apps/db-migrations/src/migrations/1767653404966-UpdateDisbursementReportForecastDate.ts

...api/src/route-controllers/report/_tests_/e2e/report.aest.controller.exportReport.e2e-spec.ts

weskubo-cgi · 2026-01-06T21:06:53Z

...ages/backend/apps/db-migrations/src/sql/Reports/Update-disbursement-report-forecast-date.sql

@@ -73,6 +73,7 @@ SET
  )
 ORDER BY
  "Date of Disbursement",
-  "Certificate Number" $$
+  "Certificate Number",
+  "Funding Code" $$


question: Is this a new requirement? I don't see an AC for it.

This is not part of the AC
The current order by will cause the disbursement values to be returned in random order making it unpredictable in the tests.
The change however should not affect the reporting.

@tiago-graf I believe the strict equal/equal(one among the 2) does not enforce the order. If that is added for tests I would ask to remove it as we can handle the assertion.

I think we can also shift the disbursementDate by a day on federal or provincial to get a consistent date sort.

sonarqubecloud · 2026-01-06T23:50:32Z

Quality Gate failed

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

See analysis details on SonarQube Cloud

github-actions · 2026-01-06T23:50:57Z

Backend Unit Tests Coverage Report

Totals
Statements:	20.3% ( 4323 / 21298 )
Methods:	9.66% ( 252 / 2609 )
Lines:	24.45% ( 3705 / 15155 )
Branches:	10.36% ( 366 / 3534 )

github-actions · 2026-01-06T23:51:19Z

E2E Workflow Workers Coverage Report

Totals
Statements:	75.41% ( 1055 / 1399 )
Methods:	79.31% ( 115 / 145 )
Lines:	78.79% ( 769 / 976 )
Branches:	61.51% ( 171 / 278 )

github-actions · 2026-01-06T23:54:17Z

E2E Queue Consumers Coverage Report

Totals
Statements:	85.68% ( 1616 / 1886 )
Methods:	85% ( 187 / 220 )
Lines:	88.64% ( 1287 / 1452 )
Branches:	66.36% ( 142 / 214 )

github-actions · 2026-01-06T23:55:05Z

E2E SIMS API Coverage Report

Totals
Statements:	75.57% ( 8582 / 11357 )
Methods:	75.59% ( 1028 / 1360 )
Lines:	79.64% ( 6235 / 7829 )
Branches:	60.84% ( 1319 / 2168 )

Add migration to update report

4490c27

tiago-graf self-assigned this Jan 5, 2026

tiago-graf added the DB DB migration involved label Jan 5, 2026

tiago-graf marked this pull request as ready for review January 5, 2026 23:06

tiago-graf requested a review from Copilot January 5, 2026 23:06

Copilot started reviewing on behalf of tiago-graf January 5, 2026 23:06 View session

Copilot AI reviewed Jan 5, 2026

View reviewed changes

Update SQL to format inner SQL (dollar sign instead of quotes)

5473752

tiago-graf requested a review from Copilot January 5, 2026 23:47

Copilot started reviewing on behalf of tiago-graf January 5, 2026 23:48 View session

Copilot AI reviewed Jan 5, 2026

View reviewed changes

...kend/apps/db-migrations/src/migrations/1767653404966-UpdateDisbursementReportForecastDate.ts Outdated Show resolved Hide resolved

...kend/apps/db-migrations/src/migrations/1767653404966-UpdateDisbursementReportForecastDate.ts Outdated Show resolved Hide resolved

dheepak-aot self-requested a review January 6, 2026 17:15

dheepak-aot reviewed Jan 6, 2026

View reviewed changes

tiago-graf added 4 commits January 6, 2026 10:05

Update package-lock.json

9d9bf1c

Update 1767653404966-UpdateDisbursementReportForecastDate.ts

adf1df3

Add unit test

34fd44a

Update Update-disbursements-report-forecast-date.sql

5005dba

dheepak-aot reviewed Jan 6, 2026

View reviewed changes

Update report.aest.controller.exportReport.e2e-spec.ts

c9b9687

dheepak-aot approved these changes Jan 6, 2026

View reviewed changes

weskubo-cgi requested changes Jan 6, 2026

View reviewed changes

Updated PR comments

a25eeea

weskubo-cgi approved these changes Jan 7, 2026

View reviewed changes

tiago-graf added this pull request to the merge queue Jan 7, 2026

Merged via the queue into main with commit e0f35a5 Jan 7, 2026
21 of 22 checks passed

tiago-graf deleted the feature/#5525-update-disbursement-report branch January 7, 2026 01:52

tiago-graf temporarily deployed to DEV January 7, 2026 01:57 — with GitHub Actions Inactive

tiago-graf temporarily deployed to DEV January 7, 2026 02:00 — with GitHub Actions Inactive

#5525 - Update Disbursement Report to include Forecast Date #5579

#5525 - Update Disbursement Report to include Forecast Date #5579

Uh oh!

Conversation

tiago-graf commented Jan 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

dheepak-aot Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

dheepak-aot Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

dheepak-aot commented Jan 6, 2026

Uh oh!

dheepak-aot Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

dheepak-aot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weskubo-cgi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weskubo-cgi Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

tiago-graf Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dheepak-aot Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

weskubo-cgi Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jan 6, 2026

Quality Gate failed

Uh oh!

github-actions bot commented Jan 6, 2026

Backend Unit Tests Coverage Report

Uh oh!

github-actions bot commented Jan 6, 2026

E2E Workflow Workers Coverage Report

Uh oh!

github-actions bot commented Jan 6, 2026

E2E Queue Consumers Coverage Report

Uh oh!

github-actions bot commented Jan 6, 2026

E2E SIMS API Coverage Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dheepak-aot left a comment •

edited

Loading

tiago-graf Jan 6, 2026 •

edited

Loading

weskubo-cgi Jan 7, 2026 •

edited

Loading