Merge branch 'master' into next

Author: MichalLytek

CHANGELOG.md

@@ -7,6 +7,15 @@
 - enhance params normalization - converting from string to primitive types is now more strict and can throw ParamNormalizationError,
 e.g. when number is expected but the invalid string (NaN) has been received  (#289)
 
+### 0.7.3
+
+- FIXED: Directly calling response bug - #286
+- FIXED: Missing parameter in @BodyParam error message - #284
+- FIXED: Sync and async auth checker bug - #283
+- FIXED: Handling different content-type responses in JsonController - #277
+- ADDED: Support for returning Buffer and streams from action handler (controller's method) - #285
+- ADDED: Custom driver support - #276
+
 ### 0.7.2
 
 - FIXED: Using `@Authorization` decorator with Koa caused 404 responses (ref [#240](https://github.com/pleerock/routing-controllers/pull/240))

README.md

@@ -246,7 +246,8 @@ export class UserController {
 
 #### Using Request and Response objects
 
-You can use framework's request and response objects this way:
+You can use framework's request and response objects directly. If you want to handle the response by yourself,
+just make sure you return the response object itself from the action.
 
 ```typescript
 import {Controller, Req, Res, Get} from "routing-controllers";
@@ -256,7 +257,7 @@ export class UserController {
 
     @Get("/users")
     getAll(@Req() request: any, @Res() response: any) {
-        response.send("Hello response!");
+        return response.send("Hello response!");
     }
 
 }
@@ -274,7 +275,7 @@ export class UserController {
 
     @Get("/users")
     getAll(@Req() request: Request, @Res() response: Response) {
-        response.send("Hello response!");
+        return response.send("Hello response!");
     }
 
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "routing-controllers",
   "private": true,
-  "version": "0.8.0-beta.1",
+  "version": "0.8.0",
   "description": "Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage for Express / Koa using TypeScript.",
   "license": "MIT",
   "readmeFilename": "README.md",

src/driver/express/ExpressDriver.ts

@@ -2,7 +2,6 @@ import {UseMetadata} from "../../metadata/UseMetadata";
 import {MiddlewareMetadata} from "../../metadata/MiddlewareMetadata";
 import {ActionMetadata} from "../../metadata/ActionMetadata";
 import {Action} from "../../Action";
-import {classToPlain} from "class-transformer";
 import {ParamMetadata} from "../../metadata/ParamMetadata";
 import {BaseDriver} from "../BaseDriver";
 import {ExpressMiddlewareInterface} from "./ExpressMiddlewareInterface";
@@ -12,7 +11,8 @@ import {AuthorizationCheckerNotDefinedError} from "../../error/AuthorizationChec
 import {isPromiseLike} from "../../util/isPromiseLike";
 import {getFromContainer} from "../../container";
 import {AuthorizationRequiredError} from "../../error/AuthorizationRequiredError";
-import { NotFoundError } from "../../index";
+import {NotFoundError} from "../../index";
+
 const cookie = require("cookie");
 const templateUrl = require("template-url");
 
@@ -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))
@@ -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});
         };
 
@@ -230,12 +238,21 @@ 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);
 
         // set http status code
-        if (result === undefined && action.undefinedResultCode && action.undefinedResultCode instanceof Function) {
-            throw new (action.undefinedResultCode as any)(options);
+        if (result === undefined && action.undefinedResultCode) {
+            if (action.undefinedResultCode instanceof Function) {
+                throw new (action.undefinedResultCode as any)(options);
+            }
+            options.response.status(action.undefinedResultCode);
         }
         else if (result === null) {
             if (action.nullResultCode) {
@@ -284,11 +301,18 @@ export class ExpressDriver extends BaseDriver {
             });
         }
         else if (result === undefined) { // throw NotFoundError on undefined response
-            const notFoundError = new NotFoundError();
+
             if (action.undefinedResultCode) {
-                notFoundError.httpCode = action.undefinedResultCode as number;
+                if (action.isJsonTyped) {
+                    options.response.json();
+                } else {
+                    options.response.send();
+                }
+                options.next();
+
+            } else {
+                throw new NotFoundError();
             }
-            throw notFoundError;
         }
         else if (result === null) { // send null response
             if (action.isJsonTyped) {

src/driver/koa/KoaDriver.ts

@@ -4,15 +4,15 @@ import {BaseDriver} from "../BaseDriver";
 import {MiddlewareMetadata} from "../../metadata/MiddlewareMetadata";
 import {ParamMetadata} from "../../metadata/ParamMetadata";
 import {UseMetadata} from "../../metadata/UseMetadata";
-import {classToPlain} from "class-transformer";
 import {KoaMiddlewareInterface} from "./KoaMiddlewareInterface";
 import {AuthorizationCheckerNotDefinedError} from "../../error/AuthorizationCheckerNotDefinedError";
 import {AccessDeniedError} from "../../error/AccessDeniedError";
 import {isPromiseLike} from "../../util/isPromiseLike";
 import {getFromContainer} from "../../container";
 import {RoleChecker} from "../../RoleChecker";
 import {AuthorizationRequiredError} from "../../error/AuthorizationRequiredError";
-import { NotFoundError, HttpError } from "../../index";
+import {HttpError, NotFoundError} from "../../index";
+
 const cookie = require("cookie");
 const templateUrl = require("template-url");
 
@@ -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,21 +213,14 @@ 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)) {
+            return options.next();
+        }
+
         // transform result if needed
         result = this.transformResult(result, action, options);
 
-        // set http status code
-        if (result === undefined && action.undefinedResultCode && action.undefinedResultCode instanceof Function) {
-            throw new (action.undefinedResultCode as any)(options);
-        } 
-        else if (result === null && action.nullResultCode) {
-            if (action.nullResultCode instanceof Function) {
-                throw new (action.nullResultCode as any)(options);
-            }
-        } 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,32 +231,24 @@ 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);
             });
         }
         else if (result === undefined) { // throw NotFoundError on undefined response
-            const notFoundError = new NotFoundError();
-            if (action.undefinedResultCode) {
-                notFoundError.httpCode = action.undefinedResultCode as number;
+            if (action.undefinedResultCode instanceof Function) {
+                throw new (action.undefinedResultCode as any)(options);
+
+            } else if (!action.undefinedResultCode) {
+                throw new NotFoundError();
             }
-            throw notFoundError;
         }
         else if (result === null) { // send null response
-            if (action.isJsonTyped) {
-                options.response.body = null;
-            } else {
-                options.response.body = null;
-            }
-            
-            // Setting `null` as a `response.body` means to koa that there is no content to return
-            // so we must reset the status codes here.
-            if (action.nullResultCode) {
-                options.response.status = action.nullResultCode;
-            } else {
-                options.response.status = 204;
-            }
+            if (action.nullResultCode instanceof Function)
+                throw new (action.nullResultCode as any)(options);
+
+            options.response.body = null;
         }
         else if (result instanceof Uint8Array) { // check if it's binary data (typed array)
             options.response.body = Buffer.from(result as any);
@@ -275,7 +260,22 @@ export class KoaDriver extends BaseDriver {
                 options.response.body = result;
             }
         }
-        
+
+        // set http status code
+        if (result === undefined && action.undefinedResultCode) {
+            console.log(action.undefinedResultCode);
+            options.response.status = action.undefinedResultCode;
+        }
+        else if (result === null && action.nullResultCode) {
+            options.response.status = action.nullResultCode;
+
+        } else if (action.successHttpCode) {
+            options.response.status = action.successHttpCode;
+
+        } else if (options.response.body === null) {
+            options.response.status = 204;
+        }
+
         // apply http headers
         Object.keys(action.headers).forEach(name => {
             options.response.set(name, action.headers[name]);
@@ -290,12 +290,6 @@ export class KoaDriver extends BaseDriver {
     handleError(error: any, action: ActionMetadata | undefined, options: Action) {
         return new Promise((resolve, reject) => {
             if (this.isDefaultErrorHandlingEnabled) {
-                // set http status
-                if (error instanceof HttpError && error.httpCode) {
-                    options.response.status = error.httpCode;
-                } else {
-                    options.response.status = 500;
-                }
 
                 // apply http headers
                 if (action) {
@@ -311,6 +305,13 @@ export class KoaDriver extends BaseDriver {
                     options.response.body = this.processTextError(error);
                 }
 
+                // set http status
+                if (error instanceof HttpError && error.httpCode) {
+                    options.response.status = error.httpCode;
+                } else {
+                    options.response.status = 500;
+                }
+
                 return resolve();
             }
             return reject(error);

src/util/importClassesFromDirectories.ts

@@ -10,7 +10,7 @@ export function importClassesFromDirectories(directories: string[], formats = ["
             allLoaded.push(exported);
         } else if (exported instanceof Array) {
             exported.forEach((i: any) => loadFileClasses(i, allLoaded));
-        } else if (exported instanceof Object || typeof exported === 'object') {
+        } else if (exported instanceof Object || typeof exported === "object") {
             Object.keys(exported).forEach(key => loadFileClasses(exported[key], allLoaded));
         }
 

test/functional/action-params.spec.ts

@@ -6,6 +6,7 @@ import {assertRequest} from "./test-utils";
 import {User} from "../fakes/global-options/User";
 import {Controller} from "../../src/decorator/Controller";
 import {Get} from "../../src/decorator/Get";
+import {Ctx} from "../../src/decorator/Ctx";
 import {Req} from "../../src/decorator/Req";
 import {Res} from "../../src/decorator/Res";
 import {Param} from "../../src/decorator/Param";
@@ -107,6 +108,26 @@ describe("action parameters", () => {
                 return "<html><body>hello</body></html>";
             }
 
+            @Get("/users-direct")
+            getUsersDirect(@Res() response: any): any {
+                if (typeof response.send === "function")
+                    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; charset=utf-8";
+                    response.body = "hi, I was written directly to the response";
+                    return response;
+                }
+            }
+
+            @Get("/users-direct/ctx")
+            getUsersDirectKoa(@Ctx() ctx: any): any {
+                ctx.response.status = 201;
+                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")
             getUser(@Param("userId") userId: number) {
                 paramUserId = userId;
@@ -383,6 +404,22 @@ describe("action parameters", () => {
         });
     });
 
+    describe("writing directly to the response using @Res should work", () => {
+        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 => {
+            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");
+        });
+    });
+
     describe("@Param should give a param from route", () => {
         assertRequest([3001, 3002], "get", "users/1", response => {
             expect(paramUserId).to.be.equal(1);