Vitest addon: Handle Playwright installation errors gracefully#32329
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit 8fd4a16
☁️ Nx Cloud last updated this comment at |
| args: ['playwright', 'install', 'chromium', '--with-deps'], | ||
| }); | ||
| } catch (e) { | ||
| console.error('Failed to install Playwright. Please install it manually'); |
Contributor
There was a problem hiding this comment.
style: Consider using the existing logger utilities (printError or printWarning) instead of console.error for consistency with the rest of the codebase's logging approach
Suggested change
| console.error('Failed to install Playwright. Please install it manually'); | |
| printError('Failed to install Playwright. Please install it manually'); |
8 tasks
shilman
reviewed
Sep 2, 2025
| args: ['playwright', 'install', 'chromium', '--with-deps'], | ||
| }); | ||
| } catch (e) { | ||
| console.error('Failed to install Playwright. Please install it manually'); |
Member
There was a problem hiding this comment.
Don't we have guidelines for how to log errors now (so that we can swap in clack)? cc @yannbf
shilman
reviewed
Sep 2, 2025
Member
shilman
left a comment
There was a problem hiding this comment.
@ndelangen do we want to patch this back?
Merged
5 tasks
shilman
pushed a commit
that referenced
this pull request
Sep 6, 2025
…ghtinstall-fails AddonVitest: Handle Playwright installation errors gracefully (cherry picked from commit bc6faab)
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.
Closes #32117
What I did
I changed the postinstall to continue (with a warning) when the install of playwright failed
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
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-storybook/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>Greptile Summary
This PR adds graceful error handling to the Playwright installation step in the
@storybook/addon-vitestpostinstall process. The change wraps thenpx playwright install chromium --with-depscommand in a try-catch block, allowing the addon installation to continue even when Playwright installation fails.The modification is minimal and targeted - it only affects the Playwright configuration section of the
postInstallfunction incode/addons/vitest/src/postinstall.ts. When Playwright installation fails (which commonly occurs in restricted environments like StackBlitz or Bolt.new), the error is caught and a user-friendly message is displayed advising manual installation, but the rest of the addon setup process continues normally.This change fits well within the broader postinstall architecture, which already handles various installation scenarios and user prompts. The postinstall function is responsible for setting up multiple components including Vitest dependencies, configuration files, and optional features like the accessibility addon. By making Playwright installation non-blocking, the PR ensures that users can still benefit from the core Vitest addon functionality even in environments where Playwright cannot be automatically installed.
Confidence score: 4/5