CCM-12740: update events and how they are propagated

Ian-Hodges · Ian-Hodges · commit 5cda343b7c64 · 2025-11-14T09:20:24.000Z
diff --git a/lambdas/ttl-create-lambda/src/__tests__/apis/sqs-trigger-lambda.test.ts b/lambdas/ttl-create-lambda/src/__tests__/apis/sqs-trigger-lambda.test.ts
@@ -27,7 +27,7 @@ describe('createHandler', () => {
     dataschemaversion: '1.0',
     severitytext: 'INFO',
     data: {
-      uri: 'https://example.com/ttl/resource',
+      messageUri: 'https://example.com/ttl/resource',
       'digital-letter-id': '123e4567-e89b-12d3-a456-426614174000',
       messageReference: 'ref1',
       senderId: 'sender1',
diff --git a/lambdas/ttl-create-lambda/src/__tests__/app/create-ttl.test.ts b/lambdas/ttl-create-lambda/src/__tests__/app/create-ttl.test.ts
@@ -28,7 +28,7 @@ describe('CreateTtl', () => {
       'digital-letter-id': '123e4567-e89b-12d3-a456-426614174000',
       messageReference: 'ref1',
       senderId: 'sender1',
-      uri: 'https://example.com/ttl/resource',
+      messageUri: 'https://example.com/ttl/resource',
     },
   };
 
diff --git a/lambdas/ttl-create-lambda/src/__tests__/infra/ttl-repository.test.ts b/lambdas/ttl-create-lambda/src/__tests__/infra/ttl-repository.test.ts
@@ -37,7 +37,7 @@ describe('TtlRepository', () => {
       'digital-letter-id': '123e4567-e89b-12d3-a456-426614174000',
       messageReference: 'ref1',
       senderId: 'sender1',
-      uri: 'https://example.com/ttl/resource',
+      messageUri: 'https://example.com/ttl/resource',
     },
   };
 
@@ -79,12 +79,11 @@ describe('TtlRepository', () => {
     expect(putCommand.input).toStrictEqual({
       TableName: tableName,
       Item: {
-        PK: item.data.uri,
+        PK: item.data.messageUri,
         SK: 'TTL',
         dateOfExpiry: expectedDateOfExpiry,
-        messageReference: 'ref1',
+        event: item,
         ttl: expectedTtlSeconds,
-        senderId: 'sender1',
       },
     });
   });
diff --git a/lambdas/ttl-create-lambda/src/infra/ttl-repository.ts b/lambdas/ttl-create-lambda/src/infra/ttl-repository.ts
@@ -23,7 +23,7 @@ export class TtlRepository {
 
     this.logger.info({
       description: 'Inserting item into TTL table',
-      PK: item.data.uri,
+      PK: item.data.messageUri,
       ttlTime,
     });
 
@@ -38,10 +38,7 @@ export class TtlRepository {
     }
   }
 
-  private async putTtlRecord(
-    { data: { messageReference, senderId, uri } }: TtlItemEvent,
-    ttlTime: number,
-  ) {
+  private async putTtlRecord(ttlItemEvent: TtlItemEvent, ttlTime: number) {
     // GSI PK utilising write sharding YYYY-MM-DD#<RANDOM_INT_BETWEEN_0_AND_[shardCount]>
     const ttlGsiPk = `${
       new Date(ttlTime * 1000).toISOString().split('T')[0]
@@ -51,12 +48,11 @@ export class TtlRepository {
       new PutCommand({
         TableName: this.tableName,
         Item: {
-          PK: uri,
+          PK: ttlItemEvent.data.messageUri,
           SK: 'TTL',
           ttl: ttlTime,
           dateOfExpiry: ttlGsiPk,
-          messageReference,
-          senderId,
+          event: ttlItemEvent,
         },
       }),
     );
diff --git a/lambdas/ttl-handle-expiry-lambda/src/__tests__/apis/dynamodb-stream-handler.test.ts b/lambdas/ttl-handle-expiry-lambda/src/__tests__/apis/dynamodb-stream-handler.test.ts
@@ -20,16 +20,53 @@ const mockEvent: DynamoDBStreamEvent = {
       dynamodb: {
         ApproximateCreationDateTime: 1_234_567_890,
         Keys: {
-          PK: { S: 'MESSAGE#test-id-1' },
+          PK: { S: 'https://example.com/ttl/resource' },
           SK: { S: 'METADATA' },
         },
         OldImage: {
-          PK: { S: 'MESSAGE#test-id-1' },
+          PK: { S: 'https://example.com/ttl/resource' },
           SK: { S: 'METADATA' },
           dateOfExpiry: { S: 'dateOfExpiry' },
-          messageReference: { S: 'ref1' },
+          event: {
+            M: {
+              profileversion: { S: '1.0.0' },
+              profilepublished: { S: '2025-10' },
+              id: { S: '550e8400-e29b-41d4-a716-446655440001' },
+              specversion: { S: '1.0' },
+              source: {
+                S: '/nhs/england/notify/production/primary/data-plane/digital-letters',
+              },
+              subject: {
+                S: 'customer/920fca11-596a-4eca-9c47-99f624614658/recipient/769acdd4-6a47-496f-999f-76a6fd2c3959',
+              },
+              type: {
+                S: 'uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1',
+              },
+              time: { S: '2023-06-20T12:00:00Z' },
+              recordedtime: { S: '2023-06-20T12:00:00.250Z' },
+              severitynumber: { N: '2' },
+              traceparent: {
+                S: '00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01',
+              },
+              datacontenttype: { S: 'application/json' },
+              dataschema: {
+                S: 'https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10/digital-letter-base-data.schema.json',
+              },
+              dataschemaversion: { S: '1.0' },
+              severitytext: { S: 'INFO' },
+              data: {
+                M: {
+                  messageUri: { S: 'https://example.com/ttl/resource' },
+                  'digital-letter-id': {
+                    S: '123e4567-e89b-12d3-a456-426614174000',
+                  },
+                  messageReference: { S: 'ref1' },
+                  senderId: { S: 'sender1' },
+                },
+              },
+            },
+          },
           ttl: { N: futureTimestamp.toString() },
-          senderId: { S: 'sender1' },
         },
         SequenceNumber: '123456789',
         SizeBytes: 100,
@@ -79,7 +116,7 @@ describe('createHandler', () => {
         source:
           '/nhs/england/notify/production/primary/data-plane/digital-letters',
         subject:
-          'customer/00000000-0000-0000-0000-000000000000/recipient/00000000-0000-0000-0000-000000000000',
+          'customer/920fca11-596a-4eca-9c47-99f624614658/recipient/769acdd4-6a47-496f-999f-76a6fd2c3959',
         type: 'uk.nhs.notify.digital.letters.queue.item.dequeued.v1',
         datacontenttype: 'application/json',
         dataschema:
@@ -89,7 +126,7 @@ describe('createHandler', () => {
             /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i,
           ),
           messageReference: 'ref1',
-          messageUri: 'MESSAGE#test-id-1',
+          messageUri: 'https://example.com/ttl/resource',
           senderId: 'sender1',
         }),
       }),
@@ -139,7 +176,7 @@ describe('createHandler', () => {
           dynamodb: {
             ApproximateCreationDateTime: 1_234_567_890,
             Keys: {
-              PK: { S: 'MESSAGE#test-id-1' },
+              PK: { S: 'https://example.com/ttl/resource' },
             },
             SequenceNumber: '123456789',
             SizeBytes: 100,
@@ -159,29 +196,19 @@ describe('createHandler', () => {
     expect(result).toEqual({});
   });
 
-  it('should handle processing errors by sending to DLQ', async () => {
+  it('should handle ttl dynamodb record parsing errors by sending to DLQ', async () => {
     const mockInvalidEvent: DynamoDBStreamEvent = {
       Records: [
         {
-          eventID: 'test-event-1',
-          eventName: 'REMOVE',
-          eventVersion: '1.1',
-          eventSource: 'aws:dynamodb',
-          awsRegion: 'us-east-1',
+          ...mockEvent.Records[0],
           dynamodb: {
-            ApproximateCreationDateTime: 1_234_567_890,
-            Keys: {
-              id: { S: 'test-id-1' },
-            },
+            ...mockEvent.Records[0].dynamodb,
             OldImage: {
               invalidField: { S: 'invalid-data' },
             },
-            SequenceNumber: '123456789',
-            SizeBytes: 100,
-            StreamViewType: 'OLD_IMAGE',
           },
         },
-      ] as DynamoDBRecord[],
+      ],
     };
 
     const result = await handler(mockInvalidEvent);
@@ -198,6 +225,40 @@ describe('createHandler', () => {
     expect(result).toEqual({});
   });
 
+  it('should handle ttl item event parsing errors by sending to DLQ', async () => {
+    const mockInvalidEvent: DynamoDBStreamEvent = {
+      Records: [
+        {
+          ...mockEvent.Records[0],
+          dynamodb: {
+            ...mockEvent.Records[0].dynamodb,
+            OldImage: {
+              ...mockEvent.Records[0].dynamodb?.OldImage,
+              event: {
+                M: {
+                  invalidField: { S: 'invalid-data' },
+                },
+              },
+            },
+          },
+        },
+      ],
+    };
+
+    const result = await handler(mockInvalidEvent);
+
+    expect(logger.warn).toHaveBeenCalledWith(
+      expect.objectContaining({
+        err: expect.any(Object),
+        description: 'Error parsing ttl item event',
+      }),
+    );
+
+    expect(dlq.send).toHaveBeenCalledWith([mockInvalidEvent.Records[0]]);
+    expect(eventPublisher.sendEvents).not.toHaveBeenCalled();
+    expect(result).toEqual({});
+  });
+
   it('should handle empty records array', async () => {
     const mockNoRecordsEvent: DynamoDBStreamEvent = {
       Records: [],
@@ -296,7 +357,7 @@ describe('createHandler', () => {
     expect(logger.info).toHaveBeenCalledWith({
       description: 'ItemDequeued event not sent as item withdrawn',
       messageReference: 'ref1',
-      messageUri: 'MESSAGE#test-id-1',
+      messageUri: 'https://example.com/ttl/resource',
       senderId: 'sender1',
     });
 
@@ -329,7 +390,7 @@ describe('createHandler', () => {
         type: 'uk.nhs.notify.digital.letters.queue.item.dequeued.v1',
         data: expect.objectContaining({
           messageReference: 'ref1',
-          messageUri: 'MESSAGE#test-id-1',
+          messageUri: 'https://example.com/ttl/resource',
           senderId: 'sender1',
         }),
       }),
diff --git a/lambdas/ttl-handle-expiry-lambda/src/apis/dynamodb-stream-handler.ts b/lambdas/ttl-handle-expiry-lambda/src/apis/dynamodb-stream-handler.ts
@@ -4,7 +4,12 @@ import type {
   DynamoDBStreamEvent,
 } from 'aws-lambda';
 import { unmarshall } from '@aws-sdk/util-dynamodb';
-import { $TtlDynamodbRecord, EventPublisher, Logger } from 'utils';
+import {
+  $TtlDynamodbRecord,
+  $TtlItemEvent,
+  EventPublisher,
+  Logger,
+} from 'utils';
 import { randomUUID } from 'node:crypto';
 import { Dlq } from 'app/dlq';
 
@@ -57,39 +62,38 @@ export const createHandler = ({
         return;
       }
 
+      const {
+        data: itemEvent,
+        error: eventParseError,
+        success: eventParseSuccess,
+      } = $TtlItemEvent.safeParse(item.event);
+
+      if (!eventParseSuccess) {
+        logger.warn({
+          err: eventParseError,
+          description: 'Error parsing ttl item event',
+        });
+
+        failures.push(record);
+
+        return;
+      }
+
       if (item.withdrawn) {
         logger.info({
           description: 'ItemDequeued event not sent as item withdrawn',
-          messageReference: item.messageReference,
+          messageReference: itemEvent.data.messageReference,
           messageUri: item.PK,
-          senderId: item.senderId,
+          senderId: itemEvent.data.senderId,
         });
       } else {
         await eventPublisher.sendEvents([
           {
-            profileversion: '1.0.0',
-            profilepublished: '2025-10',
-            specversion: '1.0',
+            ...itemEvent,
             id: randomUUID(),
             time: new Date().toISOString(),
             recordedtime: new Date().toISOString(),
-            severitynumber: 5,
-            traceparent:
-              '00-00000000000000000000000000000000-0000000000000000-01',
-            source:
-              '/nhs/england/notify/production/primary/data-plane/digital-letters',
-            subject:
-              'customer/00000000-0000-0000-0000-000000000000/recipient/00000000-0000-0000-0000-000000000000',
             type: 'uk.nhs.notify.digital.letters.queue.item.dequeued.v1',
-            datacontenttype: 'application/json',
-            dataschema:
-              'https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10/digital-letter-base-data.schema.json',
-            data: {
-              'digital-letter-id': randomUUID(),
-              messageReference: item.messageReference,
-              messageUri: item.PK,
-              senderId: item.senderId,
-            },
           },
         ]);
       }
diff --git a/lambdas/ttl-poll-lambda/src/__tests__/infra/ttl-expiry-service.test.ts b/lambdas/ttl-poll-lambda/src/__tests__/infra/ttl-expiry-service.test.ts
@@ -27,24 +27,21 @@ const queryOutput = {
       SK: 'REQUEST_ITEM_PLAN#hello1',
       dateOfExpiry: mockDate,
       ttl: mockTtl,
-      messageReference: 'ref1',
-      senderId: 'sender1',
+      event: {},
     },
     {
       PK: 'REQUEST_ITEM#hello2',
       SK: 'REQUEST_ITEM_PLAN#hello2',
       dateOfExpiry: mockDate,
       ttl: mockTtl,
-      messageReference: 'ref2',
-      senderId: 'sender2',
+      event: {},
     },
     {
       PK: 'REQUEST_ITEM#hello3',
       SK: 'REQUEST_ITEM_PLAN#hello3',
       dateOfExpiry: mockDate,
       ttl: mockTtl,
-      messageReference: 'ref3',
-      senderId: 'sender3',
+      event: {},
     },
   ],
   $metadata: {},
@@ -336,8 +333,7 @@ describe('TtlExpiryService', () => {
               SK: 'REQUEST_ITEM_PLAN#hello1',
               dateOfExpiry: mockDate,
               ttl: futureDateTime,
-              messageReference: 'ref1',
-              senderId: 'sender1',
+              event: {},
             },
           ],
           $metadata: {},
@@ -356,8 +352,7 @@ describe('TtlExpiryService', () => {
         SK: 'REQUEST_ITEM_PLAN#hello1',
         dateOfExpiry: mockDate,
         ttl: futureDateTime,
-        messageReference: 'ref1',
-        senderId: 'sender1',
+        event: {},
       },
       ttlBeforeSeconds: mockTtlBeforeSeconds,
       err: 'TTL of record is after target expiry time',
diff --git a/utils/utils/src/__tests__/types/ttl-item-event.test.ts b/utils/utils/src/__tests__/types/ttl-item-event.test.ts
@@ -26,7 +26,7 @@ describe('$TtlItemEvent', () => {
       'digital-letter-id': '123e4567-e89b-12d3-a456-426614174000',
       messageReference: 'ref1',
       senderId: 'sender1',
-      uri: 'https://example.com/ttl/resource',
+      messageUri: 'https://example.com/ttl/resource',
     },
   };
 
@@ -72,7 +72,7 @@ describe('validateTtlItemEvent', () => {
       'digital-letter-id': '123e4567-e89b-12d3-a456-426614174000',
       messageReference: 'ref1',
       senderId: 'sender1',
-      uri: 'https://example.com/ttl/resource',
+      messageUri: 'https://example.com/ttl/resource',
     },
   };
 
diff --git a/utils/utils/src/types/ttl-dynamodb-record.ts b/utils/utils/src/types/ttl-dynamodb-record.ts
diff --git a/utils/utils/src/types/ttl-item-event.ts b/utils/utils/src/types/ttl-item-event.ts
