fix: add ConfigureAwait on async code to avoid potential deadlocks

Vonage/Accounts/AccountClient.cs

@@ -9,22 +9,22 @@ public class AccountClient : IAccountClient
 {
     private readonly Configuration configuration;
     private readonly ITimeProvider timeProvider = new TimeProvider();
-
+    
     public AccountClient(Credentials creds = null)
     {
         this.Credentials = creds;
         this.configuration = Configuration.Instance;
     }
-
+    
     internal AccountClient(Credentials creds, Configuration configuration, ITimeProvider timeProvider)
     {
         this.Credentials = creds;
         this.configuration = configuration;
         this.timeProvider = timeProvider;
     }
-
+    
     public Credentials Credentials { get; set; }
-
+    
     /// <inheritdoc />
     public Task<AccountSettingsResult> ChangeAccountSettingsAsync(AccountSettingsRequest request,
         Credentials creds = null) =>
@@ -34,7 +34,7 @@ public Task<AccountSettingsResult> ChangeAccountSettingsAsync(AccountSettingsReq
                 ApiRequest.GetBaseUriFor(this.configuration, "/account/settings"),
                 request
             );
-
+    
     /// <inheritdoc />
     public Task<Secret> CreateApiSecretAsync(CreateSecretRequest request, string apiKey = null,
         Credentials creds = null) =>
@@ -45,14 +45,14 @@ public Task<Secret> CreateApiSecretAsync(CreateSecretRequest request, string api
                 request,
                 AuthType.Basic
             );
-
+    
     /// <inheritdoc />
     public Task<Balance> GetAccountBalanceAsync(Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
             .DoGetRequestWithQueryParametersAsync<Balance>(
                 ApiRequest.GetBaseUriFor(this.configuration, "/account/get-balance"),
                 AuthType.Query);
-
+    
     /// <inheritdoc />
     public Task<Secret> RetrieveApiSecretAsync(string secretId, string apiKey = null, Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -61,15 +61,15 @@ public Task<Secret> RetrieveApiSecretAsync(string secretId, string apiKey = null
                     $"/accounts/{apiKey}/secrets/{secretId}"),
                 AuthType.Basic
             );
-
+    
     /// <inheritdoc />
     public Task<SecretsRequestResult> RetrieveApiSecretsAsync(string apiKey = null, Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
             .DoGetRequestWithQueryParametersAsync<SecretsRequestResult>(
                 ApiRequest.GetBaseUri(ApiRequest.UriType.Api, this.configuration, $"/accounts/{apiKey}/secrets"),
                 AuthType.Basic
             );
-
+    
     /// <inheritdoc />
     public async Task<bool> RevokeApiSecretAsync(string secretId, string apiKey = null, Credentials creds = null)
     {
@@ -79,10 +79,10 @@ await ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.time
                     $"/accounts/{apiKey}/secrets/{secretId}"),
                 null,
                 AuthType.Basic
-            );
+            ).ConfigureAwait(false);
         return true;
     }
-
+    
     /// <inheritdoc />
     public Task<TopUpResult> TopUpAccountBalanceAsync(TopUpRequest request, Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -91,6 +91,6 @@ public Task<TopUpResult> TopUpAccountBalanceAsync(TopUpRequest request, Credenti
                 AuthType.Query,
                 request
             );
-
+    
     private Credentials GetCredentials(Credentials overridenCredentials) => overridenCredentials ?? this.Credentials;
 }

Vonage/Applications/ApplicationClient.cs

@@ -9,22 +9,22 @@ public class ApplicationClient : IApplicationClient
 {
     private readonly Configuration configuration;
     private readonly ITimeProvider timeProvider = new TimeProvider();
-
+    
     public ApplicationClient(Credentials creds = null)
     {
         this.Credentials = creds;
         this.configuration = Configuration.Instance;
     }
-
+    
     internal ApplicationClient(Credentials credentials, Configuration configuration, ITimeProvider timeProvider)
     {
         this.Credentials = credentials;
         this.configuration = configuration;
         this.timeProvider = timeProvider;
     }
-
+    
     public Credentials Credentials { get; set; }
-
+    
     /// <inheritdoc />
     public Task<Application> CreateApplicationAsync(CreateApplicationRequest request, Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -34,7 +34,7 @@ public Task<Application> CreateApplicationAsync(CreateApplicationRequest request
                 request,
                 AuthType.Basic
             );
-
+    
     /// <inheritdoc/>
     public async Task<bool> DeleteApplicationAsync(string id, Credentials creds = null)
     {
@@ -43,18 +43,18 @@ await ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.time
                 ApiRequest.GetBaseUri(ApiRequest.UriType.Api, this.configuration, $"/v2/applications/{id}"),
                 null,
                 AuthType.Basic
-            );
+            ).ConfigureAwait(false);
         return true;
     }
-
+    
     /// <inheritdoc/>
     public Task<Application> GetApplicationAsync(string id, Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
             .DoGetRequestWithQueryParametersAsync<Application>(
                 ApiRequest.GetBaseUri(ApiRequest.UriType.Api, this.configuration, $"/v2/applications/{id}"),
                 AuthType.Basic
             );
-
+    
     /// <inheritdoc/>
     public Task<ApplicationPage> ListApplicationsAsync(ListApplicationsRequest request, Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -63,7 +63,7 @@ public Task<ApplicationPage> ListApplicationsAsync(ListApplicationsRequest reque
                 AuthType.Basic,
                 request
             );
-
+    
     /// <inheritdoc/>
     public Task<Application> UpdateApplicationAsync(string id, CreateApplicationRequest request,
         Credentials creds = null) =>
@@ -74,6 +74,6 @@ public Task<Application> UpdateApplicationAsync(string id, CreateApplicationRequ
                 request,
                 AuthType.Basic
             );
-
+    
     private Credentials GetCredentials(Credentials overridenCredentials) => overridenCredentials ?? this.Credentials;
 }

Vonage/Common/Client/VonageHttpClient.cs

@@ -16,7 +16,7 @@ public class VonageHttpClient
     private readonly HttpClient client;
     private readonly IJsonSerializer jsonSerializer;
     private readonly Result<HttpClientOptions> requestOptions;
-
+    
     /// <summary>
     ///     Creates a custom Http Client for Vonage purposes.
     /// </summary>
@@ -30,24 +30,25 @@ public VonageHttpClient(VonageHttpClientConfiguration configuration, IJsonSerial
             .Map(header =>
                 new HttpClientOptions(header, UserAgentProvider.GetFormattedUserAgent(configuration.UserAgent)));
     }
-
+    
     /// <summary>
     ///     Sends a HttpRequest.
     /// </summary>
     /// <param name="request">The request to send.</param>
     /// <returns>Success if the operation succeeds, Failure it if fails.</returns>
     public async Task<Result<Unit>> SendAsync<T>(Result<T> request) where T : IVonageRequest =>
-        await this.SendRequest(request, this.BuildHttpRequestMessage, this.ParseFailure<Unit>, CreateSuccessResult);
-
+        await this.SendRequest(request, this.BuildHttpRequestMessage, this.ParseFailure<Unit>, CreateSuccessResult)
+            .ConfigureAwait(false);
+
     /// <summary>
     ///     Sends a HttpRequest without Authorization and UserAgent headers.
     /// </summary>
     /// <param name="request">The request to send.</param>
     /// <returns>Success if the operation succeeds, Failure it if fails.</returns>
     public async Task<Result<Unit>> SendWithoutHeadersAsync<T>(Result<T> request) where T : IVonageRequest =>
         await this.SendRequest(request, value => value.BuildRequestMessage(), this.ParseFailure<Unit>,
-            CreateSuccessResult);
-
+            CreateSuccessResult).ConfigureAwait(false);
+    
     /// <summary>
     ///     Sends a HttpRequest and returns the raw content.
     /// </summary>
@@ -57,8 +58,8 @@ await this.SendRequest(request, value => value.BuildRequestMessage(), this.Parse
     public async Task<Result<string>> SendWithRawResponseAsync<TRequest>(Result<TRequest> request)
         where TRequest : IVonageRequest =>
         await this.SendRequest(request, this.BuildHttpRequestMessage, this.ParseFailure<string>,
-            responseData => responseData.Content);
-
+            responseData => responseData.Content).ConfigureAwait(false);
+    
     /// <summary>
     ///     Sends a HttpRequest and parses the response.
     /// </summary>
@@ -67,38 +68,39 @@ await this.SendRequest(request, this.BuildHttpRequestMessage, this.ParseFailure<
     public async Task<Result<TResponse>> SendWithResponseAsync<TRequest, TResponse>(Result<TRequest> request)
         where TRequest : IVonageRequest =>
         await this.SendRequest(request, this.BuildHttpRequestMessage, this.ParseFailure<TResponse>,
-            this.ParseSuccess<TResponse>);
-
+            this.ParseSuccess<TResponse>).ConfigureAwait(false);
+    
     private Result<HttpRequestMessage> BuildHttpRequestMessage<T>(T value) where T : IVonageRequest =>
         this.requestOptions
             .Map(options => value
                 .BuildRequestMessage()
                 .WithAuthenticationHeader(options.AuthenticationHeader)
                 .WithUserAgent(options.UserAgent));
-
+    
     private HttpFailure CreateFailureResult(HttpStatusCode code, string responseContent) =>
         this.jsonSerializer
             .DeserializeObject<ErrorResponse>(responseContent)
             .Match(success => HttpFailure.From(code, success.Message, responseContent),
                 failure => HttpFailure.From(code, failure.GetFailureMessage(), responseContent));
-
+    
     private static HttpFailure CreateFailureResult(HttpStatusCode code) => HttpFailure.From(code);
-
+    
     private static Result<Unit> CreateSuccessResult(ResponseData response) => Result<Unit>.FromSuccess(Unit.Default);
-
+    
     private static async Task<ResponseData> ExtractResponseData(HttpResponseMessage response) =>
-        new(response.StatusCode, response.IsSuccessStatusCode, await response.Content.ReadAsStringAsync());
-
+        new ResponseData(response.StatusCode, response.IsSuccessStatusCode,
+            await response.Content.ReadAsStringAsync().ConfigureAwait(false));
+
     private Result<T> ParseFailure<T>(ResponseData response) =>
         MaybeExtensions.From(response.Content)
             .Match(value => this.CreateFailureResult(response.Code, value), () => CreateFailureResult(response.Code))
             .ToResult<T>();
-
+    
     private Result<T> ParseSuccess<T>(ResponseData response) =>
         this.jsonSerializer
             .DeserializeObject<T>(response.Content)
             .Match(Result<T>.FromSuccess, Result<T>.FromFailure);
-
+    
     private async Task<Result<TResponse>> SendRequest<TRequest, TResponse>(
         Result<TRequest> request,
         Func<TRequest, Result<HttpRequestMessage>> httpRequestConversion,
@@ -108,9 +110,10 @@ await request
             .Bind(httpRequestConversion)
             .MapAsync(value => this.client.SendAsync(value))
             .MapAsync(ExtractResponseData)
-            .Bind(response => !response.IsSuccessStatusCode ? failure(response) : success(response));
-
+            .Bind(response => !response.IsSuccessStatusCode ? failure(response) : success(response))
+            .ConfigureAwait(false);
+
     private sealed record ResponseData(HttpStatusCode Code, bool IsSuccessStatusCode, string Content);
-
+    
     private sealed record HttpClientOptions(AuthenticationHeaderValue AuthenticationHeader, string UserAgent);
 }