[dotnet] [bidi] Stateful converters with hydration

dotnet/src/webdriver/BiDi/BiDi.cs

@@ -85,7 +85,7 @@ public async ValueTask DisposeAsync()
 
     public T AsModule<T>() where T : Module, new()
     {
-        return (T)_modules.GetOrAdd(typeof(T), _ => Module.Create<T>(this, Broker, GetJsonOptions()));
+        return (T)_modules.GetOrAdd(typeof(T), _ => Module.Create<T>(this, Broker));
     }
 
     private Broker Broker { get; }
@@ -94,25 +94,25 @@ private JsonSerializerOptions GetJsonOptions()
     {
         return new JsonSerializerOptions
         {
-            PropertyNameCaseInsensitive = true,
-            PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-            DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+            //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 BrowsingContextConverter(),
+                //new BrowserUserContextConverter(),
+                //new CollectorConverter(),
+                //new InterceptConverter(),
+                //new HandleConverter(),
+                //new InternalIdConverter(),
+                //new PreloadScriptConverter(),
+                //new RealmConverter(),
                 new DateTimeOffsetConverter(),
-                new WebExtensionConverter(this),
+                //new WebExtensionConverter(),
             }
         };
     }

dotnet/src/webdriver/BiDi/Broker.cs

@@ -279,6 +279,11 @@ private void ProcessReceivedMessage(byte[]? data)
                         var commandResult = JsonSerializer.Deserialize(ref resultReader, command.JsonResultTypeInfo)
                             ?? throw new JsonException("Remote end returned null command result in the 'result' property.");
 
+                        if (commandResult is IBiDiHydratable bidiHydratable)
+                        {
+                            bidiHydratable.Hydrate(_bidi);
+                        }
+
                         command.TaskCompletionSource.SetResult((EmptyResult)commandResult);
                     }
                     catch (Exception ex)
@@ -304,6 +309,11 @@ private void ProcessReceivedMessage(byte[]? data)
                 {
                     var eventArgs = (EventArgs)JsonSerializer.Deserialize(ref paramsReader, eventInfo)!;
 
+                    if (eventArgs is IBiDiHydratable bidiHydratable)
+                    {
+                        bidiHydratable.Hydrate(_bidi);
+                    }
+
                     var messageEvent = (method, eventArgs);
                     _pendingEvents.Add(messageEvent);
                 }

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

@@ -17,15 +17,15 @@
 // under the License.
 // </copyright>
 
-using System.Text.Json;
+using OpenQA.Selenium.BiDi.Json.Converters;
 using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Browser;
 
 public sealed class BrowserModule : Module
 {
-    private BrowserJsonSerializerContext _jsonContext = null!;
+    private static readonly BrowserJsonSerializerContext _jsonContext = BrowserJsonSerializerContext.Default;
 
     public async Task<CloseResult> CloseAsync(CloseOptions? options = null)
     {
@@ -77,11 +77,6 @@ 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)
-    {
-        _jsonContext = new BrowserJsonSerializerContext(options);
-    }
 }
 
 [JsonSerializable(typeof(CloseCommand))]
@@ -96,4 +91,12 @@ protected override void Initialize(JsonSerializerOptions options)
 [JsonSerializable(typeof(GetClientWindowsResult))]
 [JsonSerializable(typeof(SetDownloadBehaviorCommand))]
 [JsonSerializable(typeof(SetDownloadBehaviorResult))]
+
+#pragma warning disable CS3016 // Arrays as attribute arguments is not CLS-compliant
+[JsonSourceGenerationOptions(
+    PropertyNameCaseInsensitive = true,
+    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+    PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
+    Converters = [typeof(DateTimeOffsetConverter)])]
+#pragma warning restore CS3016 // Arrays as attribute arguments is not CLS-compliant
 internal partial class BrowserJsonSerializerContext : JsonSerializerContext;

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

@@ -33,4 +33,10 @@ public sealed class CreateUserContextOptions : CommandOptions
     public Session.UserPromptHandler? UnhandledPromptBehavior { get; set; }
 }
 
-public sealed record CreateUserContextResult(UserContext UserContext) : UserContextInfo(UserContext);
+public sealed record CreateUserContextResult(UserContext UserContext) : UserContextInfo(UserContext), IBiDiHydratable
+{
+    void IBiDiHydratable.Hydrate(BiDi bidi)
+    {
+        UserContext.BiDi = bidi;
+    }
+}

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

@@ -17,26 +17,29 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json.Converters;
 using System;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Browser;
 
+[JsonConverter(typeof(BrowserUserContextConverter))]
 public sealed class UserContext : IEquatable<UserContext>, IAsyncDisposable
 {
-    private readonly BiDi _bidi;
-
-    internal UserContext(BiDi bidi, string id)
+    internal UserContext(string id)
     {
-        _bidi = bidi;
         Id = id;
     }
 
     internal string Id { get; }
 
+    [JsonIgnore]
+    public BiDi BiDi { get; internal set; }
+
     public Task RemoveAsync()
     {
-        return _bidi.Browser.RemoveUserContextAsync(this);
+        return BiDi.Browser.RemoveUserContextAsync(this);
     }
 
     public async ValueTask DisposeAsync()

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

@@ -17,18 +17,19 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json.Converters;
 using System;
 using System.Text.Json.Serialization;
 using System.Threading;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.BrowsingContext;
 
+[JsonConverter(typeof(BrowsingContextConverter))]
 public sealed class BrowsingContext
 {
-    internal BrowsingContext(BiDi bidi, string id)
+    internal BrowsingContext(string id)
     {
-        BiDi = bidi;
         Id = id;
     }
 
@@ -41,7 +42,7 @@ internal BrowsingContext(BiDi bidi, string id)
     internal string Id { get; }
 
     [JsonIgnore]
-    public BiDi BiDi { get; }
+    public BiDi BiDi { get; internal set; }
 
     [JsonIgnore]
     public BrowsingContextLogModule Log => _logModule ?? Interlocked.CompareExchange(ref _logModule, new BrowsingContextLogModule(this, BiDi.Log), null) ?? _logModule;

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

@@ -17,16 +17,16 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json.Converters;
 using System;
-using System.Text.Json;
 using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.BrowsingContext;
 
 public sealed class BrowsingContextModule : Module
 {
-    private BrowsingContextJsonSerializerContext _jsonContext = null!;
+    private static readonly BrowsingContextJsonSerializerContext _jsonContext = BrowsingContextJsonSerializerContext.Default;
 
     public async Task<CreateResult> CreateAsync(ContextType type, CreateOptions? options = null)
     {
@@ -251,11 +251,6 @@ 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)
-    {
-        _jsonContext = new BrowsingContextJsonSerializerContext(options);
-    }
 }
 
 [JsonSerializable(typeof(ActivateCommand))]
@@ -292,4 +287,12 @@ protected override void Initialize(JsonSerializerOptions options)
 [JsonSerializable(typeof(NavigationInfo))]
 [JsonSerializable(typeof(UserPromptOpenedEventArgs))]
 [JsonSerializable(typeof(UserPromptClosedEventArgs))]
+
+#pragma warning disable CS3016 // Arrays as attribute arguments is not CLS-compliant
+[JsonSourceGenerationOptions(
+    PropertyNameCaseInsensitive = true,
+    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+    PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
+    Converters = [typeof(DateTimeOffsetConverter)])]
+#pragma warning restore CS3016 // Arrays as attribute arguments is not CLS-compliant
 internal partial class BrowsingContextJsonSerializerContext : JsonSerializerContext;

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

@@ -43,4 +43,10 @@ public enum ContextType
     Window
 }
 
-public sealed record CreateResult(BrowsingContext Context) : EmptyResult;
+public sealed record CreateResult(BrowsingContext Context) : EmptyResult, IBiDiHydratable
+{
+    void IBiDiHydratable.Hydrate(BiDi bidi)
+    {
+        Context.BiDi = bidi;
+    }
+}

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

@@ -45,4 +45,13 @@ public sealed record BrowsingContextGetTreeOptions
     public long? MaxDepth { get; set; }
 }
 
-public sealed record GetTreeResult(IReadOnlyList<BrowsingContextInfo> Contexts) : EmptyResult;
+public sealed record GetTreeResult(IReadOnlyList<BrowsingContextInfo> Contexts) : EmptyResult, IBiDiHydratable
+{
+    void IBiDiHydratable.Hydrate(BiDi bidi)
+    {
+        foreach (var contextInfo in Contexts)
+        {
+            contextInfo.Context.BiDi = bidi;
+        }
+    }
+}

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

@@ -17,15 +17,15 @@
 // under the License.
 // </copyright>
 
-using System.Text.Json;
+using OpenQA.Selenium.BiDi.Json.Converters;
 using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Emulation;
 
 public sealed class EmulationModule : Module
 {
-    private EmulationJsonSerializerContext _jsonContext = null!;
+    private static readonly EmulationJsonSerializerContext _jsonContext = EmulationJsonSerializerContext.Default;
 
     public async Task<SetTimezoneOverrideResult> SetTimezoneOverrideAsync(string? timezone, SetTimezoneOverrideOptions? options = null)
     {
@@ -91,11 +91,6 @@ 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)
-    {
-        _jsonContext = new EmulationJsonSerializerContext(options);
-    }
 }
 
 [JsonSerializable(typeof(SetTimezoneOverrideCommand))]
@@ -112,4 +107,12 @@ protected override void Initialize(JsonSerializerOptions options)
 [JsonSerializable(typeof(SetScreenOrientationOverrideResult))]
 [JsonSerializable(typeof(SetGeolocationOverrideCommand))]
 [JsonSerializable(typeof(SetGeolocationOverrideResult))]
+
+#pragma warning disable CS3016 // Arrays as attribute arguments is not CLS-compliant
+[JsonSourceGenerationOptions(
+    PropertyNameCaseInsensitive = true,
+    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+    PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
+    Converters = [typeof(DateTimeOffsetConverter)])]
+#pragma warning restore CS3016 // Arrays as attribute arguments is not CLS-compliant
 internal partial class EmulationJsonSerializerContext : JsonSerializerContext;

dotnet/src/webdriver/BiDi/EventArgs.cs

@@ -21,10 +21,15 @@
 
 namespace OpenQA.Selenium.BiDi;
 
-public abstract record EventArgs
+public abstract record EventArgs : IBiDiHydratable
 {
     [JsonIgnore]
     public BiDi BiDi { get; internal set; }
+
+    void IBiDiHydratable.Hydrate(BiDi bidi)
+    {
+        BiDi = bidi;
+    }
 }
 
 public abstract record BrowsingContextEventArgs(BrowsingContext.BrowsingContext Context)

dotnet/src/webdriver/BiDi/IBiDiHydratable.cs

@@ -0,0 +1,25 @@
+// <copyright file="IBiDiHydratable.cs" company="Selenium Committers">
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+// </copyright>
+
+namespace OpenQA.Selenium.BiDi;
+
+public interface IBiDiHydratable
+{
+    internal void Hydrate(BiDi bidi);
+}

dotnet/src/webdriver/BiDi/Input/InputModule.cs

@@ -17,16 +17,16 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json.Converters;
 using System.Collections.Generic;
-using System.Text.Json;
 using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Input;
 
 public sealed class InputModule : Module
 {
-    private InputJsonSerializerContext _jsonContext = null!;
+    private static readonly InputJsonSerializerContext _jsonContext = InputJsonSerializerContext.Default;
 
     public async Task<PerformActionsResult> PerformActionsAsync(BrowsingContext.BrowsingContext context, IEnumerable<SourceActions> actions, PerformActionsOptions? options = null)
     {
@@ -48,11 +48,6 @@ public async Task<SetFilesResult> SetFilesAsync(BrowsingContext.BrowsingContext
 
         return await Broker.ExecuteCommandAsync(new SetFilesCommand(@params), options, _jsonContext.SetFilesCommand, _jsonContext.SetFilesResult).ConfigureAwait(false);
     }
-
-    protected override void Initialize(JsonSerializerOptions options)
-    {
-        _jsonContext = new InputJsonSerializerContext(options);
-    }
 }
 
 [JsonSerializable(typeof(PerformActionsCommand))]
@@ -65,4 +60,12 @@ protected override void Initialize(JsonSerializerOptions options)
 [JsonSerializable(typeof(IEnumerable<IKeySourceAction>))]
 [JsonSerializable(typeof(IEnumerable<INoneSourceAction>))]
 [JsonSerializable(typeof(IEnumerable<IWheelSourceAction>))]
+
+#pragma warning disable CS3016 // Arrays as attribute arguments is not CLS-compliant
+[JsonSourceGenerationOptions(
+    PropertyNameCaseInsensitive = true,
+    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+    PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
+    Converters = [typeof(DateTimeOffsetConverter)])]
+#pragma warning restore CS3016 // Arrays as attribute arguments is not CLS-compliant
 internal partial class InputJsonSerializerContext : JsonSerializerContext;