feat: allow making url without performaing route lookup

Author: Harminder Virk

adonis-typings/route.ts

@@ -419,6 +419,7 @@ declare module '@ioc:Adonis/Core/Route' {
     qs?: Record<string, any>
     domain?: string
     prefixUrl?: string
+    disableRouteLookup?: boolean
   } & Record<string, any>
 
   /**
@@ -614,6 +615,12 @@ declare module '@ioc:Adonis/Core/Route' {
      */
     make(identifier: string): string
 
+    /**
+     * Disable route lookup and consider identifier
+     * as the route pattern
+     */
+    disableRouteLookup(): this
+
     /**
      * Generate signed url for the given route
      */

src/Router/LookupStore.ts

@@ -34,6 +34,12 @@ export class UrlBuilder implements UrlBuilderContract {
    */
   private queryString: Record<string, any> = {}
 
+  /**
+   * A boolean to know if the route should be looked
+   * up inside the route store or not
+   */
+  private lookupRoute = true
+
   /**
    * A baseUrl to prefix to the endpoint
    */
@@ -134,6 +140,15 @@ export class UrlBuilder implements UrlBuilderContract {
     return this
   }
 
+  /**
+   * Disable route lookup. Calling this method considers
+   * the "identifier" as the route pattern
+   */
+  public disableRouteLookup(): this {
+    this.lookupRoute = false
+    return this
+  }
+
   /**
    * Append query string to the final URI
    */
@@ -161,8 +176,14 @@ export class UrlBuilder implements UrlBuilderContract {
    * Generate url for the given route identifier
    */
   public make(identifier: string) {
-    const route = this.findRouteOrFail(identifier)
-    const url = this.processPattern(route.pattern)
+    let url: string
+
+    if (this.lookupRoute) {
+      const route = this.findRouteOrFail(identifier)
+      url = this.processPattern(route.pattern)
+    } else {
+      url = this.processPattern(identifier)
+    }
     return this.suffixQueryString(this.baseUrl ? `${this.baseUrl}${url}` : url)
   }
 
@@ -173,8 +194,14 @@ export class UrlBuilder implements UrlBuilderContract {
     identifier: string,
     options?: { expiresIn?: string | number; purpose?: string }
   ) {
-    const route = this.findRouteOrFail(identifier)
-    const url = this.processPattern(route.pattern)
+    let url: string
+
+    if (this.lookupRoute) {
+      const route = this.findRouteOrFail(identifier)
+      url = this.processPattern(route.pattern)
+    } else {
+      url = this.processPattern(identifier)
+    }
 
     /*
      * Making the signature from the qualified url. We do not prefix the domain when

src/Router/index.ts

@@ -392,6 +392,7 @@ export class Router implements RouterContract {
     normalizedOptions.params && builder.params(normalizedOptions.params)
     normalizedOptions.qs && builder.qs(normalizedOptions.qs)
     normalizedOptions.prefixUrl && builder.prefixUrl(normalizedOptions.prefixUrl)
+    normalizedOptions.disableRouteLookup && builder.disableRouteLookup()
 
     return builder.make(routeIdentifier)
   }
@@ -413,6 +414,7 @@ export class Router implements RouterContract {
     normalizedOptions.params && builder.params(normalizedOptions.params)
     normalizedOptions.qs && builder.qs(normalizedOptions.qs)
     normalizedOptions.prefixUrl && builder.prefixUrl(normalizedOptions.prefixUrl)
+    normalizedOptions.disableRouteLookup && builder.disableRouteLookup()
 
     return builder.makeSigned(routeIdentifier, normalizedOptions)
   }

src/helpers.ts

@@ -166,6 +166,7 @@ export function normalizeMakeUrlOptions(params?: any[] | MakeUrlOptions, options
   const qs = options.qs || params['qs']
   const domain = options.domain
   const prefixUrl = options.prefixUrl
+  const disableRouteLookup = options.disableRouteLookup || false
 
   /**
    * Using legacy options
@@ -177,7 +178,7 @@ export function normalizeMakeUrlOptions(params?: any[] | MakeUrlOptions, options
     )
   })
 
-  return { params: normalizedParams, qs, domain, prefixUrl }
+  return { params: normalizedParams, qs, domain, prefixUrl, disableRouteLookup }
 }
 
 /**
@@ -200,6 +201,7 @@ export function normalizeMakeSignedUrlOptions(
   const purpose = options.purpose || params['purpose']
   const domain = options.domain
   const prefixUrl = options.prefixUrl
+  const disableRouteLookup = options.disableRouteLookup || false
 
   /**
    * Using legacy options
@@ -215,7 +217,7 @@ export function normalizeMakeSignedUrlOptions(
     }
   )
 
-  return { params: normalizedParams, qs, domain, prefixUrl, expiresIn, purpose }
+  return { params: normalizedParams, qs, domain, prefixUrl, expiresIn, purpose, disableRouteLookup }
 }
 
 /**

test/router.spec.ts

@@ -3018,6 +3018,12 @@ test.group('Router | Make url', () => {
       'E_CANNOT_MAKE_ROUTE_URL: "*" param is required to make URL for "/posts/*" route'
     )
   })
+
+  test('make url without performing route lookup', ({ assert }) => {
+    const router = new Router(encryption)
+    const url = router.makeUrl('/posts/:id', { id: 1 }, { disableRouteLookup: true })
+    assert.equal(url, '/posts/1')
+  })
 })
 
 test.group('Make signed url', () => {
@@ -3181,6 +3187,14 @@ test.group('Make signed url', () => {
       'E_CANNOT_MAKE_ROUTE_URL: "*" param is required to make URL for "/posts/*" route'
     )
   })
+
+  test('make signed url without performing route lookup', ({ assert }) => {
+    const router = new Router(encryption)
+
+    const url = router.makeSignedUrl('/posts/:id', { id: 1 }, { disableRouteLookup: true })!
+    const qs = parse(url.split('?')[1])
+    assert.equal(encryption.verifier.unsign(qs.signature as string), '/posts/1')
+  }).pin()
 })
 
 test.group('Regression', () => {