Support all return types from handler in filters #41310
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
captainsafia
added
old-area-web-frameworks-do-not-use
captainsafia
requested review from
Tratcher,
BrennanConroy and
halter73
as code owners
halter73
reviewed
Apr 21, 2022
halter73
reviewed
Apr 21, 2022
halter73
reviewed
Apr 21, 2022
halter73
reviewed
Apr 21, 2022
davidfowl
reviewed
Apr 22, 2022
halter73
approved these changes
Apr 22, 2022
captainsafia
added
the
Servicing-consider
|
Hi @captainsafia. Please make sure you've updated the PR description to use the Shiproom Template. Also, make sure this PR is not marked as a draft and is ready-to-merge. To learn more about how to prepare a servicing PR click here. |
captainsafia
added
Servicing-approved
|
Approved via email. @dotnet/aspnet-build Can I get help merging? |
JamesNK
reviewed
Apr 25, 2022
@captainsafia do you want to address @JamesNK's comment before this goes in❔ |
Yep, it's done. |
|
@captainsafia You've removed the wrong line. We want to observe in that method because it's a ValueTask. |
JamesNK
reviewed
Apr 26, 2022
JamesNK
approved these changes
Apr 26, 2022
captainsafia
added a commit
that referenced
this pull request
Apr 26, 2022
* Support all return types from handler in filters * Address feedback from peer review * Fix up Task and ValueTask handling * ExecuteAwait to ExecuteAwaited * Actually await void-returning Tasks and ValueTasks * Update comment for new logic * Polish and update tests * Tweaks and test fixes * Tweak await of void-returning Task * Fix correct ExecuteTask invocation
captainsafia
added a commit
that referenced
this pull request
Apr 26, 2022
* Support all return types from handler in filters * Address feedback from peer review * Fix up Task and ValueTask handling * ExecuteAwait to ExecuteAwaited * Actually await void-returning Tasks and ValueTasks * Update comment for new logic * Polish and update tests * Tweaks and test fixes * Tweak await of void-returning Task * Fix correct ExecuteTask invocation
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.
This PR fixes an issue where users could not apply route handler filters to endpoints that returned void, void-returning
Tasks andValueTasks, and genericValueTaskorTask.Technical Detail
The current implementation of filters has logic that wraps the user provided handler into a method that complies with the
RouteHandlerFilterDelegateSignature, namely it must return aValueTask<object?>and take in aRouteHandlerInvocationContext. To map the return types correctly, the implementation previously indiscriminately appliedValueTask.FromResult<object?>()to whatever the route handler returned. This meant that you could sometimes have invocations likeValueTask.FromResult(VoidReturningMethod())orValueTask.FromResult(new Task("foo")).To resolve this issue, we are improving the mapping of route handler types to
ValueTask<object?>to account for three scenarios:TaskandValueTaskTaskandValueTaskFixes #41213
Customer Impact
Without this fix, customers are not able to apply route handler filters to any endpoint in their application with running into exceptions or strange behavior. This bug fix allows us to achieve the stated goal of filters being applicable on all endpoints.
Regression?
Risk
Change was validated manually and with automated tests. Surface area of change limited to user code that has handlers with the 3 return types outlined above.
Verification
Packaging changes reviewed?