Skip to content

test(lit-query/createQueryController): read 'queryKey' and 'signal' from the 'queryFn' context to avoid shadowing the 'queryKey' helper - #12292

Merged
sukvvon merged 1 commit into
mainfrom
test/lit-query-createquerycontroller-use-query-fn-context
Oct 23, 2026
Merged

sukvvon merged 1 commit into
mainfrom
test/lit-query-createquerycontroller-use-query-fn-context

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

In createQueryController.test.ts, five queryFns destructured queryKey from the query function context, which shadowed the queryKey helper imported from @tanstack/query-test-utils (no-shadow).

They now take the context as context and read context.queryKey (and context.signal in the one that also used signal). The tests still read the key from the context.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Tests
    • Updated query tests to verify access to query keys and abort signals through the full context.
    • Confirmed existing abort-resolution behavior remains covered.

…rom the 'queryFn' context to avoid shadowing the 'queryKey' helper
@sukvvon sukvvon self-assigned this Oct 23, 2026
@changeset-bot

changeset-bot Bot commented Oct 23, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 069b6a6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@nx-cloud

nx-cloud Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 069b6a6

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 4m 1s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2026-10-23 03:13:27 UTC

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@coderabbitai

coderabbitai Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between 2de1d1e and 069b6a6.

📒 Files selected for processing: 1
  • packages/lit-query/src/__tests__/createQueryController.test.ts

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📝 Walkthrough

Several createQueryController tests now access queryKey and signal through the full query context argument. The abort-signal test retains its existing once-only listener and resolution behavior.

Changes: Lit query context test updates

Layer / File(s) Summary
Use query context in test callbacks
packages/lit-query/src/__tests__/createQueryController.test.ts
Updated test callbacks to read query-key values from context.queryKey. The abort-signal test now registers its listener through context.signal and retains the existing resolution behavior.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Suggested reviewers: chughgaurav

Merge Risk: ⚪ Minimal · up to 069b6

No concrete merge-blocking risk is evident from these test-only changes.

Pre-merge checks: Passed 5
Check name Status Explanation
Description check Passed The description includes all required template sections. It explains the change and motivation, completes the checklist, reports testing, and identifies the change as dev-only with no release impact.
Title check Passed The title clearly identifies the test file, the context-based access change, and the reason for the change: avoiding shadowing of the queryKey helper.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files.

✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@pkg-pr-new

pkg-pr-new Bot commented Oct 23, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@12292

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@12292

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@12292

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@12292

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@12292

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@12292

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@12292

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@12292

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@12292

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@12292

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@12292

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@12292

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@12292

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@12292

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@12292

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@12292

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@12292

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@12292

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@12292

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@12292

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@12292

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@12292

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@12292

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@12292

commit: 069b6a6

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.76 KB (0%)
react minimal 8.59 KB (0%)

@sukvvon
sukvvon merged commit 16f7d4c into main Oct 23, 2026
9 checks passed
@sukvvon
sukvvon deleted the test/lit-query-createquerycontroller-use-query-fn-context branch October 23, 2026 03:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant