Repository navigation
[release/13.4] Validate playwrightCliVersion shape with strict SemVer - #18205
Merged
Jose Perez Rodriguez (joperezr) merged 1 commit intoJun 16, 2026
Conversation
The playwrightCliVersion configuration value is forwarded to npm as the package version specifier. Previously any non-empty string would be passed through, so a typo or unsupported shape (a range, an npm dist-tag like 'latest', a v-prefixed version, etc.) would surface as a generic 'failed to resolve' error from npm. Validate the override with SemVersion.TryParse using SemVersionStyles.Strict and fail fast with a clear message that names the configuration key and the offending value when it is not a valid SemVer 2.0 version. Co-authored-by: Copilot <[email protected]>
Mitch Denny (mitchdenny)
requested review from
James Newton-King (JamesNK) and
David Fowler (davidfowl)
as code owners
June 15, 2026 03:13
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 18205Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 18205" |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds strict SemVer 2.0 validation for the playwrightCliVersion configuration override in the Playwright CLI installer. Previously, any string (including npm ranges like >=0.2.0, dist-tags like latest, or malformed values) could be passed through to npm. Now, the installer validates the override is a well-formed MAJOR.MINOR.PATCH version before forwarding it, returning a clear error message on failure.
Changes:
- Adds
SemVersion.TryParsevalidation withSemVersionStyles.Strictbefore accepting a version override, with an early-return failure path and descriptive error message. - Adds a localized resource string (
PlaywrightCliInstaller_InvalidVersionOverride) across the.resxand all 11.xlffiles. - Adds a
[Theory]test with 5 invalid version variants verifying the installer returnsFailedstatus without calling npm.
Show a summary per file
| File | Description |
|---|---|
| src/Aspire.Cli/Agents/Playwright/PlaywrightCliInstaller.cs | Adds strict SemVer validation guard before using the version override |
| tests/Aspire.Cli.Tests/Agents/PlaywrightCliInstallerTests.cs | Adds parameterized test covering invalid version override values |
| src/Aspire.Cli/Resources/AgentCommandStrings.resx | Adds new resource string for invalid version error |
| src/Aspire.Cli/Resources/AgentCommandStrings.Designer.cs | Auto-generated property for the new resource string |
| src/Aspire.Cli/Resources/xlf/AgentCommandStrings.*.xlf (11 files) | Localization entries for the new error message |
Copilot's findings
Files not reviewed (1)
- src/Aspire.Cli/Resources/AgentCommandStrings.Designer.cs: Generated file
- Files reviewed: 16/17 changed files
- Comments generated: 0
Contributor
|
❓ CLI E2E Tests unknown — 112 passed, 0 failed, 2 unknown (commit View all recordings
📹 Recordings uploaded automatically from CI run #27521770478 |
James Newton-King (JamesNK)
approved these changes
Jun 15, 2026
Ankit Jain (radical)
changed the title
Jose Perez Rodriguez (joperezr)
merged commit Jun 16, 2026
60f48b4
into
release/13.4
315 checks passed
Jose Perez Rodriguez (joperezr)
deleted the
mitchdenny/validate-playwright-cli-version-release-13.4
branch
June 16, 2026 18:21
aspire-repo-bot Bot
added a commit
to microsoft/aspire.dev
that referenced
this pull request
Jun 16, 2026
Document the playwrightCliVersion configuration setting and its strict SemVer 2.0 requirement, introduced in microsoft/aspire#18205. The Playwright CLI installer now validates that playwrightCliVersion contains a MAJOR.MINOR.PATCH version string before forwarding it to npm. Dist-tags (latest), ranges (>=1.0.0), and v-prefixed forms (v1.52.0) are all rejected with a descriptive error message. Add a 'Pin the Playwright CLI version' section to aspire-skills.mdx covering the configuration key, valid format, and the new error message users may see if their config value does not pass validation. Co-authored-by: Copilot <[email protected]>
Contributor
|
Pull request created: #1265
|
Contributor
|
📝 Documentation has been drafted in microsoft/aspire.dev#1265 targeting Added a new "Pin the Playwright CLI version" section to Note This draft PR needs human review before merging. |
This was referenced Jun 17, 2026
This was referenced Jul 13, 2026
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Backport of the internal fix for strict SemVer validation of playwrightCliVersion.