[HOTE-1024] feat: Generate Reminder: 7 days by cptiv2020 · Pull Request #346 · NHSDigital/hometest-service

cptiv2020 · 2026-04-13T13:36:09Z

Description

https://nhsd-jira.digital.nhs.uk/browse/HOTE-1024

Context

Type of changes

Refactoring (non-breaking change)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would change existing functionality)
Bug fix (non-breaking change which fixes an issue)

Checklist

I am familiar with the contributing guidelines
I have followed the code style of the project
I have added tests to cover my changes
I have updated the documentation accordingly
This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

…ify service

github-actions · 2026-04-13T13:39:13Z

Lambdas Coverage Report

Lines	Statements	Branches	Functions
	98.56% (1644/1668)	93.24% (428/459)	97.1% (268/276)

github-actions · 2026-04-13T13:39:22Z

UI Coverage Report

Lines	Statements	Branches	Functions
	96.16% (5669/5895)	88.22% (682/773)	88.06% (214/243)

Copilot

Pull request overview

Adds a new reminder-dispatch flow (7-day reminders) and refactors notification sending into dedicated “notify service” + “message builder” components to support both order-status notifications and reminders.

Changes:

Introduces reminder-dispatch-lambda with env-driven reminder scheduling/config parsing and per-reminder dispatch via SQS-backed notify services.
Refactors order status notification logic into lib/notify/services/* and lib/notify/message-builders/*, and updates existing lambdas to use dispatch(...).
Extends notify event codes to include dispatched reminder variants and updates related types/tests.

Reviewed changes

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

Show a summary per file

File	Description
lambdas/src/reminder-dispatch-lambda/init.ts	Wires DB/SQS/notify dependencies for the new reminder dispatch lambda.
lambdas/src/reminder-dispatch-lambda/index.ts	EventBridge handler that loads pending reminders and dispatches notifications based on config.
lambdas/src/reminder-dispatch-lambda/index.test.ts	Unit tests validating dispatch, skip logic, and error propagation for reminder dispatch.
lambdas/src/reminder-dispatch-lambda/config.ts	Parses/validates reminder scheduling configuration from environment variables.
lambdas/src/order-status-lambda/init.ts	Switches to the new `OrderStatusNotifyService` dependency shape.
lambdas/src/order-status-lambda/init.test.ts	Updates init wiring tests for the new notify service dependencies.
lambdas/src/order-status-lambda/index.ts	Updates notification call site to `orderStatusNotifyService.dispatch(...)`.
lambdas/src/order-status-lambda/index.test.ts	Updates handler tests to mock/expect `dispatch(...)` rather than the old method.
lambdas/src/order-result-lambda/init.ts	Switches to the new `OrderStatusNotifyService` dependency shape.
lambdas/src/order-result-lambda/init.test.ts	Updates init wiring tests for the new notify service dependencies.
lambdas/src/order-result-lambda/index.ts	Updates notification call site to `orderStatusNotifyService.dispatch(...)`.
lambdas/src/order-result-lambda/index.test.ts	Updates handler tests to mock/expect `dispatch(...)`.
lambdas/src/lib/types/notify-message.ts	Adds reminder event codes and changes `eventCode` typing.
lambdas/src/lib/notify/services/base-notify-service.ts	New shared base for SQS dispatch + notification audit insertion and logging.
lambdas/src/lib/notify/services/order-status-notify-service.ts	New service that chooses message builders based on order status and dispatches notifications.
lambdas/src/lib/notify/services/order-status-notify-service.test.ts	Updates tests to match builder-based service behavior.
lambdas/src/lib/notify/services/reminder-notify-service.ts	New service that builds and dispatches reminder notifications for dispatched orders.
lambdas/src/lib/notify/services/reminder-notify-service.test.ts	Unit tests for reminder notification dispatch behavior and error cases.
lambdas/src/lib/notify/message-builders/base-notify-message-builder.ts	Shared builder utilities (recipient lookup, reference number, URL building, date formatting).
lambdas/src/lib/notify/message-builders/order-dispatched-message-builder.ts	Builder for dispatched-order notification payload.
lambdas/src/lib/notify/message-builders/order-dispatched-message-builder.test.ts	Unit tests for dispatched-order notification builder.
lambdas/src/lib/notify/message-builders/order-received-message-builder.ts	Builder for received-order notification payload.
lambdas/src/lib/notify/message-builders/order-received-message-builder.test.ts	Unit tests for received-order notification builder.
lambdas/src/lib/notify/message-builders/order-result-available-message-builder.ts	Builder for result-available notification payload.
lambdas/src/lib/notify/message-builders/order-result-available-message-builder.test.ts	Unit tests for result-available notification builder.
lambdas/src/lib/notify/message-builders/dispatched-reminder-message-builder.ts	Builder for dispatched reminders (uses reminderId as message reference).
lambdas/src/lib/notify/message-builders/dispatched-reminder-message-builder.test.ts	Unit tests for dispatched reminder message builder.
lambdas/src/lib/db/order-status-reminder-db-client.ts	Introduces DB client abstraction for pending reminders (currently stubbed).
lambdas/src/lib/db/notification-audit-db-client.ts	Updates audit entry typing for `eventCode`.
lambdas/src/lib/notify/notify-service.ts	Removes legacy notify service implementation in favor of new services.
lambdas/src/lib/notify/notify-message-builder.ts	Removes legacy monolithic notify message builder in favor of per-message builders.
lambdas/src/lib/notify/notify-message-builder.test.ts	Removes tests for the legacy notify message builder.

lambdas/src/lib/db/order-status-reminder-db-client.ts

lambdas/src/lib/types/notify-message.ts

lambdas/src/lib/db/notification-audit-db-client.ts

lambdas/src/reminder-dispatch-lambda/dispatch-config.ts

lambdas/src/reminder-dispatch-lambda/index.ts

lambdas/src/lib/notify/services/reminder-notify-service.ts

# Conflicts: # lambdas/src/lib/notify/notify-message-builder.test.ts # lambdas/src/lib/notify/notify-message-builder.ts # lambdas/src/lib/notify/notify-service.ts # lambdas/src/lib/notify/services/order-status-notify-service.test.ts # lambdas/src/order-result-lambda/init.ts # lambdas/src/order-status-lambda/init.test.ts # lambdas/src/order-status-lambda/init.ts

Copilot

Pull request overview

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

lambdas/src/lib/db/order-status-reminder-db-client.ts

lambdas/src/lib/notify/services/reminder-notify-service.ts

lambdas/src/reminder-dispatch-lambda/init.ts

lambdas/src/reminder-dispatch-lambda/dispatch-config.ts

…inder scheduling and dispatching

Copilot

Pull request overview

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

lambdas/src/lib/notify/services/order-status-notify-service.ts

lambdas/src/lib/db/order-status-reminder-db-client.ts

local-environment/infra/main.tf

lambdas/src/reminder-dispatch-lambda/init.ts

sonarqubecloud · 2026-04-14T14:27:34Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

lewisbirks

What are your thoughts on splitting the refactor out into its own PR to reduce noise and get that change in quicker?

lewisbirks · 2026-04-14T15:14:27Z

lambdas/src/lib/db/notification-audit-db-client.ts

 export interface NotificationAuditEntryParams {
  messageReference: string;
-  eventCode: NotifyEventCode;
+  eventCode: string;


any particular reason for this?

It can be changed to "NotifyEventCode | string" but not big difference, the string is because we can have something from config that is not defined in this NotifyEventCode

lewisbirks · 2026-04-14T15:50:52Z

lambdas/src/reminder-dispatch-lambda/index.ts

+  );
+
+  if (nextSchedule) {
+    await orderStatusReminderDbClient.scheduleReminder(


I worry about this being a lot of individual requests if there are lots of reminders being processed. What are your thoughts on extracting it out to one batch at the end?

lewisbirks · 2026-04-14T15:53:20Z

lambdas/src/reminder-dispatch-lambda/index.ts

+  const nextSchedule = schedules.find(
+    (s) =>
+      s.triggerStatus === reminder.triggerStatus &&
+      s.reminderNumber === reminder.reminderNumber + 1,
+  );
+
+  if (nextSchedule) {
+    await orderStatusReminderDbClient.scheduleReminder(
+      reminder.orderUid,
+      reminder.triggerStatus,
+      nextSchedule.reminderNumber,
+      reminder.triggeredAt,
+    );
+    commons.logInfo(name, "Next reminder scheduled", {
+      ...logContext,
+      reminderNumber: nextSchedule.reminderNumber,
+    });
+  }


This essentially covers https://nhsd-jira.digital.nhs.uk/browse/HOTE-1135 right?

ahh yes, I must have lost track of what I was supposed to do and I accidentally did it

lewisbirks · 2026-04-14T15:55:14Z

lambdas/src/reminder-dispatch-lambda/index.ts

+    const outcomes: ReminderOutcome[] = [];
+    for (const reminder of reminders) {
+      outcomes.push(
+        await processReminder(reminder, {


would we want to await here or await outside of the array? using something like Promise.allSettled

introduced new lambda for scheduler event adn refactored code for not…

1b25529

…ify service

Copilot AI review requested due to automatic review settings April 13, 2026 13:36

Copilot started reviewing on behalf of cptiv2020 April 13, 2026 13:36 View session

Copilot AI reviewed Apr 13, 2026

View reviewed changes

refactoring message builders

9243b14

github-code-quality bot found potential problems Apr 14, 2026

View reviewed changes

lambdas/src/lib/notify/services/reminder-notify-service.ts Fixed Show fixed Hide fixed

Copilot AI review requested due to automatic review settings April 14, 2026 10:25

Copilot started reviewing on behalf of cptiv2020 April 14, 2026 10:25 View session

Copilot AI reviewed Apr 14, 2026

View reviewed changes

cptiv2020 added 2 commits April 14, 2026 13:49

feat: implement OrderStatusReminderDbClient and related tests for rem…

b39cb5d

…inder scheduling and dispatching

add reminder dispatch lambda and schedule configuration

6926666

Copilot AI review requested due to automatic review settings April 14, 2026 12:23

Copilot started reviewing on behalf of cptiv2020 April 14, 2026 12:23 View session

Copilot AI reviewed Apr 14, 2026

View reviewed changes

cptiv2020 marked this pull request as ready for review April 14, 2026 13:35

refactor reminder dispatch logic and fix after review

22f4ba9

lewisbirks reviewed Apr 14, 2026

View reviewed changes

Conversation

cptiv2020 commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Context

Type of changes

Checklist

Sensitive Information Declaration

Uh oh!

github-actions bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Lambdas Coverage Report

Uh oh!

github-actions bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

UI Coverage Report

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Uh oh!

Uh oh!

sonarqubecloud bot commented Apr 14, 2026

Quality Gate passed

Uh oh!

lewisbirks left a comment

Choose a reason for hiding this comment

Uh oh!

lewisbirks Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

cptiv2020 Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

lewisbirks Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

lewisbirks Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

cptiv2020 Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

lewisbirks Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cptiv2020 commented Apr 13, 2026 •

edited

Loading

github-actions bot commented Apr 13, 2026 •

edited

Loading

github-actions bot commented Apr 13, 2026 •

edited

Loading