Fix: The path value is ignored when configuring endpoint options with…

… an alternative ID and an empty path (SteeltoeOSS#1402)
thompson-tomo · Nov 1, 2024 · 5ace2a9 · 5ace2a9
1 parent 5716f75
commit 5ace2a9
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 5 deletions.
diff --git a/src/Management/src/Abstractions/Configuration/EndpointOptions.cs b/src/Management/src/Abstractions/Configuration/EndpointOptions.cs
@@ -27,7 +27,7 @@ public virtual string? Path
     {
         get
         {
-            if (!string.IsNullOrEmpty(_path))
+            if (_path != null)
             {
                 return _path;
             }

diff --git a/src/Management/src/Endpoint/Actuators/Metrics/MetricsEndpointMiddleware.cs b/src/Management/src/Endpoint/Actuators/Metrics/MetricsEndpointMiddleware.cs
@@ -45,7 +45,7 @@ internal sealed class MetricsEndpointMiddleware(
     internal string GetMetricName(HttpRequest request)
     {
         string? baseRequestPath = ManagementOptionsMonitor.CurrentValue.GetBaseRequestPath(request);
-        string path = $"{baseRequestPath}/{EndpointHandler.Options.Id}".Replace("//", "/", StringComparison.Ordinal);
+        string path = $"{baseRequestPath}/{EndpointHandler.Options.Path}".Replace("//", "/", StringComparison.Ordinal);
 
         return GetMetricName(request, path);
     }

diff --git a/src/Management/src/Prometheus/PrometheusExtensions.cs b/src/Management/src/Prometheus/PrometheusExtensions.cs
@@ -48,9 +48,9 @@ public static IApplicationBuilder UsePrometheusActuator(this IApplicationBuilder
         PrometheusEndpointOptions? prometheusOptions = builder.ApplicationServices.GetServices<EndpointOptions>()
             .OfType<PrometheusEndpointOptions>().FirstOrDefault();
 
-        string root = managementOptions?.Path ?? "/actuator";
-        string id = prometheusOptions?.Id ?? "prometheus";
-        string path = root + "/" + id;
+        string basePath = managementOptions?.Path ?? "/actuator";
+        string endpointPath = prometheusOptions?.Path ?? "prometheus";
+        string path = $"{basePath}/{endpointPath}".Replace("//", "/", StringComparison.Ordinal);
 
         return builder.UseOpenTelemetryPrometheusScrapingEndpoint(path);
     }

diff --git a/src/Management/test/Endpoint.Test/Actuators/Hypermedia/HypermediaEndpointOptionsTest.cs b/src/Management/test/Endpoint.Test/Actuators/Hypermedia/HypermediaEndpointOptionsTest.cs
@@ -37,4 +37,19 @@ public void Constructor_BindsConfigurationCorrectly()
         Assert.Equal("info", options.Id);
         Assert.Equal("infopath", options.Path);
     }
+
+    [Fact]
+    public void CanSetEmptyPathWithDifferentId()
+    {
+        var appSettings = new Dictionary<string, string?>
+        {
+            ["Management:Endpoints:Actuator:Id"] = "some",
+            ["Management:Endpoints:Actuator:Path"] = string.Empty
+        };
+
+        HypermediaEndpointOptions options = GetOptionsFromSettings<HypermediaEndpointOptions, ConfigureHypermediaEndpointOptions>(appSettings);
+
+        options.Id.Should().Be("some");
+        options.Path.Should().BeEmpty();
+    }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,7 +27,7 @@ public virtual string? Path @@
         {
             get
             {
-                if (!string.IsNullOrEmpty(_path))
+                if (_path != null)
                 {
                     return _path;
                 }
@@ Expand Down @@