Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

inject-infinite-query.test.ts

188 lines5.5 KB

1import { TestBed } from '@angular/core/testing'
2import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
3import { ChangeDetectionStrategy, Component, signal } from '@angular/core'
4import { sleep } from '@tanstack/query-test-utils'
5import { QueryClient, injectInfiniteQuery, skipToken } from '..'
6import { expectSignals, setupTanStackQueryTestBed } from './test-utils'
7​
8describe('injectInfiniteQuery', () => {
9 let queryClient: QueryClient
10​
11 beforeEach(() => {
12 queryClient = new QueryClient()
13 vi.useFakeTimers()
14 setupTanStackQueryTestBed(queryClient)
15 })
16​
17 afterEach(() => {
18 vi.useRealTimers()
19 })
20​
21 it.each(['refetch', 'fetchNextPage', 'fetchPreviousPage'] as const)(
22 'applies current infinite-query options before %s',
23 async (method) => {
24 vi.useRealTimers()
25 const version = signal('old')
26 const query = TestBed.runInInjectionContext(() =>
27 injectInfiniteQuery(() => {
28 const current = version()
29 return {
30 queryKey: ['infinite'],
31 enabled: false,
32 initialPageParam: 0,
33 initialData: { pages: ['initial'], pageParams: [0] },
34 getNextPageParam: () => 1,
35 getPreviousPageParam: () => -1,
36 queryFn: async () => current,
37 }
38 }),
39 )
40 query.data()
41 const execute = query[method]
42 version.set('new')
43 const result = await execute()
44 expect(result.data?.pages).toContain('new')
45 expect(result.data?.pages).not.toContain('old')
46 },
47 )
48​
49 it('should properly execute infinite query', async () => {
50 @Component({
51 selector: 'app-test',
52 template: '',
53 changeDetection: ChangeDetectionStrategy.OnPush,
54 })
55 class TestComponent {
56 query = injectInfiniteQuery(() => ({
57 queryKey: ['infiniteQuery'],
58 queryFn: ({ pageParam }) =>
59 sleep(10).then(() => 'data on page ' + pageParam),
60 initialPageParam: 0,
61 getNextPageParam: () => 12,
62 }))
63 }
64​
65 const fixture = TestBed.createComponent(TestComponent)
66 fixture.detectChanges()
67 const query = fixture.componentInstance.query
68​
69 expectSignals(query, {
70 data: undefined,
71 status: 'pending',
72 })
73​
74 await vi.advanceTimersByTimeAsync(11)
75​
76 expectSignals(query, {
77 data: {
78 pageParams: [0],
79 pages: ['data on page 0'],
80 },
81 status: 'success',
82 })
83​
84 void query.fetchNextPage()
85​
86 await vi.advanceTimersByTimeAsync(11)
87​
88 expectSignals(query, {
89 data: {
90 pageParams: [0, 12],
91 pages: ['data on page 0', 'data on page 12'],
92 },
93 status: 'success',
94 })
95 })
96​
97 it('should keep initialData visible alongside the error when a refetch fails', async () => {
98 @Component({
99 selector: 'app-test',
100 template: '',
101 changeDetection: ChangeDetectionStrategy.OnPush,
102 })
103 class TestComponent {
104 query = injectInfiniteQuery(() => ({
105 queryKey: ['infiniteInitialDataError'],
106 queryFn: () =>
107 sleep(10).then(() => Promise.reject(new Error('Some error'))),
108 initialData: { pages: [1], pageParams: [1] },
109 getNextPageParam: (lastPage: number) => lastPage + 1,
110 initialPageParam: 0,
111 retry: false,
112 }))
113 }
114​
115 const fixture = TestBed.createComponent(TestComponent)
116 fixture.detectChanges()
117 const query = fixture.componentInstance.query
118​
119 expect(query.data()?.pages).toEqual([1])
120 expect(query.isError()).toBe(false)
121 expect(query.status()).toBe('success')
122​
123 await vi.advanceTimersByTimeAsync(11)
124 fixture.detectChanges()
125​
126 expect(query.data()?.pages).toEqual([1])
127 expect(query.isError()).toBe(true)
128 expect(query.status()).toBe('error')
129 })
130​
131 it('should not fetch when queryFn is skipToken, and fetch once it is replaced', async () => {
132 const queryFn = vi.fn(({ pageParam }: { pageParam: number }) =>
133 sleep(10).then(() => `comments for 1 page ${pageParam}`),
134 )
135 const postId = signal<string | undefined>(undefined)
136​
137 @Component({
138 selector: 'app-test',
139 template: '',
140 changeDetection: ChangeDetectionStrategy.OnPush,
141 })
142 class TestComponent {
143 query = injectInfiniteQuery(() => ({
144 queryKey: ['skipTokenInfinite'],
145 queryFn: postId() != null ? queryFn : skipToken,
146 initialPageParam: 0,
147 getNextPageParam: () => 12,
148 }))
149 }
150​
151 const fixture = TestBed.createComponent(TestComponent)
152 fixture.detectChanges()
153 const query = fixture.componentInstance.query
154​
155 expect(query.status()).toBe('pending')
156 expect(query.isFetching()).toBe(false)
157​
158 await vi.advanceTimersByTimeAsync(11)
159 fixture.detectChanges()
160 expect(queryFn).not.toHaveBeenCalled()
161 expect(query.status()).toBe('pending')
162 expect(query.isFetching()).toBe(false)
163​
164 postId.set('1')
165 fixture.detectChanges()
166 expect(query.isFetching()).toBe(true)
167​
168 await vi.advanceTimersByTimeAsync(11)
169 fixture.detectChanges()
170 expect(queryFn).toHaveBeenCalledTimes(1)
171 expect(query.status()).toBe('success')
172 expect(query.data()?.pages).toEqual(['comments for 1 page 0'])
173 })
174​
175 describe('injection context', () => {
176 it('throws NG0203 with descriptive error outside injection context', () => {
177 expect(() => {
178 injectInfiniteQuery(() => ({
179 queryKey: ['injectionContextError'],
180 queryFn: ({ pageParam }) =>
181 sleep(0).then(() => 'data on page ' + pageParam),
182 initialPageParam: 0,
183 getNextPageParam: () => 12,
184 }))
185 }).toThrowError(/NG0203(.*?)injectInfiniteQuery/)
186 })
187 })
188})