Update service discovery environment variables by danegsta · Pull Request #16210 · microsoft/aspire

danegsta · 2026-04-15T17:41:15Z

Description

This change strikes a balance between handling http/https endpoint name and scheme mismatches and allowing non-http endpoints to be referenced using DNS style service discovery notation instead of by scheme.

Fixes #15925

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

…e support Fix scheme key computation in service discovery environment variables: - Endpoints named 'http'/'https' use the actual URI scheme as the key, correctly handling TLS upgrades (e.g., endpoint 'http' with scheme 'https' produces services__svc__https__0). - All other endpoint names (e.g., 'prometheus', 'management') use the endpoint name as the key, restoring the ability to differentiate multiple logical services from a single resource. Add optional 'name' parameter to WithReference(EndpointReference): - Allows custom service names for individual endpoint references, enabling scenarios like services__kafka-admin__admin__0. - ApplyEndpoints now keys annotations on (resource, serviceName) to support multiple named references to the same resource. Fix YARP destination address generation: - Endpoints named 'http'/'https' use standard resolution without the underscore prefix (http://resourceName). - Other endpoint names keep the named endpoint DNS-SD convention (http://_endpointName.resourceName), which now works correctly because the service discovery key uses the endpoint name. Apply same scheme key fix to DevTunnels for consistency. Fixes microsoft#15925 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates service-discovery environment variable key generation to better handle endpoint name vs scheme mismatches (especially HTTP→HTTPS TLS upgrades), while still supporting DNS-SD-style named endpoints for non-HTTP endpoints.

Changes:

Generate service discovery env-var keys using the actual scheme for endpoints named http/https, otherwise use the endpoint name.
Update YARP cluster destination address formatting to omit DNS-SD _name. prefix for http/https endpoints.
Refresh unit tests and snapshot expectations to reflect the new key/address formats.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tests/Aspire.Hosting.Yarp.Tests/YarpClusterTests.cs	Updates expectations for YARP cluster target address formatting for `http`/`https`.
tests/Aspire.Hosting.Yarp.Tests/Snapshots/YarpConfigGeneratorTests.GenerateEnvVariablesConfigurationDockerCompose.verified.env	Updates snapshot for cluster destination addresses (drops `_http.` prefix).
tests/Aspire.Hosting.Tests/WithReferenceTests.cs	Updates expected service-discovery env-var keys and adds new coverage for scheme/name mismatch and named endpoints.
src/Aspire.Hosting/ResourceBuilderExtensions.cs	Changes service-discovery key generation logic; adds helper for `http`/`https` endpoint-name detection.
src/Aspire.Hosting.Yarp/ConfigurationBuilder/YarpCluster.cs	Changes YARP target address generation to special-case `http`/`https` endpoint names.
src/Aspire.Hosting.DevTunnels/DevTunnelResourceBuilderExtensions.cs	Mirrors service-discovery key changes in Dev Tunnels integration; adds local helper.
playground/yarp/Yarp.AppHost/Properties/launchSettings.json	Removes commented env var entries.

github-actions · 2026-04-15T18:04:42Z

🚀 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 -- 16210

Or

Run remotely in PowerShell:

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

Fix scheme key computation in service discovery environment variables: - Endpoints named 'http'/'https' use the actual URI scheme as the key, correctly handling TLS upgrades (e.g., endpoint 'http' with scheme 'https' produces services__svc__https__0). - All other endpoint names (e.g., 'prometheus', 'management') use the endpoint name as the key, restoring the ability to differentiate multiple logical services from a single resource. Fix YARP destination address generation: - Endpoints named 'http'/'https' use standard resolution without the underscore prefix (http://resourceName). - Other endpoint names keep the named endpoint DNS-SD convention (http://_endpointName.resourceName), which now works correctly because the service discovery key uses the endpoint name. Apply same scheme key fix to DevTunnels for consistency. Fixes microsoft#15925 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

eerhardt · 2026-04-15T18:38:05Z

        var config = await EnvironmentVariableEvaluator.GetEnvironmentVariablesAsync(projectB.Resource, DistributedApplicationOperation.Run, TestServiceProvider.Instance).DefaultTimeout();

-        Assert.Equal("https://localhost:2000", config["services__projecta__https__0"]);
+        Assert.Equal("https://localhost:2000", config["services__projecta__mybinding__0"]);


Does ServiceDiscovery like this?

Yeah, there's two different ways ServiceDiscovery handles service resolution; the standard scheme based resolution (i.e. http+https://servicename) and DNS style resolution (http://_mybinding.projecta). Yarp was taking advantage of the latter and some fixes we made to better handle service discovery environment variables when switching endpoints from http to https ended up breaking the usage of WithReference for non scheme based endpoints.

Update TwoPassScanningGeneratedAspire snapshots for all polyglot languages (Go, Java, Python, Rust, TypeScript) to include the new EndpointReference.IsHttpSchemeNamedEndpoint property. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

danegsta · 2026-04-15T20:57:11Z

/backport to release/13.2

github-actions · 2026-04-15T20:58:00Z

Started backporting to release/13.2 (link to workflow run)

aspire-repo-bot · 2026-04-15T20:58:12Z

@danegsta backporting to release/13.2 failed, the patch most likely resulted in conflicts. Please backport manually!

git am output

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch

Applying: Fix service discovery key generation and add per-endpoint service name support
Applying: Fix service discovery key generation for named endpoints
error: sha1 information is lacking or useless (src/Aspire.Hosting/ResourceBuilderExtensions.cs).
error: could not build fake ancestor
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0002 Fix service discovery key generation for named endpoints
Error: The process '/usr/bin/git' failed with exit code 128

Link to workflow output

The custom1-custom4 endpoints now use their endpoint names as service discovery keys instead of being indexed under the http scheme. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

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

davidfowl · 2026-04-16T02:42:15Z

we typically dont add public APIs in patches but.

danegsta requested review from JamesNK, karolz-ms and mitchdenny as code owners April 15, 2026 17:41

Copilot AI review requested due to automatic review settings April 15, 2026 17:41

danegsta requested a review from davidfowl as a code owner April 15, 2026 17:41

Copilot AI reviewed Apr 15, 2026

View reviewed changes

Comment thread src/Aspire.Hosting/ResourceBuilderExtensions.cs Outdated

Comment thread src/Aspire.Hosting/ResourceBuilderExtensions.cs Outdated

Comment thread src/Aspire.Hosting.Yarp/ConfigurationBuilder/YarpCluster.cs

Comment thread src/Aspire.Hosting/ResourceBuilderExtensions.cs Outdated

Copilot started reviewing on behalf of danegsta April 15, 2026 17:54 View session

danegsta force-pushed the danegsta/referenceName branch from 24515ae to 6b0972a Compare April 15, 2026 18:27

eerhardt reviewed Apr 15, 2026

View reviewed changes

Comment thread src/Aspire.Hosting.DevTunnels/DevTunnelResourceBuilderExtensions.cs Outdated

eerhardt reviewed Apr 15, 2026

View reviewed changes

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

[pull requests] Review required #13834

Open

danegsta and others added 2 commits April 15, 2026 12:21

Add helper on endpoint to check for http/https name

12d5cf8

danegsta and others added 2 commits April 15, 2026 14:34

Update Docker Compose snapshot for named endpoint scheme keys

64566de

The custom1-custom4 endpoints now use their endpoint names as service discovery keys instead of being indexed under the http scheme. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Update Kubernetes snapshots for named endpoint scheme keys

4b5f752

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

danegsta enabled auto-merge (squash) April 15, 2026 23:09

danegsta mentioned this pull request Apr 15, 2026

[release/13.2] Update service discovery environment variables #16223

Merged

karolz-ms approved these changes Apr 15, 2026

View reviewed changes

danegsta merged commit efcd138 into microsoft:main Apr 15, 2026
556 of 559 checks passed

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

This was referenced Apr 24, 2026

[13.3] Change log #16431

Closed

[13.3] Change log #16433

Closed

[13.3] Change log #16455

Closed

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

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

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update service discovery environment variables#16210

Update service discovery environment variables#16210
danegsta merged 6 commits intomicrosoft:mainfrom
danegsta:danegsta/referenceName

danegsta commented Apr 15, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 15, 2026 •

edited

Loading

Uh oh!

Uh oh!

eerhardt Apr 15, 2026

Uh oh!

danegsta Apr 15, 2026

Uh oh!

danegsta commented Apr 15, 2026

Uh oh!

github-actions Bot commented Apr 15, 2026

Uh oh!

aspire-repo-bot Bot commented Apr 15, 2026

Uh oh!

Uh oh!

davidfowl commented Apr 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

danegsta commented Apr 15, 2026

Description

Checklist

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!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

eerhardt Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

danegsta Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

danegsta commented Apr 15, 2026

Uh oh!

github-actions Bot commented Apr 15, 2026

Uh oh!

aspire-repo-bot Bot commented Apr 15, 2026

Uh oh!

Uh oh!

davidfowl commented Apr 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions Bot commented Apr 15, 2026 •

edited

Loading