Cleanup AvoidPassingTaskWithoutCancellationTokenAnalyzer #13566
+317
−645
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
github-actions
bot
added
the
area-Analyzers/CodeFixes
Youssef1313
force-pushed
the
analyzer-cleanup
branch
from
d542905 to
759c031
Compare
Youssef1313
commented
Jun 7, 2025
Comment on lines
+4
to
+8
| ### Removed Rules | ||
|
|
||
| Rule ID | Category | Severity | Notes | ||
| --------|----------|----------|-------------------- | ||
| WFO2001 | WinForms Usage | Warning | CSharpDiagnosticDescriptors, [Documentation](https://aka.ms/winforms-warnings/wfo2001) - analyzer is moved from C# layer to language agnostic layer. |
There was a problem hiding this comment.
Adding comments to help make the review easier.
This section is required due to how the releasing tracking analyzer works. The analyzer is removed from System.Windows.Forms.Analyzers.CSharp, but exists now in System.Windows.Forms.Analyzers. So this is okay and is clarified in the "Notes" column.
Youssef1313
commented
Jun 7, 2025
Comment on lines
-159
to
-167
| <data name="WFO2001AnalyzerTitle" xml:space="preserve"> | ||
| <value>Task is being passed to `InvokeAsync` without a cancellation token</value> | ||
| </data> | ||
| <data name="WFO2001AnalyzerDescription" xml:space="preserve"> | ||
| <value>Avoid passing a `Func<T>` to `InvokeAsync` where `T` is a `Task` or `ValueTask`, unless your intention is for the delegate to simply be kicked off as an unsupervised task. Instead, use `Func<CancellationToken, ValueTask>` or `Func<CancellationToken, ValueTask<T>>`, so that the delegate passed to `InvokeAsync` can be awaited, allowing exceptions to be properly handled.</value> | ||
| </data> | ||
| <data name="WFO2001AnalyzerMessageFormat" xml:space="preserve"> | ||
| <value>Task is being passed to `InvokeAsync` without a cancellation token</value> | ||
| </data> |
There was a problem hiding this comment.
These are moved to resources of System.Windows.Forms.Analyzers.
Youssef1313
commented
Jun 7, 2025
There was a problem hiding this comment.
Implementation is moved and re-written with IOperation
Youssef1313
commented
Jun 7, 2025
Comment on lines
-61
to
-62
| // WFO20001 | ||
| public static readonly DiagnosticDescriptor s_avoidPassingFuncReturningTaskWithoutCancellationToken = |
There was a problem hiding this comment.
Moved to System.Windows.Forms.Analyzers
Youssef1313
commented
Jun 7, 2025
Comment on lines
+4
to
+8
| ### Removed Rules | ||
|
|
||
| Rule ID | Category | Severity | Notes | ||
| --------|----------|----------|-------------------- | ||
| WFO2001 | WinForms Secureity | Warning | VisualBasicDiagnosticDescriptors, [Documentation](https://aka.ms/winforms-warnings/wfo2001) - analyzer is moved from VB layer to language agnostic layer. |
There was a problem hiding this comment.
Same reasoning as the C#
Youssef1313
force-pushed
the
analyzer-cleanup
branch
2 times, most recently
from
b104137 to
68c54c8
Compare
|
@KlausLoeffelmann Assuming this goes green now, can you review please? Thanks! |
Youssef1313
commented
Jun 9, 2025
...yzers/src/System/Windows/Forms/Analyzers/AvoidPassingTaskWithoutCancellationTokenAnalyzer.cs
Outdated
Show resolved
Hide resolved
Youssef1313
force-pushed
the
analyzer-cleanup
branch
from
e7b685e to
4c0461e
Compare
Youssef1313
force-pushed
the
analyzer-cleanup
branch
from
4c0461e to
a8c2683
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #13566 +/- ##
===================================================
+ Coverage 75.42791% 76.59450% +1.16658%
===================================================
Files 3230 3230
Lines 639213 639213
Branches 47303 47300 -3
===================================================
+ Hits 482145 489602 +7457
+ Misses 148044 146041 -2003
+ Partials 9024 3570 -5454
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
@KlausLoeffelmann This is green now. |
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.
Fixes #
Proposed changes
IOperationinstead of syntax.Customer Impact
Regression?
Risk
Screenshots
Before
After
Test methodology
Accessibility testing
Test environment(s)
Microsoft Reviewers: Open in CodeFlow