refactor: use utils module for invoking controllers and middleware

Author: thetutlage

index.ts

@@ -13,8 +13,8 @@
 
 export { Router } from './src/Router'
 export { Server } from './src/Server'
-export { MiddlewareStore } from './src/Server/MiddlewareStore'
 export { HttpContext } from './src/HttpContext'
+export { MiddlewareStore } from './src/Server/MiddlewareStore'
 export { routePreProcessor } from './src/Server/routePreProcessor'
 
 export {

package.json

@@ -44,7 +44,7 @@
     "ts-node": "^8.3.0",
     "tslint": "^5.18.0",
     "tslint-eslint-rules": "^5.4.0",
-    "typedoc": "^0.14.2",
+    "typedoc": "^0.15.0",
     "typedoc-plugin-external-module-name": "^2.1.0",
     "typedoc-plugin-markdown": "^2.0.11",
     "typescript": "^3.5.3"
@@ -78,7 +78,7 @@
   "dependencies": {
     "@poppinss/request": "^1.0.9",
     "@poppinss/response": "^1.0.9",
-    "@poppinss/utils": "^1.0.3",
+    "@poppinss/utils": "^1.0.4",
     "co-compose": "^5.1.1",
     "haye": "^2.0.2",
     "lodash": "^4.17.15",

src/Server/MiddlewareStore.ts

@@ -12,7 +12,7 @@
 */
 
 import * as haye from 'haye'
-import { Exception } from '@poppinss/utils'
+import { Exception, parseIocReference } from '@poppinss/utils'
 
 import {
   RouteNode,
@@ -21,7 +21,7 @@ import {
   ResolvedMiddlewareNode,
 } from '../contracts'
 
-import { exceptionCodes, iocMethods } from '../helpers'
+import { exceptionCodes } from '../helpers'
 
 /**
  * Middleware store register and keep all the application middleware at one
@@ -61,15 +61,13 @@ export class MiddlewareStore<Context extends any> implements MiddlewareStoreCont
    * it, otherwise an exception will be raised.
    */
   private _resolveMiddlewareItem (middleware: MiddlewareNode<Context>): ResolvedMiddlewareNode<Context> {
-    return typeof(middleware) === 'string' ? {
-      type: 'class',
-      value: global[iocMethods.use](middleware),
-      args: [],
-    } : {
+    return typeof(middleware) === 'function' ? {
       type: 'function',
       value: middleware,
       args: [],
-    }
+    } : Object.assign(parseIocReference(`${middleware}.handle`, undefined, undefined, true), {
+      args: [],
+    })
   }
 
   /**

src/Server/finalErrorHandler.ts

@@ -7,7 +7,6 @@
 * file that was distributed with this source code.
 */
 
-import { iocMethods } from '../helpers'
 import { useReturnValue } from './useReturnValue'
 import { ErrorHandlerNode, HttpContextContract } from '../contracts'
 
@@ -37,8 +36,8 @@ export async function finalErrorHandler<Context extends HttpContextContract> (
    * Otherwise resolve the IoC container binding and call `handle` method
    * on it. The `handle` must always exist.
    */
-  const errorHandlerInstance = global[iocMethods.make](errorHandler)
-  const returnValue = await global[iocMethods.call](errorHandlerInstance, 'handle', [error, ctx])
+  const errorHandlerInstance = global[Symbol.for('ioc.make')](errorHandler)
+  const returnValue = await global[Symbol.for('ioc.call')](errorHandlerInstance, 'handle', [error, ctx])
   if (useReturnValue(returnValue, ctx)) {
     ctx.response.send(returnValue)
   }
@@ -48,6 +47,6 @@ export async function finalErrorHandler<Context extends HttpContextContract> (
    * attempt to make an HTTP response
    */
   if (typeof (errorHandlerInstance.report) === 'function') {
-    await global[iocMethods.call](errorHandlerInstance, 'report', [error, ctx])
+    await global[Symbol.for('ioc.call')](errorHandlerInstance, 'report', [error, ctx])
   }
 }

src/Server/finalMiddlewareHandler.ts

@@ -11,8 +11,8 @@
 * file that was distributed with this source code.
 */
 
+import { callIocReference } from '@poppinss/utils'
 import { ResolvedMiddlewareNode } from '../contracts'
-import { iocMethods } from '../helpers'
 
 /**
  * Final middleware handler executes a middleware
@@ -28,10 +28,6 @@ export function finalMiddlewareHandler<Context> (
     return middleware.value(params[0], params[1], middleware.args)
   }
 
-  const middlewareInstance = global[iocMethods.make](middleware.value)
-  return global[iocMethods.call](middlewareInstance, 'handle', [
-    params[0],
-    params[1],
-    middleware.args,
-  ])
+  const args = ([params[0], params[1]] as any).concat([middleware.args])
+  return callIocReference(middleware, args)
 }

src/Server/finalRouteHandler.ts

@@ -11,9 +11,9 @@
 * file that was distributed with this source code.
 */
 
-import { ResolvedControllerNode, HttpContextContract } from '../contracts'
+import { callIocReference } from '@poppinss/utils'
 import { useReturnValue } from './useReturnValue'
-import { iocMethods } from '../helpers'
+import { ResolvedControllerNode, HttpContextContract } from '../contracts'
 
 /**
  * Final handler executes the route handler based on it's resolved
@@ -39,9 +39,7 @@ export async function finalRouteHandler<Context extends HttpContextContract> (ct
    * Otherwise lookup the controller inside the IoC container
    * and make the response
    */
-  const controllerInstance = global[iocMethods.make](handler.namespace)
-  const returnValue = await global[iocMethods.call](controllerInstance, handler.method, [ctx])
-
+  const returnValue = await callIocReference(handler, [ctx])
   if (useReturnValue(returnValue, ctx)) {
     ctx.response.send(returnValue)
   }

src/Server/index.ts

@@ -29,9 +29,9 @@ import { LoggerContract } from '@poppinss/logger'
 import { Request, RequestContract } from '@poppinss/request'
 import { Response, ResponseContract } from '@poppinss/response'
 
-import { finalMiddlewareHandler } from './finalMiddlewareHandler'
-import { finalErrorHandler } from './finalErrorHandler'
 import { exceptionCodes } from '../helpers'
+import { finalErrorHandler } from './finalErrorHandler'
+import { finalMiddlewareHandler } from './finalMiddlewareHandler'
 
 class RouteNotFound extends Exception {}
 

src/contracts.ts

@@ -266,10 +266,11 @@ export type ResolvedMiddlewareNode<Context> = {
   value: Exclude<MiddlewareNode<Context>, string>,
   args: string[],
 } | {
-  type: 'class',
+  type: 'iocObject',
   value: {
     handle: Exclude<MiddlewareNode<Context>, string>,
   },
+  method: string,
   args: string[],
 }
 

src/helpers.ts

@@ -16,9 +16,9 @@ import { Exception } from '@poppinss/utils'
 
 import { Route } from './Router/Route'
 import { RouteGroup } from './Router/Group'
+import { RouteDefinition } from './contracts'
 import { BriskRoute } from './Router/BriskRoute'
 import { RouteResource } from './Router/Resource'
-import { RouteDefinition } from './contracts'
 
 /**
  * Makes input string consistent by having only the starting
@@ -124,12 +124,3 @@ export const exceptionCodes = {
   E_ROUTE_NOT_FOUND: 'E_ROUTE_NOT_FOUND',
   E_MISSING_NAMED_MIDDLEWARE: 'E_MISSING_NAMED_MIDDLEWARE',
 }
-
-/**
- * Symbols to use IoC container global methods.
- */
-export const iocMethods = {
-  use: Symbol.for('ioc.use'),
-  make: Symbol.for('ioc.make'),
-  call: Symbol.for('ioc.call'),
-}

test/route-pre-processor.spec.ts

@@ -71,8 +71,9 @@ test.group('Route pre processor', (group) => {
     routePreProcessor(route, middlewareStore)
 
     assert.deepEqual(route.meta.resolvedMiddleware, [{
-      type: 'class',
+      type: 'iocObject',
       value: Auth,
+      method: 'handle',
       args: ['jwt'],
     }])
   })
@@ -167,7 +168,5 @@ test.group('Route pre processor', (group) => {
 
     const route = router.get('/', '/UserController.store').toJSON()
     routePreProcessor(route, middlewareStore)
-
-    console.log(route.meta.finalHandler)
   })
 })