feat: add support to customize the query string parser

Author: thetutlage

benchmarks/adonisjs.ts

@@ -7,27 +7,19 @@
  * file that was distributed with this source code.
  */
 
-import proxyaddr from 'proxy-addr'
 import { createServer } from 'node:http'
 import Encryption from '@adonisjs/encryption'
 import { Application } from '@adonisjs/application'
 
+import { defineConfig } from '../index.js'
 import { Server } from '../src/server/main.js'
 
 const app = new Application(new URL('./', import.meta.url), { environment: 'web' })
 await app.init()
 
 const encryption = new Encryption({ secret: 'averylongrandom32charslongsecret' })
 
-const server = new Server(app, encryption, {
-  etag: false,
-  jsonpCallbackName: 'callback',
-  cookie: {},
-  subdomainOffset: 2,
-  generateRequestId: false,
-  trustProxy: proxyaddr.compile('loopback'),
-  allowMethodSpoofing: false,
-})
+const server = new Server(app, encryption, defineConfig({}))
 
 server.use([], [], {})
 

src/define_config.ts

@@ -31,11 +31,19 @@ export function defineConfig(config: Partial<ServerConfig>): ServerConfig {
       sameSite: false,
     },
     qs: {
-      depth: 5,
-      parameterLimit: 1000,
-      allowSparse: false,
-      arrayLimit: 20,
-      comma: true,
+      parse: {
+        depth: 5,
+        parameterLimit: 1000,
+        allowSparse: false,
+        arrayLimit: 20,
+        comma: true,
+      },
+      stringify: {
+        encode: true,
+        encodeValuesOnly: false,
+        arrayFormat: 'indices' as const,
+        skipNulls: false,
+      },
     },
     ...config,
   }

src/qs.ts

@@ -0,0 +1,31 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { parse, stringify } from 'qs'
+import { QSParserConfig } from './types/qs.js'
+
+/**
+ * Query string parser used to parse and stringify query
+ * strings.
+ */
+export class Qs {
+  #config: QSParserConfig
+
+  constructor(config: QSParserConfig) {
+    this.#config = config
+  }
+
+  parse(value: string) {
+    return parse(value, this.#config.parse)
+  }
+
+  stringify(value: any) {
+    return stringify(value, this.#config.stringify)
+  }
+}

src/redirect.ts

@@ -7,12 +7,12 @@
  * file that was distributed with this source code.
  */
 
-import qs from 'qs'
 import { parse } from 'node:url'
 import encodeUrl from 'encodeurl'
 import type { IncomingMessage } from 'node:http'
 
 import debug from './debug.js'
+import type { Qs } from './qs.js'
 import type { Response } from './response.js'
 import type { Router } from './router/main.js'
 import type { MakeUrlOptions } from './types/route.js'
@@ -39,18 +39,20 @@ export class Redirect {
   #request: IncomingMessage
   #response: Response
   #router: Router
+  #qs: Qs
 
-  constructor(request: IncomingMessage, response: Response, router: Router) {
+  constructor(request: IncomingMessage, response: Response, router: Router, qs: Qs) {
     this.#request = request
     this.#response = response
     this.#router = router
+    this.#qs = qs
   }
 
   /**
    * Sends response by setting require headers
    */
   #sendResponse(url: string, query: Record<string, any>) {
-    const stringified = qs.stringify(query)
+    const stringified = this.#qs.stringify(query)
 
     url = stringified ? `${url}?${stringified}` : url
     debug('redirecting to url "%s"', url)
@@ -126,7 +128,7 @@ export class Redirect {
      * Parse query string from the referrer url
      */
     if (this.#forwardQueryString) {
-      query = qs.parse(url.query || '')
+      query = this.#qs.parse(url.query || '')
     }
 
     /**
@@ -163,7 +165,7 @@ export class Redirect {
      * Extract query string from the current URL
      */
     if (this.#forwardQueryString) {
-      query = qs.parse(parse(this.#request.url!).query || '')
+      query = this.#qs.parse(parse(this.#request.url!).query || '')
     }
 
     /**

src/request.ts

@@ -7,13 +7,11 @@
  * file that was distributed with this source code.
  */
 
-import qs from 'qs'
 import cuid from 'cuid'
 import fresh from 'fresh'
 import typeIs from 'type-is'
 import accepts from 'accepts'
 import { isIP } from 'node:net'
-import encodeUrl from 'encodeurl'
 import proxyaddr from 'proxy-addr'
 import { safeEqual } from '@poppinss/utils'
 import lodash from '@poppinss/utils/lodash'
@@ -22,6 +20,7 @@ import type Encryption from '@adonisjs/encryption'
 import { parse, UrlWithStringQuery } from 'node:url'
 import { ServerResponse, IncomingMessage, IncomingHttpHeaders } from 'node:http'
 
+import type { Qs } from './qs.js'
 import { trustProxy } from './helpers.js'
 import { CookieParser } from './cookies/parser.js'
 import { RequestConfig } from './types/request.js'
@@ -37,6 +36,11 @@ import type { HttpContext } from './http_context/main.js'
  * using `request.request` property.
  */
 export class Request extends Macroable {
+  /**
+   * Query string parser
+   */
+  #qsParser: Qs
+
   /**
    * Encryption module to verify signed URLs and unsign/decrypt
    * cookies
@@ -102,10 +106,12 @@ export class Request extends Macroable {
     public request: IncomingMessage,
     public response: ServerResponse,
     encryption: Encryption,
-    config: RequestConfig
+    config: RequestConfig,
+    qsParser: Qs
   ) {
     super()
 
+    this.#qsParser = qsParser
     this.#config = config
     this.#encryption = encryption
     this.parsedUrl = parse(this.request.url!, false)
@@ -117,7 +123,7 @@ export class Request extends Macroable {
    */
   #parseQueryString() {
     if (this.parsedUrl.query) {
-      this.updateQs(qs.parse(this.parsedUrl.query, this.#config.qs))
+      this.updateQs(this.#qsParser.parse(this.parsedUrl.query))
       this.#originalRequestData = { ...this.#requestData }
     }
   }
@@ -925,10 +931,10 @@ export class Request extends Macroable {
       return false
     }
 
-    const queryString = qs.stringify(rest)
+    const queryString = this.#qsParser.stringify(rest)
 
     return queryString
-      ? safeEqual(signedUrl, `${this.url()}?${encodeUrl(queryString)}`)
+      ? safeEqual(signedUrl, `${this.url()}?${queryString}`)
       : safeEqual(signedUrl, this.url())
   }
 

src/response.ts

@@ -23,6 +23,7 @@ import type Encryption from '@adonisjs/encryption'
 import contentDisposition from 'content-disposition'
 import { ServerResponse, IncomingMessage, OutgoingHttpHeaders } from 'node:http'
 
+import type { Qs } from './qs.js'
 import { Redirect } from './redirect.js'
 import type { Router } from './router/main.js'
 import type { HttpContext } from './http_context/main.js'
@@ -43,6 +44,11 @@ const CACHEABLE_HTTP_METHODS = ['GET', 'HEAD']
  * streamlining the process of writing response body and automatically setting up appropriate headers.
  */
 export class Response extends Macroable {
+  /**
+   * Query string parser
+   */
+  #qs: Qs
+
   /**
    * Outgoing headers
    */
@@ -106,9 +112,12 @@ export class Response extends Macroable {
     public response: ServerResponse,
     encryption: Encryption,
     config: ResponseConfig,
-    router: Router
+    router: Router,
+    qs: Qs
   ) {
     super()
+
+    this.#qs = qs
     this.#config = config
     this.#router = router
     this.#cookieSerializer = new CookieSerializer(encryption)
@@ -881,7 +890,7 @@ export class Response extends Macroable {
     forwardQueryString: boolean = false,
     statusCode: number = 302
   ): Redirect | void {
-    const handler = new Redirect(this.request, this, this.#router)
+    const handler = new Redirect(this.request, this, this.#router, this.#qs)
 
     if (forwardQueryString) {
       handler.withQs()

src/router/lookup_store/main.ts

@@ -9,6 +9,7 @@
 
 import type Encryption from '@adonisjs/encryption'
 
+import type { Qs } from '../../qs.js'
 import { UrlBuilder } from './url_builder.js'
 import { RouteFinder } from './route_finder.js'
 import type { RouteJSON } from '../../types/route.js'
@@ -22,10 +23,20 @@ export class LookupStore {
    * List of routes grouped by domain
    */
   #routes: { [domain: string]: RouteJSON[] } = {}
+
+  /**
+   * Encryption for making URLs
+   */
   #encryption: Encryption
 
-  constructor(encryption: Encryption) {
+  /**
+   * Query string parser for making URLs
+   */
+  #qsParser: Qs
+
+  constructor(encryption: Encryption, qsParser: Qs) {
     this.#encryption = encryption
+    this.#qsParser = qsParser
   }
 
   /**
@@ -50,7 +61,7 @@ export class LookupStore {
    */
   builderForDomain(domain: string) {
     const routes = this.#routes[domain]
-    return new UrlBuilder(this.#encryption, new RouteFinder(routes || []))
+    return new UrlBuilder(this.#encryption, new RouteFinder(routes || []), this.#qsParser)
   }
 
   /**

src/router/lookup_store/url_builder.ts

@@ -7,10 +7,10 @@
  * file that was distributed with this source code.
  */
 
-import { stringify } from 'qs'
-import encodeUrl from 'encodeurl'
 import { RuntimeException } from '@poppinss/utils'
 import type Encryption from '@adonisjs/encryption'
+
+import type { Qs } from '../../qs.js'
 import type { RouteFinder } from './route_finder.js'
 
 /**
@@ -27,6 +27,11 @@ import type { RouteFinder } from './route_finder.js'
  * ```
  */
 export class UrlBuilder {
+  /**
+   * Query string parser
+   */
+  #qsParser: Qs
+
   /**
    * The parameters to apply on the route
    */
@@ -58,7 +63,8 @@ export class UrlBuilder {
    */
   #routeFinder: RouteFinder
 
-  constructor(encryption: Encryption, routeFinder: RouteFinder) {
+  constructor(encryption: Encryption, routeFinder: RouteFinder, qsParser: Qs) {
+    this.#qsParser = qsParser
     this.#encryption = encryption
     this.#routeFinder = routeFinder
   }
@@ -131,8 +137,8 @@ export class UrlBuilder {
    */
   #suffixQueryString(url: string, qs?: Record<string, any>): string {
     if (qs) {
-      const queryString = stringify(qs)
-      url = queryString ? `${url}?${encodeUrl(queryString)}` : url
+      const queryString = this.#qsParser.stringify(qs)
+      url = queryString ? `${url}?${queryString}` : url
     }
 
     return url

src/router/main.ts

@@ -12,6 +12,7 @@ import type Encryption from '@adonisjs/encryption'
 import { RuntimeException } from '@poppinss/utils'
 import type { Application } from '@adonisjs/application'
 
+import type { Qs } from '../qs.js'
 import { Route } from './route.js'
 import { RouteGroup } from './group.js'
 import { BriskRoute } from './brisk.js'
@@ -99,9 +100,10 @@ export class Router<
   constructor(
     app: Application,
     encryption: Encryption,
-    middlewareStore: MiddlewareStore<NamedMiddleware>
+    middlewareStore: MiddlewareStore<NamedMiddleware>,
+    qsParser: Qs
   ) {
-    super(encryption)
+    super(encryption, qsParser)
     this.#app = app
     this.#middlewareStore = middlewareStore
   }