DevTools Client - Follow up to #3669

- Improve xml doc
- Reduce code duplication

Author: amaitland

CefSharp/DevTools/DevToolsClient.cs

@@ -31,9 +31,7 @@ public partial class DevToolsClient : IDevToolsMessageObserver, IDevToolsClient
         private bool devToolsAttached;
         private SynchronizationContext syncContext;
 
-        /// <summary>
-        /// DevToolsEvent
-        /// </summary>
+        /// <inheritdoc/>
         public event EventHandler<DevToolsEventArgs> DevToolsEvent;
 
         /// <summary>
@@ -153,6 +151,7 @@ public async Task<DevToolsMethodResponse> ExecuteDevToolsMethodAsync(string meth
             return await taskCompletionSource.Task;
         }
 
+        /// <inheritdoc/>
         void IDisposable.Dispose()
         {
             DevToolsEvent = null;
@@ -161,16 +160,19 @@ void IDisposable.Dispose()
             browser = null;
         }
 
+        /// <inheritdoc/>
         void IDevToolsMessageObserver.OnDevToolsAgentAttached(IBrowser browser)
         {
             devToolsAttached = true;
         }
 
+        /// <inheritdoc/>
         void IDevToolsMessageObserver.OnDevToolsAgentDetached(IBrowser browser)
         {
             devToolsAttached = false;
         }
 
+        /// <inheritdoc/>
         void IDevToolsMessageObserver.OnDevToolsEvent(IBrowser browser, string method, Stream parameters)
         {
             var evt = DevToolsEvent;
@@ -188,11 +190,13 @@ void IDevToolsMessageObserver.OnDevToolsEvent(IBrowser browser, string method, S
             }
         }
 
+        /// <inheritdoc/>
         bool IDevToolsMessageObserver.OnDevToolsMessage(IBrowser browser, Stream message)
         {
             return false;
         }
 
+        /// <inheritdoc/>
         void IDevToolsMessageObserver.OnDevToolsMethodResult(IBrowser browser, int messageId, bool success, Stream result)
         {
             var uiThread = CefThread.CurrentlyOnUiThread;
@@ -248,5 +252,38 @@ void IDevToolsMessageObserver.OnDevToolsMethodResult(IBrowser browser, int messa
                 }
             }
         }
+
+        /// <summary>
+        /// Deserialize the JSON string into a .Net object.
+        /// For .Net Core/.Net 5.0 uses System.Text.Json
+        /// for .Net 4.5.2 uses System.Runtime.Serialization.Json
+        /// </summary>
+        /// <typeparam name="T">Object type</typeparam>
+        /// <param name="json">JSON</param>
+        /// <returns>object of type <typeparamref name="T"/></returns>
+        public static T DeserializeJson<T>(string json)
+        {
+#if NETCOREAPP
+            var options = new System.Text.Json.JsonSerializerOptions
+            {
+                PropertyNameCaseInsensitive = true,
+                IgnoreNullValues = true,
+            };
+
+            options.Converters.Add(new CefSharp.Internals.Json.JsonEnumConverterFactory());
+
+            return System.Text.Json.JsonSerializer.Deserialize<T>(json, options);
+#else
+            var bytes = Encoding.UTF8.GetBytes(json);
+            using (var ms = new MemoryStream(bytes))
+            {
+                var settings = new System.Runtime.Serialization.Json.DataContractJsonSerializerSettings();
+                settings.UseSimpleDictionaryFormat = true;
+
+                var dcs = new System.Runtime.Serialization.Json.DataContractJsonSerializer(typeof(T), settings);
+                return (T)dcs.ReadObject(ms);
+            }
+#endif
+        }
     }
 }

CefSharp/DevTools/DevToolsEventArgs.cs

@@ -4,11 +4,6 @@
 
 
 using System;
-#if !NETCOREAPP
-using System.IO;
-using System.Runtime.Serialization.Json;
-using System.Text;
-#endif
 
 namespace CefSharp.DevTools
 {
@@ -35,27 +30,7 @@ public DevToolsEventArgs(string eventName, string paramsAsJsonString)
 
         internal T DeserializeJson<T>()
         {
-#if NETCOREAPP
-            var options = new System.Text.Json.JsonSerializerOptions
-            {
-                PropertyNameCaseInsensitive = true,
-                IgnoreNullValues = true,
-            };
-
-            options.Converters.Add(new Internals.Json.JsonEnumConverterFactory());
-
-            return System.Text.Json.JsonSerializer.Deserialize<T>(ParametersAsJsonString, options);
-#else
-            var bytes = Encoding.UTF8.GetBytes(ParametersAsJsonString);
-            using (var ms = new MemoryStream(bytes))
-            {
-                var settings = new DataContractJsonSerializerSettings();
-                settings.UseSimpleDictionaryFormat = true;
-
-                var dcs = new DataContractJsonSerializer(typeof(T), settings);
-                return (T)dcs.ReadObject(ms);
-            }
-#endif
+            return DevToolsClient.DeserializeJson<T>(ParametersAsJsonString);
         }
     }
 }

CefSharp/DevTools/DevToolsMethodResponse.cs

@@ -32,33 +32,10 @@ internal T DeserializeJson<T>(bool ignoreSuccess = false)
         {
             if (Success || ignoreSuccess)
             {
-#if NETCOREAPP
-                var options = new System.Text.Json.JsonSerializerOptions
-                {
-                    //AllowTrailingCommas = true,
-                    PropertyNameCaseInsensitive = true,
-                    IgnoreNullValues = true,
-                    //PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.CamelCase
-                };
-
-                options.Converters.Add(new Internals.Json.JsonEnumConverterFactory());
-
-                return System.Text.Json.JsonSerializer.Deserialize<T>(ResponseAsJsonString, options);
-#else
-                var bytes = Encoding.UTF8.GetBytes(ResponseAsJsonString);
-                using (var ms = new MemoryStream(bytes))
-                {
-                    var settings = new DataContractJsonSerializerSettings();
-                    settings.UseSimpleDictionaryFormat = true;
-
-                    var dcs = new DataContractJsonSerializer(typeof(T), settings);
-                    return (T)dcs.ReadObject(ms);
-                }
-#endif
+                return DevToolsClient.DeserializeJson<T>(ResponseAsJsonString);
             }
 
             throw new DevToolsClientException(ResponseAsJsonString);
         }
-
     }
 }

CefSharp/DevTools/IDevToolsClient.cs

@@ -14,7 +14,9 @@ namespace CefSharp.DevTools
     public interface IDevToolsClient
     {
         /// <summary>
-        /// DevToolsEvent
+        /// Will be called on receipt of a DevTools protocol event. Events by default are disabled and need to be
+        /// enabled on a per domain basis, e.g. Sending Network.enable (or calling <see cref="Network.NetworkClient.EnableAsync(int?, int?, int?)"/>)
+        /// to enable network related events.
         /// </summary>
         event EventHandler<DevToolsEventArgs> DevToolsEvent;