Complain when returning IActionResult from route handlers #35572
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-infrastructure
|
Backport tot RC1 right? This needs a rebase on @halter73's rename. |
davidfowl
reviewed
Aug 21, 2021
|
|
||
| private static ITypeSymbol UnwrapPossibleAsyncReturnType(ITypeSymbol returnType) | ||
| { | ||
| if (returnType is not INamedTypeSymbol { Name: "Task" or "ValueTask", IsGenericType: true, TypeArguments: { Length: 1 } } taskLike) |
There was a problem hiding this comment.
Can't wait until we get list patterns. This is beautiful.
davidfowl
reviewed
Aug 21, 2021
src/Framework/Analyzer/test/MinimalActions/DisallowReturningActionResultsFromMapMethodsTest.cs
Outdated
Show resolved
Hide resolved
davidfowl
reviewed
Aug 21, 2021
| var diagnostic = Assert.Single(diagnostics); | ||
| Assert.Same(DiagnosticDescriptors.DoNotReturnActionResultsFromMapActions, diagnostic.Descriptor); | ||
| AnalyzerAssert.DiagnosticLocation(source.DefaultMarkerLocation, diagnostic.Location); | ||
| Assert.Equal("IActionResult instances should not be returned from a MapGet delegate parameter. Consider returning an equivalent result from Microsoft.AspNetCore.Http.Results.", diagnostic.GetMessage()); |
There was a problem hiding this comment.
We could go crazy here and make figure out the suggestion based on the context (you could even do a codefix).
davidfowl
reviewed
Aug 21, 2021
| } | ||
|
|
||
| [Fact] | ||
| public async Task MinimalAction_ReturningActionResultFromMethodReference_ProducesDiagnostics() |
There was a problem hiding this comment.
Intra-method analysis too? Impressive 😄
pranavkm
force-pushed
the
prkrishn/action-result-returning-analyzer
branch
from
f3bb75e to
1131f1f
Compare
pranavkm
force-pushed
the
prkrishn/action-result-returning-analyzer
branch
from
1131f1f to
6373715
Compare
davidfowl
approved these changes
Aug 21, 2021
davidfowl
added
feature-minimal-actions
|
If you want a stretch goal, write a fixer that suggests the right Results.* to use 😉 |
…tionResultsFromMapMethodsTest.cs
|
/backport to release/6.0-rc1 |
|
Started backporting to release/6.0-rc1: https://github.com/dotnet/aspnetcore/actions/runs/1154640829 |
|
@pranavkm backporting to release/6.0-rc1 failed, the patch most likely resulted in conflicts: $ git am --3way --ignore-whitespace --keep-non-patch changes.patch
Applying: Complain when returning IActionResult from MinimalAction
.git/rebase-apply/patch:573: new blank line at EOF.
+
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
A src/Framework/Analyzer/src/DelegateEndpoints/DelegateEndpointAnalyzer.cs
A src/Framework/Analyzer/src/DelegateEndpoints/DiagnosticDescriptors.cs
A src/Framework/Analyzer/src/DelegateEndpoints/WellKnownTypes.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Framework/Analyzer/src/MinimalActions/WellKnownTypes.cs
Auto-merging src/Framework/Analyzer/src/MinimalActions/MinimalActionAnalyzer.cs
CONFLICT (content): Merge conflict in src/Framework/Analyzer/src/MinimalActions/MinimalActionAnalyzer.cs
Auto-merging src/Framework/Analyzer/src/MinimalActions/DiagnosticDescriptors.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Complain when returning IActionResult from MinimalAction
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128Please backport manually! |
|
/backport to release/6.0 |
|
Started backporting to release/6.0: https://github.com/dotnet/aspnetcore/actions/runs/1167415731 |
davidfowl
changed the title
amcasey
added
the
area-minimal
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.
Contributes to #35528