Dashboard gracefully handles duplicate property names (#8373)

Author: JamesNK

src/Aspire.Dashboard/ResourceService/DashboardClient.cs

@@ -341,7 +341,7 @@ async Task WatchResourcesAsync()
                                 foreach (var resource in response.InitialData.Resources)
                                 {
                                     // Add to map.
-                                    var viewModel = resource.ToViewModel(_timeProvider, _knownPropertyLookup);
+                                    var viewModel = resource.ToViewModel(_timeProvider, _knownPropertyLookup, _logger);
                                     _resourceByName[resource.Name] = viewModel;
 
                                     // Send this update to any subscribers too.
@@ -361,7 +361,7 @@ async Task WatchResourcesAsync()
                                     if (change.KindCase == WatchResourcesChange.KindOneofCase.Upsert)
                                     {
                                         // Upsert (i.e. add or replace)
-                                        var viewModel = change.Upsert.ToViewModel(_timeProvider, _knownPropertyLookup);
+                                        var viewModel = change.Upsert.ToViewModel(_timeProvider, _knownPropertyLookup, _logger);
                                         _resourceByName[change.Upsert.Name] = viewModel;
                                         changes.Add(new(ResourceViewModelChangeType.Upsert, viewModel));
                                     }
@@ -584,7 +584,7 @@ internal void SetInitialDataReceived(IList<Resource>? initialData = null)
             {
                 foreach (var data in initialData)
                 {
-                    _resourceByName[data.Name] = data.ToViewModel(_timeProvider, _knownPropertyLookup);
+                    _resourceByName[data.Name] = data.ToViewModel(_timeProvider, _knownPropertyLookup, _logger);
                 }
             }
         }

src/Aspire.Dashboard/ResourceService/Partials.cs

@@ -9,6 +9,7 @@
 using CommandsResources = Aspire.Dashboard.Resources.Commands;
 using Aspire.Dashboard.Resources;
 using Aspire.Hosting;
+using Google.Protobuf.Collections;
 
 namespace Aspire.ResourceService.Proto.V1;
 
@@ -17,7 +18,7 @@ partial class Resource
     /// <summary>
     /// Converts this gRPC message object to a view model for use in the dashboard UI.
     /// </summary>
-    public ResourceViewModel ToViewModel(BrowserTimeProvider timeProvider, IKnownPropertyLookup knownPropertyLookup)
+    public ResourceViewModel ToViewModel(BrowserTimeProvider timeProvider, IKnownPropertyLookup knownPropertyLookup, ILogger logger)
     {
         try
         {
@@ -30,21 +31,7 @@ public ResourceViewModel ToViewModel(BrowserTimeProvider timeProvider, IKnownPro
                 CreationTimeStamp = ValidateNotNull(CreatedAt).ToDateTime(),
                 StartTimeStamp = StartedAt?.ToDateTime(),
                 StopTimeStamp = StoppedAt?.ToDateTime(),
-                Properties = Properties.ToImmutableDictionary(
-                    keyComparer: StringComparers.ResourcePropertyName,
-                    keySelector: property => ValidateNotNull(property.Name),
-                    elementSelector: property =>
-                    {
-                        var (priority, knownProperty) = knownPropertyLookup.FindProperty(ResourceType, property.Name);
-
-                        return new ResourcePropertyViewModel(
-                            name: ValidateNotNull(property.Name),
-                            value: ValidateNotNull(property.Value),
-                            isValueSensitive: property.IsSensitive,
-                            knownProperty: knownProperty,
-                            priority: priority,
-                            timeProvider: timeProvider);
-                    }),
+                Properties = CreatePropertyViewModels(Properties, timeProvider, knownPropertyLookup, logger),
                 Environment = GetEnvironment(),
                 Urls = GetUrls(),
                 Volumes = GetVolumes(),
@@ -160,16 +147,42 @@ static FluentUIIconVariant MapIconVariant(IconVariant iconVariant)
                 };
             }
         }
+    }
+
+    private ImmutableDictionary<string, ResourcePropertyViewModel> CreatePropertyViewModels(RepeatedField<ResourceProperty> properties, BrowserTimeProvider timeProvider, IKnownPropertyLookup knownPropertyLookup, ILogger logger)
+    {
+        var builder = ImmutableDictionary.CreateBuilder<string, ResourcePropertyViewModel>(StringComparers.ResourcePropertyName);
 
-        T ValidateNotNull<T>(T value, [CallerArgumentExpression(nameof(value))] string? expression = null) where T : class
+        foreach (var property in properties)
         {
-            if (value is null)
+            var (priority, knownProperty) = knownPropertyLookup.FindProperty(ResourceType, property.Name);
+            var propertyViewModel = new ResourcePropertyViewModel(
+                name: ValidateNotNull(property.Name),
+                value: ValidateNotNull(property.Value),
+                isValueSensitive: property.IsSensitive,
+                knownProperty: knownProperty,
+                priority: priority,
+                timeProvider: timeProvider);
+
+            if (builder.ContainsKey(propertyViewModel.Name))
             {
-                throw new InvalidOperationException($"Message field '{expression}' on resource with name '{Name}' cannot be null.");
+                logger.LogWarning("Duplicate property '{PropertyName}' found in resource '{ResourceName}'.", propertyViewModel.Name, Name);
             }
 
-            return value;
+            builder[propertyViewModel.Name] = propertyViewModel;
+        }
+
+        return builder.ToImmutable();
+    }
+
+    private T ValidateNotNull<T>(T value, [CallerArgumentExpression(nameof(value))] string? expression = null) where T : class
+    {
+        if (value is null)
+        {
+            throw new InvalidOperationException($"Message field '{expression}' on resource with name '{Name}' cannot be null.");
         }
+
+        return value;
     }
 }
 

tests/Aspire.Dashboard.Tests/Model/ResourceViewModelTests.cs

@@ -48,17 +48,48 @@ public void ToViewModel_EmptyEnvVarName_Success()
         };
 
         // Act
-        var vm = resource.ToViewModel(s_timeProvider, new MockKnownPropertyLookup());
+        var vm = resource.ToViewModel(s_timeProvider, new MockKnownPropertyLookup(), NullLogger.Instance);
 
         // Assert
-        Assert.Collection(resource.Environment,
+        Assert.Collection(vm.Environment,
             e =>
             {
                 Assert.Empty(e.Name);
                 Assert.Equal("Value!", e.Value);
             });
     }
 
+    [Fact]
+    public void ToViewModel_DuplicatePropertyNames_Success()
+    {
+        // Arrange
+        var resource = new Resource
+        {
+            Name = "TestName-abc",
+            DisplayName = "TestName",
+            CreatedAt = Timestamp.FromDateTime(s_dateTime),
+            Properties =
+            {
+                new ResourceProperty { Name = "test", Value = Value.ForString("one!") },
+                new ResourceProperty { Name = "test", Value = Value.ForString("two!") }
+            }
+        };
+
+        // Act
+        var vm = resource.ToViewModel(s_timeProvider, new MockKnownPropertyLookup(), NullLogger.Instance);
+
+        // Assert
+        Assert.Collection(vm.Properties,
+            e =>
+            {
+                var (key, vm) = (e.Key, e.Value);
+
+                Assert.Equal("test", key);
+                Assert.Equal("test", vm.Name);
+                Assert.Equal("two!", vm.Value.StringValue);
+            });
+    }
+
     [Fact]
     public void ToViewModel_MissingRequiredData_FailWithFriendlyError()
     {
@@ -69,7 +100,7 @@ public void ToViewModel_MissingRequiredData_FailWithFriendlyError()
         };
 
         // Act
-        var ex = Assert.Throws<InvalidOperationException>(() => resource.ToViewModel(s_timeProvider, new MockKnownPropertyLookup()));
+        var ex = Assert.Throws<InvalidOperationException>(() => resource.ToViewModel(s_timeProvider, new MockKnownPropertyLookup(), NullLogger.Instance));
 
         // Assert
         Assert.Equal(@"Error converting resource ""TestName-abc"" to ResourceViewModel.", ex.Message);
@@ -95,7 +126,7 @@ public void ToViewModel_CopiesProperties()
         var kp = new KnownProperty("foo", "bar");
 
         // Act
-        var viewModel = resource.ToViewModel(s_timeProvider, new MockKnownPropertyLookup(123, kp));
+        var viewModel = resource.ToViewModel(s_timeProvider, new MockKnownPropertyLookup(123, kp), NullLogger.Instance);
 
         // Assert
         Assert.Collection(