Separate DevTools JSON serialization context per domain

RenderMichael · RenderMichael · commit cfa54014cd34 · 2025-01-28T00:59:43.000-05:00
diff --git a/dotnet/src/webdriver/DevTools/DevToolsDomains.cs b/dotnet/src/webdriver/DevTools/DevToolsDomains.cs
@@ -20,6 +20,8 @@
 using System;
 using System.Collections.Generic;
 using System.Reflection;
+using System.Text.Json;
+using System.Text.Json.Nodes;
 
 namespace OpenQA.Selenium.DevTools
 {
@@ -68,6 +70,15 @@ public abstract class DevToolsDomains
         /// </summary>
         public abstract Log Log { get; }
 
+        internal abstract JsonNode SerializeToNode<TCommand>(TCommand command)
+            where TCommand : ICommand;
+
+        internal abstract ICommandResponse<TCommand> DeserializeCommandResponse<TCommand>(JsonElement responseJson)
+            where TCommand : ICommand;
+
+        internal abstract TCommandResponse Deserialize<TCommandResponse>(JsonElement responseJson)
+            where TCommandResponse : ICommandResponse;
+
         /// <summary>
         /// Initializes the supplied DevTools session's domains for the specified browser version.
         /// </summary>
diff --git a/dotnet/src/webdriver/DevTools/DevToolsSession.cs b/dotnet/src/webdriver/DevTools/DevToolsSession.cs
@@ -61,11 +61,6 @@ public class DevToolsSession : IDevToolsSession
 
         private readonly static ILogger logger = Internal.Logging.Log.GetLogger<DevToolsSession>();
 
-        private static readonly JsonSerializerOptions s_devToolsSerializerOptions = new()
-        {
-            TypeInfoResolver = CdpSerializationContext.Default,
-        };
-
         /// <summary>
         /// Initializes a new instance of the DevToolsSession class, using the specified WebSocket endpoint.
         /// </summary>
@@ -162,19 +157,16 @@ public T GetVersionSpecificDomains<T>() where T : DevToolsSessionDomains
                 throw new ArgumentNullException(nameof(command));
             }
 
-            var result = await SendCommand(command.CommandName, JsonSerializer.SerializeToNode(command), cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);
+            JsonNode serializedCommand = this.domains.SerializeToNode(command);
+
+            var result = await SendCommand(command.CommandName, serializedCommand, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);
 
             if (result == null)
             {
                 return null;
             }
 
-            if (!this.domains.VersionSpecificDomains.ResponseTypeMap.TryGetCommandResponseType<TCommand>(out Type commandResponseType))
-            {
-                throw new InvalidOperationException($"Type {command.GetType()} does not correspond to a known command response type.");
-            }
-
-            return result.Value.Deserialize(commandResponseType) as ICommandResponse<TCommand>;
+            return this.domains.DeserializeCommandResponse<TCommand>(result.Value);
         }
 
         /// <summary>
@@ -195,19 +187,16 @@ public T GetVersionSpecificDomains<T>() where T : DevToolsSessionDomains
                 throw new ArgumentNullException(nameof(command));
             }
 
-            var result = await SendCommand(command.CommandName, sessionId, JsonSerializer.SerializeToNode(command, s_devToolsSerializerOptions), cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);
+            JsonNode serializedCommand = this.domains.SerializeToNode(command);
+
+            var result = await SendCommand(command.CommandName, sessionId, serializedCommand, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);
 
             if (result == null)
             {
                 return null;
             }
 
-            if (!this.domains.VersionSpecificDomains.ResponseTypeMap.TryGetCommandResponseType(command, out Type commandResponseType))
-            {
-                throw new InvalidOperationException($"Type {typeof(TCommand)} does not correspond to a known command response type.");
-            }
-
-            return (ICommandResponse<TCommand>)result.Value.Deserialize(commandResponseType, s_devToolsSerializerOptions);
+            return this.domains.DeserializeCommandResponse<TCommand>(result.Value);
         }
 
         /// <summary>
@@ -229,14 +218,16 @@ public T GetVersionSpecificDomains<T>() where T : DevToolsSessionDomains
                 throw new ArgumentNullException(nameof(command));
             }
 
-            var result = await SendCommand(command.CommandName, JsonSerializer.SerializeToNode(command), cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);
+            JsonNode serializedCommand = this.domains.SerializeToNode(command);
+
+            var result = await SendCommand(command.CommandName, serializedCommand, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);
 
             if (result == null)
             {
                 return default(TCommandResponse);
             }
 
-            return result.Value.Deserialize<TCommandResponse>();
+            return this.domains.Deserialize<TCommandResponse>(result.Value);
         }
 
         /// <summary>
diff --git a/dotnet/src/webdriver/DevTools/Json/CdpJsonSerializationContext.cs b/dotnet/src/webdriver/DevTools/Json/CdpJsonSerializationContext.cs
@@ -1,8 +1,8 @@
-using System.Text.Json.Serialization;
+// using System.Text.Json.Serialization;
 
-namespace OpenQA.Selenium.DevTools.Json;
+// namespace OpenQA.Selenium.DevTools.Json;
 
-[JsonSerializable(typeof(ICommand))]
-[JsonSerializable(typeof(ICommandResponse<>))]
-[JsonSourceGenerationOptions(Converters = [typeof(StringConverter)])]
-internal sealed partial class CdpSerializationContext : JsonSerializerContext;
+// [JsonSerializable(typeof(ICommand))]
+// [JsonSerializable(typeof(ICommandResponse<>))]
+// [JsonSourceGenerationOptions(Converters = [typeof(StringConverter)])]
+// internal sealed partial class CdpSerializationContext : JsonSerializerContext;
diff --git a/dotnet/src/webdriver/DevTools/v130/DevToolsSerializationContext.cs b/dotnet/src/webdriver/DevTools/v130/DevToolsSerializationContext.cs
@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+
+namespace OpenQA.Selenium.DevTools.V130;
+
+[JsonSerializable(typeof(ICommand))]
+internal sealed partial class V130RequestSerializationContext : JsonSerializerContext;
+
+[JsonSerializable(typeof(ICommand))]
+internal sealed partial class V130ResponseSerializationContext : JsonSerializerContext;
diff --git a/dotnet/src/webdriver/DevTools/v130/V130Domains.cs b/dotnet/src/webdriver/DevTools/v130/V130Domains.cs
@@ -17,13 +17,27 @@
 // under the License.
 // </copyright>
 
+using System;
+using System.Text.Json;
+using System.Text.Json.Nodes;
+
 namespace OpenQA.Selenium.DevTools.V130
 {
     /// <summary>
     /// Class containing the domain implementation for version 130 of the DevTools Protocol.
     /// </summary>
     public class V130Domains : DevToolsDomains
     {
+        private static readonly JsonSerializerOptions jsonRequestSerializerOptions = new()
+        {
+            TypeInfoResolver = V130RequestSerializationContext.Default
+        };
+
+        private static readonly JsonSerializerOptions jsonResponseSerializerOptions = new()
+        {
+            TypeInfoResolver = V130ResponseSerializationContext.Default
+        };
+
         private DevToolsSessionDomains domains;
 
         /// <summary>
@@ -64,5 +78,25 @@ public V130Domains(DevToolsSession session)
         /// Gets the object used for manipulating the browser's logs.
         /// </summary>
         public override DevTools.Log Log => new V130Log(domains.Log);
+
+        internal override JsonNode SerializeToNode<TCommand>(TCommand command)
+        {
+            return JsonSerializer.SerializeToNode(command, jsonRequestSerializerOptions);
+        }
+
+        internal override ICommandResponse<TCommand> DeserializeCommandResponse<TCommand>(JsonElement responseJson)
+        {
+            if (!this.VersionSpecificDomains.ResponseTypeMap.TryGetCommandResponseType<TCommand>(out Type commandResponseType))
+            {
+                throw new InvalidOperationException($"Type {typeof(TCommand)} does not correspond to a known command response type.");
+            }
+
+            return (ICommandResponse<TCommand>)responseJson.Deserialize(commandResponseType, jsonResponseSerializerOptions);
+        }
+
+        internal override TCommandResponse Deserialize<TCommandResponse>(JsonElement responseJson)
+        {
+            return responseJson.Deserialize<TCommandResponse>(jsonResponseSerializerOptions);
+        }
     }
 }
diff --git a/dotnet/src/webdriver/DevTools/v131/DevToolsSerializationContext.cs b/dotnet/src/webdriver/DevTools/v131/DevToolsSerializationContext.cs
@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+
+namespace OpenQA.Selenium.DevTools.V131;
+
+[JsonSerializable(typeof(ICommand))]
+internal sealed partial class V131RequestSerializationContext : JsonSerializerContext;
+
+[JsonSerializable(typeof(ICommand))]
+internal sealed partial class V131ResponseSerializationContext : JsonSerializerContext;
diff --git a/dotnet/src/webdriver/DevTools/v131/V131Domains.cs b/dotnet/src/webdriver/DevTools/v131/V131Domains.cs
@@ -17,13 +17,27 @@
 // under the License.
 // </copyright>
 
+using System;
+using System.Text.Json;
+using System.Text.Json.Nodes;
+
 namespace OpenQA.Selenium.DevTools.V131
 {
     /// <summary>
     /// Class containing the domain implementation for version 131 of the DevTools Protocol.
     /// </summary>
     public class V131Domains : DevToolsDomains
     {
+        private static readonly JsonSerializerOptions jsonRequestSerializerOptions = new()
+        {
+            TypeInfoResolver = V131RequestSerializationContext.Default
+        };
+
+        private static readonly JsonSerializerOptions jsonResponseSerializerOptions = new()
+        {
+            TypeInfoResolver = V131ResponseSerializationContext.Default
+        };
+
         private DevToolsSessionDomains domains;
 
         /// <summary>
@@ -64,5 +78,25 @@ public V131Domains(DevToolsSession session)
         /// Gets the object used for manipulating the browser's logs.
         /// </summary>
         public override DevTools.Log Log => new V131Log(domains.Log);
+
+        internal override JsonNode SerializeToNode<TCommand>(TCommand command)
+        {
+            return JsonSerializer.SerializeToNode(command, jsonRequestSerializerOptions);
+        }
+
+        internal override ICommandResponse<TCommand> DeserializeCommandResponse<TCommand>(JsonElement responseJson)
+        {
+            if (!this.VersionSpecificDomains.ResponseTypeMap.TryGetCommandResponseType<TCommand>(out Type commandResponseType))
+            {
+                throw new InvalidOperationException($"Type {typeof(TCommand)} does not correspond to a known command response type.");
+            }
+
+            return (ICommandResponse<TCommand>)responseJson.Deserialize(commandResponseType, jsonResponseSerializerOptions);
+        }
+
+        internal override TCommandResponse Deserialize<TCommandResponse>(JsonElement responseJson)
+        {
+            return responseJson.Deserialize<TCommandResponse>(jsonResponseSerializerOptions);
+        }
     }
 }
diff --git a/dotnet/src/webdriver/DevTools/v132/DevToolsSerializationContext.cs b/dotnet/src/webdriver/DevTools/v132/DevToolsSerializationContext.cs
@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+
+namespace OpenQA.Selenium.DevTools.V132;
+
+[JsonSerializable(typeof(ICommand))]
+internal sealed partial class V132RequestSerializationContext : JsonSerializerContext;
+
+[JsonSerializable(typeof(ICommand))]
+internal sealed partial class V132ResponseSerializationContext : JsonSerializerContext;
diff --git a/dotnet/src/webdriver/DevTools/v132/V132Domains.cs b/dotnet/src/webdriver/DevTools/v132/V132Domains.cs
@@ -17,13 +17,27 @@
 // under the License.
 // </copyright>
 
+using System;
+using System.Text.Json;
+using System.Text.Json.Nodes;
+
 namespace OpenQA.Selenium.DevTools.V132
 {
     /// <summary>
     /// Class containing the domain implementation for version 132 of the DevTools Protocol.
     /// </summary>
     public class V132Domains : DevToolsDomains
     {
+        private static readonly JsonSerializerOptions jsonRequestSerializerOptions = new()
+        {
+            TypeInfoResolver = V132RequestSerializationContext.Default
+        };
+
+        private static readonly JsonSerializerOptions jsonResponseSerializerOptions = new()
+        {
+            TypeInfoResolver = V132ResponseSerializationContext.Default
+        };
+
         private DevToolsSessionDomains domains;
 
         /// <summary>
@@ -64,5 +78,25 @@ public V132Domains(DevToolsSession session)
         /// Gets the object used for manipulating the browser's logs.
         /// </summary>
         public override DevTools.Log Log => new V132Log(domains.Log);
+
+        internal override JsonNode SerializeToNode<TCommand>(TCommand command)
+        {
+            return JsonSerializer.SerializeToNode(command, jsonRequestSerializerOptions);
+        }
+
+        internal override ICommandResponse<TCommand> DeserializeCommandResponse<TCommand>(JsonElement responseJson)
+        {
+            if (!this.VersionSpecificDomains.ResponseTypeMap.TryGetCommandResponseType<TCommand>(out Type commandResponseType))
+            {
+                throw new InvalidOperationException($"Type {typeof(TCommand)} does not correspond to a known command response type.");
+            }
+
+            return (ICommandResponse<TCommand>)responseJson.Deserialize(commandResponseType, jsonResponseSerializerOptions);
+        }
+
+        internal override TCommandResponse Deserialize<TCommandResponse>(JsonElement responseJson)
+        {
+            return responseJson.Deserialize<TCommandResponse>(jsonResponseSerializerOptions);
+        }
     }
 }
diff --git a/dotnet/src/webdriver/DevTools/v85/DevToolsSerializationContext.cs b/dotnet/src/webdriver/DevTools/v85/DevToolsSerializationContext.cs
@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+
+namespace OpenQA.Selenium.DevTools.V85;
+
+[JsonSerializable(typeof(ICommand))]
+internal sealed partial class V85RequestSerializationContext : JsonSerializerContext;
+
+[JsonSerializable(typeof(ICommand))]
+internal sealed partial class V85ResponseSerializationContext : JsonSerializerContext;
diff --git a/dotnet/src/webdriver/DevTools/v85/V85Domains.cs b/dotnet/src/webdriver/DevTools/v85/V85Domains.cs
@@ -17,13 +17,27 @@
 // under the License.
 // </copyright>
 
+using System;
+using System.Text.Json;
+using System.Text.Json.Nodes;
+
 namespace OpenQA.Selenium.DevTools.V85
 {
     /// <summary>
     /// Class containing the domain implementation for version 86 of the DevTools Protocol.
     /// </summary>
     public class V85Domains : DevToolsDomains
     {
+        private static readonly JsonSerializerOptions jsonRequestSerializerOptions = new()
+        {
+            TypeInfoResolver = V85RequestSerializationContext.Default
+        };
+
+        private static readonly JsonSerializerOptions jsonResponseSerializerOptions = new()
+        {
+            TypeInfoResolver = V85ResponseSerializationContext.Default
+        };
+
         private DevToolsSessionDomains domains;
 
         /// <summary>
@@ -64,5 +78,25 @@ public V85Domains(DevToolsSession session)
         /// Gets the object used for manipulating the browser's logs.
         /// </summary>
         public override DevTools.Log Log => new V85Log(domains.Log);
+
+        internal override JsonNode SerializeToNode<TCommand>(TCommand command)
+        {
+            return JsonSerializer.SerializeToNode(command, jsonRequestSerializerOptions);
+        }
+
+        internal override ICommandResponse<TCommand> DeserializeCommandResponse<TCommand>(JsonElement responseJson)
+        {
+            if (!this.VersionSpecificDomains.ResponseTypeMap.TryGetCommandResponseType<TCommand>(out Type commandResponseType))
+            {
+                throw new InvalidOperationException($"Type {typeof(TCommand)} does not correspond to a known command response type.");
+            }
+
+            return (ICommandResponse<TCommand>)responseJson.Deserialize(commandResponseType, jsonResponseSerializerOptions);
+        }
+
+        internal override TCommandResponse Deserialize<TCommandResponse>(JsonElement responseJson)
+        {
+            return responseJson.Deserialize<TCommandResponse>(jsonResponseSerializerOptions);
+        }
     }
 }
diff --git a/third_party/dotnet/devtools/src/generator/CodeGen/CommandGenerator.cs b/third_party/dotnet/devtools/src/generator/CodeGen/CommandGenerator.cs
@@ -2,6 +2,7 @@
 using OpenQA.Selenium.DevToolsGenerator.ProtocolDefinition;
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace OpenQA.Selenium.DevToolsGenerator.CodeGen
 {
@@ -33,7 +34,8 @@ public override IDictionary<string, string> GenerateCode(CommandDefinition comma
                 className = className,
                 domain = context.Domain,
                 rootNamespace = Settings.RootNamespace,
-                context = context
+                context = context,
+                protocolVersion = Settings.RootNamespace.Split('.').Last()
             });
 
             var outputPath = Utility.ReplaceTokensInPath(Settings.DefinitionTemplates.CommandTemplate.OutputPath, className, context, Settings);
diff --git a/third_party/dotnet/devtools/src/generator/Templates/command.hbs b/third_party/dotnet/devtools/src/generator/Templates/command.hbs

Original file line number	Diff line number	Diff line change
`@@ -61,11 +61,6 @@ public class DevToolsSession : IDevToolsSession`
`61`	`61`
`62`	`62`	`private readonly static ILogger logger = Internal.Logging.Log.GetLogger<DevToolsSession>();`
`63`	`63`
`64`		`- private static readonly JsonSerializerOptions s_devToolsSerializerOptions = new()`
`65`		`- {`
`66`		`- TypeInfoResolver = CdpSerializationContext.Default,`
`67`		`- };`
`68`		`-`
`69`	`64`	`/// <summary>`
`70`	`65`	`/// Initializes a new instance of the DevToolsSession class, using the specified WebSocket endpoint.`
`71`	`66`	`/// </summary>`
`@@ -162,19 +157,16 @@ public T GetVersionSpecificDomains<T>() where T : DevToolsSessionDomains`
`162`	`157`	`throw new ArgumentNullException(nameof(command));`
`163`	`158`	`}`
`164`	`159`
`165`		`- var result = await SendCommand(command.CommandName, JsonSerializer.SerializeToNode(command), cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);`
	`160`	`+ JsonNode serializedCommand = this.domains.SerializeToNode(command);`
	`161`	`+`
	`162`	`+ var result = await SendCommand(command.CommandName, serializedCommand, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);`
`166`	`163`
`167`	`164`	`if (result == null)`
`168`	`165`	`{`
`169`	`166`	`return null;`
`170`	`167`	`}`
`171`	`168`
`172`		`- if (!this.domains.VersionSpecificDomains.ResponseTypeMap.TryGetCommandResponseType<TCommand>(out Type commandResponseType))`
`173`		`- {`
`174`		`- throw new InvalidOperationException($"Type {command.GetType()} does not correspond to a known command response type.");`
`175`		`- }`
`176`		`-`
`177`		`- return result.Value.Deserialize(commandResponseType) as ICommandResponse<TCommand>;`
	`169`	`+ return this.domains.DeserializeCommandResponse<TCommand>(result.Value);`
`178`	`170`	`}`
`179`	`171`
`180`	`172`	`/// <summary>`
`@@ -195,19 +187,16 @@ public T GetVersionSpecificDomains<T>() where T : DevToolsSessionDomains`
`195`	`187`	`throw new ArgumentNullException(nameof(command));`
`196`	`188`	`}`
`197`	`189`
`198`		`- var result = await SendCommand(command.CommandName, sessionId, JsonSerializer.SerializeToNode(command, s_devToolsSerializerOptions), cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);`
	`190`	`+ JsonNode serializedCommand = this.domains.SerializeToNode(command);`
	`191`	`+`
	`192`	`+ var result = await SendCommand(command.CommandName, sessionId, serializedCommand, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);`
`199`	`193`
`200`	`194`	`if (result == null)`
`201`	`195`	`{`
`202`	`196`	`return null;`
`203`	`197`	`}`
`204`	`198`
`205`		`- if (!this.domains.VersionSpecificDomains.ResponseTypeMap.TryGetCommandResponseType(command, out Type commandResponseType))`
`206`		`- {`
`207`		`- throw new InvalidOperationException($"Type {typeof(TCommand)} does not correspond to a known command response type.");`
`208`		`- }`
`209`		`-`
`210`		`- return (ICommandResponse<TCommand>)result.Value.Deserialize(commandResponseType, s_devToolsSerializerOptions);`
	`199`	`+ return this.domains.DeserializeCommandResponse<TCommand>(result.Value);`
`211`	`200`	`}`
`212`	`201`
`213`	`202`	`/// <summary>`
`@@ -229,14 +218,16 @@ public T GetVersionSpecificDomains<T>() where T : DevToolsSessionDomains`
`229`	`218`	`throw new ArgumentNullException(nameof(command));`
`230`	`219`	`}`
`231`	`220`
`232`		`- var result = await SendCommand(command.CommandName, JsonSerializer.SerializeToNode(command), cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);`
	`221`	`+ JsonNode serializedCommand = this.domains.SerializeToNode(command);`
	`222`	`+`
	`223`	`+ var result = await SendCommand(command.CommandName, serializedCommand, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived).ConfigureAwait(false);`
`233`	`224`
`234`	`225`	`if (result == null)`
`235`	`226`	`{`
`236`	`227`	`return default(TCommandResponse);`
`237`	`228`	`}`
`238`	`229`
`239`		`- return result.Value.Deserialize<TCommandResponse>();`
	`230`	`+ return this.domains.Deserialize<TCommandResponse>(result.Value);`
`240`	`231`	`}`
`241`	`232`
`242`	`233`	`/// <summary>`