dotnet/runtime

[Analyzer] Async methods that don't take a CancellationToken

開放

#78,397 建立於 2022年11月15日

在 GitHub 查看貢獻者指南
 (7 則留言) (11 個反應) (1 位負責人)C# (5,445 個分叉)batch import
api-approvedarea-System.Threading.Taskscode-analyzerhelp wanted

倉庫指標

星標
 (17,886 顆星)
PR 合併指標
 (平均合併 12天 11小時) (30 天內合併 661 個 PR)

描述

Cancellation is often important to the scalability of an app / service. If an async method has no way to cancel it, that can impact scalability and responsiveness. We should consider adding an analyzer (likely off by default due to noise) that flags async methods (async and/or Task/ValueTask-returning) that have no overloads which accept a CancellationToken, and issue a diagnostic to consider taking one.

貢獻者指南

研究方向
查閱 Roslyn 分析器文件，實作一個診斷規則，標記缺少 CancellationToken 參數的非同步方法（async 或回傳 Task/ValueTask 的方法）。考慮預設關閉，嚴重性設為建議。
技術棧
csharp
領域
tooling
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
3-5 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
C#Roslyn analyzersasync/awaitCancellationToken
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50