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

[dotnet] [bidi] Provide extension points for custom BiDi modules #15420

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

[dotnet] [bidi] Provide extension points for custom BiDi modules #15420

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
b46629e
[dotnet] [bidi] Provide extension points for custom BiDi modules
RenderMichael Mar 14, 2025
5a43ad4
Add reflection-based JSON fallback
RenderMichael Mar 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
35 changes: 20 additions & 15 deletions dotnet/src/webdriver/BiDi/BiDi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace OpenQA.Selenium.BiDi;
public class BiDi : IAsyncDisposable
{
private readonly ITransport _transport;
private readonly Broker _broker;
protected Broker Broker { get; }

private readonly Lazy<Modules.Session.SessionModule> _sessionModule;
private readonly Lazy<Modules.BrowsingContext.BrowsingContextModule> _browsingContextModule;
Expand All @@ -38,21 +38,21 @@ public class BiDi : IAsyncDisposable
private readonly Lazy<Modules.Log.LogModule> _logModule;
private readonly Lazy<Modules.Storage.StorageModule> _storageModule;

internal BiDi(string url)
protected internal BiDi(string url)
{
var uri = new Uri(url);

_transport = new WebSocketTransport(new Uri(url));
_broker = new Broker(this, _transport);
Broker = new Broker(this, _transport);

_sessionModule = new Lazy<Modules.Session.SessionModule>(() => new Modules.Session.SessionModule(_broker));
_browsingContextModule = new Lazy<Modules.BrowsingContext.BrowsingContextModule>(() => new Modules.BrowsingContext.BrowsingContextModule(_broker));
_browserModule = new Lazy<Modules.Browser.BrowserModule>(() => new Modules.Browser.BrowserModule(_broker));
_networkModule = new Lazy<Modules.Network.NetworkModule>(() => new Modules.Network.NetworkModule(_broker));
_inputModule = new Lazy<Modules.Input.InputModule>(() => new Modules.Input.InputModule(_broker));
_scriptModule = new Lazy<Modules.Script.ScriptModule>(() => new Modules.Script.ScriptModule(_broker));
_logModule = new Lazy<Modules.Log.LogModule>(() => new Modules.Log.LogModule(_broker));
_storageModule = new Lazy<Modules.Storage.StorageModule>(() => new Modules.Storage.StorageModule(_broker));
_sessionModule = new Lazy<Modules.Session.SessionModule>(() => new Modules.Session.SessionModule(Broker));
_browsingContextModule = new Lazy<Modules.BrowsingContext.BrowsingContextModule>(() => new Modules.BrowsingContext.BrowsingContextModule(Broker));
_browserModule = new Lazy<Modules.Browser.BrowserModule>(() => new Modules.Browser.BrowserModule(Broker));
_networkModule = new Lazy<Modules.Network.NetworkModule>(() => new Modules.Network.NetworkModule(Broker));
_inputModule = new Lazy<Modules.Input.InputModule>(() => new Modules.Input.InputModule(Broker));
_scriptModule = new Lazy<Modules.Script.ScriptModule>(() => new Modules.Script.ScriptModule(Broker));
_logModule = new Lazy<Modules.Log.LogModule>(() => new Modules.Log.LogModule(Broker));
_storageModule = new Lazy<Modules.Storage.StorageModule>(() => new Modules.Storage.StorageModule(Broker));
}

internal Modules.Session.SessionModule SessionModule => _sessionModule.Value;
Expand All @@ -73,7 +73,7 @@ public static async Task<BiDi> ConnectAsync(string url)
{
var bidi = new BiDi(url);

await bidi._broker.ConnectAsync(default).ConfigureAwait(false);
await bidi.Broker.ConnectAsync().ConfigureAwait(false);

return bidi;
}
Expand All @@ -83,10 +83,15 @@ public Task EndAsync(Modules.Session.EndOptions? options = null)
return SessionModule.EndAsync(options);
}

public async ValueTask DisposeAsync()
protected virtual async ValueTask DisposeAsyncCore()
{
await _broker.DisposeAsync().ConfigureAwait(false);

await Broker.DisposeAsync().ConfigureAwait(false);
_transport?.Dispose();
}

public async ValueTask DisposeAsync()
{
await DisposeAsyncCore();
GC.SuppressFinalize(this);
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BiDi is not a sealed type, we have to implement the IAsyncDisposable pattern for types which users may extend.

}
33 changes: 26 additions & 7 deletions dotnet/src/webdriver/BiDi/Communication/Broker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Text.Json.Serialization.Metadata;
using System.Threading;
using System.Threading.Tasks;

Expand All @@ -52,7 +54,7 @@ public class Broker : IAsyncDisposable
private Task? _eventEmitterTask;
private CancellationTokenSource? _receiveMessagesCancellationTokenSource;

private readonly BiDiJsonSerializerContext _jsonSerializerContext;
private readonly JsonSerializerOptions _jsonSerializerContext;

internal Broker(BiDi bidi, ITransport transport)
{
Expand Down Expand Up @@ -99,13 +101,29 @@ internal Broker(BiDi bidi, ITransport transport)
new Json.Converters.Enumerable.GetUserContextsResultConverter(),
new Json.Converters.Enumerable.GetClientWindowsResultConverter(),
new Json.Converters.Enumerable.GetRealmsResultConverter(),
},
TypeInfoResolverChain =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think BiDi can construct his JsonSerializerContext, and then Broker will rely on it. So I am thinking on a way completely new own permissions json context rather than extending default. Why: probably having lighter json context is beneficial for serialization in terms of performance.

And Appium (who is most likely on top of Selenium), will also provide their own json context, they are still able to define it on top of our default.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good idea. Then We can:

- internal Broker(BiDi bidi, Uri url)
+ internal Broker(SessionModule session, Uri url)

Meaning be closer to BiDi -> Broker -> Transport

{
BiDiJsonSerializerContext.Default
}
};

_jsonSerializerContext = new BiDiJsonSerializerContext(jsonSerializerOptions);
_jsonSerializerContext = jsonSerializerOptions;
}

[RequiresUnreferencedCode("Uses reflection-based JSON serialization")]
[RequiresDynamicCode("Uses reflection-based JSON serialization")]
public void EnableReflectionBasedJson()
{
_jsonSerializerContext.TypeInfoResolverChain.Add(new DefaultJsonTypeInfoResolver());
}

public void ProvideCustomSerializationContext(JsonSerializerContext extensionContext)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guidance for users: do not call this method after Broker.ConnectAsync is called. Json serialization options becomes immutable and this method will throw..

{
_jsonSerializerContext.TypeInfoResolverChain.Add(extensionContext);
}

public async Task ConnectAsync(CancellationToken cancellationToken)
public async Task ConnectAsync(CancellationToken cancellationToken = default)
{
await _transport.ConnectAsync(cancellationToken).ConfigureAwait(false);

Expand All @@ -120,7 +138,8 @@ private async Task ReceiveMessagesAsync(CancellationToken cancellationToken)
{
var data = await _transport.ReceiveAsync(cancellationToken).ConfigureAwait(false);

var message = JsonSerializer.Deserialize(new ReadOnlySpan<byte>(data), _jsonSerializerContext.Message);
var messageTypeInfo = (JsonTypeInfo<Message>)_jsonSerializerContext.GetTypeInfo(typeof(Message));
var message = JsonSerializer.Deserialize(new ReadOnlySpan<byte>(data), messageTypeInfo);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BiDiJsonSerializerContext is no longer "king".

We know that the Message JSON type info exists, but we must extract it manually now (AOT-safe).


switch (message)
{
Expand All @@ -131,9 +150,9 @@ private async Task ReceiveMessagesAsync(CancellationToken cancellationToken)
case MessageEvent messageEvent:
_pendingEvents.Add(messageEvent);
break;
case MessageError mesageError:
_pendingCommands[mesageError.Id].SetException(new BiDiException($"{mesageError.Error}: {mesageError.Message}"));
_pendingCommands.TryRemove(mesageError.Id, out _);
case MessageError messageError:
_pendingCommands[messageError.Id].SetException(new BiDiException($"{messageError.Error}: {messageError.Message}"));
_pendingCommands.TryRemove(messageError.Id, out _);
break;
}
}
Expand Down
Loading