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

Builder-Webpack5: Categorize builder error #24031

Merged
merged 5 commits into from Sep 4, 2023
Merged

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Aug 31, 2023

Closes #24030

What I did

Webpack builder errors before were just an object with a compilation property.
This PR revamps both the start and build processes in the Webpack5 builder, adding categorized Webpack errors, turning Webpack compilation errors into a single, composite error.

Turns out there was a bug since Storybook 7 where, if you have Storybook successfully running on dev mode, but then introduce a compilation error, e.g. change the code in Button.js to have incorrect syntax like conzt foo instead of const foo, the error would not be propagated to the terminal anymore. This was the case in Storybook 6.5, and it stopped working because of changes in the webpack-dev-middleware library. This PR brings that behavior back.

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!

Please check unit tests

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 pull request has been released as version 0.0.0-pr-24031-sha-553789e8. Install it by pinning all your Storybook dependencies to that version.

More information
Published version 0.0.0-pr-24031-sha-553789e8
Triggered by @yannbf
Repository storybookjs/storybook
Branch yann/webpack-builder-error
Commit 553789e8
Datetime Sun Sep 3 21:15:01 UTC 2023 (1693775701)
Workflow run 6066789759

To request a new release of this pull request, mention the @storybookjs/core team.

core team members can create a new canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=24031

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Nice one! 💪

code/lib/core-events/src/errors/server-errors.test.ts Outdated Show resolved Hide resolved
Copy link
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

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

LGTM!

Base automatically changed from yann/sanitize-errors-more to next September 4, 2023 07:12
@yannbf yannbf changed the title Builder-Webpack5: categorize builder error Builder-Webpack5: Categorize builder error Sep 4, 2023
@ndelangen ndelangen merged commit 43f4345 into next Sep 4, 2023
53 checks passed
@ndelangen ndelangen deleted the yann/webpack-builder-error branch September 4, 2023 08:23
@github-actions github-actions bot mentioned this pull request Sep 4, 2023
25 tasks
@yannbf yannbf mentioned this pull request Oct 17, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

categorize webpack builder errors
4 participants