Components: Add eslint to prevent SSR breakage #42248
Merged
Conversation
This file contains 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
|
Size Change: -57 B (0%) Total Size: 1.25 MB
ℹ️ View Unchanged
|
mirka
commented
Jul 7, 2022
Comment on lines
-16
to
-18
| const { clearTimeout, setTimeout } = | ||
| typeof window !== 'undefined' ? window : {}; | ||
|
|
There was a problem hiding this comment.
Not that this way is incorrect, but it is harder to programmatically check for safety (plus the timeout functions become an any type in TS).
p-jackson
approved these changes
Jul 7, 2022
There was a problem hiding this comment.
Great to have a lint rule that can prevent this from happening in the future. I've tested that the lint errors appear correctly: they weren't appearing for me in VS Code, but the lint-js command works great:
npm run lint-js packages/components/src/resizable-box/resize-tooltip/utils.ts
It's probably just my editor setup.
I also double-checked that FocalPointPicker, FormTokenField and ResizableBox still work correctly using storybook.
2 tasks
5 tasks
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.
What?
Adds
eslint-plugin-ssr-friendlyto the Components package so we can do some basic checks for unsafe access of DOM globals.Why?
There have been some reports of breakage in SSR environments (#38400), and a sweep of the package codebase surfaced two more instances of unsafe
windowaccess.How?
The eslint plugin isn't perfect, but it will surface the more obvious breakage points, such as accessing DOM globals in module scope, or at the root level of a functional component (i.e. obviously not in a
useEffect).Testing Instructions
npm run lint-js