apm-2006: log response headers properly and supress the x-powered-by header

Author: matt-mercer

azure/azure-build-pipeline.yml

@@ -31,21 +31,24 @@ extends:
     cache_steps:
       - task: s3-cache-action@1
         inputs:
-          key: 'node modules | ${{ variables.service_name }}/docker/async-slowapp/package-lock.json'
-          location: '${{ variables.service_name }}/docker/async-slowapp/node_modules'
+          key: 'node modules | ./docker/async-slowapp/package-lock.json'
+          location: './docker/async-slowapp/node_modules'
           debug: true
+          workingDirectory: '${{ variables.service_name }}'
         displayName: cache async-slowapp node modules
       - task: s3-cache-action@1
         inputs:
-          key: 'node modules | ${{ variables.service_name }}/docker/sync-wrap/package-lock.json'
-          location: '${{ variables.service_name }}/docker/sync-wrap/node_modules'
+          key: 'node modules | ./docker/sync-wrap/package-lock.json'
+          location: './docker/sync-wrap/node_modules'
           debug: true
+          workingDirectory: '${{ variables.service_name }}'
         displayName: cache sync-wrap node modules
       - task: s3-cache-action@1
         inputs:
-          key: 'poetry | ${{ variables.service_name }}/poetry.lock'
-          location: '${{ variables.service_name }}/.venv'
+          key: 'poetry | ./poetry.lock'
+          location: './.venv'
           debug: true
+          workingDirectory: '${{ variables.service_name }}'
         displayName: cache python dependencies
     test_steps:
       - bash: "make test-report"
@@ -54,6 +57,6 @@ extends:
       - task: PublishTestResults@2
         inputs:
           testResultsFormat: "JUnit"
-          testResultsFiles: "${{ variables.service_name }}/reports/tests/*.xml"
+          testResultsFiles: "./reports/tests/*.xml"
           failTaskOnFailedTests: true
         displayName: publish test report

azure/templates/e2e.yml

@@ -5,15 +5,18 @@ steps:
 
     - task: s3-cache-action@1
       inputs:
-        key: 'poetry | $(SERVICE_DIR)/poetry.lock'
-        location: '$(SERVICE_DIR)/.venv'
+        key: 'poetry | ./poetry.lock'
+        location: '.venv'
         debug: true
+        workingDirectory: $(SERVICE_DIR)
+      name: poetryCache
       displayName: cache python dependencies
 
     - bash: |
           make install-python
       workingDirectory: $(SERVICE_DIR)
-      displayName: Setup e2e tests
+      condition: ne(variables['poetryCache.cacheRestored'], 'true')
+      displayName: poetry install
 
     - bash: |
         export RELEASE_RELEASEID=$(Build.BuildId)
@@ -24,10 +27,10 @@ steps:
         make -C e2e ${{ parameters.test_type }}
 
       workingDirectory: $(SERVICE_DIR)
-      displayName: 'Run ${{ parameters.test_type }} Tests'
+      displayName: run ${{ parameters.test_type }} tests
 
     - task: PublishTestResults@2
-      displayName: 'Publish ${{ parameters.test_type }} Test Results'
+      displayName: publish ${{ parameters.test_type }} test results
       inputs:
           testResultsFiles: |
               $(SERVICE_DIR)/reports/${{ parameters.test_type }}.xml

docker/sync-wrap/src/app.js

@@ -36,7 +36,7 @@ function setup(options) {
     let https = app.locals.upstream.protocol === "https:";
 
     app.locals.conn = https ? require("https") : require("http");
-
+    app.disable('x-powered-by');
     let default_options = {
         host: app.locals.upstream.hostname,
         port: app.locals.upstream.port
@@ -117,7 +117,7 @@ function after_request(req, res, next) {
     if (log.getLevel()<2) {
         // debug
         log_entry.req.headers = (req.rawHeaders || []).asMultiValue();
-        log_entry.res.headers = (res.rawHeaders || []).asMultiValue();
+        log_entry.res.headers = res.getHeaders();
     }
     log.info(JSON.stringify(log_entry));
 

docker/sync-wrap/src/app.slowapp.spec.js

@@ -81,6 +81,9 @@ describe("express with slowap", function () {
     it("responds to /_status", (done) => {
         request(server)
             .get("/_status")
+            .expect(res => {
+                assert.isUndefined(res.header['x-powered-by']);
+            })
             .expect(200, {
                 status: "pass",
                 ping: "pong",
@@ -127,6 +130,19 @@ describe("express with slowap", function () {
             .expect(504, done);
     }).timeout(10000);
 
+    it("when patching it times out if x-sync-wait shorter than initial response", (done) => {
+        request(server)
+            .patch("/slow?delay=5")
+            .send({test: 'data'})
+            .set("x-sync-wait", "0.25")
+            .set("Accept", "application/json")
+            .expect(res => {
+                assert.isUndefined(res.header['x-powered-by']);
+                assert.equal(res.header['content-length'], "0");
+            })
+            .expect(504, done);
+    }).timeout(10000);
+
     it("slowapp default x-sync-wait final status 500", (done) => {
         request(server)
             .get("/slow?final_status=500&complete_in=0.5")

docker/sync-wrap/src/handlers.js

@@ -519,7 +519,7 @@ async function proxy(req, res, next) {
             await send_response(response.statusCode, {headers: headers, response: response});
         })
         .catch(async (fin) => {
-            await send_response(fin.error === "timeout" ? 504 : 502, {headers: undefined, error: fin.error || fin});
+            await send_response(fin.error === "timeout" ? 504 : 502, { error: fin.error || fin });
         });
 
 }

proxies/live/Makefile

@@ -10,7 +10,7 @@ build:
 	cp -r ./apiproxy ../../build/proxies/$(dirname)
 
 deploy: build
-	cd ../../build/$(dirname) && apigeetool deployproxy -V -o nhsd-nonprod -e internal-dev -n sync-wrap-local -t $$(get_token)
+	cd ../../build/proxies/$(dirname) && apigeetool deployproxy -V -o nhsd-nonprod -e internal-dev -n sync-wrap-local -t $$(get_token)
 
 undeploy:
 	apigeetool undeploy -V -o nhsd-nonprod -e internal-dev -n sync-wrap-local -t $$(get_token)

pyproject.toml

@@ -39,7 +39,6 @@ flake8 = "^3.7.9"
 black = "^19.10b0"
 pip-licenses = "^2.0.1"
 jinja2 = "^2.11.1"
-
 api-test-utils = {url = "https://github.com/NHSDigital/apim-test-utils/releases/download/v1.1.2-alpha/api_test_utils-1.1.2a0-py3-none-any.whl"}
 
 [tool.poetry.scripts]