CCM-14974: Add failure reason and code to component test

Author: ScottFullerton-NHSE

tests/playwright/digital-letters-component-tests/report-generator.component.spec.ts

@@ -49,27 +49,35 @@ const scenarios = [
     [EventStatus.DigitalPDMResourceSubmissionRejected],
     'Failed',
     senderId,
+    'DL_PDMV_001',
+    'Letter rejected by PDM',
   ),
   new ReportScenario(
     'component-test-pdm-resource-retries-exceeded',
     CommunicationType.Digital,
     [EventStatus.DigitalPDMResourceRetriesExceeded],
     'Failed',
     senderId,
+    'DL_PDMV_002',
+    'Timeout waiting for letter storage',
   ),
   new ReportScenario(
     'component-test-message-request-rejected',
     CommunicationType.Digital,
     [EventStatus.DigitalMessageRequestRejected],
     'Failed',
     senderId,
+    'DL_INTE_001',
+    'Request validation failed',
   ),
   new ReportScenario(
     'component-test-digital-failed-priority',
     CommunicationType.Digital,
     [EventStatus.Unread, EventStatus.DigitalPDMResourceSubmissionRejected],
     'Failed',
     senderId,
+    'DL_PDMV_001',
+    'Letter rejected by PDM',
   ),
   // Scenarios for communication type Print where there is a single event per message reference.
   new ReportScenario(
@@ -107,6 +115,8 @@ const scenarios = [
     [EventStatus.PrintFileQuarantined],
     'Failed',
     senderId,
+    'DL_CLIV_003',
+    'Attachment contains a virus',
   ),
   // multiple events for the same message reference, should take the one with highest priority status (returned > failed > dispatched > rejected)
   new ReportScenario(

tests/playwright/helpers/report-helpers.ts

@@ -83,6 +83,10 @@ export class ReportScenario {
 
   readonly senderId: string;
 
+  readonly expectedReasonCode: string;
+
+  readonly expectedReason: string;
+
   time: string;
 
   constructor(
@@ -91,12 +95,16 @@ export class ReportScenario {
     eventStatuses: EventStatus[],
     expectedStatus: string,
     senderId: string,
+    expectedReasonCode = '',
+    expectedReason = '',
   ) {
     this.messageReference = messageReference;
     this.communicationType = communicationType;
     this.eventStatuses = eventStatuses;
     this.expectedStatus = expectedStatus;
     this.senderId = senderId;
+    this.expectedReasonCode = expectedReasonCode;
+    this.expectedReason = expectedReason;
     this.time = ''; // Set when publishing the event to EventBridge, otherwise all the events would have the same timestamp.
   }
 
@@ -106,6 +114,8 @@ export class ReportScenario {
       Time: this.time,
       'Communication Type': this.communicationType,
       Status: this.expectedStatus,
+      'Reason Code': this.expectedReasonCode,
+      Reason: this.expectedReason,
     };
   }