CCM-12858: WIP fixes

Author: nhsd-angel-pastor

infrastructure/terraform/components/dl/README.md

@@ -50,6 +50,7 @@ No requirements.
 | <a name="module_s3bucket_letters"></a> [s3bucket\_letters](#module\_s3bucket\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-s3bucket.zip | n/a |
 | <a name="module_s3bucket_static_assets"></a> [s3bucket\_static\_assets](#module\_s3bucket\_static\_assets) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-s3bucket.zip | n/a |
 | <a name="module_sqs_core_notifier"></a> [sqs\_core\_notifier](#module\_sqs\_core\_notifier) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-sqs.zip | n/a |
+| <a name="module_sqs_core_notifier_errors"></a> [sqs\_core\_notifier\_errors](#module\_sqs\_core\_notifier\_errors) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-sqs.zip | n/a |
 | <a name="module_sqs_event_publisher_errors"></a> [sqs\_event\_publisher\_errors](#module\_sqs\_event\_publisher\_errors) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-sqs.zip | n/a |
 | <a name="module_sqs_pdm_uploader"></a> [sqs\_pdm\_uploader](#module\_sqs\_pdm\_uploader) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-sqs.zip | n/a |
 | <a name="module_sqs_ttl"></a> [sqs\_ttl](#module\_sqs\_ttl) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-sqs.zip | n/a |

infrastructure/terraform/components/dl/lambda_event_source_mapping_core_notifier_lambda.tf

@@ -0,0 +1,10 @@
+resource "aws_lambda_event_source_mapping" "core_notifier_lambda" {
+  event_source_arn                   = module.sqs_core_notifier.sqs_queue_arn
+  function_name                      = module.core_notifier.function_arn
+  batch_size                         = var.queue_batch_size
+  maximum_batching_window_in_seconds = var.queue_batch_window_seconds
+
+  function_response_types = [
+    "ReportBatchItemFailures"
+  ]
+}

infrastructure/terraform/components/dl/module_lambda_core_notifier.tf

@@ -40,6 +40,7 @@ module "core_notifier" {
     "APIM_ACCESS_TOKEN_SSM_PARAMETER_NAME" = local.apim_access_token_ssm_parameter_name
     "EVENT_PUBLISHER_EVENT_BUS_ARN"        = aws_cloudwatch_event_bus.main.arn
     "EVENT_PUBLISHER_DLQ_URL"              = module.sqs_event_publisher_errors.sqs_queue_url
+    "ENVIRONMENT"                          = var.environment
   }
 }
 
@@ -103,7 +104,7 @@ data "aws_iam_policy_document" "core_notifier_lambda" {
   }
 
   statement {
-    sid    = "SQSPermissionsEventPublisherDLQ"
+    sid    = "SQSPermissionsDLQ"
     effect = "Allow"
 
     actions = [
@@ -112,6 +113,7 @@ data "aws_iam_policy_document" "core_notifier_lambda" {
     ]
 
     resources = [
+      module.sqs_core_notifier_errors.sqs_queue_arn,
       module.sqs_event_publisher_errors.sqs_queue_arn,
     ]
   }

infrastructure/terraform/components/dl/module_sqs_core_notifier.tf

@@ -6,7 +6,7 @@ module "sqs_core_notifier" {
   environment    = var.environment
   project        = var.project
   region         = var.region
-  name           = "core-notifier"
+  name           = "core"
 
   sqs_kms_key_arn = module.kms.key_arn
 

infrastructure/terraform/components/dl/module_sqs_core_notifier_errors.tf

@@ -0,0 +1,14 @@
+module "sqs_core_notifier_errors" {
+  source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-sqs.zip"
+
+  aws_account_id = var.aws_account_id
+  component      = local.component
+  environment    = var.environment
+  project        = var.project
+  region         = var.region
+  name           = "core_notifier-errors"
+
+  sqs_kms_key_arn = module.kms.key_arn
+
+  visibility_timeout_seconds = 60
+}

lambdas/core-notifier-lambda/src/__tests__/app/parse-sqs-message.test.ts

@@ -5,13 +5,6 @@ import { parseSqsRecord } from 'app/parse-sqs-message';
 import { InvalidPdmResourceAvailableEvent } from 'domain/invalid-pdm-resource-available-event';
 import { validPdmEvent } from '__tests__/constants';
 
-// Import the mocked validator after the mock setup
-import { messageDownloadedValidator } from 'digital-letters-events/PDMResourceAvailable.js';
-
-jest.mock('digital-letters-events/PDMResourceAvailable.js', () => ({
-  messageDownloadedValidator: jest.fn(),
-}));
-
 const mockLogger = mock<Logger>();
 
 describe('parseSqsRecord', () => {
@@ -20,9 +13,7 @@ describe('parseSqsRecord', () => {
   const createSqsRecord = (detail: any): SQSRecord => ({
     messageId,
     receiptHandle: 'receipt-handle',
-    body: JSON.stringify({
-      detail,
-    }),
+    body: JSON.stringify(detail),
     attributes: {
       ApproximateReceiveCount: '1',
       SentTimestamp: '1234567890',
@@ -43,50 +34,43 @@ describe('parseSqsRecord', () => {
   describe('when SQS record contains a valid PDMResourceAvailable event', () => {
     it('parses and returns the PDMResourceAvailable event', () => {
       const sqsRecord = createSqsRecord(validPdmEvent);
-      (messageDownloadedValidator as jest.Mock).mockReturnValueOnce(true);
 
       const result = parseSqsRecord(sqsRecord, mockLogger);
 
       expect(result).toEqual(validPdmEvent);
       expect(mockLogger.info).toHaveBeenCalledWith('Parsing SQS Record', {
         messageId,
+        body: sqsRecord.body,
       });
       expect(mockLogger.info).toHaveBeenCalledWith(
         'Parsed valid PDMResourceAvailable Event',
         {
           messageId,
+          messageReference: validPdmEvent.data.messageReference,
+          senderId: validPdmEvent.data.senderId,
+          resourceId: validPdmEvent.data.resourceId,
         },
       );
-      expect(messageDownloadedValidator).toHaveBeenCalledWith(validPdmEvent);
     });
   });
 
   describe('when SQS record contains an invalid PDMResourceAvailable event', () => {
     it('logs error and throws InvalidPdmResourceAvailableEvent', () => {
       const invalidEvent = { ...validPdmEvent, data: {} };
       const sqsRecord = createSqsRecord(invalidEvent);
-      const validationErrors = [
-        {
-          instancePath: '/data',
-          schemaPath: '#/properties/data/required',
-          keyword: 'required',
-          params: { missingProperty: 'senderId' },
-          message: "must have required property 'senderId'",
-        },
-      ];
-      (messageDownloadedValidator as jest.Mock).mockReturnValueOnce(false);
-      messageDownloadedValidator.errors = validationErrors;
 
       expect(() => parseSqsRecord(sqsRecord, mockLogger)).toThrow(
         InvalidPdmResourceAvailableEvent,
       );
 
-      expect(mockLogger.error).toHaveBeenCalledWith({
-        err: validationErrors,
-        description:
-          'The SQS message does not contain a valid PDMResourceAvailable event',
-        messageId,
-      });
+      expect(mockLogger.error).toHaveBeenCalledWith(
+        expect.objectContaining({
+          description:
+            'The SQS message does not contain a valid PDMResourceAvailable event',
+          messageId,
+          err: expect.any(Array),
+        }),
+      );
     });
   });
 
@@ -112,6 +96,7 @@ describe('parseSqsRecord', () => {
       expect(() => parseSqsRecord(sqsRecord, mockLogger)).toThrow(SyntaxError);
       expect(mockLogger.info).toHaveBeenCalledWith('Parsing SQS Record', {
         messageId,
+        body: sqsRecord.body,
       });
     });
   });

lambdas/core-notifier-lambda/src/__tests__/constants.ts

@@ -60,19 +60,20 @@ export const mockResponse: SingleMessageResponse = {
 
 export const validPdmEvent: PDMResourceAvailable = {
   id: 'event-id-123',
-  source: 'urn:nhs:names:services:notify:pdm',
+  source:
+    '/nhs/england/notify/development/dev-12345/data-plane/digitalletters/pdm',
   specversion: '1.0',
   type: 'uk.nhs.notify.digital.letters.pdm.resource.available.v1',
   time: '2025-12-15T10:00:00Z',
   datacontenttype: 'application/json',
   subject: 'message-subject-123',
-  traceparent: '00-trace-parent',
+  traceparent: '00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01',
   recordedtime: '2025-12-15T10:00:00Z',
   severitynumber: 2,
   data: {
     senderId: 'sender-123',
     messageReference: 'msg-ref-123',
-    resourceId: 'ResourceId-123',
+    resourceId: 'f5524783-e5d7-473e-b2a0-29582ff231da',
     nhsNumber: '9991234566',
     odsCode: 'A12345',
   },

lambdas/core-notifier-lambda/src/app/parse-sqs-message.ts

@@ -2,21 +2,22 @@ import { SQSRecord } from 'aws-lambda';
 import { Logger } from 'utils';
 import { PDMResourceAvailable } from 'digital-letters-events';
 import { InvalidPdmResourceAvailableEvent } from 'domain/invalid-pdm-resource-available-event';
-import { messageDownloadedValidator } from 'digital-letters-events/PDMResourceAvailable.js';
+import messagePDMResourceAvailableValidator from 'digital-letters-events/PDMResourceAvailable.js';
 
 export const parseSqsRecord = (
   sqsRecord: SQSRecord,
   logger: Logger,
 ): PDMResourceAvailable => {
   logger.info('Parsing SQS Record', {
     messageId: sqsRecord.messageId,
+    body: sqsRecord.body,
   });
+
   const sqsEventBody = JSON.parse(sqsRecord.body);
-  const sqsEventDetail = sqsEventBody.detail;
-  const isEventValid = messageDownloadedValidator(sqsEventDetail);
-  if (!isEventValid) {
+
+  if (!messagePDMResourceAvailableValidator(sqsEventBody)) {
     logger.error({
-      err: messageDownloadedValidator.errors,
+      err: messagePDMResourceAvailableValidator.errors,
       description:
         'The SQS message does not contain a valid PDMResourceAvailable event',
       messageId: sqsRecord.messageId,
@@ -26,7 +27,10 @@ export const parseSqsRecord = (
 
   logger.info('Parsed valid PDMResourceAvailable Event', {
     messageId: sqsRecord.messageId,
+    messageReference: sqsEventBody.data.messageReference,
+    senderId: sqsEventBody.data.senderId,
+    resourceId: sqsEventBody.data.resourceId,
   });
 
-  return sqsEventDetail as PDMResourceAvailable;
+  return sqsEventBody;
 };

lambdas/core-notifier-lambda/src/infra/event-publisher-facade.ts

@@ -8,6 +8,18 @@ import messageRequestSubmittedValidator from 'digital-letters-events/MessageRequ
 import messageRequestRejectedValidator from 'digital-letters-events/MessageRequestRejected.js';
 import messageRequestSkippedValidator from 'digital-letters-events/MessageRequestSkipped.js';
 
+const submittedEventValidator = messageRequestSubmittedValidator as (
+  d: unknown,
+) => d is MessageRequestSubmitted;
+
+const rejectedEventValidator = messageRequestRejectedValidator as (
+  d: unknown,
+) => d is MessageRequestRejected;
+
+const skippedEventValidator = messageRequestSkippedValidator as (
+  d: unknown,
+) => d is MessageRequestSkipped;
+
 export class EventPublisherFacade {
   constructor(
     private readonly messageRequestSubmittedEventPublisher: EventPublisher,
@@ -24,7 +36,7 @@ export class EventPublisherFacade {
     );
     this.messageRequestSubmittedEventPublisher.sendEvents<MessageRequestSubmitted>(
       [event],
-      messageRequestSubmittedValidator,
+      submittedEventValidator,
     );
   }
 
@@ -36,7 +48,7 @@ export class EventPublisherFacade {
     );
     this.messageRequestRejectedEventPublisher.sendEvents<MessageRequestRejected>(
       [event],
-      messageRequestRejectedValidator,
+      rejectedEventValidator,
     );
   }
 
@@ -48,7 +60,7 @@ export class EventPublisherFacade {
     );
     this.messageRequestSkippedEventPublisher.sendEvents<MessageRequestSkipped>(
       [event],
-      messageRequestSkippedValidator,
+      skippedEventValidator,
     );
   }
 }

tests/playwright/digital-letters-component-tests/core-notify.component.spec.ts

@@ -0,0 +1,108 @@
+import { expect, test } from '@playwright/test';
+import { CSI, ENV } from 'constants/backend-constants';
+import { PDMResourceAvailable } from 'digital-letters-events';
+import messagePDMResourceAvailableValidator from 'digital-letters-events/PDMResourceAvailable.js';
+import { getLogsFromCloudwatch } from 'helpers/cloudwatch-helpers';
+import { getTtl } from 'helpers/dynamodb-helpers';
+import eventPublisher from 'helpers/event-bus-helpers';
+import expectToPassEventually from 'helpers/expectations';
+import { expectMessageContainingString, purgeQueue } from 'helpers/sqs-helpers';
+import {SenderManagement} from 'sender-management';
+import { v4 as uuidv4 } from 'uuid';
+import { ParameterStoreCache } from 'utils';
+
+const senderIdInvokingNotify = 'componentTestSender_RoutingConfig';
+const senderIdThatSkipsNotify = 'componentTestSender_NoRoutingConfig';
+const EVENT_BUS_LOG_GROUP_NAME = `/aws/vendedlogs/events/event-bus/${ENV}`;
+const CORE_NOTIFIER_LAMBDA_LOG_GROUP_NAME = `/aws/lambda/${CSI}-core-notifier`;
+
+test.describe('Digital Letters - Core Notify', () => {
+  const handleCoreNotifierDlqName = `${CSI}-core-notifier-errors-queue`;
+  const parameterStore = new ParameterStoreCache();
+  const senderManagement = SenderManagement({
+    parameterStore,
+  });
+
+  async function deleteSendersIfExist(){
+    senderManagement.deleteSender({senderId: senderIdInvokingNotify});
+    senderManagement.deleteSender({senderId: senderIdThatSkipsNotify});
+  };
+
+  test.beforeAll(async () => {
+    await purgeQueue(handleCoreNotifierDlqName);
+    await deleteSendersIfExist();
+    senderManagement.putSender({
+      senderId: senderIdInvokingNotify,
+      senderName: 'componentTestSender_RoutingConfig',
+      meshMailboxSenderId: 'meshMailboxSender1',
+      meshMailboxReportsId: 'meshMailboxReports1',
+      routingConfigId: 'routing-config-1',
+      fallbackWaitTimeSeconds: 100,
+    });
+
+    senderManagement.putSender({
+      senderId: senderIdThatSkipsNotify,
+      senderName: 'componentTestSender_WithoutRoutingConfig',
+      meshMailboxSenderId: 'meshMailboxSender2',
+      meshMailboxReportsId: 'meshMailboxReports2',
+      fallbackWaitTimeSeconds: 100,
+    });
+  });
+
+  test.afterAll(async () => {
+    await purgeQueue(handleCoreNotifierDlqName);
+    await deleteSendersIfExist();
+  });
+
+
+  test('given PDMResourceAvailable event, when client has routingConfigId then a message is sent to core Notify', async () => {
+    const letterId = uuidv4();
+
+    await eventPublisher.sendEvents<PDMResourceAvailable>(
+      [
+        {
+          id: letterId,
+          specversion: '1.0',
+          source:
+            '/nhs/england/notify/production/primary/data-plane/digitalletters/pdm',
+          subject:
+            'customer/920fca11-596a-4eca-9c47-99f624614658/recipient/769acdd4-6a47-496f-999f-76a6fd2c3959',
+          type: 'uk.nhs.notify.digital.letters.pdm.resource.available.v1',
+          time: '2023-06-20T12:00:00Z',
+          recordedtime: '2023-06-20T12:00:00.250Z',
+          severitynumber: 2,
+          traceparent:
+            '00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01',
+          datacontenttype: 'application/json',
+          dataschema:
+            'https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.json',
+          severitytext: 'INFO',
+          data: {
+            messageReference: 'ref1',
+            senderId: senderIdInvokingNotify,
+            resourceId: 'resource-123',
+            nhsNumber: '9991234566',
+            odsCode: 'A12345',
+          },
+        },
+      ],
+      messagePDMResourceAvailableValidator,
+    );
+
+    // Verify the event happ
+    await expectToPassEventually(async () => {
+      const filteredLogs = await getLogsFromCloudwatch(
+        CORE_NOTIFIER_LAMBDA_LOG_GROUP_NAME,
+        [
+          '$.message.description  = "1 of 1 records processed successfully"',
+        ],
+      );
+
+      expect(filteredLogs.length).toEqual(1);
+    }, 120);
+    // more assertions needed, i.e. the event published
+  });
+  // create following tests
+  // when the sender has no routingConfigId then the Skipped message is published
+  // when fails repeatedly then goes to DLQ
+});