fix(eslint-plugin-query): track custom query hook wrappers#10730
Open
junjuny0227 wants to merge 3 commits into
Open
fix(eslint-plugin-query): track custom query hook wrappers#10730junjuny0227 wants to merge 3 commits into
junjuny0227 wants to merge 3 commits into
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe rule now tracks custom hooks that return TanStack Query hook results, resolves variables initialized from those custom hooks, and flags such variables when used in React hook dependency arrays. Tests were added for wrapper hooks defined before and after usage for ChangesCustom hook wrapper detection for no-unstable-deps
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
packages/eslint-plugin-query/src/__tests__/no-unstable-deps.test.ts (1)
166-209: ⚡ Quick winAdd a declaration-order regression test for wrapper hooks
Please add an
invalidcase whereComponentappears beforefunction useMyQuery/useMyMutationand still expectsnoUnstableDeps. This guards the new wrapper-tracking contract against AST-order regressions.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/eslint-plugin-query/src/__tests__/no-unstable-deps.test.ts` around lines 166 - 209, Add an invalid test case to guard against AST-order regressions by moving the Component declaration before the wrapper hook definitions (for both useMyMutation and useMyQuery scenarios) while keeping the same expectation: an error with messageId 'noUnstableDeps' and data { reactHook: reactHookAlias, queryHook: 'useMutation' } or { queryHook: 'useQuery' } respectively; update the test entries in no-unstable-deps.test.ts to include these variants so the rule flags using the wrapper hook result as a dependency even when the wrapper is declared later in the file (referencing useMyMutation, useMyQuery, Component and the existing reactHookInvocation/ reactHookAlias symbols).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@packages/eslint-plugin-query/src/rules/no-unstable-deps/no-unstable-deps.rule.ts`:
- Around line 177-186: The rule misses wrappers declared later in the file
because trackedCustomHooks is filled during FunctionDeclaration visits while
variable-initializer resolution runs in the same traversal, so calls earlier in
the AST see an unresolved queryHook; to fix, delay resolving
VariableDeclarator/variable-init wrappers until after all FunctionDeclaration
nodes are recorded (e.g. move the variable-init resolution logic into
Program:exit or perform a second pass after collecting trackedCustomHooks) so
getReturnedQueryHook and trackedCustomHooks contain all declarations before
resolving wrappers like the code in the VariableDeclarator resolution block.
---
Nitpick comments:
In `@packages/eslint-plugin-query/src/__tests__/no-unstable-deps.test.ts`:
- Around line 166-209: Add an invalid test case to guard against AST-order
regressions by moving the Component declaration before the wrapper hook
definitions (for both useMyMutation and useMyQuery scenarios) while keeping the
same expectation: an error with messageId 'noUnstableDeps' and data { reactHook:
reactHookAlias, queryHook: 'useMutation' } or { queryHook: 'useQuery' }
respectively; update the test entries in no-unstable-deps.test.ts to include
these variants so the rule flags using the wrapper hook result as a dependency
even when the wrapper is declared later in the file (referencing useMyMutation,
useMyQuery, Component and the existing reactHookInvocation/ reactHookAlias
symbols).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 99787a89-106c-4f58-a958-fd3a10bfb9fb
📒 Files selected for processing (2)
packages/eslint-plugin-query/src/__tests__/no-unstable-deps.test.tspackages/eslint-plugin-query/src/rules/no-unstable-deps/no-unstable-deps.rule.ts
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/eslint-plugin-query/src/__tests__/no-unstable-deps.test.ts`:
- Line 222: The test defines useMyMutation with a const (const useMyMutation =
() => useMutation(...)) but calls it earlier, causing a TDZ ReferenceError;
replace the const arrow function with a function declaration (function
useMyMutation() { return useMutation({ mutationFn: (value: string) => value });
}) so the wrapper is hoisted and the test remains runtime-valid; update the
symbol useMyMutation in the test accordingly to match the other valid test
cases.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: d2cef624-7685-40a4-9c19-3f8bec611f26
📒 Files selected for processing (2)
packages/eslint-plugin-query/src/__tests__/no-unstable-deps.test.tspackages/eslint-plugin-query/src/rules/no-unstable-deps/no-unstable-deps.rule.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/eslint-plugin-query/src/rules/no-unstable-deps/no-unstable-deps.rule.ts
Collaborator
|
@Newbie012 can you take a look please |
junjuny0227
force-pushed
the
fix/no-unstable-deps-custom-hooks
branch
from
43e744b to
69acee7
Compare
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
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.
🎯 Changes
Fixes #10728.
Updates
no-unstable-depsto track simple same-file custom hooks that directly return a TanStack Query hook result. This makes the rule report wrapped unstable query or mutation results when they are used directly in React dependency arrays.The new coverage includes direct wrappers such as:
and function declarations that directly return
useQuery(...).Validation run locally:
npx nx run @tanstack/eslint-plugin-query:test:libpnpm --filter @tanstack/eslint-plugin-query run test:eslintpnpm --filter @tanstack/eslint-plugin-query run test:types:tscurrent✅ Checklist
pnpm run test:pr.🚀 Release Impact
Summary by CodeRabbit
Bug Fixes
Tests
Refactor