dotnet/runtime

Analyzer for STAThread attribute applied to async Main

Open

#78.502 aberto em 17 de nov. de 2022

Ver no GitHub
 (3 comments) (7 reactions) (0 assignees)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

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();.

Guia do colaborador

Direção de pesquisa
Explore a infraestrutura existente do analisador Roslyn em dotnet/runtime (veja os analisadores em src/libraries/System.Runtime.Analyzers). Entenda como implementar um analisador de diagnóstico que detecta STAThread em Main assíncrono. Considere as duas possíveis correções de código descritas na issue. Revise a issue vinculada dotnet/roslyn#22112 para contexto adicional. Teste o analisador com métodos Main assíncronos de exemplo.
Pilha de tecnologia
csharp
Domain
toolingdeveloper experience
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.
Meio dia
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 analyzer basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60