#5969 - Add PIR outcome to applications by tiago-graf · Pull Request #6237 · bcgov/SIMS

tiago-graf · 2026-06-12T16:05:58Z

Summary

Adds PIR outcome to applications when it applies.

Copilot

Pull request overview

Adds PIR (Program Information Request) outcome summary details into application form data so that the SFAA form can display a read-only “Program information request summary” section when PIR is completed.

Changes:

Added a new read-only PIR summary panel (program name + offering name) to SFAA form definitions across multiple program years/intensities.
Enhanced ApplicationService.getApplicationById to optionally load original assessment offering/program details needed for the PIR summary.
Injected PIR summary fields into application form data for Students/Institutions/AEST application detail endpoints, with e2e coverage added/updated.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
sources/packages/forms/src/form-definitions/sfaa2026-27-pt.json	Adds PIR summary panel/fields to the 2026-27 PT form.
sources/packages/forms/src/form-definitions/sfaa2026-27-ft.json	Adds PIR summary panel/fields to the 2026-27 FT form.
sources/packages/forms/src/form-definitions/sfaa2025-26-pt.json	Adds PIR summary panel/fields to the 2025-26 PT form.
sources/packages/forms/src/form-definitions/sfaa2025-26-ft.json	Adds PIR summary panel/fields to the 2025-26 FT form.
sources/packages/forms/src/form-definitions/sfaa2024-25.json	Adds PIR summary panel/fields to the 2024-25 form.
sources/packages/forms/src/form-definitions/sfaa2023-24.json	Adds PIR summary panel/fields to the 2023-24 form.
sources/packages/forms/src/form-definitions/sfaa2022-23.json	Adds PIR summary panel/fields to the 2022-23 form.
sources/packages/backend/apps/api/src/services/application/application.service.ts	Adds `loadPIRSummaryData` option to fetch assessment/offering/program details for PIR summary.
sources/packages/backend/apps/api/src/route-controllers/application/models/application.dto.ts	Extends `ApplicationFormData` with PIR summary fields.
sources/packages/backend/apps/api/src/route-controllers/application/application.students.controller.ts	Enables PIR summary loading and injects summary into student application form data.
sources/packages/backend/apps/api/src/route-controllers/application/application.institutions.controller.ts	Enables PIR summary loading and injects summary into institution application form data when dynamic data is loaded.
sources/packages/backend/apps/api/src/route-controllers/application/application.controller.service.ts	Adds `addPIRSummaryToFormData` helper to enrich form data when PIR is completed.
sources/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts	Enables PIR summary loading and injects summary into AEST application form data when dynamic data is loaded.
sources/packages/backend/apps/api/src/route-controllers/application/tests/e2e/application.students.controller.getApplication.e2e-spec.ts	Updates/extends student getApplication e2e coverage for PIR summary.
sources/packages/backend/apps/api/src/route-controllers/application/tests/e2e/application.institutions.controller.getApplicationDetails.e2e-spec.ts	Adds institution getApplicationDetails e2e coverage for PIR summary.
sources/packages/backend/apps/api/src/route-controllers/application/tests/e2e/application.aest.controller.getApplicationDetails.e2e-spec.ts	Adds AEST getApplicationDetails e2e coverage for PIR summary.

+          pirSummaryProgramName:
+            application.currentAssessment?.offering?.educationProgram.name,
+          pirSummaryOfferingName: getOfferingNameAndPeriod(
+            application.currentAssessment?.offering,
+          ),


andrewsignori-aot · 2026-06-12T22:17:23Z

+   * Injected for the read-only PIR outcome summary section in the application form.
+   * Only populated when pirStatus is completed.
+   */
+  pirSummaryProgramName?: string;


Similar to selectedProgramDesc, a new object can be added to group the pirSummary.

andrewsignori-aot · 2026-06-12T22:19:19Z

        currentReadOnlyDataPromise,
        previousReadOnlyDataPromise,
      ]);
+      this.applicationControllerService.addPIRSummaryToFormData(


Is there any particular reason the generateApplicationFormData was not included as one aditonal step into the existing generateApplicationFormData?

andrewsignori-aot · 2026-06-12T22:33:38Z

      loadDynamicData?: boolean;
      studentId?: number;
      entityManager?: EntityManager;
+      loadPIRSummaryData?: boolean;


Is loadPIRSummaryData not an extension of the loadDynamicData?
Should loadPIRSummaryData ever be loaded if the loadDynamicData is false?

andrewsignori-aot · 2026-06-15T19:44:35Z

+              programName: savedOffering!.educationProgram.name,
+              offeringName: getOfferingNameAndPeriod(savedOffering!),


From the moment the type was ensured at line 300, these non-null-assertion operators can be removed.

andrewsignori-aot · 2026-06-15T19:50:34Z

+    const offeringInitialValues = {
+      name: "Test PIR Offering Name",
+      studyStartDate: "2024-09-01",
+      studyEndDate: "2025-04-30",
+      yearOfStudy: 2,


Was there a need to have these values explicitly defined?

andrewsignori-aot · 2026-06-15T19:53:16Z

+   */
+  pirSummary?: {
+    /**
+     * Program name from the completed PIR's current assessment offering.


current assessment offering seems misleading in this context (same for the offeringName property). Please use something like this.

Program name from the completed PIR in the application's original assessment.

andrewsignori-aot · 2026-06-15T20:00:09Z

+          data: {
+            pirSummary: {
+              programName: savedOffering.educationProgram.name,
+              offeringName: getOfferingNameAndPeriod(savedOffering),


Just noticed it now; the idea is to try to avoid using this type of production utility to ensure the test will fail if an issue is introduced at that level.
The recommendation is either to control the input data and test a constant or recreate in a raw way the utility output.

andrewsignori-aot · 2026-06-15T20:27:47Z

+                  "key": "pirSummaryPanel",
+                  "label": "Program information request summary",
+                  "input": false,
+                  "customConditional": "show = !!(data.pirSummary && data.pirSummary.programName);",


Is "show = !!data.pirSummary not enough for the condition?

andrewsignori-aot

Thanks for making the changes. Please take a look at the comments.

weskubo-cgi

Looks good!

andrewsignori-aot · 2026-06-16T00:03:28Z

+    programName?: string;
+    /**
+     * Formatted offering name (including year of study and dates) from the
+     * completed PIR in the application's original assessment.
+     */
+    offeringName?: string;


Minor, those two must be present once the pirSummary is present.

andrewsignori-aot · 2026-06-16T00:03:55Z

   */
  async generateApplicationFormData(
-    data: ApplicationData,
+    application: Application,


Please update the parameter comments.

andrewsignori-aot · 2026-06-16T00:05:46Z

+        currentAssessment: {
+          offering: options?.loadDynamicData
+            ? { educationProgram: true }
+            : true,
+        },


Is this change still required?

andrewsignori-aot

Thanks for making the changes. Minor comments left. Feel free to merge once it is done.

sonarqubecloud · 2026-06-16T00:40:17Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2026-06-16T00:40:38Z

Backend Unit Tests Coverage Report

Totals
Statements:	20.08% ( 4753 / 23671 )
Methods:	9.81% ( 282 / 2874 )
Lines:	24.41% ( 4061 / 16635 )
Branches:	9.85% ( 410 / 4162 )

github-actions · 2026-06-16T00:41:04Z

E2E Workflow Workers Coverage Report

Totals
Statements:	47.81% ( 2746 / 5744 )
Methods:	37.57% ( 287 / 764 )
Lines:	54.63% ( 2075 / 3798 )
Branches:	32.49% ( 384 / 1182 )

github-actions · 2026-06-16T00:44:09Z

E2E Queue Consumers Coverage Report

Totals
Statements:	81.49% ( 9627 / 11814 )
Methods:	81.12% ( 1250 / 1541 )
Lines:	84.75% ( 7205 / 8501 )
Branches:	66.14% ( 1172 / 1772 )

github-actions · 2026-06-16T00:49:59Z

E2E SIMS API Coverage Report

Totals
Statements:	68.9% ( 14202 / 20612 )
Methods:	66.42% ( 1689 / 2543 )
Lines:	72.07% ( 10171 / 14113 )
Branches:	59.2% ( 2342 / 3956 )

Add PIR outcome to applications

e03b263

tiago-graf self-assigned this Jun 12, 2026

Update e2e tests

45975ec

tiago-graf marked this pull request as ready for review June 12, 2026 17:36

Copilot AI review requested due to automatic review settings June 12, 2026 17:36

Copilot started reviewing on behalf of tiago-graf June 12, 2026 17:36 View session

Copilot AI reviewed Jun 12, 2026

View reviewed changes

Update application.service.ts

9e0447a

tiago-graf added Form.io Form IO definitions changed. Backend Used by the dependabot pull requests to identify PRs related to the backend. labels Jun 12, 2026

weskubo-cgi self-requested a review June 12, 2026 18:55

andrewsignori-aot self-requested a review June 12, 2026 20:35

andrewsignori-aot reviewed Jun 12, 2026

View reviewed changes

Comment thread ...pplication/_tests_/e2e/application.institutions.controller.getApplicationDetails.e2e-spec.ts

andrewsignori-aot reviewed Jun 12, 2026

View reviewed changes

weskubo-cgi requested changes Jun 12, 2026

View reviewed changes

andrewsignori-aot reviewed Jun 12, 2026

View reviewed changes

tiago-graf added 2 commits June 15, 2026 10:35

Updated PR Comments

8823b81

Update application.students.controller.getApplication.e2e-spec.ts

c782ea8

andrewsignori-aot reviewed Jun 15, 2026

View reviewed changes

Comment thread ...s/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts

andrewsignori-aot reviewed Jun 15, 2026

View reviewed changes

tiago-graf added 2 commits June 15, 2026 16:04

Updated based on PR Comments

7654f9f

Updated form definitions

77ebe4e

weskubo-cgi approved these changes Jun 15, 2026

View reviewed changes

Load PIR info from original assessment

64aa9f7

andrewsignori-aot reviewed Jun 16, 2026

View reviewed changes

andrewsignori-aot approved these changes Jun 16, 2026

View reviewed changes

Update application.service.ts

c2c1974

		programName: savedOffering!.educationProgram.name,
		offeringName: getOfferingNameAndPeriod(savedOffering!),

Conversation

tiago-graf commented Jun 12, 2026

Summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Jun 15, 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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot left a comment

Choose a reason for hiding this comment

Uh oh!

weskubo-cgi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Jun 16, 2026

Quality Gate passed

Uh oh!

github-actions Bot commented Jun 16, 2026

Backend Unit Tests Coverage Report

Uh oh!

github-actions Bot commented Jun 16, 2026

E2E Workflow Workers Coverage Report

Uh oh!

github-actions Bot commented Jun 16, 2026

E2E Queue Consumers Coverage Report

Uh oh!

github-actions Bot commented Jun 16, 2026

E2E SIMS API Coverage Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

andrewsignori-aot Jun 15, 2026 •

edited

Loading