Add analyzer to detect use of Task<T>.ConfigureAwait with ConfigureAwaitOptions.SuppressThrowing #6669
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
Youssef1313
reviewed
Jun 5, 2023
...tAnalyzers/Core/Microsoft.NetCore.Analyzers/Tasks/DoNotConfigureAwaitWithSuppressThrowing.cs
Outdated
Show resolved
Hide resolved
…aitOptions.SuppressThrowing .NET 8 introduces new overloads of ConfigureAwait. One of the options is SuppressThrowing, but it's not supported by `Task<T>`, since that would then lead to returning a possibly invalid T. This rule flags use of SuppressThrowing so that you get a build-time rather than execution-time error.
stephentoub
force-pushed
the
configureawaitoptions
branch
from
2ad880d to
8045013
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #6669 +/- ##
==========================================
- Coverage 96.40% 96.39% -0.01%
==========================================
Files 1379 1381 +2
Lines 322253 322401 +148
Branches 10460 10463 +3
==========================================
+ Hits 310657 310794 +137
- Misses 9103 9112 +9
- Partials 2493 2495 +2 |
mavasani
approved these changes
Jun 19, 2023
|
|
||
| Rule ID | Category | Severity | Notes | ||
| --------|----------|----------|------- | ||
| CA2261 | Usage | Warning | DoNotUseConfigureAwaitWithSuppressThrowing, [Documentation](https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2250) |
There was a problem hiding this comment.
Should this be https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2261 ?
I believe this is the equivalent line in main:
Member
Author
There was a problem hiding this comment.
Yes. No idea how it ended up like that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
.NET 8 introduces new overloads of ConfigureAwait. One of the options is SuppressThrowing, but it's not supported by
Task<T>, since that would then lead to returning a possibly invalid T. This rule flags use of SuppressThrowing so that you get a build-time rather than execution-time error.Contributes to dotnet/runtime#22144 (comment)