CLI: Ensure errors with opening the browser are caught#24668
Merged
ndelangen merged 1 commit intostorybookjs:nextfrom Nov 2, 2023
Merged
CLI: Ensure errors with opening the browser are caught#24668ndelangen merged 1 commit intostorybookjs:nextfrom
ndelangen merged 1 commit intostorybookjs:nextfrom
Conversation
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.
Contributor
Author
|
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 |
ndelangen
approved these changes
Nov 2, 2023
26 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
No test cases created for open-in-browser.ts file.
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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/coreteam 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>