dotnet/runtime

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

Open

#78 397 ouverte le 15 nov. 2022

Voir sur GitHub
 (7 commentaires) (11 réactions) (1 assigné)C# (5 445 forks)batch import
api-approvedarea-System.Threading.Taskscode-analyzerhelp wanted

Métriques du dépôt

Stars
 (17 886 stars)
Métriques de merge PR
 (Merge moyen 12j 11h) (661 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Consultez la documentation de l'analyseur Roslyn et implémentez un diagnostic qui signale les méthodes asynchrones (async ou retournant Task/ValueTask) sans paramètre CancellationToken. Envisagez de le désactiver par défaut avec une gravité de suggestion.
Stack technique
csharp
Domaine
tooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#Roslyn analyzersasync/awaitCancellationToken
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50