[dotnet] [bidi] Maintain JSON converters with their respective types

RenderMichael · RenderMichael · commit fd619197e0f2 · 2025-03-15T01:15:23.000-04:00
diff --git a/dotnet/src/webdriver/BiDi/Communication/Broker.cs b/dotnet/src/webdriver/BiDi/Communication/Broker.cs
@@ -67,21 +67,14 @@ internal Broker(BiDi bidi, Uri url)
             Converters =
             {
                 new BrowsingContextConverter(_bidi),
-                new BrowserUserContextConverter(bidi),
-                new BrowserClientWindowConverter(),
-                new NavigationConverter(),
+                new BrowserUserContextConverter(_bidi),
                 new InterceptConverter(_bidi),
                 new RequestConverter(_bidi),
-                new ChannelConverter(),
                 new HandleConverter(_bidi),
                 new InternalIdConverter(_bidi),
                 new PreloadScriptConverter(_bidi),
                 new RealmConverter(_bidi),
-                new RealmTypeConverter(),
-                new DateTimeOffsetConverter(),
-                new PrintPageRangeConverter(),
-                new InputOriginConverter(),
-                new SubscriptionConverter(),
+                new BiDiDateTimeOffsetConverter(),
                 new JsonStringEnumConverter(JsonNamingPolicy.CamelCase),
 
                 // https://github.com/dotnet/runtime/issues/72604
@@ -90,15 +83,6 @@ internal Broker(BiDi bidi, Uri url)
                 new Json.Converters.Polymorphic.RemoteValueConverter(),
                 new Json.Converters.Polymorphic.RealmInfoConverter(),
                 new Json.Converters.Polymorphic.LogEntryConverter(),
-                //
-
-                // Enumerable
-                new Json.Converters.Enumerable.GetCookiesResultConverter(),
-                new Json.Converters.Enumerable.LocateNodesResultConverter(),
-                new Json.Converters.Enumerable.InputSourceActionsConverter(),
-                new Json.Converters.Enumerable.GetUserContextsResultConverter(),
-                new Json.Converters.Enumerable.GetClientWindowsResultConverter(),
-                new Json.Converters.Enumerable.GetRealmsResultConverter(),
             }
         };
 
diff --git a/dotnet/src/webdriver/BiDi/Communication/Json/Converters/BiDiDateTimeOffsetConverter.cs b/dotnet/src/webdriver/BiDi/Communication/Json/Converters/BiDiDateTimeOffsetConverter.cs
@@ -1,4 +1,4 @@
-// <copyright file="DateTimeOffsetConverter.cs" company="Selenium Committers">
+// <copyright file="BiDiDateTimeOffsetConverter.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
@@ -23,7 +23,7 @@
 
 namespace OpenQA.Selenium.BiDi.Communication.Json.Converters;
 
-internal class DateTimeOffsetConverter : JsonConverter<DateTimeOffset>
+internal class BiDiDateTimeOffsetConverter : JsonConverter<DateTimeOffset>
 {
     public override DateTimeOffset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
diff --git a/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/GetClientWindowsResultConverter.cs b/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/GetClientWindowsResultConverter.cs
@@ -37,6 +37,6 @@ public override GetClientWindowsResult Read(ref Utf8JsonReader reader, Type type
 
     public override void Write(Utf8JsonWriter writer, GetClientWindowsResult value, JsonSerializerOptions options)
     {
-        throw new NotImplementedException();
+        throw new NotSupportedException();
     }
 }
diff --git a/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/GetCookiesResultConverter.cs b/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/GetCookiesResultConverter.cs
@@ -38,6 +38,6 @@ public override GetCookiesResult Read(ref Utf8JsonReader reader, Type typeToConv
 
     public override void Write(Utf8JsonWriter writer, GetCookiesResult value, JsonSerializerOptions options)
     {
-        throw new NotImplementedException();
+        throw new NotSupportedException();
     }
 }
diff --git a/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/GetRealmsResultConverter.cs b/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/GetRealmsResultConverter.cs
@@ -37,6 +37,6 @@ public override GetRealmsResult Read(ref Utf8JsonReader reader, Type typeToConve
 
     public override void Write(Utf8JsonWriter writer, GetRealmsResult value, JsonSerializerOptions options)
     {
-        throw new NotImplementedException();
+        throw new NotSupportedException();
     }
 }
diff --git a/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/GetUserContextsResultConverter.cs b/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/GetUserContextsResultConverter.cs
@@ -37,6 +37,6 @@ public override GetUserContextsResult Read(ref Utf8JsonReader reader, Type typeT
 
     public override void Write(Utf8JsonWriter writer, GetUserContextsResult value, JsonSerializerOptions options)
     {
-        throw new NotImplementedException();
+        throw new NotSupportedException();
     }
 }
diff --git a/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/InputSourceActionsConverter.cs b/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/InputSourceActionsConverter.cs
@@ -29,7 +29,7 @@ internal class InputSourceActionsConverter : JsonConverter<SourceActions>
 {
     public override SourceActions Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
-        throw new NotImplementedException();
+        throw new NotSupportedException();
     }
 
     public override void Write(Utf8JsonWriter writer, SourceActions value, JsonSerializerOptions options)
diff --git a/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/LocateNodesResultConverter.cs b/dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/LocateNodesResultConverter.cs
@@ -38,6 +38,6 @@ public override LocateNodesResult Read(ref Utf8JsonReader reader, Type typeToCon
 
     public override void Write(Utf8JsonWriter writer, LocateNodesResult value, JsonSerializerOptions options)
     {
-        throw new NotImplementedException();
+        throw new NotSupportedException();
     }
 }
diff --git a/dotnet/src/webdriver/BiDi/Communication/Json/Converters/InputOriginConverter.cs b/dotnet/src/webdriver/BiDi/Communication/Json/Converters/InputOriginConverter.cs
@@ -28,7 +28,7 @@ internal class InputOriginConverter : JsonConverter<Origin>
 {
     public override Origin Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
-        throw new NotImplementedException();
+        throw new NotSupportedException();
     }
 
     public override void Write(Utf8JsonWriter writer, Origin value, JsonSerializerOptions options)
diff --git a/dotnet/src/webdriver/BiDi/Communication/Json/Converters/PrintPageRangeConverter.cs b/dotnet/src/webdriver/BiDi/Communication/Json/Converters/PrintPageRangeConverter.cs
@@ -28,7 +28,7 @@ internal class PrintPageRangeConverter : JsonConverter<PrintPageRange>
 {
     public override PrintPageRange Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
-        throw new NotImplementedException();
+        throw new NotSupportedException();
     }
 
     public override void Write(Utf8JsonWriter writer, PrintPageRange value, JsonSerializerOptions options)
diff --git a/dotnet/src/webdriver/BiDi/Modules/Browser/ClientWindow.cs b/dotnet/src/webdriver/BiDi/Modules/Browser/ClientWindow.cs
@@ -17,8 +17,12 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
+using System.Text.Json.Serialization;
+
 namespace OpenQA.Selenium.BiDi.Modules.Browser;
 
+[JsonConverter(typeof(BrowserClientWindowConverter))]
 public record ClientWindow
 {
     internal ClientWindow(string id)
diff --git a/dotnet/src/webdriver/BiDi/Modules/Browser/GetClientWindowsCommand.cs b/dotnet/src/webdriver/BiDi/Modules/Browser/GetClientWindowsCommand.cs
@@ -18,8 +18,10 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json.Converters.Enumerable;
 using System.Collections;
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi.Modules.Browser;
 
@@ -28,6 +30,7 @@ internal class GetClientWindowsCommand()
 
 public record GetClientWindowsOptions : CommandOptions;
 
+[JsonConverter(typeof(GetClientWindowsResultConverter))]
 public record GetClientWindowsResult : IReadOnlyList<ClientWindowInfo>
 {
     private readonly IReadOnlyList<ClientWindowInfo> _clientWindows;
diff --git a/dotnet/src/webdriver/BiDi/Modules/Browser/GetUserContextsCommand.cs b/dotnet/src/webdriver/BiDi/Modules/Browser/GetUserContextsCommand.cs
@@ -18,8 +18,10 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json.Converters.Enumerable;
 using System.Collections;
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi.Modules.Browser;
 
@@ -28,6 +30,7 @@ internal class GetUserContextsCommand()
 
 public record GetUserContextsOptions : CommandOptions;
 
+[JsonConverter(typeof(GetUserContextsResultConverter))]
 public record GetUserContextsResult : IReadOnlyList<UserContextInfo>
 {
     private readonly IReadOnlyList<UserContextInfo> _userContexts;
diff --git a/dotnet/src/webdriver/BiDi/Modules/BrowsingContext/LocateNodesCommand.cs b/dotnet/src/webdriver/BiDi/Modules/BrowsingContext/LocateNodesCommand.cs
@@ -18,8 +18,10 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json.Converters.Enumerable;
 using System.Collections;
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi.Modules.BrowsingContext;
 
@@ -37,6 +39,7 @@ public record LocateNodesOptions : CommandOptions
     public IEnumerable<Script.ISharedReference>? StartNodes { get; set; }
 }
 
+[JsonConverter(typeof(LocateNodesResultConverter))]
 public record LocateNodesResult : IReadOnlyList<Script.RemoteValue.Node>
 {
     private readonly IReadOnlyList<Script.RemoteValue.Node> _nodes;
diff --git a/dotnet/src/webdriver/BiDi/Modules/BrowsingContext/Navigation.cs b/dotnet/src/webdriver/BiDi/Modules/BrowsingContext/Navigation.cs
@@ -17,6 +17,10 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
+using System.Text.Json.Serialization;
+
 namespace OpenQA.Selenium.BiDi.Modules.BrowsingContext;
 
+[JsonConverter(typeof(NavigationConverter))]
 public record Navigation(string Id);
diff --git a/dotnet/src/webdriver/BiDi/Modules/BrowsingContext/PrintCommand.cs b/dotnet/src/webdriver/BiDi/Modules/BrowsingContext/PrintCommand.cs
@@ -18,8 +18,10 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
 using System;
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi.Modules.BrowsingContext;
 
@@ -69,6 +71,7 @@ public struct PrintPage
     public double? Width { get; set; }
 }
 
+[JsonConverter(typeof(PrintPageRangeConverter))]
 public readonly record struct PrintPageRange(int? Start, int? End)
 {
     public static implicit operator PrintPageRange(int index) { return new PrintPageRange(index, index); }
diff --git a/dotnet/src/webdriver/BiDi/Modules/Input/Origin.cs b/dotnet/src/webdriver/BiDi/Modules/Input/Origin.cs
@@ -17,10 +17,12 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
 using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi.Modules.Input;
 
+[JsonConverter(typeof(InputOriginConverter))]
 public abstract record Origin
 {
     public record Viewport() : Origin;
diff --git a/dotnet/src/webdriver/BiDi/Modules/Input/SourceActions.cs b/dotnet/src/webdriver/BiDi/Modules/Input/SourceActions.cs
@@ -17,13 +17,15 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Communication.Json.Converters.Enumerable;
 using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi.Modules.Input;
 
+[JsonConverter(typeof(InputSourceActionsConverter))]
 public abstract record SourceActions
 {
     public string Id { get; } = Guid.NewGuid().ToString();
diff --git a/dotnet/src/webdriver/BiDi/Modules/Script/Channel.cs b/dotnet/src/webdriver/BiDi/Modules/Script/Channel.cs
@@ -17,6 +17,10 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
+using System.Text.Json.Serialization;
+
 namespace OpenQA.Selenium.BiDi.Modules.Script;
 
+[JsonConverter(typeof(ChannelConverter))]
 public record Channel(string Id);
diff --git a/dotnet/src/webdriver/BiDi/Modules/Script/GetRealmsCommand.cs b/dotnet/src/webdriver/BiDi/Modules/Script/GetRealmsCommand.cs
@@ -18,8 +18,10 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json.Converters.Enumerable;
 using System.Collections;
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi.Modules.Script;
 
@@ -35,6 +37,7 @@ public record GetRealmsOptions : CommandOptions
     public RealmType? Type { get; set; }
 }
 
+[JsonConverter(typeof(GetRealmsResultConverter))]
 public record GetRealmsResult : IReadOnlyList<RealmInfo>
 {
     private readonly IReadOnlyList<RealmInfo> _realms;
diff --git a/dotnet/src/webdriver/BiDi/Modules/Script/RealmType.cs b/dotnet/src/webdriver/BiDi/Modules/Script/RealmType.cs
@@ -17,8 +17,12 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
+using System.Text.Json.Serialization;
+
 namespace OpenQA.Selenium.BiDi.Modules.Script;
 
+[JsonConverter(typeof(RealmTypeConverter))]
 public enum RealmType
 {
     Window,
diff --git a/dotnet/src/webdriver/BiDi/Modules/Session/Subscription.cs b/dotnet/src/webdriver/BiDi/Modules/Session/Subscription.cs
@@ -17,8 +17,12 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
+using System.Text.Json.Serialization;
+
 namespace OpenQA.Selenium.BiDi.Modules.Session;
 
+[JsonConverter(typeof(SubscriptionConverter))]
 public sealed class Subscription
 {
     internal Subscription(string id)
diff --git a/dotnet/src/webdriver/BiDi/Modules/Storage/GetCookiesCommand.cs b/dotnet/src/webdriver/BiDi/Modules/Storage/GetCookiesCommand.cs
@@ -18,6 +18,7 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json.Converters.Enumerable;
 using System;
 using System.Collections;
 using System.Collections.Generic;
@@ -37,6 +38,7 @@ public record GetCookiesOptions : CommandOptions
     public PartitionDescriptor? Partition { get; set; }
 }
 
+[JsonConverter(typeof(GetCookiesResultConverter))]
 public record GetCookiesResult : IReadOnlyList<Network.Cookie>
 {
     private readonly IReadOnlyList<Network.Cookie> _cookies;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// <copyright file="DateTimeOffsetConverter.cs" company="Selenium Committers">`
	`1`	`+// <copyright file="BiDiDateTimeOffsetConverter.cs" company="Selenium Committers">`
`2`	`2`	`// Licensed to the Software Freedom Conservancy (SFC) under one`
`3`	`3`	`// or more contributor license agreements. See the NOTICE file`
`4`	`4`	`// distributed with this work for additional information`
`@@ -23,7 +23,7 @@`
`23`	`23`
`24`	`24`	`namespace OpenQA.Selenium.BiDi.Communication.Json.Converters;`
`25`	`25`
`26`		`-internal class DateTimeOffsetConverter : JsonConverter<DateTimeOffset>`
	`26`	`+internal class BiDiDateTimeOffsetConverter : JsonConverter<DateTimeOffset>`
`27`	`27`	`{`
`28`	`28`	`public override DateTimeOffset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)`
`29`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,6 @@ public override GetClientWindowsResult Read(ref Utf8JsonReader reader, Type type`
`37`	`37`
`38`	`38`	`public override void Write(Utf8JsonWriter writer, GetClientWindowsResult value, JsonSerializerOptions options)`
`39`	`39`	`{`
`40`		`- throw new NotImplementedException();`
	`40`	`+ throw new NotSupportedException();`
`41`	`41`	`}`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,6 @@ public override GetCookiesResult Read(ref Utf8JsonReader reader, Type typeToConv`
`38`	`38`
`39`	`39`	`public override void Write(Utf8JsonWriter writer, GetCookiesResult value, JsonSerializerOptions options)`
`40`	`40`	`{`
`41`		`- throw new NotImplementedException();`
	`41`	`+ throw new NotSupportedException();`
`42`	`42`	`}`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,6 @@ public override GetRealmsResult Read(ref Utf8JsonReader reader, Type typeToConve`
`37`	`37`
`38`	`38`	`public override void Write(Utf8JsonWriter writer, GetRealmsResult value, JsonSerializerOptions options)`
`39`	`39`	`{`
`40`		`- throw new NotImplementedException();`
	`40`	`+ throw new NotSupportedException();`
`41`	`41`	`}`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,6 @@ public override GetUserContextsResult Read(ref Utf8JsonReader reader, Type typeT`
`37`	`37`
`38`	`38`	`public override void Write(Utf8JsonWriter writer, GetUserContextsResult value, JsonSerializerOptions options)`
`39`	`39`	`{`
`40`		`- throw new NotImplementedException();`
	`40`	`+ throw new NotSupportedException();`
`41`	`41`	`}`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ internal class InputSourceActionsConverter : JsonConverter<SourceActions>`
`29`	`29`	`{`
`30`	`30`	`public override SourceActions Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)`
`31`	`31`	`{`
`32`		`- throw new NotImplementedException();`
	`32`	`+ throw new NotSupportedException();`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`public override void Write(Utf8JsonWriter writer, SourceActions value, JsonSerializerOptions options)`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,6 @@ public override LocateNodesResult Read(ref Utf8JsonReader reader, Type typeToCon`
`38`	`38`
`39`	`39`	`public override void Write(Utf8JsonWriter writer, LocateNodesResult value, JsonSerializerOptions options)`
`40`	`40`	`{`
`41`		`- throw new NotImplementedException();`
	`41`	`+ throw new NotSupportedException();`
`42`	`42`	`}`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ internal class InputOriginConverter : JsonConverter<Origin>`
`28`	`28`	`{`
`29`	`29`	`public override Origin Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)`
`30`	`30`	`{`
`31`		`- throw new NotImplementedException();`
	`31`	`+ throw new NotSupportedException();`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`public override void Write(Utf8JsonWriter writer, Origin value, JsonSerializerOptions options)`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ internal class PrintPageRangeConverter : JsonConverter<PrintPageRange>`
`28`	`28`	`{`
`29`	`29`	`public override PrintPageRange Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)`
`30`	`30`	`{`
`31`		`- throw new NotImplementedException();`
	`31`	`+ throw new NotSupportedException();`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`public override void Write(Utf8JsonWriter writer, PrintPageRange value, JsonSerializerOptions options)`