undici 7.0.0-alpha.1 → 7.0.0-alpha.2

package/lib/mock/mock-agent.js

@@ -18,7 +18,6 @@ const MockPool = require('./mock-pool')
 const { matchValue, buildMockOptions } = require('./mock-utils')
 const { InvalidArgumentError, UndiciError } = require('../core/errors')
 const Dispatcher = require('../dispatcher/dispatcher')
-const Pluralizer = require('./pluralizer')
 const PendingInterceptorsFormatter = require('./pending-interceptors-formatter')
 
 class MockAgent extends Dispatcher {
@@ -147,13 +146,11 @@ class MockAgent extends Dispatcher {
       return
     }
 
-    const pluralizer = new Pluralizer('interceptor', 'interceptors').pluralize(pending.length)
-
-    throw new UndiciError(`
-${pluralizer.count} ${pluralizer.noun} ${pluralizer.is} pending:
-
-${pendingInterceptorsFormatter.format(pending)}
-`.trim())
+    throw new UndiciError(
+      pending.length === 1
+        ? `1 interceptor is pending:\n\n${pendingInterceptorsFormatter.format(pending)}`.trim()
+        : `${pending.length} interceptors are pending:\n\n${pendingInterceptorsFormatter.format(pending)}`.trim()
+    )
   }
 }
 

package/lib/mock/mock-client.js

@@ -10,7 +10,8 @@ const {
   kOriginalClose,
   kOrigin,
   kOriginalDispatch,
-  kConnected
+  kConnected,
+  kIgnoreTrailingSlash
 } = require('./mock-symbols')
 const { MockInterceptor } = require('./mock-interceptor')
 const Symbols = require('../core/symbols')
@@ -29,6 +30,7 @@ class MockClient extends Client {
 
     this[kMockAgent] = opts.agent
     this[kOrigin] = origin
+    this[kIgnoreTrailingSlash] = opts.ignoreTrailingSlash ?? false
     this[kDispatches] = []
     this[kConnected] = 1
     this[kOriginalDispatch] = this.dispatch
@@ -46,7 +48,10 @@ class MockClient extends Client {
    * Sets up the base interceptor for mocking replies from undici.
    */
   intercept (opts) {
-    return new MockInterceptor(opts, this[kDispatches])
+    return new MockInterceptor(
+      opts && { ignoreTrailingSlash: this[kIgnoreTrailingSlash], ...opts },
+      this[kDispatches]
+    )
   }
 
   async [kClose] () {

package/lib/mock/mock-errors.js

@@ -2,10 +2,12 @@
 
 const { UndiciError } = require('../core/errors')
 
+/**
+ * The request does not match any registered mock dispatches.
+ */
 class MockNotMatchedError extends UndiciError {
   constructor (message) {
     super(message)
-    Error.captureStackTrace(this, MockNotMatchedError)
     this.name = 'MockNotMatchedError'
     this.message = message || 'The request does not match any registered mock dispatches'
     this.code = 'UND_MOCK_ERR_MOCK_NOT_MATCHED'

package/lib/mock/mock-interceptor.js

@@ -7,10 +7,11 @@ const {
   kDefaultHeaders,
   kDefaultTrailers,
   kContentLength,
-  kMockDispatch
+  kMockDispatch,
+  kIgnoreTrailingSlash
 } = require('./mock-symbols')
 const { InvalidArgumentError } = require('../core/errors')
-const { buildURL } = require('../core/util')
+const { serializePathWithQuery } = require('../core/util')
 
 /**
  * Defines the scope API for an interceptor reply
@@ -72,7 +73,7 @@ class MockInterceptor {
     // fragments to servers when they retrieve a document,
     if (typeof opts.path === 'string') {
       if (opts.query) {
-        opts.path = buildURL(opts.path, opts.query)
+        opts.path = serializePathWithQuery(opts.path, opts.query)
       } else {
         // Matches https://github.com/nodejs/undici/blob/main/lib/web/fetch/index.js#L1811
         const parsedURL = new URL(opts.path, 'data://')
@@ -85,6 +86,7 @@ class MockInterceptor {
 
     this[kDispatchKey] = buildKey(opts)
     this[kDispatches] = mockDispatches
+    this[kIgnoreTrailingSlash] = opts.ignoreTrailingSlash ?? false
     this[kDefaultHeaders] = {}
     this[kDefaultTrailers] = {}
     this[kContentLength] = false
@@ -137,7 +139,7 @@ class MockInterceptor {
       }
 
       // Add usual dispatch data, but this time set the data parameter to function that will eventually provide data.
-      const newMockDispatch = addMockDispatch(this[kDispatches], this[kDispatchKey], wrappedDefaultsCallback)
+      const newMockDispatch = addMockDispatch(this[kDispatches], this[kDispatchKey], wrappedDefaultsCallback, { ignoreTrailingSlash: this[kIgnoreTrailingSlash] })
       return new MockScope(newMockDispatch)
     }
 
@@ -154,7 +156,7 @@ class MockInterceptor {
 
     // Send in-already provided data like usual
     const dispatchData = this.createMockScopeDispatchData(replyParameters)
-    const newMockDispatch = addMockDispatch(this[kDispatches], this[kDispatchKey], dispatchData)
+    const newMockDispatch = addMockDispatch(this[kDispatches], this[kDispatchKey], dispatchData, { ignoreTrailingSlash: this[kIgnoreTrailingSlash] })
     return new MockScope(newMockDispatch)
   }
 
@@ -166,7 +168,7 @@ class MockInterceptor {
       throw new InvalidArgumentError('error must be defined')
     }
 
-    const newMockDispatch = addMockDispatch(this[kDispatches], this[kDispatchKey], { error })
+    const newMockDispatch = addMockDispatch(this[kDispatches], this[kDispatchKey], { error }, { ignoreTrailingSlash: this[kIgnoreTrailingSlash] })
     return new MockScope(newMockDispatch)
   }
 

package/lib/mock/mock-pool.js

@@ -10,7 +10,8 @@ const {
   kOriginalClose,
   kOrigin,
   kOriginalDispatch,
-  kConnected
+  kConnected,
+  kIgnoreTrailingSlash
 } = require('./mock-symbols')
 const { MockInterceptor } = require('./mock-interceptor')
 const Symbols = require('../core/symbols')
@@ -29,6 +30,7 @@ class MockPool extends Pool {
 
     this[kMockAgent] = opts.agent
     this[kOrigin] = origin
+    this[kIgnoreTrailingSlash] = opts.ignoreTrailingSlash ?? false
     this[kDispatches] = []
     this[kConnected] = 1
     this[kOriginalDispatch] = this.dispatch
@@ -46,7 +48,10 @@ class MockPool extends Pool {
    * Sets up the base interceptor for mocking replies from undici.
    */
   intercept (opts) {
-    return new MockInterceptor(opts, this[kDispatches])
+    return new MockInterceptor(
+      opts && { ignoreTrailingSlash: this[kIgnoreTrailingSlash], ...opts },
+      this[kDispatches]
+    )
   }
 
   async [kClose] () {

package/lib/mock/mock-symbols.js

@@ -20,5 +20,6 @@ module.exports = {
   kIsMockActive: Symbol('is mock active'),
   kNetConnect: Symbol('net connect'),
   kGetNetConnect: Symbol('get net connect'),
-  kConnected: Symbol('connected')
+  kConnected: Symbol('connected'),
+  kIgnoreTrailingSlash: Symbol('ignore trailing slash')
 }

package/lib/mock/mock-utils.js

@@ -8,7 +8,7 @@ const {
   kOrigin,
   kGetNetConnect
 } = require('./mock-symbols')
-const { buildURL } = require('../core/util')
+const { serializePathWithQuery } = require('../core/util')
 const { STATUS_CODES } = require('node:http')
 const {
   types: {
@@ -118,6 +118,10 @@ function matchKey (mockDispatch, { path, method, body, headers }) {
 function getResponseData (data) {
   if (Buffer.isBuffer(data)) {
     return data
+  } else if (data instanceof Uint8Array) {
+    return data
+  } else if (data instanceof ArrayBuffer) {
+    return data
   } else if (typeof data === 'object') {
     return JSON.stringify(data)
   } else {
@@ -126,11 +130,19 @@ function getResponseData (data) {
 }
 
 function getMockDispatch (mockDispatches, key) {
-  const basePath = key.query ? buildURL(key.path, key.query) : key.path
+  const basePath = key.query ? serializePathWithQuery(key.path, key.query) : key.path
   const resolvedPath = typeof basePath === 'string' ? safeUrl(basePath) : basePath
 
+  const resolvedPathWithoutTrailingSlash = removeTrailingSlash(resolvedPath)
+
   // Match path
-  let matchedMockDispatches = mockDispatches.filter(({ consumed }) => !consumed).filter(({ path }) => matchValue(safeUrl(path), resolvedPath))
+  let matchedMockDispatches = mockDispatches
+    .filter(({ consumed }) => !consumed)
+    .filter(({ path, ignoreTrailingSlash }) => {
+      return ignoreTrailingSlash
+        ? matchValue(removeTrailingSlash(safeUrl(path)), resolvedPathWithoutTrailingSlash)
+        : matchValue(safeUrl(path), resolvedPath)
+    })
   if (matchedMockDispatches.length === 0) {
     throw new MockNotMatchedError(`Mock dispatch not matched for path '${resolvedPath}'`)
   }
@@ -157,8 +169,8 @@ function getMockDispatch (mockDispatches, key) {
   return matchedMockDispatches[0]
 }
 
-function addMockDispatch (mockDispatches, key, data) {
-  const baseData = { timesInvoked: 0, times: 1, persist: false, consumed: false }
+function addMockDispatch (mockDispatches, key, data, opts) {
+  const baseData = { timesInvoked: 0, times: 1, persist: false, consumed: false, ...opts }
   const replyData = typeof data === 'function' ? { callback: data } : { ...data }
   const newMockDispatch = { ...baseData, ...key, pending: true, data: { error: null, ...replyData } }
   mockDispatches.push(newMockDispatch)
@@ -177,8 +189,24 @@ function deleteMockDispatch (mockDispatches, key) {
   }
 }
 
+/**
+ * @param {string} path Path to remove trailing slash from
+ */
+function removeTrailingSlash (path) {
+  while (path.endsWith('/')) {
+    path = path.slice(0, -1)
+  }
+
+  if (path.length === 0) {
+    path = '/'
+  }
+
+  return path
+}
+
 function buildKey (opts) {
   const { path, method, body, headers, query } = opts
+
   return {
     path,
     method,

package/lib/util/timers.js

@@ -14,9 +14,6 @@
  * Consequently, timers may trigger later than their scheduled time.
  */
 
-const nativeSetTimeout = global.setTimeout
-const nativeClearTimeout = global.clearTimeout
-
 /**
  * The fastNow variable contains the internal fast timer clock value.
  *
@@ -340,14 +337,14 @@ module.exports = {
     // If the delay is less than or equal to the RESOLUTION_MS value return a
     // native Node.js Timer instance.
     return delay <= RESOLUTION_MS
-      ? nativeSetTimeout(callback, delay, arg)
+      ? setTimeout(callback, delay, arg)
       : new FastTimer(callback, delay, arg)
   },
   /**
    * The clearTimeout method cancels an instantiated Timer previously created
    * by calling setTimeout.
    *
-   * @param {FastTimer} timeout
+   * @param {NodeJS.Timeout|FastTimer} timeout
    */
   clearTimeout (timeout) {
     // If the timeout is a FastTimer, call its own clear method.
@@ -359,9 +356,32 @@ module.exports = {
       // Otherwise it is an instance of a native NodeJS.Timeout, so call the
       // Node.js native clearTimeout function.
     } else {
-      nativeClearTimeout(timeout)
+      clearTimeout(timeout)
     }
   },
+  /**
+   * The setFastTimeout() method sets a fastTimer which executes a function once
+   * the timer expires.
+   * @param {Function} callback A function to be executed after the timer
+   * expires.
+   * @param {number} delay The time, in milliseconds that the timer should
+   * wait before the specified function or code is executed.
+   * @param {*} [arg] An optional argument to be passed to the callback function
+   * when the timer expires.
+   * @returns {FastTimer}
+   */
+  setFastTimeout (callback, delay, arg) {
+    return new FastTimer(callback, delay, arg)
+  },
+  /**
+   * The clearTimeout method cancels an instantiated FastTimer previously
+   * created by calling setFastTimeout.
+   *
+   * @param {FastTimer} timeout
+   */
+  clearFastTimeout (timeout) {
+    timeout.clear()
+  },
   /**
    * The now method returns the value of the internal fast timer clock.
    *
@@ -370,6 +390,30 @@ module.exports = {
   now () {
     return fastNow
   },
+  /**
+   * Trigger the onTick function to process the fastTimers array.
+   * Exported for testing purposes only.
+   * Marking as deprecated to discourage any use outside of testing.
+   * @deprecated
+   * @param {number} [delay=0] The delay in milliseconds to add to the now value.
+   */
+  tick (delay = 0) {
+    fastNow += delay - RESOLUTION_MS + 1
+    onTick()
+    onTick()
+  },
+  /**
+   * Reset FastTimers.
+   * Exported for testing purposes only.
+   * Marking as deprecated to discourage any use outside of testing.
+   * @deprecated
+   */
+  reset () {
+    fastNow = 0
+    fastTimers.length = 0
+    clearTimeout(fastNowTimeout)
+    fastNowTimeout = null
+  },
   /**
    * Exporting for testing purposes only.
    * Marking as deprecated to discourage any use outside of testing.

package/lib/web/cache/cache.js

@@ -1,12 +1,11 @@
 'use strict'
 
-const { kConstruct } = require('./symbols')
+const { kConstruct } = require('../../core/symbols')
 const { urlEquals, getFieldValues } = require('./util')
 const { kEnumerableProperty, isDisturbed } = require('../../core/util')
 const { webidl } = require('../fetch/webidl')
-const { Response, cloneResponse, fromInnerResponse } = require('../fetch/response')
-const { Request, fromInnerRequest } = require('../fetch/request')
-const { kState } = require('../fetch/symbols')
+const { cloneResponse, fromInnerResponse, getResponseState } = require('../fetch/response')
+const { Request, fromInnerRequest, getRequestState } = require('../fetch/request')
 const { fetching } = require('../fetch/index')
 const { urlIsHttpHttpsScheme, createDeferredPromise, readAllBytes } = require('../fetch/util')
 const assert = require('node:assert')
@@ -115,7 +114,7 @@ class Cache {
       }
 
       // 3.1
-      const r = request[kState]
+      const r = getRequestState(request)
 
       // 3.2
       if (!urlIsHttpHttpsScheme(r.url) || r.method !== 'GET') {
@@ -133,7 +132,7 @@ class Cache {
     // 5.
     for (const request of requests) {
       // 5.1
-      const r = new Request(request)[kState]
+      const r = getRequestState(new Request(request))
 
       // 5.2
       if (!urlIsHttpHttpsScheme(r.url)) {
@@ -269,10 +268,10 @@ class Cache {
     let innerRequest = null
 
     // 2.
-    if (request instanceof Request) {
-      innerRequest = request[kState]
+    if (webidl.is.Request(request)) {
+      innerRequest = getRequestState(request)
     } else { // 3.
-      innerRequest = new Request(request)[kState]
+      innerRequest = getRequestState(new Request(request))
     }
 
     // 4.
@@ -284,7 +283,7 @@ class Cache {
     }
 
     // 5.
-    const innerResponse = response[kState]
+    const innerResponse = getResponseState(response)
 
     // 6.
     if (innerResponse.status === 206) {
@@ -334,7 +333,7 @@ class Cache {
       const reader = stream.getReader()
 
       // 11.3
-      readAllBytes(reader).then(bodyReadPromise.resolve, bodyReadPromise.reject)
+      readAllBytes(reader, bodyReadPromise.resolve, bodyReadPromise.reject)
     } else {
       bodyReadPromise.resolve(undefined)
     }
@@ -401,8 +400,8 @@ class Cache {
      */
     let r = null
 
-    if (request instanceof Request) {
-      r = request[kState]
+    if (webidl.is.Request(request)) {
+      r = getRequestState(request)
 
       if (r.method !== 'GET' && !options.ignoreMethod) {
         return false
@@ -410,7 +409,7 @@ class Cache {
     } else {
       assert(typeof request === 'string')
 
-      r = new Request(request)[kState]
+      r = getRequestState(new Request(request))
     }
 
     /** @type {CacheBatchOperation[]} */
@@ -467,16 +466,16 @@ class Cache {
     // 2.
     if (request !== undefined) {
       // 2.1
-      if (request instanceof Request) {
+      if (webidl.is.Request(request)) {
         // 2.1.1
-        r = request[kState]
+        r = getRequestState(request)
 
         // 2.1.2
         if (r.method !== 'GET' && !options.ignoreMethod) {
           return []
         }
       } else if (typeof request === 'string') { // 2.2
-        r = new Request(request)[kState]
+        r = getRequestState(new Request(request))
       }
     }
 
@@ -514,6 +513,7 @@ class Cache {
       for (const request of requests) {
         const requestObject = fromInnerRequest(
           request,
+          undefined,
           new AbortController().signal,
           'immutable'
         )
@@ -748,9 +748,9 @@ class Cache {
 
     // 2.
     if (request !== undefined) {
-      if (request instanceof Request) {
+      if (webidl.is.Request(request)) {
         // 2.1.1
-        r = request[kState]
+        r = getRequestState(request)
 
         // 2.1.2
         if (r.method !== 'GET' && !options.ignoreMethod) {
@@ -758,7 +758,7 @@ class Cache {
         }
       } else if (typeof request === 'string') {
         // 2.2.1
-        r = new Request(request)[kState]
+        r = getRequestState(new Request(request))
       }
     }
 
@@ -847,7 +847,10 @@ webidl.converters.MultiCacheQueryOptions = webidl.dictionaryConverter([
   }
 ])
 
-webidl.converters.Response = webidl.interfaceConverter(Response)
+webidl.converters.Response = webidl.interfaceConverter(
+  webidl.is.Response,
+  'Response'
+)
 
 webidl.converters['sequence<RequestInfo>'] = webidl.sequenceConverter(
   webidl.converters.RequestInfo

package/lib/web/cache/cachestorage.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { kConstruct } = require('./symbols')
 const { Cache } = require('./cache')
 const { webidl } = require('../fetch/webidl')
 const { kEnumerableProperty } = require('../../core/util')
+const { kConstruct } = require('../../core/symbols')
 
 class CacheStorage {
   /**

package/lib/web/cookies/index.js

@@ -5,6 +5,8 @@ const { stringify } = require('./util')
 const { webidl } = require('../fetch/webidl')
 const { Headers } = require('../fetch/headers')
 
+const brandChecks = webidl.brandCheckMultiple([Headers, globalThis.Headers].filter(Boolean))
+
 /**
  * @typedef {Object} Cookie
  * @property {string} name
@@ -26,7 +28,7 @@ const { Headers } = require('../fetch/headers')
 function getCookies (headers) {
   webidl.argumentLengthCheck(arguments, 1, 'getCookies')
 
-  webidl.brandCheckMultiple(headers, [Headers, globalThis.Headers])
+  brandChecks(headers)
 
   const cookie = headers.get('cookie')
 
@@ -53,7 +55,7 @@ function getCookies (headers) {
  * @returns {void}
  */
 function deleteCookie (headers, name, attributes) {
-  webidl.brandCheckMultiple(headers, [Headers, globalThis.Headers])
+  brandChecks(headers)
 
   const prefix = 'deleteCookie'
   webidl.argumentLengthCheck(arguments, 2, prefix)
@@ -78,7 +80,7 @@ function deleteCookie (headers, name, attributes) {
 function getSetCookies (headers) {
   webidl.argumentLengthCheck(arguments, 1, 'getSetCookies')
 
-  webidl.brandCheckMultiple(headers, [Headers, globalThis.Headers])
+  brandChecks(headers)
 
   const cookies = headers.getSetCookie()
 
@@ -97,7 +99,7 @@ function getSetCookies (headers) {
 function setCookie (headers, cookie) {
   webidl.argumentLengthCheck(arguments, 2, 'setCookie')
 
-  webidl.brandCheckMultiple(headers, [Headers, globalThis.Headers])
+  brandChecks(headers)
 
   cookie = webidl.converters.Cookie(cookie)