Skip to content
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

Improve endpoint metadata debugging #48207

Merged
merged 27 commits into from
May 19, 2023
Merged

Improve endpoint metadata debugging #48207

merged 27 commits into from
May 19, 2023

Conversation

JamesNK
Copy link
Member

@JamesNK JamesNK commented May 12, 2023 •
edited
Loading

Fixes #39792

This PR:

  • Adds ToString implementations to many types used as metadata on endpoints
  • Adds DebuggerDisplayAttribute that uses the ToString
  • Adds display and proxy attributes to EndpointMetadataCollection

Replaces #47163 by @SeanFarrow

Before:

image

After:

image

SeanFarrow and others added 18 commits May 10, 2023 08:50
@SeanFarrow
Override the ToString method in the DataTokensMetadata class.
bbd0058
@SeanFarrow
Override the ToString method in the EndpointNameMetadata class.
6252be4
@SeanFarrow
Override the ToString method in the HostAttribute class.
9bcccae
@SeanFarrow
Use the overridden ToString method of the HostAttribute class rather …
ae62eec 
…than specifically implementing aDebuggerToString method.
@SeanFarrow
Override the ToString method in the HttpMethodMetadata class.
c622400
@SeanFarrow
Use the ToString method of the HttpMethodMetadata for debugging and r…
2810c06 
…emove the DebuggerToString method.
@SeanFarrow
Override the ToString method in the RouteNameMetadata class.
b4e3786
@SeanFarrow
Use the newly implemented ToString method instead of DebuggerToString…
19e069c 
… in the RouteNameMetadata class.
@SeanFarrow
Override the ToString method in the SuppressLinkGenerationMetadata cl…
a388d8e 
…ass.
@SeanFarrow
Override the ToString method in the SuppressMatchingMetadata class.
3cf3bb1
@SeanFarrow
Update the ToString method of the DataTokensMetadata class to remove …
1dcbd3f 
…the use of StringBuilder.
@SeanFarrow
Override the ToString method in the DataTokensMetadata class.
9000058
@SeanFarrow
Override the ToString method in the HostAttribute class.
fc093b2
@SeanFarrow
Override the ToString method in the HttpMethodMetadata class.
1c2cc7f
@SeanFarrow
Override the ToString method in the RouteNameMetadata class.
17ec7f6
@SeanFarrow
Update the ToString method of the DataTokensMetadata class to remove …
4f2b05a 
…the use of StringBuilder.
@JamesNK
Clean up, collection proxy, extra attributes
72d493e
@JamesNK
Update
ee43ced
@JamesNK JamesNK mentioned this pull request May 12, 2023
Closed
@JamesNK JamesNK mentioned this pull request May 12, 2023
Open
11 tasks
@JamesNK JamesNK requested a review from a team as a code owner May 12, 2023 10:29
Tratcher
Tratcher approved these changes May 12, 2023
View reviewed changes
src/Http/Routing/src/SuppressLinkGenerationMetadata.cs Outdated Show resolved Hide resolved
src/Middleware/CORS/src/EnableCorsAttribute.cs Outdated Show resolved Hide resolved
src/Security/Authorization/Core/src/AuthorizeAttribute.cs Outdated Show resolved Hide resolved
amcasey
amcasey approved these changes May 12, 2023
View reviewed changes
Copy link
Member

@amcasey amcasey left a comment

Choose a reason for hiding this comment

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

Minor questions, but LGTM

src/Http/Http.Abstractions/src/Routing/EndpointMetadataCollection.cs Show resolved Hide resolved
src/Http/Http.Extensions/src/TagsAttribute.cs Outdated Show resolved Hide resolved
src/Http/Routing/src/SuppressLinkGenerationMetadata.cs Outdated Show resolved Hide resolved
src/Middleware/CORS/src/DisableCorsAttribute.cs Outdated Show resolved Hide resolved
@JamesNK
Copy link
Member Author

JamesNK commented May 17, 2023

@Tratcher I added a helper method for building up a debug string for types. There are some allocations (the values array, string builder), but these methods are unlikely to ever be used on a hot path. Could avoid the values array in most cases by adding something like TagList, but I'm not concerned about perf here so I skipped it.

What do you think?

@JamesNK JamesNK merged commit ba58563 into main May 19, 2023
@JamesNK JamesNK deleted the SeanFarrow-feature/sf/39792-improve-endpoint-metadata-debugging branch May 19, 2023 01:28
@ghost ghost added this to the 8.0-preview5 milestone May 19, 2023
@amcasey amcasey added area-middleware Includes: URL rewrite, redirect, response cache/compression, session, and other general middlesware and removed area-runtime labels Jun 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amcasey amcasey amcasey approved these changes

@Tratcher Tratcher Tratcher approved these changes

@javiercn javiercn Awaiting requested review from javiercn

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

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

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

Assignees
No one assigned
Labels
area-middleware Includes: URL rewrite, redirect, response cache/compression, session, and other general middlesware
Projects
None yet
Milestone
8.0-preview5
Development

Successfully merging this pull request may close these issues.

Improve endpoint metadata debugging by overriding ToString
4 participants
@JamesNK @Tratcher @amcasey @SeanFarrow