Repository navigation
Fix React #418 hydration mismatch in App Provider - #17644
Closed
posthog[bot] wants to merge 1 commit into
Closed
posthog[bot] wants to merge 1 commit into
posthog[bot] wants to merge 1 commit into
Conversation
The App Provider seeded its first-render state from client-only values that don't exist during SSR: `isMobile` from `window.innerWidth`, theme/colorMode from `window.__theme`, and the siteSettings spread from `localStorage`. Because `isMobile || compact` flips `siteSettings.experience` to `'boring'`, the whole app tree hydrated with different markup than the server produced, firing React error #418 at high volume (esp. on mobile, with a flash of the wrong theme/experience). Render the SSR-stable defaults on the first client render and defer the divergent values to a post-mount effect: - `getInitialSiteSettings` gains an `ssr` flag that forces server defaults. - `isMobile`, `siteSettings`, and `windows` initialize to their server values. - A mount effect applies the real viewport/localStorage/__theme values and clears windows for the mobile-homepage and `?windows=` shared-desktop cases. The inline `theme-init.js` script already sets `document.body.className` before React loads, so the visual theme stays correct while React's theme state is deferred. Generated-By: PostHog Code Task-Id: bbff1854-5e3d-4577-bd3b-9505043570b9
Contributor
Deploy preview
|
Contributor
Bundle reportTotal JS (gzip)6.30 MiB (+0.5 KiB / +0.0%) Eager graph (static-import closure per entrypoint)
Largest modules in the
|
| Module | Size |
|---|---|
./node_modules/.pnpm/mapbox-gl@3.16.0/node_modules/mapbox-gl/dist/mapbox-gl.js |
1619.1 KiB |
./src/mdxGlobalComponents.js + 138 modules |
868.2 KiB |
css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css |
710.1 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 KiB |
./node_modules/.pnpm/lottie-web@5.13.0/node_modules/lottie-web/build/player/lottie.js |
610.8 KiB |
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js |
481.4 KiB |
./.cache/caches/gatsby-plugin-mdx/mdx-scopes-dir/31a094f140f119e73085d847ae81b99b.js + 2 modules |
470.3 KiB |
./node_modules/.pnpm/@codemirror+view@6.38.2/node_modules/@codemirror/view/dist/index.js |
458.1 KiB |
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules |
395.1 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.cjs.js |
364.8 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js |
354.8 KiB |
./src/hooks/useCustomers.tsx + 54 modules |
352.3 KiB |
./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules |
351.4 KiB |
./node_modules/.pnpm/jspdf@3.0.2/node_modules/jspdf/dist/jspdf.es.min.js |
334.1 KiB |
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js |
281.9 KiB |
Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes.
Contributor
|
This PR hasn't seen activity in two weeks! Should it be merged, closed, or further worked on? If you want to keep it open, please remove the |
Contributor
|
This PR was closed due to lack of activity. Feel free to reopen if it's still relevant. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Fixes the React #418 hydration mismatch firing at massive scale on posthog.com (the dominant fingerprint alone: 4.58M occurrences / 383K sessions / 234K users in 30 days).
The
Providerinsrc/context/App.tsxinitialized first-render state from client-only values that don't exist during SSR:isMobilefromwindow.innerWidth < 768theme/colorModefromwindow.__themesiteSettingsspread fromlocalStorageBecause
isMobile || compactflipssiteSettings.experienceto'boring', the entire app tree hydrated with different markup than the server produced (which always renders desktop +light+ defaults), triggering #418 — with a user-visible flash of the wrong theme/experience, especially on mobile.This renders the SSR-stable defaults on the first client render and defers the divergent values to a post-mount effect:
getInitialSiteSettingsgains anssrflag that forces server defaults.isMobile,siteSettings, andwindowsinitialize to their server values.localStorage/__themevalues, and clears windows for the mobile-homepage and?windows=shared-desktop cases (preserving existing behavior).The inline
static/scripts/theme-init.jsalready setsdocument.body.classNamebefore React loads, so the visual theme stays correct while React's theme state is deferred — no theme flash is introduced.Why: #418 was firing at enormous volume, degrading first paint and flooding error tracking with noise, all traced to SSR-divergent initial state in the App Provider.
Verification: This is a Gatsby SSR-vs-client hydration mismatch, which only manifests in a production build (
gatsby build && gatsby serve), notgatsby develop(client-only render). Correctness was verified by tracing SSR-vs-first-client-render parity: server and first client render now compute identicalisMobile(false),siteSettings(server defaults,experience: 'posthog'), andwindows(getInitialWindows). A full production-build hydration repro was not run here due to the build's cost (16GB RAM, ~15+ min); reviewers should confirm on the Vercel preview.Checklist
vercel.jsonCreated with PostHog Code from an inbox report.