Skip to content

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

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

Merged
merged 11 commits into from
May 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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:*",
Expand Down
1 change: 1 addition & 0 deletions packages/angular-query-experimental/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -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', () => {
Expand All @@ -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,
}))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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,
}))
Expand Down Expand Up @@ -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,
}))
Expand All @@ -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,
}),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -39,7 +39,7 @@ describe('injectIsFetching', () => {
const isFetching = TestBed.runInInjectionContext(() => {
injectQuery(() => ({
queryKey: ['isFetching1'],
queryFn: delayedFetcher(100),
queryFn: () => sleep(100).then(() => 'Some data'),
}))
return injectIsFetching()
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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),
}))
})

Expand All @@ -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),
})),
]
})
Expand Down Expand Up @@ -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),
}))
})

Expand Down
Original file line number Diff line number Diff line change
@@ -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()) {
Expand All @@ -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()) {
Expand All @@ -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()) {
Expand All @@ -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()) {
Expand All @@ -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()) {
Expand Down
Loading
Loading