SWC-6545 pre-work - Upgrade Storybook + expose ability to enable StrictMode #711
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
- Upgrade Storybook to latest version (7.6.15) - Enable React StrictMode in Storybook - Replace deprecated @storybook/addon-styling with @storybook/addon-themes I was trying to upgrade react-query to v5 (SWC-6545) and found that our Challenge Portal components relied on features that were removed from react-query (e.g. onSuccess/onSettled callbacks for useQuery). The features were removed because they were often used improperly, leading to bugs. The Challenge Portal components indeed used these callbacks improperly, so I was working to fix them and additionally remove unnecessary `useEffect` hooks. To attempt to identify new issues with the effect hooks, I enabled StrictMode. However, StrictMode did not work properly in Storybook, with a fix in v7.6.13 (storybookjs/storybook#22472), so this upgrade is necessary to enable StrictMode.
…storybook/addon-designs
nickgros
changed the title
nickgros
commented
Feb 16, 2024
nickgros
commented
Feb 16, 2024
| ], | ||
|
|
||
| framework: { | ||
| name: '@storybook/react-vite', | ||
| options: { | ||
| strictMode: false, |
There was a problem hiding this comment.
I considered enabling StrictMode by default, but wasn't sure if that might cause problems with stories. Explicitly setting it to false here makes it easy to go in and change it locally when desired. In the future, we can decide to enable it globally.
jay-hodgson
approved these changes
Feb 16, 2024
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.
I was trying to upgrade react-query to v5 (SWC-6545) and found that our Challenge Portal components relied on features that were removed from react-query (e.g. onSuccess/onSettled callbacks for useQuery). The features were removed because they were often used improperly, leading to bugs. The Challenge Portal components indeed used these callbacks improperly, so I was working to fix them and additionally remove unnecessary
useEffecthooks.To attempt to identify new issues with the effect hooks, I enabled StrictMode. However, StrictMode did not work properly in Storybook, with a fix in v7.6.13 (storybookjs/storybook#22472), so this upgrade is necessary to enable StrictMode.