@anjianshi/utils 3.8.1 → 3.8.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anjianshi/utils",
-  "version": "3.8.1",
+  "version": "3.8.3",
   "description": "Common JavaScript Utils",
   "homepage": "https://github.com/anjianshi/js-packages/utils",
   "bugs": {
@@ -39,11 +39,11 @@
     "typescript": "^5.8.3",
     "vconsole": "^3.15.1",
     "@anjianshi/presets-eslint-node": "6.1.2",
-    "@anjianshi/presets-prettier": "3.2.0",
-    "@anjianshi/presets-eslint-typescript": "6.1.2",
     "@anjianshi/presets-eslint-react": "6.1.3",
     "@anjianshi/presets-typescript": "3.2.5",
-    "@anjianshi/presets-eslint-base": "6.1.2"
+    "@anjianshi/presets-prettier": "3.2.0",
+    "@anjianshi/presets-eslint-base": "6.1.2",
+    "@anjianshi/presets-eslint-typescript": "6.1.2"
   },
   "prettier": "@anjianshi/presets-prettier/prettierrc"
 }

package/request/client.d.ts

@@ -12,6 +12,7 @@ export declare abstract class BaseRequestClient<FailedT extends Failed> {
     /** 生成一个快捷方式函数，调用它相当于调用 client.request() */
     asFunction(): <T>(inputUrl: string, inputOptions?: Options<T>) => Promise<Result<T, FailedT>>;
     request<T>(inputUrl: string, inputOptions?: Options<T>): Promise<Result<T, FailedT>>;
+    protected realRequest<T>(options: FormattedOptions): Promise<Result<T, FailedT>>;
     formatOptions<T>(input: Options<T>): Promise<FormattedOptions<T>>;
     /** 请求发起前调用此方法补充 Headers 内容 */
     protected getHeaders(options: FormattedOptions, inputOptions: Options): Record<string, string> | undefined | Promise<Record<string, string> | undefined>;
@@ -35,7 +36,7 @@ export declare abstract class BaseRequestClient<FailedT extends Failed> {
      * - 输出 Success 或 Failed 结果均可，但输出的 Failed 结果不会交给 makeFailedResult() 进行格式化，需自行保证符合 FailedT 约定。
      * - 若此方法抛出异常，会生成 FormatResponseDataFailed，此错误会照常交给 makeFailedResult() 处理。
      */
-    protected formatSuccessResult(result: Success<unknown>): Result<unknown, FailedT>;
+    protected formatSuccessResult(result: Success<unknown>, options: FormattedOptions): Result<unknown, FailedT>;
 }
 /** 默认的 RequestClient 实现。出现错误时，会把错误对象原样放入错误信息中。 */
 export declare class RequestClient extends BaseRequestClient<RequestFailed> {

package/request/client.js

@@ -30,6 +30,18 @@ export class BaseRequestClient {
             url: inputUrl,
             ...(inputOptions ?? {}),
         });
+        let result;
+        let tryCount = 0;
+        do {
+            tryCount += 1;
+            if (tryCount > 1) {
+                this.logger.warn('Retrying Request', { ...options, tryCount });
+            }
+            result = await this.realRequest(options);
+        } while (!result.success && tryCount <= options.retry + 1);
+        return result;
+    }
+    async realRequest(options) {
         const { url, method, headers, body, timeout, signal: manualSignal, format } = options;
         const timeoutSignal = timeout ? AbortSignal.timeout(timeout) : undefined;
         const signal = manualSignal || timeoutSignal
@@ -71,7 +83,7 @@ export class BaseRequestClient {
         // 格式化响应数据
         if (result.success) {
             try {
-                result = this.formatSuccessResult(result);
+                result = this.formatSuccessResult(result, options);
             }
             catch (error) {
                 return this.handleError(failed('Format Response Data Failed', 'FormatResponseDataFailed', {
@@ -103,7 +115,7 @@ export class BaseRequestClient {
     // -------------------------------
     async formatOptions(input) {
         const predefined = this.prefefinedOptions;
-        const { urlPrefix = predefined.urlPrefix ?? '', url: rawUrl, query = {}, method = predefined.method ?? 'GET', headers: rawHeaders = {}, body: rawBody = null, data, timeout = predefined.timeout ?? 0, binary = false, signal, format, } = input;
+        const { urlPrefix = predefined.urlPrefix ?? '', url: rawUrl, query = {}, method = predefined.method ?? 'GET', headers: rawHeaders = {}, body: rawBody = null, data, binary = false, timeout = predefined.timeout ?? 0, signal, retry = predefined.retry ?? 0, format, } = input;
         const headers = {
             ...(predefined.headers ?? {}),
             ...rawHeaders,
@@ -128,6 +140,7 @@ export class BaseRequestClient {
             binary,
             signal,
             format,
+            retry,
         };
         Object.assign(options.headers, await this.getHeaders(options, input));
         return options;
@@ -205,7 +218,9 @@ export class BaseRequestClient {
      * - 输出 Success 或 Failed 结果均可，但输出的 Failed 结果不会交给 makeFailedResult() 进行格式化，需自行保证符合 FailedT 约定。
      * - 若此方法抛出异常，会生成 FormatResponseDataFailed，此错误会照常交给 makeFailedResult() 处理。
      */
-    formatSuccessResult(result) {
+    formatSuccessResult(result, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    options) {
         return result;
     }
 }

package/request/options.d.ts

@@ -19,10 +19,12 @@ export interface Options<T = unknown> {
     timeout?: number;
     /** 可通过此信号手动终止请求 */
     signal?: AbortSignal;
+    /** 请求结果为失败（无论原因为何）时的重试次数，默认值为 0，表示不重试 */
+    retry?: number;
     /** 对请求成功时得到的数据进行最终格式化 */
     format?: (responseData: any) => T;
 }
 /** 可预指定的请求参数 */
-export type PredefinedOptions = Pick<Options, 'urlPrefix' | 'method' | 'headers' | 'timeout'>;
+export type PredefinedOptions = Pick<Options, 'urlPrefix' | 'method' | 'headers' | 'timeout' | 'retry'>;
 /** 经过整理的请求参数（client 内部使用） */
-export type FormattedOptions<T = unknown> = Required<Pick<Options, 'url' | 'method' | 'headers' | 'body' | 'timeout' | 'binary'>> & Pick<Options<T>, 'signal' | 'format'>;
+export type FormattedOptions<T = unknown> = Required<Pick<Options, 'url' | 'method' | 'headers' | 'body' | 'binary' | 'timeout' | 'retry'>> & Pick<Options<T>, 'signal' | 'format'>;