TA review changes: move utils to common area, move objectStore to routes/, hide/refactor adding the sandbox baseUrl header, sandbox objectStore returns x-correlation-id

Author: francisco-videira-nhs

sandbox/src/app.js

@@ -4,16 +4,22 @@ const Inert = require('@hapi/inert')
 const process = require('process')
 const routes = require('./routes')
 
+/*
+The purpose of this logic is to mirror the transformations the API proxy currently applies to responses.
+This allows the sandbox to have the same behaviour locally.
+*/
 const addCommonHeaders = function (request, response) {
   // if a response doesn't include any headers provide an empty object to allow for the common headers to be appended.
   if (!response.headers) {
     response.headers = {}
   }
 
-  if (!request.path.includes("ObjectStore")) {
-    if (request.headers["x-correlation-id"]) {
-      response.headers["X-Correlation-ID"] = request.headers["x-correlation-id"]
-    }
+  // API proxy always adds x-correlation-id to responses.
+  if (request.headers["x-correlation-id"]) {
+    response.headers["X-Correlation-ID"] = request.headers["x-correlation-id"]
+  }
+
+  if (!request.path.includes("/ObjectStore")) {
     response.headers["X-Request-ID"] = '58621d65-d5ad-4c3a-959f-0438e355990e-1'
   }
 }

sandbox/src/routes/common/validationUtil.js

@@ -1,6 +1,17 @@
+/**
+ * @file validationUtil.js
+ * @description Provides utility functions.
+ */
 
-module.exports = {
-  validateBusinessFunction: function (request, h, allowedBusinessFunctions) {
+function isValidUuid(string) {
+    return /^[0-9A-F]{8}-[0-9A-F]{4}-[4][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i.test(string);
+  }
+
+function hasLegacyPrefix(string) {
+    return string.startsWith('att-');
+}
+
+function validateBusinessFunction(request, h, allowedBusinessFunctions) {
     const requestedBusinessFunction = request.headers["nhsd-ers-business-function"]
     const oboUserId = request.headers["nhsd-ers-on-behalf-of-user-id"]
 
@@ -23,5 +34,10 @@ module.exports = {
     }
 
     return undefined;
-  }
 }
+
+module.exports = {
+    isValidUuid,
+    hasLegacyPrefix,
+    validateBusinessFunction
+};

…rc/services/businessFunctionValidator.js …box/src/routes/common/validationUtils.jssandbox/src/services/businessFunctionValidator.js renamed to sandbox/src/routes/common/validationUtils.js sandbox/src/services/businessFunctionValidator.js renamed to sandbox/src/routes/common/validationUtils.js

@@ -47,7 +47,7 @@ const retrieveAttachmentR4 = require('./r4/retrieveAttachment')
 /**
  * Services
  */
-const objectStore = require('../services/objectStore')
+const objectStore = require('./objectStore')
 
 
 const routes = [].concat(

sandbox/src/routes/index.js

@@ -1,5 +1,4 @@
-const businessFunctionValidator = require('../../services/businessFunctionValidator')
-const validationUtil = require('../common/validationUtil')
+const validationUtils = require('../common/validationUtils')
 
 module.exports = [
   /**
@@ -12,7 +11,7 @@ module.exports = [
 
       const allowedBusinessFunctions = ["REFERRING_CLINICIAN", "REFERRING_CLINICIAN_ADMIN", "SERVICE_PROVIDER_CLINICIAN", "SERVICE_PROVIDER_CLINICIAN_ADMIN"];
 
-      const validationResult = businessFunctionValidator.validateBusinessFunction(request, h, allowedBusinessFunctions);
+      const validationResult = validationUtils.validateBusinessFunction(request, h, allowedBusinessFunctions);
       if (validationResult) {
         return validationResult;
       }
@@ -21,7 +20,7 @@ module.exports = [
       const objectStore = "/ObjectStore/d497bbe3-f88b-45f1-b3d4-9c563e4c0f5f";
       const location = request.headers['x-ers-sandbox-baseurl'] + objectStore;
 
-      if ((validationUtil.hasLegacyPrefix(binaryId) || validationUtil.isValidUuid(binaryId)) && request.method === 'get') {
+      if ((validationUtils.hasLegacyPrefix(binaryId) || validationUtils.isValidUuid(binaryId)) && request.method === 'get') {
         const response = h.response().code(307);
         response.headers["Location"] = location;
         return response;

sandbox/src/services/objectStore.js sandbox/src/routes/objectStore.jssandbox/src/services/objectStore.js renamed to sandbox/src/routes/objectStore.js

@@ -1,10 +1,10 @@
 const mockResponseProvider = require('./services/mockResponseProvider')
-const businessFunctionValidator = require('../../services/businessFunctionValidator')
+const validationUtils = require('../common/validationUtils')
 
 function retrieveHealthcareService(request, h) {
     const allowedBusinessFunctions = ["REFERRING_CLINICIAN", "REFERRING_CLINICIAN_ADMIN"]
 
-    const validationResult = businessFunctionValidator.validateBusinessFunction(request, h, allowedBusinessFunctions)
+    const validationResult = validationUtils.validateBusinessFunction(request, h, allowedBusinessFunctions)
     if (validationResult) {
         return validationResult
     }

sandbox/src/routes/r4/retrieveAttachment.js

@@ -1,5 +1,5 @@
 const mockResponseProvider = require('./services/mockResponseProvider')
-const businessFunctionValidator = require('../../services/businessFunctionValidator')
+const validationUtils = require('../common/validationUtils')
 
 module.exports = [
     {
@@ -8,7 +8,7 @@ module.exports = [
         handler: (request, h) => {
             const allowedBusinessFunctions = ["REFERRING_CLINICIAN", "REFERRING_CLINICIAN_ADMIN"]
 
-            const validationResult = businessFunctionValidator.validateBusinessFunction(request, h, allowedBusinessFunctions)
+            const validationResult = validationUtils.validateBusinessFunction(request, h, allowedBusinessFunctions)
             if (validationResult) {
                 return validationResult
             }

sandbox/src/routes/r4/retrieveHealthcareService.js

@@ -1,10 +1,10 @@
 const mockResponseProvider = require('./services/mockResponseProvider')
-const businessFunctionValidator = require('../../services/businessFunctionValidator')
+const validationUtils = require('../common/validationUtils')
 
 function searchServiceRequest(request, h) {
     const allowedBusinessFunctions = ["REFERRING_CLINICIAN", "REFERRING_CLINICIAN_ADMIN", "SERVICE_PROVIDER_CLINICIAN", "SERVICE_PROVIDER_CLINICIAN_ADMIN"]
 
-    const validationResult = businessFunctionValidator.validateBusinessFunction(request, h, allowedBusinessFunctions)
+    const validationResult = validationUtils.validateBusinessFunction(request, h, allowedBusinessFunctions)
     if (validationResult) {
         return validationResult
     }

sandbox/src/routes/r4/searchForHealthcareServices.js

@@ -1,5 +1,5 @@
 const mockResponseProvider = require('./services/mockResponseProvider')
-const businessFunctionValidator = require('../../services/businessFunctionValidator')
+const validationUtils = require('../common/validationUtils')
 
 module.exports = [
   /**
@@ -12,7 +12,7 @@ module.exports = [
 
       const allowedBusinessFunctions = ["SERVICE_PROVIDER_CLINICIAN", "SERVICE_PROVIDER_CLINICIAN_ADMIN"]
 
-      const validationResult = businessFunctionValidator.validateBusinessFunction(request, h, allowedBusinessFunctions)
+      const validationResult = validationUtils.validateBusinessFunction(request, h, allowedBusinessFunctions)
 
       if (validationResult) {
         return validationResult