!docs/docs/**/*

!scripts/strip-comments.js

test/request-timeout.10mb.bin

);

**Introduction**

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**

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**

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);

- **No Error if `throwOnError` is False**:

```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));

});

```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);

});

```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();

}

});

assert.doesNotThrow(() => interceptor({ ...opts, response }, handler));

});

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.

- **retry** `(err: Error, context: RetryContext, callback: (err?: Error | null) => void) => number | null` (optional) - Function to be called after every retry. It should pass error if no more retries should be performed.

- **maxRetries** `number` (optional) - Maximum number of retries. Default: `5`

- **maxTimeout** `number` (optional) - Maximum number of milliseconds to wait before retrying. Default: `30000` (30 seconds)

- **minTimeout** `number` (optional) - Minimum number of milliseconds to wait before retrying. Default: `500` (half a second)

}

onUpgrade (statusCode, rawHeaders, socket) {

assert(statusCode === 101)

const { callback, opaque, context } = this

removeSignal(this)