Skip to content

Add hidden to protocol, support in dashboard #9069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
May 3, 2025
Merged

Add hidden to protocol, support in dashboard #9069

merged 3 commits into from
May 3, 2025

Conversation

@adamint
Copy link
Member

@adamint adamint commented May 2, 2025 •
edited
Loading

Description

First part of #9063, adds the hidden attribute and consumes it in the dashboard. @mitchdenny

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes (added one small mapping test)
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?

@adamint adamint requested review from JamesNK and davidfowl May 2, 2025 02:43
davidfowl
davidfowl reviewed May 2, 2025
View reviewed changes
src/Aspire.Hosting/Dashboard/proto/resource_service.proto Outdated
repeated ResourceRelationship relationships = 20;

// Whether the resource should be visually hidden in the dashboard.
bool hidden = 21;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is optional bool a thing @JamesNK? We need to distinguish false and not set.

if you have state “Hidden” and Hidden false what does it mean @adamint ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want a tri state bool.

IMO a resource is hidden if hidden property is true or the state is hidden (for backwards compatibility).

@mitchdenny
Copy link
Member

@adamint I'm working on a copy of your branch integrating the changes I just merged to main and its looking like the dashboard resource is showing up in the dashboard even though the Hidden field is set to true. Are we not filtering on that flag yet in the PR?

JamesNK
JamesNK requested changes May 2, 2025
View reviewed changes
Copy link
Member

@JamesNK JamesNK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All other bool properties follow is_xxx naming standard.

@dotnet-policy-service dotnet-policy-service bot added the needs-author-action An issue or pull request that requires more info or actions from the author. label May 2, 2025
@mitchdenny
Copy link
Member

@adamint please confirm that this works for the dashboard resource.

@adamint
Copy link
Member Author

adamint commented May 2, 2025

@adamint I'm working on a copy of your branch integrating the changes I just merged to main and its looking like the dashboard resource is showing up in the dashboard even though the Hidden field is set to true. Are we not filtering on that flag yet in the PR?

@adamint please confirm that this works for the dashboard resource.

The hidden field is only set if the AppHost launch profile doesn't set ASPIRE_SHOW_DASHBOARD_RESOURCES to true. I've tested removing that property and the dashboard resource does not show up on the dashboard itself. Are you seeing something different?

@dotnet-policy-service dotnet-policy-service bot removed the needs-author-action An issue or pull request that requires more info or actions from the author. label May 2, 2025
@adamint adamint requested a review from JamesNK May 2, 2025 21:58
JamesNK
JamesNK approved these changes May 2, 2025
View reviewed changes
tests/Aspire.Playground.Tests/Infrastructure/DistributedApplicationExtensions.cs
return app.ResourceNotifications.WaitForResourceAsync(resourceName, targetState, cancellationToken);
}

#pragma warning disable CS0618 // Type or member is obsolete
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can you place these just around KnownResourceStates.Hidden in the method instead of the entire method

@davidfowl
Copy link
Member

Looking good!

@davidfowl davidfowl merged commit 157fdd4 into dotnet:main May 3, 2025
170 checks passed
@davidfowl davidfowl mentioned this pull request May 13, 2025
Merged
@github-actions github-actions bot locked and limited conversation to collaborators Jun 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@davidfowl davidfowl davidfowl left review comments

@JamesNK JamesNK JamesNK approved these changes

@radical radical Awaiting requested review from radical radical is a code owner

@eerhardt eerhardt Awaiting requested review from eerhardt eerhardt is a code owner

@mitchdenny mitchdenny Awaiting requested review from mitchdenny mitchdenny is a code owner

Assignees

No one assigned

Labels

area-dashboard

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@adamint @mitchdenny @davidfowl @JamesNK