fix(axios): 修复当自定义拦截器解包响应数据时，请求返回 undefined 的问题

Author: ethanz-code

.changeset/wicked-pillows-juggle.md

@@ -0,0 +1,5 @@
+---
+"@ethan-utils/axios": patch
+---
+
+修复当自定义拦截器解包响应数据时，请求返回 undefined 的问题

packages/axios/index.ts

@@ -98,6 +98,24 @@ const formatError = <T>(error: unknown): BaseResponse<T> => {
   } as BaseResponse<T>;
 };
 
+/**
+ * 智能解包响应数据
+ * 判断是否为 AxiosResponse，如果是则返回 data，否则直接返回 response
+ */
+const unwrapResponse = <T>(response: unknown): T => {
+  if (
+    response &&
+    typeof response === "object" &&
+    "data" in response &&
+    "status" in response &&
+    "headers" in response &&
+    "config" in response
+  ) {
+    return (response as any).data as T;
+  }
+  return response as T;
+};
+
 /**
  * 创建 API 客户端，包含常用请求方法和原始请求方法（raw）
  * @param api Axios 实例
@@ -108,7 +126,7 @@ function createClient(api: AxiosInstance): ApiClient {
     /** GET 请求，直接返回后端数据，失败抛出异常 */
     async get<T>(url: string, config?: AxiosRequestConfig): Promise<T> {
       const response = await api.get<T>(url, config);
-      return response.data;
+      return unwrapResponse<T>(response);
     },
     /** GET 标准请求，返回 BaseResponse 格式，错误会被转换为标准响应 */
     async getStandard<T, R extends BaseResponse<T> = BaseResponse<T>>(
@@ -117,7 +135,7 @@ function createClient(api: AxiosInstance): ApiClient {
     ): Promise<R> {
       try {
         const response = await api.get<R>(url, config);
-        return response.data;
+        return unwrapResponse<R>(response);
       } catch (error: unknown) {
         return formatError<T>(error) as R;
       }
@@ -129,7 +147,7 @@ function createClient(api: AxiosInstance): ApiClient {
       config?: AxiosRequestConfig,
     ): Promise<T> {
       const response = await api.post<T>(url, data, config);
-      return response.data;
+      return unwrapResponse<T>(response);
     },
     /** POST 标准请求，返回 BaseResponse 格式，错误会被转换为标准响应 */
     async postStandard<T, R extends BaseResponse<T> = BaseResponse<T>>(
@@ -139,7 +157,7 @@ function createClient(api: AxiosInstance): ApiClient {
     ): Promise<R> {
       try {
         const response = await api.post<R>(url, data, config);
-        return response.data;
+        return unwrapResponse<R>(response);
       } catch (error: unknown) {
         return formatError<T>(error) as R;
       }
@@ -151,7 +169,7 @@ function createClient(api: AxiosInstance): ApiClient {
       config?: AxiosRequestConfig,
     ): Promise<T> {
       const response = await api.put<T>(url, data, config);
-      return response.data;
+      return unwrapResponse<T>(response);
     },
     /** PUT 标准请求，返回 BaseResponse 格式，错误会被转换为标准响应 */
     async putStandard<T, R extends BaseResponse<T> = BaseResponse<T>>(
@@ -161,15 +179,15 @@ function createClient(api: AxiosInstance): ApiClient {
     ): Promise<R> {
       try {
         const response = await api.put<R>(url, data, config);
-        return response.data;
+        return unwrapResponse<R>(response);
       } catch (error: unknown) {
         return formatError<T>(error) as R;
       }
     },
     /** DELETE 请求，直接返回后端数据，失败抛出异常 */
     async delete<T>(url: string, config?: AxiosRequestConfig): Promise<T> {
       const response = await api.delete<T>(url, config);
-      return response.data;
+      return unwrapResponse<T>(response);
     },
     /** DELETE 标准请求，返回 BaseResponse 格式，错误会被转换为标准响应 */
     async deleteStandard<T, R extends BaseResponse<T> = BaseResponse<T>>(
@@ -178,7 +196,7 @@ function createClient(api: AxiosInstance): ApiClient {
     ): Promise<R> {
       try {
         const response = await api.delete<R>(url, config);
-        return response.data;
+        return unwrapResponse<R>(response);
       } catch (error: unknown) {
         return formatError<T>(error) as R;
       }
@@ -190,7 +208,7 @@ function createClient(api: AxiosInstance): ApiClient {
       config?: AxiosRequestConfig,
     ): Promise<T> {
       const response = await api.patch<T>(url, data, config);
-      return response.data;
+      return unwrapResponse<T>(response);
     },
     /** PATCH 标准请求，返回 BaseResponse 格式，错误会被转换为标准响应 */
     async patchStandard<T, R extends BaseResponse<T> = BaseResponse<T>>(
@@ -200,7 +218,7 @@ function createClient(api: AxiosInstance): ApiClient {
     ): Promise<R> {
       try {
         const response = await api.patch<R>(url, data, config);
-        return response.data;
+        return unwrapResponse<R>(response);
       } catch (error: unknown) {
         return formatError<T>(error) as R;
       }

packages/axios/test/interceptor-compatibility.test.ts

@@ -0,0 +1,111 @@
+import { expect, test, vi, describe, beforeEach } from "vitest";
+import { createRequest } from "../index";
+import axios from "axios";
+
+// Mock axios
+vi.mock("axios", async () => {
+  const actual = await vi.importActual<typeof import("axios")>("axios");
+  const mockCreate = vi.fn(() => ({
+    interceptors: {
+      request: { use: vi.fn() },
+      response: { use: vi.fn() },
+    },
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    delete: vi.fn(),
+    patch: vi.fn(),
+  }));
+
+  const defaultAxios = actual.default;
+
+  return {
+    ...actual,
+    default: {
+      ...defaultAxios,
+      create: mockCreate,
+    },
+  };
+});
+
+describe("请求返回值测试", () => {
+  let mockAxiosInstance: any;
+
+  beforeEach(() => {
+    mockAxiosInstance = {
+      interceptors: {
+        request: { use: vi.fn() },
+        response: { use: vi.fn() },
+      },
+      get: vi.fn(),
+      post: vi.fn(),
+      put: vi.fn(),
+      delete: vi.fn(),
+      patch: vi.fn(),
+    };
+    (axios.create as any).mockReturnValue(mockAxiosInstance);
+  });
+
+  test("请求应该正确返回数据", async () => {
+    const data = { id: 1, name: "test" };
+    // 模拟 get 返回结构 (完整的 AxiosResponse)
+    mockAxiosInstance.get.mockResolvedValue({
+      data,
+      status: 200,
+      headers: {},
+      config: {},
+    });
+
+    const client = createRequest(
+      {
+        baseURL: "http://localhost",
+      },
+      false,
+    );
+
+    // 测试普通 get 请求
+    const result = await client.get("/test");
+    expect(result).toEqual(data);
+  });
+
+  test("标准请求应该正确返回数据", async () => {
+    const stdData = { code: 200, message: "ok", data: { id: 1 } };
+    mockAxiosInstance.get.mockResolvedValue({
+      data: stdData,
+      status: 200,
+      headers: {},
+      config: {},
+    });
+
+    const client = createRequest(
+      {
+        baseURL: "http://localhost",
+      },
+      false,
+    );
+
+    const stdResult = await client.std.get("/std-test");
+    expect(stdResult).toEqual(stdData);
+  });
+
+  test("如果拦截器修改了返回值结构，应该能智能解包", async () => {
+    const data = { id: 1, name: "test" };
+    // 模拟用户添加了拦截器，直接返回了 data 而不是 response 对象
+    mockAxiosInstance.get.mockResolvedValue(data);
+
+    const client = createRequest(
+      {
+        baseURL: "http://localhost",
+      },
+      false,
+    );
+
+    // 这时候再调用 client.get
+    // 内部实现是: const response = await api.get(); return unwrapResponse(response);
+    // 此时 response = data
+    // unwrapResponse(data) 应该返回 data (因为 data 不是 AxiosResponse)
+
+    const result = await client.get("/test");
+    expect(result).toEqual(data);
+  });
+});