Use display name without DCP suffix in resource command error messages#16148
Merged
Use display name without DCP suffix in resource command error messages#16148
Conversation
JamesNK
requested review from
danegsta,
davidfowl,
karolz-ms and
mitchdenny
as code owners
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 16148Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 16148" |
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR updates resource command error messages to use the resource’s display name for single-instance resources, while keeping full DCP resource IDs for replica scenarios to avoid ambiguity.
Changes:
- Added
IResource.GetResolvedDisplayResourceName(resourceId)to choose display name vs. full resource ID based on replica count. - Updated
ResourceCommandService.ExecuteCommandCoreAsyncto use the resolved display name in the “command not available” error message. - Renamed an existing helper method in
CommandsConfigurationExtensionsand added tests for single-instance vs replica message formatting.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| tests/Aspire.Hosting.Tests/ResourceCommandServiceTests.cs | Adds tests asserting error message formatting for single-instance vs replica resources. |
| src/Aspire.Hosting/ApplicationModel/ResourceExtensions.cs | Introduces GetResolvedDisplayResourceName utility for display name vs instance ID selection. |
| src/Aspire.Hosting/ApplicationModel/ResourceCommandService.cs | Switches the “command not available” message to use the resolved display/instance name. |
| src/Aspire.Hosting/ApplicationModel/CommandsConfigurationExtensions.cs | Renames helper used in lifecycle command success messages to distinguish from the new extension method. |
src/Aspire.Hosting/ApplicationModel/CommandsConfigurationExtensions.cs
Outdated
Show resolved
Hide resolved
src/Aspire.Hosting/ApplicationModel/CommandsConfigurationExtensions.cs
Outdated
Show resolved
Hide resolved
src/Aspire.Hosting/ApplicationModel/CommandsConfigurationExtensions.cs
Outdated
Show resolved
Hide resolved
src/Aspire.Hosting/ApplicationModel/CommandsConfigurationExtensions.cs
Outdated
Show resolved
Hide resolved
src/Aspire.Hosting/ApplicationModel/CommandsConfigurationExtensions.cs
Outdated
Show resolved
Hide resolved
JamesNK
added
the
area-app-model
Contributor
|
Re-running the failed jobs in the CI workflow for this pull request because 1 job was identified as retry-safe transient failures in the CI run attempt.
|
karolz-ms
approved these changes
Apr 14, 2026
src/Aspire.Hosting/ApplicationModel/CommandsConfigurationExtensions.cs
Outdated
Show resolved
Hide resolved
16 tasks
davidfowl
approved these changes
Apr 15, 2026
Add GetResolvedDisplayResourceName extension method to return the resource display name for single-instance resources and the full DCP resource ID for resources with replicas. Use it in ResourceCommandService error messages and rename the existing helper in CommandsConfigurationExtensions to GetResolvedDcpResouceName.
…isplayResourceName
JamesNK
force-pushed
the
jamesnk/resource-command-display-name
branch
from
59e78c0 to
bee48dd
Compare
Contributor
|
🎬 CLI E2E Test Recordings — 69 recordings uploaded (commit View recordings
📹 Recordings uploaded automatically from CI run #24443212932 |
Contributor
|
No documentation PR is required for this change. This is a bug fix to error message formatting — replacing the internal DCP resource ID suffix (e.g.,
|
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
Resource command error messages previously included the full DCP resource ID (e.g.,
cache-abcdwxyz) even for single-instance resources. This is confusing because users know the resource by its display name (cache).This PR:
GetResolvedDisplayResourceNameextension method onIResourcethat returns the display name for single-instance resources and the full DCP resource ID for resources with replicas.ResourceCommandService.ExecuteCommandCoreAsyncfor the "command not available" error message.CommandsConfigurationExtensionstoGetResolvedDcpResouceNameto distinguish it from the new method.Before:
After:
Checklist