fix: all Promise rejections must be Errors (#4843)

* fix: make sure all promise rejections are Errors because our default TError type is now Error * fix: make sure all promise rejections are Errors because our default TError type is now Error * remove string promise rejection I can't say I fully understand this code, but whatever we reject here does not land up in our reducer because we have already rejected with a CancelledError the rejection here is just necessary to stop further pages from fetching after the AbortSignal has been consumed * fix another test * fix types * fix createQuery tests
TanStack · Jan 20, 2023 · 8c373d2 · 8c373d2
1 parent 63943c6
commit 8c373d2
Show file tree

Hide file tree

Showing 12 changed files with 118 additions and 117 deletions.
diff --git a/packages/query-core/src/infiniteQueryBehavior.ts b/packages/query-core/src/infiniteQueryBehavior.ts
@@ -44,7 +44,8 @@ export function infiniteQueryBehavior<
 
         // Get query function
         const queryFn =
-          context.options.queryFn || (() => Promise.reject('Missing queryFn'))
+          context.options.queryFn ||
+          (() => Promise.reject(new Error('Missing queryFn')))
 
         const buildNewPages = (
           pages: unknown[],
@@ -66,7 +67,7 @@ export function infiniteQueryBehavior<
           previous?: boolean,
         ): Promise<unknown[]> => {
           if (cancelled) {
-            return Promise.reject('Cancelled')
+            return Promise.reject()
           }
 
           if (typeof param === 'undefined' && !manual && pages.length) {

diff --git a/packages/query-core/src/mutation.ts b/packages/query-core/src/mutation.ts
@@ -162,7 +162,7 @@ export class Mutation<
       this.#retryer = createRetryer({
         fn: () => {
           if (!this.options.mutationFn) {
-            return Promise.reject('No mutationFn found')
+            return Promise.reject(new Error('No mutationFn found'))
           }
           return this.options.mutationFn(this.state.variables!)
         },

diff --git a/packages/query-core/src/query.ts b/packages/query-core/src/query.ts
@@ -389,7 +389,7 @@ export class Query<
     // Create fetch function
     const fetchFn = () => {
       if (!this.options.queryFn) {
-        return Promise.reject('Missing queryFn')
+        return Promise.reject(new Error('Missing queryFn'))
       }
       this.#abortSignalConsumed = false
       return this.options.queryFn(

diff --git a/packages/query-core/src/tests/hydration.test.tsx b/packages/query-core/src/tests/hydration.test.tsx
@@ -347,7 +347,7 @@ describe('dehydration and rehydration', () => {
 
     const serverAddTodo = jest
       .fn()
-      .mockImplementation(() => Promise.reject('offline'))
+      .mockImplementation(() => Promise.reject(new Error('offline')))
     const serverOnMutate = jest.fn().mockImplementation((variables) => {
       const optimisticTodo = { id: 1, text: variables.text }
       return { optimisticTodo }
@@ -424,7 +424,7 @@ describe('dehydration and rehydration', () => {
 
     const serverAddTodo = jest
       .fn()
-      .mockImplementation(() => Promise.reject('offline'))
+      .mockImplementation(() => Promise.reject(new Error('offline')))
 
     const queryClient = createQueryClient()
 
@@ -453,7 +453,7 @@ describe('dehydration and rehydration', () => {
 
     const serverAddTodo = jest
       .fn()
-      .mockImplementation(() => Promise.reject('offline'))
+      .mockImplementation(() => Promise.reject(new Error('offline')))
 
     const queryClient = createQueryClient()
 

diff --git a/packages/query-core/src/tests/infiniteQueryBehavior.test.tsx b/packages/query-core/src/tests/infiniteQueryBehavior.test.tsx
@@ -37,7 +37,7 @@ describe('InfiniteQueryBehavior', () => {
     await waitFor(() => {
       return expect(observerResult).toMatchObject({
         isError: true,
-        error: 'Missing queryFn',
+        error: new Error('Missing queryFn'),
       })
     })
 

diff --git a/packages/query-core/src/tests/mutationCache.test.tsx b/packages/query-core/src/tests/mutationCache.test.tsx
@@ -14,13 +14,18 @@ describe('mutationCache', () => {
         await executeMutation(testClient, {
           mutationKey: key,
           variables: 'vars',
-          mutationFn: () => Promise.reject('error'),
+          mutationFn: () => Promise.reject(new Error('error')),
           onMutate: () => 'context',
         })
       } catch {}
 
       const mutation = testCache.getAll()[0]
-      expect(onError).toHaveBeenCalledWith('error', 'vars', 'context', mutation)
+      expect(onError).toHaveBeenCalledWith(
+        new Error('error'),
+        'vars',
+        'context',
+        mutation,
+      )
     })
 
     test('should be awaited', async () => {
@@ -38,7 +43,7 @@ describe('mutationCache', () => {
         await executeMutation(testClient, {
           mutationKey: key,
           variables: 'vars',
-          mutationFn: () => Promise.reject('error'),
+          mutationFn: () => Promise.reject(new Error('error')),
           onError: async () => {
             states.push(3)
             await sleep(1)

diff --git a/packages/query-core/src/tests/mutations.test.tsx b/packages/query-core/src/tests/mutations.test.tsx
@@ -153,7 +153,7 @@ describe('mutations', () => {
     const mutation = new MutationObserver(queryClient, {
       mutationFn: async () => {
         await sleep(20)
-        return Promise.reject('err')
+        return Promise.reject(new Error('err'))
       },
       onMutate: (text) => text,
       variables: 'todo',
@@ -214,7 +214,7 @@ describe('mutations', () => {
       data: undefined,
       error: null,
       failureCount: 1,
-      failureReason: 'err',
+      failureReason: new Error('err'),
       isError: false,
       isIdle: false,
       isLoading: true,
@@ -231,9 +231,9 @@ describe('mutations', () => {
     expect(states[3]).toEqual({
       context: 'todo',
       data: undefined,
-      error: 'err',
+      error: new Error('err'),
       failureCount: 2,
-      failureReason: 'err',
+      failureReason: new Error('err'),
       isError: true,
       isIdle: false,
       isLoading: false,
@@ -340,6 +340,6 @@ describe('mutations', () => {
     } catch (err) {
       error = err
     }
-    expect(error).toEqual('No mutationFn found')
+    expect(error).toEqual(new Error('No mutationFn found'))
   })
 })
diff --git a/packages/query-core/src/tests/query.test.tsx b/packages/query-core/src/tests/query.test.tsx
@@ -761,7 +761,7 @@ describe('query', () => {
 
     const unsubscribe = observer.subscribe(() => undefined)
     await sleep(10)
-    expect(mockLogger.error).toHaveBeenCalledWith('Missing queryFn')
+    expect(mockLogger.error).toHaveBeenCalledWith(new Error('Missing queryFn'))
 
     unsubscribe()
   })

diff --git a/packages/react-query/src/__tests__/useMutation.test.tsx b/packages/react-query/src/__tests__/useMutation.test.tsx
@@ -154,7 +154,7 @@ describe('useMutation', () => {
     const mutateFn = jest.fn<Promise<Value>, [value: Value]>()
 
     mutateFn.mockImplementationOnce(() => {
-      return Promise.reject('Error test Jonas')
+      return Promise.reject(new Error('Error test Jonas'))
     })
 
     mutateFn.mockImplementation(async (value) => {
@@ -163,18 +163,16 @@ describe('useMutation', () => {
     })
 
     function Page() {
-      const { mutate, failureCount, failureReason, data, status } = useMutation<
-        Value,
-        string,
-        Value
-      >({ mutationFn: mutateFn })
+      const { mutate, failureCount, failureReason, data, status } = useMutation(
+        { mutationFn: mutateFn },
+      )
 
       return (
         <div>
           <h1>Data {data?.count}</h1>
           <h2>Status {status}</h2>
           <h2>Failed {failureCount} times</h2>
-          <h2>Failed because {failureReason ?? 'null'}</h2>
+          <h2>Failed because {failureReason?.message ?? 'null'}</h2>
           <button onClick={() => mutate({ count: ++count })}>mutate</button>
         </div>
       )
@@ -318,7 +316,7 @@ describe('useMutation', () => {
 
     function Page() {
       const { mutateAsync } = useMutation({
-        mutationFn: async (_text: string) => Promise.reject('oops'),
+        mutationFn: async (_text: string) => Promise.reject(new Error('oops')),
         onError: async () => {
           callbacks.push('useMutation.onError')
         },
@@ -339,7 +337,7 @@ describe('useMutation', () => {
               },
             })
           } catch (error) {
-            callbacks.push(`mutateAsync.error:${error}`)
+            callbacks.push(`mutateAsync.error:${(error as Error).message}`)
           }
         }, 10)
       }, [mutateAsync])
@@ -405,7 +403,7 @@ describe('useMutation', () => {
       const { mutate } = useMutation({
         mutationFn: (_text: string) => {
           count++
-          return Promise.reject('oops')
+          return Promise.reject(new Error('oops'))
         },
         retry: 1,
         retryDelay: 5,
@@ -594,7 +592,9 @@ describe('useMutation', () => {
         mutationFn: async (_text: string) => {
           await sleep(1)
           count++
-          return count > 1 ? Promise.resolve('data') : Promise.reject('oops')
+          return count > 1
+            ? Promise.resolve('data')
+            : Promise.reject(new Error('oops'))
         },
         retry: 1,
         retryDelay: 5,
@@ -635,13 +635,13 @@ describe('useMutation', () => {
       isLoading: true,
       isPaused: false,
       failureCount: 1,
-      failureReason: 'oops',
+      failureReason: new Error('oops'),
     })
     expect(states[3]).toMatchObject({
       isLoading: true,
       isPaused: true,
       failureCount: 1,
-      failureReason: 'oops',
+      failureReason: new Error('oops'),
     })
 
     onlineMock.mockReturnValue(true)
@@ -654,7 +654,7 @@ describe('useMutation', () => {
       isLoading: true,
       isPaused: false,
       failureCount: 1,
-      failureReason: 'oops',
+      failureReason: new Error('oops'),
     })
     expect(states[5]).toMatchObject({
       isLoading: false,