BiDi shared json context for built-in modules

nvborisenko · nvborisenko · commit c447d75c7496 · 2025-10-08T00:33:14.000+03:00
diff --git a/dotnet/src/webdriver/BiDi/BiDi.cs b/dotnet/src/webdriver/BiDi/BiDi.cs
@@ -24,6 +24,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json;
 using OpenQA.Selenium.BiDi.Communication.Json.Converters;
 
 namespace OpenQA.Selenium.BiDi;
@@ -32,6 +33,7 @@ public sealed class BiDi : IAsyncDisposable
 {
     private readonly Broker _broker;
     private readonly JsonSerializerOptions _jsonOptions;
+    private readonly BiDiJsonSerializerContext _jsonContext;
 
     private readonly ConcurrentDictionary<Type, Module> _modules = [];
 
@@ -63,6 +65,8 @@ private BiDi(string url)
             }
         };
 
+        _jsonContext = new BiDiJsonSerializerContext(_jsonOptions);
+
         _broker = new Broker(this, uri, _jsonOptions);
     }
 
@@ -88,7 +92,7 @@ private BiDi(string url)
 
     public TModule AsModule<TModule>() where TModule : Module, new()
     {
-        return (TModule)_modules.GetOrAdd(typeof(TModule), _ => Module.Create<TModule>(this, _broker, _jsonOptions));
+        return (TModule)_modules.GetOrAdd(typeof(TModule), _ => Module.Create<TModule>(this, _broker, _jsonOptions, _jsonContext));
     }
 
     public Task<Session.StatusResult> StatusAsync()
diff --git a/dotnet/src/webdriver/BiDi/Browser/BrowserModule.cs b/dotnet/src/webdriver/BiDi/Browser/BrowserModule.cs
@@ -18,9 +18,6 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
-using System.Collections.Generic;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Browser;
@@ -76,25 +73,4 @@ public async Task<EmptyResult> SetDownloadBehaviorDeniedAsync(SetDownloadBehavio
 
         return await Broker.ExecuteCommandAsync<SetDownloadBehaviorCommand, EmptyResult>(new SetDownloadBehaviorCommand(@params), options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BrowserModuleJsonSerializerContext(options);
-    }
 }
-
-[JsonSerializable(typeof(Command))]
-[JsonSerializable(typeof(EmptyResult))]
-
-[JsonSerializable(typeof(CloseCommand))]
-[JsonSerializable(typeof(CreateUserContextCommand))]
-[JsonSerializable(typeof(GetUserContextsCommand))]
-[JsonSerializable(typeof(GetUserContextsResult))]
-[JsonSerializable(typeof(RemoveUserContextCommand))]
-[JsonSerializable(typeof(GetClientWindowsCommand))]
-[JsonSerializable(typeof(GetClientWindowsResult))]
-[JsonSerializable(typeof(SetDownloadBehaviorCommand))]
-[JsonSerializable(typeof(UserContextInfo))]
-[JsonSerializable(typeof(IReadOnlyList<UserContextInfo>))]
-[JsonSerializable(typeof(IReadOnlyList<ClientWindowInfo>))]
-internal partial class BrowserModuleJsonSerializerContext : JsonSerializerContext;
diff --git a/dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextModule.cs b/dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextModule.cs
@@ -18,11 +18,8 @@
 // </copyright>
 
 using System;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 using OpenQA.Selenium.BiDi.Communication;
-using OpenQA.Selenium.BiDi.Communication.Json;
 
 namespace OpenQA.Selenium.BiDi.BrowsingContext;
 
@@ -253,9 +250,4 @@ public async Task<Subscription> OnUserPromptClosedAsync(Action<UserPromptClosedE
     {
         return await Broker.SubscribeAsync("browsingContext.userPromptClosed", handler, options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BiDiJsonSerializerContext(options);
-    }
 }
diff --git a/dotnet/src/webdriver/BiDi/Emulation/EmulationModule.cs b/dotnet/src/webdriver/BiDi/Emulation/EmulationModule.cs
@@ -17,12 +17,8 @@
 // under the License.
 // </copyright>
 
-using System;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 using OpenQA.Selenium.BiDi.Communication;
-using OpenQA.Selenium.BiDi.Communication.Json;
 
 namespace OpenQA.Selenium.BiDi.Emulation;
 
@@ -92,9 +88,4 @@ public async Task<EmptyResult> SetGeolocationPositionErrorOverrideAsync(SetGeolo
 
         return await Broker.ExecuteCommandAsync<SetGeolocationOverrideCommand, EmptyResult>(new SetGeolocationOverrideCommand(@params), options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BiDiJsonSerializerContext(options);
-    }
 }
diff --git a/dotnet/src/webdriver/BiDi/Input/InputModule.cs b/dotnet/src/webdriver/BiDi/Input/InputModule.cs
@@ -18,10 +18,7 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
-using OpenQA.Selenium.BiDi.Communication.Json;
 using System.Collections.Generic;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Input;
@@ -48,9 +45,4 @@ public async Task<EmptyResult> SetFilesAsync(BrowsingContext.BrowsingContext con
 
         return await Broker.ExecuteCommandAsync<SetFilesCommand, EmptyResult>(new SetFilesCommand(@params), options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BiDiJsonSerializerContext(options);
-    }
 }
diff --git a/dotnet/src/webdriver/BiDi/Log/LogModule.cs b/dotnet/src/webdriver/BiDi/Log/LogModule.cs
@@ -20,9 +20,6 @@
 using System.Threading.Tasks;
 using System;
 using OpenQA.Selenium.BiDi.Communication;
-using System.Text.Json;
-using OpenQA.Selenium.BiDi.Communication.Json;
-using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi.Log;
 
@@ -37,9 +34,4 @@ public async Task<Subscription> OnEntryAddedAsync(Action<LogEntry> handler, Subs
     {
         return await Broker.SubscribeAsync("log.entryAdded", handler, options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BiDiJsonSerializerContext(options);
-    }
 }
diff --git a/dotnet/src/webdriver/BiDi/Module.cs b/dotnet/src/webdriver/BiDi/Module.cs
@@ -18,26 +18,30 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json;
 using System.Text.Json;
-using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi;
 
 public abstract class Module
 {
-    protected JsonSerializerContext JsonContext { get; set; }
-
     protected Broker Broker { get; private set; }
 
-    protected internal abstract JsonSerializerContext ConfigureJson(JsonSerializerOptions options);
+    internal BiDiJsonSerializerContext JsonContext { get; set; }
+
+    protected virtual void Initialize(JsonSerializerOptions options) { }
 
-    public static TModule Create<TModule>(BiDi bidi, Broker broker, JsonSerializerOptions jsonOptions) where TModule : Module, new()
+    internal static TModule Create<TModule>(BiDi bidi, Broker broker, JsonSerializerOptions jsonOptions, BiDiJsonSerializerContext context)
+        where TModule : Module, new()
     {
         TModule module = new()
         {
-            Broker = broker
+            Broker = broker,
+            JsonContext = context
         };
-        module.JsonContext = module.ConfigureJson(jsonOptions);
+
+        module.Initialize(jsonOptions);
+
         return module;
     }
 }
diff --git a/dotnet/src/webdriver/BiDi/Network/NetworkModule.cs b/dotnet/src/webdriver/BiDi/Network/NetworkModule.cs
@@ -19,11 +19,8 @@
 
 using System;
 using System.Collections.Generic;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 using OpenQA.Selenium.BiDi.Communication;
-using OpenQA.Selenium.BiDi.Communication.Json;
 
 namespace OpenQA.Selenium.BiDi.Network;
 
@@ -176,9 +173,4 @@ public async Task<Subscription> OnAuthRequiredAsync(Action<AuthRequiredEventArgs
     {
         return await Broker.SubscribeAsync("network.authRequired", handler, options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BiDiJsonSerializerContext(options);
-    }
 }
diff --git a/dotnet/src/webdriver/BiDi/Script/ScriptModule.cs b/dotnet/src/webdriver/BiDi/Script/ScriptModule.cs
@@ -18,10 +18,7 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
-using OpenQA.Selenium.BiDi.Communication.Json;
 using System;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Script;
@@ -108,9 +105,4 @@ public async Task<Subscription> OnRealmDestroyedAsync(Action<RealmDestroyedEvent
     {
         return await Broker.SubscribeAsync("script.realmDestroyed", handler, options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BiDiJsonSerializerContext(options);
-    }
 }
diff --git a/dotnet/src/webdriver/BiDi/Session/SessionModule.cs b/dotnet/src/webdriver/BiDi/Session/SessionModule.cs
@@ -18,10 +18,7 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
-using OpenQA.Selenium.BiDi.Communication.Json;
 using System.Collections.Generic;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Session;
@@ -58,9 +55,4 @@ public async Task<EmptyResult> EndAsync(EndOptions? options = null)
     {
         return await Broker.ExecuteCommandAsync<EndCommand, EmptyResult>(new EndCommand(), options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BiDiJsonSerializerContext(options);
-    }
 }
diff --git a/dotnet/src/webdriver/BiDi/Storage/StorageModule.cs b/dotnet/src/webdriver/BiDi/Storage/StorageModule.cs
@@ -18,9 +18,6 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
-using OpenQA.Selenium.BiDi.Communication.Json;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Storage;
@@ -47,9 +44,4 @@ public async Task<SetCookieResult> SetCookieAsync(PartialCookie cookie, SetCooki
 
         return await Broker.ExecuteCommandAsync<SetCookieCommand, SetCookieResult>(new SetCookieCommand(@params), options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BiDiJsonSerializerContext(options);
-    }
 }
diff --git a/dotnet/src/webdriver/BiDi/WebExtension/WebExtensionModule.cs b/dotnet/src/webdriver/BiDi/WebExtension/WebExtensionModule.cs
@@ -18,9 +18,6 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
-using OpenQA.Selenium.BiDi.Communication.Json;
-using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.WebExtension;
@@ -40,9 +37,4 @@ public async Task<EmptyResult> UninstallAsync(Extension extension, UninstallOpti
 
         return await Broker.ExecuteCommandAsync<UninstallCommand, EmptyResult>(new UninstallCommand(@params), options, JsonContext).ConfigureAwait(false);
     }
-
-    protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)
-    {
-        return new BiDiJsonSerializerContext(options);
-    }
 }

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`using System.Threading;`
`25`	`25`	`using System.Threading.Tasks;`
`26`	`26`	`using OpenQA.Selenium.BiDi.Communication;`
	`27`	`+using OpenQA.Selenium.BiDi.Communication.Json;`
`27`	`28`	`using OpenQA.Selenium.BiDi.Communication.Json.Converters;`
`28`	`29`
`29`	`30`	`namespace OpenQA.Selenium.BiDi;`
`@@ -32,6 +33,7 @@ public sealed class BiDi : IAsyncDisposable`
`32`	`33`	`{`
`33`	`34`	`private readonly Broker _broker;`
`34`	`35`	`private readonly JsonSerializerOptions _jsonOptions;`
	`36`	`+ private readonly BiDiJsonSerializerContext _jsonContext;`
`35`	`37`
`36`	`38`	`private readonly ConcurrentDictionary<Type, Module> _modules = [];`
`37`	`39`
`@@ -63,6 +65,8 @@ private BiDi(string url)`
`63`	`65`	`}`
`64`	`66`	`};`
`65`	`67`
	`68`	`+ _jsonContext = new BiDiJsonSerializerContext(_jsonOptions);`
	`69`	`+`
`66`	`70`	`_broker = new Broker(this, uri, _jsonOptions);`
`67`	`71`	`}`
`68`	`72`
`@@ -88,7 +92,7 @@ private BiDi(string url)`
`88`	`92`
`89`	`93`	`public TModule AsModule<TModule>() where TModule : Module, new()`
`90`	`94`	`{`
`91`		`- return (TModule)_modules.GetOrAdd(typeof(TModule), _ => Module.Create<TModule>(this, _broker, _jsonOptions));`
	`95`	`+ return (TModule)_modules.GetOrAdd(typeof(TModule), _ => Module.Create<TModule>(this, _broker, _jsonOptions, _jsonContext));`
`92`	`96`	`}`
`93`	`97`
`94`	`98`	`public Task<Session.StatusResult> StatusAsync()`
Original file line number	Diff line number	Diff line change
`@@ -18,11 +18,8 @@`
`18`	`18`	`// </copyright>`
`19`	`19`
`20`	`20`	`using System;`
`21`		`-using System.Text.Json;`
`22`		`-using System.Text.Json.Serialization;`
`23`	`21`	`using System.Threading.Tasks;`
`24`	`22`	`using OpenQA.Selenium.BiDi.Communication;`
`25`		`-using OpenQA.Selenium.BiDi.Communication.Json;`
`26`	`23`
`27`	`24`	`namespace OpenQA.Selenium.BiDi.BrowsingContext;`
`28`	`25`
`@@ -253,9 +250,4 @@ public async Task<Subscription> OnUserPromptClosedAsync(Action<UserPromptClosedE`
`253`	`250`	`{`
`254`	`251`	`return await Broker.SubscribeAsync("browsingContext.userPromptClosed", handler, options, JsonContext).ConfigureAwait(false);`
`255`	`252`	`}`
`256`		`-`
`257`		`- protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)`
`258`		`- {`
`259`		`- return new BiDiJsonSerializerContext(options);`
`260`		`- }`
`261`	`253`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,6 @@`
`20`	`20`	`using System.Threading.Tasks;`
`21`	`21`	`using System;`
`22`	`22`	`using OpenQA.Selenium.BiDi.Communication;`
`23`		`-using System.Text.Json;`
`24`		`-using OpenQA.Selenium.BiDi.Communication.Json;`
`25`		`-using System.Text.Json.Serialization;`
`26`	`23`
`27`	`24`	`namespace OpenQA.Selenium.BiDi.Log;`
`28`	`25`
`@@ -37,9 +34,4 @@ public async Task<Subscription> OnEntryAddedAsync(Action<LogEntry> handler, Subs`
`37`	`34`	`{`
`38`	`35`	`return await Broker.SubscribeAsync("log.entryAdded", handler, options, JsonContext).ConfigureAwait(false);`
`39`	`36`	`}`
`40`		`-`
`41`		`- protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)`
`42`		`- {`
`43`		`- return new BiDiJsonSerializerContext(options);`
`44`		`- }`
`45`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,11 +19,8 @@`
`19`	`19`
`20`	`20`	`using System;`
`21`	`21`	`using System.Collections.Generic;`
`22`		`-using System.Text.Json;`
`23`		`-using System.Text.Json.Serialization;`
`24`	`22`	`using System.Threading.Tasks;`
`25`	`23`	`using OpenQA.Selenium.BiDi.Communication;`
`26`		`-using OpenQA.Selenium.BiDi.Communication.Json;`
`27`	`24`
`28`	`25`	`namespace OpenQA.Selenium.BiDi.Network;`
`29`	`26`
`@@ -176,9 +173,4 @@ public async Task<Subscription> OnAuthRequiredAsync(Action<AuthRequiredEventArgs`
`176`	`173`	`{`
`177`	`174`	`return await Broker.SubscribeAsync("network.authRequired", handler, options, JsonContext).ConfigureAwait(false);`
`178`	`175`	`}`
`179`		`-`
`180`		`- protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)`
`181`		`- {`
`182`		`- return new BiDiJsonSerializerContext(options);`
`183`		`- }`
`184`	`176`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,7 @@`
`18`	`18`	`// </copyright>`
`19`	`19`
`20`	`20`	`using OpenQA.Selenium.BiDi.Communication;`
`21`		`-using OpenQA.Selenium.BiDi.Communication.Json;`
`22`	`21`	`using System;`
`23`		`-using System.Text.Json;`
`24`		`-using System.Text.Json.Serialization;`
`25`	`22`	`using System.Threading.Tasks;`
`26`	`23`
`27`	`24`	`namespace OpenQA.Selenium.BiDi.Script;`
`@@ -108,9 +105,4 @@ public async Task<Subscription> OnRealmDestroyedAsync(Action<RealmDestroyedEvent`
`108`	`105`	`{`
`109`	`106`	`return await Broker.SubscribeAsync("script.realmDestroyed", handler, options, JsonContext).ConfigureAwait(false);`
`110`	`107`	`}`
`111`		`-`
`112`		`- protected internal override JsonSerializerContext ConfigureJson(JsonSerializerOptions options)`
`113`		`- {`
`114`		`- return new BiDiJsonSerializerContext(options);`
`115`		`- }`
`116`	`108`	`}`