SSR adds px to numeric CSS custom properties, causing a hydration mismatch

Aberta
#177 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
20/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
react, typescript
Domínio
frontend, testing

Direção de pesquisa

Read packages/redact/src/server/escape.ts and the linked test tests/ssr-custom-property-styles.test.tsx; compare how styleToString handles numeric values with how browser rendering treats keys beginning with --. The issue also proposes defaulting root.re in dom/root-internal.ts to reportRecoverableError. Tests already pass with the proposed changes on the linked branch, so check whether that work has been adopted before picking this up.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Bug

During SSR, numeric CSS custom properties get a px unit:

renderToString(<span style={{ '--h': 262 } as React.CSSProperties} />)
// Redact: <span style="--h:262px;"></span>
// React:  <span style="--h:262"></span>

The browser renderer leaves custom properties unitless (--h: 262), so hydrateRoot hits Hydration mismatch on <span> for "style" and client-renders the whole root again.

Version: @tanstack/redact 0.3.1 (also on main at f61f721).

Seen in: a TanStack Start app with product logos styled style={{ '--h': hue }} and color: hsl(var(--h) 45% 50%).

  • 516 of 539 elements on / were recreated after load, and LCP went from ~52 ms to ~108 ms.
  • Until hydration finished, the logos had no colour, because hsl(262px …) is invalid.

Passing the value as a string (String(hue)) avoids it.

Cause: styleToString in packages/redact/src/server/escape.ts applies the numeric px rule to keys starting with -- as well. setStyleProperty in dom/[dom.ts](https://github.com/home/fak3/developer/dom/dom.ts) and React both skip custom properties.

Related: mismatch fallback is silent without onRecoverableError

With no onRecoverableError passed to hydrateRoot, this mismatch produced no console output at all in production; the page just re-rendered. React's default reports these through reportError. Redact already does the same for uncaught render errors (dom/[reconcile.ts](https://github.com/home/fak3/developer/dom/reconcile.ts)), so defaulting root.re to it would make this kind of bug visible. I found this one only by patching the bundle.

Fix

Both changes, with tests and a changeset, are on a branch you're welcome to take:
https://github.com/fakelozic/redact/commit/1ef30f4ed182d0a99f3a62ce01547893f415556c

  • server/escape.ts: keys starting with -- keep their value as written. One-line change.
  • dom/[root-internal.ts](https://github.com/home/fak3/developer/dom/root-internal.ts): re: options.onRecoverableError ?? reportRecoverableError, which uses reportError and falls back to console.error.
  • tests/[ssr-custom-property-styles.test.tsx](https://github.com/home/fak3/developer/tests/ssr-custom-property-styles.test.tsx): the new tests fail on main and pass with the fix.

pnpm test (2131 passed), pnpm test:types and pnpm size:check (Node 24.22.0) all pass. The repo only accepts pull requests from collaborators, so I couldn't open a PR.

Linguagem predominante
TypeScript
Estrelas
581
Forks
28
Merge médio
13h 48min
PRs com merge (30d)
45

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TanStack/redact

Todas as issues de TanStack/redact

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.