test(query-test-utils): init (internal package) (#9095)

* 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>

Author: manudeli

codecov.yml

@@ -59,6 +59,10 @@ component_management:
       name: '@tanstack/query-sync-storage-persister'
       paths:
         - packages/query-sync-storage-persister/**
+    - component_id: query-test-utils
+      name: '@tanstack/query-test-utils'
+      paths:
+        - packages/query-test-utils/**
     - component_id: react-query
       name: '@tanstack/react-query'
       paths:

package.json

@@ -86,6 +86,7 @@
       "@tanstack/query-devtools": "workspace:*",
       "@tanstack/query-persist-client-core": "workspace:*",
       "@tanstack/query-sync-storage-persister": "workspace:*",
+      "@tanstack/query-test-utils": "workspace:*",
       "@tanstack/react-query": "workspace:*",
       "@tanstack/react-query-devtools": "workspace:*",
       "@tanstack/react-query-next-experimental": "workspace:*",

packages/angular-query-experimental/package.json

@@ -74,6 +74,7 @@
     "@angular/core": "^19.2.4",
     "@angular/platform-browser": "^19.2.4",
     "@angular/platform-browser-dynamic": "^19.2.4",
+    "@tanstack/query-test-utils": "workspace:*",
     "eslint-plugin-jsdoc": "^50.5.0",
     "npm-run-all2": "^5.0.0"
   },

packages/angular-query-experimental/src/__tests__/inject-infinite-query.test-d.ts

@@ -1,8 +1,8 @@
 import { TestBed } from '@angular/core/testing'
 import { afterEach, beforeEach, describe, expectTypeOf, test, vi } from 'vitest'
 import { provideExperimentalZonelessChangeDetection } from '@angular/core'
+import { sleep } from '@tanstack/query-test-utils'
 import { QueryClient, injectInfiniteQuery, provideTanStackQuery } from '..'
-import { infiniteFetcher } from './test-utils'
 import type { InfiniteData } from '@tanstack/query-core'
 
 describe('injectInfiniteQuery', () => {
@@ -27,7 +27,8 @@ describe('injectInfiniteQuery', () => {
     const query = TestBed.runInInjectionContext(() => {
       return injectInfiniteQuery(() => ({
         queryKey: ['infiniteQuery'],
-        queryFn: infiniteFetcher,
+        queryFn: ({ pageParam }) =>
+          sleep(0).then(() => 'data on page ' + pageParam),
         initialPageParam: 0,
         getNextPageParam: () => 12,
       }))

packages/angular-query-experimental/src/__tests__/inject-infinite-query.test.ts

@@ -4,8 +4,9 @@ import {
   Injector,
   provideExperimentalZonelessChangeDetection,
 } from '@angular/core'
+import { sleep } from '@tanstack/query-test-utils'
 import { QueryClient, injectInfiniteQuery, provideTanStackQuery } from '..'
-import { expectSignals, infiniteFetcher } from './test-utils'
+import { expectSignals } from './test-utils'
 
 const QUERY_DURATION = 1000
 
@@ -33,7 +34,8 @@ describe('injectInfiniteQuery', () => {
     const query = TestBed.runInInjectionContext(() => {
       return injectInfiniteQuery(() => ({
         queryKey: ['infiniteQuery'],
-        queryFn: infiniteFetcher,
+        queryFn: ({ pageParam }) =>
+          sleep(0).then(() => 'data on page ' + pageParam),
         initialPageParam: 0,
         getNextPageParam: () => 12,
       }))
@@ -72,7 +74,8 @@ describe('injectInfiniteQuery', () => {
       expect(() => {
         injectInfiniteQuery(() => ({
           queryKey: ['injectionContextError'],
-          queryFn: infiniteFetcher,
+          queryFn: ({ pageParam }) =>
+            sleep(0).then(() => 'data on page ' + pageParam),
           initialPageParam: 0,
           getNextPageParam: () => 12,
         }))
@@ -83,7 +86,8 @@ describe('injectInfiniteQuery', () => {
       const query = injectInfiniteQuery(
         () => ({
           queryKey: ['manualInjector'],
-          queryFn: infiniteFetcher,
+          queryFn: ({ pageParam }) =>
+            sleep(0).then(() => 'data on page ' + pageParam),
           initialPageParam: 0,
           getNextPageParam: () => 12,
         }),

packages/angular-query-experimental/src/__tests__/inject-is-fetching.test.ts

@@ -4,13 +4,13 @@ import {
   Injector,
   provideExperimentalZonelessChangeDetection,
 } from '@angular/core'
+import { sleep } from '@tanstack/query-test-utils'
 import {
   QueryClient,
   injectIsFetching,
   injectQuery,
   provideTanStackQuery,
 } from '..'
-import { delayedFetcher } from './test-utils'
 
 const QUERY_DURATION = 100
 
@@ -39,7 +39,7 @@ describe('injectIsFetching', () => {
     const isFetching = TestBed.runInInjectionContext(() => {
       injectQuery(() => ({
         queryKey: ['isFetching1'],
-        queryFn: delayedFetcher(100),
+        queryFn: () => sleep(100).then(() => 'Some data'),
       }))
       return injectIsFetching()
     })

packages/angular-query-experimental/src/__tests__/inject-is-mutating.test.ts

@@ -4,13 +4,13 @@ import {
   Injector,
   provideExperimentalZonelessChangeDetection,
 } from '@angular/core'
+import { sleep } from '@tanstack/query-test-utils'
 import {
   QueryClient,
   injectIsMutating,
   injectMutation,
   provideTanStackQuery,
 } from '..'
-import { successMutator } from './test-utils'
 
 describe('injectIsMutating', () => {
   let queryClient: QueryClient
@@ -36,7 +36,7 @@ describe('injectIsMutating', () => {
       const isMutating = injectIsMutating()
       const mutation = injectMutation(() => ({
         mutationKey: ['isMutating1'],
-        mutationFn: successMutator<{ par1: string }>,
+        mutationFn: (params: { par1: string }) => sleep(0).then(() => params),
       }))
 
       expect(isMutating()).toBe(0)

packages/angular-query-experimental/src/__tests__/inject-mutation-state.test.ts

@@ -8,13 +8,14 @@ import {
 import { TestBed } from '@angular/core/testing'
 import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
 import { By } from '@angular/platform-browser'
+import { sleep } from '@tanstack/query-test-utils'
 import {
   QueryClient,
   injectMutation,
   injectMutationState,
   provideTanStackQuery,
 } from '..'
-import { setFixtureSignalInputs, successMutator } from './test-utils'
+import { setFixtureSignalInputs } from './test-utils'
 
 describe('injectMutationState', () => {
   let queryClient: QueryClient
@@ -42,7 +43,7 @@ describe('injectMutationState', () => {
       const mutation = TestBed.runInInjectionContext(() => {
         return injectMutation(() => ({
           mutationKey: mutationKey,
-          mutationFn: (params: string) => successMutator(params),
+          mutationFn: (params: string) => sleep(0).then(() => params),
         }))
       })
 
@@ -68,11 +69,11 @@ describe('injectMutationState', () => {
         return [
           injectMutation(() => ({
             mutationKey: mutationKey1,
-            mutationFn: (params: string) => successMutator(params),
+            mutationFn: (params: string) => sleep(0).then(() => params),
           })),
           injectMutation(() => ({
             mutationKey: mutationKey2,
-            mutationFn: (params: string) => successMutator(params),
+            mutationFn: (params: string) => sleep(0).then(() => params),
           })),
         ]
       })
@@ -103,7 +104,7 @@ describe('injectMutationState', () => {
       const mutation = TestBed.runInInjectionContext(() => {
         return injectMutation(() => ({
           mutationKey: mutationKey,
-          mutationFn: (params: string) => successMutator(params),
+          mutationFn: (params: string) => sleep(0).then(() => params),
         }))
       })
 

packages/angular-query-experimental/src/__tests__/inject-mutation.test-d.ts

@@ -1,20 +1,20 @@
 import { describe, expectTypeOf, test } from 'vitest'
+import { sleep } from '@tanstack/query-test-utils'
 import { injectMutation } from '..'
-import { successMutator } from './test-utils'
 import type { Signal } from '@angular/core'
 
 describe('Discriminated union return type', () => {
   test('data should be possibly undefined by default', () => {
     const mutation = injectMutation(() => ({
-      mutationFn: successMutator<string>,
+      mutationFn: () => sleep(0).then(() => 'string'),
     }))
 
     expectTypeOf(mutation.data).toEqualTypeOf<Signal<string | undefined>>()
   })
 
   test('data should be defined when mutation is success', () => {
     const mutation = injectMutation(() => ({
-      mutationFn: successMutator<string>,
+      mutationFn: () => sleep(0).then(() => 'string'),
     }))
 
     if (mutation.isSuccess()) {
@@ -24,7 +24,7 @@ describe('Discriminated union return type', () => {
 
   test('error should be null when mutation is success', () => {
     const mutation = injectMutation(() => ({
-      mutationFn: successMutator<string>,
+      mutationFn: () => sleep(0).then(() => 'string'),
     }))
 
     if (mutation.isSuccess()) {
@@ -34,7 +34,7 @@ describe('Discriminated union return type', () => {
 
   test('data should be undefined when mutation is pending', () => {
     const mutation = injectMutation(() => ({
-      mutationFn: successMutator<string>,
+      mutationFn: () => sleep(0).then(() => 'string'),
     }))
 
     if (mutation.isPending()) {
@@ -44,7 +44,7 @@ describe('Discriminated union return type', () => {
 
   test('error should be defined when mutation is error', () => {
     const mutation = injectMutation(() => ({
-      mutationFn: successMutator<string>,
+      mutationFn: () => sleep(0).then(() => 'string'),
     }))
 
     if (mutation.isError()) {
@@ -54,7 +54,7 @@ describe('Discriminated union return type', () => {
 
   test('should narrow variables', () => {
     const mutation = injectMutation(() => ({
-      mutationFn: successMutator<string>,
+      mutationFn: (_variables: string) => sleep(0).then(() => 'string'),
     }))
 
     if (mutation.isIdle()) {