-
Notifications
You must be signed in to change notification settings - Fork 658
perf(useIsMacOS): replace useState+useEffect with useSyncExternalStore #7548
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.
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
hectahertz
merged 2 commits into
main
from
hectahertz/perf-useismacOS-sync-external-store
Feb 18, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@primer/react': patch | ||
| --- | ||
|
|
||
| perf(useIsMacOS): replace useState+useEffect with useSyncExternalStore to eliminate unnecessary re-render |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,30 @@ | ||
| import {isMacOS as ssrUnsafeIsMacOS} from '@primer/behaviors/utils' | ||
| import {useEffect, useState} from 'react' | ||
| import {canUseDOM} from '../utils/environment' | ||
| import {useSyncExternalStore} from 'react' | ||
|
|
||
| // No-op. The platform never changes at runtime, so there is nothing to | ||
| // subscribe to. Hoisted to avoid creating a new function on every call. | ||
| const subscribe = () => () => {} | ||
|
|
||
| // Safe default for SSR since we can't detect the platform on the server. | ||
| const getServerSnapshot = () => false | ||
|
|
||
| /** | ||
| * SSR-safe hook for determining if the current platform is MacOS. When rendering | ||
| * server-side, will default to non-MacOS and then re-render in an effect if the | ||
| * client turns out to be a MacOS device. | ||
| * SSR-safe hook for determining if the current platform is MacOS. | ||
| * | ||
| * Uses `useSyncExternalStore` to read the platform value: | ||
| * | ||
| * - On the **client**, `ssrUnsafeIsMacOS` reads `navigator.userAgent` and | ||
| * returns the real value immediately, with no extra render pass. | ||
| * | ||
| * - On the **server**, returns `false`. During hydration, if the snapshots | ||
| * differ, React handles the mismatch internally in a single synchronous | ||
| * pass, avoiding the layout shift that a deferred `useEffect` + `setState` | ||
| * would cause. | ||
| * | ||
| * Previous implementation used `useState` + `useEffect`, which caused an | ||
| * unconditional second render on every mount (even on the client where the | ||
| * initial value was already correct). | ||
| */ | ||
| export function useIsMacOS() { | ||
| const [isMacOS, setIsMacOS] = useState(() => (canUseDOM ? ssrUnsafeIsMacOS() : false)) | ||
|
|
||
| useEffect(() => { | ||
| // eslint-disable-next-line react-hooks/set-state-in-effect | ||
| setIsMacOS(ssrUnsafeIsMacOS()) | ||
| }, []) | ||
|
|
||
| return isMacOS | ||
| return useSyncExternalStore(subscribe, ssrUnsafeIsMacOS, getServerSnapshot) | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
useIsMacOSis a publicly exported hook and its behavior around SSR/hydration is subtle. There are hook unit tests for other hooks underpackages/react/src/hooks/__tests__, but none for this one—please add a smalluseIsMacOStest that at least verifies SSR defaults tofalse(e.g. viareact-dom/server), and client behavior can be controlled via a mocked@primer/behaviors/utilsimplementation.