Skip to content

[dotnet] [bidi] Support cancellation of events registration #16996

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
nvborisenko merged 6 commits into from
Jan 24, 2026
Merged

[dotnet] [bidi] Support cancellation of events registration #16996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6cdb9f3
Force subscription setup cancellation
nvborisenko Jan 24, 2026
feb18ed
Add CancellationToken to BiDi event subscription methods
nvborisenko Jan 24, 2026
c0895c3
Add CancellationToken to UnsubscribeAsync method
nvborisenko Jan 24, 2026
fd89034
Add CancellationToken support to BiDi event subscriptions
nvborisenko Jan 24, 2026
62886da
Add CancellationToken support to network interception APIs
nvborisenko Jan 24, 2026
a7a4493
Add CancellationToken to AsBiDiAsync extension
nvborisenko Jan 24, 2026
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
8 changes: 4 additions & 4 deletions dotnet/src/webdriver/BiDi/Broker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,27 +152,27 @@ public async Task<TResult> ExecuteCommandAsync<TCommand, TResult>(TCommand comma
return (TResult)await tcs.Task.ConfigureAwait(false);
}

public async Task<Subscription> SubscribeAsync<TEventArgs>(string eventName, EventHandler eventHandler, SubscriptionOptions? options, JsonTypeInfo<TEventArgs> jsonTypeInfo)
public async Task<Subscription> SubscribeAsync<TEventArgs>(string eventName, EventHandler eventHandler, SubscriptionOptions? options, JsonTypeInfo<TEventArgs> jsonTypeInfo, CancellationToken cancellationToken)
where TEventArgs : EventArgs
{
_eventTypesMap[eventName] = jsonTypeInfo;

var handlers = _eventHandlers.GetOrAdd(eventName, (a) => []);

var subscribeResult = await _bidi.SessionModule.SubscribeAsync([eventName], new() { Contexts = options?.Contexts, UserContexts = options?.UserContexts }).ConfigureAwait(false);
var subscribeResult = await _bidi.SessionModule.SubscribeAsync([eventName], new() { Contexts = options?.Contexts, UserContexts = options?.UserContexts }, cancellationToken).ConfigureAwait(false);

handlers.Add(eventHandler);

return new Subscription(subscribeResult.Subscription, this, eventHandler);
}

public async Task UnsubscribeAsync(Subscription subscription)
public async Task UnsubscribeAsync(Subscription subscription, CancellationToken cancellationToken)
{
var eventHandlers = _eventHandlers[subscription.EventHandler.EventName];

eventHandlers.Remove(subscription.EventHandler);

await _bidi.SessionModule.UnsubscribeAsync([subscription.SubscriptionId]).ConfigureAwait(false);
await _bidi.SessionModule.UnsubscribeAsync([subscription.SubscriptionId], null, cancellationToken).ConfigureAwait(false);
}

public async ValueTask DisposeAsync()
Expand Down
10 changes: 6 additions & 4 deletions dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextInputModule.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,24 @@ public Task<SetFilesResult> SetFilesAsync(Script.ISharedReference element, IEnum
return inputModule.SetFilesAsync(context, element, files, options, cancellationToken);
}

public Task<Subscription> OnFileDialogOpenedAsync(Func<FileDialogInfo, Task> handler, ContextSubscriptionOptions? options = null)
public Task<Subscription> OnFileDialogOpenedAsync(Func<FileDialogInfo, Task> handler, ContextSubscriptionOptions? options = null, CancellationToken cancellationToken = default)
{
if (handler is null) throw new ArgumentNullException(nameof(handler));

return inputModule.OnFileDialogOpenedAsync(
e => HandleFileDialogOpenedAsync(e, handler),
ContextSubscriptionOptions.WithContext(options, context));
ContextSubscriptionOptions.WithContext(options, context),
cancellationToken);
}

public Task<Subscription> OnFileDialogOpenedAsync(Action<FileDialogInfo> handler, ContextSubscriptionOptions? options = null)
public Task<Subscription> OnFileDialogOpenedAsync(Action<FileDialogInfo> handler, ContextSubscriptionOptions? options = null, CancellationToken cancellationToken = default)
{
if (handler is null) throw new ArgumentNullException(nameof(handler));

return inputModule.OnFileDialogOpenedAsync(
e => HandleFileDialogOpened(e, handler),
ContextSubscriptionOptions.WithContext(options, context));
ContextSubscriptionOptions.WithContext(options, context),
cancellationToken);
}

private async Task HandleFileDialogOpenedAsync(FileDialogInfo e, Func<FileDialogInfo, Task> handler)
Expand Down
11 changes: 7 additions & 4 deletions dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextLogModule.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,31 @@

using OpenQA.Selenium.BiDi.Log;
using System;
using System.Threading;
using System.Threading.Tasks;

namespace OpenQA.Selenium.BiDi.BrowsingContext;

public sealed class BrowsingContextLogModule(BrowsingContext context, LogModule logModule)
{
public Task<Subscription> OnEntryAddedAsync(Func<Log.LogEntry, Task> handler, ContextSubscriptionOptions? options = null)
public Task<Subscription> OnEntryAddedAsync(Func<Log.LogEntry, Task> handler, ContextSubscriptionOptions? options = null, CancellationToken cancellationToken = default)
{
if (handler is null) throw new ArgumentNullException(nameof(handler));

return logModule.OnEntryAddedAsync(
e => HandleEntryAddedAsync(e, handler),
ContextSubscriptionOptions.WithContext(options, context));
ContextSubscriptionOptions.WithContext(options, context),
cancellationToken);
}

public Task<Subscription> OnEntryAddedAsync(Action<Log.LogEntry> handler, ContextSubscriptionOptions? options = null)
public Task<Subscription> OnEntryAddedAsync(Action<Log.LogEntry> handler, ContextSubscriptionOptions? options = null, CancellationToken cancellationToken = default)
{
if (handler is null) throw new ArgumentNullException(nameof(handler));

return logModule.OnEntryAddedAsync(
e => HandleEntryAdded(e, handler),
ContextSubscriptionOptions.WithContext(options, context));
ContextSubscriptionOptions.WithContext(options, context),
cancellationToken);
}

private async Task HandleEntryAddedAsync(Log.LogEntry e, Func<Log.LogEntry, Task> handler)
Expand Down
Loading