Error boundary with a lazy fallback blanks the Suspense boundary when a child throws during hydration (0.3.0)

Aperta
#154 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
56/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
react, typescript

Direzione di ricerca

Start by tracing hydration and Suspense error handling in Redact; the report identifies RenderSuspenseCapture when an error boundary renders a lazy fallback. Reproduce the case with the supplied server and client entries, then compare the DOM and page errors with React. Done means hydration preserves or renders the fallback without an unhandled rejection.

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

Descrizione

Summary

If a component throws during hydration and the error boundary's fallback is a lazy component, Redact empties the enclosing Suspense boundary and reports an unhandled RenderSuspenseCapture. The fallback never appears, even after the lazy component resolves. React keeps the server-rendered content and shows the fallback.

With a synchronous fallback, the same tree works correctly in Redact.

Reproduction

shared.jsx

import { Component, Suspense, lazy } from 'react'

const isServer = typeof document === 'undefined'

class Boundary extends Component {
  state = { error: null }
  static getDerivedStateFromError(error) {
    return { error }
  }
  render() {
    return this.state.error ? <LazyFallback /> : this.props.children
  }
}

function Fallback() {
  return <section>something went wrong</section>
}

const LazyFallback = lazy(async () => ({ default: Fallback }))

function Route() {
  if (isServer) return <Fallback />
  throw new Error('boom')
}

export function App() {
  return (
    <main>
      <Suspense fallback={<p>loading</p>}>
        <Boundary>
          <Route />
        </Boundary>
      </Suspense>
    </main>
  )
}

server.jsx

import { renderToString } from 'react-dom/server'
import { App } from './shared.jsx'

export const render = () => renderToString(<App />)

client.jsx

import { hydrateRoot } from 'react-dom/client'
import { App } from './shared.jsx'

hydrateRoot(document.getElementById('root'), <App />)

Build the server and client entries with and without the redact() plugin, put render()'s output in #root, load the client bundle and wait a moment.

Runtime #root after hydration Page errors
React 19.3.1 <main><section>something went wrong</section></main> None
Redact 0.3.0 <main><!--$0--><!--/$--></main> RenderSuspenseCapture (unhandled rejection)
Why this comes up in real apps

Route above copies what TanStack Router's MatchInner does for a route whose loader failed: the server renders the errorComponent directly, and the client throws match.error so the CatchBoundary catches it. When the errorComponent is code-split, the fallback is lazy.

In a TanStack Start app, the server correctly sends the error page with a 500. Hydration then removes it and leaves an empty <main>, so the visitor sees a blank page where the error and its retry action should be. Stopping the router from code-splitting errorComponent avoids the problem.

Possibly related

#137 also involves RenderSuspenseCapture during hydration, but its trigger is different: a boundary suspending again while retrying hydration. Its proposed fix may or may not cover this case, as I have not tested it. #43 changes how errors thrown by a fallback propagate, whereas here the fallback suspends.

Environment
  • @tanstack/redact 0.3.0 (also 0.2.5), default redact() preset
  • React 19.3.1 (control)
  • Vite 7.3.7, @vitejs/plugin-react 5.2.0
  • Chromium 156 (Playwright), Node 26
Lingua principale
TypeScript
Stelle
581
Fork
28
Merge medio
13h 48m
PR unite (30g)
45

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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/redact

Tutte le issue di TanStack/redact

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.