Skip to content

test(react-query): use fake timers for QueryClientProvider.test.tsx #9074

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

manudeli
Copy link
Collaborator

No description provided.

@manudeli manudeli self-assigned this Apr 26, 2025
@manudeli manudeli removed their assignment Apr 26, 2025
Copy link

nx-cloud bot commented Apr 26, 2025

View your CI Pipeline Execution ↗ for commit 7a6ffe7.

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

☁️ Nx Cloud last updated this comment at 2025-04-26 10:48:43 UTC

Copy link

pkg-pr-new bot commented Apr 26, 2025

More templates

@tanstack/angular-query-devtools-experimental

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

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-async-storage-persister

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/react-query

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 7a6ffe7

Copy link

codecov bot commented Apr 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.22%. Comparing base (83f01cd) to head (7a6ffe7).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #9074       +/-   ##
===========================================
+ Coverage   44.58%   84.22%   +39.64%     
===========================================
  Files         203       26      -177     
  Lines        8104      374     -7730     
  Branches     1809      110     -1699     
===========================================
- Hits         3613      315     -3298     
+ Misses       4059       50     -4009     
+ Partials      432        9      -423     
Components Coverage Δ
@tanstack/angular-query-devtools-experimental ∅ <ø> (∅)
@tanstack/angular-query-experimental ∅ <ø> (∅)
@tanstack/eslint-plugin-query ∅ <ø> (∅)
@tanstack/query-async-storage-persister ∅ <ø> (∅)
@tanstack/query-broadcast-client-experimental ∅ <ø> (∅)
@tanstack/query-codemods ∅ <ø> (∅)
@tanstack/query-core ∅ <ø> (∅)
@tanstack/query-devtools ∅ <ø> (∅)
@tanstack/query-persist-client-core ∅ <ø> (∅)
@tanstack/query-sync-storage-persister ∅ <ø> (∅)
@tanstack/react-query 95.42% <ø> (ø)
@tanstack/react-query-devtools 10.00% <ø> (ø)
@tanstack/react-query-next-experimental ∅ <ø> (∅)
@tanstack/react-query-persist-client 100.00% <ø> (ø)
@tanstack/solid-query ∅ <ø> (∅)
@tanstack/solid-query-devtools ∅ <ø> (∅)
@tanstack/solid-query-persist-client ∅ <ø> (∅)
@tanstack/svelte-query ∅ <ø> (∅)
@tanstack/svelte-query-devtools ∅ <ø> (∅)
@tanstack/svelte-query-persist-client ∅ <ø> (∅)
@tanstack/vue-query ∅ <ø> (∅)
@tanstack/vue-query-devtools ∅ <ø> (∅)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@manudeli manudeli requested a review from Copilot April 26, 2025 11:06
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the QueryClientProvider tests to use fake timers for improved reliability when testing asynchronous query behavior.

  • Introduces beforeEach/afterEach hooks to switch between fake and real timers.
  • Replaces testing-library’s waitFor with vi.waitFor to accommodate fake timers.
  • Updates queryFn implementations from async/await to promise chains.
Comments suppressed due to low confidence (2)

packages/react-query/src/tests/QueryClientProvider.test.tsx:40

  • Verify that replacing testing-library's waitFor with vi.waitFor handles asynchronous UI updates as expected under fake timers.
await vi.waitFor(() => rendered.getByText('test'))

packages/react-query/src/tests/QueryClientProvider.test.tsx:12

  • Confirm that resetting to real timers after using fake timers does not inadvertently affect subsequent asynchronous tests.
vi.useRealTimers()

@TkDodo TkDodo merged commit b8ea29e into TanStack:main Apr 26, 2025
7 checks passed
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.

3 participants