feat: add the disableThrowResponseError option for return full response when api fails

Author: Boelroy

packages/console-utils/xconsole-service/src/interceptors/consoleInterceptor/response.ts

@@ -3,7 +3,6 @@ import { IError, IResponse, IResponseData } from '../../types';
 import { ApiType } from '../../const/index';
 import { AxiosResponse } from 'axios';
 
-
 const injectErrorPromptAdaptor = (error: IError, response: AxiosResponse) => {
   error.response = response;
   error.code = response.data?.code;
@@ -21,17 +20,14 @@ function consoleResponseInterceptor(
 ): IResponse<IResponseData> {
   const {
     data: apiResponseData,
-    config: { apiType, ignoreError, risk = {} },
+    config: { apiType, ignoreError, disableThrowResponseError, risk = {} },
   } = response;
 
   if (apiType === ApiType.custom) return response;
 
-  if (
-    // Single api succeeded -> code 200, withFailedRequest undefined
-    // Multi api succeeded  -> code 200, withFailedRequest false
-    apiResponseData.code === '200' &&
-    apiResponseData.withFailedRequest !== true
-  ) {
+  // Single api succeeded -> code 200, withFailedRequest undefined
+  // Multi api succeeded  -> code 200, withFailedRequest false
+  if (apiResponseData.code === '200' && apiResponseData.withFailedRequest !== true ) {
     return response;
   }
 
@@ -41,36 +37,29 @@ function consoleResponseInterceptor(
     return response;
   }
 
-  if (
-    // Multi api with failed request
-    apiResponseData.code === '200' &&
-    apiResponseData.withFailedRequest === true
-  ) {
-    const error: IError = new Error('Multi OpenAPI calls with failed request.');
-    injectErrorPromptAdaptor(error, response);
-    if (ignoreError !== true) {
-      throw error;
-    }
-    return response;
+  let error: IError = new Error('OpenAPI failed without a message.');
+
+  // Multi api with failed request 
+  if (apiResponseData.code === '200' && apiResponseData.withFailedRequest === true ) {
+    error = new Error('Multi OpenAPI calls with failed request.');
   }
 
+  // Single api failed with an error message
   if (apiResponseData.message) {
-    // Single api failed with an error message
-    const error: IError = new Error(apiResponseData.message);
-    injectErrorPromptAdaptor(error, response);
-    if (ignoreError !== true) {
-      throw error;
-    }
-    return response;
+    error = new Error(apiResponseData.message);
   }
-  // Single api failed without an error message
-  const error: IError = new Error('OpenAPI failed without a message.');
+
+  // 适配 error-proxy
   injectErrorPromptAdaptor(error, response);
 
-  if (ignoreError !== true) {
+  // 历史有个 ignoreError 的配置 已经被 deprecate 掉了，为了兼容历史逻辑。本身是 widget 里面给弹窗使用的
+  // 新的参数都是 disableThrowResponseError, 在设置了 disableThrowResponseError 会不 throw error
+  if (!disableThrowResponseError && ignoreError !== true) {
     throw error;
   }
 
+  response.config.rawResponseData = disableThrowResponseError;
+
   return response;
 }
 

packages/console-utils/xconsole-service/src/service.ts

@@ -72,7 +72,8 @@ const createDefaultService = <R, P>(requestInstance: AxiosInstance, product: str
       risk: opts.risk,
     } as AxiosRequestConfig);
 
-    return opts?.rawResponseData ? res.data : res.data.data;
+    //@ts-ignore
+    return res.config.rawResponseData ? res.data : res.data.data;
   };
 }
 

packages/console-utils/xconsole-service/src/types.ts

@@ -45,6 +45,10 @@ export interface IOptions extends AxiosRequestConfig {
   mock?: boolean;
   region?: string;
   rawResponseData?: boolean;
+  /**
+   * 在请求失败的时候不 throw Error 而是直接返回请求对象
+   */
+  disableThrowResponseError?: boolean;
   throwDoubleConfirmError?: boolean;
 }
 

packages/console-utils/xconsole-service/stories/index.stories.tsx

@@ -45,7 +45,21 @@ storiesOf('XConsole Service', module)
   })
   .add('createService', () => {
     useEffect(() => {
-      createService('xxxx', 'test', {apiType: ApiType.open})({ xxxx:1 })
+      (async () => {
+        try {
+          const a = await createService('xxxx', 'test', {apiType: ApiType.open, disableThrowResponseError: true})({ xxxx:1 })
+          console.log('a', a)
+          const b = await createService('xxxx', 'test', {apiType: ApiType.open, ignoreError: true})({ xxxx:1 })
+          console.log('b', b)
+          const c = await createService('ecs', 'DescribeInstances', {apiType: ApiType.open, rawResponseData: true})({ xxxx:1 })
+          console.log('c', c)
+          const e = await createService('ecs', 'DescribeInstances', {apiType: ApiType.open})({ xxxx:1 })
+          console.log('e', e)
+          await createService('xxxx', 'test', {apiType: ApiType.open})({ xxxx:1 })
+        } catch (e) {
+          console.error('d', e)
+        }
+      })()
     });
 
     return <div></div>