Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/olive-pugs-shave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/router-ssr-query-core': patch
---

skip hydration when the query stream closes
2 changes: 1 addition & 1 deletion packages/router-ssr-query-core/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -195,10 +195,10 @@ export function setupCoreRouterSsrQueryIntegration<TRouter extends AnyRouter>({
reader
.read()
.then(async function handle({ done, value }) {
queryHydrate(queryClient, value, hydrateOptions)
if (done) {
return
}
queryHydrate(queryClient, value, hydrateOptions)
const result = await reader.read()
return handle(result)
})
Expand Down
38 changes: 38 additions & 0 deletions packages/router-ssr-query-core/tests/stream-close.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { QueryClient, hydrate } from '@tanstack/query-core'
import { beforeEach, describe, expect, it, vi } from 'vitest'
import { setupCoreRouterSsrQueryIntegration } from '../src'

vi.mock('@tanstack/query-core', async (importOriginal) => {
const actual = await importOriginal<typeof import('@tanstack/query-core')>()
return { ...actual, hydrate: vi.fn(actual.hydrate) }
})

describe('setupCoreRouterSsrQueryIntegration', () => {
beforeEach(() => {
vi.mocked(hydrate).mockClear()
})

it('does not hydrate once the query stream is closed', async () => {
const queryClient = new QueryClient()
const router = { isServer: false, options: {} } as {
isServer: boolean
options: { hydrate?: (dehydrated: any) => unknown | Promise<unknown> }
}

setupCoreRouterSsrQueryIntegration({ router: router as any, queryClient })

const stream = new ReadableStream({
start(controller) {
controller.enqueue({ mutations: [], queries: [] })
controller.close()
},
})

await router.options.hydrate?.({ queryStream: stream })
await vi.waitFor(() => expect(hydrate).toHaveBeenCalled())

expect(
vi.mocked(hydrate).mock.calls.some(([, state]) => state === undefined),
).toBe(false)
})
})