feat: Query string params

docs/api/Dispatcher.md

@@ -194,6 +194,7 @@ Returns: `Boolean` - `false` if dispatcher is busy and further dispatch calls wo
 * **method** `string`
 * **body** `string | Buffer | Uint8Array | stream.Readable | Iterable | AsyncIterable | null` (optional) - Default: `null`
 * **headers** `UndiciHeaders | string[]` (optional) - Default: `null`.
+* **params** `Record<string, any | null` (optional) - Default: `null` - Query string params to be embedded in the request URL.
 * **idempotent** `boolean` (optional) - Default: `true` if `method` is `'HEAD'` or `'GET'` - Whether the requests can be safely retried or not. If `false` the request won't be sent until all preceding requests in the pipeline has completed.
 * **blocking** `boolean` (optional) - Default: `false` - Whether the response is expected to take a long time and would end up blocking the pipeline. When this is set to `true` further pipelining will be avoided on the same connection until headers have been received.
 * **upgrade** `string | null` (optional) - Default: `null` - Upgrade the request. Should be used to specify the kind of upgrade i.e. `'Websocket'`.

lib/core/request.js

@@ -4,8 +4,8 @@ const {
   InvalidArgumentError,
   NotSupportedError
 } = require('./errors')
-const util = require('./util')
 const assert = require('assert')
+const util = require('./util')
 
 const kHandler = Symbol('handler')
 
@@ -38,6 +38,7 @@ class Request {
     method,
     body,
     headers,
+    params,
     idempotent,
     blocking,
     upgrade,
@@ -97,7 +98,13 @@ class Request {
 
     this.upgrade = upgrade || null
 
-    this.path = path
+    if (params && Object.keys(params).length > 0) {
+      const searchParams = new URLSearchParams(params)
+      const delimiter = path.indexOf('?') === -1 ? '?' : '&'
+      this.path = `${path}${delimiter}${searchParams.toString()}`
+    } else {
+      this.path = path
+    }
 
     this.origin = origin
 

test/client.js

@@ -1,10 +1,10 @@
 'use strict'
 
-const { test } = require('tap')
-const { Client, errors } = require('..')
-const { createServer } = require('http')
 const { readFileSync, createReadStream } = require('fs')
+const { createServer } = require('http')
 const { Readable } = require('stream')
+const { test } = require('tap')
+const { Client, errors } = require('..')
 const { kSocket } = require('../lib/core/symbols')
 const { wrapWithAsyncIterable } = require('./utils/async-iterators')
 const EE = require('events')
@@ -80,6 +80,116 @@ test('basic get', (t) => {
   })
 })
 
+test('basic get with query params', (t) => {
+  t.plan(4)
+
+  const server = createServer((req, res) => {
+    const [, paramString] = req.url.split('?')
+    const searchParams = new URLSearchParams(paramString)
+    const searchParamsObject = Object.fromEntries(searchParams.entries())
+    t.strictSame(searchParamsObject, {
+      foo: '1',
+      bar: 'bar',
+      multi: '1,2'
+    })
+
+    res.statusCode = 200
+    res.end('hello')
+  })
+  t.teardown(server.close.bind(server))
+
+  const params = {
+    foo: 1,
+    bar: 'bar',
+    multi: [1, 2]
+  }
+
+  server.listen(0, () => {
+    const client = new Client(`http://localhost:${server.address().port}`, {
+      keepAliveTimeout: 300e3
+    })
+    t.tearDown(client.close.bind(client))
+
+    const signal = new EE()
+    client.request({
+      signal,
+      path: '/',
+      method: 'GET',
+      params
+    }, (err, data) => {
+      t.error(err)
+      const { statusCode } = data
+      t.strictEqual(statusCode, 200)
+    })
+    t.strictEqual(signal.listenerCount('abort'), 1)
+  })
+})
+
+/*
+test('basic get with empty query params', (t) => {
+  t.plan(4)
+
+  const server = createServer(serverRequestParams(t, {}))
+  t.tearDown(server.close.bind(server))
+
+  const params = {}
+
+  server.listen(0, () => {
+    const client = new Client(`http://localhost:${server.address().port}`, {
+      keepAliveTimeout: 300e3
+    })
+    t.tearDown(client.close.bind(client))
+
+    const signal = new EE()
+    client.request({
+      signal,
+      path: '/',
+      method: 'GET',
+      params
+    }, (err, data) => {
+      t.error(err)
+      const { statusCode } = data
+      t.strictEqual(statusCode, 200)
+    })
+    t.strictEqual(signal.listenerCount('abort'), 1)
+  })
+})
+
+test('basic get with query params partially in path', (t) => {
+  t.plan(4)
+
+  const server = createServer(serverRequestParams(t, {
+    foo: '1',
+    bar: '2'
+  }))
+  t.tearDown(server.close.bind(server))
+
+  const params = {
+    foo: 1
+  }
+
+  server.listen(0, () => {
+    const client = new Client(`http://localhost:${server.address().port}`, {
+      keepAliveTimeout: 300e3
+    })
+    t.tearDown(client.close.bind(client))
+
+    const signal = new EE()
+    client.request({
+      signal,
+      path: '/?bar=2',
+      method: 'GET',
+      params
+    }, (err, data) => {
+      t.error(err)
+      const { statusCode } = data
+      t.strictEqual(statusCode, 200)
+    })
+    t.strictEqual(signal.listenerCount('abort'), 1)
+  })
+})
+ */
+
 test('basic head', (t) => {
   t.plan(14)
 
@@ -251,6 +361,20 @@ test('head with host header', (t) => {
   })
 })
 
+/*
+function serverRequestParams (t, expected) {
+  return function (req, res) {
+    const [, paramString] = req.url.split('?')
+    const searchParams = new URLSearchParams(paramString)
+    const searchParamsObject = Object.fromEntries(searchParams.entries())
+    t.strictSame(searchParamsObject, expected)
+
+    res.statusCode = 200
+    res.end('hello')
+  }
+}
+ */
+
 function postServer (t, expected) {
   return function (req, res) {
     t.equal(req.url, '/')