Skip to content

fix(jsx): Fix "Invalid state: Controller is already closed" #4770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yusukebe merged 3 commits into from
Mar 4, 2026
+117 −3
Merged

fix(jsx): Fix "Invalid state: Controller is already closed" #4770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
415da59
Add failing test cases for Invalid state: Controller is already closed
gaearon Feb 25, 2026
4e031a4
Fix the crashes
gaearon Feb 25, 2026
63d908f
refactored
yusukebe Mar 4, 2026
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
104 changes: 104 additions & 0 deletions src/jsx/streaming.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -881,4 +881,108 @@ d.replaceWith(c.content)
)
})
})

it('should not throw ERR_INVALID_STATE when reader is cancelled during nested Suspense streaming', async () => {
const unhandled: unknown[] = []
const onRejection = (e: unknown) => unhandled.push(e)
process.on('unhandledRejection', onRejection)

const SubContent = async () => <h2>World</h2>
const Content = async () => (
<>
<h1>Hello</h1>
<Suspense fallback={<p>Loading sub...</p>}>
<SubContent />
</Suspense>
</>
)

const onError = vi.fn()
const stream = renderToReadableStream(
<Suspense fallback={<p>Loading...</p>}>
<Content />
</Suspense>,
onError
)

const reader = stream.getReader()
const firstChunk = await reader.read()
expect(firstChunk.done).toBe(false)

// Simulate client disconnect
await reader.cancel()

// Wait for nested Suspense callbacks to fire against the closed controller
await new Promise((resolve) => setTimeout(resolve))

expect(unhandled).toHaveLength(0)
expect(onError).not.toHaveBeenCalled()

process.off('unhandledRejection', onRejection)
})

it('should not call onError when reader is cancelled during a slow callback resolution', async () => {
const unhandled: unknown[] = []
const onRejection = (e: unknown) => unhandled.push(e)
process.on('unhandledRejection', onRejection)

let signalCallbackStarted!: () => void
const callbackStarted = new Promise<void>((r) => {
signalCallbackStarted = r
})

const Content = async () =>
raw('<p>content</p>', [
((opts: any) => {
if (opts.phase === HtmlEscapedCallbackPhase.BeforeStream) {
signalCallbackStarted()
return new Promise<string>((r) => setTimeout(() => r('')))
}
return undefined
}) as any,
])

const onError = vi.fn()
const stream = renderToReadableStream(
<Suspense fallback={<p>Loading...</p>}>
<Content />
</Suspense>,
onError
)

const reader = stream.getReader()
await reader.read()

await callbackStarted
await reader.cancel()

await new Promise((resolve) => setTimeout(resolve))

expect(unhandled).toHaveLength(0)
expect(onError).not.toHaveBeenCalled()

process.off('unhandledRejection', onRejection)
})

it('should not throw when cancelled before initial content resolves', async () => {
const unhandled: unknown[] = []
const onRejection = (e: unknown) => unhandled.push(e)
process.on('unhandledRejection', onRejection)

const onError = vi.fn()
const stream = renderToReadableStream(
Promise.resolve(raw('<p>slow content</p>') as HtmlEscapedString),
onError
)

const reader = stream.getReader()
await reader.cancel()

await new Promise((resolve) => setTimeout(resolve))

expect(unhandled).toHaveLength(0)
expect(onError).not.toHaveBeenCalled()

process.off('unhandledRejection', onRejection)
})
})
16 changes: 13 additions & 3 deletions src/jsx/streaming.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ export const renderToReadableStream = (
content: HtmlEscapedString | JSXNode | Promise<HtmlEscapedString>,
onError: (e: unknown) => string | void = console.trace
): ReadableStream<Uint8Array> => {
let cancelled = false
const reader = new ReadableStream<Uint8Array>({
async start(controller) {
try {
Expand All @@ -157,7 +158,9 @@ export const renderToReadableStream = (
true,
context
)
controller.enqueue(textEncoder.encode(resolved))
if (!cancelled) {
controller.enqueue(textEncoder.encode(resolved))
}

let resolvedCount = 0
const callbacks: Promise<void>[] = []
Expand All @@ -182,7 +185,9 @@ export const renderToReadableStream = (
.filter<Promise<string>>(Boolean as any)
.forEach(then)
resolvedCount++
controller.enqueue(textEncoder.encode(res))
if (!cancelled) {
controller.enqueue(textEncoder.encode(res))
}
})
)
}
Expand All @@ -199,7 +204,12 @@ export const renderToReadableStream = (
onError(e)
}

controller.close()
if (!cancelled) {
controller.close()
}
},
cancel() {
cancelled = true
},
})
return reader
Expand Down
Loading