dotnet/runtime

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

Open

#78,397 opened on 2022年11月15日

GitHub で見る
 (7 comments) (11 reactions) (1 assignee)C# (5,445 forks)batch import
api-approvedarea-System.Threading.Taskscode-analyzerhelp wanted

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (平均マージ 12d 11h) (30d で 661 merged PRs)

説明

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
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
3-5日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
C#Roslyn analyzersasync/awaitCancellationToken
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50