-
-
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
Merged
+62
−5
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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; | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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(); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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