Merge branch 'next' of https://github.com/pleerock/routing-controllers into next

Author: MichalLytek

CHANGELOG.md

@@ -1,29 +1,63 @@
 # Changelog and release notes
 
-### 0.8.0
+### 0.8.0 [BREAKING CHANGES]
+
+#### Features
 
 - extract generic `@Session()` deocorator into `@SessionParam()` and `@Session()`
-- restore/introduce `@QueryParams()` and `@Params()` missing decorators options (they are needed for validation purposes) - #289
-- normalize param object properties (for "queries", "headers", "params" and "cookies") - now you can easily validate query/path params using `class-validator` - #289
-- 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
+- restore/introduce `@QueryParams()` and `@Params()` missing decorators options (ref [#289][#289])
+- normalize param object properties (for "queries", "headers", "params" and "cookies"), with this change you can easily validate query/path params using `class-validator` (ref [#289][#289])
+- improved params normalization, converting to primitive types is now more strict and can throw ParamNormalizationError (e.g. when number is expected but an invalid string (NaN) has been received) (ref [#289][#289])
+
+### 0.7.7 (to be released)
+
+#### Features
+
+- feat(ErrorHandling): add support for custom toJSON method in errors (ref [#325][#325])
+
+#### Fixes
+
+- fixed inconsistent roles parameter in authorizationChecker (ref [#308][#308])
+
+### 0.7.6
+
+#### Fixes
+
+- fixed bugs with undefined result code behaviour
+
+### 0.7.5
+
+#### Fixes
+
+- fixed bugs with undefined result code behaviour
+
+### 0.7.4
+
+#### Fixes
+
+- fixed bugs with undefined result code behaviour
 
 ### 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
+#### Features
+
+- Support for returning Buffer and streams from action handler (controller's method) (ref [#285][#285])
+- Custom driver support (ref [#276][#276])
+
+#### Fixes
+
+- Directly calling response bug (ref [#286][#286])
+- Missing parameter in @BodyParam error message (ref [#284][#284])
+- Sync and async auth checker bug (ref (ref [#283][#283])
+- Handling different content-type responses in JsonController (ref [#277][#277])
 
 ### 0.7.2
 
-- FIXED: Using `@Authorization` decorator with Koa caused 404 responses (ref [#240](https://github.com/pleerock/routing-controllers/pull/240))
-- FIXED: Allow throwing custom errors in `authorizationChecker` (ref [#233](https://github.com/pleerock/routing-controllers/pull/233), ref [#247](https://github.com/pleerock/routing-controllers/pull/247))
-- FIXED: check auth permissions before accepting files for upload (ref [#251](https://github.com/pleerock/routing-controllers/pull/240))
+#### Fixes
 
-### 0.7.1
+- Using `@Authorization` decorator with Koa caused 404 responses (ref [#240][#240])
+- Allow throwing custom errors in `authorizationChecker` (ref [#233][#233])
+- check auth permissions before accepting files for upload (ref [#251][#251])
 
 ### 0.7.0 [BREAKING CHANGES]
 
@@ -33,8 +67,7 @@ e.g. when number is expected but the invalid string (NaN) has been received - #2
 - `MiddlewareInterface` was removed and instead `ExpressMiddlewareInterface` or `KoaMiddlewareInterface` should be used
 - `ExpressErrorMiddlewareInterface` was renamed into `ErrorMiddlewareInterface`
 - per-controller and per-action middlewares used in `@UseBefore` and `@UseAfter` now should not be marked with `@Middleware` decorator
-- `@MiddlewareGlobalBefore()` and `@MiddlewareGlobalAfter()` were removed and instead new signatures should be used: `@Middleware({ type: "before" })`
-and `@Middleware({ type: "after" })`
+- `@MiddlewareGlobalBefore()` and `@MiddlewareGlobalAfter()` were removed and instead new signatures should be used: `@Middleware({ type: "before" })` and `@Middleware({ type: "after" })`
 - named some decorator parameter names
 - added few new decorators to get all parameters like `@QueryParams`, `@Params`, `@HeaderParams` etc.
 - added `@Authorized` and `@CurrentUser` decorators
@@ -50,29 +83,55 @@ and `@Middleware({ type: "after" })`
 
 ### 0.6.10
 
-* added integration with `class-transform-validator` for deserialization and auto validation request parameters
+#### Features
+
+- added integration with `class-transform-validator` for deserialization and auto validation request parameters
 
 ### 0.6.2
 
-* made interceptors to support promises
+#### Features
+
+- made interceptors to support promises
 
 ### 0.6.1
 
+#### Features
+
 - added interceptors support
 
 ### 0.6.0 [BREAKING CHANGES]
 
+#### Features
+
 - middleware and error handlers support
 - everything packed into "routing-controllers" main export
-- removed parseJson from @Body decorator
-- removed ActionOptions
-- removed responseType from action options and added @JsonResponse and @TextResponse decorators
 - added few more new decorators
+
+#### Fixes
+
 - fixed multiple issues with param decorators
 - fixed multiple bugs
 - refactored core
 
+#### Removals
+
+- removed `parseJson` from `@Body` decorator
+- removed `ActionOptions`
+- removed `responseType` from action options and added `@JsonResponse` and `@TextResponse` decorators
+
 ### 0.5.0
 
 - renamed package from `controllers.ts` to `routing-controllers`
 - added integration with `constructor-utils` for serialization and deserialization
+
+[#325]: https://github.com/pleerock/routing-controllers/pull/325
+[#308]: https://github.com/pleerock/routing-controllers/pull/308
+[#286]: https://github.com/pleerock/routing-controllers/pull/286
+[#285]: https://github.com/pleerock/routing-controllers/pull/285
+[#284]: https://github.com/pleerock/routing-controllers/pull/284
+[#283]: https://github.com/pleerock/routing-controllers/pull/283
+[#277]: https://github.com/pleerock/routing-controllers/pull/277
+[#276]: https://github.com/pleerock/routing-controllers/pull/276
+[#251]: https://github.com/pleerock/routing-controllers/pull/251
+[#240]: https://github.com/pleerock/routing-controllers/pull/240
+[#233]: https://github.com/pleerock/routing-controllers/pull/233

README.md

@@ -295,7 +295,9 @@ import {useExpressServer} from "routing-controllers";
 let express = require("express"); // or you can import it if you have installed typings
 let app = express(); // your created express server
 // app.use() // you can configure it the way you want
-useExpressServer(app); // register created express server in routing-controllers
+useExpressServer(app, { // register created express server in routing-controllers
+    controllers: [UserController] // and configure it the way you need (controllers, validation, etc.)
+});
 app.listen(3000); // run your express server
 ```
 
@@ -724,7 +726,30 @@ There are set of prepared errors you can use:
 * NotFoundError
 * UnauthorizedError
 
-You can also create and use your own errors by extending `HttpError` class.
+
+You can also create and use your own errors by extending `HttpError` class.  
+To define the data returned to the client, you could define a toJSON method in your error.
+
+```typescript
+class DbError extends HttpError {
+    public operationName: string;
+    public args: any[];
+
+    constructor(operationName: string, args: any[] = []) {
+        super(500);
+        Object.setPrototypeOf(this, DbError.prototype);
+        this.operationName = operationName;
+        this.args = args; // can be used for internal logging
+    }
+
+    toJSON() {
+        return {
+            status: this.httpCode,
+            failedOperation: this.operationName
+        }
+    }
+}
+``` 
 
 #### Enable CORS
 

sample/sample6-global-middlewares/AllErrorsHandler.ts

@@ -1,12 +1,12 @@
 import {ExpressErrorMiddlewareInterface} from "../../src/driver/express/ExpressErrorMiddlewareInterface";
 import {Middleware} from "../../src/decorator/Middleware";
 
-@Middleware({ type: "before" })
+@Middleware({ type: "after" })
 export class AllErrorsHandler implements ExpressErrorMiddlewareInterface {
 
-    error(error: any, request: any, response: any, next?: Function): void {
+    error(error: any, request: any, response: any, next: Function): void {
         console.log("Error handled: ", error);
         next(error);
     }
 
-}
+}

src/driver/BaseDriver.ts

@@ -150,12 +150,14 @@ export abstract class BaseDriver {
         if (!this.isDefaultErrorHandlingEnabled)
             return error;
 
+        if (typeof error.toJSON === "function")
+            return error.toJSON();
+        
         let processedError: any = {};
         if (error instanceof Error) {
             const name = error.name && error.name !== "Error" ? error.name : error.constructor.name;
+            processedError.name = name;
 
-            if (name && (this.developmentMode || error.message)) // show name only if in debug mode and if error message exist too
-                processedError.name = name;
             if (error.message)
                 processedError.message = error.message;
             if (error.stack && this.developmentMode)

src/metadata/ActionMetadata.ts

@@ -207,7 +207,7 @@ export class ActionMetadata {
         this.headers = this.buildHeaders(responseHandlers);
 
         this.isAuthorizedUsed = this.controllerMetadata.isAuthorizedUsed || !!authorizedHandler;
-        this.authorizedRoles = (this.controllerMetadata.authorizedRoles || []).concat(authorizedHandler && authorizedHandler.value ? authorizedHandler.value : []);
+        this.authorizedRoles = (this.controllerMetadata.authorizedRoles || []).concat((authorizedHandler && authorizedHandler.value) || []);
     }
 
     // -------------------------------------------------------------------------

src/metadata/ControllerMetadata.ts

@@ -86,7 +86,7 @@ export class ControllerMetadata {
     build(responseHandlers: ResponseHandlerMetadata[]) {
         const authorizedHandler = responseHandlers.find(handler => handler.type === "authorized" && !handler.method);
         this.isAuthorizedUsed = !!authorizedHandler;
-        this.authorizedRoles = authorizedHandler ? authorizedHandler.value : [];
+        this.authorizedRoles = [].concat((authorizedHandler && authorizedHandler.value) || []);
     }
 
 }

test/functional/express-error-handling.spec.ts

@@ -6,6 +6,7 @@ import {Middleware} from "../../src/decorator/Middleware";
 import {UseAfter} from "../../src/decorator/UseAfter";
 import {ExpressErrorMiddlewareInterface} from "../../src/driver/express/ExpressErrorMiddlewareInterface";
 import {NotFoundError} from "../../src/http-error/NotFoundError";
+import {HttpError} from "../../src/http-error/HttpError";
 const chakram = require("chakram");
 const expect = chakram.expect;
 
@@ -54,6 +55,25 @@ describe("express error handling", () => {
 
         }
 
+        class ToJsonError extends HttpError {
+            public publicData: string;
+            public secretData: string;
+
+            constructor(httpCode: number, publicMsg?: string, privateMsg?: string) {
+                super(httpCode);
+                Object.setPrototypeOf(this, ToJsonError.prototype);
+                this.publicData = publicMsg || "public";
+                this.secretData = privateMsg || "secret";
+            }
+
+            toJSON() {
+                return {
+                    status: this.httpCode,
+                    publicData: `${this.publicData} (${this.httpCode})`
+                }
+            }
+        }
+
         @JsonController()
         class ExpressErrorHandlerController {
 
@@ -97,6 +117,11 @@ describe("express error handling", () => {
                 return "1234";
             }
 
+            @Get("/stories")
+            stories() {
+                throw new ToJsonError(503, "sorry, try it again later", "impatient user");
+            }
+
         }
     });
 
@@ -154,4 +179,15 @@ describe("express error handling", () => {
             });
     });
 
+    it("should process JsonErrors by their toJSON method if it exists", () => {
+        return chakram
+            .get("http://127.0.0.1:3001/stories")
+            .then((response: any) => {
+                expect(response).to.have.status(503);
+                expect(response.body).to.have.property("status").and.equals(503);
+                expect(response.body).to.have.property("publicData").and.equals("sorry, try it again later (503)");
+                expect(response.body).to.not.have.property("secretData");
+            });
+    });
+
 });