dotnet/runtime

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

Offen

#78.397 geöffnet am 15.11.2022

Auf GitHub ansehenContributor Guide
 (7 Kommentare) (11 Reaktionen) (1 zugewiesene Person)C# (5.445 Forks)batch import
api-approvedarea-System.Threading.Taskscode-analyzerhelp wanted

Repository-Metriken

Stars
 (17.886 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 12T 11h) (661 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Durchsuchen Sie die Roslyn Analyzer Dokumentation und implementieren Sie eine Diagnose, die asynchrone Methoden (async oder Task/ValueTask zurückgebend) ohne einen CancellationToken Parameter kennzeichnet. Erwägen Sie, sie standardmäßig zu deaktivieren und den Schweregrad als Vorschlag festzulegen.
Tech Stack
csharp
Domain
tooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#Roslyn analyzersasync/awaitCancellationToken
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50