CCM-16553: Refactor to include potentially other event types and to send to the event bus

nhsd-angel-pastor · nhsd-angel-pastor · commit 072b12cbd63c · 2026-04-16T15:38:35.000+01:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/scripts/nft-event-generator/jest.config.ts b/scripts/nft-event-generator/jest.config.ts
@@ -17,6 +17,7 @@ const config: Config = {
           target: 'ES2020',
           moduleResolution: 'node',
           noEmit: true,
+          typeRoots: ['../../node_modules/@types'],
         },
         diagnostics: {
           ignoreCodes: [1343], // Ignore TS1343: import.meta errors
@@ -47,6 +48,7 @@ const config: Config = {
   moduleNameMapper: {
     '^(.*)\\.ts$': '$1',
   },
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
   testTimeout: 10_000,
 };
 
diff --git a/scripts/nft-event-generator/package.json b/scripts/nft-event-generator/package.json
@@ -1,9 +1,11 @@
 {
   "author": "",
   "dependencies": {
+    "@aws-sdk/client-eventbridge": "^3.914.0",
     "@aws-sdk/client-sqs": "^3.914.0",
     "@aws-sdk/client-sts": "^3.914.0",
     "csv-parse": "^6.1.0",
+    "digital-letters-events": "^0.0.1",
     "tsx": "^4.20.6",
     "yargs": "^17.7.2"
   },
diff --git a/scripts/nft-event-generator/src/__tests__/send-events-to-event-bus.test.ts b/scripts/nft-event-generator/src/__tests__/send-events-to-event-bus.test.ts
@@ -0,0 +1,90 @@
+import {
+  PutEventsCommand,
+  PutEventsResultEntry,
+} from '@aws-sdk/client-eventbridge';
+import { fakeEvent } from '__tests__/helpers/fake-event';
+import { PublishableEvent } from 'destination-client';
+import { mock } from 'jest-mock-extended';
+import { sendEventsToEventBus } from 'send-events-to-event-bus';
+
+const environment = 'dev';
+
+const mockEventBridgeClient = { send: jest.fn() };
+jest.mock('@aws-sdk/client-eventbridge', () => {
+  const originalModule = jest.requireActual('@aws-sdk/client-eventbridge');
+
+  return {
+    __esModule: true,
+    ...originalModule,
+    EventBridgeClient: jest.fn(() => mockEventBridgeClient),
+  };
+});
+
+const successEntry = mock<PutEventsResultEntry>({ ErrorCode: undefined });
+const successfulSendResponse = { Entries: [successEntry] };
+
+describe('sendEventsToEventBus', () => {
+  beforeEach(() => {
+    mockEventBridgeClient.send.mockReset();
+  });
+
+  it('should send the expected request to EventBridge', async () => {
+    mockEventBridgeClient.send.mockResolvedValue(successfulSendResponse);
+
+    await sendEventsToEventBus(environment, [fakeEvent], 5);
+
+    expect(mockEventBridgeClient.send).toHaveBeenCalled();
+    const putEventsCommand: PutEventsCommand =
+      mockEventBridgeClient.send.mock.calls[0][0];
+
+    expect(putEventsCommand.input.Entries).toHaveLength(1);
+    const entry = putEventsCommand.input.Entries![0];
+    expect(entry.EventBusName).toBe(`nhs-${environment}-dl`);
+    expect(entry.Source).toBe(fakeEvent.source);
+    expect(entry.DetailType).toBe(fakeEvent['detail-type']);
+    expect(entry.Detail).toBe(JSON.stringify(fakeEvent.detail));
+  });
+
+  it('should send a request for each batch of messages', async () => {
+    const events: PublishableEvent[] = Array.from(
+      { length: 52 },
+      () => fakeEvent,
+    );
+    mockEventBridgeClient.send.mockResolvedValue(successfulSendResponse);
+
+    await sendEventsToEventBus(environment, events, 5);
+
+    // Batch size is 10, so 52 events = 6 batches.
+    expect(mockEventBridgeClient.send).toHaveBeenCalledTimes(6);
+  });
+
+  it('should continue sending batches if an error is raised', async () => {
+    mockEventBridgeClient.send.mockRejectedValueOnce(
+      new Error('Something went wrong!'),
+    );
+    mockEventBridgeClient.send.mockResolvedValue(successfulSendResponse);
+
+    const events: PublishableEvent[] = Array.from(
+      { length: 30 },
+      () => fakeEvent,
+    );
+
+    await sendEventsToEventBus(environment, events, 5);
+
+    // Batch size is 10, so 30 events = 3 batches.
+    expect(mockEventBridgeClient.send).toHaveBeenCalledTimes(3);
+  });
+
+  it('should warn when some events fail to publish', async () => {
+    const failedEntry = mock<PutEventsResultEntry>({
+      ErrorCode: 'InternalFailure',
+    });
+    mockEventBridgeClient.send.mockResolvedValue({
+      Entries: [failedEntry],
+    });
+
+    await sendEventsToEventBus(environment, [fakeEvent], 5);
+
+    expect(console.warn).toHaveBeenCalled();
+  });
+});
diff --git a/scripts/nft-event-generator/src/__tests__/send-events-to-sqs.test.ts b/scripts/nft-event-generator/src/__tests__/send-events-to-sqs.test.ts
@@ -3,9 +3,9 @@ import {
   SendMessageBatchCommand,
 } from '@aws-sdk/client-sqs';
 import { fakeEvent } from '__tests__/helpers/fake-event';
+import { PublishableEvent } from 'destination-client';
 import { mock } from 'jest-mock-extended';
 import { sendEventsToSqs } from 'send-events-to-sqs';
-import { SupplierStatusEvent } from 'types';
 
 const accountId = '257995483745';
 const environment = 'dev';
@@ -68,7 +68,7 @@ describe('sendEventsToSqs', () => {
   });
 
   it('should send a request for each batch of messages', async () => {
-    const events: SupplierStatusEvent[] = Array.from(
+    const events: PublishableEvent[] = Array.from(
       {
         length: 52,
       },
@@ -88,7 +88,7 @@ describe('sendEventsToSqs', () => {
     );
     mockSqsClient.send.mockResolvedValue(successfulSendResponse);
 
-    const events: SupplierStatusEvent[] = Array.from(
+    const events: PublishableEvent[] = Array.from(
       {
         length: 30,
       },
@@ -107,7 +107,7 @@ describe('sendEventsToSqs', () => {
     });
     mockSqsClient.send.mockResolvedValue(successfulSendResponse);
 
-    const events: SupplierStatusEvent[] = Array.from(
+    const events: PublishableEvent[] = Array.from(
       {
         length: 30,
       },
@@ -122,7 +122,7 @@ describe('sendEventsToSqs', () => {
 
   it('should continue sending batches if an empty response is received', async () => {
     mockSqsClient.send.mockResolvedValue({});
-    const events: SupplierStatusEvent[] = Array.from(
+    const events: PublishableEvent[] = Array.from(
       {
         length: 30,
       },
diff --git a/scripts/nft-event-generator/src/cli.ts b/scripts/nft-event-generator/src/cli.ts
@@ -1,5 +1,7 @@
+import { DestinationClient } from 'destination-client';
 import { generateSupplierStatusEvents } from 'generate-events';
-import { sendEventsToSqs } from 'send-events-to-sqs';
+import { EventBusDestinationClient } from 'send-events-to-event-bus';
+import { SqsDestinationClient } from 'send-events-to-sqs';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
@@ -24,15 +26,32 @@ const argv = yargs(hideBin(process.argv))
     default: 0.5,
     describe: 'Ratio of events with delayedFallback = true (0 to 1)',
   })
+  .option('destination', {
+    type: 'string',
+    choices: ['sqs', 'event-bus'] as const,
+    default: 'sqs',
+    describe: 'Destination to send events to',
+  })
   .help()
   .alias('help', 'h').argv as any;
 
-const { delayedFallbackRatio, environment, interval, numberOfEvents } = argv;
+const {
+  delayedFallbackRatio,
+  destination,
+  environment,
+  interval,
+  numberOfEvents,
+} = argv;
 
 const events = generateSupplierStatusEvents({
   numberOfEvents,
   environment,
   delayedFallbackRatio,
 });
 
-sendEventsToSqs(environment, events, interval);
+const client: DestinationClient =
+  destination === 'event-bus'
+    ? new EventBusDestinationClient(environment)
+    : new SqsDestinationClient(environment);
+
+client.sendEvents(events, interval);
diff --git a/scripts/nft-event-generator/src/destination-client.ts b/scripts/nft-event-generator/src/destination-client.ts
@@ -0,0 +1,14 @@
+/**
+ * Minimum shape required by all destination clients.
+ * Each publishable event must carry an `id` so the sending implementation
+ * can use it as a unique identifier within a batch.
+ */
+export type PublishableEvent = { id: string };
+
+/**
+ * Common interface for all event destinations (SQS, EventBridge, etc.).
+ * Implementations are responsible for batching, retries and back-off.
+ */
+export interface DestinationClient {
+  sendEvents(events: PublishableEvent[], interval: number): Promise<void>;
+}
diff --git a/scripts/nft-event-generator/src/event-templates/supplier-status.json b/scripts/nft-event-generator/src/event-templates/supplier-status.json
@@ -0,0 +1,21 @@
+{
+  "detail": {
+    "data": {
+      "clientId": "apim_integration_test_client_id",
+      "nhsNumber": "9001648967",
+      "previousSupplierStatus": "received",
+      "supplierStatus": "unnotified"
+    },
+    "datacontenttype": "application/json",
+    "dataschema": "https://notify.nhs.uk/events/schemas/supplier-status/v1.json",
+    "dataschemaversion": "1.0.0",
+    "plane": "data",
+    "specversion": "1.0",
+    "type": "uk.nhs.notify.channels.nhsapp.SupplierStatusChange.v1"
+  },
+  "detail-type": "uk.nhs.notify.channels.nhsapp.SupplierStatusChange.v1",
+  "region": "eu-west-2",
+  "resources": [],
+  "source": "custom.event",
+  "version": "0"
+}
diff --git a/scripts/nft-event-generator/src/generate-events.ts b/scripts/nft-event-generator/src/generate-events.ts
@@ -1,5 +1,6 @@
 import { randomUUID } from 'node:crypto';
 import { SupplierStatusEvent } from 'types';
+import supplierStatusTemplate from 'event-templates/supplier-status.json';
 
 type GenerateEventsParams = {
   numberOfEvents: number;
@@ -21,38 +22,25 @@ function generateSupplierStatusEvent(
   const sharedPlanId = randomUUID();
 
   return {
-    version: '0',
+    ...supplierStatusTemplate,
     id: eventId,
-    'detail-type': 'uk.nhs.notify.channels.nhsapp.SupplierStatusChange.v1',
-    source: 'custom.event',
     account: '257995483745',
     time: now.toISOString(),
-    region: 'eu-west-2',
-    resources: [],
     detail: {
+      ...supplierStatusTemplate.detail,
       id: detailId,
       source: `//nhs.notify.uk/supplier-status/${environment}`,
-      specversion: '1.0',
-      type: 'uk.nhs.notify.channels.nhsapp.SupplierStatusChange.v1',
-      plane: 'data',
       subject: sharedPlanId,
       time: now.toISOString(),
-      datacontenttype: 'application/json',
-      dataschema:
-        'https://notify.nhs.uk/events/schemas/supplier-status/v1.json',
-      dataschemaversion: '1.0.0',
       data: {
-        nhsNumber: '9001648967',
+        ...supplierStatusTemplate.detail.data,
         delayedFallback,
         sendingGroupId,
-        clientId: 'apim_integration_test_client_id',
-        supplierStatus: 'unnotified',
-        previousSupplierStatus: 'received',
         requestItemId,
         requestItemPlanId: sharedPlanId,
       },
     },
-  };
+  } as SupplierStatusEvent;
 }
 
 function shuffle<T>(array: T[]): T[] {
diff --git a/scripts/nft-event-generator/src/send-events-to-event-bus.ts b/scripts/nft-event-generator/src/send-events-to-event-bus.ts
diff --git a/scripts/nft-event-generator/src/send-events-to-sqs.ts b/scripts/nft-event-generator/src/send-events-to-sqs.ts
diff --git a/scripts/nft-event-generator/src/utils/build-event-bus-name.ts b/scripts/nft-event-generator/src/utils/build-event-bus-name.ts
