Core: Don't shadow the window global variable #14472
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
This snippet:
```
import { window } from 'global';
```
will let you mock window variables in Jest tests.
However, it breaks hot module reloading in Vite,
because Vite injects code snippets in top of every
file:
```
window.STUFF = 'Vite injected some HMR code here';
import { window } from 'global';
// this fails: Uncaught ReferenceError: Cannot access 'window' before initialization
```
The simple solution is to rename `window` when importing it:
```
import { window as globalWindow } from 'global';
globalWindow.alert('hello world');
```
The code works like before, but Vite will be able to
inject its code snippet without interfering with the
rest of the code.
eirslett
requested review from
alterx,
CodeByAlex,
igor-dv,
jbovenschen,
kazupon,
thani-sh,
ndelangen,
shilman,
theinterned,
thomasbertet,
tmeasday and
usulpro
as code owners
shilman
changed the title
shilman
approved these changes
Apr 10, 2021
shilman
approved these changes
Apr 10, 2021
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.
Issue: Vite's hot module reloading doesn't work properly with the 'global' package
This snippet:
will let you mock window variables in Jest tests.
However, it breaks hot module reloading in Vite,
because Vite injects code snippets in top of every
file:
What I did
The simple solution is to rename
windowwhen importing it:The code works like before, but Vite will be able to
inject its code snippet without interfering with the
rest of the code.
How to test
Run Storybook CI, and check that nothing is broken.
I verified locally that this fixes the Vite HMR bug (but the Vite stuff is going on in branches in forks of Storybook, so it's hard for others to test).