refactor: do not cache route lookups, instead make matchDomain method smart

Author: thetutlage

README.md

@@ -26,8 +26,8 @@ The benchmarking scheme is taken from the Fastify github repo.
 
 | Framework          | Version                    | Router?      |  Requests/sec |
 | :----------------- | :------------------------- | :----------: | ------------: |
-| **Fastify**        | **2.0.0**                  | **✓** | **52709**    |
-| **AdonisJs**        | **1.5.4**                 | **✓** | **47791**    |
+| **Fastify**        | **2.0.0**                  | **✓** | **58,740**    |
+| **AdonisJS**        | **1.8.1**                 | **✓** | **54,832**    |
 
 You can run the same benchmarks by cloning the repo and then running the following command.
 

docs/classes/_poppinss_request.request.md

@@ -28,6 +28,7 @@ using `request.request` property.
 
 ### Properties
 
+* [ctx](_poppinss_request.request.md#optional-ctx)
 * [parsedUrl](_poppinss_request.request.md#parsedurl)
 * [request](_poppinss_request.request.md#request)
 * [response](_poppinss_request.request.md#response)
@@ -110,6 +111,15 @@ Name | Type |
 
 ## Properties
 
+### `Optional` ctx
+
+• **ctx**? : *HttpContextContract*
+
+The ctx will be set by the context itself. It creates a circular
+reference
+
+___
+
 ###  parsedUrl
 
 • **parsedUrl**: *UrlWithStringQuery* = parse(this.request.url!, false)
@@ -156,7 +166,7 @@ Required by Macroable
 
 ###  accepts
 
-▸ **accepts**(`types`: string[]): *string | null*
+▸ **accepts**<**T**>(`types`: T[]): *T | null*
 
 Returns the best type using `Accept` header and
 by matching it against the given types.
@@ -178,13 +188,17 @@ switch (request.accepts(['json', 'html'])) {
 }
 ```
 
+**Type parameters:**
+
+▪ **T**: *string*
+
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
-`types` | string[] |
+`types` | T[] |
 
-**Returns:** *string | null*
+**Returns:** *T | null*
 
 ___
 
@@ -214,7 +228,7 @@ ___
 
 ###  charset
 
-▸ **charset**(`charsets`: string[]): *string | null*
+▸ **charset**<**T**>(`charsets`: T[]): *T | null*
 
 Returns the best charset using `Accept-charset` header
 and by matching it against the given charsets.
@@ -234,13 +248,17 @@ switch (request.charset(['utf-8', 'ISO-8859-1'])) {
 }
 ```
 
+**Type parameters:**
+
+▪ **T**: *string*
+
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
-`charsets` | string[] |
+`charsets` | T[] |
 
-**Returns:** *string | null*
+**Returns:** *T | null*
 
 ___
 
@@ -316,7 +334,7 @@ ___
 
 ###  encoding
 
-▸ **encoding**(`encodings`: string[]): *string | null*
+▸ **encoding**<**T**>(`encodings`: T[]): *T | null*
 
 Returns the best encoding using `Accept-encoding` header
 and by matching it against the given encodings.
@@ -326,13 +344,17 @@ If nothing is matched, then `null` will be returned
 Make sure to check [accepts](https://www.npmjs.com/package/accepts) package
 docs too.
 
+**Type parameters:**
+
+▪ **T**: *string*
+
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
-`encodings` | string[] |
+`encodings` | T[] |
 
-**Returns:** *string | null*
+**Returns:** *T | null*
 
 ___
 
@@ -650,7 +672,7 @@ ___
 
 ###  language
 
-▸ **language**(`languages`: string[]): *string | null*
+▸ **language**<**T**>(`languages`: T[]): *T | null*
 
 Returns the best language using `Accept-language` header
 and by matching it against the given languages.
@@ -672,13 +694,17 @@ switch (request.language(['fr', 'de'])) {
 }
 ```
 
+**Type parameters:**
+
+▪ **T**: *string*
+
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
-`languages` | string[] |
+`languages` | T[] |
 
-**Returns:** *string | null*
+**Returns:** *T | null*
 
 ___
 

docs/classes/_src_response_index_.response.md

@@ -42,6 +42,7 @@ This is how `explicitEnd` mode works in nutshell.
 
 ### Properties
 
+* [ctx](_src_response_index_.response.md#optional-ctx)
 * [lazyBody](_src_response_index_.response.md#lazybody)
 * [request](_src_response_index_.response.md#request)
 * [response](_src_response_index_.response.md#response)
@@ -155,6 +156,15 @@ Name | Type |
 
 ## Properties
 
+### `Optional` ctx
+
+• **ctx**? : *HttpContextContract*
+
+The ctx will be set by the context itself. It creates a circular
+reference
+
+___
+
 ###  lazyBody
 
 • **lazyBody**: *LazyBody | null* = null

docs/classes/_src_router_store_.store.md

@@ -30,16 +30,25 @@ store.match('posts/1', 'GET')
 
 ## Index
 
+### Properties
+
+* [matchDomain](_src_router_store_.store.md#matchdomain)
+
 ### Methods
 
 * [add](_src_router_store_.store.md#add)
 * [match](_src_router_store_.store.md#match)
-* [matchDomain](_src_router_store_.store.md#matchdomain)
 
 ### Object literals
 
 * [tree](_src_router_store_.store.md#tree)
 
+## Properties
+
+###  matchDomain
+
+• **matchDomain**: *any* = this.matchDomainNoop
+
 ## Methods
 
 ###  add
@@ -94,22 +103,6 @@ Name | Type |
 
 **Returns:** *null | MatchedRoute*
 
-___
-
-###  matchDomain
-
-▸ **matchDomain**(`domain`: string): *RouteStoreMatch[]*
-
-Matches the domain pattern for a given string
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`domain` | string |
-
-**Returns:** *RouteStoreMatch[]*
-
 ## Object literals
 
 ###  tree

src/Router/Store.ts

@@ -53,6 +53,25 @@ import {
 export class Store {
   public tree: RoutesTree = { tokens: [], domains: {} }
 
+  /**
+   * The [[matchDomainReal]] and [[matchDomainNoop]] functions are two
+   * implementation of matching a domain. We use noop implementation
+   * by default and once an explicit domain is registered, we
+   * pivot to [[matchDomainReal]].
+   *
+   * This all is done for performance, since we have noticed around 8-10%
+   * improvement.
+   */
+  private matchDomainReal = function (domain: string): RouteStoreMatch[] {
+    return matchit.match(domain || 'root', this.tree.tokens)
+  }.bind(this)
+
+  private matchDomainNoop = function (_: string): RouteStoreMatch[] {
+    return []
+  }.bind(this)
+
+  public matchDomain = this.matchDomainNoop
+
   /**
    * Returns the domain node for a given domain. If domain node is missing,
    * it will added to the routes object and tokens are also generated
@@ -118,6 +137,13 @@ export class Store {
       'name',
     ])) as RouteNode
 
+    /**
+     * An explicit domain is defined
+     */
+    if (route.domain && route.domain !== 'root' && this.matchDomain !== this.matchDomainReal) {
+      this.matchDomain = this.matchDomainReal
+    }
+
     route.methods.forEach((method) => {
       const methodRoutes = this.getMethodRoutes(route.domain || 'root', method)
 
@@ -150,13 +176,6 @@ export class Store {
     return this
   }
 
-  /**
-   * Matches the domain pattern for a given string
-   */
-  public matchDomain (domain: string): RouteStoreMatch[] {
-    return matchit.match(domain || 'root', this.tree.tokens)
-  }
-
   /**
    * Matches the url, method and optionally domain to pull the matching
    * route. `null` is returned when unable to match the URL against

src/Router/index.ts

@@ -15,7 +15,6 @@
 
 import ms from 'ms'
 import { stringify } from 'qs'
-import QuickLru from 'quick-lru'
 import { Exception } from '@poppinss/utils'
 import { EncryptionContract } from '@ioc:Adonis/Core/Encryption'
 
@@ -92,11 +91,6 @@ export class Router implements RouterContract {
    */
   private testRoutePatternCounter = 0
 
-  /**
-   * Cache of routes matched for a given domain, url and method
-   */
-  private matchedRoutes = new QuickLru({ maxSize: 1000 })
-
   private getRecentGroup () {
     return this.openedGroups[this.openedGroups.length - 1]
   }
@@ -348,12 +342,6 @@ export class Router implements RouterContract {
      *
      *    - Else we search within the routes of the mentioned domain.
      */
-
-    const cacheKey = `${url}-${method}-${domain}`
-    if (this.matchedRoutes.has(cacheKey)) {
-      return this.matchedRoutes.get(cacheKey) as null | MatchedRoute
-    }
-
     let response: null | MatchedRoute = null
     const matchingDomain = domain ? this.store.matchDomain(domain) : []
 
@@ -369,7 +357,6 @@ export class Router implements RouterContract {
       })
     }
 
-    this.matchedRoutes.set(cacheKey, response)
     return response
   }