dotnet/runtime

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

Open

#78.397 aberto em 15 de nov. de 2022

Ver no GitHub
 (7 comments) (11 reactions) (1 assignee)C# (5.445 forks)batch import
api-approvedarea-System.Threading.Taskscode-analyzerhelp wanted

Métricas do repositório

Stars
 (17.886 stars)
Métricas de merge de PR
 (Mesclagem média 12d 11h) (661 fundiu PRs em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Explore a documentação do analisador Roslyn e implemente um diagnóstico que sinalize métodos assíncronos (async ou que retornam Task/ValueTask) sem um parâmetro CancellationToken. Considere desativá lo por padrão com gravidade de sugestão.
Pilha de tecnologia
csharp
Domain
tooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
3-5 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C#Roslyn analyzersasync/awaitCancellationToken
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50