@tanstack/react-query 5.39.0 → 5.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query",
-  "version": "5.39.0",
+  "version": "5.40.0",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in React",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -41,7 +41,7 @@
     "!build/codemods/**/__tests__"
   ],
   "dependencies": {
-    "@tanstack/query-core": "5.38.0"
+    "@tanstack/query-core": "5.40.0"
   },
   "devDependencies": {
     "@types/react": "npm:types-react@rc",

package/src/__tests__/useQuery.test.tsx

@@ -2,7 +2,7 @@ import { describe, expect, expectTypeOf, it, test, vi } from 'vitest'
 import { act, fireEvent, render, waitFor } from '@testing-library/react'
 import * as React from 'react'
 import { ErrorBoundary } from 'react-error-boundary'
-import { skipToken } from '@tanstack/query-core'
+import { dehydrate, hydrate, skipToken } from '@tanstack/query-core'
 import { QueryCache, keepPreviousData, useQuery } from '..'
 import {
   Blink,
@@ -6476,4 +6476,117 @@ describe('useQuery', () => {
     })
     expect(results[3]?.errorUpdatedAt).toBeGreaterThan(0)
   })
+
+  it('should pick up an initialPromise', async () => {
+    const key = queryKey()
+
+    const serverQueryClient = createQueryClient({
+      defaultOptions: { dehydrate: { shouldDehydrateQuery: () => true } },
+    })
+
+    void serverQueryClient.prefetchQuery({
+      queryKey: key,
+      queryFn: async () => {
+        await sleep(10)
+        return Promise.resolve('server')
+      },
+    })
+
+    const dehydrated = dehydrate(serverQueryClient)
+
+    let count = 0
+
+    function Page() {
+      const query = useQuery({
+        queryKey: key,
+        queryFn: async () => {
+          count++
+          await sleep(10)
+          return Promise.resolve('client')
+        },
+      })
+
+      return (
+        <div>
+          <div>data: {query.data}</div>
+          <button onClick={() => query.refetch()}>refetch</button>
+        </div>
+      )
+    }
+
+    const clientQueryClient = createQueryClient()
+    hydrate(clientQueryClient, dehydrated)
+
+    const rendered = renderWithClient(clientQueryClient, <Page />)
+
+    await waitFor(() => rendered.getByText('data: server'))
+    expect(count).toBe(0)
+
+    fireEvent.click(rendered.getByRole('button', { name: 'refetch' }))
+
+    await waitFor(() => rendered.getByText('data: client'))
+    expect(count).toBe(1)
+  })
+
+  it('should retry failed initialPromise on the client', async () => {
+    const consoleMock = vi
+      .spyOn(console, 'error')
+      .mockImplementation(() => undefined)
+    const key = queryKey()
+
+    const serverQueryClient = createQueryClient({
+      defaultOptions: {
+        dehydrate: { shouldDehydrateQuery: () => true },
+      },
+    })
+
+    void serverQueryClient.prefetchQuery({
+      queryKey: key,
+      queryFn: async () => {
+        await sleep(10)
+        return Promise.reject(new Error('server error'))
+      },
+    })
+
+    const dehydrated = dehydrate(serverQueryClient)
+
+    let count = 0
+
+    function Page() {
+      const query = useQuery({
+        queryKey: key,
+        queryFn: async () => {
+          count++
+          await sleep(10)
+          return Promise.resolve('client')
+        },
+      })
+
+      return (
+        <div>
+          <div>failure: {query.failureReason?.message}</div>
+          <div>data: {query.data}</div>
+        </div>
+      )
+    }
+
+    const clientQueryClient = createQueryClient({
+      defaultOptions: { hydrate: { queries: { retry: 1, retryDelay: 10 } } },
+    })
+    hydrate(clientQueryClient, dehydrated)
+
+    const rendered = renderWithClient(clientQueryClient, <Page />)
+    await waitFor(() => rendered.getByText('failure: redacted'))
+    await waitFor(() => rendered.getByText('data: client'))
+    expect(count).toBe(1)
+
+    const query = clientQueryClient.getQueryCache().find({ queryKey: key })
+
+    expect(consoleMock).toHaveBeenCalledTimes(1)
+    expect(consoleMock).toHaveBeenCalledWith(
+      `A query that was dehydrated as pending ended up rejecting. [${query?.queryHash}]: Error: server error; The error will be redacted in production builds`,
+    )
+
+    consoleMock.mockRestore()
+  })
 })