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

Angular: Enhance Error Handling and Entry Normalization #28217

Merged
merged 8 commits into from
Jul 3, 2024

Conversation

superhermione
Copy link
Contributor

@superhermione superhermione commented Jun 12, 2024

Closes #27367

What I did

Description:
This PR introduces several key enhancements to the StorybookNormalizeAngularEntryPlugin to improve its reliability and maintainability within Storybook projects using Angular. The changes focus on robust error handling, support for asynchronous entry configurations, and a streamlined process for merging main and styles entry points to prevent multiple runtime bundles.

Changes:
Error Handling: Added try-catch blocks to capture and log errors when executing entry functions. This ensures that exceptions are handled gracefully and do not disrupt the Webpack build process.
Asynchronous Support: Modified the entry configuration handling to support asynchronous functions by awaiting their results, accommodating configurations that return promises.
Entry Merging: Refined the merging logic for main and styles entries to ensure that only one runtime bundle is generated, preventing the webpack_require.nmd is not a function error.

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 the Repository:
    Clone the repository and switch to the branch containing the changes.

  2. Install Dependencies:
    Install the necessary dependencies for the project.

  3. Build the Project:
    Build the project to ensure that the changes integrate correctly.

  4. Run Automated Tests:
    Execute existing automated tests to ensure no existing functionality is broken.

Documentation

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

Checklist for Maintainers

  • [ x] 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

  • [x ] Make sure this PR contains one of the labels below:

    Available labels - `cleanup`: Minor cleanup style change. Will not show up in release changelog.

🦋 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>

Copy link

nx-cloud bot commented Jun 12, 2024

☁️ Nx Cloud Report

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

@jonniebigodes jonniebigodes self-assigned this Jun 13, 2024
@jonniebigodes jonniebigodes added ci: do not merge documentation angular ci:docs Run the CI jobs for documentation checks only. labels Jun 13, 2024
@jonniebigodes
Copy link
Contributor

@superhermione, thanks for taking the time to put this pull request together. We appreciate it 🙏 ! Regarding the documentation changes, I'll take a look at it later, as we're on a documentation freeze period. Once that's lifted, I'll be more than glad to follow up with you on it. Sounds good?

Looking forward to hearing from you.

Have a great day.

Stay safe

@valentinpalkovic, I've added the ci do not merge label to this so that we don't accidentally merge it based on what I mentioned regarding the documentation freeze, but feel free to review it from a code standpoint. Will that work for you?

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

  • Enhanced error handling with try-catch blocks
  • Added support for asynchronous entry configurations
  • Streamlined merging of main and styles entry points
  • Prevented generation of multiple runtime bundles

File: code/frameworks/angular/src/server/plugins/storybook-normalize-angular-entry-plugin.js

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

Copy link
Contributor

@valentinpalkovic valentinpalkovic left a comment

Choose a reason for hiding this comment

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

LGTM!

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

(updates since last review)

  • Improved error handling with try-catch blocks
  • Added support for asynchronous entry configurations
  • Refined merging logic for main and styles entries
  • Ensured single runtime bundle generation
  • Addressed __webpack_require__.nmd is not a function error

File: code/frameworks/angular/src/server/plugins/storybook-normalize-angular-entry-plugin.js

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

@valentinpalkovic valentinpalkovic added ci:normal and removed ci:docs Run the CI jobs for documentation checks only. labels Jul 3, 2024
@valentinpalkovic valentinpalkovic changed the title Enhance Error Handling and Entry Normalization in StorybookNormalizeAngularEntryPlugin Angular: Enhance Error Handling and Entry Normalization Jul 3, 2024
@valentinpalkovic valentinpalkovic merged commit 30fd8df into storybookjs:next Jul 3, 2024
56 of 59 checks passed
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.

[Bug]: Inconsistent Error Handling and Promise Management in Storybook Normalize Angular Entry Plugin
3 participants