Fix aspire wait for JSON-emitted resource names by sebastienros · Pull Request #16224 · microsoft/aspire

sebastienros · 2026-04-16T00:02:54Z

Description

aspire wait was forwarding the user-supplied resource token directly to the AppHost wait RPC. That RPC only accepts the canonical resource Name, which meant the generated name emitted by aspire ps --format json --resources could fail even though the friendly display name worked.

This updates wait to resolve the input against current resource snapshots before invoking the backchannel. Exact canonical names still pass through, unique display names are mapped to the canonical Name, and ambiguous replica display names still fail instead of guessing. The PR also updates the wait help text to say it accepts a resource name or identifier and adds unit coverage for the resolution behavior.

Fixes #15842

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Link to aspire.dev issue:
    - New issue
- No

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-04-16T00:06:52Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 16224

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 16224"

Copilot

Pull request overview

This PR fixes aspire wait so it accepts both canonical resource Name values (as emitted by aspire ps --format json --resources) and unique displayName values, by resolving the user input against the current AppHost resource snapshots before invoking the wait RPC.

Changes:

Resolve the user-supplied resource token to a canonical resource Name using resource snapshots before calling the AppHost wait RPC.
Update wait argument help text to indicate it accepts a resource name or identifier.
Add unit tests covering display-name resolution, canonical-name pass-through, and ambiguous display-name failure.

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/Aspire.Cli/Commands/WaitCommand.cs	Adds snapshot-based resolution from user input to canonical resource name before waiting.
src/Aspire.Cli/Resources/WaitCommandStrings.resx	Updates the resource argument description string to “name or identifier”.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.cs.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.de.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.es.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.fr.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.it.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.ja.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.ko.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.pl.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.pt-BR.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.ru.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.tr.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.zh-Hans.xlf	Updates localized string source/target for the resource argument description.
src/Aspire.Cli/Resources/xlf/WaitCommandStrings.zh-Hant.xlf	Updates localized string source/target for the resource argument description.
tests/Aspire.Cli.Tests/TestServices/TestAppHostAuxiliaryBackchannel.cs	Captures the last wait call inputs for assertions in unit tests.
tests/Aspire.Cli.Tests/Commands/WaitCommandTests.cs	Adds unit tests for display-name resolution, canonical-name pass-through, and ambiguous-name failure.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…re-wait-resource-name

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

JamesNK · 2026-04-16T01:28:43Z

This client-side resolution in WaitCommand is inconsistent with how ResourceCommand handles the same scenario. ResourceCommand passes the raw user-supplied name to ExecuteResourceCommandAsync, which flows to ResourceCommandService.ExecuteCommandAsync → ResourceNotificationService.TryGetCurrentState, where the server resolves display names to canonical names (exact match first, then fallback to Resource.Name when unambiguous).

WaitForResourceAsync on the server side doesn't use TryGetCurrentState — it matches against appModel.Resources using r.Name directly, which is why it needed a fix. But arguably the more consistent fix would be to add the same TryGetCurrentState-style resolution to the server-side WaitForResourceAsync in AuxiliaryBackchannelRpcTarget, rather than adding client-side resolution in the CLI. That would fix it for all callers (not just the CLI) and keep the resolution responsibility in one place.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

JamesNK

I think the wait command should solve this problem the same way the resource command does. The partial resource name should be resolved inside the app host

sebastienros · 2026-04-16T02:40:24Z

This client-side resolution in WaitCommand is inconsistent with how ResourceCommand handles the same scenario. ResourceCommand passes the raw user-supplied name to ExecuteResourceCommandAsync, which flows to ResourceCommandService.ExecuteCommandAsync -> ResourceNotificationService.TryGetCurrentState, where the server resolves display names to canonical names (exact match first, then fallback to Resource.Name when unambiguous).

WaitForResourceAsync on the server side doesn't use TryGetCurrentState - it matches against appModel.Resources using r.Name directly, which is why it needed a fix. But arguably the more consistent fix would be to add the same TryGetCurrentState-style resolution to the server-side WaitForResourceAsync in AuxiliaryBackchannelRpcTarget, rather than adding client-side resolution in the CLI. That would fix it for all callers (not just the CLI) and keep the resolution responsibility in one place.

Addressed in 1378456ab. The backchannel wait path now resolves on the AppHost side by matching both the unique resource id and the logical resource name, and it no longer fails early before the AppHost has published its resources. That keeps the resolution responsibility in one place and fixes the startup race that was still reproducing with the CLI-only approach.

JamesNK · 2026-04-16T02:43:40Z

But I still see resource name resolution logic in WaitCommand...

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

sebastienros · 2026-04-16T03:14:57Z

But I still see resource name resolution logic in WaitCommand...

Fixed in 68c132edb. WaitCommand now forwards the raw user input again. The AppHost backchannel resolves the identifier instead: it uses the current resource state when available, falls back to the app model to map a unique logical resource name to its resolved instance id, and still accepts exact resolved ids. That keeps the resolution behavior in the AppHost and preserves the startup-race fix without keeping snapshot-based resolution in the CLI.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

sebastienros · 2026-04-16T15:40:49Z

Everything is moved to the AuxiliaryBackchannelRpcTarget and uses TryGetCurrentState before checking the app model when there are no snapshots yet.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…re-wait-resource-name

JamesNK

1 issue flagged: misleading error message when resource name is ambiguous (multiple replicas) vs. genuinely not found.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-04-17T16:17:25Z

🎬 CLI E2E Test Recordings — 72 recordings uploaded (commit 80867fd)

View recordings

Test	Recording
AddPackageInteractiveWhileAppHostRunningDetached	▶️ View Recording
AddPackageWhileAppHostRunningDetached	▶️ View Recording
AgentCommands_AllHelpOutputs_AreCorrect	▶️ View Recording
AgentInitCommand_DefaultSelection_InstallsSkillOnly	▶️ View Recording
AgentInitCommand_MigratesDeprecatedConfig	▶️ View Recording
AspireAddPackageVersionToDirectoryPackagesProps	▶️ View Recording
AspireUpdateRemovesAppHostPackageVersionFromDirectoryPackagesProps	▶️ View Recording
Banner_DisplayedOnFirstRun	▶️ View Recording
Banner_DisplayedWithExplicitFlag	▶️ View Recording
Banner_NotDisplayedWithNoLogoFlag	▶️ View Recording
CertificatesClean_RemovesCertificates	▶️ View Recording
CertificatesTrust_WithNoCert_CreatesAndTrustsCertificate	▶️ View Recording
CertificatesTrust_WithUntrustedCert_TrustsCertificate	▶️ View Recording
ConfigSetGet_CreatesNestedJsonFormat	▶️ View Recording
CreateAndRunAspireStarterProject	▶️ View Recording
CreateAndRunAspireStarterProjectWithBundle	▶️ View Recording
CreateAndRunEmptyAppHostProject	▶️ View Recording
CreateAndRunJavaEmptyAppHostProject	▶️ View Recording
CreateAndRunJsReactProject	▶️ View Recording
CreateAndRunPythonReactProject	▶️ View Recording
CreateAndRunTypeScriptEmptyAppHostProject	▶️ View Recording
CreateAndRunTypeScriptStarterProject	▶️ View Recording
CreateJavaAppHostWithViteApp	▶️ View Recording
CreateTypeScriptAppHostWithViteApp	▶️ View Recording
DashboardRunWithOtelTracesReturnsNoTraces	▶️ View Recording
DeployK8sBasicApiService	▶️ View Recording
DeployK8sWithGarnet	▶️ View Recording
DeployK8sWithMongoDB	▶️ View Recording
DeployK8sWithMySql	▶️ View Recording
DeployK8sWithPostgres	▶️ View Recording
DeployK8sWithRabbitMQ	▶️ View Recording
DeployK8sWithRedis	▶️ View Recording
DeployK8sWithSqlServer	▶️ View Recording
DeployK8sWithValkey	▶️ View Recording
DeployTypeScriptAppToKubernetes	▶️ View Recording
DescribeCommandResolvesReplicaNames	▶️ View Recording
DescribeCommandShowsRunningResources	▶️ View Recording
DetachFormatJsonProducesValidJson	▶️ View Recording
DetachFormatJsonProducesValidJsonWhenRestartingExistingInstance	▶️ View Recording
DoListStepsShowsPipelineSteps	▶️ View Recording
DoctorCommand_DetectsDeprecatedAgentConfig	▶️ View Recording
DoctorCommand_WithSslCertDir_ShowsTrusted	▶️ View Recording
DoctorCommand_WithoutSslCertDir_ShowsPartiallyTrusted	▶️ View Recording
GlobalMigration_HandlesCommentsAndTrailingCommas	▶️ View Recording
GlobalMigration_HandlesMalformedLegacyJson	▶️ View Recording
GlobalMigration_PreservesAllValueTypes	▶️ View Recording
GlobalMigration_SkipsWhenNewConfigExists	▶️ View Recording
GlobalSettings_MigratedFromLegacyFormat	▶️ View Recording
InitTypeScriptAppHost_AugmentsExistingViteRepoAtRoot	▶️ View Recording
InvalidAppHostPathWithComments_IsHealedOnRun	▶️ View Recording
LegacySettingsMigration_AdjustsRelativeAppHostPath	▶️ View Recording
LogsCommandShowsResourceLogs	▶️ View Recording
OtelLogsReturnsStructuredLogsFromStarterApp	▶️ View Recording
PsCommandListsRunningAppHost	▶️ View Recording
PsFormatJsonOutputsOnlyJsonToStdout	▶️ View Recording
PublishWithConfigureEnvFileUpdatesEnvOutput	▶️ View Recording
PublishWithDockerComposeServiceCallbackSucceeds	▶️ View Recording
PublishWithoutOutputPathUsesAppHostDirectoryDefault	▶️ View Recording
RestoreGeneratesSdkFiles	▶️ View Recording
RestoreRefreshesGeneratedSdkAfterAddingIntegration	▶️ View Recording
RestoreSupportsConfigOnlyHelperPackageAndCrossPackageTypes	▶️ View Recording
RunFromParentDirectory_UsesExistingConfigNearAppHost	▶️ View Recording
SecretCrudOnDotNetAppHost	▶️ View Recording
SecretCrudOnTypeScriptAppHost	▶️ View Recording
StagingChannel_ConfigureAndVerifySettings_ThenSwitchChannels	▶️ View Recording
StartAndWaitForTypeScriptSqlServerAppHostWithNativeAssets	▶️ View Recording
StopAllAppHostsFromAppHostDirectory	▶️ View Recording
StopAllAppHostsFromUnrelatedDirectory	▶️ View Recording
StopNonInteractiveMultipleAppHostsShowsError	▶️ View Recording
StopNonInteractiveSingleAppHost	▶️ View Recording
StopWithNoRunningAppHostExitsSuccessfully	▶️ View Recording
UnAwaitedChainsCompileWithAutoResolvePromises	▶️ View Recording

_{📹 Recordings uploaded automatically from CI run #24573554565}

davidfowl · 2026-04-17T16:29:58Z

Did you test this with an older apphost?

sebastienros · 2026-04-17T16:49:29Z

@davidfowl do you mean we should see if older apphosts had the issue? If so how old? We didn't have json results that long ago.

davidfowl · 2026-04-17T19:32:36Z

new cli old apphost is what needs to always work.

sebastienros · 2026-04-17T22:11:45Z

@davidfowl

1- we are not touching the protocol definition, WaitForResourceAsync(WaitForResourceRequest) : WaitForResourceResponse is unchanged
2- old apphost with new cli will still work, but the issue will still hapen

JamesNK · 2026-04-18T00:29:31Z

        });

-        var response = await waitTask.WaitAsync(TimeSpan.FromSeconds(10));
+        var response = await waitTask.WaitAsync(TestConstants.DefaultTimeoutTimeSpan);


No, use DefaultTimeout in tests. A shared file may need to be added to the project. It adapts waiting time based on the environment, no ops when debugger is attached, provides better error message.

Fix aspire wait resource resolution

4f2a22c

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

sebastienros requested a review from mitchdenny as a code owner April 16, 2026 00:02

Copilot AI review requested due to automatic review settings April 16, 2026 00:02

sebastienros requested review from JamesNK and davidfowl as code owners April 16, 2026 00:02

Copilot started reviewing on behalf of sebastienros April 16, 2026 00:03 View session

Fix wait fallback without snapshots

173aea3

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI reviewed Apr 16, 2026

View reviewed changes

Comment thread src/Aspire.Cli/Commands/WaitCommand.cs Outdated

Comment thread tests/Aspire.Cli.Tests/Commands/WaitCommandTests.cs Outdated

sebastienros and others added 2 commits April 15, 2026 17:14

Clarify ambiguous wait resource errors

960b503

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Disambiguate wait snapshot lookup

62bb70d

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions Bot mentioned this pull request Apr 16, 2026

[pull requests] Review required #13834

Open

sebastienros and others added 3 commits April 15, 2026 17:48

Merge remote-tracking branch 'origin/main' into sebastienros/fix-aspi…

71a399b

…re-wait-resource-name

Adapt wait to hidden resource API

7798b98

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Resolve hidden wait resources

82597eb

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Fix wait backchannel resource matching

1378456

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

sebastienros requested review from danegsta and karolz-ms as code owners April 16, 2026 01:45

JamesNK requested changes Apr 16, 2026

View reviewed changes

JamesNK reviewed Apr 16, 2026

View reviewed changes

Comment thread src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs Outdated

Move wait resolution into backchannel

68c132e

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

sebastienros and others added 4 commits April 15, 2026 20:30

Restore wait name matching semantics

a5b7dbc

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Revert wait service change

7e68c6a

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Address wait review feedback

b276ec3

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Clarify wait target resolution

da6183b

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Retry CLI E2E apt operations

8ad851f

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

sebastienros requested review from eerhardt and radical as code owners April 16, 2026 16:27

Revert CLI E2E apt retry changes

b2320d7

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

sebastienros mentioned this pull request Apr 16, 2026

Use libicu-dev in Ubuntu Dockerfiles #16250

Merged

16 tasks

Merge remote-tracking branch 'origin/main' into sebastienros/fix-aspi…

5c696b2

…re-wait-resource-name

JamesNK reviewed Apr 16, 2026

View reviewed changes

Comment thread src/Aspire.Hosting/Backchannel/AuxiliaryBackchannelRpcTarget.cs

sebastienros and others added 7 commits April 17, 2026 08:02

Handle ambiguous wait resource names

4d41cb8

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Share healthy wait predicate

2cfd23f

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Resolve wait display names

e9a7d40

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Test wait cancellation display names

5d43982

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Use DefaultTimeout in wait tests

866e208

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Remove fixed wait test delays

c339fc1

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Use shared wait timeout constant

80867fd

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

JamesNK approved these changes Apr 18, 2026

View reviewed changes

JamesNK merged commit f285799 into main Apr 20, 2026
559 of 563 checks passed

JamesNK deleted the sebastienros/fix-aspire-wait-resource-name branch April 20, 2026 04:18

github-actions Bot added this to the 13.3 milestone Apr 20, 2026

This was referenced Apr 24, 2026

[13.3] Change log #16433

Closed

[13.3] Change log #16453

Closed

[13.3] Change log #16455

Closed

[13.3] Change log #16458

Closed

[milestone-changelog] [13.3] Change log #16462

Closed

Conversation

sebastienros commented Apr 16, 2026

Description

Checklist

Uh oh!

github-actions Bot commented Apr 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

JamesNK commented Apr 16, 2026

Uh oh!

JamesNK left a comment

Choose a reason for hiding this comment

Uh oh!

sebastienros commented Apr 16, 2026

Uh oh!

JamesNK commented Apr 16, 2026

Uh oh!

Uh oh!

sebastienros commented Apr 16, 2026

Uh oh!

sebastienros commented Apr 16, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JamesNK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented Apr 17, 2026

Uh oh!

davidfowl commented Apr 17, 2026

Uh oh!

sebastienros commented Apr 17, 2026

Uh oh!

davidfowl commented Apr 17, 2026

Uh oh!

sebastienros commented Apr 17, 2026

Uh oh!

JamesNK Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented Apr 16, 2026 •

edited

Loading