Fix up handling for awaitable IResults in ApiExplorer #57068
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
area-mvc
amcasey
reviewed
Jul 29, 2024
| @@ -228,6 +228,13 @@ private static List<IApiResponseMetadataProvider> GetResponseMetadataAttributes( | |||
|
|
|||
| foreach (var metadata in responseMetadata) | |||
| { | |||
| // `IResult` metadata inserted for awaitable types should | |||
There was a problem hiding this comment.
I can't tell from this comment whether IResult only appears because we inserted it. Is there a case where it's present legitimately and we shouldn't skip it?
There was a problem hiding this comment.
It's theoritically feasible that IResult could appear there if someone manually insert it by doing something like:
app.MapGet()
.Produces<IResult>("application/json");In either case, it still stands that IResult doesn't provide us with type information specific enough to include in the response type information.
There was a problem hiding this comment.
What about something like "IResult (usually inserted for awaitable types) isn't useful..."?
1 task
amcasey
approved these changes
Jul 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #56975.
I introduced in a regression in 8da6daa that meant that
IResulttypes (which don't expose any metadata) were erroneously inserted intoApiResponseTypes. This regression wasn't caught because the test cases that existed optimized for void-returning awaitables and didn't factor in result types that implementedIEndpointMetadataProvider.To resolve this issue, I've made some changes to treat
IResult-types directly in the response and those included in metadata as void responses that should not map toApiResponseTypes. I also included additional tests for handling of typed results in ApiExplorer.