Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 2.3k
Add missing ConfigureAwait(false) to prevent deadlocks#2367
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.
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
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -45,7 +45,7 @@ public async Task<RestResponse<T>> ExecuteAsync<T>( | ||
| Ensure.NotNull(request, nameof(request)); | ||
| var response = await client.ExecuteAsync(request, cancellationToken).ConfigureAwait(false); | ||
| return await client.Serializers.Deserialize<T>(request, response, client.Options, cancellationToken); | ||
| return await client.Serializers.Deserialize<T>(request, response, client.Options, cancellationToken).ConfigureAwait(false); | ||
| } | ||
Comment on lines
45
to
49
Contributor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 2. Deadlock fix lacks tests This PR changes async flow to prevent sync-over-async deadlocks, but it does not add/update tests to cover the reported hang scenario. Without a regression test, the deadlock could reappear unnoticed. Agent Prompt
| ||
| /// <summary> | ||
| @@ -172,9 +172,9 @@ [EnumeratorCancellation] CancellationToken cancellationToken | ||
| using var reader = new StreamReader(stream); | ||
| #if NET7_0_OR_GREATER | ||
| while (await reader.ReadLineAsync(cancellationToken) is { } line && !cancellationToken.IsCancellationRequested) { | ||
| while (await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false) is { } line && !cancellationToken.IsCancellationRequested) { | ||
| #else | ||
| while (await reader.ReadLineAsync() is { } line && !cancellationToken.IsCancellationRequested) { | ||
| while (await reader.ReadLineAsync().ConfigureAwait(false) is { } line && !cancellationToken.IsCancellationRequested) { | ||
| #endif | ||
| if (string.IsNullOrWhiteSpace(line)) continue; | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| namespace RestSharp.Tests.Integrated; | ||
| #pragma warning disable xUnit1031 // Blocking calls in tests are intentional — we are testing sync-over-async deadlock safety | ||
| public sealed class SyncRequestTests(WireMockTestServer server) : IClassFixture<WireMockTestServer> { | ||
| [Fact] | ||
| public void Sync_execute_should_not_deadlock() { | ||
| // Regression test for https://github.com/restsharp/RestSharp/issues/2083 | ||
| // Sync methods (ExecuteGet) could deadlock when await calls inside the pipeline | ||
| // did not use ConfigureAwait(false), causing continuations to try to marshal | ||
| // back to a captured SynchronizationContext. | ||
| using var client = new RestClient(server.Url!); | ||
| var request = new RestRequest("success"); | ||
| RestResponse? response = null; | ||
| var completed = Task.Run(() => { | ||
| response = client.ExecuteGet(request); | ||
| }).Wait(TimeSpan.FromSeconds(10)); | ||
| completed.Should().BeTrue("sync ExecuteGet should complete without deadlocking"); | ||
| response.Should().NotBeNull(); | ||
| response!.IsSuccessStatusCode.Should().BeTrue(); | ||
| } | ||
| [Fact] | ||
| public void Sync_execute_with_deserialization_should_not_deadlock() { | ||
| using var client = new RestClient(server.Url!); | ||
| var request = new RestRequest("success"); | ||
| RestResponse<SuccessResponse>? response = null; | ||
| var completed = Task.Run(() => { | ||
| response = client.ExecuteGet<SuccessResponse>(request); | ||
| }).Wait(TimeSpan.FromSeconds(10)); | ||
| completed.Should().BeTrue("sync ExecuteGet<T> should complete without deadlocking"); | ||
| response.Should().NotBeNull(); | ||
| response!.IsSuccessStatusCode.Should().BeTrue(); | ||
| response.Data.Should().NotBeNull(); | ||
| } | ||
| [Fact] | ||
| public void Sync_execute_from_multiple_threads_should_not_deadlock() { | ||
| using var client = new RestClient(server.Url!); | ||
| const int threadCount = 5; | ||
| var completed = Parallel.For(0, threadCount, _ => { | ||
| var request = new RestRequest("success"); | ||
| var response = client.ExecuteGet(request); | ||
| response.IsSuccessStatusCode.Should().BeTrue(); | ||
| }); | ||
| completed.IsCompleted.Should().BeTrue(); | ||
| } | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Restresponse.cs header mismatch
📘 Rule violation✓ CorrectnessAgent Prompt
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools