Skip to content

test(vue-query/useIsFetching): add test for outside scope warning in development mode#10237

Open
sukvvon wants to merge 2 commits intoTanStack:mainfrom
sukvvon:test/vue-query-useIsFetching-outside-scope-warning
Open

test(vue-query/useIsFetching): add test for outside scope warning in development mode#10237
sukvvon wants to merge 2 commits intoTanStack:mainfrom
sukvvon:test/vue-query-useIsFetching-outside-scope-warning

Conversation

@sukvvon
Copy link
Contributor

@sukvvon sukvvon commented Mar 5, 2026

🎯 Changes

  • Add test to verify that useIsFetching warns when used outside of a setup() function or running effect scope in development mode.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 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
    • Added a test to verify that a development-mode warning is triggered when a composable is used outside its intended context.

@changeset-bot
Copy link

changeset-bot bot commented Mar 5, 2026

⚠️ No Changeset found

Latest commit: 2afeaa5

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 5, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 44f39382-2d24-46f2-9e5c-ea53973cee54

📥 Commits

Reviewing files that changed from the base of the PR and between f48213f and 2afeaa5.

📒 Files selected for processing (1)
  • packages/vue-query/src/__tests__/useIsFetching.test.ts

📝 Walkthrough

Walkthrough

A new unit test was added that ensures a development-mode warning is emitted when useIsFetching is called outside of a Vue setup context; the test temporarily sets NODE_ENV to development, spies on console.warn, invokes the hook, and asserts the warning message.

Changes

Cohort / File(s) Summary
Development Mode Warning Test
packages/vue-query/src/__tests__/useIsFetching.test.ts
Added a test that stubs NODE_ENV to development, spies on console.warn, calls useIsFetching outside of setup, and asserts the expected development-mode warning message.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nibble on tests with gentle paw, 🐇
Stubbing envs to see what they saw,
A warning hops when hooks misbehave,
This little test keeps code more brave,
Happy trails for bugs we stave!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding a test for the outside scope warning in development mode for useIsFetching.
Description check ✅ Passed The pull request description follows the required template structure with all major sections completed: Changes, Checklist, and Release Impact sections are present with appropriate checkmarks.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

@nx-cloud
Copy link

nx-cloud bot commented Mar 5, 2026

View your CI Pipeline Execution ↗ for commit 2afeaa5

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

☁️ Nx Cloud last updated this comment at 2026-03-05 05:22:24 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 5, 2026

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: c04f521

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@packages/vue-query/src/__tests__/useIsFetching.test.ts`:
- Around line 103-109: The test around useIsFetching currently stubs NODE_ENV
and console.warn then calls useIsFetching but restores them unconditionally
after the call; wrap the setup and assertion (the vi.stubEnv('NODE_ENV',
'development'), vi.spyOn(console, 'warn') and the useIsFetching() invocation) in
a try/finally block and move vi.unstubAllEnvs() and the spy restore (the
mockImplementation reset/spy restore) into the finally so NODE_ENV and
console.warn are always restored even if useIsFetching() throws.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c17b9410-5d89-4a5d-af40-171736bea68f

📥 Commits

Reviewing files that changed from the base of the PR and between fe25edc and f48213f.

📒 Files selected for processing (1)
  • packages/vue-query/src/__tests__/useIsFetching.test.ts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant