undici 7.0.0-alpha.7 → 7.0.0-alpha.9

package/docs/docs/api/Dispatcher.md

@@ -207,7 +207,7 @@ Returns: `Boolean` - `false` if dispatcher is busy and further dispatch calls wo
 
 * **onRequestStart** `(controller: DispatchController, context: object) => void` - Invoked before request is dispatched on socket. May be invoked multiple times when a request is retried when the request at the head of the pipeline fails.
 * **onRequestUpgrade** `(controller: DispatchController, statusCode: number, headers: Record<string, string | string[]>, socket: Duplex) => void` (optional) - Invoked when request is upgraded. Required if `DispatchOptions.upgrade` is defined or `DispatchOptions.method === 'CONNECT'`.
-* **onResponseStart** `(controller: DispatchController, statusCode: number, statusMessage?: string, headers: Record<string, string | string []>) => void` - Invoked when statusCode and headers have been received. May be invoked multiple times due to 1xx informational headers. Not required for `upgrade` requests.
+* **onResponseStart** `(controller: DispatchController, statusCode: number, headers: Record<string, string | string []>, statusMessage?: string) => void` - Invoked when statusCode and headers have been received. May be invoked multiple times due to 1xx informational headers. Not required for `upgrade` requests.
 * **onResponseData** `(controller: DispatchController, chunk: Buffer) => void` - Invoked when response payload data is received. Not required for `upgrade` requests.
 * **onResponseEnd** `(controller: DispatchController, trailers: Record<string, string | string[]>) => void` - Invoked when response payload and trailers have been received and the request has completed. Not required for `upgrade` requests.
 * **onResponseError** `(error: Error) => void` - Invoked when an error has occurred. May not throw.
@@ -1054,203 +1054,27 @@ const response = await client.request({
 })
 ```
 
-##### `Response Error Interceptor`
+##### `responseError`
 
-**Introduction**
+The `responseError` interceptor throws an error for responses with status code errors (>= 400).
 
-The Response Error Interceptor is designed to handle HTTP response errors efficiently. It intercepts responses and throws detailed errors for responses with status codes indicating failure (4xx, 5xx). This interceptor enhances error handling by providing structured error information, including response headers, data, and status codes.
-
-**ResponseError Class**
-
-The `ResponseError` class extends the `UndiciError` class and encapsulates detailed error information. It captures the response status code, headers, and data, providing a structured way to handle errors.
-
-**Definition**
-
-```js
-class ResponseError extends UndiciError {
-  constructor (message, code, { headers, data }) {
-    super(message);
-    this.name = 'ResponseError';
-    this.message = message || 'Response error';
-    this.code = 'UND_ERR_RESPONSE';
-    this.statusCode = code;
-    this.data = data;
-    this.headers = headers;
-  }
-}
-```
-
-**Interceptor Handler**
-
-The interceptor's handler class extends `DecoratorHandler` and overrides methods to capture response details and handle errors based on the response status code.
-
-**Methods**
-
-- **onConnect**: Initializes response properties.
-- **onHeaders**: Captures headers and status code. Decodes body if content type is `application/json` or `text/plain`.
-- **onData**: Appends chunks to the body if status code indicates an error.
-- **onComplete**: Finalizes error handling, constructs a `ResponseError`, and invokes the `onError` method.
-- **onError**: Propagates errors to the handler.
-
-**Definition**
-
-```js
-class Handler extends DecoratorHandler {
-  // Private properties
-  #handler;
-  #statusCode;
-  #contentType;
-  #decoder;
-  #headers;
-  #body;
-
-  constructor (opts, { handler }) {
-    super(handler);
-    this.#handler = handler;
-  }
-
-  onConnect (abort) {
-    this.#statusCode = 0;
-    this.#contentType = null;
-    this.#decoder = null;
-    this.#headers = null;
-    this.#body = '';
-    return this.#handler.onConnect(abort);
-  }
-
-  onHeaders (statusCode, rawHeaders, resume, statusMessage, headers = parseHeaders(rawHeaders)) {
-    this.#statusCode = statusCode;
-    this.#headers = headers;
-    this.#contentType = headers['content-type'];
-
-    if (this.#statusCode < 400) {
-      return this.#handler.onHeaders(statusCode, rawHeaders, resume, statusMessage, headers);
-    }
-
-    if (this.#contentType === 'application/json' || this.#contentType === 'text/plain') {
-      this.#decoder = new TextDecoder('utf-8');
-    }
-  }
-
-  onData (chunk) {
-    if (this.#statusCode < 400) {
-      return this.#handler.onData(chunk);
-    }
-    this.#body += this.#decoder?.decode(chunk, { stream: true }) ?? '';
-  }
-
-  onComplete (rawTrailers) {
-    if (this.#statusCode >= 400) {
-      this.#body += this.#decoder?.decode(undefined, { stream: false }) ?? '';
-      if (this.#contentType === 'application/json') {
-        try {
-          this.#body = JSON.parse(this.#body);
-        } catch {
-          // Do nothing...
-        }
-      }
-
-      let err;
-      const stackTraceLimit = Error.stackTraceLimit;
-      Error.stackTraceLimit = 0;
-      try {
-        err = new ResponseError('Response Error', this.#statusCode, this.#headers, this.#body);
-      } finally {
-        Error.stackTraceLimit = stackTraceLimit;
-      }
-
-      this.#handler.onError(err);
-    } else {
-      this.#handler.onComplete(rawTrailers);
-    }
-  }
-
-  onError (err) {
-    this.#handler.onError(err);
-  }
-}
-
-module.exports = (dispatch) => (opts, handler) => opts.throwOnError
-  ? dispatch(opts, new Handler(opts, { handler }))
-  : dispatch(opts, handler);
-```
-
-**Tests**
-
-Unit tests ensure the interceptor functions correctly, handling both error and non-error responses appropriately.
-
-**Example Tests**
-
-- **No Error if `throwOnError` is False**:
+**Example**
 
 ```js
-test('should not error if request is not meant to throw error', async (t) => {
-  const opts = { throwOnError: false };
-  const handler = { onError: () => {}, onData: () => {}, onComplete: () => {} };
-  const interceptor = createResponseErrorInterceptor((opts, handler) => handler.onComplete());
-  assert.doesNotThrow(() => interceptor(opts, handler));
-});
-```
-
-- **Error if Status Code is in Specified Error Codes**:
-
-```js
-test('should error if request status code is in the specified error codes', async (t) => {
-  const opts = { throwOnError: true, statusCodes: [500] };
-  const response = { statusCode: 500 };
-  let capturedError;
-  const handler = {
-    onError: (err) => { capturedError = err; },
-    onData: () => {},
-    onComplete: () => {}
-  };
-
-  const interceptor = createResponseErrorInterceptor((opts, handler) => {
-    if (opts.throwOnError && opts.statusCodes.includes(response.statusCode)) {
-      handler.onError(new Error('Response Error'));
-    } else {
-      handler.onComplete();
-    }
-  });
-
-  interceptor({ ...opts, response }, handler);
-
-  await new Promise(resolve => setImmediate(resolve));
-
-  assert(capturedError, 'Expected error to be captured but it was not.');
-  assert.strictEqual(capturedError.message, 'Response Error');
-  assert.strictEqual(response.statusCode, 500);
-});
-```
-
-- **No Error if Status Code is Not in Specified Error Codes**:
+const { Client, interceptors } = require("undici");
+const { responseError } = interceptors;
 
-```js
-test('should not error if request status code is not in the specified error codes', async (t) => {
-  const opts = { throwOnError: true, statusCodes: [500] };
-  const response = { statusCode: 404 };
-  const handler = {
-    onError: () => {},
-    onData: () => {},
-    onComplete: () => {}
-  };
-
-  const interceptor = createResponseErrorInterceptor((opts, handler) => {
-    if (opts.throwOnError && opts.statusCodes.includes(response.statusCode)) {
-      handler.onError(new Error('Response Error'));
-    } else {
-      handler.onComplete();
-    }
-  });
+const client = new Client("http://example.com").compose(
+  responseError()
+);
 
-  assert.doesNotThrow(() => interceptor({ ...opts, response }, handler));
+// Will throw a ResponseError for status codes >= 400
+await client.request({
+  method: "GET",
+  path: "/"
 });
 ```
 
-**Conclusion**
-
-The Response Error Interceptor provides a robust mechanism for handling HTTP response errors by capturing detailed error information and propagating it through a structured `ResponseError` class. This enhancement improves error handling and debugging capabilities in applications using the interceptor.
-
 ##### `Cache Interceptor`
 
 The `cache` interceptor implements client-side response caching as described in
@@ -1260,6 +1084,8 @@ The `cache` interceptor implements client-side response caching as described in
 
 - `store` - The [`CacheStore`](/docs/docs/api/CacheStore.md) to store and retrieve responses from. Default is [`MemoryCacheStore`](/docs/docs/api/CacheStore.md#memorycachestore).
 - `methods` - The [**safe** HTTP methods](https://www.rfc-editor.org/rfc/rfc9110#section-9.2.1) to cache the response of.
+- `cacheByDefault` - The default expiration time to cache responses by if they don't have an explicit expiration. If this isn't present, responses without explicit expiration will not be cached. Default `undefined`.
+- `type` - The type of cache for Undici to act as. Can be `shared` or `private`. Default `shared`.
 
 ## Instance Events
 

package/index.js

@@ -38,6 +38,7 @@ module.exports.DecoratorHandler = DecoratorHandler
 module.exports.RedirectHandler = RedirectHandler
 module.exports.interceptors = {
   redirect: require('./lib/interceptor/redirect'),
+  responseError: require('./lib/interceptor/response-error'),
   retry: require('./lib/interceptor/retry'),
   dump: require('./lib/interceptor/dump'),
   dns: require('./lib/interceptor/dns'),

package/lib/cache/memory-cache-store.js

@@ -89,7 +89,9 @@ class MemoryCacheStore {
           statusCode: entry.statusCode,
           headers: entry.headers,
           body: entry.body,
+          vary: entry.vary ? entry.vary : undefined,
           etag: entry.etag,
+          cacheControlDirectives: entry.cacheControlDirectives,
           cachedAt: entry.cachedAt,
           staleAt: entry.staleAt,
           deleteAt: entry.deleteAt

package/lib/cache/sqlite-cache-store.js

@@ -4,7 +4,10 @@ const { DatabaseSync } = require('node:sqlite')
 const { Writable } = require('stream')
 const { assertCacheKey, assertCacheValue } = require('../util/cache.js')
 
-const VERSION = 2
+const VERSION = 3
+
+// 2gb
+const MAX_ENTRY_SIZE = 2 * 1000 * 1000 * 1000
 
 /**
  * @typedef {import('../../types/cache-interceptor.d.ts').default.CacheStore} CacheStore
@@ -17,8 +20,8 @@ const VERSION = 2
  *  body: string
  * } & import('../../types/cache-interceptor.d.ts').default.CacheValue} SqliteStoreValue
  */
-class SqliteCacheStore {
-  #maxEntrySize = Infinity
+module.exports = class SqliteCacheStore {
+  #maxEntrySize = MAX_ENTRY_SIZE
   #maxCount = Infinity
 
   /**
@@ -78,6 +81,11 @@ class SqliteCacheStore {
         ) {
           throw new TypeError('SqliteCacheStore options.maxEntrySize must be a non-negative integer')
         }
+
+        if (opts.maxEntrySize > MAX_ENTRY_SIZE) {
+          throw new TypeError('SqliteCacheStore options.maxEntrySize must be less than 2gb')
+        }
+
         this.#maxEntrySize = opts.maxEntrySize
       }
 
@@ -103,11 +111,12 @@ class SqliteCacheStore {
         method TEXT NOT NULL,
 
         -- Data returned to the interceptor
-        body TEXT NULL,
+        body BUF NULL,
         deleteAt INTEGER NOT NULL,
         statusCode INTEGER NOT NULL,
         statusMessage TEXT NOT NULL,
         headers TEXT NULL,
+        cacheControlDirectives TEXT NULL,
         etag TEXT NULL,
         vary TEXT NULL,
         cachedAt INTEGER NOT NULL,
@@ -128,6 +137,7 @@ class SqliteCacheStore {
         statusMessage,
         headers,
         etag,
+        cacheControlDirectives,
         vary,
         cachedAt,
         staleAt
@@ -147,6 +157,7 @@ class SqliteCacheStore {
         statusMessage = ?,
         headers = ?,
         etag = ?,
+        cacheControlDirectives = ?,
         cachedAt = ?,
         staleAt = ?,
         deleteAt = ?
@@ -164,11 +175,12 @@ class SqliteCacheStore {
         statusMessage,
         headers,
         etag,
+        cacheControlDirectives,
         vary,
         cachedAt,
         staleAt,
         deleteAt
-      ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+      ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
     `)
 
     this.#deleteByUrlQuery = this.#db.prepare(
@@ -218,11 +230,15 @@ class SqliteCacheStore {
      * @type {import('../../types/cache-interceptor.d.ts').default.GetResult}
      */
     const result = {
-      body: value.body ? parseBufferArray(JSON.parse(value.body)) : null,
+      body: Buffer.from(value.body),
       statusCode: value.statusCode,
       statusMessage: value.statusMessage,
       headers: value.headers ? JSON.parse(value.headers) : undefined,
       etag: value.etag ? value.etag : undefined,
+      vary: value.vary ?? undefined,
+      cacheControlDirectives: value.cacheControlDirectives
+        ? JSON.parse(value.cacheControlDirectives)
+        : undefined,
       cachedAt: value.cachedAt,
       staleAt: value.staleAt,
       deleteAt: value.deleteAt
@@ -269,12 +285,13 @@ class SqliteCacheStore {
         if (existingValue) {
           // Updating an existing response, let's overwrite it
           store.#updateValueQuery.run(
-            JSON.stringify(stringifyBufferArray(body)),
+            Buffer.concat(body),
             value.deleteAt,
             value.statusCode,
             value.statusMessage,
             value.headers ? JSON.stringify(value.headers) : null,
-            value.etag,
+            value.etag ? value.etag : null,
+            value.cacheControlDirectives ? JSON.stringify(value.cacheControlDirectives) : null,
             value.cachedAt,
             value.staleAt,
             value.deleteAt,
@@ -286,12 +303,13 @@ class SqliteCacheStore {
           store.#insertValueQuery.run(
             url,
             key.method,
-            JSON.stringify(stringifyBufferArray(body)),
+            Buffer.concat(body),
             value.deleteAt,
             value.statusCode,
             value.statusMessage,
             value.headers ? JSON.stringify(value.headers) : null,
             value.etag ? value.etag : null,
+            value.cacheControlDirectives ? JSON.stringify(value.cacheControlDirectives) : null,
             value.vary ? JSON.stringify(value.vary) : null,
             value.cachedAt,
             value.staleAt,
@@ -316,7 +334,7 @@ class SqliteCacheStore {
   }
 
   #prune () {
-    if (this.#size <= this.#maxCount) {
+    if (this.size <= this.#maxCount) {
       return 0
     }
 
@@ -341,7 +359,7 @@ class SqliteCacheStore {
    * Counts the number of rows in the cache
    * @returns {Number}
    */
-  get #size () {
+  get size () {
     const { total } = this.#countEntriesQuery.get()
     return total
   }
@@ -385,10 +403,10 @@ class SqliteCacheStore {
           return undefined
         }
 
-        const vary = JSON.parse(value.vary)
+        value.vary = JSON.parse(value.vary)
 
-        for (const header in vary) {
-          if (headerValueEquals(headers[header], vary[header])) {
+        for (const header in value.vary) {
+          if (!headerValueEquals(headers[header], value.vary[header])) {
             matches = false
             break
           }
@@ -426,32 +444,3 @@ function headerValueEquals (lhs, rhs) {
 
   return lhs === rhs
 }
-
-/**
- * @param {Buffer[]} buffers
- * @returns {string[]}
- */
-function stringifyBufferArray (buffers) {
-  const output = new Array(buffers.length)
-  for (let i = 0; i < buffers.length; i++) {
-    output[i] = buffers[i].toString()
-  }
-
-  return output
-}
-
-/**
- * @param {string[]} strings
- * @returns {Buffer[]}
- */
-function parseBufferArray (strings) {
-  const output = new Array(strings.length)
-
-  for (let i = 0; i < strings.length; i++) {
-    output[i] = Buffer.from(strings[i])
-  }
-
-  return output
-}
-
-module.exports = SqliteCacheStore

package/lib/core/errors.js

@@ -196,13 +196,13 @@ class RequestRetryError extends UndiciError {
 }
 
 class ResponseError extends UndiciError {
-  constructor (message, code, { headers, data }) {
+  constructor (message, code, { headers, body }) {
     super(message)
     this.name = 'ResponseError'
     this.message = message || 'Response error'
     this.code = 'UND_ERR_RESPONSE'
     this.statusCode = code
-    this.data = data
+    this.body = body
     this.headers = headers
   }
 }

package/lib/dispatcher/dispatcher-base.js

@@ -130,6 +130,8 @@ class DispatcherBase extends Dispatcher {
       throw new InvalidArgumentError('handler must be an object')
     }
 
+    handler = UnwrapHandler.unwrap(handler)
+
     try {
       if (!opts || typeof opts !== 'object') {
         throw new InvalidArgumentError('opts must be an object.')
@@ -143,10 +145,10 @@ class DispatcherBase extends Dispatcher {
         throw new ClientClosedError()
       }
 
-      return this[kDispatch](opts, UnwrapHandler.unwrap(handler))
+      return this[kDispatch](opts, handler)
     } catch (err) {
       if (typeof handler.onError !== 'function') {
-        throw new InvalidArgumentError('invalid onError method')
+        throw err
       }
 
       handler.onError(err)