Detect manual handling of the response by returning the response itself

Author: fabiob

src/driver/express/ExpressDriver.ts

@@ -105,7 +105,7 @@ export class ExpressDriver extends BaseDriver {
                 const action: Action = { request, response, next };
                 try {
                     const checkResult = this.authorizationChecker(action, actionMetadata.authorizedRoles);
-    
+
                     const handleError = (result: any) => {
                         if (!result) {
                             let error = actionMetadata.authorizedRoles.length === 0 ? new AuthorizationRequiredError(action) : new AccessDeniedError(action);
@@ -114,7 +114,7 @@ export class ExpressDriver extends BaseDriver {
                             next();
                         }
                     };
-    
+
                     if (isPromiseLike(checkResult)) {
                         checkResult
                             .then(result => handleError(result))
@@ -230,6 +230,12 @@ export class ExpressDriver extends BaseDriver {
      */
     handleSuccess(result: any, action: ActionMetadata, options: Action): void {
 
+        // if the action returned the response object itself, short-circuits
+        if (result && result === options.response) {
+            options.next();
+            return;
+        }
+
         // transform result if needed
         result = this.transformResult(result, action, options);
 

src/driver/koa/KoaDriver.ts

@@ -81,7 +81,7 @@ export class KoaDriver extends BaseDriver {
                     const checkResult = actionMetadata.authorizedRoles instanceof Function ?
                         getFromContainer<RoleChecker>(actionMetadata.authorizedRoles).check(action) :
                         this.authorizationChecker(action, actionMetadata.authorizedRoles);
-    
+
                     const handleError = (result: any) => {
                         if (!result) {
                             let error = actionMetadata.authorizedRoles.length === 0 ? new AuthorizationRequiredError(action) : new AccessDeniedError(action);
@@ -90,7 +90,7 @@ export class KoaDriver extends BaseDriver {
                             return next();
                         }
                     };
-    
+
                     if (isPromiseLike(checkResult)) {
                         return checkResult
                             .then(result => handleError(result))
@@ -213,6 +213,12 @@ export class KoaDriver extends BaseDriver {
      */
     handleSuccess(result: any, action: ActionMetadata, options: Action): void {
 
+        // if the action returned the context or the response object itself, short-circuits
+        if (result && (result === options.response || result === options.context)) {
+            options.next();
+            return;
+        }
+
         // transform result if needed
         result = this.transformResult(result, action, options);
 
@@ -227,7 +233,7 @@ export class KoaDriver extends BaseDriver {
         } else if (action.successHttpCode) {
             options.response.status = action.successHttpCode;
         }
-        
+
         if (action.redirect) { // if redirect is set then do it
             if (typeof result === "string") {
                 options.response.redirect(result);
@@ -238,7 +244,7 @@ export class KoaDriver extends BaseDriver {
             }
         } else if (action.renderedTemplate) { // if template is set then render it // TODO: not working in koa
             const renderOptions = result && result instanceof Object ? result : {};
-            
+
             this.koa.use(async function (ctx: any, next: any) {
                 await ctx.render(action.renderedTemplate, renderOptions);
             });
@@ -275,7 +281,7 @@ export class KoaDriver extends BaseDriver {
                 options.response.body = result;
             }
         }
-        
+
         // apply http headers
         Object.keys(action.headers).forEach(name => {
             options.response.set(name, action.headers[name]);

test/functional/action-params.spec.ts

@@ -89,22 +89,24 @@ describe("action parameters", () => {
                 return "<html><body>hello</body></html>";
             }
 
-            @Get("/users/direct")
-            getUsersDirectExpress(@Res() response: any): any {
+            @Get("/users-direct")
+            getUsersDirect(@Res() response: any): any {
                 if (typeof response.send === "function")
-                    response.status(201).contentType("custom/x-sample").send("hi, I was written directly to the response");
+                    return response.status(201).contentType("custom/x-sample").send("hi, I was written directly to the response");
                 else {
                     response.status = 201;
-                    response.type = "custom/x-sample";
+                    response.type = "custom/x-sample; charset=utf-8";
                     response.body = "hi, I was written directly to the response";
+                    return response;
                 }
             }
 
-            @Get("/users/direct/ctx")
+            @Get("/users-direct/ctx")
             getUsersDirectKoa(@Ctx() ctx: any): any {
                 ctx.response.status = 201;
-                ctx.response.type = "custom/x-sample";
+                ctx.response.type = "custom/x-sample; charset=utf-8";
                 ctx.response.body = "hi, I was written directly to the response using Koa Ctx";
+                return ctx;
             }
 
             @Get("/users/:userId")
@@ -366,15 +368,15 @@ describe("action parameters", () => {
     });
 
     describe("writing directly to the response using @Res should work", () => {
-        assertRequest([3001, 3002], "get", "users/direct", response => {
+        assertRequest([3001, 3002], "get", "users-direct", response => {
             expect(response).to.be.status(201);
             expect(response.body).to.be.equal("hi, I was written directly to the response");
             expect(response).to.have.header("content-type", "custom/x-sample; charset=utf-8");
         });
     });
 
     describe("writing directly to the response using @Ctx should work", () => {
-        assertRequest([3002], "get", "users/direct/ctx", response => {
+        assertRequest([3002], "get", "users-direct/ctx", response => {
             expect(response).to.be.status(201);
             expect(response.body).to.be.equal("hi, I was written directly to the response using Koa Ctx");
             expect(response).to.have.header("content-type", "custom/x-sample; charset=utf-8");