test(query-core/streamedQuery): consume the signal with 'void context.signal' instead of an always-truthy condition, and explain the kept 'require-await' disables by sukvvon · Pull Request #12337 · TanStack/query

sukvvon · 2026-10-25T04:32:14Z

🎯 Changes

The two abort tests consumed the signal with context.signal ? 3 : 0, an always-truthy condition kept behind an oxlint-disable-next-line typescript/no-unnecessary-condition comment. Consume it with void context.signal, like the other query-core tests do, and pass 3 directly. The tests still fail without this line.
Add the reason to the three typescript/require-await disables: streamFn needs an async iterable, and those generators have nothing to await.

✅ 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 streamed query tests to use consistent three-value generators when checking abort behavior on refetch and unsubscribe.

….signal' instead of an always-truthy condition, and explain the kept 'require-await' disables

changeset-bot · 2026-10-25T04:32:18Z

⚠️ No Changeset found

Latest commit: de92bb9

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 · 2026-10-25T04:32:49Z

View your CI Pipeline Execution ↗ for commit de92bb9

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

☁️ Nx Cloud last updated this comment at 2026-10-25 04:38:07 UTC

github-actions · 2026-10-25T04:33:07Z

🚀 Changeset Version Preview

5 package(s) bumped directly, 19 bumped as dependents.

🟨 Minor bumps

Package	Version	Reason
`@tanstack/angular-query-experimental`	5.104.5 → 5.105.0	Changeset
`@tanstack/solid-query-devtools`	5.104.5 → 5.105.0	Changeset
`@tanstack/vue-query`	5.104.5 → 5.105.0	Changeset
`@tanstack/eslint-plugin-query`	5.104.5 → 5.105.0	Dependent
`@tanstack/preact-query`	5.104.5 → 5.105.0	Dependent
`@tanstack/preact-query-devtools`	5.104.5 → 5.105.0	Dependent
`@tanstack/preact-query-persist-client`	5.104.5 → 5.105.0	Dependent
`@tanstack/query-async-storage-persister`	5.104.5 → 5.105.0	Dependent
`@tanstack/query-broadcast-client-experimental`	5.104.5 → 5.105.0	Dependent
`@tanstack/query-core`	5.104.5 → 5.105.0	Dependent
`@tanstack/query-devtools`	5.104.5 → 5.105.0	Dependent
`@tanstack/query-persist-client-core`	5.104.5 → 5.105.0	Dependent
`@tanstack/query-sync-storage-persister`	5.104.5 → 5.105.0	Dependent
`@tanstack/react-query`	5.104.5 → 5.105.0	Dependent
`@tanstack/react-query-devtools`	5.104.5 → 5.105.0	Dependent
`@tanstack/react-query-next-experimental`	5.104.5 → 5.105.0	Dependent
`@tanstack/react-query-persist-client`	5.104.5 → 5.105.0	Dependent
`@tanstack/solid-query`	5.104.5 → 5.105.0	Dependent
`@tanstack/solid-query-persist-client`	5.104.5 → 5.105.0	Dependent

🟩 Patch bumps

Package	Version	Reason
`@tanstack/svelte-query-devtools`	6.3.5 → 6.3.6	Changeset
`@tanstack/vue-query-devtools`	6.3.5 → 6.3.6	Changeset
`@tanstack/lit-query`	0.2.30 → 0.2.31	Dependent
`@tanstack/svelte-query`	6.3.5 → 6.3.6	Dependent
`@tanstack/svelte-query-persist-client`	6.3.5 → 6.3.6	Dependent

coderabbitai · 2026-10-25T04:33:35Z

No actionable comments were generated in the recent review.

Recent review info

Run configuration

Source mode: Auto
Repository: TanStack/query
Branch: test/query-core-streamed-query-consume-signal-with-void
File: .coderabbit.yaml
Commit: de92bb9
Layers: Repository YAML
Review profile: CHILL
Plan: Advanced
Run ID: d1b0c805-1627-431a-93c3-56e4ebadb31f

Commits

Reviewing files that changed from the base of the PR and between 83aeaf0 and de92bb9.

Files selected for processing: 1

packages/query-core/src/__tests__/streamedQuery.test.tsx

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

Walkthrough

Two streamed-query abort tests now consume context.signal and always produce three values. Three require-await suppression comments clarify why the async generators have no await.

Changes: Streamed-query test updates

Layer / File(s)	Summary
Abort test generators `packages/query-core/src/__tests__/streamedQuery.test.tsx`	The abort-on-refetch and abort-on-unsubscribe tests always produce three values. Three lint suppression comments explain that the async generators meet the `streamFn` async-iterable contract.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related PRs

TanStack/query#12293: It changes the createKey test utility contract used by this test file.

Suggested reviewers: dogpawhat

Merge Risk: Minimal · up to de92b

The test-only updates are mergeable with normal checks.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title accurately summarizes both test changes and the clarified lint suppressions. It is specific, although longer than necessary.
Description check		The description includes all required template sections, explains the changes and motivation, completes the checklist, and states the release impact.
Docstring Coverage		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		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		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 · 2026-10-25T04:33:54Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: de92bb9

github-actions · 2026-10-25T04:34:24Z

size-limit report 📦

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

test(query-core/streamedQuery): consume the signal with 'void context…

de92bb9

….signal' instead of an always-truthy condition, and explain the kept 'require-await' disables

sukvvon self-assigned this Oct 25, 2026

sukvvon merged commit e8ffa3f into main Oct 25, 2026
9 checks passed

sukvvon deleted the test/query-core-streamed-query-consume-signal-with-void branch October 25, 2026 04:41

Navigation Menu

Repository navigation

test(query-core/streamedQuery): consume the signal with 'void context.signal' instead of an always-truthy condition, and explain the kept 'require-await' disables - #12337

test(query-core/streamedQuery): consume the signal with 'void context.signal' instead of an always-truthy condition, and explain the kept 'require-await' disables#12337
sukvvon merged 1 commit into
mainfrom
test/query-core-streamed-query-consume-signal-with-void

sukvvon commented Oct 25, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 25, 2026

Uh oh!

nx-cloud Bot commented Oct 25, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 25, 2026

Uh oh!

coderabbitai Bot commented Oct 25, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Oct 25, 2026

Uh oh!

github-actions Bot commented Oct 25, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 25, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Oct 25, 2026

⚠️ No Changeset found

Uh oh!

nx-cloud Bot commented Oct 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 25, 2026

🚀 Changeset Version Preview

🟨 Minor bumps

🟩 Patch bumps

Uh oh!

coderabbitai Bot commented Oct 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Oct 25, 2026

Uh oh!

github-actions Bot commented Oct 25, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 25, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Oct 25, 2026 •

edited

Loading

coderabbitai Bot commented Oct 25, 2026 •

edited

Loading