Skip to content
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: Fix header for MountMustBeDestructuredError message #28590

Merged
merged 2 commits into from
Jul 17, 2024

Conversation

0916dhkim
Copy link
Contributor

@0916dhkim 0916dhkim commented Jul 13, 2024

Closes #28514

What I did

The preview displaying MountMustBeDestructuredError doesn't have a title on top because showErrorDisplay takes the first line of the error message as header.

showErrorDisplay({ message = '', stack = '' }) {
let header = message;
let detail = stack;
const parts = message.split('\n');
if (parts.length > 1) {
[header] = parts;
detail = parts.slice(1).join('\n').replace(/^\n/, '');
}
document.getElementById('error-message')!.innerHTML = ansiConverter.toHtml(header);
document.getElementById('error-stack')!.innerHTML = ansiConverter.toHtml(detail);
this.showMode(Mode.ERROR);
}

This PR adds a header to the MountMustBeDestructuredError message.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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>

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 76.5 MB 76.5 MB 699 B 1.75 0%
initSize 198 MB 198 MB 1.27 kB -1.08 0%
diffSize 121 MB 121 MB 569 B -1.09 0%
buildSize 7.59 MB 7.59 MB 153 B 6.4 0%
buildSbAddonsSize 1.63 MB 1.63 MB 102 B Infinity 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 2.3 MB 2.3 MB 0 B - 0%
buildSbPreviewSize 349 kB 349 kB 51 B Infinity 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 4.47 MB 4.47 MB 153 B Infinity 0%
buildPreviewSize 3.12 MB 3.12 MB 0 B 0.33 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 20s 7.6s -12s -357ms -0.75 -160.9%
generateTime 25.5s 28.9s 3.4s 3.11 🔺11.8%
initTime 25.7s 27.9s 2.2s 2.7 🔺8%
buildTime 16.2s 14.3s -1s -919ms 0.01 -13.4%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 8.5s 10.2s 1.6s 1.75 🔺16.2%
devManagerResponsive 5.6s 6.4s 764ms 1.96 🔺11.9%
devManagerHeaderVisible 843ms 893ms 50ms 1.63 🔺5.6%
devManagerIndexVisible 884ms 901ms 17ms 1.25 1.9%
devStoryVisibleUncached 1.2s 1.5s 363ms 1.04 22.8%
devStoryVisible 920ms 960ms 40ms 1.82 4.2%
devAutodocsVisible 730ms 846ms 116ms 2.01 🔺13.7%
devMDXVisible 797ms 772ms -25ms 0.49 -3.2%
buildManagerHeaderVisible 783ms 805ms 22ms 0.1 2.7%
buildManagerIndexVisible 786ms 807ms 21ms 0.06 2.6%
buildStoryVisible 836ms 859ms 23ms 0.11 2.7%
buildAutodocsVisible 769ms 704ms -65ms -0.13 -9.2%
buildMDXVisible 673ms 702ms 29ms 0.75 4.1%

Copy link

nx-cloud bot commented Jul 13, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 6899755. 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 target

Sent with 💌 from NxCloud.

@0916dhkim 0916dhkim marked this pull request as ready for review July 15, 2024 19:24
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

  • Added header to MountMustBeDestructuredError message in /code/core/src/preview-errors.ts
  • Ensured error message displays correctly in the preview by meeting showErrorDisplay requirements

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link
Contributor

@kasperpeulen kasperpeulen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@kasperpeulen kasperpeulen added bug ci:normal patch:yes Bugfix & documentation PR that need to be picked to main branch labels Jul 16, 2024
@kasperpeulen kasperpeulen merged commit 0b54024 into storybookjs:next Jul 17, 2024
44 of 47 checks passed
storybook-bot pushed a commit that referenced this pull request Jul 17, 2024
Fix: Add header for MountMustBeDestructuredError message
(cherry picked from commit 0b54024)
storybook-bot pushed a commit that referenced this pull request Jul 18, 2024
Fix: Add header for MountMustBeDestructuredError message
(cherry picked from commit 0b54024)
storybook-bot pushed a commit that referenced this pull request Jul 19, 2024
Fix: Add header for MountMustBeDestructuredError message
(cherry picked from commit 0b54024)
storybook-bot pushed a commit that referenced this pull request Jul 19, 2024
Fix: Add header for MountMustBeDestructuredError message
(cherry picked from commit 0b54024)
@shilman shilman changed the title Fix: Add header for MountMustBeDestructuredError message Core: Fix header for MountMustBeDestructuredError message Jul 19, 2024
storybook-bot pushed a commit that referenced this pull request Jul 19, 2024
Fix: Add header for MountMustBeDestructuredError message
(cherry picked from commit 0b54024)
storybook-bot pushed a commit that referenced this pull request Jul 19, 2024
Fix: Add header for MountMustBeDestructuredError message
(cherry picked from commit 0b54024)
storybook-bot pushed a commit that referenced this pull request Jul 19, 2024
Fix: Add header for MountMustBeDestructuredError message
(cherry picked from commit 0b54024)
storybook-bot pushed a commit that referenced this pull request Jul 19, 2024
Fix: Add header for MountMustBeDestructuredError message
(cherry picked from commit 0b54024)
storybook-bot pushed a commit that referenced this pull request Jul 19, 2024
Fix: Add header for MountMustBeDestructuredError message
(cherry picked from commit 0b54024)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Bug]: Error title is lost when a preview error is shown
2 participants