Add more logging to CallService_OtlpGrpcEndPoint_ExternalFile_FileChanged_UseConfiguredKey (dotnet#4638)

Author: JamesNK

src/Aspire.Dashboard/Configuration/PostConfigureDashboardOptions.cs

@@ -2,21 +2,30 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using Aspire.Hosting;
+using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
 
 namespace Aspire.Dashboard.Configuration;
 
 public sealed class PostConfigureDashboardOptions : IPostConfigureOptions<DashboardOptions>
 {
     private readonly IConfiguration _configuration;
+    private readonly ILogger _logger;
 
-    public PostConfigureDashboardOptions(IConfiguration configuration)
+    public PostConfigureDashboardOptions(IConfiguration configuration) : this(configuration, NullLogger<PostConfigureDashboardOptions>.Instance)
+    {
+    }
+
+    public PostConfigureDashboardOptions(IConfiguration configuration, ILogger<PostConfigureDashboardOptions> logger)
     {
         _configuration = configuration;
+        _logger = logger;
     }
 
     public void PostConfigure(string? name, DashboardOptions options)
     {
+        _logger.LogDebug($"PostConfigure {nameof(DashboardOptions)} with name '{name}'.");
+
         // Copy aliased config values to the strongly typed options.
         if (_configuration[DashboardConfigNames.DashboardOtlpGrpcUrlName.ConfigKey] is { Length: > 0 } otlpGrpcUrl)
         {

src/Aspire.Dashboard/Configuration/ValidateDashboardOptions.cs

@@ -2,14 +2,28 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using Aspire.Hosting;
+using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
 
 namespace Aspire.Dashboard.Configuration;
 
 public sealed class ValidateDashboardOptions : IValidateOptions<DashboardOptions>
 {
+    private readonly ILogger _logger;
+
+    public ValidateDashboardOptions() : this(NullLogger<ValidateDashboardOptions>.Instance)
+    {
+    }
+
+    public ValidateDashboardOptions(ILogger<ValidateDashboardOptions> logger)
+    {
+        _logger = logger;
+    }
+
     public ValidateOptionsResult Validate(string? name, DashboardOptions options)
     {
+        _logger.LogDebug($"Validating {nameof(DashboardOptions)}.");
+
         var errorMessages = new List<string>();
 
         if (!options.Frontend.TryParseOptions(out var frontendParseErrorMessage))

tests/Aspire.Dashboard.Tests/Integration/OtlpGrpcServiceTests.cs

@@ -166,7 +166,8 @@ public async Task CallService_OtlpGrpcEndPoint_ExternalFile_FileChanged_UseConfi
                 }
             }
         };
-        File.WriteAllText(configPath, configJson.ToString());
+        _testOutputHelper.WriteLine("Writing original JSON file.");
+        await File.WriteAllTextAsync(configPath, configJson.ToString());
 
         var testSink = new TestSink();
         await using var app = IntegrationTestHelpers.CreateDashboardWebApplication(_testOutputHelper, config =>
@@ -178,6 +179,7 @@ public async Task CallService_OtlpGrpcEndPoint_ExternalFile_FileChanged_UseConfi
         var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
         using var monitorRegistration = app.DashboardOptionsMonitor.OnChange((o, n) =>
         {
+            _testOutputHelper.WriteLine("Options changed.");
             tcs.TrySetResult();
         });
 
@@ -207,10 +209,15 @@ public async Task CallService_OtlpGrpcEndPoint_ExternalFile_FileChanged_UseConfi
                 }
             }
         };
-        File.WriteAllText(configPath, configJson.ToString());
 
+        _testOutputHelper.WriteLine("Writing new JSON file.");
+        await File.WriteAllTextAsync(configPath, configJson.ToString());
+
+        _testOutputHelper.WriteLine("Waiting for options change.");
         await tcs.Task;
 
+        Assert.Equal("Different", app.DashboardOptionsMonitor.CurrentValue.Otlp.PrimaryApiKey);
+
         // Act 2
         var ex = await Assert.ThrowsAsync<RpcException>(() => client.ExportAsync(new ExportLogsServiceRequest(), metadata).ResponseAsync);