Skip to content
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

Explicit Catch of System.IO.IOException in ExecuteQueryImplementation… #301

Merged
merged 4 commits into from
May 3, 2021
Merged

Explicit Catch of System.IO.IOException in ExecuteQueryImplementation… #301

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da7499d
Explicit Catch of System.IO.IOException in ExecuteQueryImplementation…
May 1, 2021
9aa84f4
handle when SocketException exception is returned as innerException o…
May 1, 2021
4c04259
SocketException seems to always innermost error
May 1, 2021
6d8335b
retry on socket error
May 2, 2021
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
71 changes: 60 additions & 11 deletions src/lib/PnP.Framework/Extensions/ClientContextExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
using System.Configuration;
using System.Diagnostics;
using System.IdentityModel.Tokens.Jwt;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
Expand Down Expand Up @@ -158,18 +159,19 @@ private static async Task ExecuteQueryImplementation(ClientRuntimeContext client
var response = wex.Response as HttpWebResponse;
// Check if request was throttled - http status code 429
// Check is request failed due to server unavailable - http status code 503
if (response != null &&
if ((response != null &&
(response.StatusCode == (HttpStatusCode)429
|| response.StatusCode == (HttpStatusCode)503
// || response.StatusCode == (HttpStatusCode)500
))
|| wex.Status == WebExceptionStatus.Timeout)
{
wrapper = (ClientRequestWrapper)wex.Data["ClientRequest"];
retry = true;
retryAfterInterval = 0;

//Add delay for retry, retry-after header is specified in seconds
if (response.Headers["Retry-After"] != null)
if (response != null && response.Headers["Retry-After"] != null)
{
if (int.TryParse(response.Headers["Retry-After"], out int retryAfterHeaderValue))
{
Expand All @@ -181,7 +183,15 @@ private static async Task ExecuteQueryImplementation(ClientRuntimeContext client
retryAfterInterval = backoffInterval;
backoffInterval *= 2;
}
Log.Warning(Constants.LOGGING_SOURCE, $"CSOM request frequency exceeded usage limits. Retry attempt {retryAttempts + 1}. Sleeping for {retryAfterInterval} milliseconds before retrying.");

if (wex.Status == WebExceptionStatus.Timeout)
{
Log.Warning(Constants.LOGGING_SOURCE, $"CSOM request timeout. Retry attempt {retryAttempts + 1}. Sleeping for {retryAfterInterval} milliseconds before retrying.");
}
else
{
Log.Warning(Constants.LOGGING_SOURCE, $"CSOM request frequency exceeded usage limits. Retry attempt {retryAttempts + 1}. Sleeping for {retryAfterInterval} milliseconds before retrying.");
}

await Task.Delay(retryAfterInterval);

Expand All @@ -193,19 +203,58 @@ private static async Task ExecuteQueryImplementation(ClientRuntimeContext client
var errorSb = new System.Text.StringBuilder();

errorSb.AppendLine(wex.ToString());

if (response != null)
errorSb.AppendLine($"TraceCorrelationId: {clientContext.TraceCorrelationId}");
errorSb.AppendLine($"Url: {clientContext.Url}");

//find innermost Error and check if it is a SocketException
Exception innermostEx = wex;
while (innermostEx.InnerException != null) innermostEx = innermostEx.InnerException;
var socketEx = innermostEx as System.Net.Sockets.SocketException;
if (socketEx != null)
{
//if(response.Headers["SPRequestGuid"] != null)
if (response.Headers.AllKeys.Any(k => string.Equals(k, "SPRequestGuid", StringComparison.InvariantCultureIgnoreCase)))
errorSb.AppendLine($"ErrorCode: {socketEx.ErrorCode}"); //10054
errorSb.AppendLine($"SocketErrorCode: {socketEx.SocketErrorCode}"); //ConnectionReset
errorSb.AppendLine($"Message: {socketEx.Message}"); //An existing connection was forcibly closed by the remote host
Log.Error(Constants.LOGGING_SOURCE, CoreResources.ClientContextExtensions_ExecuteQueryRetryException, errorSb.ToString());

//retry
wrapper = (ClientRequestWrapper)wex.Data["ClientRequest"];
retry = true;
retryAfterInterval = 0;

//Add delay for retry, retry-after header is specified in seconds
if (response != null && response.Headers["Retry-After"] != null)
{
var spRequestGuid = response.Headers["SPRequestGuid"];
errorSb.AppendLine($"ServerErrorTraceCorrelationId: {spRequestGuid}");
if (int.TryParse(response.Headers["Retry-After"], out int retryAfterHeaderValue))
{
retryAfterInterval = retryAfterHeaderValue * 1000;
}
}
else
{
retryAfterInterval = backoffInterval;
backoffInterval *= 2;
}
await Task.Delay(retryAfterInterval);

//Add to retry count and increase delay.
retryAttempts++;
}
else
{
if (response != null)
{
//if(response.Headers["SPRequestGuid"] != null)
if (response.Headers.AllKeys.Any(k => string.Equals(k, "SPRequestGuid", StringComparison.InvariantCultureIgnoreCase)))
{
var spRequestGuid = response.Headers["SPRequestGuid"];
errorSb.AppendLine($"ServerErrorTraceCorrelationId: {spRequestGuid}");
}
}

Log.Error(Constants.LOGGING_SOURCE, CoreResources.ClientContextExtensions_ExecuteQueryRetryException, errorSb.ToString());
throw;
Log.Error(Constants.LOGGING_SOURCE, CoreResources.ClientContextExtensions_ExecuteQueryRetryException, errorSb.ToString());
throw;
}
}
}
catch (ServerException serverEx)
Expand Down