refactor: remove gc flag (TanStack#825)

Author: boschni

src/core/query.ts

@@ -43,7 +43,6 @@ export interface QueryState<TResult, TError> {
   isLoading: boolean
   isStale: boolean
   isSuccess: boolean
-  markedForGarbageCollection: boolean
   status: QueryStatus
   throwInErrorBoundary?: boolean
   updatedAt: number
@@ -61,7 +60,6 @@ export interface FetchMoreOptions {
 enum ActionType {
   Failed = 'Failed',
   MarkStale = 'MarkStale',
-  MarkGC = 'MarkGC',
   Fetch = 'Fetch',
   Success = 'Success',
   Error = 'Error',
@@ -76,10 +74,6 @@ interface MarkStaleAction {
   type: ActionType.MarkStale
 }
 
-interface MarkGCAction {
-  type: ActionType.MarkGC
-}
-
 interface FetchAction {
   type: ActionType.Fetch
 }
@@ -105,7 +99,6 @@ type Action<TResult, TError> =
   | ErrorAction<TError>
   | FailedAction
   | FetchAction
-  | MarkGCAction
   | MarkStaleAction
   | SetStateAction<TResult, TError>
   | SuccessAction<TResult>
@@ -220,14 +213,9 @@ export class Query<TResult, TError> {
       return
     }
 
-    this.dispatch({ type: ActionType.MarkGC })
-
     this.cacheTimeout = setTimeout(
       () => {
-        this.queryCache.removeQueries(
-          d =>
-            d.state.markedForGarbageCollection && d.queryHash === this.queryHash
-        )
+        this.clear()
       },
       typeof this.state.data === 'undefined' &&
         this.state.status !== QueryStatus.Error
@@ -612,7 +600,6 @@ function getDefaultState<TResult, TError>(
     isFetching: initialStatus === QueryStatus.Loading,
     failureCount: 0,
     isStale,
-    markedForGarbageCollection: false,
     data: initialData,
     updatedAt: hasInitialData ? Date.now() : 0,
   }
@@ -633,12 +620,6 @@ export function queryReducer<TResult, TError>(
         ...state,
         isStale: true,
       }
-    case ActionType.MarkGC: {
-      return {
-        ...state,
-        markedForGarbageCollection: true,
-      }
-    }
     case ActionType.Fetch:
       const status =
         typeof state.data !== 'undefined'

src/react/tests/useInfiniteQuery.test.tsx

@@ -203,6 +203,8 @@ describe('useInfiniteQuery', () => {
   })
 
   it('should compute canFetchMore correctly for falsy getFetchMore return value', async () => {
+    const key = queryKey()
+
     function Page() {
       const fetchCountRef = React.useRef(0)
       const {
@@ -215,7 +217,7 @@ describe('useInfiniteQuery', () => {
         canFetchMore,
         refetch,
       } = useInfiniteQuery<Result, Error, string>(
-        'items',
+        key,
         (_key, nextId = 0) => fetchItems(nextId, fetchCountRef.current++),
         {
           getFetchMore: (_lastGroup, _allGroups) => undefined,
@@ -374,6 +376,8 @@ describe('useInfiniteQuery', () => {
   })
 
   it('should compute canFetchMore correctly for falsy getFetchMore return value using initialData', async () => {
+    const key = queryKey()
+
     function Page() {
       const fetchCountRef = React.useRef(0)
       const {
@@ -386,7 +390,7 @@ describe('useInfiniteQuery', () => {
         canFetchMore,
         refetch,
       } = useInfiniteQuery<Result, Error, string>(
-        'items',
+        key,
         (_key, nextId = 0) => fetchItems(nextId, fetchCountRef.current++),
         {
           initialData: [initialItems(0)],

src/react/tests/useQuery.test.tsx

@@ -537,18 +537,16 @@ describe('useQuery', () => {
     const key = queryKey()
 
     const queryFn = jest.fn()
-    queryFn.mockImplementation(() => sleep(10).then(() => 'data'))
+    queryFn.mockImplementation(() => 'data')
 
     const prefetchQueryFn = jest.fn()
-    prefetchQueryFn.mockImplementation(() => sleep(16).then(() => 'not yet...'))
+    prefetchQueryFn.mockImplementation(() => 'not yet...')
 
-    await act(() =>
-      queryCache.prefetchQuery(key, prefetchQueryFn, {
-        staleTime: 10,
-      })
-    )
+    await queryCache.prefetchQuery(key, prefetchQueryFn, {
+      staleTime: 10,
+    })
 
-    await act(() => sleep(20))
+    await sleep(100)
 
     function Page() {
       const query = useQuery(key, queryFn)
@@ -560,9 +558,9 @@ describe('useQuery', () => {
       )
     }
 
-    const rendered = render(<Page />)
+    render(<Page />)
 
-    await waitFor(() => rendered.getByText('data'))
+    await sleep(100)
 
     expect(prefetchQueryFn).toHaveBeenCalledTimes(1)
     expect(queryFn).toHaveBeenCalledTimes(1)
@@ -572,16 +570,16 @@ describe('useQuery', () => {
     const key = queryKey()
 
     const queryFn = jest.fn()
-    queryFn.mockImplementation(() => sleep(10).then(() => 'data'))
+    queryFn.mockImplementation(() => 'data')
 
     const prefetchQueryFn = jest.fn()
-    prefetchQueryFn.mockImplementation(() => sleep(16).then(() => 'not yet...'))
+    prefetchQueryFn.mockImplementation(() => 'not yet...')
 
-    await act(() =>
-      queryCache.prefetchQuery(key, prefetchQueryFn, {
-        staleTime: 1000,
-      })
-    )
+    await queryCache.prefetchQuery(key, prefetchQueryFn, {
+      staleTime: 1000,
+    })
+
+    sleep(100)
 
     function Page() {
       const query = useQuery(key, queryFn)
@@ -593,9 +591,9 @@ describe('useQuery', () => {
       )
     }
 
-    const rendered = render(<Page />)
+    render(<Page />)
 
-    await waitFor(() => rendered.getByText('data'))
+    sleep(100)
 
     expect(prefetchQueryFn).toHaveBeenCalledTimes(1)
     expect(queryFn).toHaveBeenCalledTimes(0)