Support simplified service url ENV format

sebastienros · sebastienros · commit 368ccc64c4f1 · 2025-10-17T17:14:01.000-07:00
Fixes #12069
diff --git a/playground/AspireWithJavaScript/AspireJavaScript.Angular/default.conf.template b/playground/AspireWithJavaScript/AspireJavaScript.Angular/default.conf.template
@@ -11,7 +11,7 @@ server {
     }
 
     location /api/ {
-        proxy_pass ${services__weatherapi__https__0};
+        proxy_pass ${WEATHERAPI_HTTPS};
         proxy_http_version 1.1;
         proxy_ssl_server_name on;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
diff --git a/playground/AspireWithJavaScript/AspireJavaScript.Angular/proxy.conf.js b/playground/AspireWithJavaScript/AspireJavaScript.Angular/proxy.conf.js
@@ -1,8 +1,7 @@
 module.exports = {
   "/api": {
     target:
-      process.env["services__weatherapi__https__0"] ||
-      process.env["services__weatherapi__http__0"],
+      process.env["WEATHERAPI_HTTPS"] || process.env["WEATHERAPI_HTTP"],
     secure: process.env["NODE_ENV"] !== "development",
     pathRewrite: {
       "^/api": "",
diff --git a/playground/AspireWithJavaScript/AspireJavaScript.React/default.conf.template b/playground/AspireWithJavaScript/AspireJavaScript.React/default.conf.template
@@ -11,7 +11,7 @@ server {
     }
 
     location /api/ {
-        proxy_pass ${services__weatherapi__https__0};
+        proxy_pass ${WEATHERAPI_HTTPS};
         proxy_http_version 1.1;
         proxy_ssl_server_name on;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
diff --git a/playground/AspireWithJavaScript/AspireJavaScript.React/webpack.config.js b/playground/AspireWithJavaScript/AspireJavaScript.React/webpack.config.js
@@ -10,8 +10,7 @@ module.exports = (env) => {
         {
           context: ["/api"],
           target:
-            process.env.services__weatherapi__https__0 ||
-            process.env.services__weatherapi__http__0,
+            process.env.WEATHERAPI_HTTPS || process.env.WEATHERAPI_HTTP,
           pathRewrite: { "^/api": "" },
           secure: false,
         },
diff --git a/playground/AspireWithJavaScript/AspireJavaScript.Vite/default.conf.template b/playground/AspireWithJavaScript/AspireJavaScript.Vite/default.conf.template
@@ -11,7 +11,7 @@ server {
     }
 
     location /api/ {
-        proxy_pass ${services__weatherapi__https__0};
+        proxy_pass ${WEATHERAPI_HTTPS};
         proxy_http_version 1.1;
         proxy_ssl_server_name on;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
diff --git a/playground/AspireWithJavaScript/AspireJavaScript.Vite/vite.config.ts b/playground/AspireWithJavaScript/AspireJavaScript.Vite/vite.config.ts
@@ -11,8 +11,7 @@ export default defineConfig(({ mode }) => {
             port: parseInt(env.VITE_PORT),
             proxy: {
                 '/api': {
-                    target: process.env.services__weatherapi__https__0 ||
-                        process.env.services__weatherapi__http__0,
+                    target: process.env.WEATHERAPI_HTTPS || process.env.WEATHERAPI_HTTP,
                     changeOrigin: true,
                     rewrite: (path) => path.replace(/^\/api/, ''),
                     secure: false,
diff --git a/playground/AspireWithJavaScript/AspireJavaScript.Vue/default.conf.template b/playground/AspireWithJavaScript/AspireJavaScript.Vue/default.conf.template
@@ -11,7 +11,7 @@ server {
     }
 
     location /api/ {
-        proxy_pass ${services__weatherapi__https__0};
+        proxy_pass ${WEATHERAPI_HTTPS};
         proxy_http_version 1.1;
         proxy_ssl_server_name on;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
diff --git a/playground/AspireWithJavaScript/AspireJavaScript.Vue/vite.config.ts b/playground/AspireWithJavaScript/AspireJavaScript.Vue/vite.config.ts
@@ -18,7 +18,7 @@ export default defineConfig({
     port: parseInt(process.env.PORT ?? "5173"),
     proxy: {
       '/api': {
-        target: process.env.services__weatherapi__https__0 || process.env.services__weatherapi__http__0,
+        target: process.env.WEATHERAPI_HTTPS || process.env.WEATHERAPI_HTTP,
         changeOrigin: true,
         rewrite: path => path.replace(/^\/api/, ''),
         secure: false
diff --git a/playground/AspireWithNode/AspireWithNode.AppHost/AppHost.cs b/playground/AspireWithNode/AspireWithNode.AppHost/AppHost.cs
@@ -8,7 +8,8 @@
     .AddRedis("cache")
     .WithPassword(pass);
 
-var weatherapi = builder.AddProject<Projects.AspireWithNode_AspNetCoreApi>("weatherapi");
+var weatherapi = builder.AddProject<Projects.AspireWithNode_AspNetCoreApi>("weatherapi")
+    .WithHttpsEndpoint(port: 9999, name: "dashboard"); ;
 
 var frontend = builder.AddNpmApp("frontend", "../NodeFrontend", "watch")
     .WithReference(weatherapi)
diff --git a/playground/AspireWithNode/NodeFrontend/app.js b/playground/AspireWithNode/NodeFrontend/app.js
@@ -15,7 +15,7 @@ const config = {
     certFile: process.env['HTTPS_CERT_FILE'] ?? '',
     certKeyFile: process.env['HTTPS_CERT_KEY_FILE'] ?? '',
     cacheUrl: process.env['CACHE_URI'] ?? '',
-    apiServer: process.env['services__weatherapi__https__0'] ?? process.env['services__weatherapi__http__0']
+    apiServer: process.env['WEATHERAPI_HTTPS'] ?? process.env['WEATHERAPI_HTTP']
 };
 console.log(`config: ${JSON.stringify(config)}`);
 
diff --git a/src/Aspire.Hosting.DevTunnels/DevTunnelResourceBuilderExtensions.cs b/src/Aspire.Hosting.DevTunnels/DevTunnelResourceBuilderExtensions.cs
@@ -374,7 +374,7 @@ public static EndpointReference GetEndpoint(this IResourceBuilder<DevTunnelResou
         ArgumentNullException.ThrowIfNull(targetEndpointReference);
 
         var portResource = tunnelBuilder.Resource.Ports
-            .FirstOrDefault(p => p.TargetEndpoint.Resource == targetEndpointReference.Resource 
+            .FirstOrDefault(p => p.TargetEndpoint.Resource == targetEndpointReference.Resource
                 && StringComparers.EndpointAnnotationName.Equals(p.TargetEndpoint.EndpointName, targetEndpointReference.EndpointName));
 
         if (portResource is null)
@@ -394,8 +394,9 @@ private static EndpointReference CreateEndpointReferenceWithError(DevTunnelResou
     }
 
     /// <summary>
-    /// Injects service discovery information as environment variables from the dev tunnel resource into the destination resource, using the tunneled resource's name as the service name.
-    /// Each endpoint defined on the target resource will be injected using the format "services__{sourceResourceName}__{endpointName}__{endpointIndex}={uriString}".
+    /// Injects service discovery and endpoint information as environment variables from the dev tunnel resource into the destination resource, using the tunneled resource's name as the service name.
+    /// Each endpoint defined on the target resource will be injected using the format defined by the <see cref="ReferenceEnvironmentInjectionAnnotation"/> on the destination resource, i.e.
+    /// either "services__{sourceResourceName}__{endpointName}__{endpointIndex}={uriString}" for .NET service discovery, or "{RESOURCE_ENDPOINT}={uri}" for endpoint injection.
     /// </summary>
     /// <remarks>
     /// Referencing a dev tunnel will delay the start of the resource until the referenced dev tunnel's endpoint is allocated.
@@ -422,12 +423,25 @@ public static IResourceBuilder<TResource> WithReference<TResource>(this IResourc
             .WithReferenceRelationship(tunnelResource)
             .WithEnvironment(context =>
             {
+                // Determine what to inject based on the annotation on the destination resource
+                var injectionAnnotation = context.Resource.Annotations.OfType<ReferenceEnvironmentInjectionAnnotation>().LastOrDefault();
+                var flags = injectionAnnotation?.Flags ?? ReferenceEnvironmentInjectionFlags.All;
+
                 // Add environment variables for each tunnel port that references an endpoint on the target resource
                 foreach (var port in tunnelResource.Resource.Ports.Where(p => p.TargetEndpoint.Resource == targetResource.Resource))
                 {
                     var serviceName = targetResource.Resource.Name;
                     var endpointName = port.TargetEndpoint.EndpointName;
-                    context.EnvironmentVariables[$"services__{serviceName}__{endpointName}__0"] = port.TunnelEndpoint;
+
+                    if (flags.HasFlag(ReferenceEnvironmentInjectionFlags.ServiceDiscovery))
+                    {
+                        context.EnvironmentVariables[$"services__{serviceName}__{endpointName}__0"] = port.TunnelEndpoint;
+                    }
+
+                    if (flags.HasFlag(ReferenceEnvironmentInjectionFlags.Endpoints))
+                    {
+                        context.EnvironmentVariables[$"{serviceName.ToUpperInvariant()}_{endpointName.ToUpperInvariant()}"] = port.TunnelEndpoint;
+                    }
                 }
             });
 
diff --git a/src/Aspire.Hosting/ApplicationModel/ReferenceEnvironmentInjectionAnnotation.cs b/src/Aspire.Hosting/ApplicationModel/ReferenceEnvironmentInjectionAnnotation.cs
@@ -4,7 +4,7 @@
 namespace Aspire.Hosting.ApplicationModel;
 
 /// <summary>
-/// Annotation that specifies which connection information should be injected into environment variables
+/// Annotation that specifies which connection and endpoint information should be injected into environment variables
 /// when a resource is referenced using <c>WithReference()</c>.
 /// </summary>
 public sealed class ReferenceEnvironmentInjectionAnnotation : IResourceAnnotation
diff --git a/src/Aspire.Hosting/ApplicationModel/ReferenceEnvironmentInjectionFlags.cs b/src/Aspire.Hosting/ApplicationModel/ReferenceEnvironmentInjectionFlags.cs
@@ -4,7 +4,7 @@
 namespace Aspire.Hosting.ApplicationModel;
 
 /// <summary>
-/// Specifies which connection information should be injected into environment variables when <c>WithReference()</c> is invoked.
+/// Specifies which connection or endpoint information should be injected into environment variables when <c>WithReference()</c> is invoked.
 /// </summary>
 [Flags]
 public enum ReferenceEnvironmentInjectionFlags
@@ -25,7 +25,17 @@ public enum ReferenceEnvironmentInjectionFlags
     ConnectionProperties = 1 << 1,
 
     /// <summary>
-    /// Both connection string and connection properties will be injected as environment variables.
+    /// Each endpoint defined on the resource will be injected using the format "services__{resourceName}__{endpointName}__{endpointIndex}".
     /// </summary>
-    All = ConnectionString | ConnectionProperties
+    ServiceDiscovery = 1 << 2,
+
+    /// <summary>
+    /// Each endpoint defined on the resource will be injected using the format "{RESOURCENAME}_{ENDPOINTNAME}".
+    /// </summary>
+    Endpoints = 1 << 3,
+
+    /// <summary>
+    /// Connection string, connection properties and service endpoints will be injected as environment variables.
+    /// </summary>
+    All = ConnectionString | ConnectionProperties | ServiceDiscovery | Endpoints
 }
diff --git a/src/Aspire.Hosting/ResourceBuilderExtensions.cs b/src/Aspire.Hosting/ResourceBuilderExtensions.cs
diff --git a/tests/Aspire.Hosting.Tests/WithReferenceTests.cs b/tests/Aspire.Hosting.Tests/WithReferenceTests.cs

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ server {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`location /api/ {`
`14`		`- proxy_pass ${services__weatherapi__https__0};`
	`14`	`+ proxy_pass ${WEATHERAPI_HTTPS};`
`15`	`15`	`proxy_http_version 1.1;`
`16`	`16`	`proxy_ssl_server_name on;`
`17`	`17`	`proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;`