Orval项目中TanStack Query类型回归问题解析

背景介绍

在Orval项目的最新版本7.4.0中，开发团队发现了一个与TanStack Query(原React Query)相关的类型系统回归问题。这个问题主要影响了使用select选项进行数据转换时的类型推断。

问题本质

在Orval自动生成的代码中，查询钩子的类型定义存在一个关键缺陷。具体表现为生成的UseQueryOptions类型参数设置不当，导致select函数的返回类型被错误地约束为必须与API原始返回类型一致。

技术细节

Orval生成的代码原本是这样的结构：

export function useControllerGetData<
  TData = Awaited<ReturnType<typeof controllerGetData>>,
  TError = ErrorType<ErrorResponse>,
>(
  id: string,
  options?: {
    query?: Partial<UseQueryOptions<TData, TError, TData>>;
    request?: SecondParameter<typeof orvalHttpClient>;
  },
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> }

问题出在UseQueryOptions<TData, TError, TData>的第三个泛型参数上。按照TanStack Query的设计，这三个参数分别代表：

1. 查询函数返回的数据类型
2. 错误类型
3. 最终返回的数据类型(经过select等转换后的类型)

当前的实现错误地将第三个参数也设为TData，这意味着select函数必须返回与API原始响应相同类型的数据，这显然不符合实际使用场景。

实际影响

这种类型限制会导致开发者在使用select进行数据转换时遇到类型错误。例如以下常见用法会报错：

useControllerGetData(mainAssetId, {
  query: {
    select(data) {
      const boolA = data.key_X;
      const boolB = data.key_Y;
      return { boolA, boolB }; // 类型错误，因为要求返回原始API类型
    },
  },
});

解决方案

正确的类型定义应该是：

query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof controllerGetData>>, TError, TData>>;

这样修改后，第一个参数保持为API原始返回类型，而第三个参数则可以自由定义为select转换后的类型，完美支持数据转换场景。

修复过程

Orval团队在7.4.1版本中快速修复了这个问题。修复的关键在于确保生成的代码中UseQueryOptions的三个类型参数正确区分了原始数据类型和转换后数据类型。

经验教训

这个案例提醒我们：

1. 自动生成代码时，类型系统的精确性至关重要
2. 需要全面考虑各种使用场景，特别是像select这样的数据转换功能
3. 完善的测试用例能够帮助及早发现这类问题

总结

Orval作为API客户端代码生成工具，其与TanStack Query的集成需要精确处理类型系统。这次类型回归问题的快速修复展现了团队对类型安全性的重视，也提醒开发者在使用自动生成代码时要注意类型系统的正确性。