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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI: Ensure errors with opening the browser are caught #24668

Merged
merged 1 commit into from
Nov 2, 2023

Conversation

xueyawei
Copy link
Contributor

@xueyawei xueyawei commented Nov 2, 2023

What I did

If user default browser is Chrome or Chromium, then cli will use better-opn to open browser, but this command may facing error and not been captured, then it will block the whole start process.

Solution:
add await to betterOpn in order to catch error in betterOpn, otherwise it will be a unhandled promise error.

  • Add await to betterOpn to catch unhandled promise 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

No test cases created for open-in-browser.ts file.

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>

f user default browser is Chrome or Chromium, then cli will use better-opn to open browser, but this command may facing error and not been captured, then it will block the whole start process.

Solution:
add await to betterOpn in order to catch error in betterOpn, otherwise it will be a unhandled promise error.
@xueyawei xueyawei marked this pull request as ready for review November 2, 2023 07:40
@xueyawei
Copy link
Contributor Author

xueyawei commented Nov 2, 2023

Facing this issue in my corporate pc, we are using win32 system and don't have access to powershell due to corporate policy. Inside better-opn, it will use powershell to execute open command, then there will be a permission error thrown and then block the process. Should add await or Promise.catch to catch the error

Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

Thanks for this!

@JReinhold JReinhold self-assigned this Nov 2, 2023
@JReinhold JReinhold changed the title CLI Bug: open browser in CLI block start process CLI: Ensure errors with opening the browser are caught Nov 2, 2023
@ndelangen ndelangen merged commit 5403dc8 into storybookjs:next Nov 2, 2023
54 of 62 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.

None yet

3 participants