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

CLI: Improve error message when fetching CLI version #28289

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Jun 19, 2024

Closes N/A

What I did

This PR brings a new categorized error to the CLI on an error related to #26553 and #27236. Instead of showing the user just

 Unable to find versions of @storybook/cli using NPM

Which could happen for many different reasons:

  • NPM might return a non-successful code in their API
  • The package might not exist
  • an NPM version has a bug
  • our parsing code has a bug

Now they will get a highly described issue like so (example of outdated NPM + 404 status from npm API):
image

or an error in our parsing code:
image

Additionally the error is now categorized in telemetry.

This change is applicable to:

  • storybook init
  • storybook add
  • storybook upgrade

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!
easiest way to test it is via storybook add:

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. Run sb add non-existent-package where sb points to the CLI binary in the monorepo

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>

Copy link

nx-cloud bot commented Jun 19, 2024

☁️ Nx Cloud Report

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

@yannbf yannbf merged commit 4635b61 into next Jun 24, 2024
58 of 65 checks passed
@yannbf yannbf deleted the yann/npm-versions-error-handling branch June 24, 2024 12:24
@valentinpalkovic valentinpalkovic added needs qa Indicates that this needs manual QA during the upcoming minor/major release and removed needs qa Indicates that this needs manual QA during the upcoming minor/major release labels Jul 4, 2024
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.

2 participants