CCM-13303: Create report scheduler #195

simonlabarere · 2026-02-03T09:17:47Z

Description

Component to trigger daily reports for all the senders.

Notes:

CVE-2026-25128 added to .trivyignore will be fixed as part of a different PR
Some elements have been copied from CCM-13278: CCM-12616 + CCM-13278 #186

Testing

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
If I have used the 'skip-trivy-package' label I have done so responsibly and in the knowledge that this is being fixed as part of a separate ticket/PR.

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.

lambdas/report-scheduler/src/apis/scheduled-event-handler.ts

nhsd-angel-pastor · 2026-02-03T13:26:08Z

lambdas/report-scheduler/package.json

+  "dependencies": {
+    "aws-lambda": "^1.0.7",
+    "digital-letters-events": "^0.0.1",
+    "p-limit": "^3.1.0",


I probably missed it, but is it used?

Nope, I'll remove it!

nhsd-angel-pastor · 2026-02-03T13:38:26Z

infrastructure/terraform/components/dl/locals.tf

  apim_keystore_s3_bucket              = "nhs-${var.aws_account_id}-${var.region}-${var.environment}-${var.component}-static-assets"
  unscanned_files_bucket               = local.acct.additional_s3_buckets["digital-letters_unscanned-files"]["id"]
  ssm_mesh_prefix                      = "/${var.component}/${var.environment}/mesh"
+  ssm_senders_prefix                   = "/${var.component}/${var.environment}/senders"


is more clear this way and we could reuse it in module_lambda_ttl_create.tf and module_lambda_core_notifier.tf

gareth-allan · 2026-02-03T15:46:48Z

.trivyignore

 CVE-2024-49761 # https://avd.aquasec.com/nvd/cve-2024-49761 ## latest Jekyll Webpack (0.2.7) installs old version of rexml
 CVE-2024-47220 # https://avd.aquasec.com/nvd/cve-2024-47220 ## latest lint_roller (1.1.0) installs old version of rexml
 CVE-2024-7254 # https://avd.aquasec.com/nvd/cve-2024-7254 ## latest Jekyll Webpack (0.2.7) installs old version of google-protobuf
+CVE-2026-25128


I don't think we want to merge this now the fix is in.

Yes agreed. I should have used the tag to skip the check.

gareth-allan · 2026-02-03T16:55:11Z

tests/playwright/digital-letters-component-tests/report-scheduler.component.spec.ts

+      const senderIds = parsedEvents.map((event) => event.data.senderId);
+      expect(senderIds).toContain('2b8ebb33-8b33-49bd-949e-c12e22d25320');
+      expect(senderIds).toContain('f017669b-6da4-4576-9d59-3d2b7f005ae2');
+      expect(senderIds).toContain('67403568-166e-41d0-900a-1f31fe93a091');


These should probably use the constants from tests-constants.ts, right?

Also, it might be worth a comment to explain why we expect the event to contain these sender IDs (I believe it's because we've put them into the sender config in SSM). It wasn't immediately clear to me what these IDs were.

I'll replace the hardcoded IDs with constants but isn't the name of the test a good clue for what's happening?

Yeah, that's a fair point. It was probably more the fact that I reviewed it late in the day than the code being unclear!

gareth-allan · 2026-02-03T16:57:35Z

lambdas/report-scheduler/package.json

@@ -0,0 +1,29 @@
+{
+  "dependencies": {
+    "aws-lambda": "^1.0.7",


I don't think you're using aws-lambda (or @types/aws-lambda) in this function.

gareth-allan · 2026-02-03T16:58:45Z

lambdas/report-scheduler/package.json

+    "@types/lodash": "^4.17.20",
+    "aws-sdk-client-mock": "^4.1.0",
+    "aws-sdk-client-mock-jest": "^4.1.0",


I'm not sure you're using any of these dependencies either.

Suggested change

"@types/lodash": "^4.17.20",

"aws-sdk-client-mock": "^4.1.0",

"aws-sdk-client-mock-jest": "^4.1.0",

gareth-allan · 2026-02-03T16:59:18Z

lambdas/report-scheduler/package.json

+    "aws-sdk-client-mock": "^4.1.0",
+    "aws-sdk-client-mock-jest": "^4.1.0",
+    "jest": "^29.7.0",
+    "jest-mock-extended": "^3.0.7",


Or jest-mock-extended!

Suggested change

"jest-mock-extended": "^3.0.7",

gareth-allan · 2026-02-03T17:14:42Z

lambdas/report-scheduler/src/__tests__/apis/scheduled-event-handler.test.ts

+    it('should calculate yesterday date range correctly', async () => {
+      const mockDate = new Date('2024-01-15T12:00:00.000Z');
+      jest.setSystemTime(mockDate);
+
+      mockSenderManagement.listSenders.mockResolvedValue([]);
+      mockEventPublisher.sendEvents.mockResolvedValue([]);
+
+      const handler = createHandler({
+        logger: mockLogger,
+        senderManagement: mockSenderManagement,
+        eventPublisher: mockEventPublisher,
+      });
+
+      await handler();
+
+      expect(mockLogger.debug).toHaveBeenCalledWith({
+        description: 'Calculated yesterday date range',
+        yesterdayStart: '2024-01-14T00:00:00.000Z',
+        yesterdayEnd: '2024-01-14T23:59:59.999Z',
+      });
+    });


I think this test would be better verifying the value of the data.reportPeriodStartTime and data.reportPeriodEndTime fields in the return value of handler(), rather than what was logged. Ultimately, it's the return values that are used.

gareth-allan · 2026-02-03T17:29:23Z

lambdas/report-scheduler/src/__tests__/apis/scheduled-event-handler.test.ts

+    it('should handle event publisher errors', async () => {
+      const mockSenders = [{ senderId: 'sender-1' }] as unknown as Sender[];
+      const error = new Error('Failed to publish events');
+
+      mockSenderManagement.listSenders.mockResolvedValue(mockSenders);
+      mockEventPublisher.sendEvents.mockRejectedValue(error);
+
+      const handler = createHandler({
+        logger: mockLogger,
+        senderManagement: mockSenderManagement,
+        eventPublisher: mockEventPublisher,
+      });
+
+      await expect(handler()).rejects.toThrow('Failed to publish events');
+    });


I don't think that sendEvents throws an error. I think it reutrns a list of failed events instead.

gareth-allan · 2026-02-03T17:33:52Z

package-lock.json

This has a lot more changes in it than I'd expect, given the changes you've made to the package.json files. It also appears to undo the fix for the fast-xml-parser vulnerability (from a local run of npm audit at least).

CCM-13303: Create report scheduler

743f20b

simonlabarere requested review from a team as code owners February 3, 2026 09:17

simonlabarere added 5 commits February 3, 2026 09:18

CCM-13303: Undo me

1b95514

CCM-13303: Report scheduler component test

1f25992

CCM-13303: Report scheduler component test

562048d

Merge branch 'main' into feature/CCM-13303_create_report_scheduler

c1d60a6

CCM-13303: Improve component test

13110d2

nhsd-angel-pastor reviewed Feb 3, 2026

View reviewed changes

lambdas/report-scheduler/src/apis/scheduled-event-handler.ts Show resolved Hide resolved

nhsd-angel-pastor reviewed Feb 3, 2026

View reviewed changes

lambdas/report-scheduler/src/apis/scheduled-event-handler.ts Show resolved Hide resolved

nhsd-angel-pastor reviewed Feb 3, 2026

View reviewed changes

nhsd-angel-pastor previously approved these changes Feb 3, 2026

View reviewed changes

gareth-allan self-assigned this Feb 3, 2026

CCM-13303: Address review comments

774f249

simonlabarere dismissed nhsd-angel-pastor’s stale review via 774f249 February 3, 2026 15:54

Merge branch 'main' into feature/CCM-13303_create_report_scheduler

681670f

gareth-allan reviewed Feb 3, 2026

View reviewed changes

simonlabarere added 2 commits February 4, 2026 09:03

Merge branch 'main' into feature/CCM-13303_create_report_scheduler

9a84bf7

CCM-13303: Update Generate Report schema to require a reportDate

12bf48c

	"@types/lodash": "^4.17.20",
	"aws-sdk-client-mock": "^4.1.0",
	"aws-sdk-client-mock-jest": "^4.1.0",

CCM-13303: Create report scheduler #195

Are you sure you want to change the base?

CCM-13303: Create report scheduler #195

Conversation

simonlabarere commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Type of changes

Checklist

Sensitive Information Declaration

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

simonlabarere commented Feb 3, 2026 •

edited

Loading