component test sqs draft

lapenna-bjss · lapenna-bjss · commit 537a3030cc4f · 2026-04-22T15:42:24.000+01:00
diff --git a/infrastructure/terraform/components/dl/README.md b/infrastructure/terraform/components/dl/README.md
@@ -103,6 +103,7 @@ No requirements.
 | <a name="module_sqs_report_generator"></a> [sqs\_report\_generator](#module\_sqs\_report\_generator) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-sqs.zip | n/a |
 | <a name="module_sqs_report_sender"></a> [sqs\_report\_sender](#module\_sqs\_report\_sender) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-sqs.zip | n/a |
 | <a name="module_sqs_scanner"></a> [sqs\_scanner](#module\_sqs\_scanner) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-sqs.zip | n/a |
+| <a name="module_sqs_test_observer"></a> [sqs\_test\_observer](#module\_sqs\_test\_observer) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/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/3.0.6/terraform-sqs.zip | n/a |
 | <a name="module_sqs_ttl_handle_expiry_errors"></a> [sqs\_ttl\_handle\_expiry\_errors](#module\_sqs\_ttl\_handle\_expiry\_errors) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-sqs.zip | n/a |
 | <a name="module_ttl_create"></a> [ttl\_create](#module\_ttl\_create) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-lambda.zip | n/a |
diff --git a/infrastructure/terraform/components/dl/cloudwatch_event_rule_all_events.tf b/infrastructure/terraform/components/dl/cloudwatch_event_rule_all_events.tf
@@ -18,3 +18,10 @@ resource "aws_cloudwatch_event_target" "reporting_firehose" {
   role_arn       = aws_iam_role.eventbridge_firehose.arn
   event_bus_name = aws_cloudwatch_event_bus.main.name
 }
+
+resource "aws_cloudwatch_event_target" "test_observer_sqs" {
+  rule           = aws_cloudwatch_event_rule.all_events.name
+  target_id      = "test-observer-sqs-target"
+  arn            = module.sqs_test_observer.sqs_queue_arn
+  event_bus_name = aws_cloudwatch_event_bus.main.name
+}
diff --git a/infrastructure/terraform/components/dl/module_sqs_test_observer.tf b/infrastructure/terraform/components/dl/module_sqs_test_observer.tf
@@ -0,0 +1,41 @@
+module "sqs_test_observer" {
+  source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-sqs.zip"
+
+  aws_account_id             = var.aws_account_id
+  component                  = local.component
+  environment                = var.environment
+  project                    = var.project
+  region                     = var.region
+  name                       = "test-observer"
+  sqs_kms_key_arn            = module.kms.key_arn
+  visibility_timeout_seconds = var.sqs_visibility_timeout_seconds
+  create_dlq                 = false
+  max_receive_count          = var.sqs_max_receive_count
+  sqs_policy_overload        = data.aws_iam_policy_document.sqs_test_observer.json
+}
+
+data "aws_iam_policy_document" "sqs_test_observer" {
+  statement {
+    sid    = "AllowEventBridgeToSendMessage"
+    effect = "Allow"
+
+    principals {
+      type        = "Service"
+      identifiers = ["events.amazonaws.com"]
+    }
+
+    actions = [
+      "sqs:SendMessage"
+    ]
+
+    resources = [
+      "arn:aws:sqs:${var.region}:${var.aws_account_id}:${local.csi}-test-observer-queue"
+    ]
+
+    condition {
+      test     = "ArnLike"
+      variable = "aws:SourceArn"
+      values   = [aws_cloudwatch_event_rule.all_events.arn]
+    }
+  }
+}
diff --git a/tests/playwright/constants/backend-constants.ts b/tests/playwright/constants/backend-constants.ts
@@ -32,6 +32,7 @@ export const PRINT_SENDER_DLQ_NAME = `${CSI}-print-sender-dlq`;
 export const MOVE_SCANNED_FILES_NAME = `${CSI}-move-scanned-files-queue`;
 export const MOVE_SCANNED_FILES_DLQ_NAME = `${CSI}-move-scanned-files-dlq`;
 export const REPORT_SENDER_DLQ_NAME = `${CSI}-report-sender-dlq`;
+export const TEST_OBSERVER_QUEUE_NAME = `${CSI}-test-observer-queue`;
 
 // Queue Url Prefix
 export const SQS_URL_PREFIX = `https://sqs.${REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/`;
diff --git a/tests/playwright/digital-letters-component-tests/mesh-poll-download.component.spec.ts b/tests/playwright/digital-letters-component-tests/mesh-poll-download.component.spec.ts
@@ -1,18 +1,19 @@
 import { expect, test } from '@playwright/test';
 import {
-  ENV,
   MESH_DOWNLOAD_DLQ_NAME,
   MESH_DOWNLOAD_LAMBDA_LOG_GROUP_NAME,
   MESH_POLL_LAMBDA_NAME,
   NON_PII_S3_BUCKET_NAME,
   PII_S3_BUCKET_NAME,
+  EVENT_BUS_LOG_GROUP_NAME,
 } from 'constants/backend-constants';
 import { getLogsFromCloudwatch } from 'helpers/cloudwatch-helpers';
 import eventPublisher from 'helpers/event-bus-helpers';
 import expectToPassEventually from 'helpers/expectations';
 import { invokeLambda } from 'helpers/lambda-helpers';
 import { downloadFromS3, uploadToS3 } from 'helpers/s3-helpers';
-import { expectMessageContainingString } from 'helpers/sqs-helpers';
+import { expectMessageContainingString, purgeQueue } from 'helpers/sqs-helpers';
+import { expectEventOnTestObserverQueue } from 'helpers/test-observer-helpers';
 import { v4 as uuidv4 } from 'uuid';
 import { SENDER_ID_SKIPS_NOTIFY } from 'constants/tests-constants';
 import { validateMESHInboxMessageReceived } from 'digital-letters-events';
@@ -72,6 +73,10 @@ test.describe('Digital Letters - MESH Poll and Download', () => {
   const sendersMeshMailboxId = 'test-mesh-sender-1';
   const meshMailboxId = 'mock-mailbox';
 
+  test.beforeAll(async () => {
+    await purgeQueue(MESH_DOWNLOAD_DLQ_NAME);
+  });
+
   async function uploadMeshMessage(
     meshMessageId: string,
     messageReference: string,
@@ -93,58 +98,67 @@ test.describe('Digital Letters - MESH Poll and Download', () => {
   async function expectMeshInboxMessageReceivedEvent(
     meshMessageId: string,
   ): Promise<void> {
-    await expectToPassEventually(async () => {
-      const eventLogEntry = await getLogsFromCloudwatch(
-        `/aws/vendedlogs/events/event-bus/nhs-${ENV}-dl`,
-        [
-          '$.message_type = "EVENT_RECEIPT"',
-          '$.details.detail_type = "uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1"',
-          `$.details.event_detail = "*\\"meshMessageId\\":\\"${meshMessageId}\\"*"`,
-          `$.details.event_detail = "*\\"senderId\\":\\"${senderId}\\"*"`,
-        ],
-      );
-
-      expect(eventLogEntry.length).toBeGreaterThanOrEqual(1);
-    }, 120_000);
+    await expectEventOnTestObserverQueue(
+      'uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1',
+      (detail) => {
+        const data = (
+          detail as { data?: { meshMessageId?: string; senderId?: string } }
+        ).data;
+        return (
+          data?.meshMessageId === meshMessageId && data?.senderId === senderId
+        );
+      },
+      60_000,
+    );
   }
 
   async function expectMeshInboxMessageDownloadedEvent(
     messageReference: string,
   ): Promise<void> {
-    await expectToPassEventually(async () => {
-      const eventLogEntry = await getLogsFromCloudwatch(
-        `/aws/vendedlogs/events/event-bus/nhs-${ENV}-dl`,
-        [
-          '$.message_type = "EVENT_RECEIPT"',
-          '$.details.detail_type = "uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1"',
-          `$.details.event_detail = "*\\"messageReference\\":\\"${messageReference}\\"*"`,
-          `$.details.event_detail = "*\\"senderId\\":\\"${senderId}\\"*"`,
-        ],
-      );
-
-      expect(eventLogEntry.length).toBeGreaterThanOrEqual(1);
-    }, 180_000);
+    await expectEventOnTestObserverQueue(
+      'uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1',
+      (detail) => {
+        const data = (
+          detail as {
+            data?: { messageReference?: string; senderId?: string };
+          }
+        ).data;
+        return (
+          data?.messageReference === messageReference &&
+          data?.senderId === senderId
+        );
+      },
+      60_000,
+    );
   }
 
   async function expectMeshInboxMessageInvalidEvent(
     meshMessageId: string,
     messageReference: string,
+    failureCode = 'DL_CLIV_005',
   ): Promise<void> {
-    await expectToPassEventually(async () => {
-      const eventLogEntry = await getLogsFromCloudwatch(
-        `/aws/vendedlogs/events/event-bus/nhs-${ENV}-dl`,
-        [
-          '$.message_type = "EVENT_RECEIPT"',
-          '$.details.detail_type = "uk.nhs.notify.digital.letters.mesh.inbox.message.invalid.v1"',
-          `$.details.event_detail = "*\\"messageReference\\":\\"${messageReference}\\"*"`,
-          `$.details.event_detail = "*\\"senderId\\":\\"${senderId}\\"*"`,
-          `$.details.event_detail = "*\\"meshMessageId\\":\\"${meshMessageId}\\"*"`,
-          `$.details.event_detail = "*\\"failureCode\\":\\"DL_CLIV_005\\"*"`,
-        ],
-      );
-
-      expect(eventLogEntry.length).toBeGreaterThanOrEqual(1);
-    }, 180_000);
+    await expectEventOnTestObserverQueue(
+      'uk.nhs.notify.digital.letters.mesh.inbox.message.invalid.v1',
+      (detail) => {
+        const data = (
+          detail as {
+            data?: {
+              meshMessageId?: string;
+              messageReference?: string;
+              senderId?: string;
+              failureCode?: string;
+            };
+          }
+        ).data;
+        return (
+          data?.meshMessageId === meshMessageId &&
+          data?.messageReference === messageReference &&
+          data?.senderId === senderId &&
+          data?.failureCode === failureCode
+        );
+      },
+      60_000,
+    );
   }
 
   test('should poll message from MESH inbox, publish received event, download message, and publish downloaded event', async () => {
@@ -287,6 +301,8 @@ test.describe('Digital Letters - MESH Poll and Download', () => {
   });
 
   test('should publish MESHInboxMessageInvalid event when local_id is missing', async () => {
+    test.setTimeout(200_000);
+
     const meshMessageId = `${Date.now()}_INVALID_${uuidv4().slice(0, 8)}`;
     const messageContent = JSON.stringify({
       senderId,
@@ -300,20 +316,7 @@ test.describe('Digital Letters - MESH Poll and Download', () => {
 
     await invokeLambda(MESH_POLL_LAMBDA_NAME);
 
-    await expectToPassEventually(async () => {
-      const eventLogEntry = await getLogsFromCloudwatch(
-        `/aws/vendedlogs/events/event-bus/nhs-${ENV}-dl`,
-        [
-          '$.message_type = "EVENT_RECEIPT"',
-          '$.details.detail_type = "uk.nhs.notify.digital.letters.mesh.inbox.message.invalid.v1"',
-          String.raw`$.details.event_detail = "*\"meshMessageId\":\"${meshMessageId}\"*"`,
-          String.raw`$.details.event_detail = "*\"senderId\":\"${senderId}\"*"`,
-          String.raw`$.details.event_detail = "*\"failureCode\":\"DL_CLIV_006\"*"`,
-        ],
-      );
-
-      expect(eventLogEntry.length).toBeGreaterThanOrEqual(1);
-    }, 120_000);
+    await expectMeshInboxMessageInvalidEvent(meshMessageId, '', 'DL_CLIV_006');
 
     await expectToPassEventually(async () => {
       await expect(async () => {
@@ -323,18 +326,6 @@ test.describe('Digital Letters - MESH Poll and Download', () => {
         );
       }).rejects.toThrow('No objects found');
     }, 60_000);
-
-    await expectToPassEventually(async () => {
-      const receivedEvents = await getLogsFromCloudwatch(
-        `/aws/vendedlogs/events/event-bus/nhs-${ENV}-dl`,
-        [
-          '$.message_type = "EVENT_RECEIPT"',
-          '$.details.detail_type = "uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1"',
-          `$.details.event_detail = "*\\"meshMessageId\\":\\"${meshMessageId}\\"*"`,
-        ],
-      );
-      expect(receivedEvents.length).toBe(0);
-    }, 15_000);
   });
 
   test('should skip publishing downloaded event and acknowledge message when document already exists in S3', async () => {
@@ -395,7 +386,7 @@ test.describe('Digital Letters - MESH Poll and Download', () => {
     // Assert that no MESHInboxMessageDownloaded event was published
     await expectToPassEventually(async () => {
       const downloadedEvents = await getLogsFromCloudwatch(
-        `/aws/vendedlogs/events/event-bus/nhs-${ENV}-dl`,
+        EVENT_BUS_LOG_GROUP_NAME,
         [
           '$.message_type = "EVENT_RECEIPT"',
           '$.details.detail_type = "uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1"',
diff --git a/tests/playwright/helpers/test-observer-helpers.ts b/tests/playwright/helpers/test-observer-helpers.ts
@@ -0,0 +1,56 @@
+import {
+  DeleteMessageCommand,
+  ReceiveMessageCommand,
+} from '@aws-sdk/client-sqs';
+import { TEST_OBSERVER_QUEUE_NAME, SQS_URL_PREFIX } from 'constants/backend-constants';
+import { sqsClient } from 'utils';
+
+const queueUrl = `${SQS_URL_PREFIX}${TEST_OBSERVER_QUEUE_NAME}`;
+
+/**
+ * Polls the test observer SQS queue for an event matching the given type and predicate.
+ * Deletes the matched message from the queue and returns the event detail.
+ *
+ * The test observer queue is subscribed to the EventBridge bus and receives all
+ * uk.nhs.notify.digital.letters.* events.
+ */
+export async function expectEventOnTestObserverQueue(
+  eventType: string,
+  matchFn: (detail: Record<string, unknown>) => boolean,
+  timeoutMs = 60_000,
+): Promise<Record<string, unknown>> {
+  const start = Date.now();
+
+  while (Date.now() - start < timeoutMs) {
+    const { Messages = [] } = await sqsClient.send(
+      new ReceiveMessageCommand({
+        QueueUrl: queueUrl,
+        MaxNumberOfMessages: 10,
+        WaitTimeSeconds: 2,
+        VisibilityTimeout: 5,
+      }),
+    );
+
+    for (const msg of Messages) {
+      if (!msg.Body) continue;
+
+      const envelope = JSON.parse(msg.Body) as Record<string, unknown>;
+      const detailType = envelope['detail-type'] as string | undefined;
+      const detail = envelope['detail'] as Record<string, unknown> | undefined;
+
+      if (detailType === eventType && detail && matchFn(detail)) {
+        await sqsClient.send(
+          new DeleteMessageCommand({
+            QueueUrl: queueUrl,
+            ReceiptHandle: msg.ReceiptHandle!,
+          }),
+        );
+        return detail;
+      }
+    }
+  }
+
+  throw new Error(
+    `Event of type "${eventType}" not found on test observer queue within ${timeoutMs}ms`,
+  );
+}
