nstarter-http-request 0.1.12 → 0.1.14

package/src/utils/redirect.ts

@@ -0,0 +1,163 @@
+import type {
+    HttpRequestOptions,
+    HttpResponse
+} from '../types';
+import { HttpError } from '../types';
+import { Readable } from 'node:stream';
+import { EClientAdapter } from '../const';
+
+/**
+ * 交给调用方跟跳的状态码，与 undici 的 redirectableStatusCodes 一致。
+ * 304 表示未修改，305 表示改走代理，306 已废弃，这三类不跟。
+ */
+const REDIRECT_STATUS: ReadonlySet<number> = new Set([
+    300,
+    301,
+    302,
+    303,
+    307,
+    308
+]);
+
+/**
+ * 判断状态码是否需要跟跳。
+ * @param status HTTP 状态码
+ */
+export function isRedirectStatus(status: number): boolean {
+    return REDIRECT_STATUS.has(status);
+}
+
+/**
+ * 根据响应里的 Location 构造下一跳请求。
+ * 没有 Location 时返回 undefined，调用方把当前 3xx 原样返回。
+ * axios：POST 的 301/302，以及非 GET/HEAD 的 303，改成 GET 并去掉 body 和 content-*。
+ * undici：只有非 HEAD 的 303 改成 GET 并去掉 body；303 仍去掉 content-*。
+ * 两边都去掉 host；跨域去掉 authorization、cookie、proxy-authorization。
+ * @param options 当前这一跳的请求
+ * @param response 当前这一跳的响应
+ * @param adapter 当前适配器
+ * @param configuredTimeout 客户端配置中的超时。请求未单独设置时使用。
+ */
+export function buildRedirectOptions(
+    options: HttpRequestOptions,
+    response: HttpResponse,
+    adapter: EClientAdapter,
+    configuredTimeout?: number
+): HttpRequestOptions | undefined {
+    const location = response.headers?.location;
+    if (!location) {
+        return;
+    }
+    const status = response.status;
+    const currentUrl = new URL(options.url);
+    const nextUrl = new URL(location, currentUrl);
+    const headers = { ...options.headers };
+    const crossOrigin = currentUrl.origin !== nextUrl.origin;
+    const rewriteToGet = shouldRewriteToGet(adapter, status, options.method);
+    const removeContentHeaders = adapter === EClientAdapter.axios
+        ? rewriteToGet
+        : status === 303;
+        
+    // 清理请求头
+    for (const key of Object.keys(headers)) {
+        const name = key.toLowerCase();
+        if (
+            name === 'host'
+            || (removeContentHeaders && name.startsWith('content-'))
+            || (crossOrigin && (name === 'authorization' || name === 'cookie' || name === 'proxy-authorization'))
+        ) {
+            delete headers[key];
+        }
+    }
+    const nextOptions: HttpRequestOptions = {
+        ...options,
+        url: nextUrl.toString(),
+        params: undefined,
+        headers,
+        timeout: options.timeout ?? configuredTimeout,
+        meta: options.meta ? { ...options.meta } : undefined
+    };
+    // 清理 meta 中的正向代理信息
+    if (nextOptions.meta) {
+        delete nextOptions.meta.__forwardProxy;
+    }
+    if (rewriteToGet) {
+        nextOptions.method = 'GET';
+        nextOptions.body = undefined;
+    } else if (!isReplayable(options.body)) {
+        throw new Error('Request body is not replayable');
+    }
+    return nextOptions;
+}
+
+/**
+ * axios 的 301/302 只改 POST。undici 的 301/302 保持原方法。
+ * 303 时两边都把非 HEAD 改成 GET；axios 额外保留已经是 GET 的请求。
+ */
+function shouldRewriteToGet(adapter: EClientAdapter, status: number, method: HttpRequestOptions['method']): boolean {
+    if (adapter === EClientAdapter.axios) {
+        return ((status === 301 || status === 302) && method === 'POST')
+            || (status === 303 && method !== 'GET' && method !== 'HEAD');
+    }
+    return status === 303 && method !== 'HEAD';
+}
+
+/**
+ * 字符串、Buffer、普通对象每次都能重新序列化。
+ * 流和异步可迭代对象读过一次就不能再发。
+ */
+function isReplayable(body: unknown): boolean {
+    if (
+        body === null
+        || body === undefined
+        || typeof body === 'string'
+        || typeof body === 'number'
+        || typeof body === 'boolean'
+        || Buffer.isBuffer(body)
+        || body instanceof ArrayBuffer
+        || ArrayBuffer.isView(body)
+        || body instanceof URLSearchParams
+        || (typeof Blob !== 'undefined' && body instanceof Blob)
+        || (typeof FormData !== 'undefined' && body instanceof FormData)
+    ) {
+        return true;
+    }
+    if (body instanceof Readable) {
+        return false;
+    }
+    if (typeof body !== 'object') {
+        return true;
+    }
+    const candidate = body as {
+        getReader?: unknown,
+        [Symbol.asyncIterator]?: unknown
+    };
+    return typeof candidate.getReader !== 'function'
+        && typeof candidate[Symbol.asyncIterator] !== 'function';
+}
+
+/**
+ * 跟跳共用同一次超时。把本跳已经花掉的时间从 redirectOptions.timeout 扣掉。
+ * @param redirectOptions 下一跳请求
+ * @param startTime 本跳开始时间
+ */
+export function consumeRedirectTimeout(
+    redirectOptions: HttpRequestOptions,
+    startTime: number
+): void {
+    const timeout = redirectOptions.timeout;
+    if (typeof timeout !== 'number' || !Number.isFinite(timeout) || timeout <= 0) {
+        return;
+    }
+    const remaining = timeout - (Date.now() - startTime);
+    if (remaining <= 0) {
+        throw new HttpError(
+            `timeout of ${ timeout }ms exceeded`,
+            'ECONNABORTED',
+            undefined,
+            undefined,
+            redirectOptions
+        );
+    }
+    redirectOptions.timeout = remaining;
+}