CCM-13146 update tests to query cloudwatch

Author: Ian-Hodges

tests/playwright/digital-letters-component-tests/handle-ttl.component.spec.ts

@@ -1,4 +1,6 @@
 import { expect, test } from '@playwright/test';
+import { ENV } from 'constants/backend-constants';
+import { getLogsFromCloudwatch } from 'helpers/cloudwatch-helpers';
 import { deleteTtl, putTtl } from 'helpers/dynamodb-helpers';
 import expectToPassEventually from 'helpers/expectations';
 import { v4 as uuidv4 } from 'uuid';
@@ -57,7 +59,52 @@ test.describe('Digital Letters - Handle TTL', () => {
     expect(deleteResponseCode).toBe(200);
 
     await expectToPassEventually(async () => {
-      // Check lambda log for withdrawn messageReference.
+      const eventLogEntry = await getLogsFromCloudwatch(
+        `/aws/lambda/nhs-${ENV}-dl-ttl-handle-expiry`,
+        `{ ($.messageUri = "${messageUri}") and ($.description = "ItemDequeued event not sent as item withdrawn") }`
+      );
+
+      expect(eventLogEntry.length).toEqual(1);
+    });
+  });
+
+  test('should handle expired item', async () => {
+    const letterId = uuidv4();
+    const messageUri = `https://example.com/ttl/resource/${letterId}`;
+
+    const event = {
+      ...baseEvent,
+      id: letterId,
+      data: {
+        ...baseEvent.data,
+        messageUri,
+        'digital-letter-id': letterId,
+      },
+    };
+
+    const ttlItem = {
+      PK: messageUri,
+      SK: 'TTL',
+      dateOfExpiry: '2023-12-31#0',
+      event,
+      ttl: Date.now() / 1000 + 3600,
+    };
+
+    const putResponseCode = await putTtl(ttlItem);
+    expect(putResponseCode).toBe(200);
+
+    const deleteResponseCode = await deleteTtl(messageUri);
+    expect(deleteResponseCode).toBe(200);
+
+    await expectToPassEventually(async () => {
+      await expectToPassEventually(async () => {
+        const eventLogEntry = await getLogsFromCloudwatch(
+          `/aws/vendedlogs/events/event-bus/nhs-${ENV}-dl`,
+          `{ ($.id = "${letterId}") }`
+        );
+
+        expect(eventLogEntry.length).toEqual(1);
+      });
     });
   });
 });

tests/playwright/helpers/cloudwatch-helpers.ts

@@ -0,0 +1,36 @@
+import {
+  CloudWatchLogsClient,
+  FilterLogEventsCommand,
+} from '@aws-sdk/client-cloudwatch-logs';
+import { region } from 'utils';
+import { test } from '@playwright/test';
+
+const client = new CloudWatchLogsClient({ region: region() });
+
+let testStartTime = new Date();
+
+test.beforeEach(() => {
+  testStartTime = new Date();
+});
+
+/**
+ * @param logGroupName e.g. `/aws/lambda/nhs-main-dl-apim-key-generation`
+ * @param pattern e.g. `{ $.id = ${JSON.stringify(letterId)} }`
+ */
+export async function getLogsFromCloudwatch(
+  logGroupName: string,
+  pattern: string
+): Promise<unknown[]> {
+  const filterEvents = new FilterLogEventsCommand({
+    logGroupName,
+    startTime: testStartTime.getTime() - 60 * 1000,
+    filterPattern: pattern,
+    limit: 50,
+  });
+
+  const { events = [] } = await client.send(filterEvents);
+
+  return events.flatMap(({ message }) =>
+    message ? [JSON.parse(message)] : []
+  );
+}

utils/utils/src/index.ts

@@ -1,5 +1,6 @@
 export * from './dynamodb';
 export * from './lambda-utils';
+export * from './locations';
 export * from './logger';
 export * from './sqs-utils';
 export * from './ssm-utils';