fix: match query key correctly when setting defaults

Author: boschni

src/core/queryClient.ts

@@ -1,6 +1,7 @@
 import {
   QueryFilters,
   Updater,
+  hashQueryKey,
   noop,
   parseFilterArgs,
   parseQueryArgs,
@@ -303,8 +304,8 @@ export class QueryClient {
     queryKey: QueryKey,
     options: QueryOptions<any, any, any>
   ): void {
-    const result = this.queryDefaults.find(x =>
-      partialMatchKey(x.queryKey, queryKey)
+    const result = this.queryDefaults.find(
+      x => hashQueryKey(queryKey) === hashQueryKey(x.queryKey)
     )
     if (result) {
       result.defaultOptions = options
@@ -316,16 +317,16 @@ export class QueryClient {
   getQueryDefaults(
     queryKey: QueryKey
   ): QueryOptions<any, any, any> | undefined {
-    return this.queryDefaults.find(x => partialMatchKey(x.queryKey, queryKey))
+    return this.queryDefaults.find(x => partialMatchKey(queryKey, x.queryKey))
       ?.defaultOptions
   }
 
   setMutationDefaults(
     mutationKey: MutationKey,
     options: MutationOptions<any, any, any, any>
   ): void {
-    const result = this.mutationDefaults.find(x =>
-      partialMatchKey(x.mutationKey, mutationKey)
+    const result = this.mutationDefaults.find(
+      x => hashQueryKey(mutationKey) === hashQueryKey(x.mutationKey)
     )
     if (result) {
       result.defaultOptions = options
@@ -338,7 +339,7 @@ export class QueryClient {
     mutationKey: MutationKey
   ): MutationOptions<any, any, any, any> | undefined {
     return this.mutationDefaults.find(x =>
-      partialMatchKey(x.mutationKey, mutationKey)
+      partialMatchKey(mutationKey, x.mutationKey)
     )?.defaultOptions
   }
 

src/core/queryObserver.ts

@@ -236,12 +236,16 @@ export class QueryObserver<
     this.updateQuery()
 
     // Fetch
-    return this.currentQuery
-      .fetch(
-        this.options as QueryOptions<TQueryData, TError, TQueryFnData>,
-        fetchOptions
-      )
-      .catch(noop)
+    let promise: Promise<TQueryData | undefined> = this.currentQuery.fetch(
+      this.options as QueryOptions<TQueryData, TError, TQueryFnData>,
+      fetchOptions
+    )
+
+    if (!fetchOptions?.throwOnError) {
+      promise = promise.catch(noop)
+    }
+
+    return promise
   }
 
   private updateStaleTimeout(): void {

src/core/tests/queryCache.test.tsx

@@ -30,15 +30,21 @@ describe('queryCache', () => {
   })
 
   test('setQueryDefaults should be able to override defaults', async () => {
-    const consoleMock = mockConsoleError()
     const key = queryKey()
-    const queryFn = jest.fn().mockRejectedValue('reject')
-    queryClient.setQueryDefaults(key, { queryFn, retry: 1 })
+    queryClient.setQueryDefaults(key, { queryFn: () => 'data' })
     const observer = new QueryObserver(queryClient, { queryKey: key })
-    const { error } = await observer.getNextResult({ throwOnError: false })
-    expect(error).toBe('reject')
-    expect(queryFn).toHaveBeenCalledTimes(2)
-    consoleMock.mockRestore()
+    const { data } = await observer.refetch()
+    expect(data).toBe('data')
+  })
+
+  test('setQueryDefaults should match the query key partially', async () => {
+    const key = queryKey()
+    queryClient.setQueryDefaults([key], { queryFn: () => 'data' })
+    const observer = new QueryObserver(queryClient, {
+      queryKey: [key, 'a'],
+    })
+    const { data } = await observer.refetch()
+    expect(data).toBe('data')
   })
 
   test('setQueryData does not crash if query could not be found', () => {

src/core/tests/utils.test.tsx

@@ -62,6 +62,12 @@ describe('core/utils', () => {
       const b = { a: { b: 'b' }, c: 'c', d: [{ d: 'd ' }] }
       expect(partialDeepEqual(a, b)).toEqual(false)
     })
+
+    it('should return `true` if array a includes array b', () => {
+      const a = [1, 2, 3]
+      const b = [1, 2]
+      expect(partialDeepEqual(a, b)).toEqual(true)
+    })
   })
 
   describe('replaceEqualDeep', () => {

src/core/utils.ts

@@ -241,7 +241,7 @@ export function partialDeepEqual(a: any, b: any): boolean {
     return false
   }
 
-  if (typeof a === 'object') {
+  if (typeof a === 'object' && typeof b === 'object') {
     return !Object.keys(b).some(key => !partialDeepEqual(a[key], b[key]))
   }
 

src/react/useBaseQuery.ts

@@ -75,7 +75,8 @@ export function useBaseQuery<TData, TError, TQueryFnData, TQueryData>(
       observer.willFetchOnMount()
     ) {
       errorResetBoundary.clearReset()
-      throw observer.getNextResult({ throwOnError: true })
+      const unsubscribe = observer.subscribe()
+      throw observer.refetch().finally(unsubscribe)
     }
   }