dotnet/runtime

Analyzer for STAThread attribute applied to async Main

Open

#78 502 ouverte le 17 nov. 2022

Voir sur GitHub
 (3 commentaires) (7 réactions) (0 assignés)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

Describe the problem you are trying to solve

When the [STAThread] attribute is applied to an async Main method, it does not have the intended effect (the main thread of the application is not created with the single-threaded apartment state). Since this gotcha seems to be fairly common (see e.g. https://github.com/dotnet/roslyn/issues/22112 and the issues linked to it), users should be made aware of it.

Describe suggestions on how to achieve the rule

I'm not certain if a code fix is necessary, but it could remove [STAThread] from the async Main method and then do one of the following:

  1. Add Thread.CurrentThread.SetApartmentState(ApartmentState.STA); at the start of the async Main method.
  2. Rename the async Main method to MainAsync and then add [STAThread] static void Main() => MainAsync().GetAwaiter().GetResult();.

Guide contributeur

Direction de recherche
Explorez l'infrastructure existante de l'analyseur Roslyn dans dotnet/runtime (voir les analyseurs dans src/libraries/System.Runtime.Analyzers). Comprenez comment implémenter un analyseur de diagnostic qui détecte STAThread sur Main asynchrone. Considérez les deux correctifs de code possibles décrits dans l'issue. Consultez l'issue liée dotnet/roslyn#22112 pour un contexte supplémentaire. Testez l'analyseur avec des méthodes Main asynchrones d'exemple.
Stack technique
csharp
Domaine
toolingdeveloper experience
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.
Une demi journée
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 analyzer basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60