feat: add routeKey to the matched route and the context

Author: thetutlage

adonis-typings/context.ts

@@ -32,6 +32,7 @@ declare module '@ioc:Adonis/Core/HttpContext' {
     logger: LoggerContract
     profiler: ProfilerRowContract
     route?: RouteNode
+    routeKey: string,
     params: any
     subdomains: any
   }

adonis-typings/route.ts

@@ -46,6 +46,7 @@ declare module '@ioc:Adonis/Core/Route' {
    */
   export type RouteNode = {
     pattern: string,
+
     /**
      * The router itself doesn't use the handler for anything, it
      * leaves the type to `any` for the consumer to decide the
@@ -130,6 +131,11 @@ declare module '@ioc:Adonis/Core/Route' {
    */
   export type MatchedRoute = {
     route: RouteNode,
+
+    /**
+     * A unique key for the looked up route
+     */
+    routeKey: string,
     params: any,
     subdomains: any,
   }

package-lock.json

@@ -33,7 +33,7 @@
   "devDependencies": {
     "@adonisjs/encryption": "^2.0.2",
     "@adonisjs/fold": "^6.3.5",
-    "@adonisjs/logger": "^2.0.2",
+    "@adonisjs/logger": "^2.0.3",
     "@adonisjs/mrm-preset": "^2.3.0",
     "@adonisjs/profiler": "^3.0.1",
     "@poppinss/dev-utils": "^1.0.6",

package.json

@@ -32,6 +32,7 @@ import { processPattern } from '../helpers'
  * error handler and server hooks.
  */
 export class HttpContext extends Macroable implements HttpContextContract {
+  public routeKey: string
   public params: any = {}
   public subdomains: any = {}
   public route?: RouteNode
@@ -136,6 +137,11 @@ export class HttpContext extends Macroable implements HttpContextContract {
       meta: {},
     }
 
+    /**
+     * Defining route key
+     */
+    ctx.routeKey = `${request.method()}-${ctx.route.pattern}`
+
     /**
      * Attaching params to the ctx
      */

src/HttpContext/index.ts

@@ -189,7 +189,10 @@ export class Store {
     method: string,
     domain?: { storeMatch: RouteStoreMatch[], value: string },
   ): null | MatchedRoute {
-    const matchedDomain = this.tree.domains[domain?.storeMatch[0]?.old || 'root']
+    const matchingDomain = domain && domain.storeMatch[0] && domain.storeMatch[0].old
+    const domainName = matchingDomain || 'root'
+
+    const matchedDomain = this.tree.domains[domainName]
     if (!matchedDomain) {
       return null
     }
@@ -199,7 +202,7 @@ export class Store {
      * method node is missing, means no routes ever got registered for that
      * method
      */
-    const matchedMethod = this.tree.domains[domain?.storeMatch[0].old || 'root'][method]
+    const matchedMethod = this.tree.domains[domainName][method]
     if (!matchedMethod) {
       return null
     }
@@ -213,11 +216,15 @@ export class Store {
       return null
     }
 
+    const route = matchedMethod.routes[matchedRoute[0].old]
     return {
-      route: matchedMethod.routes[matchedRoute[0].old],
+      route: route,
+      routeKey: matchingDomain
+        ? `${matchingDomain}-${method}-${route.pattern}`
+        : `${method}-${route.pattern}`,
       params: matchit.exec(url, matchedRoute),
       subdomains: domain?.value
-        ? matchit.exec(domain.value || 'root', domain.storeMatch)
+        ? matchit.exec(domain.value, domain.storeMatch)
         : {},
     }
   }

src/Router/Store.ts

@@ -67,6 +67,7 @@ export class RequestHandler {
     ctx.params = route!.params
     ctx.subdomains = route!.subdomains
     ctx.route = route!.route
+    ctx.routeKey = route!.routeKey
   }
 
   /**

src/Server/RequestHandler/index.ts

@@ -1723,6 +1723,7 @@ test.group('Router | match', () => {
         name: 'photos.index',
         handler: 'PhotosController.index',
       },
+      routeKey: 'GET-/photos',
       subdomains: {},
     })
 
@@ -1737,6 +1738,7 @@ test.group('Router | match', () => {
         name: 'photos.create',
         handler: 'PhotosController.create',
       },
+      routeKey: 'GET-/photos/create',
       subdomains: {},
     })
 
@@ -1751,6 +1753,7 @@ test.group('Router | match', () => {
         name: 'photos.store',
         handler: 'PhotosController.store',
       },
+      routeKey: 'POST-/photos',
       subdomains: {},
     })
 
@@ -1767,6 +1770,7 @@ test.group('Router | match', () => {
         name: 'photos.show',
         handler: 'PhotosController.show',
       },
+      routeKey: 'GET-/photos/:id',
       subdomains: {},
     })
 
@@ -1783,6 +1787,7 @@ test.group('Router | match', () => {
         name: 'photos.edit',
         handler: 'PhotosController.edit',
       },
+      routeKey: 'GET-/photos/:id/edit',
       subdomains: {},
     })
 
@@ -1799,6 +1804,7 @@ test.group('Router | match', () => {
         name: 'photos.update',
         handler: 'PhotosController.update',
       },
+      routeKey: 'PUT-/photos/:id',
       subdomains: {},
     })
 
@@ -1815,6 +1821,7 @@ test.group('Router | match', () => {
         name: 'photos.delete',
         handler: 'PhotosController.delete',
       },
+      routeKey: 'DELETE-/photos/:id',
       subdomains: {},
     })
   })

test/router.spec.ts

@@ -932,4 +932,17 @@ test.group('Server | all', (group) => {
     const { text } = await supertest(httpServer).get('/').expect(200)
     assert.equal(text, 'application/json')
   })
+
+  test('pass routeKey to the context', async (assert) => {
+    const server = new Server(new Ioc(), logger, profiler, encryption, Object.assign({
+      forceContentNegotiationToJSON: true,
+    }, config))
+    const httpServer = createServer(server.handle.bind(server))
+
+    server.router.get('/', async ({ routeKey, response }) => response.send(routeKey))
+    server.optimize()
+
+    const { text } = await supertest(httpServer).get('/').expect(200)
+    assert.equal(text, 'GET-/')
+  })
 })

test/server.spec.ts

@@ -275,6 +275,7 @@ test.group('Store | match', () => {
       },
       params: {},
       subdomains: {},
+      routeKey: 'GET-/',
     })
   })
 
@@ -302,6 +303,7 @@ test.group('Store | match', () => {
         username: 'virk',
       },
       subdomains: {},
+      routeKey: 'GET-/:username',
     })
   })
 
@@ -329,6 +331,7 @@ test.group('Store | match', () => {
         username: 'virk',
       },
       subdomains: {},
+      routeKey: 'GET-/:username?',
     })
 
     assert.deepEqual(store.match('/', 'GET'), {
@@ -340,6 +343,7 @@ test.group('Store | match', () => {
       },
       params: {},
       subdomains: {},
+      routeKey: 'GET-/:username?',
     })
   })
 
@@ -376,6 +380,7 @@ test.group('Store | match', () => {
         username: 'virk',
       },
       subdomains: {},
+      routeKey: 'GET-/:username',
     })
   })
 
@@ -416,6 +421,7 @@ test.group('Store | match', () => {
         id: '1',
       },
       subdomains: {},
+      routeKey: 'GET-/:id',
     })
   })
 
@@ -457,6 +463,7 @@ test.group('Store | match', () => {
         id: '1',
       },
       subdomains: {},
+      routeKey: 'foo.com-GET-/:id',
     })
   })
 
@@ -491,6 +498,7 @@ test.group('Store | match', () => {
       subdomains: {
         subdomain: 'blog',
       },
+      routeKey: ':subdomain.adonisjs.com-GET-/:id',
     })
   })
 
@@ -568,6 +576,7 @@ test.group('Store | match', () => {
       params: {
       },
       subdomains: {},
+      routeKey: 'GET-/users/:id?',
     })
   })
 
@@ -597,6 +606,7 @@ test.group('Store | match', () => {
         id: '1',
       },
       subdomains: {},
+      routeKey: 'GET-/users/:id?',
     })
   })
 })