Skip to content

Use CancellationToken in AsyncExecution #1531

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

Merged
merged 3 commits into from
Nov 14, 2025
Merged

Use CancellationToken in AsyncExecution #1531

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9891b6
Use `CancellationToken` in `AsyncExecution`
JamieMagee Nov 14, 2025
a4be1a9
Review comments
JamieMagee Nov 14, 2025
af86d53
retain original TimeoutException
JamieMagee Nov 14, 2025
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
30 changes: 17 additions & 13 deletions src/Microsoft.ComponentDetection.Common/AsyncExecution.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ public static class AsyncExecution
/// <returns>The result of the function.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="toExecute"/> is null.</exception>
/// <exception cref="TimeoutException">Thrown when the execution does not complete within the timeout.</exception>
public static async Task<T> ExecuteWithTimeoutAsync<T>(Func<Task<T>> toExecute, TimeSpan timeout, CancellationToken cancellationToken)
public static async Task<T> ExecuteWithTimeoutAsync<T>(Func<Task<T>> toExecute, TimeSpan timeout, CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(toExecute);

var work = Task.Run(toExecute);

var completedInTime = await Task.Run(() => work.Wait(timeout));
if (!completedInTime)
var work = toExecute();
try
{
throw new TimeoutException($"The execution did not complete in the allotted time ({timeout.TotalSeconds} seconds) and has been terminated prior to completion");
return await work.WaitAsync(timeout, cancellationToken);
}
catch (TimeoutException ex)
{
throw new TimeoutException($"The execution did not complete in the allotted time ({timeout.TotalSeconds} seconds) and has been terminated prior to completion", ex);
}

return await work;
}

/// <summary>
Expand All @@ -43,15 +43,19 @@ public static async Task<T> ExecuteWithTimeoutAsync<T>(Func<Task<T>> toExecute,
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="toExecute"/> is null.</exception>
/// <exception cref="TimeoutException">Thrown when the execution does not complete within the timeout.</exception>
public static async Task ExecuteVoidWithTimeoutAsync(Action toExecute, TimeSpan timeout, CancellationToken cancellationToken)
public static async Task ExecuteVoidWithTimeoutAsync(Action toExecute, TimeSpan timeout, CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(toExecute);

var work = Task.Run(toExecute, cancellationToken);
var completedInTime = await Task.Run(() => work.Wait(timeout));
if (!completedInTime)
var work = Task.Run(toExecute, CancellationToken.None);

try
{
await work.WaitAsync(timeout, cancellationToken);
}
catch (TimeoutException ex)
{
throw new TimeoutException($"The execution did not complete in the allotted time ({timeout.TotalSeconds} seconds) and has been terminated prior to completion");
throw new TimeoutException($"The execution did not complete in the allotted time ({timeout.TotalSeconds} seconds) and has been terminated prior to completion", ex);
}
}
}
Loading