Add the ability to return an HTTP 422 error from the sandbox

Author: gareth-allan

sandbox/__test__/messages.spec.js

@@ -2,6 +2,7 @@ import request from "supertest";
 import { assert } from "chai";
 import * as uuid from "uuid";
 import { setup } from "./helpers.js";
+import { duplicateRequestCorrelationId } from "../handlers/config.js";
 
 describe("/api/v1/messages", () => {
   let env;
@@ -169,6 +170,30 @@ describe("/api/v1/messages", () => {
       .expect("X-Correlation-Id", correlationId, done);
   });
 
+  it("responds with a 422 when provided with the correct correlation ID", (done) => {
+    request(server)
+      .post("/api/v1/messages")
+      .send({
+        data: {
+          type: "Message",
+          attributes: {
+            routingPlanId: "b838b13c-f98c-4def-93f0-515d4e4f4ee1",
+            messageReference: "b5bb84b9-a522-41e9-aa8b-ad1b6a454243",
+            recipient: {
+              nhsNumber: "1",
+            },
+            originator: {
+              odsCode: "X123",
+            },
+            personalisation: {},
+          },
+        },
+      })
+      .set("X-Correlation-Id", duplicateRequestCorrelationId)
+      .expect(422)
+      .expect("Content-Type", /json/, done);
+  });
+
   it("responds with a 201 for a valid global NHS app routing plan", (done) => {
     request(server)
       .post("/api/v1/messages")

sandbox/handlers/config.js

@@ -52,6 +52,8 @@ const noDefaultOdsClientAuth = "noDefaultOds";
 const noOdsChangeClientAuth = "noOdsChange";
 const notAllowedContactDetailOverride = "notAllowedContactDetailOverride"
 
+const duplicateRequestCorrelationId = "cb8c06ea-505b-4c4b-a4c4-317178ecb5b5"
+
 export {
     invalidRoutingPlanId,
     trigger500SendingGroupId,
@@ -66,5 +68,6 @@ export {
     globalFreeTextSmsSendingGroupId,
     noDefaultOdsClientAuth,
     noOdsChangeClientAuth,
-    notAllowedContactDetailOverride
+    notAllowedContactDetailOverride,
+    duplicateRequestCorrelationId
 }

sandbox/handlers/error_scenarios/correlation_id.js

@@ -0,0 +1,14 @@
+import {
+  duplicateRequestCorrelationId
+} from "../config.js";
+
+export function getCorrelationIdError(correlationId) {
+  if (correlationId === duplicateRequestCorrelationId) {
+    return [
+      422,
+      "Request exists with identical messageReference",
+    ];
+  }
+
+  return null;
+}

sandbox/handlers/messages.js

@@ -6,6 +6,7 @@ import { getOdsCodeError } from "./error_scenarios/ods_code.js";
 import { mandatorySingleMessageFieldValidation } from "./validation/mandatory_single_message_fields.js";
 import { getAlternateContactDetailsError } from "./error_scenarios/override_contact_details.js";
 import { getGlobalFreeTextError } from "./error_scenarios/global_free_text.js";
+import { getCorrelationIdError } from "./error_scenarios/correlation_id.js";
 
 export async function messages(req, res, next) {
   if (req.headers.authorization === "banned") {
@@ -71,6 +72,15 @@ export async function messages(req, res, next) {
     return;
   }
 
+  const correlationIdError = getCorrelationIdError(req.headers["x-correlation-id"]);
+  if (correlationIdError !== null) {
+    const [errorCode, errorMessage] = correlationIdError;
+    sendError(res, errorCode, errorMessage);
+    next();
+    return;
+
+  }
+
   writeLog(res, "warn", {
     message: "/api/v1/messages",
     req: {