CCM-14323: Store failure reason and code (#207)

* CCM-14323: Added failure code and reason

---------

Co-authored-by: Gareth Allan <157592212+gareth-allan@users.noreply.github.com>

Author: ScottFullerton-NHSE

lambdas/print-status-handler/src/__tests__/apis/sqs-handler.test.ts

@@ -2,7 +2,11 @@ import { mock } from 'jest-mock-extended';
 import { randomUUID } from 'node:crypto';
 import { createHandler } from 'apis/sqs-handler';
 import { EventPublisher, Logger } from 'utils';
-import { acceptedLetterEvent, recordEvent } from '__tests__/test-data';
+import {
+  acceptedLetterEvent,
+  failedLetterEvent,
+  recordEvent,
+} from '__tests__/test-data';
 
 const logger = mock<Logger>();
 const eventPublisher = mock<EventPublisher>();
@@ -63,6 +67,85 @@ describe('SQS Handler', () => {
       );
       expect(response).toEqual({ batchItemFailures: [] });
     });
+
+    it('should include reasonCode and reasonText when provided in letter.FAILED event', async () => {
+      const response = await handler(recordEvent([failedLetterEvent]));
+
+      expect(eventPublisher.sendEvents).toHaveBeenCalledWith(
+        [
+          {
+            ...failedLetterEvent,
+            id: '550e8400-e29b-41d4-a716-446655440001',
+            time: '2023-06-20T12:00:00.250Z',
+            recordedtime: '2023-06-20T12:00:00.250Z',
+            dataschema:
+              'https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-print-letter-transitioned-data.schema.json',
+            type: 'uk.nhs.notify.digital.letters.print.letter.transitioned.v1',
+            source:
+              '/nhs/england/notify/production/primary/data-plane/digitalletters/print',
+            data: {
+              senderId: failedLetterEvent.data.origin.subject.split('/')[1],
+              messageReference:
+                failedLetterEvent.data.origin.subject.split('/')[3],
+              specificationId: failedLetterEvent.data.specificationId,
+              status: failedLetterEvent.data.status,
+              supplierId: failedLetterEvent.data.supplierId,
+              time: failedLetterEvent.time,
+              reasonCode: 'FAILURE001',
+              reasonText: 'Letter has too many pages',
+            },
+          },
+        ],
+        expect.any(Function),
+      );
+      expect(logger.info).toHaveBeenCalledWith(
+        'Received SQS Event of 1 record(s)',
+      );
+      expect(logger.info).toHaveBeenCalledWith(
+        '1 of 1 records processed successfully',
+      );
+      expect(response).toEqual({ batchItemFailures: [] });
+    });
+
+    it('should not include reasonCode when only reasonText is provided', async () => {
+      const eventWithReasonTextOnly = {
+        ...failedLetterEvent,
+        data: {
+          ...failedLetterEvent.data,
+          reasonCode: undefined,
+          reasonText: 'Letter has too many pages',
+        },
+      };
+
+      const response = await handler(recordEvent([eventWithReasonTextOnly]));
+
+      const publishedEvent = (eventPublisher.sendEvents as jest.Mock).mock
+        .calls[0][0][0];
+
+      expect(publishedEvent.data).not.toHaveProperty('reasonCode');
+      expect(publishedEvent.data.reasonText).toBe('Letter has too many pages');
+      expect(response).toEqual({ batchItemFailures: [] });
+    });
+
+    it('should not include reasonText when only reasonCode is provided', async () => {
+      const eventWithReasonCodeOnly = {
+        ...failedLetterEvent,
+        data: {
+          ...failedLetterEvent.data,
+          reasonCode: 'FAILURE001',
+          reasonText: undefined,
+        },
+      };
+
+      const response = await handler(recordEvent([eventWithReasonCodeOnly]));
+
+      const publishedEvent = (eventPublisher.sendEvents as jest.Mock).mock
+        .calls[0][0][0];
+
+      expect(publishedEvent.data.reasonCode).toBe('FAILURE001');
+      expect(publishedEvent.data).not.toHaveProperty('reasonText');
+      expect(response).toEqual({ batchItemFailures: [] });
+    });
   });
 
   describe('errors', () => {

lambdas/print-status-handler/src/__tests__/test-data.ts

@@ -35,6 +35,42 @@ export const acceptedLetterEvent = {
   },
 } as LetterEvent;
 
+export const failedLetterEvent = {
+  id: '550e8400-e29b-41d4-a716-446655440002',
+  specversion: '1.0',
+  source: '/data-plane/supplier-api/prod/update-status',
+  subject:
+    'letter-origin/digital-letters/letter/f47ac10b-58cc-4372-a567-0e02b2c3d480',
+  type: 'uk.nhs.notify.supplier-api.letter.FAILED.v1',
+  dataschema:
+    'https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.FAILED.1.0.0.schema.json',
+  dataschemaversion: '1.0.0',
+  time: '2023-06-20T13:00:00Z',
+  recordedtime: '2023-06-20T13:00:00.250Z',
+  severitynumber: 3,
+  traceparent: '00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203332-01',
+  datacontenttype: 'application/json',
+  severitytext: 'WARN',
+  plane: 'data',
+  data: {
+    domainId: 'f47ac10b-58cc-4372-a567-0e02b2c3d480',
+    groupId: 'client_template',
+    origin: {
+      domain: 'letter-rendering',
+      event: 'f47ac10b-58cc-4372-a567-0e02b2c3d480',
+      source: '/data-plane/letter-rendering/prod/render-pdf',
+      subject:
+        'client/00f3b388-bbe9-41c9-9e76-052d37ee8988/digital-letters/c8d1d8g9-9305-511e-9459-8f8eeg886ebf',
+    },
+    specificationId: '1y3q9v1zzzz',
+    supplierId: 'supplier-1',
+    status: 'FAILED',
+    billingRef: '1y3q9v1zzzz',
+    reasonCode: 'FAILURE001',
+    reasonText: 'Letter has too many pages',
+  },
+} as LetterEvent;
+
 const busEvent = {
   version: '0',
   id: 'ab07d406-0797-e919-ff9b-3ad9c5498114',

lambdas/print-status-handler/src/apis/sqs-handler.ts

@@ -83,6 +83,8 @@ function generateUpdatedEvent(event: LetterEvent): PrintLetterTransitioned {
   const {
     data: {
       origin: { subject },
+      reasonCode,
+      reasonText,
       specificationId,
       status,
       supplierId,
@@ -111,6 +113,8 @@ function generateUpdatedEvent(event: LetterEvent): PrintLetterTransitioned {
       status,
       supplierId,
       time,
+      ...(reasonCode && { reasonCode }),
+      ...(reasonText && { reasonText }),
     },
   };
 }