Only add dashboard services if the dashboard is enabled (#3489)

* Only add dashboard services if the dashboard is enabled
dotnet · Apr 8, 2024 · a6f7540 · a6f7540
1 parent 3d82b0f
commit a6f7540
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/src/Aspire.Hosting/DistributedApplicationBuilder.cs b/src/Aspire.Hosting/DistributedApplicationBuilder.cs
@@ -140,14 +140,14 @@ public DistributedApplicationBuilder(DistributedApplicationOptions options)
                 _innerBuilder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<IValidateOptions<TransportOptions>, TransportOptionsValidator>());
                 _innerBuilder.Services.AddSingleton<DashboardServiceHost>();
                 _innerBuilder.Services.AddHostedService(sp => sp.GetRequiredService<DashboardServiceHost>());
+                _innerBuilder.Services.AddSingleton<IDashboardEndpointProvider, HostDashboardEndpointProvider>();
                 _innerBuilder.Services.AddLifecycleHook<DashboardLifecycleHook>();
                 _innerBuilder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<DashboardOptions>, ConfigureDefaultDashboardOptions>());
                 _innerBuilder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<IValidateOptions<DashboardOptions>, ValidateDashboardOptions>());
             }
 
             // DCP stuff
             _innerBuilder.Services.AddSingleton<ApplicationExecutor>();
-            _innerBuilder.Services.AddSingleton<IDashboardEndpointProvider, HostDashboardEndpointProvider>();
             _innerBuilder.Services.AddSingleton<IDcpDependencyCheckService, DcpDependencyCheck>();
             _innerBuilder.Services.AddHostedService<DcpHostService>();
             _innerBuilder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<DcpOptions>, ConfigureDefaultDcpOptions>());

diff --git a/tests/Aspire.Hosting.Tests/Dashboard/DashboardResourceTests.cs b/tests/Aspire.Hosting.Tests/Dashboard/DashboardResourceTests.cs
@@ -276,6 +276,20 @@ public async Task DashboardIsNotAddedIfDisabled()
         Assert.Empty(model.Resources);
     }
 
+    [Fact]
+    public void ContainerIsValidWithDashboardIsDisabled()
+    {
+        // Set the host environment to "Development" so that the container validates services.
+        using var builder = TestDistributedApplicationBuilder.Create(new DistributedApplicationOptions
+        {
+            DisableDashboard = true,
+            Args = ["--environment", "Development"] }
+        );
+
+        // Container validation logic runs when the service provider is built.
+        using var app = builder.Build();
+    }
+
     private sealed class MockDashboardEndpointProvider : IDashboardEndpointProvider
     {
         public Task<string> GetResourceServiceUriAsync(CancellationToken cancellationToken = default)