router-ssr-query-core: reader.releaseLock() can deadlock WebKit's GC after hydration

Aperta
#8,795 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@EmilEinarsen ci sta già lavorando.

Dal 23/10/2026.

  • #8796 di @EmilEinarsen — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
playwright, react, typescript
Ambito
backend, testing

Direzione di ricerca

Start at packages/router-ssr-query-core/src/index.ts, especially the reader cleanup around lines 244–260, and review the standalone WebKit reproducer in the issue. Check how the stream reader is used after the loop and run the reproducer with Playwright WebKit on Linux. Done means hydration no longer freezes and the reproducer completes without a freeze; linked PR #8796 is already open.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

information needed
Which project does this relate to?

Start

Describe the bug

In Playwright's WebKit on Linux, a page using @tanstack/react-router-ssr-query can freeze for good right after load. The main thread never comes back.

Stall dumps put the WebKit web process main thread in a garbage collection, waiting on a lock nobody else holds:

Heap::collectInMutatorThread
  -> marking constraint
  -> JSReadableStreamDefaultReaderOwner::isReachableFromOpaqueRoots
  -> Lock::lockSlow

WebKit's native ReadableStreamDefaultReader.releaseLock() runs stream JavaScript while it holds the reader's lock. If a GC starts there, the marking constraint tries to take the same lock and the page deadlocks.

router-ssr-query-core calls reader.releaseLock() in a finally when the dehydrated query stream ends, which is just after load:

https://github.com/TanStack/router/blob/6b9fe6d29552270836c511bc9b343d73541f4424/packages/router-ssr-query-core/src/index.ts#L244-L260

Numbers:

  • Bare-page probe in Playwright's WebKit (script below): 7 of 120 rounds froze with releaseLock(), 0 of 120 without it.
  • Our app's Playwright suite: 3 fixture timeouts in 400 walks before patching, 0 in 1,200 walks after dropping the releaseLock() call.

I don't know whether Safari itself is affected. I have only seen it in Playwright's WebKit build on Linux.

Complete minimal reproducer

No app reproducer. The standalone script below reproduces the WebKit side without TanStack. It does what router-ssr-query-core does (read a stream to the end, then releaseLock()) under allocation pressure.

webkit-release-lock.ts (Linux, node webkit-release-lock.ts, Node 24, @playwright/test 1.62.0)
import { webkit } from '@playwright/test'

const RELEASED_ROUND_LIMIT = 360
const DROPPED_ROUND_COUNT = 120
const STREAMS_PER_ROUND = 200
const ROUND_DEADLINE_MS = 20_000

const browser = await webkit.launch()
let releasedWalk: RoundWalk
let droppedWalk: RoundWalk

try {
	releasedWalk = await walkRounds('released')
	droppedWalk = await walkRounds('dropped')
} finally {
	await browser.close()
}

console.table({ 'reader released': releasedWalk, 'reader dropped': droppedWalk })

console.log(JSON.stringify({ webkit: browser.version(), arch: process.arch }))

if (releasedWalk.frozenRoundCount === 0 || droppedWalk.frozenRoundCount > 0) process.exitCode = 1

type ReaderEnd = 'released' | 'dropped'

type RoundWalk = { roundCount: number; frozenRoundCount: number }

async function walkRounds(readerEnd: ReaderEnd): Promise<RoundWalk> {
	const roundLimit = readerEnd === 'released' ? RELEASED_ROUND_LIMIT : DROPPED_ROUND_COUNT
	let frozenRoundCount = 0

	for (let roundNumber = 1; roundNumber <= roundLimit; roundNumber++) {
		const roundContext = await browser.newContext()

		try {
			const probePage = await roundContext.newPage()
			await probePage.goto('data:text/html,<p>release-lock probe</p>')

			const isFrozen = await Promise.race([
				probePage
					.evaluate(readStreamsUnderCollection, { readerEnd, streamCount: STREAMS_PER_ROUND })
					.then(() => false),
				new Promise<boolean>((resolve) => setTimeout(() => resolve(true), ROUND_DEADLINE_MS)),
			])

			if (isFrozen) frozenRoundCount++
		} finally {
			await roundContext.close().catch(() => {})
		}

		if (readerEnd === 'released' && frozenRoundCount > 0)
			return { roundCount: roundNumber, frozenRoundCount }
	}

	return { roundCount: roundLimit, frozenRoundCount }
}

async function readStreamsUnderCollection({
	readerEnd,
	streamCount,
}: {
	readerEnd: ReaderEnd
	streamCount: number
}) {
	let garbageObjects: Array<{ index: number; pair: number[]; text: string }> = []

	function allocateGarbage(objectCount: number) {
		for (let objectIndex = 0; objectIndex < objectCount; objectIndex++)
			garbageObjects.push({
				index: objectIndex,
				pair: [objectIndex, objectIndex + 1],
				text: `g${objectIndex}${Math.random()}`,
			})

		if (garbageObjects.length > 300_000) garbageObjects = []
	}

	async function drainChunks(chunkReader: ReadableStreamDefaultReader<{ chunk: number }>) {
		try {
			for (;;) {
				const { done } = await chunkReader.read()

				if (done) return
				allocateGarbage(500)
			}
		} finally {
			if (readerEnd === 'released') chunkReader.releaseLock()
		}
	}

	const allocationTimer = setInterval(() => allocateGarbage(20_000), 1)

	try {
		for (let streamIndex = 0; streamIndex < streamCount; streamIndex++) {
			let streamController: ReadableStreamDefaultController<{ chunk: number }> | undefined

			const chunkStream = new ReadableStream<{ chunk: number }>({
				start(controller) {
					streamController = controller
				},
			})

			const chunkDrain = drainChunks(chunkStream.getReader())

			for (let chunkIndex = 0; chunkIndex < 10; chunkIndex++) {
				streamController?.enqueue({ chunk: chunkIndex })

				if (chunkIndex % 3 === 0) await new Promise((resolve) => setTimeout(resolve, 0))
			}

			streamController?.close()
			await chunkDrain
		}
	} finally {
		clearInterval(allocationTimer)
	}
}
Steps to Reproduce the Bug
  1. On Linux, install @playwright/test 1.62.0 and its WebKit (npx playwright install webkit).
  2. Run node webkit-release-lock.ts.
  3. The "reader released" walk freezes a round (20 s deadline) within a few hundred rounds. The "reader dropped" walk never freezes.
Expected behavior

Hydration finishes and the page stays responsive. Instead, the page sometimes freezes for good right after load.

Platform
  • @tanstack/router-ssr-query-core 1.169.3 (via @tanstack/react-router-ssr-query 1.167.3, @tanstack/react-start 1.169.2, @tanstack/react-router 1.170.44)
  • OS: Linux (GitHub Actions runners)
  • Browser: Playwright WebKit from @playwright/test 1.62.0
  • Bundler: Vite 8.2.4
Additional context

Proposed fix: drop the finally { reader.releaseLock() }. Once the loop exits the stream has ended (or the reader has been cancelled), and nothing else reads it, so the lock does not need releasing. We ship this as a pnpm patch and will open a PR.

The WebKit deadlock itself is a WebKit bug. Removing the call avoids it until WebKit fixes it.

Drafted with AI assistance.

Lingua principale
TypeScript
Stelle
15.3k
Fork
1.9k
Merge medio
1g 5h
PR unite (30g)
46

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TanStack/router

Tutte le issue di TanStack/router

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.