fix(controller): Use the same controller context for routes inside a controller (#187)

Fixes #173. Fixes the typing errors with the decorators.
Use the same context (controller instance) for all routes in
a given Controller.

Author: buehler

config/tsconfig.base.json

@@ -9,7 +9,7 @@
         "declaration": true,
         "sourceMap": false,
         "importHelpers": true,
-        "strictNullChecks": true,
+        "strict": true,
         "experimentalDecorators": true,
         "emitDecoratorMetadata": true,
         "noUnusedLocals": true,

src/Giuseppe.ts

@@ -41,6 +41,7 @@ const routeScore = (route: RouteRegisterInformation) =>
 export interface RouteRegisterInformation {
     route: GiuseppeRoute;
     ctrl: Function;
+    instance: object;
     segments: number;
     wildcards: number;
     urlParams: number;
@@ -98,11 +99,11 @@ export class Giuseppe {
     protected routes: { [id: string]: RouteRegisterInformation } = {};
     protected _server: Server | undefined;
 
-    protected _returnTypes: ReturnType<any>[] | null;
-    protected _pluginController: ControllerDefinitionConstructor[] | null;
-    protected _pluginRoutes: RouteDefinitionConstructor[] | null;
-    protected _pluginRouteModificators: RouteModificatorConstructor[] | null;
-    protected _pluginParameters: ParameterDefinitionConstructor[] | null;
+    protected _returnTypes: ReturnType<any>[] | null = null;
+    protected _pluginController: ControllerDefinitionConstructor[] | null = null;
+    protected _pluginRoutes: RouteDefinitionConstructor[] | null = null;
+    protected _pluginRouteModificators: RouteModificatorConstructor[] | null = null;
+    protected _pluginParameters: ParameterDefinitionConstructor[] | null = null;
 
     /**
      * List of registered {@link ReturnType}.
@@ -344,6 +345,8 @@ export class Giuseppe {
                 ctrlRoutes = ctrlRoutes.concat(modifiedRoutes);
             }
 
+            const ctrlInstance = new (ctrl.ctrlTarget as { new(...args: any[]): any; })();
+
             for (const route of ctrlRoutes) {
                 if (this.routes[route.id]) {
                     throw new DuplicateRouteError(route);
@@ -354,6 +357,7 @@ export class Giuseppe {
                     wildcards: route.url.split('*').length - 1,
                     urlParams: route.url.split('/').filter(s => s.indexOf(':') >= 0).length,
                     ctrl: ctrl.ctrlTarget,
+                    instance: ctrlInstance,
                 };
             }
         }
@@ -363,7 +367,7 @@ export class Giuseppe {
         Object.keys(this.routes)
             .map(k => this.routes[k])
             .sort((a, b) => routeScore(b) - routeScore(a))
-            .forEach(r => this.router[HttpMethod[r.route.method]](
+            .forEach(r => (this.router as any)[HttpMethod[r.route.method]](
                 `/${r.route.url}`,
                 ...r.route.middlewares,
                 this.createRouteWrapper(r),
@@ -385,7 +389,6 @@ export class Giuseppe {
         const meta = new ControllerMetadata(routeInfo.ctrl.prototype);
         const params = meta.parameters(routeInfo.route.name);
         const returnTypeHandler = new ReturnTypeHandler(this.returnTypes);
-        const ctrlInstance = new (routeInfo as any).ctrl();
 
         return async (req: express.Request, res: express.Response) => {
             const paramValues: any[] = [];
@@ -395,7 +398,7 @@ export class Giuseppe {
                     paramValues[param.index] = param.getValue(req, res);
                 }
 
-                let result = routeInfo.route.function.apply(ctrlInstance, paramValues);
+                let result = routeInfo.route.function.apply(routeInfo.instance, paramValues);
 
                 if (result instanceof Promise) {
                     result = await result;
@@ -407,7 +410,7 @@ export class Giuseppe {
 
                 returnTypeHandler.handleValue(result, res);
             } catch (e) {
-                meta.errorHandler().handleError(ctrlInstance, req, res, e);
+                meta.errorHandler().handleError(routeInfo.instance, req, res, e);
             }
         };
     }

src/controller/ControllerDefinition.ts

@@ -5,14 +5,14 @@ import { GiuseppeRoute } from '../routes/GiuseppeRoute';
 /**
  * Interface for a controller definition. Contains the targeted function (class) and containing middlewares.
  * The definition must be able to create the routes that are registered within the controller.
- * 
+ *
  * @export
  * @interface ControllerDefinition
  */
 export interface ControllerDefinition {
     /**
      * The target class that is decorated with the controller decorator.
-     * 
+     *
      * @type {Function}
      * @memberof ControllerDefinition
      */
@@ -21,17 +21,17 @@ export interface ControllerDefinition {
     /**
      * A collection of middlewares that is contained in the given controller.
      * Middleware priority is: Controller -> Route (they are concatenated).
-     * 
+     *
      * @type {RequestHandler[]}
      * @memberof ControllerDefinition
      */
     readonly middlewares: RequestHandler[];
 
     /**
      * A function that creates the routes for a given controller. Those routes are then modificated and registered.
-     * 
-     * @param {string} baseUrl 
-     * @returns {GiuseppeRoute[]} 
+     *
+     * @param {string} baseUrl
+     * @returns {GiuseppeRoute[]}
      * @memberof ControllerDefinition
      */
     createRoutes(baseUrl: string): GiuseppeRoute[];

src/core/controller/GiuseppeApiController.ts

@@ -11,7 +11,7 @@ import { UrlHelper } from '../../utilities/UrlHelper';
 /**
  * Controller decorator. Creates a {@link GiuseppeApiController} that is registered within {@link Giuseppe}.
  * All controllers are later used to generate their routes.
- * 
+ *
  * @export
  * @param {(string | RequestHandler)} [routePrefixOrMiddleware] It's either a middleware (if no route prefix is used) or a
  *                                                              string that contains the routeprefix for this controller.
@@ -35,7 +35,7 @@ import { UrlHelper } from '../../utilities/UrlHelper';
  */
 export function Controller(
     routePrefixOrMiddleware?: string | RequestHandler,
-    ...middlewares: RequestHandler[],
+    ...middlewares: RequestHandler[]
 ): ClassDecorator {
     const routePrefix = routePrefixOrMiddleware && typeof routePrefixOrMiddleware === 'string' ?
         routePrefixOrMiddleware :
@@ -50,7 +50,7 @@ export function Controller(
 
 /**
  * Default core controller of giuseppe. Contains the routes and generates them on "configureRouter()" of giuseppe.
- * 
+ *
  * @export
  * @class GiuseppeApiController
  * @implements {ControllerDefinition}

src/core/parameters/Body.ts

@@ -10,10 +10,10 @@ import { ParameterFactory, ParameterValidator } from './ParameterAdditions';
 /**
  * Parameter decorator. Creates a parameter decorator that is registered on that route. Can
  * contain a type factory and multiple validators.
- * 
+ *
  * @export
- * @param {{ validator?: ParameterValidator, factory?: ParameterFactory<any> }} [{ validator, factory } = {}] 
- * @returns {ParameterDecorator} 
+ * @param {{ validator?: ParameterValidator, factory?: ParameterFactory<any> }} [{ validator, factory } = {}]
+ * @returns {ParameterDecorator}
  */
 export function Body(
     {
@@ -22,12 +22,12 @@ export function Body(
         factory,
     }: { required?: boolean, validator?: ParameterValidator, factory?: ParameterFactory<any> } = {},
 ): ParameterDecorator {
-    return (target: Object, propertyKey: string, parameterIndex: number) =>
+    return (target: Object, propertyKey: string | symbol, parameterIndex: number) =>
         Giuseppe.registrar.registerParameter(
             target,
-            propertyKey,
+            propertyKey.toString(),
             new GiuseppeBodyParameter(
-                new ControllerMetadata(target).parameterTypes(propertyKey)[parameterIndex],
+                new ControllerMetadata(target).parameterTypes(propertyKey.toString())[parameterIndex],
                 parameterIndex,
                 required,
                 validator,
@@ -38,7 +38,7 @@ export function Body(
 
 /**
  * Default core body parameter of giuseppe. Injects Request.body into the route.
- * 
+ *
  * @export
  * @class GiuseppeBodyParameter
  * @extends {GiuseppeBaseParameter}

src/core/parameters/Cookie.ts

@@ -9,7 +9,7 @@ import { ParameterFactory, ParameterValidator } from './ParameterAdditions';
 
 /**
  * Class that splits cookie values into their specific parts.
- * 
+ *
  * @class CookieHelper
  */
 class CookieHelper {
@@ -26,15 +26,15 @@ class CookieHelper {
 /**
  * Parameter decorator. Creates a parameter definition that injects a specific cookie from the request.
  * Can contain validators and a factory if the value is complex.
- * 
+ *
  * @export
  * @param {string} name Name of the cookie.
  * @param {{ required?: boolean, validator?: ParameterValidator, factory?: ParameterFactory<any> }} [{
  *         required,
  *         validator,
  *         factory,
  *     }={}] Configuration object for the cookie parameter.
- * @returns {ParameterDecorator} 
+ * @returns {ParameterDecorator}
  */
 export function Cookie(
     name: string,
@@ -44,13 +44,13 @@ export function Cookie(
         factory,
     }: { required?: boolean, validator?: ParameterValidator, factory?: ParameterFactory<any> } = {},
 ): ParameterDecorator {
-    return (target: Object, propertyKey: string, parameterIndex: number) =>
+    return (target: Object, propertyKey: string | symbol, parameterIndex: number) =>
         Giuseppe.registrar.registerParameter(
             target,
-            propertyKey,
+            propertyKey.toString(),
             new GiuseppeCookieParameter(
                 name,
-                new ControllerMetadata(target).parameterTypes(propertyKey)[parameterIndex],
+                new ControllerMetadata(target).parameterTypes(propertyKey.toString())[parameterIndex],
                 parameterIndex,
                 required,
                 validator,
@@ -61,7 +61,7 @@ export function Cookie(
 
 /**
  * Default core cookie parameter of giuseppe. Injects the value of a specific cookie from the request.
- * 
+ *
  * @export
  * @class GiuseppeCookieParameter
  * @extends {GiuseppeBaseParameter}

src/core/parameters/GiuseppeBaseParameter.ts

@@ -52,7 +52,7 @@ export abstract class GiuseppeBaseParameter implements ParameterDefinition {
         if (this.factory) {
             factory = this.factory;
         } else {
-            factory = rawValue => {
+            factory = (rawValue: any) => {
                 const ctor = this.type as any;
                 if (rawValue.constructor === ctor) {
                     return rawValue;
@@ -76,7 +76,7 @@ export abstract class GiuseppeBaseParameter implements ParameterDefinition {
         if (!this.validator || (!this.required && (parsed === undefined || parsed === null))) {
             return;
         }
-        const isValid = value => {
+        const isValid = (value: any) => {
             const predicates = this.validator;
 
             if (Array.isArray(predicates)) {

src/core/parameters/Header.ts

@@ -10,15 +10,15 @@ import { ParameterFactory, ParameterValidator } from './ParameterAdditions';
 /**
  * Parameter decorator. Creates a parameter definition that injects a specific header value from the request.
  * Can contain validators and a factory if the value is complex.
- * 
+ *
  * @export
- * @param {string} name 
+ * @param {string} name
  * @param {{ required?: boolean, validator?: ParameterValidator, factory?: ParameterFactory<any> }} [{
  *         required,
  *         validator,
  *         factory,
- *     }={}] 
- * @returns {ParameterDecorator} 
+ *     }={}]
+ * @returns {ParameterDecorator}
  */
 export function Header(
     name: string,
@@ -28,13 +28,13 @@ export function Header(
         factory,
     }: { required?: boolean, validator?: ParameterValidator, factory?: ParameterFactory<any> } = {},
 ): ParameterDecorator {
-    return (target: Object, propertyKey: string, parameterIndex: number) =>
+    return (target: Object, propertyKey: string | symbol, parameterIndex: number) =>
         Giuseppe.registrar.registerParameter(
             target,
-            propertyKey,
+            propertyKey.toString(),
             new GiuseppeHeaderParameter(
                 name,
-                new ControllerMetadata(target).parameterTypes(propertyKey)[parameterIndex],
+                new ControllerMetadata(target).parameterTypes(propertyKey.toString())[parameterIndex],
                 parameterIndex,
                 required,
                 validator,
@@ -45,7 +45,7 @@ export function Header(
 
 /**
  * Default core header parameter of giuseppe. Injects a specific header value into the route.
- * 
+ *
  * @export
  * @class GiuseppeHeaderParameter
  * @extends {GiuseppeBaseParameter}

src/core/parameters/ParameterAdditions.ts

@@ -62,15 +62,15 @@ export function isNumber({ min, max, multipleOf }: { min?: number, max?: number,
             return false;
         }
 
-        if (!isNullOrUndefined(min) && value < min) {
+        if (!isNullOrUndefined(min) && value < min!) {
             return false;
         }
 
-        if (!isNullOrUndefined(max) && value > max) {
+        if (!isNullOrUndefined(max) && value > max!) {
             return false;
         }
 
-        return !(!isNullOrUndefined(multipleOf) && value % multipleOf !== 0);
+        return !(!isNullOrUndefined(multipleOf) && value % multipleOf! !== 0);
     };
 }
 
@@ -93,11 +93,11 @@ export function isArray(
             return false;
         }
 
-        if (!isNullOrUndefined(min) && value.length < min) {
+        if (!isNullOrUndefined(min) && value.length < min!) {
             return false;
         }
 
-        if (!isNullOrUndefined(max) && value.length > max) {
+        if (!isNullOrUndefined(max) && value.length > max!) {
             return false;
         }
 

src/core/parameters/Query.ts

@@ -9,7 +9,7 @@ import { ParameterFactory, ParameterValidator } from './ParameterAdditions';
 
 /**
  * @typedef QueryConfigObject
- 
+
  * @property {string | string[]} [alias]
  * @property {boolean} [required]
  * @property {ParameterValidator} [validator]
@@ -20,11 +20,11 @@ import { ParameterFactory, ParameterValidator } from './ParameterAdditions';
  * Parameter decorator. Creates a parameter definition that injects a query parameter value from the request.
  * Can contain validators and a factory if the value is complex. If an alias is defined, the alias(es)
  * will be used to determine a value other than the given name.
- * 
+ *
  * @export
- * @param {string} name 
+ * @param {string} name
  * @param {QueryConfigObject} [{alias, required, validator, factory}={}]
- * @returns {ParameterDecorator} 
+ * @returns {ParameterDecorator}
  */
 export function Query(
     name: string,
@@ -41,13 +41,13 @@ export function Query(
             factory?: ParameterFactory<any>,
         } = {},
 ): ParameterDecorator {
-    return (target: Object, propertyKey: string, parameterIndex: number) =>
+    return (target: Object, propertyKey: string | symbol, parameterIndex: number) =>
         Giuseppe.registrar.registerParameter(
             target,
-            propertyKey,
+            propertyKey.toString(),
             new GiuseppeQueryParameter(
                 name,
-                new ControllerMetadata(target).parameterTypes(propertyKey)[parameterIndex],
+                new ControllerMetadata(target).parameterTypes(propertyKey.toString())[parameterIndex],
                 parameterIndex,
                 required,
                 validator,
@@ -60,7 +60,7 @@ export function Query(
 /**
  * Default core query parameter of giuseppe. Does inject a query parameter from the request into the route.
  * Can contain an alias that the query parameter can be named with.
- * 
+ *
  * @export
  * @class GiuseppeQueryParameter
  * @extends {GiuseppeBaseParameter}