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

Jump to bottom

Avoid unhandled exceptions on unawaited async path #2289

Merged
merged 2 commits into from
Aug 23, 2023
Merged

Avoid unhandled exceptions on unawaited async path #2289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5ac62f
Avoid unhandled exceptions on unawaited async path
jnyrup Aug 23, 2023
fc4e432
Add "Async" suffix to Task returning methods
jnyrup Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 20 additions & 13 deletions lib/PuppeteerSharp/ChromeTargetManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ private void StoreExistingTargetsForInit()
}
}

private async Task EnsureTargetsIdsForInit()
private async Task EnsureTargetsIdsForInitAsync()
{
if (_targetDiscoveryTimeout > 0)
{
Expand Down Expand Up @@ -160,7 +160,7 @@ private void OnMessageReceived(object sender, MessageEventArgs e)
return;

case "Target.targetDestroyed":
OnTargetDestroyed(e.MessageData.ToObject<TargetDestroyedResponse>(true));
_ = OnTargetDestroyedAsync(e.MessageID, e.MessageData.ToObject<TargetDestroyedResponse>(true));
return;

case "Target.targetInfoChanged":
Expand Down Expand Up @@ -198,15 +198,22 @@ private void OnTargetCreated(TargetCreatedResponse e)
}
}

private async void OnTargetDestroyed(TargetDestroyedResponse e)
private async Task OnTargetDestroyedAsync(string messageId, TargetDestroyedResponse e)
{
_discoveredTargetsByTargetId.TryRemove(e.TargetId, out var targetInfo);
await EnsureTargetsIdsForInit().ConfigureAwait(false);
FinishInitializationIfReady(e.TargetId);
try
{
_discoveredTargetsByTargetId.TryRemove(e.TargetId, out var targetInfo);
await EnsureTargetsIdsForInitAsync().ConfigureAwait(false);
FinishInitializationIfReady(e.TargetId);

if (targetInfo?.Type == TargetType.ServiceWorker && _availableTargetsByTargetIdDictionary.TryRemove(e.TargetId, out var target))
if (targetInfo?.Type == TargetType.ServiceWorker && _availableTargetsByTargetIdDictionary.TryRemove(e.TargetId, out var target))
{
TargetGone?.Invoke(this, new TargetChangedArgs { Target = target, TargetInfo = targetInfo });
}
}
catch (Exception ex)
{
TargetGone?.Invoke(this, new TargetChangedArgs { Target = target, TargetInfo = targetInfo });
HandleExceptionOnMessageReceived(messageId, ex);
}
}

Expand All @@ -224,7 +231,7 @@ private void OnTargetInfoChanged(TargetCreatedResponse e)
TargetChanged?.Invoke(this, new TargetChangedArgs { Target = target, TargetInfo = e.TargetInfo });
}

private async Task OnAttachedToTarget(object sender, TargetAttachedToTargetResponse e)
private async Task OnAttachedToTargetAsync(object sender, TargetAttachedToTargetResponse e)
{
var parent = sender as ICDPConnection;
var targetInfo = e.TargetInfo;
Expand Down Expand Up @@ -256,7 +263,7 @@ async Task SilentDetach()
if (targetInfo.Type == TargetType.ServiceWorker &&
_connection.IsAutoAttached(targetInfo.TargetId))
{
await EnsureTargetsIdsForInit().ConfigureAwait(false);
await EnsureTargetsIdsForInitAsync().ConfigureAwait(false);
FinishInitializationIfReady(targetInfo.TargetId);
await SilentDetach().ConfigureAwait(false);
if (_availableTargetsByTargetIdDictionary.ContainsKey(targetInfo.TargetId))
Expand All @@ -273,7 +280,7 @@ async Task SilentDetach()
if (_targetFilterFunc?.Invoke(targetInfo) == false)
{
_ignoredTargets.Add(targetInfo.TargetId);
await EnsureTargetsIdsForInit().ConfigureAwait(false);
await EnsureTargetsIdsForInitAsync().ConfigureAwait(false);
FinishInitializationIfReady(targetInfo.TargetId);
await SilentDetach().ConfigureAwait(false);
return;
Expand Down Expand Up @@ -311,7 +318,7 @@ async Task SilentDetach()
}
}

await EnsureTargetsIdsForInit().ConfigureAwait(false);
await EnsureTargetsIdsForInitAsync().ConfigureAwait(false);
_targetsIdsForInit.Remove(target.TargetId);

if (!existingTarget)
Expand Down Expand Up @@ -342,7 +349,7 @@ private async Task OnAttachedToTargetHandlingExceptionsAsync(object sender, stri
{
try
{
await OnAttachedToTarget(sender, e).ConfigureAwait(false);
await OnAttachedToTargetAsync(sender, e).ConfigureAwait(false);
}
catch (Exception ex)
{
Expand Down
4 changes: 2 additions & 2 deletions lib/PuppeteerSharp/IsolatedWorld.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ private async void Client_MessageReceived(object sender, MessageEventArgs e)
switch (e.MessageID)
{
case "Runtime.bindingCalled":
await OnBindingCalled(e.MessageData.ToObject<BindingCalledResponse>(true)).ConfigureAwait(false);
await OnBindingCalledAsync(e.MessageData.ToObject<BindingCalledResponse>(true)).ConfigureAwait(false);
break;
}
}
Expand All @@ -460,7 +460,7 @@ private async void Client_MessageReceived(object sender, MessageEventArgs e)
}
}

private async Task OnBindingCalled(BindingCalledResponse e)
private async Task OnBindingCalledAsync(BindingCalledResponse e)
{
var payload = e.BindingPayload;

Expand Down
12 changes: 6 additions & 6 deletions lib/PuppeteerSharp/Page.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,9 +329,9 @@ public Task<IJSHandle> QuerySelectorAllHandleAsync(string selector)
=> MainFrame.QuerySelectorAllHandleAsync(selector);

/// <inheritdoc/>
#pragma warning disable CS0618 // Using obsolets
#pragma warning disable CS0618 // Using obsolets
public Task<IElementHandle[]> XPathAsync(string expression) => MainFrame.XPathAsync(expression);
#pragma warning restore CS0618
#pragma warning restore CS0618

/// <inheritdoc/>
public async Task<IJSHandle> EvaluateExpressionHandleAsync(string script)
Expand Down Expand Up @@ -784,10 +784,10 @@ public Task<IElementHandle> WaitForSelectorAsync(string selector, WaitForSelecto
=> MainFrame.WaitForSelectorAsync(selector, options ?? new WaitForSelectorOptions());

/// <inheritdoc/>
#pragma warning disable CS0618 // WaitForXPathAsync is obsolete
#pragma warning disable CS0618 // WaitForXPathAsync is obsolete
public Task<IElementHandle> WaitForXPathAsync(string xpath, WaitForSelectorOptions options = null)
=> MainFrame.WaitForXPathAsync(xpath, options ?? new WaitForSelectorOptions());
#pragma warning restore CS0618
#pragma warning restore CS0618

/// <inheritdoc/>
public Task<IResponse> WaitForNavigationAsync(NavigationOptions options = null)
Expand Down Expand Up @@ -1470,7 +1470,7 @@ private async void Client_MessageReceived(object sender, MessageEventArgs e)
await OnLogEntryAddedAsync(e.MessageData.ToObject<LogEntryAddedResponse>(true)).ConfigureAwait(false);
break;
case "Runtime.bindingCalled":
await OnBindingCalled(e.MessageData.ToObject<BindingCalledResponse>(true)).ConfigureAwait(false);
await OnBindingCalledAsync(e.MessageData.ToObject<BindingCalledResponse>(true)).ConfigureAwait(false);
break;
case "Page.fileChooserOpened":
await OnFileChooserAsync(e.MessageData.ToObject<PageFileChooserOpenedResponse>(true)).ConfigureAwait(false);
Expand Down Expand Up @@ -1519,7 +1519,7 @@ private async Task OnFileChooserAsync(PageFileChooserOpenedResponse e)
}
}

private async Task OnBindingCalled(BindingCalledResponse e)
private async Task OnBindingCalledAsync(BindingCalledResponse e)
{
if (e.BindingPayload.Type != "exposedFun" || !_bindings.ContainsKey(e.BindingPayload.Name))
{
Expand Down
4 changes: 2 additions & 2 deletions lib/PuppeteerSharp/Worker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ internal async void OnMessageReceived(object sender, MessageEventArgs e)
OnExecutionContextCreated(e.MessageData.ToObject<RuntimeExecutionContextCreatedResponse>(true));
break;
case "Runtime.consoleAPICalled":
await OnConsoleAPICalled(e).ConfigureAwait(false);
await OnConsoleAPICalledAsync(e).ConfigureAwait(false);
break;
case "Runtime.exceptionThrown":
OnExceptionThrown(e.MessageData.ToObject<RuntimeExceptionThrownResponse>(true));
Expand All @@ -155,7 +155,7 @@ internal async void OnMessageReceived(object sender, MessageEventArgs e)

private void OnExceptionThrown(RuntimeExceptionThrownResponse e) => _exceptionThrown(e.ExceptionDetails);

private async Task OnConsoleAPICalled(MessageEventArgs e)
private async Task OnConsoleAPICalledAsync(MessageEventArgs e)
{
var consoleData = e.MessageData.ToObject<PageConsoleResponse>(true);
await _consoleAPICalled(
Expand Down