Merge branch 'main' into feature/react-query-mutation-options

Author: manudeli

packages/angular-query-devtools-experimental/tsup.config.js renamed to packages/angular-query-devtools-experimental/tsup.config.ts

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { defineConfig } from 'tsup'
 import { legacyConfig, modernConfig } from './root.tsup.config.js'
 

packages/angular-query-persist-client/tsup.config.js renamed to packages/angular-query-persist-client/tsup.config.ts

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { defineConfig } from 'tsup'
 import { legacyConfig, modernConfig } from './root.tsup.config.js'
 

packages/eslint-plugin-query/tsup.config.js renamed to packages/eslint-plugin-query/tsup.config.ts

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { defineConfig } from 'tsup'
 import { legacyConfig, modernConfig } from './root.tsup.config.js'
 

packages/query-async-storage-persister/tsup.config.js renamed to packages/query-async-storage-persister/tsup.config.ts

@@ -19,7 +19,7 @@ describe('InfiniteQueryBehavior', () => {
     vi.useRealTimers()
   })
 
-  test('InfiniteQueryBehavior should throw an error if the queryFn is not defined', async () => {
+  test('should throw an error if the queryFn is not defined', async () => {
     const key = queryKey()
 
     const observer = new InfiniteQueryObserver(queryClient, {
@@ -48,7 +48,7 @@ describe('InfiniteQueryBehavior', () => {
     unsubscribe()
   })
 
-  test('InfiniteQueryBehavior should apply the maxPages option to limit the number of pages', async () => {
+  test('should apply the maxPages option to limit the number of pages', async () => {
     const key = queryKey()
     let abortSignal: AbortSignal | null = null
 
@@ -197,7 +197,7 @@ describe('InfiniteQueryBehavior', () => {
     unsubscribe()
   })
 
-  test('InfiniteQueryBehavior should support query cancellation', async () => {
+  test('should support query cancellation', async () => {
     const key = queryKey()
     let abortSignal: AbortSignal | null = null
 
@@ -250,7 +250,7 @@ describe('InfiniteQueryBehavior', () => {
     unsubscribe()
   })
 
-  test('InfiniteQueryBehavior should not refetch pages if the query is cancelled', async () => {
+  test('should not refetch pages if the query is cancelled', async () => {
     const key = queryKey()
     let abortSignal: AbortSignal | null = null
 
@@ -334,7 +334,7 @@ describe('InfiniteQueryBehavior', () => {
     unsubscribe()
   })
 
-  test('InfiniteQueryBehavior should not enter an infinite loop when a page errors while retry is on #8046', async () => {
+  test('should not enter an infinite loop when a page errors while retry is on #8046', async () => {
     let errorCount = 0
     const key = queryKey()
 
@@ -436,7 +436,7 @@ describe('InfiniteQueryBehavior', () => {
     unsubscribe()
   })
 
-  test('InfiniteQueryBehavior should not fetch next page when getNextPageParam returns null', async () => {
+  test('should not fetch next page when getNextPageParam returns null', async () => {
     const key = queryKey()
 
     const observer = new InfiniteQueryObserver(queryClient, {
@@ -471,7 +471,7 @@ describe('InfiniteQueryBehavior', () => {
     unsubscribe()
   })
 
-  test('InfiniteQueryBehavior should use persister when provided', async () => {
+  test('should use persister when provided', async () => {
     const key = queryKey()
 
     const persisterSpy = vi.fn().mockImplementation(async (fn) => {

packages/query-broadcast-client-experimental/tsup.config.js renamed to packages/query-broadcast-client-experimental/tsup.config.ts

@@ -533,7 +533,7 @@ describe('mutations', () => {
     ])
   })
 
-  test('each scope should run should run in parallel, serial within scope', async () => {
+  test('each scope should run in parallel, serial within scope', async () => {
     const results: Array<string> = []
 
     executeMutation(

packages/query-core/src/__tests__/infiniteQueryBehavior.test.tsx

@@ -39,7 +39,7 @@ describe('notifyManager', () => {
     })
     notifyManagerTest.batch(callbackBatchLevel1Spy)
 
-    await vi.advanceTimersByTimeAsync(20)
+    await vi.advanceTimersByTimeAsync(0)
     expect(callbackBatchLevel1Spy).toHaveBeenCalledTimes(1)
     expect(callbackBatchLevel2Spy).toHaveBeenCalledTimes(1)
     expect(callbackScheduleSpy).toHaveBeenCalledTimes(1)
@@ -57,9 +57,7 @@ describe('notifyManager', () => {
 
     expect(customCallback).toHaveBeenCalledOnce()
 
-    // wait until the microtask has run
-    await new Promise<void>((res) => queueMicrotask(res))
-
+    await vi.advanceTimersByTimeAsync(0)
     expect(notifySpy).toHaveBeenCalledTimes(1)
   })
 

packages/query-core/src/__tests__/mutations.test.tsx

@@ -699,9 +699,8 @@ describe('queryClient', () => {
       })
       await vi.advanceTimersByTimeAsync(10)
       await expect(promise).resolves.toEqual(1)
-      await vi.waitFor(() =>
-        expect(queryClient.getQueryData(key1)).toEqual(undefined),
-      )
+      await vi.advanceTimersByTimeAsync(1)
+      expect(queryClient.getQueryData(key1)).toEqual(undefined)
     })
 
     test('should keep a query in cache if garbage collection time is Infinity', async () => {
@@ -1023,7 +1022,7 @@ describe('queryClient', () => {
         queryKey: key3,
         queryFn: () => sleep(1000).then(() => 'data3'),
       })
-      await vi.advanceTimersByTime(10)
+      await vi.advanceTimersByTimeAsync(10)
       await queryClient.cancelQueries()
       const state1 = queryClient.getQueryState(key1)
       const state2 = queryClient.getQueryState(key2)
@@ -1556,7 +1555,7 @@ describe('queryClient', () => {
       observer.subscribe(() => undefined)
 
       queryClient.refetchQueries()
-      await vi.advanceTimersByTime(10)
+      await vi.advanceTimersByTimeAsync(10)
       observer.destroy()
       expect(abortFn).toHaveBeenCalledTimes(1)
       expect(fetchCount).toBe(2)
@@ -1580,7 +1579,7 @@ describe('queryClient', () => {
       observer.subscribe(() => undefined)
 
       queryClient.refetchQueries(undefined, { cancelRefetch: false })
-      await vi.advanceTimersByTime(10)
+      await vi.advanceTimersByTimeAsync(10)
       observer.destroy()
       expect(abortFn).toHaveBeenCalledTimes(0)
       expect(fetchCount).toBe(1)
@@ -1725,9 +1724,8 @@ describe('queryClient', () => {
       expect(mutationCacheResumePausedMutationsSpy).not.toHaveBeenCalled()
 
       focusManager.setFocused(true)
-      await vi.waitFor(() =>
-        expect(queryCacheOnFocusSpy).toHaveBeenCalledTimes(1),
-      )
+      await vi.advanceTimersByTimeAsync(0)
+      expect(queryCacheOnFocusSpy).toHaveBeenCalledTimes(1)
       expect(mutationCacheResumePausedMutationsSpy).toHaveBeenCalledTimes(1)
 
       expect(queryCacheOnOnlineSpy).not.toHaveBeenCalled()
@@ -1759,9 +1757,8 @@ describe('queryClient', () => {
       expect(mutationCacheResumePausedMutationsSpy).not.toHaveBeenCalled()
 
       onlineManager.setOnline(true)
-      await vi.waitFor(() =>
-        expect(queryCacheOnOnlineSpy).toHaveBeenCalledTimes(1),
-      )
+      await vi.advanceTimersByTimeAsync(0)
+      expect(queryCacheOnOnlineSpy).toHaveBeenCalledTimes(1)
 
       expect(mutationCacheResumePausedMutationsSpy).toHaveBeenCalledTimes(1)
 
@@ -1787,17 +1784,14 @@ describe('queryClient', () => {
       void observer1.mutate()
       void observer2.mutate()
 
-      await vi.waitFor(() => {
-        expect(observer1.getCurrentResult().isPaused).toBeTruthy()
-        expect(observer2.getCurrentResult().isPaused).toBeTruthy()
-      })
+      expect(observer1.getCurrentResult().isPaused).toBeTruthy()
+      expect(observer2.getCurrentResult().isPaused).toBeTruthy()
 
       onlineManager.setOnline(true)
 
-      await vi.waitFor(() => {
-        expect(observer1.getCurrentResult().status).toBe('success')
-        expect(observer2.getCurrentResult().status).toBe('success')
-      })
+      await vi.advanceTimersByTimeAsync(0)
+      expect(observer1.getCurrentResult().status).toBe('success')
+      expect(observer2.getCurrentResult().status).toBe('success')
     })
 
     test('should resume paused mutations in parallel', async () => {
@@ -1825,17 +1819,14 @@ describe('queryClient', () => {
       void observer1.mutate()
       void observer2.mutate()
 
-      await vi.waitFor(() => {
-        expect(observer1.getCurrentResult().isPaused).toBeTruthy()
-        expect(observer2.getCurrentResult().isPaused).toBeTruthy()
-      })
+      expect(observer1.getCurrentResult().isPaused).toBeTruthy()
+      expect(observer2.getCurrentResult().isPaused).toBeTruthy()
 
       onlineManager.setOnline(true)
 
-      await vi.waitFor(() => {
-        expect(observer1.getCurrentResult().status).toBe('success')
-        expect(observer2.getCurrentResult().status).toBe('success')
-      })
+      await vi.advanceTimersByTimeAsync(50)
+      expect(observer1.getCurrentResult().status).toBe('success')
+      expect(observer2.getCurrentResult().status).toBe('success')
 
       expect(orders).toEqual(['1start', '2start', '2end', '1end'])
     })
@@ -1873,18 +1864,15 @@ describe('queryClient', () => {
       void observer1.mutate()
       void observer2.mutate()
 
-      await vi.waitFor(() => {
-        expect(observer1.getCurrentResult().isPaused).toBeTruthy()
-        expect(observer2.getCurrentResult().isPaused).toBeTruthy()
-      })
+      expect(observer1.getCurrentResult().isPaused).toBeTruthy()
+      expect(observer2.getCurrentResult().isPaused).toBeTruthy()
 
       onlineManager.setOnline(true)
       void queryClient.resumePausedMutations()
 
-      await vi.waitFor(() => {
-        expect(observer1.getCurrentResult().status).toBe('success')
-        expect(observer2.getCurrentResult().status).toBe('success')
-      })
+      await vi.advanceTimersByTimeAsync(70)
+      expect(observer1.getCurrentResult().status).toBe('success')
+      expect(observer2.getCurrentResult().status).toBe('success')
 
       expect(orders).toEqual(['1start', '1end', '2start', '2end'])
     })
@@ -1909,9 +1897,8 @@ describe('queryClient', () => {
 
       onlineManager.setOnline(true)
 
-      await vi.waitFor(() => {
-        expect(observer.getCurrentResult().status).toBe('success')
-      })
+      await vi.advanceTimersByTimeAsync(0)
+      expect(observer.getCurrentResult().status).toBe('success')
     })
 
     test('should resumePausedMutations when coming online after having restored cache (and resumed) while offline', async () => {
@@ -1950,11 +1937,10 @@ describe('queryClient', () => {
 
       onlineManager.setOnline(true)
 
-      await vi.waitFor(() => {
-        expect(
-          newQueryClient.getMutationCache().getAll()[0]?.state.status,
-        ).toBe('success')
-      })
+      await vi.advanceTimersByTimeAsync(0)
+      expect(newQueryClient.getMutationCache().getAll()[0]?.state.status).toBe(
+        'success',
+      )
 
       newQueryClient.unmount()
     })
@@ -1977,9 +1963,8 @@ describe('queryClient', () => {
 
       const unsubscribe = queryObserver.subscribe(() => undefined)
 
-      await vi.waitFor(() => {
-        expect(queryClient.getQueryData(key)).toBe('data1')
-      })
+      await vi.advanceTimersByTimeAsync(10)
+      expect(queryClient.getQueryData(key)).toBe('data1')
 
       onlineManager.setOnline(false)
 
@@ -2022,21 +2007,13 @@ describe('queryClient', () => {
 
       void observer3.mutate()
 
-      await vi.waitFor(() =>
-        expect(observer.getCurrentResult().isPaused).toBeTruthy(),
-      )
-      await vi.waitFor(() =>
-        expect(observer2.getCurrentResult().isPaused).toBeTruthy(),
-      )
-      await vi.waitFor(() =>
-        expect(observer3.getCurrentResult().isPaused).toBeTruthy(),
-      )
-
+      expect(observer.getCurrentResult().isPaused).toBeTruthy()
+      expect(observer2.getCurrentResult().isPaused).toBeTruthy()
+      expect(observer3.getCurrentResult().isPaused).toBeTruthy()
       onlineManager.setOnline(true)
 
-      await vi.waitFor(() => {
-        expect(queryClient.getQueryData(key)).toBe('data2')
-      })
+      await vi.advanceTimersByTimeAsync(110)
+      expect(queryClient.getQueryData(key)).toBe('data2')
 
       // refetch from coming online should happen after mutations have finished
       expect(results).toStrictEqual([
@@ -2074,15 +2051,13 @@ describe('queryClient', () => {
 
       onlineManager.setOnline(false)
       onlineManager.setOnline(true)
-      await vi.waitFor(() =>
-        expect(queryCacheOnOnlineSpy).toHaveBeenCalledTimes(1),
-      )
+      await vi.advanceTimersByTimeAsync(0)
+      expect(queryCacheOnOnlineSpy).toHaveBeenCalledTimes(1)
       expect(mutationCacheResumePausedMutationsSpy).toHaveBeenCalledTimes(1)
 
       focusManager.setFocused(true)
-      await vi.waitFor(() =>
-        expect(queryCacheOnFocusSpy).toHaveBeenCalledTimes(1),
-      )
+      await vi.advanceTimersByTimeAsync(0)
+      expect(queryCacheOnFocusSpy).toHaveBeenCalledTimes(1)
       expect(mutationCacheResumePausedMutationsSpy).toHaveBeenCalledTimes(2)
 
       queryCacheOnFocusSpy.mockRestore()

packages/query-core/src/__tests__/notifyManager.test.tsx

@@ -4,5 +4,5 @@
     "outDir": "./dist-ts",
     "rootDir": "."
   },
-  "include": ["src", "*.config.js", "package.json"]
+  "include": ["src", "*.config.js", "*.config.ts", "package.json"]
 }