Add hidden to protocol, support in dashboard

playground/Stress/Stress.AppHost/Program.cs

@@ -26,6 +26,8 @@
     }
 }
 
+builder.AddParameter("testParameterResource", () => "value", secret: true);
+
 // TODO: OTEL env var can be removed when OTEL libraries are updated to 1.9.0
 // See https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/RELEASENOTES.md#1100
 var serviceBuilder = builder.AddProject<Projects.Stress_ApiService>("stress-apiservice", launchProfileName: null)

src/Aspire.Dashboard/Components/Pages/ConsoleLogs.razor.cs

@@ -393,7 +393,7 @@ internal static ImmutableList<SelectViewModel<ResourceTypeDetails>> GetConsoleLo
         var builder = ImmutableList.CreateBuilder<SelectViewModel<ResourceTypeDetails>>();
 
         foreach (var grouping in resourcesByName
-            .Where(r => !r.Value.IsHiddenState())
+            .Where(r => !r.Value.IsResourceHidden())
             .OrderBy(c => c.Value, ResourceViewModelNameComparer.Instance)
             .GroupBy(r => r.Value.DisplayName, StringComparers.ResourceName))
         {

src/Aspire.Dashboard/Components/Pages/Resources.razor.cs

@@ -118,7 +118,7 @@ private bool Filter(ResourceViewModel resource)
                && IsKeyValueTrue(resource.State ?? string.Empty, PageViewModel.ResourceStatesToVisibility)
                && IsKeyValueTrue(resource.HealthStatus?.Humanize() ?? string.Empty, PageViewModel.ResourceHealthStatusesToVisibility)
                && (_filter.Length == 0 || resource.MatchesFilter(_filter))
-               && !resource.IsHiddenState();
+               && !resource.IsResourceHidden();
 
         static bool IsKeyValueTrue(string key, IDictionary<string, bool> dictionary) => dictionary.TryGetValue(key, out var value) && value;
     }
@@ -451,7 +451,7 @@ private void UpdateMenuButtons()
 
     private bool HasCollapsedResources()
     {
-        return _resourceByName.Any(r => !r.Value.IsHiddenState() && _collapsedResourceNames.Contains(r.Key));
+        return _resourceByName.Any(r => !r.Value.IsResourceHidden() && _collapsedResourceNames.Contains(r.Key));
     }
 
     private void UpdateMaxHighlightedCount()
@@ -619,7 +619,7 @@ private bool HasMultipleReplicas(ResourceViewModel resource)
         var count = 0;
         foreach (var (_, item) in _resourceByName)
         {
-            if (item.IsHiddenState())
+            if (item.IsResourceHidden())
             {
                 continue;
             }
@@ -693,7 +693,7 @@ private async Task OnToggleCollapse(ResourceGridViewModel viewModel)
     private async Task OnToggleCollapseAll()
     {
         var resourcesWithChildren = _resourceByName.Values
-            .Where(r => !r.IsHiddenState())
+            .Where(r => !r.IsResourceHidden())
             .Where(r => _resourceByName.Values.Any(nested => nested.GetResourcePropertyValue(KnownProperties.Resource.ParentName) == r.Name))
             .ToList();
 

src/Aspire.Dashboard/Extensions/ResourceViewModelExtensions.cs

@@ -7,11 +7,6 @@ namespace Aspire.Dashboard.Extensions;
 
 internal static class ResourceViewModelExtensions
 {
-    public static bool IsHiddenState(this ResourceViewModel resource)
-    {
-        return resource.KnownState is KnownResourceState.Hidden;
-    }
-
     public static bool IsRunningState(this ResourceViewModel resource)
     {
         return resource.KnownState is KnownResourceState.Running;

src/Aspire.Dashboard/Model/ResourceGraph/ResourceGraphMapper.cs

@@ -24,7 +24,7 @@ public static ResourceDto MapResource(ResourceViewModel r, IDictionary<string, R
         {
             var matches = resourcesByName.Values
                 .Where(r => string.Equals(r.DisplayName, resourceRelationships.Key, StringComparisons.ResourceName))
-                .Where(r => r.KnownState != KnownResourceState.Hidden)
+                .Where(r => !r.IsResourceHidden())
                 .ToList();
 
             foreach (var match in matches)

src/Aspire.Dashboard/Model/ResourceViewModel.cs

@@ -6,7 +6,6 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using Aspire.Dashboard.Components.Controls;
-using Aspire.Dashboard.Extensions;
 using Aspire.Dashboard.Utils;
 using Google.Protobuf.WellKnownTypes;
 using Humanizer;
@@ -39,6 +38,7 @@ public sealed class ResourceViewModel
     public required ImmutableArray<CommandViewModel> Commands { get; init; }
     /// <summary>The health status of the resource. <see langword="null"/> indicates that health status is expected but not yet available.</summary>
     public HealthStatus? HealthStatus { get; private set; }
+    public bool IsHidden { private get; init; }
 
     public required ImmutableArray<HealthReportViewModel> HealthReports
     {
@@ -79,6 +79,11 @@ internal bool MatchesFilter(string filter)
         return null;
     }
 
+    public bool IsResourceHidden()
+    {
+        return IsHidden || KnownState is KnownResourceState.Hidden;
+    }
+
     internal static HealthStatus? ComputeHealthStatus(ImmutableArray<HealthReportViewModel> healthReports, KnownResourceState? state)
     {
         if (state != KnownResourceState.Running)
@@ -100,7 +105,7 @@ public static string GetResourceName(ResourceViewModel resource, IDictionary<str
         var count = 0;
         foreach (var (_, item) in allResources)
         {
-            if (item.IsHiddenState())
+            if (item.IsResourceHidden())
             {
                 continue;
             }

src/Aspire.Dashboard/ResourceService/Partials.cs

@@ -41,6 +41,7 @@ public ResourceViewModel ToViewModel(IKnownPropertyLookup knownPropertyLookup, I
                 StateStyle = HasStateStyle ? StateStyle : null,
                 Commands = GetCommands(),
                 HealthReports = HealthReports.Select(ToHealthReportViewModel).OrderBy(vm => vm.Name).ToImmutableArray(),
+                IsHidden = IsHidden
             };
         }
         catch (Exception ex)

src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs

@@ -123,6 +123,11 @@ internal init
     /// </summary>
     public ImmutableArray<RelationshipSnapshot> Relationships { get; init; } = [];
 
+    /// <summary>
+    /// Whether this resource should be hidden in UI.
+    /// </summary>
+    public bool IsHidden { get; init; }
+
     internal static HealthStatus? ComputeHealthStatus(ImmutableArray<HealthReportSnapshot> healthReports, string? state)
     {
         if (state != KnownResourceStates.Running)
@@ -337,6 +342,7 @@ public static class KnownResourceStates
     /// <summary>
     /// The hidden state. Useful for hiding the resource.
     /// </summary>
+    [Obsolete("Use CustomResourceSnapshot.Hidden instead.")]
     public static readonly string Hidden = nameof(Hidden);
 
     /// <summary>

src/Aspire.Hosting/ConnectionStringBuilderExtensions.cs

@@ -44,7 +44,9 @@ public static IResourceBuilder<ConnectionStringResource> AddConnectionString(thi
                       {
                           ResourceType = "ConnectionString",
                           // TODO: We'll hide this until we come up with a sane representation of these in the dashboard
+#pragma warning disable CS0618 // Type or member is obsolete
                           State = KnownResourceStates.Hidden,
+#pragma warning restore CS0618 // Type or member is obsolete
                           Properties = []
                       });
     }

src/Aspire.Hosting/Dashboard/DashboardLifecycleHook.cs

@@ -173,7 +173,9 @@ private void ConfigureAspireDashboardResource(IResource dashboardResource)
             },
             State = configuration.GetBool(KnownConfigNames.ShowDashboardResources, KnownConfigNames.Legacy.ShowDashboardResources) is true
                 ? null
+#pragma warning disable CS0618 // Type or member is obsolete
                 : KnownResourceStates.Hidden
+#pragma warning restore CS0618 // Type or member is obsolete
         };
 
         dashboardResource.Annotations.Add(new ResourceSnapshotAnnotation(snapshot));

src/Aspire.Hosting/Dashboard/DashboardServiceData.cs

@@ -49,7 +49,8 @@ static GenericResourceSnapshot CreateResourceSnapshot(IResource resource, string
                     State = snapshot.State?.Text,
                     StateStyle = snapshot.State?.Style,
                     HealthReports = snapshot.HealthReports,
-                    Commands = snapshot.Commands
+                    Commands = snapshot.Commands,
+                    IsHidden = snapshot.IsHidden,
                 };
             }
 

src/Aspire.Hosting/Dashboard/ResourceSnapshot.cs

@@ -28,6 +28,7 @@ internal abstract class ResourceSnapshot
     public required ImmutableArray<RelationshipSnapshot> Relationships { get; init; }
     public required ImmutableArray<HealthReportSnapshot> HealthReports { get; init; }
     public required ImmutableArray<ResourceCommandSnapshot> Commands { get; init; }
+    public required bool IsHidden { get; init; }
 
     protected abstract IEnumerable<(string Key, Value Value, bool IsSensitive)> GetProperties();
 

src/Aspire.Hosting/Dashboard/proto/Partials.cs

@@ -18,6 +18,7 @@ public static Resource FromSnapshot(ResourceSnapshot snapshot)
             Uid = snapshot.Uid,
             State = snapshot.State ?? "",
             StateStyle = snapshot.StateStyle ?? "",
+            IsHidden = snapshot.IsHidden
         };
 
         if (snapshot.CreationTimeStamp.HasValue)

src/Aspire.Hosting/Dashboard/proto/resource_service.proto

@@ -237,6 +237,9 @@ message Resource {
 
     // The list of relationships for this resource.
     repeated ResourceRelationship relationships = 20;
+
+    // Whether the resource should be visually hidden in the dashboard.
+    bool is_hidden = 21;
 }
 
 ////////////////////////////////////////////

src/Aspire.Hosting/Dcp/ResourceSnapshotBuilder.cs

@@ -24,7 +24,9 @@ public CustomResourceSnapshot ToSnapshot(Container container, CustomResourceSnap
         var volumes = GetVolumes(container);
 
         var environment = GetEnvironmentVariables(container.Status?.EffectiveEnv ?? container.Spec.Env, container.Spec.Env);
+#pragma warning disable CS0618 // Type or member is obsolete
         var state = container.AppModelInitialState == KnownResourceStates.Hidden ? KnownResourceStates.Hidden : container.Status?.State;
+#pragma warning restore CS0618 // Type or member is obsolete
 
         var relationships = ImmutableArray<RelationshipSnapshot>.Empty;
 

src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs

@@ -152,17 +152,19 @@ private static string GetParameterValue(ConfigurationManager configuration, stri
         configurationKey ??= $"Parameters:{name}";
         return configuration[configurationKey]
             ?? parameterDefault?.GetDefaultValue()
-            ?? throw new DistributedApplicationException($"Parameter resource could not be used because configuration key '{configurationKey}' is missing and the Parameter has no default value."); ;
+            ?? throw new DistributedApplicationException($"Parameter resource could not be used because configuration key '{configurationKey}' is missing and the Parameter has no default value.");
     }
 
     internal static IResourceBuilder<T> AddParameter<T>(this IDistributedApplicationBuilder builder, T resource)
         where T : ParameterResource
     {
-        var state = new CustomResourceSnapshot()
+        var state = new CustomResourceSnapshot
         {
             ResourceType = "Parameter",
             // hide parameters by default
+#pragma warning disable CS0618 // Type or member is obsolete
             State = KnownResourceStates.Hidden,
+#pragma warning restore CS0618 // Type or member is obsolete
             Properties = [
                 new("parameter.secret", resource.Secret.ToString()),
                 new(CustomResourceKnownProperties.Source, resource.ConfigurationKey)

tests/Aspire.Dashboard.Components.Tests/Pages/ResourcesTests.cs

@@ -328,6 +328,7 @@ private static ResourceViewModel CreateResource(string name, string type, string
             Relationships = default,
             Properties = ImmutableDictionary<string, ResourcePropertyViewModel>.Empty,
             Commands = [],
+            IsHidden = false,
         };
     }
 }

tests/Aspire.Hosting.Tests/Dashboard/ResourcePublisherTests.cs

@@ -202,7 +202,8 @@ private static GenericResourceSnapshot CreateResourceSnapshot(string name)
             Environment = [],
             HealthReports = [],
             Commands = [],
-            Relationships = []
+            Relationships = [],
+            IsHidden = false
         };
     }
 

tests/Aspire.Playground.Tests/Infrastructure/DistributedApplicationExtensions.cs

@@ -89,6 +89,7 @@ public static Task WaitForResource(this DistributedApplication app, string resou
         return app.ResourceNotifications.WaitForResourceAsync(resourceName, targetState, cancellationToken);
     }
 
+#pragma warning disable CS0618 // Type or member is obsolete
     /// <summary>
     /// Waits for all resources in the application to reach one of the specified states.
     /// </summary>
@@ -102,6 +103,7 @@ public static Task WaitForResources(this DistributedApplication app, IEnumerable
 
         return Task.WhenAll(applicationModel.Resources.Select(r => app.ResourceNotifications.WaitForResourceAsync(r.Name, targetStates, cancellationToken)));
     }
+#pragma warning restore CS0618 // Type or member is obsolete
 
     /// <summary>
     /// Gets the app host and resource logs from the application.

tests/Shared/DashboardModel/ModelTestHelpers.cs

@@ -21,7 +21,8 @@ public static ResourceViewModel CreateResource(
         HealthStatus? reportHealthStatus = null,
         bool createNullHealthReport = false,
         ImmutableArray<CommandViewModel>? commands = null,
-        ImmutableArray<RelationshipViewModel>? relationships = null)
+        ImmutableArray<RelationshipViewModel>? relationships = null,
+        bool hidden = false)
     {
         return new ResourceViewModel
         {
@@ -42,6 +43,7 @@ public static ResourceViewModel CreateResource(
             HealthReports = reportHealthStatus is null && !createNullHealthReport ? [] : [new HealthReportViewModel("healthcheck", reportHealthStatus, null, null)],
             Commands = commands ?? [],
             Relationships = relationships ?? [],
+            IsHidden = hidden
         };
     }
 }