-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
Core: Make sure StorybookError message shows up in browser console and interactions panel #28464
Conversation
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.
PR Summary
- Updated
TestError
class in/code/core/src/__tests/storybook-error.test.ts
to accept adocumentation
parameter. - Refactored error handling in
/code/core/src/preview-errors.ts
to ensure proper display of error messages in the browser. - Modified
StorybookError
class in/code/core/src/storybook-error.ts
to makecategory
andcode
properties public and refactor error message generation.
3 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 13338a2. 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 1 targetSent with 💌 from NxCloud. |
I believe I made all the necessary changes, but it would be great to test this properly before merging. |
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.
PR Summary
(updates since last review)
- Updated ESLint config in
/code/.eslintrc.js
to enforce unique error codes and ensure local rules execute correctly. - Refactored error classes in
/code/core/src/preview-errors.ts
,/code/core/src/manager-errors.ts
, and/code/core/src/server-errors.ts
to include error messages in the stack trace. - Modified
StorybookError
class in/code/core/src/storybook-error.ts
to usegetFullMessage
for setting error messages. - Updated test cases in
/code/core/src/__tests/preview-errors.test.ts
and/code/core/src/__tests/storybook-error.test.ts
to reflect new error handling format. - Enhanced ESLint rule logic in
/scripts/eslint-plugin-local-rules/no-duplicated-error-codes.js
to conform to new error handling format.
10 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings
}); | ||
|
||
if (categoryProperty && categoryProperty.value.type === 'MemberExpression') { | ||
const categoryName = categoryProperty.value.property.name; | ||
const categoryValue = properties.category.value.property.name; |
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.
🧠 logic: Potential issue if properties.category
or properties.code
is null. Consider adding a null check.
65d45ab
to
a0f8189
Compare
What I did
Makes sure that the message is present in the stack of the built-in Error class in a way that works in all browsers.
Previously, the error structure was working in Safari and Firefox, but for some reason Chromium based browsers didn't have the error message in the stack.
This PR does the following:
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make 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/core
team 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>