Skip to content

fix(csharp/src/Drivers/BigQuery): improve selective handling of cancellation exception #3615

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −8
Open

fix(csharp/src/Drivers/BigQuery): improve selective handling of cancellation exception #3615

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
17 changes: 11 additions & 6 deletions csharp/src/Drivers/BigQuery/BigQueryStatement.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ private async Task<QueryResult> ExecuteQueryInternalAsync()
}).ConfigureAwait(false);
};

BigQueryResults results = await ExecuteWithRetriesAsync(getJobResults, activity).ConfigureAwait(false);
BigQueryResults results = await ExecuteWithRetriesAsync(getJobResults, activity, cancellationContext.CancellationToken).ConfigureAwait(false);

TokenProtectedReadClientManger clientMgr = new TokenProtectedReadClientManger(Credential);
clientMgr.UpdateToken = () => Task.Run(() =>
Expand Down Expand Up @@ -180,7 +180,7 @@ private async Task<QueryResult> ExecuteQueryInternalAsync()
throw new AdbcException($"Unable to obtain result from statement [{statementIndex}]", AdbcStatusCode.InvalidData);
};

results = await ExecuteWithRetriesAsync(getMultiJobResults, activity).ConfigureAwait(false);
results = await ExecuteWithRetriesAsync(getMultiJobResults, activity, cancellationContext.CancellationToken).ConfigureAwait(false);
}

if (results?.TableReference == null)
Expand Down Expand Up @@ -213,7 +213,7 @@ private async Task<QueryResult> ExecuteQueryInternalAsync()
return await GetArrowReaders(clientMgr, table, results.TableReference.ProjectId, maxStreamCount, activity, context.CancellationToken).ConfigureAwait(false);
}).ConfigureAwait(false);
};
IEnumerable<IArrowReader> readers = await ExecuteWithRetriesAsync(getArrowReadersFunc, activity).ConfigureAwait(false);
IEnumerable<IArrowReader> readers = await ExecuteWithRetriesAsync(getArrowReadersFunc, activity, cancellationContext.CancellationToken).ConfigureAwait(false);

// Note: MultiArrowReader must dispose the cancellationContext.
IArrowArrayStream stream = new MultiArrowReader(this, TranslateSchema(results.Schema), readers, new CancellationContext(cancellationRegistry));
Expand Down Expand Up @@ -287,7 +287,7 @@ private async Task<UpdateResult> ExecuteUpdateInternalAsync()
return await context.Job.GetQueryResultsAsync(getQueryResultsOptions, context.CancellationToken).ConfigureAwait(false);
}).ConfigureAwait(false);
};
BigQueryResults? result = await ExecuteWithRetriesAsync(getQueryResultsAsyncFunc, activity);
BigQueryResults? result = await ExecuteWithRetriesAsync(getQueryResultsAsyncFunc, activity, context.CancellationToken);
long updatedRows = result?.NumDmlAffectedRows.HasValue == true ? result.NumDmlAffectedRows.Value : -1L;

activity?.AddTag(SemanticConventions.Db.Response.ReturnedRows, updatedRows);
Expand Down Expand Up @@ -562,7 +562,8 @@ private TableReference TryGetLargeDestinationTableReference(string datasetId, Ac

public bool TokenRequiresUpdate(Exception ex) => BigQueryUtils.TokenRequiresUpdate(ex);

private async Task<T> ExecuteWithRetriesAsync<T>(Func<Task<T>> action, Activity? activity) => await RetryManager.ExecuteWithRetriesAsync<T>(this, action, activity, MaxRetryAttempts, RetryDelayMs);
private async Task<T> ExecuteWithRetriesAsync<T>(Func<Task<T>> action, Activity? activity, CancellationToken cancellationToken = default) =>
await RetryManager.ExecuteWithRetriesAsync<T>(this, action, activity, MaxRetryAttempts, RetryDelayMs, cancellationToken);

private async Task<T> ExecuteCancellableJobAsync<T>(
JobCancellationContext context,
Expand All @@ -573,8 +574,12 @@ private async Task<T> ExecuteCancellableJobAsync<T>(
{
return await func(context).ConfigureAwait(false);
}
catch (Exception ex) when (BigQueryUtils.ContainsException(ex, out OperationCanceledException? cancelledEx))
catch (Exception ex)
when (context.CancellationToken.IsCancellationRequested &&
BigQueryUtils.ContainsException(ex, out OperationCanceledException? cancelledEx))
{
// Note: OperationCanceledException could be thrown from the call,
// but we only want to handle when the cancellation was requested from the context.
activity?.AddException(cancelledEx!);
try
{
Expand Down
8 changes: 6 additions & 2 deletions csharp/src/Drivers/BigQuery/RetryManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;

namespace Apache.Arrow.Adbc.Drivers.BigQuery
Expand All @@ -32,7 +33,8 @@ public static async Task<T> ExecuteWithRetriesAsync<T>(
Func<Task<T>> action,
Activity? activity,
int maxRetries = 5,
int initialDelayMilliseconds = 200)
int initialDelayMilliseconds = 200,
CancellationToken cancellationToken = default)
{
if (action == null)
{
Expand All @@ -49,8 +51,10 @@ public static async Task<T> ExecuteWithRetriesAsync<T>(
T result = await action();
return result;
}
catch (Exception ex) when (!BigQueryUtils.ContainsException(ex, out OperationCanceledException? _))
catch (Exception ex) when (!cancellationToken.IsCancellationRequested)
{
// Note: OperationCanceledException could be thrown from the call,
// but we only want to break out when the cancellation was requested from the caller.
activity?.AddBigQueryTag("retry_attempt", retryCount);
activity?.AddException(ex);

Expand Down
Loading