Merge pull request #297 from elementar/augmented-test-utils

Patch to treat unhandled rejections as test failures

Author: pleerock

src/driver/express/ExpressDriver.ts

@@ -150,6 +150,14 @@ export class ExpressDriver extends BaseDriver {
         // prepare route and route handler function
         const route = ActionMetadata.appendBaseRoute(this.routePrefix, actionMetadata.fullRoute);
         const routeHandler = function routeHandler(request: any, response: any, next: Function) {
+            // Express calls the "get" route automatically when we call the "head" route:
+            // Reference: https://expressjs.com/en/4x/api.html#router.METHOD
+            // This causes a double action execution on our side, which results in an unhandled rejection,
+            // saying: "Can't set headers after they are sent".
+            // The following line skips action processing when the request method does not match the action method.
+            if (request.method.toLowerCase() !== actionMetadata.type)
+                return next();
+
             return executeCallback({request, response, next});
         };
 

test/functional/test-utils.ts

@@ -13,16 +13,37 @@ export function assertRequest(ports: number[],
 
     ports.forEach(port => {
 
-        it("asserting port " + port, () => {
-            if (args === 4) {
-                return chakram[method](`http://127.0.0.1:${port}/${route}`).then(dataOrCallback as Function);
-            } else if (args === 5) {
-                return chakram[method](`http://127.0.0.1:${port}/${route}`, dataOrCallback as any).then(dataOrRequestOptionsOrCallback as Function);
-            } else if (args === 6) {
-                return chakram[method](`http://127.0.0.1:${port}/${route}`, dataOrCallback as any, dataOrRequestOptionsOrCallback as any).then(maybeCallback);
+        it("asserting port " + port, async() => {
+            let unhandledRejection: Error = undefined;
+            const captureRejection = (e: Error) => { unhandledRejection = e; };
+            process.on("unhandledRejection", captureRejection);
+
+            try {
+                let r;
+                if (args === 4) {
+                    r = await chakram[method](`http://127.0.0.1:${port}/${route}`).then(dataOrCallback as Function);
+                }
+                else if (args === 5) {
+                    r = await chakram[method](`http://127.0.0.1:${port}/${route}`, dataOrCallback as any).then(dataOrRequestOptionsOrCallback as Function);
+                }
+                else if (args === 6) {
+                    r = await chakram[method](`http://127.0.0.1:${port}/${route}`, dataOrCallback as any, dataOrRequestOptionsOrCallback as any).then(maybeCallback);
+                }
+                else {
+                    throw new Error("No assertion has been performed");
+                }
+
+                if (unhandledRejection) {
+                    const e = new Error("There was an unhandled rejection while processing the request");
+                    e.stack += "\nCaused by: " + unhandledRejection.stack;
+                    throw e;
+                }
+
+                return r;
+            }
+            finally {
+                process.removeListener("unhandledRejection", captureRejection);
             }
-            
-            throw new Error("No assertion has been performed");
         });
 
     });