fix: allow useQueries with combine property in no-unstable-deps rule #9720
+95
−18
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add hasCombineProperty function to detect combine property in useQueries calls - Skip tracking useQueries with combine as unstable since combine makes result stable - Add tests for useQueries with and without combine property - Fixes TanStack#9718
🦋 Changeset detectedLatest commit: 8517ada The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Caution Review failedThe pull request is closed. WalkthroughAdds handling so Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Dev as Developer Code
participant ESLint as no-unstable-deps Rule
participant AST as AST Walker
Dev->>ESLint: Run lint on file
ESLint->>AST: Visit VariableDeclarator (init is CallExpression)
alt callee is useQueries with combine
note right of ESLint #a9d18e: hasCombineProperty -> treat as stable
ESLint-->>AST: Skip tracking variable
else callee is useQueries without combine
note right of ESLint #f4c7c3: No combine -> treat as unstable
ESLint->>AST: Track variable as unstable
end
AST->>ESLint: Visit React Hook call with deps
alt deps reference tracked (unstable) variable
ESLint-->>Dev: Report noUnstableDeps diagnostic
else deps reference skipped/stable variable
ESLint-->>Dev: No diagnostic
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
packages/eslint-plugin-query/src/rules/no-unstable-deps/no-unstable-deps.rule.ts (1)
70-81: Consider edge cases in combine property detection.The function correctly identifies standard
combineproperties, but may not handle all edge cases:
- Spread properties:
{ ...config, queries: [...] }won't be detected ifcombineis in the spread- Computed property names:
{ ['combine']: fn }won't match since you checkprop.key.type === AST_NODE_TYPES.Identifier- Property shorthand: While
{ combine }should work, the function assumes the property key name is what mattersFor robustness, consider adding a check for computed properties:
function hasCombineProperty(callExpression: TSESTree.CallExpression): boolean { if (callExpression.arguments.length === 0) return false const firstArg = callExpression.arguments[0] if (!firstArg || firstArg.type !== AST_NODE_TYPES.ObjectExpression) return false return firstArg.properties.some(prop => prop.type === AST_NODE_TYPES.Property && + !prop.computed && prop.key.type === AST_NODE_TYPES.Identifier && prop.key.name === 'combine' ) }This ensures computed properties like
{ ['combine']: fn }are excluded (though they're unlikely in practice).packages/eslint-plugin-query/src/__tests__/no-unstable-deps.test.ts (1)
110-134: Consider adding invalid test case foruseSuspenseQuerieswithout combine.The invalid test case correctly verifies that
useQuerieswithoutcombinetriggers the rule. For completeness and symmetry with the valid test cases, consider adding a corresponding invalid test foruseSuspenseQuerieswithoutcombine.Add this test case to the invalid array:
{ name: `result of useSuspenseQueries without combine is passed to ${reactHookInvocation} as dependency`, code: ` ${reactHookImport} import { useSuspenseQueries } from "@tanstack/react-query"; function Component() { const queries = useSuspenseQueries({ queries: [ { queryKey: ['test'], queryFn: () => 'test' } ] }); const callback = ${reactHookInvocation}(() => { queries[0]?.data }, [queries]); return; } `, errors: [ { messageId: 'noUnstableDeps', data: { reactHook: reactHookAlias, queryHook: 'useSuspenseQueries' }, }, ], },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
packages/eslint-plugin-query/src/__tests__/no-unstable-deps.test.ts(2 hunks)packages/eslint-plugin-query/src/rules/no-unstable-deps/no-unstable-deps.rule.ts(2 hunks)
packages/eslint-plugin-query/src/__tests__/no-unstable-deps.test.ts
Outdated
Show resolved
Hide resolved
packages/eslint-plugin-query/src/rules/no-unstable-deps/no-unstable-deps.rule.ts
Show resolved
Hide resolved
|
View your CI Pipeline Execution ↗ for commit 07a1be7
☁️ Nx Cloud last updated this comment at |
TkDodo
approved these changes
Oct 16, 2025
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #9720 +/- ##
===========================================
+ Coverage 45.56% 83.56% +38.00%
===========================================
Files 196 19 -177
Lines 8327 572 -7755
Branches 1895 212 -1683
===========================================
- Hits 3794 478 -3316
+ Misses 4091 72 -4019
+ Partials 442 22 -420
🚀 New features to boost your workflow:
|
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@tanstack/query/no-unstable-depsESLint rule with combine property #9718Changes
Checklist
pnpm test:pr.Release Impact
Summary by CodeRabbit
Bug Fixes
Tests