Updating .NET bindings to allow use with older versions of the IE driver

The bindings will now flatten out the capabilities sent over the wire for
non-spec-compliant versions of the IE driver. This will allow users to
continue to use legacy versions of the driver until enough are upgraded to
a version of the executable that understands the `se:ieOptions`
capability.

Author: jimevans

dotnet/src/webdriver/IE/InternetExplorerDriver.cs

@@ -17,6 +17,7 @@
 // </copyright>
 
 using System;
+using System.Collections.Generic;
 using OpenQA.Selenium.Remote;
 
 namespace OpenQA.Selenium.IE
@@ -160,6 +161,37 @@ public override IFileDetector FileDetector
             set { }
         }
 
+        /// <summary>
+        /// Gets the capabilities as a dictionary supporting legacy drivers.
+        /// </summary>
+        /// <param name="capabilities">The dictionary to return.</param>
+        /// <returns>A Dictionary consisting of the capabilities requested.</returns>
+        /// <remarks>This method is only transitional. Do not rely on it. It will be removed
+        /// once browser driver capability formats stabilize.</remarks>
+        protected override Dictionary<string, object> GetLegacyCapabilitiesDictionary(ICapabilities capabilities)
+        {
+            // Flatten the dictionary, if required to support old versions of the IE driver.
+            Dictionary<string, object> capabilitiesDictionary = new Dictionary<string, object>();
+            DesiredCapabilities capabilitiesObject = capabilities as DesiredCapabilities;
+            foreach (KeyValuePair<string, object> entry in capabilitiesObject.CapabilitiesDictionary)
+            {
+                if (entry.Key == InternetExplorerOptions.Capability)
+                {
+                    Dictionary<string, object> internetExplorerOptions = entry.Value as Dictionary<string, object>;
+                    foreach (KeyValuePair<string, object> option in internetExplorerOptions)
+                    {
+                        capabilitiesDictionary.Add(option.Key, option.Value);
+                    }
+                }
+                else
+                {
+                    capabilitiesDictionary.Add(entry.Key, entry.Value);
+                }
+            }
+
+            return capabilitiesDictionary;
+        }
+
         private static ICapabilities ConvertOptionsToCapabilities(InternetExplorerOptions options)
         {
             if (options == null)

dotnet/src/webdriver/Remote/DesiredCapabilities.cs

@@ -16,6 +16,7 @@
 // limitations under the License.
 // </copyright>
 
+using System;
 using System.Collections.Generic;
 using System.Globalization;
 
@@ -141,6 +142,7 @@ public string Version
         /// <summary>
         /// Gets or sets a value indicating whether the browser is JavaScript enabled
         /// </summary>
+        [Obsolete("Capability is not allowed by the W3C specification, and will be removed in a future version of the bindings.")]
         public bool IsJavaScriptEnabled
         {
             get

dotnet/src/webdriver/Remote/RemoteWebDriver.cs

@@ -1094,23 +1094,10 @@ protected virtual void Dispose(bool disposing)
         /// <param name="desiredCapabilities">Capabilities of the browser</param>
         protected void StartSession(ICapabilities desiredCapabilities)
         {
-            DesiredCapabilities capabilitiesObject = desiredCapabilities as DesiredCapabilities;
             Dictionary<string, object> parameters = new Dictionary<string, object>();
-            parameters.Add("desiredCapabilities", capabilitiesObject.CapabilitiesDictionary);
+            parameters.Add("desiredCapabilities", this.GetLegacyCapabilitiesDictionary(desiredCapabilities));
 
-            // Must remove "platform" and "version" capabilities, which are not
-            // supported by W3C compliant remote ends. Note that this block is
-            // temporary and will change soon.
-            Dictionary<string, object> firstMatchCapabilities = capabilitiesObject.CapabilitiesDictionary;
-            if (firstMatchCapabilities.ContainsKey(CapabilityType.Version))
-            {
-                firstMatchCapabilities.Remove(CapabilityType.Version);
-            }
-
-            if (firstMatchCapabilities.ContainsKey(CapabilityType.Platform))
-            {
-                firstMatchCapabilities.Remove(CapabilityType.Platform);
-            }
+            Dictionary<string, object> firstMatchCapabilities = this.GetCapabilitiesDictionary(desiredCapabilities);
 
             List<object> firstMatchCapabilitiesList = new List<object>();
             firstMatchCapabilitiesList.Add(firstMatchCapabilities);
@@ -1127,6 +1114,47 @@ protected void StartSession(ICapabilities desiredCapabilities)
             this.sessionId = new SessionId(response.SessionId);
         }
 
+        /// <summary>
+        /// Gets the capabilities as a dictionary supporting legacy drivers.
+        /// </summary>
+        /// <param name="capabilities">The dictionary to return.</param>
+        /// <returns>A Dictionary consisting of the capabilities requested.</returns>
+        /// <remarks>This method is only transitional. Do not rely on it. It will be removed
+        /// once browser driver capability formats stabilize.</remarks>
+        protected virtual Dictionary<string, object> GetLegacyCapabilitiesDictionary(ICapabilities capabilities)
+        {
+            Dictionary<string, object> capabilitiesDictionary = new Dictionary<string, object>();
+            DesiredCapabilities capabilitiesObject = capabilities as DesiredCapabilities;
+            foreach (KeyValuePair<string, object> entry in capabilitiesObject.CapabilitiesDictionary)
+            {
+                capabilitiesDictionary.Add(entry.Key, entry.Value);
+            }
+
+            return capabilitiesDictionary;
+        }
+
+        /// <summary>
+        /// Gets the capabilities as a dictionary.
+        /// </summary>
+        /// <param name="capabilities">The dictionary to return.</param>
+        /// <returns>A Dictionary consisting of the capabilities requested.</returns>
+        /// <remarks>This method is only transitional. Do not rely on it. It will be removed
+        /// once browser driver capability formats stabilize.</remarks>
+        protected virtual Dictionary<string, object> GetCapabilitiesDictionary(ICapabilities capabilities)
+        {
+            Dictionary<string, object> capabilitiesDictionary = new Dictionary<string, object>();
+            DesiredCapabilities capabilitiesObject = capabilities as DesiredCapabilities;
+            foreach (KeyValuePair<string, object> entry in capabilitiesObject.CapabilitiesDictionary)
+            {
+                if (entry.Key != CapabilityType.Version && entry.Key != CapabilityType.Platform)
+                {
+                    capabilitiesDictionary.Add(entry.Key, entry.Value);
+                }
+            }
+
+            return capabilitiesDictionary;
+        }
+
         /// <summary>
         /// Executes a command with this driver .
         /// </summary>