Merge branch 'trunk' into driver-options-tostring

Author: RenderMichael

MODULE.bazel

@@ -17,7 +17,7 @@ bazel_dep(name = "protobuf", version = "21.7", dev_dependency = True, repo_name
 # Required for rules_rust to import the crates properly
 bazel_dep(name = "rules_cc", version = "0.0.9", dev_dependency = True)
 
-bazel_dep(name = "rules_dotnet", version = "0.16.0")
+bazel_dep(name = "rules_dotnet", version = "0.16.1")
 bazel_dep(name = "rules_java", version = "7.11.1")
 bazel_dep(name = "rules_jvm_external", version = "6.3")
 bazel_dep(name = "rules_nodejs", version = "6.3.0")

dotnet/src/webdriver/Remote/RemoteSessionSettings.cs

@@ -19,7 +19,6 @@
 
 using OpenQA.Selenium.Remote;
 using System;
-using System.Collections;
 using System.Collections.Generic;
 using System.Globalization;
 using System.Text.Json;
@@ -71,18 +70,12 @@ public RemoteSessionSettings(DriverOptions mustMatchDriverOptions, params Driver
         /// <summary>
         /// Gets a value indicating the options that must be matched by the remote end to create a session.
         /// </summary>
-        internal DriverOptions MustMatchDriverOptions
-        {
-            get { return this.mustMatchDriverOptions; }
-        }
+        internal DriverOptions MustMatchDriverOptions => this.mustMatchDriverOptions;
 
         /// <summary>
         /// Gets a value indicating the number of options that may be matched by the remote end to create a session.
         /// </summary>
-        internal int FirstMatchOptionsCount
-        {
-            get { return this.firstMatchOptions.Count; }
-        }
+        internal int FirstMatchOptionsCount => this.firstMatchOptions.Count;
 
         /// <summary>
         /// Gets the capability value with the specified name.
@@ -92,6 +85,7 @@ internal int FirstMatchOptionsCount
         /// <exception cref="ArgumentException">
         /// The specified capability name is not in the set of capabilities.
         /// </exception>
+        /// <exception cref="ArgumentNullException">If <paramref name="capabilityName"/> is null.</exception>
         public object this[string capabilityName]
         {
             get
@@ -121,18 +115,10 @@ public object this[string capabilityName]
         /// </summary>
         /// <param name="settingName">The name of the setting to set.</param>
         /// <param name="settingValue">The value of the setting.</param>
-        /// <remarks>
-        /// The value to be set must be serializable to JSON for transmission
-        /// across the wire to the remote end. To be JSON-serializable, the value
-        /// must be a string, a numeric value, a boolean value, an object that
-        /// implmeents <see cref="IEnumerable"/> that contains JSON-serializable
-        /// objects, or a <see cref="Dictionary{TKey, TValue}"/> where the keys
-        /// are strings and the values are JSON-serializable.
-        /// </remarks>
         /// <exception cref="ArgumentException">
-        /// Thrown if the setting name is null, the empty string, or one of the
-        /// reserved names of metadata settings; or if the setting value is not
-        /// JSON serializable.
+        /// <para>If the setting name is null or empty.</para>
+        /// <para>-or-</para>
+        /// <para>If one of the reserved names of metadata settings.</para>
         /// </exception>
         public void AddMetadataSetting(string settingName, object settingValue)
         {
@@ -146,11 +132,6 @@ public void AddMetadataSetting(string settingName, object settingValue)
                 throw new ArgumentException(string.Format("'{0}' is a reserved name for a metadata setting, and cannot be used as a name.", settingName), nameof(settingName));
             }
 
-            if (!this.IsJsonSerializable(settingValue))
-            {
-                throw new ArgumentException("Metadata setting value must be JSON serializable.", nameof(settingValue));
-            }
-
             this.remoteMetadataSettings[settingName] = settingValue;
         }
 
@@ -161,9 +142,9 @@ public void AddMetadataSetting(string settingName, object settingValue)
         /// <param name="options">The <see cref="DriverOptions"/> to add to the list of "first matched" options.</param>
         public void AddFirstMatchDriverOption(DriverOptions options)
         {
-            if (mustMatchDriverOptions != null)
+            if (this.mustMatchDriverOptions != null)
             {
-                DriverOptionsMergeResult mergeResult = mustMatchDriverOptions.GetMergeResult(options);
+                DriverOptionsMergeResult mergeResult = this.mustMatchDriverOptions.GetMergeResult(options);
                 if (mergeResult.IsMergeConflict)
                 {
                     string msg = string.Format(CultureInfo.InvariantCulture, "You cannot request the same capability in both must-match and first-match capabilities. You are attempting to add a first-match driver options object that defines a capability, '{0}', that is already defined in the must-match driver options.", mergeResult.MergeConflictOptionName);
@@ -297,58 +278,13 @@ private IDictionary<string, object> GetAlwaysMatchOptionsAsSerializableDictionar
 
         private List<object> GetFirstMatchOptionsAsSerializableList()
         {
-            List<object> optionsMatches = new List<object>();
+            List<object> optionsMatches = new List<object>(this.firstMatchOptions.Count);
             foreach (DriverOptions options in this.firstMatchOptions)
             {
                 optionsMatches.Add(options.ToDictionary());
             }
 
             return optionsMatches;
         }
-
-        private bool IsJsonSerializable(object arg)
-        {
-            IEnumerable argAsEnumerable = arg as IEnumerable;
-            IDictionary argAsDictionary = arg as IDictionary;
-
-            if (arg is string || arg is float || arg is double || arg is int || arg is long || arg is bool || arg == null)
-            {
-                return true;
-            }
-            else if (argAsDictionary != null)
-            {
-                foreach (object key in argAsDictionary.Keys)
-                {
-                    if (!(key is string))
-                    {
-                        return false;
-                    }
-                }
-
-                foreach (object value in argAsDictionary.Values)
-                {
-                    if (!IsJsonSerializable(value))
-                    {
-                        return false;
-                    }
-                }
-            }
-            else if (argAsEnumerable != null)
-            {
-                foreach (object item in argAsEnumerable)
-                {
-                    if (!IsJsonSerializable(item))
-                    {
-                        return false;
-                    }
-                }
-            }
-            else
-            {
-                return false;
-            }
-
-            return true;
-        }
     }
 }

dotnet/test/remote/RemoteSessionCreationTests.cs

@@ -18,6 +18,9 @@
 // </copyright>
 
 using NUnit.Framework;
+using System.Collections.Generic;
+using System.Text.Json;
+using System.Text.Json.Nodes;
 
 namespace OpenQA.Selenium.Remote
 {
@@ -68,5 +71,66 @@ public void CreateEdgeRemoteSession()
                 edge.Quit();
             }
         }
+
+        [Test]
+        public void ShouldSetRemoteSessionSettingsMetadata()
+        {
+            var settings = new RemoteSessionSettings();
+
+            Assert.That(settings.HasCapability("a"), Is.False);
+
+            settings.AddMetadataSetting("a", null);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.Null);
+
+            settings.AddMetadataSetting("a", true);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.True);
+
+            settings.AddMetadataSetting("a", false);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.False);
+
+            settings.AddMetadataSetting("a", 123);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.TypeOf<int>().And.EqualTo(123));
+
+            settings.AddMetadataSetting("a", 123f);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.TypeOf<float>().And.EqualTo(123f));
+
+            settings.AddMetadataSetting("a", 123d);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.TypeOf<double>().And.EqualTo(123d));
+
+            JsonNode trueName = JsonValue.Create(true);
+            settings.AddMetadataSetting("a", trueName);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.InstanceOf<JsonNode>().And.EqualTo(trueName).Using<JsonNode>(JsonNode.DeepEquals));
+
+            var reader = new Utf8JsonReader("false"u8);
+            JsonElement trueElement = JsonElement.ParseValue(ref reader);
+
+            settings.AddMetadataSetting("a", trueElement);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.TypeOf<JsonElement>().And.Matches<JsonElement>(static left =>
+            {
+                return left.ValueKind == JsonValueKind.False;
+            }));
+
+            List<int> intValues = [1, 2, 3];
+            settings.AddMetadataSetting("a", intValues);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.TypeOf<List<int>>().And.EqualTo(intValues));
+
+            Dictionary<string, int> dictionaryValues = new Dictionary<string, int>
+            {
+                {"value1", 1 },
+                {"value2", 1 },
+            };
+            settings.AddMetadataSetting("a", dictionaryValues);
+            Assert.That(settings.HasCapability("a"));
+            Assert.That(settings.GetCapability("a"), Is.TypeOf<Dictionary<string, int>>().And.EqualTo(dictionaryValues));
+        }
     }
 }

rb/Gemfile.lock

@@ -13,8 +13,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.1.2)
+    activesupport (7.2.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
@@ -28,6 +29,7 @@ GEM
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
+    benchmark (0.4.0)
     bigdecimal (3.1.8)
     bigdecimal (3.1.8-java)
     concurrent-ruby (1.3.4)
@@ -45,7 +47,7 @@ GEM
     ffi (1.17.0)
     ffi (1.17.0-java)
     ffi (1.17.0-x86_64-darwin)
-    fileutils (1.7.2)
+    fileutils (1.7.3)
     git (1.19.1)
       addressable (~> 2.8)
       rchardet (~> 1.8)
@@ -58,21 +60,21 @@ GEM
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     jar-dependencies (0.4.1)
-    json (2.7.5)
-    json (2.7.5-java)
+    json (2.8.1)
+    json (2.8.1-java)
     language_server-protocol (3.17.0.3)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.6.1)
     minitest (5.25.1)
     parallel (1.26.3)
-    parser (3.3.5.0)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
-    psych (5.1.2)
+    psych (5.2.0)
       stringio
-    psych (5.1.2-java)
+    psych (5.2.0-java)
       jar-dependencies (>= 0.1.7)
     public_suffix (6.0.1)
     racc (1.8.1)
@@ -89,7 +91,7 @@ GEM
     rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
-    reline (0.5.10)
+    reline (0.5.11)
       io-console (~> 0.5)
     rexml (3.3.9)
     rspec (3.13.0)
@@ -105,7 +107,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.67.0)
+    rubocop (1.68.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -115,7 +117,7 @@ GEM
       rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.33.0)
+    rubocop-ast (1.34.1)
       parser (>= 3.3.1.0)
     rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
@@ -151,7 +153,7 @@ GEM
       securerandom (>= 0.1)
       strscan (>= 1.0.0)
       terminal-table (>= 2, < 4)
-    stringio (3.1.1)
+    stringio (3.1.2)
     strscan (3.1.0)
     strscan (3.1.0-java)
     terminal-table (3.0.2)
@@ -163,7 +165,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.8.2)
+    webrick (1.9.0)
     websocket (1.2.11)
     yard (0.9.37)
 

rb/lib/selenium/webdriver/bidi/log_handler.rb

@@ -30,6 +30,7 @@ def initialize(bidi)
         end
 
         # @return [int] id of the handler
+        # steep:ignore:start
         def add_message_handler(type)
           subscribe_log_entry unless @log_entry_subscribed
           @bidi.add_callback('log.entryAdded') do |params|
@@ -39,6 +40,7 @@ def add_message_handler(type)
             end
           end
         end
+        # steep:ignore:end
 
         # @param [int] id of the handler previously added
         def remove_message_handler(id)

rb/lib/selenium/webdriver/bidi/struct.rb

@@ -37,8 +37,6 @@ def camel_to_snake(camel_str)
           end
         end
       end
-    end
-
-    # BiDi
+    end # BiDi
   end # WebDriver
 end # Selenium

rb/lib/selenium/webdriver/common/error.rb

@@ -50,9 +50,11 @@ def initialize(msg = '')
           super(URLS[class_name] ? "#{msg}; #{SUPPORT_MSG} #{URLS[class_name]}" : msg)
         end
 
+        # steep:ignore:start
         def class_name
-          self.class.name&.split('::')&.last&.to_sym
+          self.class.name.split('::')&.last&.to_sym
         end
+        # steep:ignore:end
       end
 
       #

rb/lib/selenium/webdriver/common/fedcm/account.rb

@@ -30,9 +30,7 @@ class Account
         attr_reader :account_id, :email, :name, :given_name, :picture_url,
                     :idp_config_url, :login_state, :terms_of_service_url, :privacy_policy_url
 
-        # Initializes a new account with the provided attributes.
-        #
-        # @param [Hash]
+        # steep:ignore:start
         def initialize(**args)
           @account_id = args['accountId']
           @email = args['email']
@@ -44,6 +42,7 @@ def initialize(**args)
           @terms_of_service_url = args['termsOfServiceUrl']
           @privacy_policy_url = args['privacyPolicyUrl']
         end
+        # steep:ignore:end
       end # Account
     end # FedCM
   end # WebDriver