test(query-test-utils): init (internal package) #9095
Merged
Conversation
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
github-actions
bot
added
package: react-query
package: react-query-persist-client
package: vue-query
package: query-core
package: solid-query
package: query-persist-client-core
package: svelte-query
package: angular-query-experimental
package: query-async-storage-persister
package: query-sync-storage-persister
package: solid-query-persist-client
package: svelte-query-persist-client
labels
manudeli
changed the title
|
View your CI Pipeline Execution ↗ for commit eb1f343.
☁️ Nx Cloud last updated this comment at |
manudeli
force-pushed
the
query-test-utils/init
branch
4 times, most recently
from
e3038ad to
b9e67d1
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #9095 +/- ##
==========================================
+ Coverage 44.53% 44.55% +0.01%
==========================================
Files 204 207 +3
Lines 8150 8159 +9
Branches 1828 1820 -8
==========================================
+ Hits 3630 3635 +5
- Misses 4077 4081 +4
Partials 443 443 🚀 New features to boost your workflow:
|
manudeli
force-pushed
the
query-test-utils/init
branch
2 times, most recently
from
73d0c27 to
7e9683f
Compare
manudeli
commented
May 2, 2025
There was a problem hiding this comment.
This PR is for an internal query-test-utils package that consolidates common test utilities such as sleep, mockVisibilityState, and others, which were previously duplicated across various TanStack Query packages. This helps reduce redundancy and improve test consistency across packages.
Comment on lines
-1
to
-52
| /* istanbul ignore file */ | ||
|
|
||
| export function flushPromises(timeout = 0): Promise<unknown> { | ||
| return new Promise(function (resolve) { | ||
| setTimeout(resolve, timeout) | ||
| }) | ||
| } | ||
|
|
||
| export function simpleFetcher(): Promise<string> { | ||
| return new Promise((resolve) => { | ||
| setTimeout(() => { | ||
| return resolve('Some data') | ||
| }, 0) | ||
| }) | ||
| } | ||
|
|
||
| export function getSimpleFetcherWithReturnData(returnData: unknown) { | ||
| return () => | ||
| new Promise((resolve) => setTimeout(() => resolve(returnData), 0)) | ||
| } | ||
|
|
||
| export function infiniteFetcher({ | ||
| pageParam, | ||
| }: { | ||
| pageParam?: number | ||
| }): Promise<string> { | ||
| return new Promise((resolve) => { | ||
| setTimeout(() => { | ||
| return resolve('data on page ' + pageParam) | ||
| }, 0) | ||
| }) | ||
| } | ||
|
|
||
| export function rejectFetcher(): Promise<Error> { | ||
| return new Promise((_, reject) => { | ||
| setTimeout(() => { | ||
| return reject(new Error('Some error')) | ||
| }, 0) | ||
| }) | ||
| } | ||
|
|
||
| export function successMutator<T>(param: T): Promise<T> { | ||
| return new Promise((resolve) => { | ||
| setTimeout(() => { | ||
| return resolve(param) | ||
| }, 0) | ||
| }) | ||
| } | ||
|
|
||
| export function errorMutator<T>(_: T): Promise<Error> { | ||
| return rejectFetcher() | ||
| } |
Comment on lines
-1
to
-5
| export function sleep(timeout: number): Promise<void> { | ||
| return new Promise((resolve, _reject) => { | ||
| setTimeout(resolve, timeout) | ||
| }) | ||
| } |
Comment on lines
-1
to
-14
| import { QueryClient } from '@tanstack/svelte-query' | ||
|
|
||
| import type { QueryClientConfig } from '@tanstack/svelte-query' | ||
|
|
||
| export function createQueryClient(config?: QueryClientConfig): QueryClient { | ||
| return new QueryClient(config) | ||
| } | ||
|
|
||
| export function sleep(timeout: number): Promise<void> { | ||
| return new Promise((resolve, _reject) => { | ||
| setTimeout(resolve, timeout) | ||
| }) | ||
| } | ||
|
|
Comment on lines
-51
to
-56
| export function sleep(timeout: number): Promise<void> { | ||
| return new Promise((resolve, _reject) => { | ||
| setTimeout(resolve, timeout) | ||
| }) | ||
| } | ||
|
|
Comment on lines
-9
to
-14
| let queryKeyCount = 0 | ||
| export function queryKey() { | ||
| queryKeyCount++ | ||
| return [`query_${queryKeyCount}`] | ||
| } | ||
|
|
Comment on lines
-45
to
-53
| export function createQueryClient(config?: QueryClientConfig): QueryClient { | ||
| return new QueryClient(config) | ||
| } | ||
|
|
||
| export function mockVisibilityState( | ||
| value: DocumentVisibilityState, | ||
| ): MockInstance<() => DocumentVisibilityState> { | ||
| return vi.spyOn(document, 'visibilityState', 'get').mockReturnValue(value) | ||
| } |
Comment on lines
-61
to
-71
| let queryKeyCount = 0 | ||
| export function queryKey(): Array<string> { | ||
| queryKeyCount++ | ||
| return [`query_${queryKeyCount}`] | ||
| } | ||
|
|
||
| export function sleep(timeout: number): Promise<void> { | ||
| return new Promise((resolve, _reject) => { | ||
| setTimeout(resolve, timeout) | ||
| }) | ||
| } |
Comment on lines
-1
to
-18
| import { QueryClient } from '@tanstack/react-query' | ||
| import type { QueryClientConfig } from '@tanstack/react-query' | ||
|
|
||
| export function createQueryClient(config?: QueryClientConfig): QueryClient { | ||
| return new QueryClient(config) | ||
| } | ||
|
|
||
| let queryKeyCount = 0 | ||
| export function queryKey(): Array<string> { | ||
| queryKeyCount++ | ||
| return [`query_${queryKeyCount}`] | ||
| } | ||
|
|
||
| export function sleep(timeout: number): Promise<void> { | ||
| return new Promise((resolve, _reject) => { | ||
| setTimeout(resolve, timeout) | ||
| }) | ||
| } |
Comment on lines
-1
to
-5
| export function sleep(timeout: number): Promise<void> { | ||
| return new Promise((resolve, _reject) => { | ||
| setTimeout(resolve, timeout) | ||
| }) | ||
| } |
Comment on lines
-6
to
-14
| export function createQueryClient(config?: QueryClientConfig): QueryClient { | ||
| return new QueryClient(config) | ||
| } | ||
|
|
||
| function sleep(timeout: number): Promise<void> { | ||
| return new Promise((resolve, _reject) => { | ||
| setTimeout(resolve, timeout) | ||
| }) | ||
| } |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces an internal package (@tanstack/query-test-utils) for shared testing utilities, streamlining the usage of functions like sleep and standardizing the instantiation of QueryClient across various test files. Key changes include replacing duplicated local test utilities with imports from the new package, and updating test files to use new QueryClient() instead of a custom createQueryClient() helper.
Reviewed Changes
Copilot reviewed 116 out of 117 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/query-core/src/tests/infiniteQueryObserver.test.tsx | Replaced local test utils with shared ones and updated QueryClient instantiation. |
| packages/query-core/src/tests/infiniteQueryObserver.test-d.tsx | Updated imports and QueryClient instantiation for type tests. |
| packages/query-core/src/tests/infiniteQueryBehavior.test.tsx | Uniformly replaced local sleep and createQueryClient with shared utilities and new QueryClient. |
| packages/query-core/src/tests/hydration.test.tsx | Refactored dehydration/rehydration tests to use the shared sleep function and direct QueryClient instantiation. |
| packages/query-async-storage-persister/src/tests/utils.ts | Removed duplicated sleep function in favor of the shared package. |
| packages/query-async-storage-persister/src/tests/asyncThrottle.test.ts | Updated tests to use shared sleep function instead of local delay. |
| packages/angular-query-persist-client/src/tests/with-persist-query-client.test.ts | Adjusted import order to use shared query-test-utils. |
| packages/angular-query-persist-client/src/tests/utils.ts | Removed duplicate utility functions in favor of the shared package. |
| packages/angular-query-experimental/src/tests/* | Across multiple files, updated query and mutation functions to use the shared sleep utility and adjusted error/promise handling accordingly. |
| codecov.yml | Added the new package to the code coverage configuration. |
Files not reviewed (1)
- package.json: Language not supported
manudeli
force-pushed
the
query-test-utils/init
branch
2 times, most recently
from
89c0431 to
11f4dd5
Compare
…ntiation across test files
…ations in query tests
…ns in query tests
manudeli
force-pushed
the
query-test-utils/init
branch
from
11f4dd5 to
4c28e94
Compare
minseong0324
pushed a commit
to minseong0324/Tanstack-query
that referenced
this pull request
May 7, 2025
* test(query-test-utils): init * refactor(tests): replace createQueryClient with new QueryClient instantiation across test files * refactor(tests): remove unused imports in utils test file * refactor(tests): replace fetcher functions with sleep-based implementations in query tests * refactor(tests): replace simpleFetcher with sleep-based implementations in query tests * fix(query-core): update test:build script to remove pnpm prefix * refactor(tests): extract query function into a variable for clarity in useQuery tests * chore(tsconfig): remove temporary Vitest TypeScript configuration file * chore: add @tanstack/query-test-utils as a devDependency in multiple packages --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
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.
Why
There are many shared test utilities like
sleep,mockVisibilityState, etc., duplicated across multiple@tanstack/*packages. This makes it hard to maintain consistency and often leads to minor discrepancies in behavior.To address this, I’ve made a new internal package:
@tanstack/query-test-utilsunderpackages/query-test-utils, which centralizes these test utilities.Ask
Please let me know if you're okay with adding this internal package for shared testing purposes. I'm happy to revise the approach if there's a better alternative!