[dotnet] [bidi] Stateful converters with hydration (#16670)

Author: nvborisenko

dotnet/src/webdriver/BiDi/BiDi.cs

@@ -31,13 +31,29 @@ public sealed class BiDi : IAsyncDisposable
 {
     private readonly ConcurrentDictionary<Type, Module> _modules = new();
 
+    private readonly JsonSerializerOptions _jsonOptions;
+
     private BiDi(string url)
     {
         var uri = new Uri(url);
 
         Broker = new Broker(this, uri);
+
+        _jsonOptions = new JsonSerializerOptions
+        {
+            PropertyNameCaseInsensitive = true,
+            PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+            DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+
+            Converters =
+            {
+                new DateTimeOffsetConverter(),
+            }
+        };
     }
 
+    private Broker Broker { get; }
+
     internal Session.SessionModule SessionModule => AsModule<Session.SessionModule>();
 
     public BrowsingContext.BrowsingContextModule BrowsingContext => AsModule<BrowsingContext.BrowsingContextModule>();
@@ -85,35 +101,6 @@ public async ValueTask DisposeAsync()
 
     public T AsModule<T>() where T : Module, new()
     {
-        return (T)_modules.GetOrAdd(typeof(T), _ => Module.Create<T>(this, Broker, GetJsonOptions()));
-    }
-
-    private Broker Broker { get; }
-
-    private JsonSerializerOptions GetJsonOptions()
-    {
-        return new JsonSerializerOptions
-        {
-            PropertyNameCaseInsensitive = true,
-            PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-            DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
-
-            // BiDi returns special numbers such as "NaN" as strings
-            // Additionally, -0 is returned as a string "-0"
-            NumberHandling = JsonNumberHandling.AllowNamedFloatingPointLiterals | JsonNumberHandling.AllowReadingFromString,
-            Converters =
-            {
-                new BrowsingContextConverter(this),
-                new BrowserUserContextConverter(this),
-                new CollectorConverter(this),
-                new InterceptConverter(this),
-                new HandleConverter(this),
-                new InternalIdConverter(this),
-                new PreloadScriptConverter(this),
-                new RealmConverter(this),
-                new DateTimeOffsetConverter(),
-                new WebExtensionConverter(this),
-            }
-        };
+        return (T)_modules.GetOrAdd(typeof(T), _ => Module.Create<T>(this, Broker, _jsonOptions));
     }
 }

dotnet/src/webdriver/BiDi/Broker.cs

@@ -304,6 +304,8 @@ private void ProcessReceivedMessage(byte[]? data)
                 {
                     var eventArgs = (EventArgs)JsonSerializer.Deserialize(ref paramsReader, eventInfo)!;
 
+                    eventArgs.BiDi = _bidi;
+
                     var messageEvent = (method, eventArgs);
                     _pendingEvents.Add(messageEvent);
                 }

dotnet/src/webdriver/BiDi/Browser/BrowserModule.cs

@@ -17,6 +17,7 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json.Converters;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using System.Threading.Tasks;
@@ -78,9 +79,17 @@ public async Task<SetDownloadBehaviorResult> SetDownloadBehaviorDeniedAsync(SetD
         return await Broker.ExecuteCommandAsync(new SetDownloadBehaviorCommand(@params), options, _jsonContext.SetDownloadBehaviorCommand, _jsonContext.SetDownloadBehaviorResult).ConfigureAwait(false);
     }
 
-    protected override void Initialize(JsonSerializerOptions options)
+    protected override void Initialize(JsonSerializerOptions jsonSerializerOptions)
     {
-        _jsonContext = new BrowserJsonSerializerContext(options);
+        var browserOptions = new JsonSerializerOptions(jsonSerializerOptions)
+        {
+            Converters =
+            {
+                new BrowserUserContextConverter(BiDi),
+            }
+        };
+
+        _jsonContext = new BrowserJsonSerializerContext(browserOptions);
     }
 }
 
@@ -96,4 +105,5 @@ protected override void Initialize(JsonSerializerOptions options)
 [JsonSerializable(typeof(GetClientWindowsResult))]
 [JsonSerializable(typeof(SetDownloadBehaviorCommand))]
 [JsonSerializable(typeof(SetDownloadBehaviorResult))]
+
 internal partial class BrowserJsonSerializerContext : JsonSerializerContext;

dotnet/src/webdriver/BiDi/Browser/UserContext.cs

@@ -18,45 +18,32 @@
 // </copyright>
 
 using System;
-using System.Threading.Tasks;
+using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi.Browser;
 
-public sealed class UserContext : IEquatable<UserContext>, IAsyncDisposable
+public sealed record UserContext
 {
-    private readonly BiDi _bidi;
-
-    internal UserContext(BiDi bidi, string id)
-    {
-        _bidi = bidi;
-        Id = id;
-    }
-
-    internal string Id { get; }
-
-    public Task RemoveAsync()
+    public UserContext(BiDi bidi, string id)
+        : this(id)
     {
-        return _bidi.Browser.RemoveUserContextAsync(this);
+        BiDi = bidi ?? throw new ArgumentNullException(nameof(bidi));
     }
 
-    public async ValueTask DisposeAsync()
+    [JsonConstructor]
+    internal UserContext(string id)
     {
-        await RemoveAsync().ConfigureAwait(false);
-    }
-
-    public bool Equals(UserContext? other)
-    {
-        return other is not null && string.Equals(Id, other.Id, StringComparison.Ordinal);
+        Id = id;
     }
 
+    internal string Id { get; }
 
-    public override bool Equals(object? obj)
-    {
-        return Equals(obj as UserContext);
-    }
+    private BiDi? _bidi;
 
-    public override int GetHashCode()
+    [JsonIgnore]
+    public BiDi BiDi
     {
-        return StringComparer.Ordinal.GetHashCode(Id);
+        get => _bidi ?? throw new InvalidOperationException($"{nameof(BiDi)} instance has not been hydrated.");
+        internal set => _bidi = value;
     }
 }

dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContext.cs

@@ -26,9 +26,15 @@ namespace OpenQA.Selenium.BiDi.BrowsingContext;
 
 public sealed class BrowsingContext
 {
-    internal BrowsingContext(BiDi bidi, string id)
+    public BrowsingContext(BiDi bidi, string id)
+        : this(id)
+    {
+        BiDi = bidi ?? throw new ArgumentNullException(nameof(bidi));
+    }
+
+    [JsonConstructor]
+    internal BrowsingContext(string id)
     {
-        BiDi = bidi;
         Id = id;
     }
 
@@ -40,8 +46,14 @@ internal BrowsingContext(BiDi bidi, string id)
 
     internal string Id { get; }
 
+    private BiDi? _bidi;
+
     [JsonIgnore]
-    public BiDi BiDi { get; }
+    public BiDi BiDi
+    {
+        get => _bidi ?? throw new InvalidOperationException($"{nameof(BiDi)} instance has not been hydrated.");
+        internal set => _bidi = value;
+    }
 
     [JsonIgnore]
     public BrowsingContextLogModule Log => _logModule ?? Interlocked.CompareExchange(ref _logModule, new BrowsingContextLogModule(this, BiDi.Log), null) ?? _logModule;

dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextModule.cs

@@ -17,6 +17,7 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json.Converters;
 using System;
 using System.Text.Json;
 using System.Text.Json.Serialization;
@@ -252,9 +253,20 @@ public async Task<Subscription> OnUserPromptClosedAsync(Action<UserPromptClosedE
         return await Broker.SubscribeAsync("browsingContext.userPromptClosed", handler, options, _jsonContext.UserPromptClosedEventArgs).ConfigureAwait(false);
     }
 
-    protected override void Initialize(JsonSerializerOptions options)
+    protected override void Initialize(JsonSerializerOptions jsonSerializerOptions)
     {
-        _jsonContext = new BrowsingContextJsonSerializerContext(options);
+        var browsingContextOptions = new JsonSerializerOptions(jsonSerializerOptions)
+        {
+            Converters =
+            {
+                new BrowsingContextConverter(BiDi),
+                new InternalIdConverter(BiDi),
+                new HandleConverter(BiDi),
+                new BrowserUserContextConverter(BiDi),
+            }
+        };
+
+        _jsonContext = new BrowsingContextJsonSerializerContext(browsingContextOptions);
     }
 }
 
@@ -292,4 +304,5 @@ protected override void Initialize(JsonSerializerOptions options)
 [JsonSerializable(typeof(NavigationInfo))]
 [JsonSerializable(typeof(UserPromptOpenedEventArgs))]
 [JsonSerializable(typeof(UserPromptClosedEventArgs))]
+
 internal partial class BrowsingContextJsonSerializerContext : JsonSerializerContext;

dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextNetworkModule.cs

@@ -25,52 +25,58 @@ namespace OpenQA.Selenium.BiDi.BrowsingContext;
 
 public sealed class BrowsingContextNetworkModule(BrowsingContext context, NetworkModule networkModule)
 {
-    public async Task<Intercept> InterceptRequestAsync(Func<InterceptedRequest, Task> handler, InterceptRequestOptions? options = null)
+    public async Task<Interception> InterceptRequestAsync(Func<InterceptedRequest, Task> handler, InterceptRequestOptions? options = null)
     {
         AddInterceptOptions addInterceptOptions = new(options)
         {
             Contexts = [context]
         };
 
-        var intercept = await networkModule.AddInterceptAsync([InterceptPhase.BeforeRequestSent], addInterceptOptions).ConfigureAwait(false);
+        var interceptResult = await networkModule.AddInterceptAsync([InterceptPhase.BeforeRequestSent], addInterceptOptions).ConfigureAwait(false);
 
-        await intercept.OnBeforeRequestSentAsync(
+        Interception interception = new(context.BiDi, interceptResult.Intercept);
+
+        await interception.OnBeforeRequestSentAsync(
             async req => await handler(new(req.BiDi, req.Context, req.IsBlocked, req.Navigation, req.RedirectCount, req.Request, req.Timestamp, req.Initiator, req.Intercepts)),
             new() { Contexts = [context] }).ConfigureAwait(false);
 
-        return intercept;
+        return interception;
     }
 
-    public async Task<Intercept> InterceptResponseAsync(Func<InterceptedResponse, Task> handler, InterceptResponseOptions? options = null)
+    public async Task<Interception> InterceptResponseAsync(Func<InterceptedResponse, Task> handler, InterceptResponseOptions? options = null)
     {
         AddInterceptOptions addInterceptOptions = new(options)
         {
             Contexts = [context]
         };
 
-        var intercept = await networkModule.AddInterceptAsync([InterceptPhase.ResponseStarted], addInterceptOptions).ConfigureAwait(false);
+        var interceptResult = await networkModule.AddInterceptAsync([InterceptPhase.ResponseStarted], addInterceptOptions).ConfigureAwait(false);
+
+        Interception interception = new(context.BiDi, interceptResult.Intercept);
 
-        await intercept.OnResponseStartedAsync(
+        await interception.OnResponseStartedAsync(
             async res => await handler(new(res.BiDi, res.Context, res.IsBlocked, res.Navigation, res.RedirectCount, res.Request, res.Timestamp, res.Response, res.Intercepts)),
             new() { Contexts = [context] }).ConfigureAwait(false);
 
-        return intercept;
+        return interception;
     }
 
-    public async Task<Intercept> InterceptAuthAsync(Func<InterceptedAuth, Task> handler, InterceptAuthOptions? options = null)
+    public async Task<Interception> InterceptAuthAsync(Func<InterceptedAuth, Task> handler, InterceptAuthOptions? options = null)
     {
         AddInterceptOptions addInterceptOptions = new(options)
         {
             Contexts = [context]
         };
 
-        var intercept = await networkModule.AddInterceptAsync([InterceptPhase.AuthRequired], addInterceptOptions).ConfigureAwait(false);
+        var interceptResult = await networkModule.AddInterceptAsync([InterceptPhase.AuthRequired], addInterceptOptions).ConfigureAwait(false);
+
+        Interception interception = new(context.BiDi, interceptResult.Intercept);
 
-        await intercept.OnAuthRequiredAsync(
+        await interception.OnAuthRequiredAsync(
             async auth => await handler(new(auth.BiDi, auth.Context, auth.IsBlocked, auth.Navigation, auth.RedirectCount, auth.Request, auth.Timestamp, auth.Response, auth.Intercepts)),
             new() { Contexts = [context] }).ConfigureAwait(false);
 
-        return intercept;
+        return interception;
     }
 
     public Task<SetCacheBehaviorResult> SetCacheBehaviorAsync(CacheBehavior behavior, BrowsingContextSetCacheBehaviorOptions? options = null)

dotnet/src/webdriver/BiDi/Emulation/EmulationModule.cs

@@ -17,6 +17,7 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json.Converters;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using System.Threading.Tasks;
@@ -92,9 +93,18 @@ public async Task<SetGeolocationOverrideResult> SetGeolocationPositionErrorOverr
         return await Broker.ExecuteCommandAsync(new SetGeolocationOverrideCommand(@params), options, _jsonContext.SetGeolocationOverrideCommand, _jsonContext.SetGeolocationOverrideResult).ConfigureAwait(false);
     }
 
-    protected override void Initialize(JsonSerializerOptions options)
+    protected override void Initialize(JsonSerializerOptions jsonSerializerOptions)
     {
-        _jsonContext = new EmulationJsonSerializerContext(options);
+        var emulationOptions = new JsonSerializerOptions(jsonSerializerOptions)
+        {
+            Converters =
+            {
+                new BrowsingContextConverter(BiDi),
+                new BrowserUserContextConverter(BiDi),
+            }
+        };
+
+        _jsonContext = new EmulationJsonSerializerContext(emulationOptions);
     }
 }
 
@@ -112,4 +122,5 @@ protected override void Initialize(JsonSerializerOptions options)
 [JsonSerializable(typeof(SetScreenOrientationOverrideResult))]
 [JsonSerializable(typeof(SetGeolocationOverrideCommand))]
 [JsonSerializable(typeof(SetGeolocationOverrideResult))]
+
 internal partial class EmulationJsonSerializerContext : JsonSerializerContext;

dotnet/src/webdriver/BiDi/EventArgs.cs

@@ -17,14 +17,21 @@
 // under the License.
 // </copyright>
 
+using System;
 using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi;
 
 public abstract record EventArgs
 {
+    private BiDi? _bidi;
+
     [JsonIgnore]
-    public BiDi BiDi { get; internal set; }
+    public BiDi BiDi
+    {
+        get => _bidi ?? throw new InvalidOperationException($"{nameof(BiDi)} instance has not been hydrated.");
+        internal set => _bidi = value;
+    }
 }
 
 public abstract record BrowsingContextEventArgs(BrowsingContext.BrowsingContext Context)