React Query 中 eslint 规则对可选链的误报问题解析

在 React Query 项目中，开发者在使用 eslint-plugin-query 的 exhaustive-deps 规则时，可能会遇到一个关于可选链操作符(optional chaining)的误报问题。这个问题会影响代码的静态检查，导致不必要的警告。

问题现象

当开发者在 queryKey 中使用可选链操作符(?. )访问对象属性时，eslint 规则会错误地报告依赖缺失。例如以下两种常见情况：

1. 第一种情况会错误提示"缺少 data 依赖"

queryKey: ['query-name', data?.address],
queryFn: async () => sendQuery(data!.address)

2. 第二种情况会错误提示"缺少 data.address 依赖"

queryKey: ['query-name', data?.address],
queryFn: async () => sendQuery(data.address)

技术背景

React Query 的 exhaustive-deps 规则旨在确保 queryKey 中包含所有在 queryFn 中使用的依赖项，这是为了避免缓存失效和数据不一致的问题。该规则会静态分析代码，找出 queryFn 中引用的变量，并检查它们是否都包含在 queryKey 中。

可选链操作符是 ES2020 引入的特性，它允许安全地访问可能为 null 或 undefined 的对象属性。当遇到 a?.b 这样的表达式时，如果 a 为 null/undefined，整个表达式会返回 undefined 而不会抛出错误。

问题原因

eslint 规则在处理可选链操作符时存在两个问题：

1. 对于第一种情况，规则未能正确识别可选链表达式(data?.address)已经包含了 data 的依赖检查

2. 对于第二种情况，规则虽然识别了 data.address 的依赖，但没有考虑到可选链表达式(data?.address)已经隐式包含了 data 的检查

解决方案

React Query 团队已经在新版本中修复了这个问题。修复后的规则能够正确识别可选链操作符的语义，不再对上述情况产生误报。

对于开发者而言，除了等待更新外，还可以考虑以下替代方案：

1. 使用显式的条件判断代替可选链

queryKey: ['query-name', data && data.address]

2. 使用 React Query 提供的 skipToken 来安全地禁用查询，这是一种类型安全的方式

enabled: data ? !!data.address : skipToken

最佳实践建议

1. 保持 eslint-plugin-query 插件的最新版本，以获取最新的规则修复

2. 在可能为 undefined 的值上使用可选链操作符时，确保 queryFn 中的访问方式与 queryKey 中的一致

3. 对于复杂的依赖关系，考虑将依赖提取为单独的变量，提高代码可读性

4. 使用 TypeScript 可以更好地捕获这类问题，因为它能在编译时检查类型安全

这个问题展示了静态分析工具在处理现代 JavaScript 语法时的挑战，也提醒我们在使用新特性时需要关注工具链的支持情况。React Query 团队对此问题的快速响应也体现了该项目对开发者体验的重视。