Core: Avoid crash when theme contains non-color strings #29063
+235
−106
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 patch fixes runtime crash reported in, * <#28781> * <#25092> This patch skips color modification against theme properties if the property is color and a value is not valid color strings Polished accepts. While this wouldn't be exactly what users would expect, program is usable at least. I've added two public functions `transparentize` and `opacify` to enable internal components to access those wrapped ones. I have not added `@internal` JSDoc tag because: * that JSDoc tag is not common in this codebase, and * users would benefit from this. (I'm not proud of the number of changed files...but this is the minimal atomic change without losing context I can think of)
pocka
changed the title
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 469b9f8. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
30 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings
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.
Closes #28781
Also reported at #25092
Related #10170
What I did
This PR adds safe wrapper for four functions exported by
polished:lightendarkentransparentizeopacify5 years ago, #6939 fixed runtime crashes, which happens when a user provides a non-color string (ones
polisheddoes not support) to theme. Many things changed since then, and nowadays most of the internal components import functions directly frompolishedinstead of the guarded-wrappers. So I suspect this will happen in the future again... a guideline or migration to the CSS custom properties based theming would be necessary in order to prevent the future possible re-regression.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
(I assume Docs Page crashing is not detectable via test runners?)
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
yarn task --task dev --template react-vite/default-tsDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
This PR adds safe wrappers for color manipulation functions from the 'polished' library to prevent crashes when non-color strings or CSS variables are used in themes.
lighten,darken,transparentize, andopacifyincode/core/src/theming/utils.ts@storybook/core/themingcode/core/src/theming/tests/util.test.jsto ensure proper handling of various input typescode/addons/docs/template/stories/docspage/theming.stories.tsto demonstrate CSS variable usage in themes