[dotnet] Avoid performing JSON serialization in debugger display

Author: RenderMichael

dotnet/src/webdriver/DriverOptions.cs

@@ -21,7 +21,9 @@
 using OpenQA.Selenium.Remote;
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Globalization;
+using System.Text;
 using System.Text.Json;
 
 namespace OpenQA.Selenium
@@ -111,6 +113,7 @@ public Dictionary<string, object> ToCapabilities()
     /// <summary>
     /// Base class for managing options specific to a browser driver.
     /// </summary>
+    [DebuggerDisplay($"{{{nameof(GetDebuggerDisplay)}(),nq}}")]
     public abstract class DriverOptions
     {
         private string browserName;
@@ -624,5 +627,40 @@ protected IWritableCapabilities GenerateDesiredCapabilities(bool isSpecification
 
             return capabilities;
         }
+
+        private string GetDebuggerDisplay()
+        {
+            StringBuilder builder = new StringBuilder();
+
+            bool needComma = false;
+
+            if (browserName is not null)
+            {
+                builder.Append("Browser = ").Append(browserName);
+                needComma = true;
+            }
+
+            if (browserVersion is not null)
+            {
+                if (needComma)
+                {
+                    builder.Append(',').Append(' ');
+                }
+
+                builder.Append("Version = ").Append(browserVersion);
+            }
+
+            if (platformName is not null)
+            {
+                if (needComma)
+                {
+                    builder.Append(',').Append(' ');
+                }
+
+                builder.Append("Platform = ").Append(platformName);
+            }
+
+            return builder.ToString();
+        }
     }
 }

dotnet/src/webdriver/Internal/ReturnedCapabilities.cs

@@ -20,6 +20,7 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using System.Diagnostics;
 using System.Globalization;
 using System.Text.Json;
 
@@ -29,6 +30,7 @@ namespace OpenQA.Selenium.Internal
     /// Class to Create the capabilities of the browser you require for <see cref="IWebDriver"/>.
     /// If you wish to use default values use the static methods
     /// </summary>
+    [DebuggerDisplay($"{{{nameof(GetDebuggerDisplay)}(),nq}}")]
     internal class ReturnedCapabilities : ICapabilities, IHasCapabilitiesDictionary
     {
         private readonly Dictionary<string, object> capabilities = new Dictionary<string, object>();
@@ -156,5 +158,15 @@ public override string ToString()
         {
             return JsonSerializer.Serialize(this.capabilities, new JsonSerializerOptions { WriteIndented = true });
         }
+
+        private string GetDebuggerDisplay()
+        {
+            string browser = this.BrowserName;
+            if (!string.IsNullOrEmpty(browser))
+            {
+                return $"Browser = {browser}, Count = {this.capabilities.Count}";
+            }
+            return $"Count = {this.capabilities.Count}";
+        }
     }
 }

dotnet/src/webdriver/Remote/RemoteSessionSettings.cs

@@ -21,6 +21,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Globalization;
 using System.Text.Json;
 
@@ -29,12 +30,13 @@ namespace OpenQA.Selenium
     /// <summary>
     /// Base class for managing options specific to a browser driver.
     /// </summary>
+    [DebuggerDisplay($"{{{nameof(GetDebuggerDisplay)}(),nq}}")]
     public class RemoteSessionSettings : ICapabilities
     {
         private const string FirstMatchCapabilityName = "firstMatch";
         private const string AlwaysMatchCapabilityName = "alwaysMatch";
 
-        private readonly List<string> reservedSettingNames = new List<string>() { FirstMatchCapabilityName, AlwaysMatchCapabilityName };
+        private readonly HashSet<string> reservedSettingNames = new HashSet<string>() { FirstMatchCapabilityName, AlwaysMatchCapabilityName };
         private DriverOptions mustMatchDriverOptions;
         private List<DriverOptions> firstMatchOptions = new List<DriverOptions>();
         private Dictionary<string, object> remoteMetadataSettings = new Dictionary<string, object>();
@@ -350,5 +352,16 @@ private bool IsJsonSerializable(object arg)
 
             return true;
         }
+
+        private string GetDebuggerDisplay()
+        {
+            string browser = this.mustMatchDriverOptions.BrowserName;
+
+            if (!string.IsNullOrEmpty(browser))
+            {
+                return $"Browser = {browser}, Extra driver options count = {this.firstMatchOptions.Count}";
+            }
+            return $"Extra driver options Count = {this.firstMatchOptions.Count}, ";
+        }
     }
 }