Refuse synthesized 'staging' channel on daily CLI builds#16717
Open
mitchdenny wants to merge 2 commits intomainfrom
Open
Refuse synthesized 'staging' channel on daily CLI builds#16717mitchdenny wants to merge 2 commits intomainfrom
mitchdenny wants to merge 2 commits intomainfrom
Conversation
On a daily Aspire CLI, `aspire update --channel staging` could resolve to daily packages because PackagingService.CreateStagingChannel() either built a per-commit darc-pub feed URL from the daily commit hash (no such feed exists) or fell back to the shared dotnet9 daily feed. Either way the user got daily packages instead of staging packages with no warning. PackagingService now refuses to synthesize the staging channel when the running CLI is itself a daily/CI build (detected via prerelease-identifier count on the assembly informational version) unless the user provides an explicit overrideStagingFeed configuration value. The resolved staging feed URL is also logged at info level so users can verify channel resolution. When the staging channel is omitted on a daily CLI, `aspire update --channel staging` now surfaces an actionable error explaining why and how to recover (set 'overrideStagingFeed' or use a stable CLI build). Fixes #16652 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 16717Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 16717" |
Contributor
There was a problem hiding this comment.
Pull request overview
Prevents aspire update --channel staging from silently resolving to daily packages when the running CLI is itself a daily build. The PR adds staging-unavailable detection in PackagingService, reuses that reason in UpdateCommand, and adds regression tests plus localized resource entries.
Changes:
- Added a new staging-unavailable reason API and daily-build heuristic in
PackagingService. - Updated
UpdateCommandto surface a staging-specific error instead of the generic missing-channel message. - Added regression tests and new packaging resource strings for the user-facing message.
Reviewed changes
Copilot reviewed 19 out of 20 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
tests/Aspire.Cli.Tests/TestServices/TestPackagingService.cs |
Extended test fake to expose staging-unavailable reason. |
tests/Aspire.Cli.Tests/Packaging/PackagingServiceTests.cs |
Added regression coverage for daily/stable/blessed staging resolution cases. |
tests/Aspire.Cli.Tests/Commands/UpdateCommandTests.cs |
Added test for explicit staging error message. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.zh-Hant.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.zh-Hans.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.tr.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.ru.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.pt-BR.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.pl.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.ko.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.ja.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.it.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.fr.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.es.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.de.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/xlf/PackagingStrings.cs.xlf |
Added localized staging-unavailable string entry. |
src/Aspire.Cli/Resources/PackagingStrings.resx |
Added source resource string for staging-unavailable message. |
src/Aspire.Cli/Resources/PackagingStrings.Designer.cs |
Regenerated strongly-typed resource accessor. |
src/Aspire.Cli/Packaging/PackagingService.cs |
Added daily-build gating, test seam, logging, and staging-unavailable reason generation. |
src/Aspire.Cli/Commands/UpdateCommand.cs |
Switched missing-channel message construction to use staging-specific reason. |
Files not reviewed (1)
- src/Aspire.Cli/Resources/PackagingStrings.Designer.cs: Language not supported
Comment on lines
+117
to
+123
| // If the user has supplied an explicit staging feed override they are taking | ||
| // ownership of where staging packages come from, so any CLI build is allowed. | ||
| var hasExplicitFeedOverride = !string.IsNullOrEmpty(configuration["overrideStagingFeed"]); | ||
| if (hasExplicitFeedOverride) | ||
| { | ||
| return null; | ||
| } |
Comment on lines
+193
to
+203
| /// Honors the test-only configuration override so tests can deterministically | ||
| /// simulate stable / blessed-prerelease / daily CLI builds. | ||
| /// </summary> | ||
| private string? GetCliInformationalVersionForStagingDecision() | ||
| { | ||
| var testOverride = configuration[PackagingConfigurationKeys.CliVersionForTesting]; | ||
| if (!string.IsNullOrWhiteSpace(testOverride)) | ||
| { | ||
| return testOverride; | ||
| } | ||
|
|
Comment on lines
+181
to
190
| // CLI logs (suggested-fix option 3 from #16652). | ||
| logger.LogInformation( | ||
| "Resolved 'staging' channel: feed='{StagingFeedUrl}', quality='{Quality}', pinnedVersion='{PinnedVersion}'.", | ||
| stagingFeedUrl, | ||
| stagingQuality, | ||
| pinnedVersion ?? "(none)"); | ||
|
|
||
| return stagingChannel; | ||
| } | ||
|
|
Comment on lines
+285
to
+300
| private string BuildChannelNotFoundMessage(string channelName, IEnumerable<PackageChannel> allChannels) | ||
| { | ||
| // For an explicit `--channel staging` request, surface the staging-specific | ||
| // unavailability reason (issue #16652) instead of the generic "no channel | ||
| // matching" message so users on a daily CLI know why the channel was omitted | ||
| // and how to recover (set 'overrideStagingFeed' or use a stable CLI). | ||
| if (string.Equals(channelName, PackageChannelNames.Staging, StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| var stagingReason = _packagingService.GetStagingChannelUnavailableReason(); | ||
| if (!string.IsNullOrEmpty(stagingReason)) | ||
| { | ||
| return stagingReason; | ||
| } | ||
| } | ||
|
|
||
| return $"No channel found matching '{channelName}'. Valid options are: {string.Join(", ", allChannels.Select(c => c.Name))}"; |
Contributor
|
Re-running the failed jobs in the CI workflow for this pull request because 2 jobs were identified as retry-safe transient failures in the CI run attempt.
|
…nism The 8 pre-existing tests in PackagingServiceTests that exercise the shared-feed and pin-to-CLI-version paths assume the running CLI is not itself a daily/CI build, but they don't pin the version. With this PR's new daily-CLI guard, when CI builds the test assembly with a daily-flavored VersionSuffix (e.g. pr.NNNN.gSHA), the daily heuristic treats the running CLI as daily and GetStagingChannelUnavailableReason hides the staging channel, causing the tests to fail with "Sequence contains no matching element" on .First(c => c.Name == "staging"). Use the existing internal:packaging:cliVersionForTesting test seam to pin a stable CLI version (13.4.0) in those tests so the daily-CLI guard doesn't trigger and the tests deterministically exercise the shared-feed and pinning code paths regardless of the test-assembly's build flavor. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
🎬 CLI E2E Test Recordings — 76 recordings uploaded (commit View all recordings
📹 Recordings uploaded automatically from CI run #25360887354 |
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.
Description
Fixes #16652.
PackagingServicesynthesized thestagingchannel relative to the running CLI build:darc-pub-microsoft-aspire-{currentCliCommitHash}).When the running CLI is itself a daily build, neither produces a real staging feed: there is no SHA-specific darc feed for daily commits, and the shared daily feed contains daily packages. As a result
aspire update --channel stagingsilently resolved to daily versions — the bug tracked by #16652.This PR makes
stagingresolution deterministic on daily CLI builds by refusing to synthesize the channel rather than silently downgrading:IPackagingService.GetStagingChannelUnavailableReason()returns a localized, user-facing explanation when staging cannot be resolved.CreateStagingChannel()consults that helper. If staging is unavailable on a daily CLI it logs a warning and returnsnullinstead of fabricating a daily feed.UpdateCommandsurfaces the same reason in itsChannelNotFoundExceptionmessage when the user explicitly passes--channel staging, so the failure is clear and actionable.CreateStagingChannel()always logs the resolved feed URL + quality + pinned version when it does produce a channel (the "show what was resolved" suggestion from the issue).Escape hatches and unaffected paths:
overrideStagingFeedconfiguration entry continues to take ownership; staging is allowed in that case regardless of CLI build.preview.1,rc.1) continue to produce a real staging channel.preview.1.26210.1) are treated as daily.This is a 💥 blocking-release fix targeting
mainfirst; a backport PR torelease/13.3will follow.Validation
To verify locally, install the CLI from this PR:
Then:
A stable / blessed-preview CLI is unaffected — staging continues to resolve via the SHA-specific darc feed.
Automated coverage
tests/Aspire.Cli.Tests/Packaging/PackagingServiceTests.cs(new file, ~280 lines) covers staging behavior across stable / blessed-preview / daily CLI versions, with and withoutoverrideStagingFeed, including the unparseable-version fail-safe.tests/Aspire.Cli.Tests/Commands/UpdateCommandTests.cscovers--channel stagingsurfacing the staging-specific exception message instead of the generic "no channel matching" message.internal:packaging:cliVersionForTestingconfig key) lets unit tests deterministically simulate stable, blessed-preview, and daily CLI builds without depending on the actualAspire.Cli.dllassembly version. The key is internal/test-only, scoped toPackagingConfigurationKeys, and clearly documented as such.Checklist