fix(core): do not invoke getNextPageParam or getPreviousPageParam if …

…there is we have empty pages in the cache (#7743)
TanStack · Jul 17, 2024 · 7edf587 · 7edf587
1 parent a1ce3c4
commit 7edf587
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 12 deletions.
diff --git a/packages/query-core/src/__tests__/infiniteQueryObserver.test.tsx b/packages/query-core/src/__tests__/infiniteQueryObserver.test.tsx
@@ -103,6 +103,41 @@ describe('InfiniteQueryObserver', () => {
     expect(all).toEqual(['next0', 'next0,1', 'prev0,1'])
   })
 
+  test('should not invoke getNextPageParam and getPreviousPageParam on empty pages', async () => {
+    const key = queryKey()
+
+    const getNextPageParam = vi.fn()
+    const getPreviousPageParam = vi.fn()
+
+    const observer = new InfiniteQueryObserver(queryClient, {
+      queryKey: key,
+      queryFn: ({ pageParam }) => String(pageParam),
+      initialPageParam: 1,
+      getNextPageParam: getNextPageParam.mockImplementation(
+        (_, __, lastPageParam) => {
+          return lastPageParam + 1
+        },
+      ),
+      getPreviousPageParam: getPreviousPageParam.mockImplementation(
+        (_, __, firstPageParam) => {
+          return firstPageParam - 1
+        },
+      ),
+    })
+
+    const unsubscribe = observer.subscribe(() => {})
+
+    getNextPageParam.mockClear()
+    getPreviousPageParam.mockClear()
+
+    queryClient.setQueryData(key, { pages: [], pageParams: [] })
+
+    expect(getNextPageParam).toHaveBeenCalledTimes(0)
+    expect(getPreviousPageParam).toHaveBeenCalledTimes(0)
+
+    unsubscribe()
+  })
+
   test('should stop refetching if undefined is returned from getNextPageParam', async () => {
     const key = queryKey()
     let next: number | undefined = 2

diff --git a/packages/query-core/src/infiniteQueryBehavior.ts b/packages/query-core/src/infiniteQueryBehavior.ts
@@ -133,24 +133,23 @@ function getNextPageParam(
   { pages, pageParams }: InfiniteData<unknown>,
 ): unknown | undefined {
   const lastIndex = pages.length - 1
-  return options.getNextPageParam(
-    pages[lastIndex],
-    pages,
-    pageParams[lastIndex],
-    pageParams,
-  )
+  return pages.length > 0
+    ? options.getNextPageParam(
+        pages[lastIndex],
+        pages,
+        pageParams[lastIndex],
+        pageParams,
+      )
+    : undefined
 }
 
 function getPreviousPageParam(
   options: InfiniteQueryPageParamsOptions<any>,
   { pages, pageParams }: InfiniteData<unknown>,
 ): unknown | undefined {
-  return options.getPreviousPageParam?.(
-    pages[0],
-    pages,
-    pageParams[0],
-    pageParams,
-  )
+  return pages.length > 0
+    ? options.getPreviousPageParam?.(pages[0], pages, pageParams[0], pageParams)
+    : undefined
 }
 
 /**