Merge pull request #61 from NHSDigital/mm-set-content-length-0-on-initial-request-timeout

apm: set content-length=0 for errors with no response stream

Author: matt-mercer

docker/async-slowapp/src/app.js

@@ -120,7 +120,7 @@ const handlers = require("./handlers");
 app.use(before_request);
 app.get("/_ping", handlers.ping);
 app.get("/_status", handlers.ping);
-app.get("/slow", handlers.slow);
+app.all("/slow", handlers.slow);
 app.delete("/poll", handlers.delete_poll);
 app.get("/poll", handlers.poll);
 app.get("/sub/_ping", handlers.ping);

docker/async-slowapp/src/app.spec.js

@@ -213,6 +213,45 @@ describe("express with async-slowapp with /sub", function () {
             });
     });
 
+    it("responds to post /slow with a content-location and poll count increments", (done) => {
+        let content_location;
+        request(server)
+            .post("/slow?complete_in=0.01&final_status=418")
+            .send({test: "bob"})
+            .expect("Content-Type", /json/)
+            .expect(res => {
+                let headers = res.res.rawHeaders.asMultiValue();
+                assert.isTrue(headers.has('content-location'));
+                content_location = headers['content-location'];
+                let cookies = headers.cookies("set-cookie");
+                assert.isDefined(cookies["poll-count"]);
+                let poll_count = parseInt(cookies["poll-count"].split(";")[0].split("=")[1]);
+                assert.equal(poll_count, 0);
+            })
+            .expect(202)
+            .end(async (err)=>{
+                if (err) {
+                    return done(err);
+                }
+                await sleep(500);
+                let url = new URL(content_location);
+                request(server)
+                    .get(url.pathname + url.search)
+                    .set("Cookie", "poll-count=0")
+                    .expect(res => {
+                        if (err) {
+                            return done(err);
+                        }
+                        let headers = res.res.rawHeaders.asMultiValue();
+                        assert.isFalse(headers.has('content-location'));
+                        let cookies = headers.cookies("set-cookie");
+                        assert.isDefined(cookies["poll-count"]);
+                        let poll_count = parseInt(cookies["poll-count"].split(";")[0].split("=")[1]);
+                        assert.equal(poll_count, 1);
+                    })
+                    .expect(418, done)
+            });
+    });
 
     it("responds to /sub/poll continues with correct location", (done) => {
         let content_location;

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

@@ -109,6 +109,21 @@ describe("express with slowap", function () {
             .get("/slow?delay=5")
             .set("x-sync-wait", "0.25")
             .set("Accept", "application/json")
+            .expect(res => {
+                assert.equal(res.header['content-length'], "0");
+            })
+            .expect(504, done);
+    }).timeout(10000);
+
+    it("when posting it times out if x-sync-wait shorter than initial response", (done) => {
+        request(server)
+            .post("/slow?delay=5")
+            .send({test: 'data'})
+            .set("x-sync-wait", "0.25")
+            .set("Accept", "application/json")
+            .expect(res => {
+                assert.equal(res.header['content-length'], "0");
+            })
             .expect(504, done);
     }).timeout(10000);
 

docker/sync-wrap/src/handlers.js

@@ -302,6 +302,7 @@ async function proxy(req, res, next) {
         }
 
         if (response_stream === undefined) {
+            res.set('content-length', 0)
             res.end();
             next(error);
             return
@@ -518,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: headers, error: fin.error || fin});
+            await send_response(fin.error === "timeout" ? 504 : 502, {headers: undefined, error: fin.error || fin});
         });
 
 }

e2e/tests/api_tests.py

@@ -65,8 +65,9 @@ async def is_deployed(resp: ClientResponse):
             return False
 
         backend = dict_path(body, ["checks", "healthcheck", "outcome", "version"])
-        if not backend:
-            return True
+    
+        if type(backend) != dict:
+            return False
 
         return backend.get("commitId") == api_test_config.commit_id