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