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

React-Docgen: Make error-handling more gentle #25055

Merged
merged 4 commits into from
Nov 30, 2023

Conversation

valentinpalkovic
Copy link
Contributor

Closes #25053

What I did

Storybook 7.6, we have replaced the babel-plugin-react-docgen plugin with a custom Webpack5 loader, which works independently of the used compiler (SWC, Babel, ...). The loader throws an Error, though, as soon as a file cannot be processed.

An Error is not thrown anymore but instead log a warning to the user. In --loglevel=debug mode a stack trace should be available to report bug reports for react-docgen.

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!

  1. Clone https://github.com/zooniverse/front-end-monorepo
  2. Checkout dependabot/npm_and_yarn/storybook/react-webpack5-7.6.1
  3. yarn install (Node 20)
  4. Go to packages/lib-classifier and run yarn install
  5. yarn storybook -> it should fail
  6. Precompile preset-react-webpack from the monorepo and swap out the files
  7. A warning should be shown
  8. Start Storybook with yarn storybook loglevel=debug -> Now a stacktrace is shown as well

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>

@valentinpalkovic valentinpalkovic self-assigned this Nov 30, 2023
@valentinpalkovic valentinpalkovic added bug addon: docs builder-webpack5 ci:daily Run the CI jobs that normally run in the daily job. upgrade:7.6 labels Nov 30, 2023
@valentinpalkovic valentinpalkovic merged commit fc6022c into next Nov 30, 2023
102 of 103 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/react-docgen-error-handling branch November 30, 2023 14:29
@valentinpalkovic valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Nov 30, 2023
@github-actions github-actions bot mentioned this pull request Nov 30, 2023
36 tasks
valentinpalkovic added a commit that referenced this pull request Nov 30, 2023
…r-handling

React-Docgen: Make error-handling more gentle
@valentinpalkovic valentinpalkovic mentioned this pull request Nov 30, 2023
4 tasks
@shilman shilman added the patch:done Patch/release PRs already cherry-picked to main/release branch label Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs bug builder-webpack5 ci:daily Run the CI jobs that normally run in the daily job. 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 upgrade:7.6
Projects
None yet
3 participants