fix: make Notie SSR-safe (renderToString works in Node)#54
Closed
branyang02 wants to merge 1 commit into
Closed
Conversation
The execute-code-block render path called navigator.platform unconditionally during render, which throws when consumers run renderToString in Node. Move the platform detection into a state + useEffect pattern so SSR returns the default (Ctrl) icon and the client switches to (Cmd) after mount. Adds a vitest-based SSR test that renders sample markdown (math, code, headings, blockquotes) plus an `execute-python` block through renderToString, guarding against future regressions of this kind. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
Why
Consumers that want to pre-render notie pages at build time (static-site generation, vite-ssr, Next.js, Astro, etc.) can't currently do so because of the `navigator` access. With this change, `renderToString()` succeeds in pure Node — confirmed by the new test.
I verified the regression: reverting just the `CodeBlock` change while keeping the new test causes test #7 ("renders a markdown containing an execute-* block without throwing") to fail with the exact `navigator.platform` stack trace at `CodeBlock.tsx:187`. With the fix applied all 8 tests pass.
The audit also covered every other `document`/`window`/`navigator` reference in `src/` — they were all already inside `useEffect` callbacks or event handlers, which don't run during SSR. `StaticCodeBlock`'s async shiki upgrade is also safe: its `useState` initial value (escaped `