Merge pull request #2079 from NHSDigital/develop

APIM-R 1.41 Cut

Author: nhsd-david-wass

Makefile

@@ -18,6 +18,7 @@ lint: copy-examples
 	cd sandbox && make lint
 	poetry run python scripts/xml_validator.py
 	poetry run flake8 **/*.py
+	poetry check
 	@printf "\nLinting passed.\n\n"
 
 clean:

package-lock.json

@@ -12,7 +12,7 @@
   "license": "MIT",
   "homepage": "https://github.com/NHSDigital/e-referrals-service-api",
   "dependencies": {
-    "@redocly/cli": "^1.25.15"
+    "@redocly/cli": "^1.27.2"
   },
   "devDependencies": {
     "apigeetool": "^0.16.5",

package.json

@@ -0,0 +1,9 @@
+<AssignMessage async="false" continueOnError="false" enabled="true" name="AssignMessage.AddBaseUrlHeader">
+    <Set>
+        <Headers>
+            <Header name="x-ers-sandbox-baseurl">https://{request.header.Host}/{proxy.basepath}</Header>
+        </Headers>
+    </Set>
+    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
+    <AssignTo createNew="false"/>
+</AssignMessage>

poetry.lock

@@ -7,8 +7,12 @@
         <Response/>
     </PostFlow>
     <PreFlow name="PreFlow">
-        <Request/>
-        <Response></Response>
+        <Request>
+            <Step>
+                <Name>AssignMessage.AddBaseUrlHeader</Name>
+            </Step>
+        </Request>
+        <Response/>
     </PreFlow>
     <HTTPTargetConnection>{{ HOSTED_TARGET_CONNECTION }}</HTTPTargetConnection>
 </TargetEndpoint>

proxies/sandbox/apiproxy/policies/AssignMessage.AddBaseUrlHeader.xml

@@ -1,23 +1,22 @@
 [project]
 python = "^3.8"
-
-
-[tool.poetry]
 name = "e-referrals-service-api"
 version = "0.0.1-alpha"
 description = "TODO"
-package-mode = false
-
 license = "MIT"
 
 authors = [
 ]
 
 readme = 'README.md'
-
 repository = "https://github.com/NHSDigital/e-referrals-service-api"
-
 keywords = ["healthcare", "uk", "nhs"] #TODO add additional keywords
+dynamic = ["dependencies", "requires-python"]
+
+[tool.poetry]
+package-mode = false
+
+
 
 
 [tool.poetry.dependencies]
@@ -26,21 +25,21 @@ pyyaml = "^6.0"
 docopt = "^0.6.2"
 jsonpath-rw = "^1.4.0"
 semver = "^3.0.2"
-gitpython = "^3.1.43"
+gitpython = "^3.1.44"
 lxml = "^4.9.4"
 xmlformatter = "^0.2.8"
 pytest-check = "^2.4.1"
 requests = "^2.32.3"
 openapi-core = "^0.19.4"
 
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 flake8 = "^7.1.1"
 black = "^24.8"
 pip-licenses = "^5.0.0"
-jinja2 = "^3.1.4"
+jinja2 = "^3.1.5"
 pytest = "^8.3.4"
-pytest-asyncio = "^0.24.0"
+pytest-asyncio = "^0.25.2"
 pytest-nhsd-apim = "^3.4.3"
 
 [tool.poetry.scripts]

proxies/sandbox/apiproxy/targets/sandbox.xml

@@ -1,6 +1,6 @@
 FROM node:18.3.0-alpine3.14
 
-ENV npm_config_cache /home/node/app/.npm
+ENV npm_config_cache=/home/node/app/.npm
 
 WORKDIR /app
 

pyproject.toml

@@ -4,16 +4,24 @@ 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 = {}
   }
 
+  // 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"]
   }
-  response.headers["X-Request-ID"] = '58621d65-d5ad-4c3a-959f-0438e355990e-1'
+
+  if (!request.path.includes("/ObjectStore")) {
+    response.headers["X-Request-ID"] = '58621d65-d5ad-4c3a-959f-0438e355990e-1'
+  }
 }
 
 const preResponse = function (request, h) {