PRMP-744 PDS Error 20-A NACK

src/constants/enums.js

@@ -1,4 +1,4 @@
 import {errorMessages} from "../errors/errors";
 
 export const RecordType = {
   ALL: 'ALL', // Option for querying all layers in one call
@@ -72,6 +72,10 @@
   CODE_10: {
     errorCode: '10',
     errorDisplayName: 'Failed to successfully generate EHR Extract.'
+  },
+  CODE_20: {
+    errorCode: '20',
+    errorDisplayName: 'Spine system responded with an error.'
   }
 };
 
@@ -109,6 +113,11 @@
     gp2gpError: Gp2gpError.CODE_10,
     internalErrorCode: `${Gp2gpError.CODE_10.errorCode}-B`,
     internalErrorDescription: errorMessages.PRESIGNED_URL_NOT_FOUND_ERROR
+  },
+  ERROR_CODE_20_A: {
+    gp2gpError: Gp2gpError.CODE_20,
+    internalErrorCode: `${Gp2gpError.CODE_20.errorCode}-A`,
+    internalErrorDescription: errorMessages.GET_PDS_CODE_ERROR
   }
 };
 

src/errors/errors.js

@@ -48,10 +48,9 @@ export class ParsingError extends Error {
   }
 }
 
-export class GetPdsCodeError extends Error {
-  constructor(error) {
-    super(errorMessages.GET_PDS_CODE_ERROR);
-    logError(errorMessages.GET_PDS_CODE_ERROR, error);
+export class GetPdsCodeError extends NegativeAcknowledgementError {
+  constructor(error, acknowledgementErrorCode) {
+    super(errorMessages.GET_PDS_CODE_ERROR, acknowledgementErrorCode, error);
   }
 }
 

src/services/gp2gp/__tests__/pds-retrieval-request.test.js

@@ -1,6 +1,8 @@
 import nock from 'nock';
 import { getPdsOdsCode } from '../pds-retrieval-request';
 import { logError, logInfo } from '../../../middleware/logging';
+import { GetPdsCodeError } from '../../../errors/errors';
+import { AcknowledgementErrorCode } from '../../../constants/enums';
 
 // Mocking
 jest.mock('../../../middleware/logging');
@@ -48,7 +50,8 @@ describe('getPdsOdsCode', () => {
   it('should log and throw error when pds retrieval returns 500', async () => {
     // given
     let error;
-    const expectedError = new Error('Request failed with status code 500');
+    const http500Error = new Error('Request failed with status code 500');
+    const expectedError = new GetPdsCodeError(http500Error, AcknowledgementErrorCode.ERROR_CODE_20_A);
 
     // when
     nock(MOCK_GP2GP_MESSENGER_SERVICE_URL, HEADERS)
@@ -61,7 +64,8 @@ describe('getPdsOdsCode', () => {
     }
 
     // then
-    expect(error).not.toBeNull();
-    expect(logError).toHaveBeenCalledWith('Unable to retrieve patient from PDS', expectedError);
+    expect(error).toEqual(expectedError)
+    expect(logError).toHaveBeenCalledWith(http500Error);
+    expect(logError).toHaveBeenCalledWith(expect.stringContaining('internalErrorCode is: ' + expectedError.acknowledgementErrorCode.internalErrorCode));
   });
 });

src/services/gp2gp/pds-retrieval-request.js

@@ -2,6 +2,7 @@ import axios from 'axios';
 import { config } from '../../config';
 import { logInfo } from '../../middleware/logging';
 import { GetPdsCodeError } from '../../errors/errors';
+import { AcknowledgementErrorCode } from "../../constants/enums";
 
 export const getPdsOdsCode = async nhsNumber => {
   const { gp2gpMessengerAuthKeys, gp2gpMessengerServiceUrl } = config();
@@ -14,6 +15,6 @@ export const getPdsOdsCode = async nhsNumber => {
       return response.data.data.odsCode;
     })
     .catch(error => {
-      throw new GetPdsCodeError(error);
+      throw new GetPdsCodeError(error, AcknowledgementErrorCode.ERROR_CODE_20_A);
     });
 };

src/services/handler/__test__/continue-message-handler.test.js

@@ -21,9 +21,8 @@ import path from 'path';
 import { logError, logInfo, logWarning } from '../../../middleware/logging';
 import { hasServiceStartedInTheLast5Minutes } from '../../../config';
 import {
-  DownloadError,
+  DownloadError, GetPdsCodeError,
   NhsNumberNotFoundError,
-  PatientRecordNotFoundError,
   PresignedUrlNotFoundError
 } from '../../../errors/errors';
 import {
@@ -236,6 +235,12 @@ describe('continueMessageHandler', () => {
   });
 
   const testCasesForFragmentTransferErrors = [
+    {
+      errorType: GetPdsCodeError,
+      acknowledgementErrorCode: AcknowledgementErrorCode.ERROR_CODE_20_A,
+      conversationStatus: conversationStatus.OUTBOUND_FRAGMENTS_SENDING_FAILED,
+      failureReason: FailureReason.SENDING_FAILED
+    },
     {
       errorType: DownloadError,
       acknowledgementErrorCode: AcknowledgementErrorCode.ERROR_CODE_10_A,

src/services/handler/continue-message-handler.js

@@ -16,7 +16,7 @@ import { parseConversationId } from '../parser/parsing-utilities';
 import { logError, logInfo, logWarning } from '../../middleware/logging';
 import { ConversationStatus, CoreStatus, FailureReason } from '../../constants/enums';
 import { hasServiceStartedInTheLast5Minutes } from '../../config';
-import {DownloadError, PresignedUrlNotFoundError} from "../../errors/errors";
+import {DownloadError, GetPdsCodeError, PresignedUrlNotFoundError} from "../../errors/errors";
 import {sendAcknowledgement} from "../gp2gp/send-acknowledgement";
 
 export default async function continueMessageHandler(message) {
@@ -154,6 +154,20 @@ const handleFragmentTransferError = async (
   logError('Encountered error while sending out fragments', error);
 
   switch (true) {
+    case error instanceof GetPdsCodeError:
+      await sendAcknowledgement(
+        nhsNumber,
+        odsCode,
+        conversationId,
+        messageId,
+        error.acknowledgementErrorCode.gp2gpError
+      );
+      await updateConversationStatus(
+        conversationId,
+        ConversationStatus.OUTBOUND_FRAGMENTS_SENDING_FAILED,
+        FailureReason.SENDING_FAILED
+      );
+      break;
     case error instanceof PresignedUrlNotFoundError:
       await sendAcknowledgement(
         nhsNumber,

src/services/transfer/__tests__/transfer-out-ehr-core.test.js

@@ -9,7 +9,8 @@ import {
   DownloadError,
   MessageIdUpdateError,
   StatusUpdateError,
-  errorMessages, PatientRecordNotFoundError
+  PatientRecordNotFoundError,
+  GetPdsCodeError
 } from '../../../errors/errors';
 import {
   createAndStoreOutboundMessageIds,
@@ -116,6 +117,12 @@ describe('transferOutEhrCore', () => {
     });
 
     const testCasesForCoreTransferErrors = [
+      {
+        errorType: GetPdsCodeError,
+        acknowledgementErrorCode: AcknowledgementErrorCode.ERROR_CODE_20_A,
+        conversationStatus: conversationStatus.OUTBOUND_FAILED,
+        failureReason: FailureReason.CORE_SENDING_FAILED
+      },
       {
         errorType: PatientRecordNotFoundError,
         acknowledgementErrorCode: AcknowledgementErrorCode.ERROR_CODE_06_A

src/services/transfer/transfer-out-ehr-core.js

@@ -1,4 +1,9 @@
-import {PresignedUrlNotFoundError, DownloadError, PatientRecordNotFoundError} from '../../errors/errors';
+import {
+  PresignedUrlNotFoundError,
+  DownloadError,
+  PatientRecordNotFoundError,
+  GetPdsCodeError
+} from '../../errors/errors';
 import { logError, logInfo, logWarning } from '../../middleware/logging';
 import { getEhrCoreAndFragmentIdsFromRepo } from '../ehr-repo/get-ehr';
 import { setCurrentSpanAttributes } from '../../config/tracing';
@@ -104,6 +109,20 @@ const handleCoreTransferError = async (
   incomingMessageId
 ) => {
   switch (true) {
+    case error instanceof GetPdsCodeError:
+      await sendAcknowledgement(
+        nhsNumber,
+        odsCode,
+        conversationId,
+        incomingMessageId,
+        error.acknowledgementErrorCode.gp2gpError
+      );
+      await updateConversationStatus(
+        conversationId,
+        ConversationStatus.OUTBOUND_FAILED,
+        FailureReason.CORE_SENDING_FAILED
+      );
+      break;
     case error instanceof PatientRecordNotFoundError:
       await sendAcknowledgement(
         nhsNumber,