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

Add cancellationtoken to timeout tasks #1380

Merged
merged 1 commit into from
Feb 29, 2020
Merged

Add cancellationtoken to timeout tasks #1380

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
13 changes: 8 additions & 5 deletions lib/PuppeteerSharp/ChromiumProcess.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -609,11 +609,14 @@ public Task EnterFromAsync(ChromiumProcess p, State fromState, TimeSpan timeout)
public override async Task ExitAsync(ChromiumProcess p, TimeSpan timeout)
{
var waitForExitTask = WaitForExitAsync(p);
await waitForExitTask.WithTimeout(async () =>
{
await Killing.EnterFromAsync(p, this).ConfigureAwait(false);
await waitForExitTask.ConfigureAwait(false);
}, timeout).ConfigureAwait(false);
await waitForExitTask.WithTimeout(
async () =>
{
await Killing.EnterFromAsync(p, this).ConfigureAwait(false);
await waitForExitTask.ConfigureAwait(false);
},
timeout,
CancellationToken.None).ConfigureAwait(false);
}

public override Task KillAsync(ChromiumProcess p) => Killing.EnterFromAsync(p, this);
Expand Down
33 changes: 25 additions & 8 deletions lib/PuppeteerSharp/Helpers/TaskHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,13 @@ public static class TaskHelper
/// <param name="task">Task to wait for.</param>
/// <param name="milliseconds">Milliseconds timeout.</param>
/// <param name="exceptionFactory">Optional timeout exception factory.</param>
public static Task WithTimeout(this Task task, int milliseconds = 1_000, Func<TimeSpan, Exception> exceptionFactory = null)
=> WithTimeout(task, TimeSpan.FromMilliseconds(milliseconds), exceptionFactory);
/// <param name="cancellationToken">Cancellation token.</param>
public static Task WithTimeout(
this Task task,
int milliseconds = 1_000,
Func<TimeSpan, Exception> exceptionFactory = null,
CancellationToken cancellationToken = default)
=> WithTimeout(task, TimeSpan.FromMilliseconds(milliseconds), exceptionFactory, cancellationToken);

//Recipe from https://blogs.msdn.microsoft.com/pfxteam/2012/10/05/how-do-i-cancel-non-cancelable-async-operations/
/// <summary>
Expand All @@ -31,10 +36,16 @@ public static Task WithTimeout(this Task task, int milliseconds = 1_000, Func<Ti
/// <param name="task">Task to wait for.</param>
/// <param name="timeout">The timeout period.</param>
/// <param name="exceptionFactory">Optional timeout exception factory.</param>
public static Task WithTimeout(this Task task, TimeSpan timeout, Func<TimeSpan, Exception> exceptionFactory = null)
/// <param name="cancellationToken">Cancellation token.</param>
public static Task WithTimeout(
this Task task,
TimeSpan timeout,
Func<TimeSpan, Exception> exceptionFactory = null,
CancellationToken cancellationToken = default)
=> task.WithTimeout(
() => throw (exceptionFactory ?? DefaultExceptionFactory)(timeout),
timeout);
timeout,
cancellationToken);

//Recipe from https://blogs.msdn.microsoft.com/pfxteam/2012/10/05/how-do-i-cancel-non-cancelable-async-operations/
/// <summary>
Expand All @@ -44,8 +55,13 @@ public static Task WithTimeout(this Task task, TimeSpan timeout, Func<TimeSpan,
/// <param name="task">Task to wait for.</param>
/// <param name="timeoutAction">Action to be executed on Timeout.</param>
/// <param name="milliseconds">Milliseconds timeout.</param>
public static Task WithTimeout(this Task task, Func<Task> timeoutAction, int milliseconds = 1_000)
=> WithTimeout(task, timeoutAction, TimeSpan.FromMilliseconds(milliseconds));
/// <param name="cancellationToken">Cancellation token.</param>
public static Task WithTimeout(
this Task task,
Func<Task> timeoutAction,
int milliseconds = 1_000,
CancellationToken cancellationToken = default)
=> WithTimeout(task, timeoutAction, TimeSpan.FromMilliseconds(milliseconds), cancellationToken);

//Recipe from https://blogs.msdn.microsoft.com/pfxteam/2012/10/05/how-do-i-cancel-non-cancelable-async-operations/
/// <summary>
Expand All @@ -55,9 +71,10 @@ public static Task WithTimeout(this Task task, Func<Task> timeoutAction, int mil
/// <param name="task">Task to wait for.</param>
/// <param name="timeoutAction">Action to be executed on Timeout.</param>
/// <param name="timeout">The timeout period.</param>
public static async Task WithTimeout(this Task task, Func<Task> timeoutAction, TimeSpan timeout)
/// <param name="cancellationToken">Cancellation token.</param>
public static async Task WithTimeout(this Task task, Func<Task> timeoutAction, TimeSpan timeout, CancellationToken cancellationToken)
{
if (await TimeoutTask(task, timeout).ConfigureAwait(false))
if (await TimeoutTask(task, timeout).ConfigureAwait(false) && !cancellationToken.IsCancellationRequested)
{
await timeoutAction().ConfigureAwait(false);
}
Expand Down
7 changes: 5 additions & 2 deletions lib/PuppeteerSharp/LifecycleWatcher.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using System.Linq;
using System.Diagnostics.Contracts;
using PuppeteerSharp.Helpers;
using System.Threading;

namespace PuppeteerSharp
{
Expand Down Expand Up @@ -31,6 +32,7 @@ internal class LifecycleWatcher : IDisposable
private TaskCompletionSource<bool> _sameDocumentNavigationTaskWrapper;
private TaskCompletionSource<bool> _lifecycleTaskWrapper;
private TaskCompletionSource<bool> _terminationTaskWrapper;
private CancellationTokenSource _terminationCancellationToken;

public LifecycleWatcher(
FrameManager frameManager,
Expand All @@ -55,6 +57,7 @@ public LifecycleWatcher(
_newDocumentNavigationTaskWrapper = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
_lifecycleTaskWrapper = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
_terminationTaskWrapper = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
_terminationCancellationToken = new CancellationTokenSource();

frameManager.LifecycleEvent += FrameManager_LifecycleEvent;
frameManager.FrameNavigatedWithinDocument += NavigatedWithinDocument;
Expand All @@ -70,8 +73,7 @@ public LifecycleWatcher(
public Task<bool> SameDocumentNavigationTask => _sameDocumentNavigationTaskWrapper.Task;
public Task<bool> NewDocumentNavigationTask => _newDocumentNavigationTaskWrapper.Task;
public Response NavigationResponse => _navigationRequest?.Response;
public Task TimeoutOrTerminationTask
=> _terminationTaskWrapper.Task.WithTimeout(_timeout);
public Task TimeoutOrTerminationTask => _terminationTaskWrapper.Task.WithTimeout(_timeout, cancellationToken: _terminationCancellationToken.Token);
public Task LifecycleTask => _lifecycleTaskWrapper.Task;

#endregion
Expand Down Expand Up @@ -168,6 +170,7 @@ public void Dispose(bool disposing)
_frameManager.FrameDetached -= OnFrameDetached;
_frameManager.NetworkManager.Request -= OnRequest;
_frameManager.Client.Disconnected -= OnClientDisconnected;
_terminationCancellationToken.Cancel();
}

#endregion
Expand Down