@tanstack/query-core 4.14.1 → 4.14.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-core",
-  "version": "4.14.1",
+  "version": "4.14.5",
   "description": "The framework agnostic core that powers TanStack Query",
   "author": "tannerlinsley",
   "license": "MIT",

package/src/infiniteQueryBehavior.ts

@@ -76,7 +76,7 @@ export function infiniteQueryBehavior<
           const queryFnContext: QueryFunctionContext = {
             queryKey: context.queryKey,
             pageParam: param,
-            meta: context.meta,
+            meta: context.options.meta,
           }
 
           addSignalProperty(queryFnContext)

package/src/infiniteQueryObserver.ts

@@ -139,18 +139,25 @@ export class InfiniteQueryObserver<
   ): InfiniteQueryObserverResult<TData, TError> {
     const { state } = query
     const result = super.createResult(query, options)
+
+    const { isFetching, isRefetching } = result
+
+    const isFetchingNextPage =
+      isFetching && state.fetchMeta?.fetchMore?.direction === 'forward'
+
+    const isFetchingPreviousPage =
+      isFetching && state.fetchMeta?.fetchMore?.direction === 'backward'
+
     return {
       ...result,
       fetchNextPage: this.fetchNextPage,
       fetchPreviousPage: this.fetchPreviousPage,
       hasNextPage: hasNextPage(options, state.data?.pages),
       hasPreviousPage: hasPreviousPage(options, state.data?.pages),
-      isFetchingNextPage:
-        state.fetchStatus === 'fetching' &&
-        state.fetchMeta?.fetchMore?.direction === 'forward',
-      isFetchingPreviousPage:
-        state.fetchStatus === 'fetching' &&
-        state.fetchMeta?.fetchMore?.direction === 'backward',
+      isFetchingNextPage,
+      isFetchingPreviousPage,
+      isRefetching:
+        isRefetching && !isFetchingNextPage && !isFetchingPreviousPage,
     }
   }
 }

package/src/mutation.ts

@@ -91,7 +91,6 @@ export class Mutation<
   state: MutationState<TData, TError, TVariables, TContext>
   options: MutationOptions<TData, TError, TVariables, TContext>
   mutationId: number
-  meta: MutationMeta | undefined
 
   private observers: MutationObserver<TData, TError, TVariables, TContext>[]
   private mutationCache: MutationCache
@@ -110,12 +109,15 @@ export class Mutation<
     this.logger = config.logger || defaultLogger
     this.observers = []
     this.state = config.state || getDefaultState()
-    this.meta = config.meta
 
     this.updateCacheTime(this.options.cacheTime)
     this.scheduleGc()
   }
 
+  get meta(): MutationMeta | undefined {
+    return this.options.meta
+  }
+
   setState(state: MutationState<TData, TError, TVariables, TContext>): void {
     this.dispatch({ type: 'setState', state })
   }

package/src/mutationCache.ts

@@ -101,7 +101,6 @@ export class MutationCache extends Subscribable<MutationCacheListener> {
       defaultOptions: options.mutationKey
         ? client.getMutationDefaults(options.mutationKey)
         : undefined,
-      meta: options.meta,
     })
 
     this.add(mutation)

package/src/query.ts

@@ -34,7 +34,6 @@ interface QueryConfig<
   options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>
   defaultOptions?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>
   state?: QueryState<TData, TError>
-  meta: QueryMeta | undefined
 }
 
 export interface QueryState<TData = unknown, TError = unknown> {
@@ -64,7 +63,6 @@ export interface FetchContext<
   options: QueryOptions<TQueryFnData, TError, TData, any>
   queryKey: TQueryKey
   state: QueryState<TData, TError>
-  meta: QueryMeta | undefined
 }
 
 export interface QueryBehavior<
@@ -152,7 +150,6 @@ export class Query<
   initialState: QueryState<TData, TError>
   revertState?: QueryState<TData, TError>
   state: QueryState<TData, TError>
-  meta: QueryMeta | undefined
   isFetchingOptimistic?: boolean
 
   private cache: QueryCache
@@ -176,7 +173,10 @@ export class Query<
     this.queryHash = config.queryHash
     this.initialState = config.state || getDefaultState(this.options)
     this.state = this.initialState
-    this.meta = config.meta
+  }
+
+  get meta(): QueryMeta | undefined {
+    return this.options.meta
   }
 
   private setOptions(
@@ -184,8 +184,6 @@ export class Query<
   ): void {
     this.options = { ...this.defaultOptions, ...options }
 
-    this.meta = options?.meta
-
     this.updateCacheTime(this.options.cacheTime)
   }
 
@@ -406,7 +404,6 @@ export class Query<
       queryKey: this.queryKey,
       state: this.state,
       fetchFn,
-      meta: this.meta,
     }
 
     addSignalProperty(context)

package/src/queryCache.ts

@@ -103,7 +103,6 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
         options: client.defaultQueryOptions(options),
         state,
         defaultOptions: client.getQueryDefaults(queryKey),
-        meta: options.meta,
       })
       this.add(query)
     }

package/src/tests/query.test.tsx

@@ -134,8 +134,8 @@ describe('query', () => {
     // There should not be a result yet
     expect(result).toBeUndefined()
 
-    // By now we should have a value
-    await sleep(50)
+    // Promise should eventually be resolved
+    await promise
     expect(result).toBe('data3')
   })
 
@@ -174,12 +174,15 @@ describe('query', () => {
     query.cancel()
 
     // Check if the error is set to the cancelled error
-    await sleep(0)
-    expect(isCancelledError(result)).toBe(true)
-
-    // Reset visibilityState to original value
-    visibilityMock.mockRestore()
-    window.dispatchEvent(new FocusEvent('focus'))
+    try {
+      await promise
+    } catch {
+      expect(isCancelledError(result)).toBe(true)
+    } finally {
+      // Reset visibilityState to original value
+      visibilityMock.mockRestore()
+      window.dispatchEvent(new FocusEvent('focus'))
+    }
   })
 
   test('should provide context to queryFn', async () => {
@@ -593,6 +596,23 @@ describe('query', () => {
     expect(query.options.meta).toBeUndefined()
   })
 
+  test('can use default meta', async () => {
+    const meta = {
+      it: 'works',
+    }
+
+    const key = queryKey()
+    const queryFn = () => 'data'
+
+    queryClient.setQueryDefaults(key, { meta })
+
+    await queryClient.prefetchQuery(key, queryFn)
+
+    const query = queryCache.find(key)!
+
+    expect(query.meta).toBe(meta)
+  })
+
   test('provides meta object inside query function', async () => {
     const meta = {
       it: 'works',

package/src/tests/queryCache.test.tsx

@@ -1,7 +1,8 @@
 import { sleep, queryKey, createQueryClient } from './utils'
 import type { QueryClient } from '..'
-import { QueryCache } from '..'
+import { QueryCache, QueryObserver } from '..'
 import type { Query } from '.././query'
+import { waitFor } from '@testing-library/react'
 
 describe('queryCache', () => {
   let queryClient: QueryClient
@@ -37,6 +38,40 @@ describe('queryCache', () => {
       expect(callback).toHaveBeenCalled()
     })
 
+    test('should notify query cache when a query becomes stale', async () => {
+      const key = queryKey()
+      const events: Array<string> = []
+      const unsubscribe = queryCache.subscribe((event) => {
+        events.push(event.type)
+      })
+
+      const observer = new QueryObserver(queryClient, {
+        queryKey: key,
+        queryFn: () => 'data',
+        staleTime: 10,
+      })
+
+      const unsubScribeObserver = observer.subscribe(jest.fn)
+
+      await waitFor(() => {
+        expect(events.length).toBe(8)
+      })
+
+      expect(events).toEqual([
+        'added', // 1. Query added -> loading
+        'observerResultsUpdated', // 2. Observer result updated -> loading
+        'observerAdded', // 3. Observer added
+        'observerResultsUpdated', // 4. Observer result updated -> fetching
+        'updated', // 5. Query updated -> fetching
+        'observerResultsUpdated', // 6. Observer result updated -> success
+        'updated', // 7. Query updated -> success
+        'observerResultsUpdated', // 8. Observer result updated -> stale
+      ])
+
+      unsubscribe()
+      unsubScribeObserver()
+    })
+
     test('should include the queryCache and query when notifying listeners', async () => {
       const key = queryKey()
       const callback = jest.fn()