Skip to content

Treat missing .ConfigureAwait(false) as errors (and fix) #633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 10, 2021
Merged

Treat missing .ConfigureAwait(false) as errors (and fix) #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,11 @@ resharper_web_config_module_not_resolved_highlighting=warning
resharper_web_config_type_not_resolved_highlighting=warning
resharper_web_config_wrong_module_highlighting=warning

# .NET Analzyer settings
# VSTHRD200: Use "Async" suffix for awaitable methods
dotnet_diagnostic.VSTHRD200.severity = none
# CA2007: Do not directly await a Task
dotnet_diagnostic.CA2007.severity = error

[*.{cs,cshtml}]
charset=utf-8
Expand Down
2 changes: 2 additions & 0 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
<PackageProjectUrl>https://github.com/OmniSharp/csharp-language-server-protocol</PackageProjectUrl>
<PackageTags>lsp;language server;language server protocol;language client;language server client</PackageTags>
<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)\lsp.snk</AssemblyOriginatorKeyFile>
<!-- See: https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/overview -->
<EnableNETAnalyzers>true</EnableNETAnalyzers>
</PropertyGroup>
<PropertyGroup>
<EmbedUntrackedSources>true</EmbedUntrackedSources>
Expand Down
16 changes: 8 additions & 8 deletions sample/SampleServer/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ private static async Task MainAsync(string[] args)
);
workDone = manager;

await Task.Delay(2000);
await Task.Delay(2000).ConfigureAwait(false);

manager.OnNext(
new WorkDoneProgressReport {
Expand All @@ -102,7 +102,7 @@ private static async Task MainAsync(string[] args)
}
);

await Task.Delay(2000);
await Task.Delay(2000).ConfigureAwait(false);

workDone.OnNext(
new WorkDoneProgressReport {
Expand All @@ -115,12 +115,12 @@ private static async Task MainAsync(string[] args)
)
.OnStarted(
async (languageServer, token) => {
using var manager = await languageServer.WorkDoneManager.Create(new WorkDoneProgressBegin { Title = "Doing some work..." });
using var manager = await languageServer.WorkDoneManager.Create(new WorkDoneProgressBegin { Title = "Doing some work..." }).ConfigureAwait(false);

manager.OnNext(new WorkDoneProgressReport { Message = "doing things..." });
await Task.Delay(10000);
await Task.Delay(10000).ConfigureAwait(false);
manager.OnNext(new WorkDoneProgressReport { Message = "doing things... 1234" });
await Task.Delay(10000);
await Task.Delay(10000).ConfigureAwait(false);
manager.OnNext(new WorkDoneProgressReport { Message = "doing things... 56789" });

var logger = languageServer.Services.GetService<ILogger<Foo>>();
Expand All @@ -130,7 +130,7 @@ private static async Task MainAsync(string[] args)
}, new ConfigurationItem {
Section = "terminal",
}
);
).ConfigureAwait(false);

var baseConfig = new JObject();
foreach (var config in languageServer.Configuration.AsEnumerable())
Expand All @@ -149,9 +149,9 @@ private static async Task MainAsync(string[] args)
logger.LogInformation("Scoped Config: {Config}", scopedConfig);
}
)
);
).ConfigureAwait(false);

await server.WaitForExit;
await server.WaitForExit.ConfigureAwait(false);
}
}

Expand Down
8 changes: 4 additions & 4 deletions sample/SampleServer/SemanticTokensHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ public SemanticTokensHandler(ILogger<SemanticTokensHandler> logger) =>
SemanticTokensParams request, CancellationToken cancellationToken
)
{
var result = await base.Handle(request, cancellationToken);
var result = await base.Handle(request, cancellationToken).ConfigureAwait(false);
return result;
}

public override async Task<SemanticTokens?> Handle(
SemanticTokensRangeParams request, CancellationToken cancellationToken
)
{
var result = await base.Handle(request, cancellationToken);
var result = await base.Handle(request, cancellationToken).ConfigureAwait(false);
return result;
}

Expand All @@ -42,7 +42,7 @@ public SemanticTokensHandler(ILogger<SemanticTokensHandler> logger) =>
CancellationToken cancellationToken
)
{
var result = await base.Handle(request, cancellationToken);
var result = await base.Handle(request, cancellationToken).ConfigureAwait(false);
return result;
}

Expand All @@ -54,7 +54,7 @@ CancellationToken cancellationToken
using var typesEnumerator = RotateEnum(SemanticTokenType.Defaults).GetEnumerator();
using var modifiersEnumerator = RotateEnum(SemanticTokenModifier.Defaults).GetEnumerator();
// you would normally get this from a common source that is managed by current open editor, current active editor, etc.
var content = await File.ReadAllTextAsync(DocumentUri.GetFileSystemPath(identifier), cancellationToken);
var content = await File.ReadAllTextAsync(DocumentUri.GetFileSystemPath(identifier), cancellationToken).ConfigureAwait(false);
await Task.Yield();

foreach (var (line, text) in content.Split('\n').Select((text, line) => (line, text)))
Expand Down
14 changes: 7 additions & 7 deletions sample/SampleServer/TextDocumentHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public override async Task<Unit> Handle(DidOpenTextDocumentParams notification,
{
await Task.Yield();
_logger.LogInformation("Hello world!");
await _configuration.GetScopedConfiguration(notification.TextDocument.Uri, token);
await _configuration.GetScopedConfiguration(notification.TextDocument.Uri, token).ConfigureAwait(false);
return Unit.Value;
}

Expand Down Expand Up @@ -84,7 +84,7 @@ CancellationToken cancellationToken
)
{
// you would normally get this from a common source that is managed by current open editor, current active editor, etc.
var content = await File.ReadAllTextAsync(DocumentUri.GetFileSystemPath(request), cancellationToken);
var content = await File.ReadAllTextAsync(DocumentUri.GetFileSystemPath(request), cancellationToken).ConfigureAwait(false);
var lines = content.Split('\n');
var symbols = new List<SymbolInformationOrDocumentSymbol>();
for (var lineIndex = 0; lineIndex < lines.Length; lineIndex++)
Expand Down Expand Up @@ -160,31 +160,31 @@ CancellationToken cancellationToken
using var partialResults = _progressManager.For(request, cancellationToken);
if (partialResults != null)
{
await Task.Delay(2000, cancellationToken);
await Task.Delay(2000, cancellationToken).ConfigureAwait(false);

reporter.OnNext(
new WorkDoneProgressReport {
Cancellable = true,
Percentage = 20
}
);
await Task.Delay(500, cancellationToken);
await Task.Delay(500, cancellationToken).ConfigureAwait(false);

reporter.OnNext(
new WorkDoneProgressReport {
Cancellable = true,
Percentage = 40
}
);
await Task.Delay(500, cancellationToken);
await Task.Delay(500, cancellationToken).ConfigureAwait(false);

reporter.OnNext(
new WorkDoneProgressReport {
Cancellable = true,
Percentage = 50
}
);
await Task.Delay(500, cancellationToken);
await Task.Delay(500, cancellationToken).ConfigureAwait(false);

partialResults.OnNext(
new[] {
Expand All @@ -209,7 +209,7 @@ CancellationToken cancellationToken
Percentage = 70
}
);
await Task.Delay(500, cancellationToken);
await Task.Delay(500, cancellationToken).ConfigureAwait(false);

reporter.OnNext(
new WorkDoneProgressReport {
Expand Down
2 changes: 1 addition & 1 deletion src/Dap.Client/DebugAdapterClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ await DebugAdapterEventingHelper.Run(
token
).ConfigureAwait(false);

await _initializedComplete.ToTask(token, _scheduler);
await _initializedComplete.ToTask(token, _scheduler).ConfigureAwait(false);

await DebugAdapterEventingHelper.Run(
_startedDelegates,
Expand Down
2 changes: 1 addition & 1 deletion src/Dap.Testing/DebugAdapterProtocolTestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Action<DebugAdapterServerOptions> serverOptionsAction

return await Observable.FromAsync(_client.Initialize)
.ForkJoin(Observable.FromAsync(_server.Initialize), (_, _) => ( _client, _server ))
.ToTask(CancellationToken);
.ToTask(CancellationToken).ConfigureAwait(false);
}
}
}
2 changes: 1 addition & 1 deletion src/JsonRpc/OutputHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ private async Task ProcessOutputStream(CancellationToken cancellationToken)
{
do
{
var value = await _queue.ReadAsync(cancellationToken);
var value = await _queue.ReadAsync(cancellationToken).ConfigureAwait(false);
if (value is ITraceData traceData)
{
_activityTracingStrategy?.ApplyOutgoing(traceData);
Expand Down
2 changes: 1 addition & 1 deletion src/Protocol/Features/Document/CallHierarchyFeature.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ protected CallHierarchyHandlerBase() : this(Guid.NewGuid())

public sealed override async Task<Container<CallHierarchyItem>?> Handle(CallHierarchyPrepareParams request, CancellationToken cancellationToken)
{
var response = await HandlePrepare(request, cancellationToken);
var response = await HandlePrepare(request, cancellationToken).ConfigureAwait(false);
return Container<CallHierarchyItem>.From(response?.Select(CallHierarchyItem.From)!);
}

Expand Down
4 changes: 2 additions & 2 deletions src/Server/LanguageServer.Shutdown.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ public partial class LanguageServer : IExitHandler, IShutdownHandler
#pragma warning disable VSTHRD100
public async void ForcefulShutdown()
{
await ( (IShutdownHandler) this ).Handle(ShutdownParams.Instance, CancellationToken.None);
await ( (IExitHandler) this ).Handle(ExitParams.Instance, CancellationToken.None);
await ( (IShutdownHandler) this ).Handle(ShutdownParams.Instance, CancellationToken.None).ConfigureAwait(false);
await ( (IExitHandler) this ).Handle(ExitParams.Instance, CancellationToken.None).ConfigureAwait(false);
}

async Task<Unit> IRequestHandler<ExitParams, Unit>.Handle(ExitParams request, CancellationToken token)
Expand Down
1 change: 1 addition & 0 deletions test/.editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[*]
dotnet_diagnostic.CA2007.severity = none
dotnet_diagnostic.CS0618.severity = none
dotnet_diagnostic.CS4014.severity = none
dotnet_diagnostic.CS1998.severity = none
Expand Down