CCM-12842: Update Create TTL lambda to accept Event Bus envelope

Author: simonlabarere

lambdas/ttl-create-lambda/src/__tests__/apis/sqs-trigger-lambda.test.ts

@@ -1,34 +1,37 @@
 import { createHandler } from 'apis/sqs-trigger-lambda';
 import type { SQSEvent } from 'aws-lambda';
-import { $TtlItemEvent, TtlItemEvent } from 'utils';
+import { $TtlItemBusEvent, TtlItemBusEvent } from 'utils';
 
 describe('createHandler', () => {
   let createTtl: any;
   let eventPublisher: any;
   let logger: any;
   let handler: any;
 
-  const validItem: TtlItemEvent = {
-    profileversion: '1.0.0',
-    profilepublished: '2025-10',
-    id: '550e8400-e29b-41d4-a716-446655440001',
-    specversion: '1.0',
-    source: '/nhs/england/notify/production/primary/data-plane/digital-letters',
-    subject:
-      'customer/920fca11-596a-4eca-9c47-99f624614658/recipient/769acdd4-6a47-496f-999f-76a6fd2c3959',
-    type: 'uk.nhs.notify.digital.letters.sent.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/schemas/events/digital-letters/2025-10/digital-letters.schema.json',
-    dataschemaversion: '1.0',
-    severitytext: 'INFO',
-    data: {
-      uri: 'https://example.com/ttl/resource',
-      'digital-letter-id': '123e4567-e89b-12d3-a456-426614174000',
+  const validItem: TtlItemBusEvent = {
+    detail: {
+      profileversion: '1.0.0',
+      profilepublished: '2025-10',
+      id: '550e8400-e29b-41d4-a716-446655440001',
+      specversion: '1.0',
+      source:
+        '/nhs/england/notify/production/primary/data-plane/digital-letters',
+      subject:
+        'customer/920fca11-596a-4eca-9c47-99f624614658/recipient/769acdd4-6a47-496f-999f-76a6fd2c3959',
+      type: 'uk.nhs.notify.digital.letters.sent.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/schemas/events/digital-letters/2025-10/digital-letters.schema.json',
+      dataschemaversion: '1.0',
+      severitytext: 'INFO',
+      data: {
+        uri: 'https://example.com/ttl/resource',
+        'digital-letter-id': '123e4567-e89b-12d3-a456-426614174000',
+      },
     },
   };
 
@@ -41,7 +44,7 @@ describe('createHandler', () => {
 
   it('processes a valid SQS event and returns success', async () => {
     jest
-      .spyOn($TtlItemEvent, 'safeParse')
+      .spyOn($TtlItemBusEvent, 'safeParse')
       .mockReturnValue({ success: true, data: validItem });
     createTtl.send.mockResolvedValue('sent');
     const event: SQSEvent = {
@@ -51,8 +54,8 @@ describe('createHandler', () => {
     const res = await handler(event);
 
     expect(res.batchItemFailures).toEqual([]);
-    expect(createTtl.send).toHaveBeenCalledWith(validItem);
-    expect(eventPublisher.sendEvents).toHaveBeenCalledWith([validItem]);
+    expect(createTtl.send).toHaveBeenCalledWith(validItem.detail);
+    expect(eventPublisher.sendEvents).toHaveBeenCalledWith([validItem.detail]);
     expect(logger.info).toHaveBeenCalledWith({
       description: 'Processed SQS Event.',
       failed: 0,
@@ -64,7 +67,7 @@ describe('createHandler', () => {
   it('handles parse failure and logs error', async () => {
     const zodError = { errors: [] } as any;
     jest
-      .spyOn($TtlItemEvent, 'safeParse')
+      .spyOn($TtlItemBusEvent, 'safeParse')
       .mockReturnValue({ success: false, error: zodError });
     const event: SQSEvent = {
       Records: [{ body: '{}', messageId: 'msg2' }],
@@ -88,7 +91,7 @@ describe('createHandler', () => {
 
   it('handles createTtl.send failure', async () => {
     jest
-      .spyOn($TtlItemEvent, 'safeParse')
+      .spyOn($TtlItemBusEvent, 'safeParse')
       .mockReturnValue({ success: true, data: validItem });
     createTtl.send.mockResolvedValue('failed');
     const event: SQSEvent = {
@@ -107,7 +110,7 @@ describe('createHandler', () => {
   });
 
   it('handles thrown error and logs', async () => {
-    jest.spyOn($TtlItemEvent, 'safeParse').mockImplementation(() => {
+    jest.spyOn($TtlItemBusEvent, 'safeParse').mockImplementation(() => {
       throw new Error('bad json');
     });
     const event: SQSEvent = {
@@ -159,7 +162,7 @@ describe('createHandler', () => {
 
   it('processes multiple successful events and sends them as a batch', async () => {
     jest
-      .spyOn($TtlItemEvent, 'safeParse')
+      .spyOn($TtlItemBusEvent, 'safeParse')
       .mockReturnValue({ success: true, data: validItem });
     createTtl.send.mockResolvedValue('sent');
     const event: SQSEvent = {
@@ -175,9 +178,9 @@ describe('createHandler', () => {
     expect(res.batchItemFailures).toEqual([]);
     expect(createTtl.send).toHaveBeenCalledTimes(3);
     expect(eventPublisher.sendEvents).toHaveBeenCalledWith([
-      validItem,
-      validItem,
-      validItem,
+      validItem.detail,
+      validItem.detail,
+      validItem.detail,
     ]);
     expect(logger.info).toHaveBeenCalledWith({
       description: 'Processed SQS Event.',
@@ -189,7 +192,7 @@ describe('createHandler', () => {
 
   it('handles partial event publishing failures and logs warning', async () => {
     jest
-      .spyOn($TtlItemEvent, 'safeParse')
+      .spyOn($TtlItemBusEvent, 'safeParse')
       .mockReturnValue({ success: true, data: validItem });
     createTtl.send.mockResolvedValue('sent');
     const failedEvents = [validItem];
@@ -206,8 +209,8 @@ describe('createHandler', () => {
 
     expect(res.batchItemFailures).toEqual([]);
     expect(eventPublisher.sendEvents).toHaveBeenCalledWith([
-      validItem,
-      validItem,
+      validItem.detail,
+      validItem.detail,
     ]);
     expect(logger.warn).toHaveBeenCalledWith({
       description: 'Some events failed to publish',
@@ -218,7 +221,7 @@ describe('createHandler', () => {
 
   it('handles event publishing exception and logs warning', async () => {
     jest
-      .spyOn($TtlItemEvent, 'safeParse')
+      .spyOn($TtlItemBusEvent, 'safeParse')
       .mockReturnValue({ success: true, data: validItem });
     createTtl.send.mockResolvedValue('sent');
     const publishError = new Error('EventBridge error');
@@ -231,7 +234,7 @@ describe('createHandler', () => {
     const res = await handler(event);
 
     expect(res.batchItemFailures).toEqual([]);
-    expect(eventPublisher.sendEvents).toHaveBeenCalledWith([validItem]);
+    expect(eventPublisher.sendEvents).toHaveBeenCalledWith([validItem.detail]);
     expect(logger.warn).toHaveBeenCalledWith({
       err: publishError,
       description: 'Failed to send events to EventBridge',
@@ -241,7 +244,7 @@ describe('createHandler', () => {
 
   it('does not call eventPublisher when no successful events', async () => {
     jest
-      .spyOn($TtlItemEvent, 'safeParse')
+      .spyOn($TtlItemBusEvent, 'safeParse')
       .mockReturnValue({ success: true, data: validItem });
     createTtl.send.mockResolvedValue('failed');
 
@@ -263,7 +266,7 @@ describe('createHandler', () => {
 
   it('handles mixed success and failure scenarios', async () => {
     jest
-      .spyOn($TtlItemEvent, 'safeParse')
+      .spyOn($TtlItemBusEvent, 'safeParse')
       .mockReturnValueOnce({ success: true, data: validItem })
       .mockReturnValueOnce({ success: false, error: { errors: [] } as any })
       .mockReturnValueOnce({ success: true, data: validItem });
@@ -285,7 +288,7 @@ describe('createHandler', () => {
       { itemIdentifier: 'msg2' },
       { itemIdentifier: 'msg3' },
     ]);
-    expect(eventPublisher.sendEvents).toHaveBeenCalledWith([validItem]);
+    expect(eventPublisher.sendEvents).toHaveBeenCalledWith([validItem.detail]);
     expect(logger.info).toHaveBeenCalledWith({
       description: 'Processed SQS Event.',
       failed: 2,

lambdas/ttl-create-lambda/src/apis/sqs-trigger-lambda.ts

@@ -4,7 +4,7 @@ import type {
   SQSEvent,
 } from 'aws-lambda';
 import type { CreateTtl, CreateTtlOutcome } from 'app/create-ttl';
-import { $TtlItemEvent, EventPublisher, Logger, TtlItemEvent } from 'utils';
+import { $TtlItemBusEvent, EventPublisher, Logger, TtlItemEvent } from 'utils';
 
 interface ProcessingResult {
   result: CreateTtlOutcome;
@@ -33,7 +33,7 @@ export const createHandler = ({
             data: item,
             error: parseError,
             success: parseSuccess,
-          } = $TtlItemEvent.safeParse(JSON.parse(body));
+          } = $TtlItemBusEvent.safeParse(JSON.parse(body));
 
           if (!parseSuccess) {
             logger.error({
@@ -44,14 +44,14 @@ export const createHandler = ({
             return { result: 'failed' };
           }
 
-          const result = await createTtl.send(item);
+          const result = await createTtl.send(item.detail);
 
           if (result === 'failed') {
             batchItemFailures.push({ itemIdentifier: messageId });
             return { result: 'failed' };
           }
 
-          return { result, item };
+          return { result, item: item.detail };
         } catch (error) {
           logger.error({
             err: error,

utils/utils/src/types/ttl-item-event.ts

@@ -13,11 +13,13 @@ export const $TtlItemEvent = $CloudEvent.extend({
   data: $TtlItemData,
 });
 
+export const $TtlItemBusEvent = z.object({
+  detail: $TtlItemEvent,
+});
+
 export type TtlItemEvent = z.infer<typeof $TtlItemEvent>;
 
-export type TtlItemBusEvent = {
-  detail: TtlItemEvent;
-};
+export type TtlItemBusEvent = z.infer<typeof $TtlItemBusEvent>;
 
 export const validateTtlItemEvent = (data: unknown) => {
   return $TtlItemEvent.safeParse(data);