#5878 - Student Forms e2e Tests - Ministry submitItemDecision by andrewsignori-aot · Pull Request #5966 · bcgov/SIMS

andrewsignori-aot · 2026-03-27T00:47:09Z

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 😉

Ministry - submitItemDecision

"Should submit an item decision when there is no decision yet and the user has approval authorization.
Should submit an item decision, creating a history record when a decision is already in place and the user has approval authorization.
Should throw an unprocessable entity error when submitting an item decision for an application that was edited.
Should throw an unprocessable entity error when submitting an item decision for a completed form submission.
Should throw an unprocessable entity error when submitting a student form decision and the user is not authorized for the specific form category.
Should throw an unprocessable entity error when submitting a student appeal decision and the user is not authorized for the specific form category.
Should throw a forbidden error when submitting a form decision and the user is not authorized to access the endpoint.
Should throw an unprocessable entity error when submitting an item decision and last updated date is different.
Should throw a not found error when submitting an item decision and the item does not exist.

New JWT Token Helpers

Created the generic mockJWTToken to allow token manipulation.
Created the removeJWTUserRoles using the mockJWTToken as a helper to remove existing roles from a Ministry user to test authorization scenarios. More variations can be added as needed.
Existing student mockJWTUserInfo is now also consuming the mockJWTToken.

Copilot

Pull request overview

Adds end-to-end coverage for the AEST/Ministry submitItemDecision endpoint on form submission items, along with supporting test utilities to make JWT payload manipulation and timestamp assertions reliable/deterministic.

Changes:

Added comprehensive e2e tests for PATCH /aest/form-submission/items/:id/decision (success + common failure scenarios).
Introduced a reusable mockJWTToken helper to mutate JWT payloads in e2e tests (used to refactor student JWT mocking and enable role-removal scenarios).
Improved input handling for decision concurrency by transforming lastUpdateDate to a Date, and stabilized test data timestamps by setting FormSubmission.createdAt.

Reviewed changes

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

Show a summary per file

File	Description
sources/packages/backend/libs/test-utils/src/factories/form-submission.ts	Sets `createdAt` from the factory “now” value to keep timestamps deterministic in tests.
sources/packages/backend/apps/api/src/testHelpers/auth/token-helpers.ts	Adds `mockJWTToken` helper to mutate JWT payloads via `JwtStrategy.validate` spying.
sources/packages/backend/apps/api/src/testHelpers/auth/student-user-helpers.ts	Refactors `mockJWTUserInfo` to reuse `mockJWTToken` (reduces duplicated mocking logic).
sources/packages/backend/apps/api/src/testHelpers/auth/aest-token-helpers.ts	Adds `removeJWTUserRoles` helper for AEST authorization/role-negative test scenarios.
sources/packages/backend/apps/api/src/route-controllers/form-submission/models/form-submission.dto.ts	Ensures `lastUpdateDate` is transformed to `Date` for `@IsDate()` validation.
sources/packages/backend/apps/api/src/route-controllers/form-submission/tests/e2e/form-submission.aest.controller.submitItemDecision.e2e-spec.ts	New e2e suite validating decision submission behavior, authorization, concurrency/outdated handling, and not-found cases.

sonarqubecloud · 2026-03-27T01:38:21Z

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-27T01:39:19Z

Backend Unit Tests Coverage Report

Totals
Statements:	20.12% ( 4578 / 22754 )
Methods:	9.47% ( 262 / 2767 )
Lines:	24.49% ( 3930 / 16045 )
Branches:	9.79% ( 386 / 3942 )

github-actions · 2026-03-27T01:39:39Z

E2E Workflow Workers Coverage Report

Totals
Statements:	48.27% ( 2713 / 5620 )
Methods:	38.26% ( 285 / 745 )
Lines:	55.14% ( 2050 / 3718 )
Branches:	32.67% ( 378 / 1157 )

github-actions · 2026-03-27T01:42:17Z

E2E Queue Consumers Coverage Report

Totals
Statements:	79.33% ( 9156 / 11542 )
Methods:	78.47% ( 1181 / 1505 )
Lines:	82.66% ( 6882 / 8326 )
Branches:	63.88% ( 1093 / 1711 )

github-actions · 2026-03-27T01:44:37Z

E2E SIMS API Coverage Report

Totals
Statements:	66.89% ( 13264 / 19831 )
Methods:	63.96% ( 1567 / 2450 )
Lines:	70.3% ( 9589 / 13640 )
Branches:	56.35% ( 2108 / 3741 )

andrewsignori-aot · 2026-03-27T20:14:35Z

   * Date when the decision record was last updated. Used for concurrency control
   * to prevent overwriting a more recent decision.
   */
+  @Type(() => Date)


Did not find a reason why supertest is failing the DTO validation while Vue/axios is able to submit without any problem.
The recommendation seems to have the @Type(() => Date), hence I would like to keep it.
My best guess was some difference while setting the setGlobalPipes but we use the same method in E2E tests that is also used by the API.

dheepak-aot · 2026-03-27T21:12:47Z

+    };
+    const endpoint = `/aest/form-submission/items/${formSubmissionItemA.id}/decision`;
+    const token = await getAESTToken(AESTGroups.BusinessAdministrators);
+    await removeJWTUserRoles(appModule, [Role.StudentApproveDeclineAppeals]);


dheepak-aot

Good work @andrewsignori-aot 👍

tiago-graf · 2026-03-27T21:52:31Z

+      .expect({
+        message:
+          "The application associated with the form submission is not in completed status.",
+        error: "Unprocessable Entity",


we should introduce a constant for this at some point

Yeah, we are more lenient for E2E tests for these framework constants.
I am not opposed if someone starts it.

tiago-graf · 2026-03-27T21:55:49Z

+      .send(payload)
+      .auth(token, BEARER_AUTH_TYPE)
+      .expect(HttpStatus.UNPROCESSABLE_ENTITY)
+      .expect({


I'm okay with this but i've been receiving the feedback to the use the new standard:

.expect(({ body }) => ...

Is it about using the expect from supertest vs the expected from jest?
If yes, the idea of using the jest one for the body return was to allow easy troubleshooting for complex objects, especially when doing maintenance in existing E2E tests. I do not see it as necessary in this scenario.
@dheepak-aot FYI

tiago-graf

Just a couple of minor comments

Ministry submitItemDecision

f61b414

andrewsignori-aot self-assigned this Mar 27, 2026

andrewsignori-aot added Ministry Ministry Features E2E/Unit tests labels Mar 27, 2026

andrewsignori-aot requested a review from Copilot March 27, 2026 01:22

Copilot started reviewing on behalf of andrewsignori-aot March 27, 2026 01:22 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

Pre-review comments

fbd8894

andrewsignori-aot marked this pull request as ready for review March 27, 2026 03:05

andrewsignori-aot commented Mar 27, 2026

View reviewed changes

dheepak-aot self-requested a review March 27, 2026 20:37

dheepak-aot reviewed Mar 27, 2026

View reviewed changes

dheepak-aot approved these changes Mar 27, 2026

View reviewed changes

tiago-graf reviewed Mar 27, 2026

View reviewed changes

tiago-graf approved these changes Mar 27, 2026

View reviewed changes

andrewsignori-aot added this pull request to the merge queue Mar 27, 2026

Merged via the queue into main with commit 4352c63 Mar 27, 2026
22 checks passed

andrewsignori-aot deleted the feature/#5878-forms-e2e-tests-part-5 branch March 27, 2026 22:05

andrewsignori-aot temporarily deployed to DEV March 27, 2026 22:09 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV March 27, 2026 22:10 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV March 27, 2026 22:13 — with GitHub Actions Inactive

Conversation

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

Uh oh!

Ministry - submitItemDecision

New JWT Token Helpers

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!

sonarqubecloud Bot commented Mar 27, 2026

Quality Gate passed

Uh oh!

github-actions Bot commented Mar 27, 2026

Backend Unit Tests Coverage Report

Uh oh!

github-actions Bot commented Mar 27, 2026

E2E Workflow Workers Coverage Report

Uh oh!

github-actions Bot commented Mar 27, 2026

E2E Queue Consumers Coverage Report

Uh oh!

github-actions Bot commented Mar 27, 2026

E2E SIMS API Coverage Report

Uh oh!

andrewsignori-aot Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

dheepak-aot Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

dheepak-aot left a comment

Choose a reason for hiding this comment

Uh oh!

tiago-graf Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

tiago-graf Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

tiago-graf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

andrewsignori-aot commented Mar 27, 2026 •

edited

Loading