Skip to content

#5849 - Form Submissions, Appeals and Change requests notifications #5895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiago-graf merged 17 commits into from
Mar 18, 2026
Merged

#5849 - Form Submissions, Appeals and Change requests notifications #5895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
3ff7b46
Form Submissions, Appeals, Change requests notifications initial changes
tiago-graf Mar 13, 2026
2d18ee2
Send change request reviewed student notification
tiago-graf Mar 14, 2026
8b0d819
Add change request ministry notification
tiago-graf Mar 14, 2026
9e9c41a
Load form friendly names
tiago-graf Mar 14, 2026
f5e7f4a
Update notification form category
tiago-graf Mar 15, 2026
2d97c8d
Added notifications e2e tests
tiago-graf Mar 15, 2026
0569c1d
Merge branch 'main' into feature/#5849-appeal-notification
tiago-graf Mar 15, 2026
2a705a1
Remove unused code
tiago-graf Mar 15, 2026
e2481eb
Copilot review
tiago-graf Mar 15, 2026
f0d334b
Update 1773355579843-InsertAppealChangeRequestNotificationMessages.ts
tiago-graf Mar 15, 2026
65b0425
PR Comments
tiago-graf Mar 17, 2026
6bec4c7
Updated logic for appeals / change requests
tiago-graf Mar 17, 2026
8d8d336
Rename NotificationMessageType
tiago-graf Mar 17, 2026
32e8498
Enum updated
tiago-graf Mar 17, 2026
27c6e64
Update formName to be a list
tiago-graf Mar 17, 2026
7b72f22
Update student-appeal.aest.controller.approveStudentAppealRequests.e2…
tiago-graf Mar 17, 2026
da3215b
Updated PR comments
tiago-graf Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 75 additions & 2 deletions ...e2e/application-change-request.aest.controller.assessApplicationChangeRequest.e2e-spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
import { HttpStatus, INestApplication } from "@nestjs/common";
import * as request from "supertest";
import { DataSource } from "typeorm";
import { DataSource, IsNull } from "typeorm";
import {
AESTGroups,
BEARER_AUTH_TYPE,
createTestingAppModule,
getAESTToken,
getAESTUser,
} from "../../../../testHelpers";
import { ApplicationEditStatus, ApplicationStatus, User } from "@sims/sims-db";
import {
ApplicationEditStatus,
ApplicationStatus,
NotificationMessageType,
User,
} from "@sims/sims-db";
import { faker } from "@faker-js/faker";
import {
createE2EDataSources,
Expand All @@ -19,6 +24,8 @@ import {
import { ZeebeGrpcClient } from "@camunda8/sdk/dist/zeebe";
import MockDate from "mockdate";
import { INVALID_APPLICATION_EDIT_STATUS } from "@sims/services/constants";
import { GC_NOTIFY_TEMPLATE_IDS } from "@sims/test-utils/constants";
import { getPSTPDTDateTime } from "@sims/utilities";

describe("ApplicationChangeRequestAESTController(e2e)-assessApplicationChangeRequest", () => {
let app: INestApplication;
Expand All @@ -42,6 +49,15 @@ describe("ApplicationChangeRequestAESTController(e2e)-assessApplicationChangeReq

beforeEach(async () => {
MockDate.reset();
// Mark all existing change request review completed notifications as sent to isolate test assertions.
await db.notification.update(
{
notificationMessage: {
id: NotificationMessageType.StudentChangeRequestReviewCompleted,
},
},
{ dateSent: new Date() },
);
});

it("Should approve a change request and copy the offering and appeal when the application change request is waiting for approval.", async () => {
Expand Down Expand Up @@ -218,6 +234,25 @@ describe("ApplicationChangeRequestAESTController(e2e)-assessApplicationChangeReq
creator: ministryUser,
},
]);
// Validate notification.
const createdNotification = await db.notification.findOne({
select: { id: true, messagePayload: true },
where: {
notificationMessage: {
id: NotificationMessageType.StudentChangeRequestReviewCompleted,
},
dateSent: IsNull(),
},
});
expect(createdNotification.messagePayload).toStrictEqual({
template_id: GC_NOTIFY_TEMPLATE_IDS.StudentChangeRequestReviewCompleted,
email_address: changeRequest.student.user.email,
personalisation: {
givenNames: changeRequest.student.user.firstName ?? "",
lastName: changeRequest.student.user.lastName,
date: `${getPSTPDTDateTime(now)} PST/PDT`,
},
});
});

it("Should approve a change request and copy the offering and no appeals when the application change request is waiting for approval, and no appeals are present.", async () => {
Expand Down Expand Up @@ -320,6 +355,25 @@ describe("ApplicationChangeRequestAESTController(e2e)-assessApplicationChangeReq
},
},
});
// Validate notification.
const createdNotification = await db.notification.findOne({
select: { id: true, messagePayload: true },
where: {
notificationMessage: {
id: NotificationMessageType.StudentChangeRequestReviewCompleted,
},
dateSent: IsNull(),
},
});
expect(createdNotification.messagePayload).toStrictEqual({
template_id: GC_NOTIFY_TEMPLATE_IDS.StudentChangeRequestReviewCompleted,
email_address: changeRequest.student.user.email,
personalisation: {
givenNames: changeRequest.student.user.firstName ?? "",
lastName: changeRequest.student.user.lastName,
date: `${getPSTPDTDateTime(now)} PST/PDT`,
},
});
});

it("Should be able to decline a change request and create a student note when the application change request is waiting for approval.", async () => {
Expand Down Expand Up @@ -402,6 +456,25 @@ describe("ApplicationChangeRequestAESTController(e2e)-assessApplicationChangeReq
creator: ministryUser,
},
]);
// Validate notification.
const createdNotification = await db.notification.findOne({
select: { id: true, messagePayload: true },
where: {
notificationMessage: {
id: NotificationMessageType.StudentChangeRequestReviewCompleted,
},
dateSent: IsNull(),
},
});
expect(createdNotification.messagePayload).toStrictEqual({
template_id: GC_NOTIFY_TEMPLATE_IDS.StudentChangeRequestReviewCompleted,
email_address: changeRequest.student.user.email,
personalisation: {
givenNames: changeRequest.student.user.firstName ?? "",
lastName: changeRequest.student.user.lastName,
date: `${getPSTPDTDateTime(now)} PST/PDT`,
},
});
});

it("Should throw a BadRequestException when the application change request approval has an invalid status.", async () => {
Expand Down
54 changes: 54 additions & 0 deletions ...ppeal/_tests_/e2e/student-appeal.aest.controller.approveStudentAppealRequests.e2e-spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { In, IsNull } from "typeorm";
import { HttpStatus, INestApplication } from "@nestjs/common";
import * as request from "supertest";
import {
Expand All @@ -19,12 +20,15 @@ import {
ApplicationStatus,
AssessmentTriggerType,
ModifiedIndependentStatus,
NotificationMessageType,
NoteType,
StudentAppealActionType,
StudentAppealStatus,
} from "@sims/sims-db";
import { StudentAppealApprovalAPIInDTO } from "../../../../route-controllers";
import MockDate from "mockdate";
import { getPSTPDTDateTime } from "@sims/utilities";
import { GC_NOTIFY_TEMPLATE_IDS } from "@sims/test-utils/constants";

describe("StudentAppealAESTController(e2e)-approveStudentAppealRequests", () => {
let app: INestApplication;
Expand All @@ -39,6 +43,18 @@ describe("StudentAppealAESTController(e2e)-approveStudentAppealRequests", () =>

beforeEach(async () => {
MockDate.reset();
// Mark all existing student appeal notifications as sent to isolate test assertions.
await db.notification.update(
{
notificationMessage: {
id: In([
NotificationMessageType.StudentChangeRequestReviewCompleted,
NotificationMessageType.MinistryAppealCompleted,
]),
},
},
{ dateSent: new Date() },
);
});

it("Should approve student appeal requests and add note when the appeal with appeal requests submitted for approval are in pending status.", async () => {
Expand Down Expand Up @@ -121,6 +137,25 @@ describe("StudentAppealAESTController(e2e)-approveStudentAppealRequests", () =>
},
],
});
// Validate notification.
const createdNotification = await db.notification.findOne({
select: { id: true, messagePayload: true },
where: {
notificationMessage: {
id: NotificationMessageType.StudentChangeRequestReviewCompleted,
},
dateSent: IsNull(),
},
});
expect(createdNotification.messagePayload).toStrictEqual({
template_id: GC_NOTIFY_TEMPLATE_IDS.StudentChangeRequestReviewCompleted,
email_address: application.student.user.email,
personalisation: {
givenNames: application.student.user.firstName ?? "",
lastName: application.student.user.lastName,
date: `${getPSTPDTDateTime(now)} PST/PDT`,
},
});
});

it("Should throw an unprocessable entity error when the application associated with the appeal is not in completed status.", async () => {
Expand Down Expand Up @@ -291,6 +326,25 @@ describe("StudentAppealAESTController(e2e)-approveStudentAppealRequests", () =>
},
],
});
// Validate notification.
const createdNotification = await db.notification.findOne({
select: { id: true, messagePayload: true },
where: {
notificationMessage: {
id: NotificationMessageType.MinistryAppealCompleted,
},
dateSent: IsNull(),
},
});
expect(createdNotification.messagePayload).toStrictEqual({
template_id: GC_NOTIFY_TEMPLATE_IDS.MinistryAppealCompleted,
email_address: student.user.email,
personalisation: {
givenNames: student.user.firstName ?? "",
lastName: student.user.lastName,
date: `${getPSTPDTDateTime(now)} PST/PDT`,
},
});
});
}
});
Expand Down
Loading
Loading