#5878 - Student Forms e2e Tests - getFormSubmission by andrewsignori-aot · Pull Request #5924 · bcgov/SIMS

andrewsignori-aot · 2026-03-18T21:13:04Z

PR Goal

Add some level of API endpoints E2E tests to all new endpoints introduced during the new forms implementation. At least one scenario for each endpoint must be present, and more scenarios can be added if time allows it. Suggestions for scenarios not covered are appreciated, but will be taken care of based on criticality and time available 😉

getFormSubmission

Ministry

Should get a form submission as pending, its decisions and history when the form has multiple decisions and the user has approval authorization.
Should get a form submission as pending, and its decisions as pending without history when the form has multiple decisions, including an approved decision, and the user does not have approval authorization.
Should get a form submission as completed, and its decision statuses, including current notes when the user does not have approval authorization.
Should get a form submission as completed, and its decision statuses, including current notes and audit when the user has approval authorization.
Should get a form submission item, and its decision statuses, including current notes and audit when the user has approval authorization and an item ID was provided.
Should throw a not found exception when the form submission ID does not exist.
Should throw a not found exception when the form submission ID or the item ID does not exist.

Institution

Should get a form submission as pending and its decisions as pending when the final decision is not yet made and there is an approved and a pending decision (no decision set).
Should get a form submission as completed and its decision statuses, including the decision notes, when form submission is completed.
Should throw a not found exception when the form submission ID exists for the student but the user does not have access to the location.

Students

Should get a form submission as pending and its decisions as pending when the final decision is not yet made and there is an approved and a pending decision (no decision set).
Should get a form submission as completed and its decision statuses when form submission is completed.
Should throw a not found exception when the form submission ID belongs to another student.
Should throw a not found exception when the form submission ID does not exist.

Fix

Ministry's approval visualization

Users without approval roles were not able to see the final decision once the form submissions were completed.
The image below is what Ministry users without approval roles will be able to see, similar to BC Public Institutions.
They have access to the decision statuses and final note only when the submission is completed, following the same idea from the BC Public Institutions.

Ministry's history view

The history visualization was also adapted to behave similarly to BC Public Institutions, where the "temporary" decision status is not displayed until the final decision is made.

Copilot

Pull request overview

This PR adds e2e coverage for the new getFormSubmission endpoints across clients (students/institutions/ministry) and adjusts Ministry decision-visibility rules so non-approval roles can see final decision info once a submission is completed.

Changes:

Added e2e specs for getFormSubmission for Students, Institutions, and AEST, plus a small assertion style tweak in an existing student spec.
Refactored form-submission approval-role authorization into a dedicated helper and updated controller/service mapping to use role-based decision-detail restrictions.
Updated the Ministry UI approval component to hide decision controls for users without approval authorization.

Reviewed changes

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

Show a summary per file

File	Description
sources/packages/web/src/components/form-submissions/FormSubmissionApproval.vue	Adjusts what decision UI is rendered based on approval authorization/submission status.
sources/packages/backend/libs/test-utils/src/factories/form-submission.ts	Adds a richer factory helper to create submissions/items/decisions for e2e tests.
sources/packages/backend/libs/test-utils/src/factories/form-submission-item.ts	Extends factory to support audit user/decision array initialization.
sources/packages/backend/libs/test-utils/src/factories/dynamic-form-configuration.ts	Extends dynamic form configuration helpers to support more flexible setup for tests.
sources/packages/backend/apps/api/src/services/index.ts	Exposes the new form-submission authorization helper via barrel export.
sources/packages/backend/apps/api/src/services/form-submission/form-submission.models.ts	Removes embedded approval-role map (moved to authorization helper).
sources/packages/backend/apps/api/src/services/form-submission/form-submission.authorization.ts	Introduces shared approval-authorization helper and roles map.
sources/packages/backend/apps/api/src/services/form-submission/form-submission-approval.service.ts	Switches authorization checks to use the shared helper.
sources/packages/backend/apps/api/src/route-controllers/form-submission/form-submission.controller.service.ts	Updates decision mapping logic to restrict details based on user roles + submission status.
sources/packages/backend/apps/api/src/route-controllers/form-submission/form-submission.aest.controller.ts	Uses shared authorization logic and controller-service decision mapping for Ministry output.
sources/packages/backend/apps/api/src/route-controllers/form-submission/tests/e2e/form-submission.students.controller.getSubmissionForms.e2e-spec.ts	Minor assertion style change (`toStrictEqual`).
sources/packages/backend/apps/api/src/route-controllers/form-submission/tests/e2e/form-submission.students.controller.getFormSubmission.e2e-spec.ts	New Students e2e coverage for getFormSubmission scenarios.
sources/packages/backend/apps/api/src/route-controllers/form-submission/tests/e2e/form-submission.institutions.controller.getFormSubmission.e2e-spec.ts	New Institutions e2e coverage for getFormSubmission scenarios.
sources/packages/backend/apps/api/src/route-controllers/form-submission/tests/e2e/form-submission.aest.controller.getFormSubmission.e2e-spec.ts	New AEST e2e coverage for getFormSubmission scenarios.

Comments suppressed due to low confidence (1)

sources/packages/backend/apps/api/src/route-controllers/form-submission/form-submission.controller.service.ts:36

The JSDoc for getFormSubmissions still references keepPendingDecisionsWhilePendingFormSubmission, but this option was removed from the method signature. Please update/remove this part of the comment to avoid misleading API/controller behavior documentation.

   * - `userRoles` when provided, it will be used to determine the access to the decision details
   * that the consumer has based on their roles and the form category.
   * - `includeBasicDecisionDetails` optional flag to include basic decision details, besides
   * the decision status. Used for institutions to have access to more details than the student
   * to better support them. Default to false when not provided to expose less information. When keepPendingDecisionsWhilePendingFormSubmission
   * is true, the decision details will not be included while the form submission is pending to avoid showing non-final decisions
   * to be exposed.

You can also share your feedback on Copilot code review. Take the survey.

sources/packages/web/src/components/form-submissions/FormSubmissionApproval.vue

sources/packages/backend/libs/test-utils/src/factories/form-submission-item.ts

...rs/form-submission/_tests_/e2e/form-submission.aest.controller.getFormSubmission.e2e-spec.ts

...orm-submission/_tests_/e2e/form-submission.students.controller.getFormSubmission.e2e-spec.ts

...es/backend/apps/api/src/route-controllers/form-submission/form-submission.aest.controller.ts

sources/packages/backend/apps/api/src/services/form-submission/form-submission.authorization.ts

dheepak-aot · 2026-03-19T22:21:31Z

...rs/form-submission/_tests_/e2e/form-submission.aest.controller.getFormSubmission.e2e-spec.ts

+
+    // Mock the user received in the token.
+    await mockJWTUserInfo(appModule, formSubmission.student.user);
+


The mockJWTUserInfo is still there. Isn't it supposed to be removed.

I guess I got them all removed now 😉

dheepak-aot · 2026-03-19T22:34:57Z

...rs/form-submission/_tests_/e2e/form-submission.aest.controller.getFormSubmission.e2e-spec.ts

+      );
+  });
+
+  it("Should get a form submission as completed, and its decision statuses, including current notes when the user does not have approval authorization.", async () => {


Minor. current decision notes?

dheepak-aot · 2026-03-19T22:50:35Z

...rs/form-submission/_tests_/e2e/form-submission.aest.controller.getFormSubmission.e2e-spec.ts

+          formCategory: formSubmission.formCategory,
+          status: formSubmission.submissionStatus,


Minor and not blocker. Form category and submission status can be used as values.

I tried to change them all across all the files.

dheepak-aot · 2026-03-19T22:56:04Z

...submission/_tests_/e2e/form-submission.institutions.controller.getFormSubmission.e2e-spec.ts

+    const collegeFAlternativeLocation = createFakeInstitutionLocation({
+      institution: collegeF,
+    });
+    const application = await saveFakeApplication(db.dataSource, {


This is as good as const application = await saveFakeApplication(db.dataSource); for the test and alternative location is not required.

Yes, it would work, but the idea was to have a location under the same institution being used for the other for the same scenario.

dheepak-aot · 2026-03-19T22:59:13Z

...orm-submission/_tests_/e2e/form-submission.students.controller.getFormSubmission.e2e-spec.ts

+          formCategory: FormCategory.StudentAppeal,
+          status: FormSubmissionStatus.Completed,
+          submittedDate: formSubmission.submittedDate.toISOString(),
+          assessedDate: formSubmission.assessedDate?.toISOString(),


The optional chaining operation is not required here.

Removed the "?".

dheepak-aot · 2026-03-19T23:08:43Z

...rm-submission/_tests_/e2e/form-submission.students.controller.getSubmissionForms.e2e-spec.ts

-          configurations: [
+      .expect(({ body }) =>
+        expect(body.configurations).toEqual(
+          expect.arrayContaining([


Is there a reason to use arrayContaining?

Yes, the DB now has other dynamic configurations added along with the tests that would be retrieved by this method. The idea was to keep the validation to ensure the PROD ones are present.

tiago-graf · 2026-03-19T23:14:23Z

...rs/form-submission/_tests_/e2e/form-submission.aest.controller.getFormSubmission.e2e-spec.ts

+    const formSubmission = await saveFakeFormSubmissionFromInputTestData(db, {
+      formCategory: FormCategory.StudentAppeal,
+      submissionStatus: FormSubmissionStatus.Pending,
+      auditUser: ministryUser,


minor: creator should be a student

I am changing to internally use the student for the form submission creation and audit user for the Ministry scope, for instance, while saving the decision.

dheepak-aot · 2026-03-19T23:18:24Z

...backend/apps/api/src/route-controllers/form-submission/form-submission.controller.service.ts

+      !hasFormSubmissionApprovalAuthorization(
+        submissionItem.dynamicFormConfiguration.formCategory,
+        userRoles,
+      ) && submissionStatus === FormSubmissionStatus.Pending;


dheepak-aot · 2026-03-19T23:19:36Z

sources/packages/backend/libs/test-utils/src/factories/dynamic-form-configuration.ts

 ): DynamicFormConfiguration {
  const dynamicFormConfiguration = new DynamicFormConfiguration();
-  dynamicFormConfiguration.formType = formType;
+  dynamicFormConfiguration.formType = formType as DynamicFormType;


tiago-graf · 2026-03-19T23:19:56Z

...es/backend/apps/api/src/route-controllers/form-submission/form-submission.aest.controller.ts

  /**
   * Gets the list of form submissions for a student,
   * including the individual form items and their details.
   * @param studentId student ID to retrieve the form submission history for.


minor: missing userToken comment definition

We refrain from adding it. There will be many endpoints missing it.

dheepak-aot · 2026-03-19T23:26:32Z

Nice work. Just a few minor comments.

sonarqubecloud · 2026-03-20T00:12:47Z

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-03-20T00:13:23Z

Backend Unit Tests Coverage Report

Totals
Statements:	20.12% ( 4577 / 22747 )
Methods:	9.47% ( 262 / 2768 )
Lines:	24.49% ( 3929 / 16045 )
Branches:	9.81% ( 386 / 3934 )

github-actions · 2026-03-20T00:13:42Z

E2E Workflow Workers Coverage Report

Totals
Statements:	48.25% ( 2712 / 5621 )
Methods:	38.2% ( 285 / 746 )
Lines:	55.11% ( 2049 / 3718 )
Branches:	32.67% ( 378 / 1157 )

github-actions · 2026-03-20T00:16:33Z

E2E Queue Consumers Coverage Report

Totals
Statements:	79.31% ( 9155 / 11543 )
Methods:	78.42% ( 1181 / 1506 )
Lines:	82.64% ( 6881 / 8326 )
Branches:	63.88% ( 1093 / 1711 )

github-actions · 2026-03-20T00:18:42Z

E2E SIMS API Coverage Report

Totals
Statements:	65.55% ( 12995 / 19824 )
Methods:	62.3% ( 1527 / 2451 )
Lines:	69.14% ( 9431 / 13640 )
Branches:	54.57% ( 2037 / 3733 )

andrewsignori-aot added 3 commits March 17, 2026 10:59

Starting E2E for getFormSubmission

9a460ee

getFormSubmission updates

9a46c83

Added getFormSubmission for FormSubmissionAESTController

19ad67d

andrewsignori-aot self-assigned this Mar 18, 2026

andrewsignori-aot added Student Student Features Institution Institution Features Ministry Ministry Features E2E/Unit tests labels Mar 18, 2026

andrewsignori-aot added 5 commits March 18, 2026 16:23

Institutions getFormSubmission

b1fe08c

Pre review changes

a44b9e0

Adjusting data for Ministry user without approval role

468185e

Minor fixes

b601d69

Merge branch 'main' into feature/#5878-forms-e2e-tests-part-2

c93bec6

andrewsignori-aot marked this pull request as ready for review March 19, 2026 02:29

Copilot AI review requested due to automatic review settings March 19, 2026 02:29

Copilot AI reviewed Mar 19, 2026

View reviewed changes

Copilot and other E2E fixes

4944d3d

dheepak-aot self-requested a review March 19, 2026 20:59

tiago-graf self-requested a review March 19, 2026 21:53

dheepak-aot reviewed Mar 19, 2026

View reviewed changes

tiago-graf reviewed Mar 19, 2026

View reviewed changes

dheepak-aot reviewed Mar 19, 2026

View reviewed changes

tiago-graf reviewed Mar 19, 2026

View reviewed changes

PR comments

8785129

tiago-graf approved these changes Mar 20, 2026

View reviewed changes


		// Mock the user received in the token.
		await mockJWTUserInfo(appModule, formSubmission.student.user);

		formCategory: formSubmission.formCategory,
		status: formSubmission.submissionStatus,

Conversation

andrewsignori-aot commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Goal

getFormSubmission

Ministry

Institution

Students

Fix

Ministry's approval visualization

Ministry's history view

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Mar 20, 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!

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!

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!

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!

dheepak-aot commented Mar 19, 2026

Uh oh!

sonarqubecloud bot commented Mar 20, 2026

Quality Gate passed

Uh oh!

github-actions bot commented Mar 20, 2026

Backend Unit Tests Coverage Report

Uh oh!

github-actions bot commented Mar 20, 2026

E2E Workflow Workers Coverage Report

Uh oh!

github-actions bot commented Mar 20, 2026

E2E Queue Consumers Coverage Report

Uh oh!

github-actions bot commented Mar 20, 2026

E2E SIMS API Coverage Report

Uh oh!

Reviewers

Assignees

andrewsignori-aot commented Mar 18, 2026 •

edited

Loading

andrewsignori-aot Mar 20, 2026 •

edited

Loading