[dotnet] Handle returning shadow roots from JavaScript

SeleniumHQ · Nov 19, 2021 · 201fad3 · 201fad3
1 parent 9cd6c45
commit 201fad3
Show file tree

Hide file tree

Showing 19 changed files with 277 additions and 157 deletions.
diff --git a/common/src/web/shadowRootPage.html b/common/src/web/shadowRootPage.html
@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Shadow Root Page</title>
+</head>
+<body>
+    <style>
+        custom-checkbox-element {
+            display:block; width:20px; height:20px;
+        }
+    </style>
+    <div><input id="noShadowRoot" /></div>
+    <div><custom-checkbox-element></custom-checkbox-element></div>
+    <script>
+        customElements.define('custom-checkbox-element',
+            class extends HTMLElement {
+                constructor() {
+                    super();
+                    this.attachShadow({mode: 'open'}).innerHTML = '<div><input type="checkbox"/></div>';
+                }
+            }
+        );
+    </script>
+</body>
+</html>
diff --git a/dotnet/src/webdriver/ElementCoordinates.cs b/dotnet/src/webdriver/ElementCoordinates.cs
@@ -70,7 +70,7 @@ public object AuxiliaryLocator
         {
             get
             {
-                IWebElementReference elementReference = this.element as IWebElementReference;
+                IWebDriverObjectReference elementReference = this.element as IWebDriverObjectReference;
                 if (elementReference == null)
                 {
                     return null;
@@ -80,7 +80,7 @@ public object AuxiliaryLocator
                 // uses the raw ID of the element, not an element reference. To use this,
                 // extract the ID using the well-known key to the dictionary for element
                 // references.
-                return elementReference.ElementReferenceId;
+                return elementReference.ObjectReferenceId;
             }
         }
     }

diff --git a/dotnet/src/webdriver/Interactions/PointerInputDevice.cs b/dotnet/src/webdriver/Interactions/PointerInputDevice.cs
@@ -521,13 +521,13 @@ public override string ToString()
 
             private Dictionary<string, object> ConvertElement()
             {
-                IWebElementReference elementReference = this.target as IWebElementReference;
+                IWebDriverObjectReference elementReference = this.target as IWebDriverObjectReference;
                 if (elementReference == null)
                 {
                     IWrapsElement elementWrapper = this.target as IWrapsElement;
                     if (elementWrapper != null)
                     {
-                        elementReference = elementWrapper.WrappedElement as IWebElementReference;
+                        elementReference = elementWrapper.WrappedElement as IWebDriverObjectReference;
                     }
                 }
 

diff --git a/dotnet/src/webdriver/Interactions/WheelInputDevice.cs b/dotnet/src/webdriver/Interactions/WheelInputDevice.cs
@@ -178,13 +178,13 @@ public override Dictionary<string, object> ToDictionary()
 
             private Dictionary<string, object> ConvertElement()
             {
-                IWebElementReference elementReference = this.target as IWebElementReference;
+                IWebDriverObjectReference elementReference = this.target as IWebDriverObjectReference;
                 if (elementReference == null)
                 {
                     IWrapsElement elementWrapper = this.target as IWrapsElement;
                     if (elementWrapper != null)
                     {
-                        elementReference = elementWrapper.WrappedElement as IWebElementReference;
+                        elementReference = elementWrapper.WrappedElement as IWebDriverObjectReference;
                     }
                 }
 

diff --git a/...ebdriver/Internal/IWebElementReference.cs → ...ver/Internal/IWebDriverObjectReference.cs b/...ebdriver/Internal/IWebElementReference.cs → ...ver/Internal/IWebDriverObjectReference.cs
@@ -1,4 +1,4 @@
-// <copyright file="IWebElementReference.cs" company="WebDriver Committers">
+// <copyright file="IWebElementReference.cs" company="WebDriver Committers">
 // Licensed to the Software Freedom Conservancy (SFC) under one
 // or more contributor license agreements. See the NOTICE file
 // distributed with this work for additional information
@@ -26,12 +26,12 @@ namespace OpenQA.Selenium.Internal
     /// <summary>
     /// Defines the interface through which the framework can serialize an element to the wire protocol.
     /// </summary>
-    internal interface IWebElementReference
+    internal interface IWebDriverObjectReference
     {
         /// <summary>
-        /// Gets the internal ID of the element.
+        /// Gets the internal ID of the WebDriver object.
         /// </summary>
-        string ElementReferenceId { get; }
+        string ObjectReferenceId { get; }
 
         /// <summary>
         /// Converts an object into an object that represents an element for the wire protocol.

diff --git a/dotnet/src/webdriver/ShadowRoot.cs b/dotnet/src/webdriver/ShadowRoot.cs
@@ -19,13 +19,14 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using OpenQA.Selenium.Internal;
 
 namespace OpenQA.Selenium
 {
     /// <summary>
     /// Provides a representation of an element's shadow root.
     /// </summary>
-    public class ShadowRoot : ISearchContext, IWrapsDriver
+    public class ShadowRoot : ISearchContext, IWrapsDriver, IWebDriverObjectReference
     {
         /// <summary>
         /// The property name that represents an element shadow root in the wire protocol.
@@ -54,6 +55,29 @@ public IWebDriver WrappedDriver
             get { return this.driver; }
         }
 
+        /// <summary>
+        /// Gets the internal ID for this ShadowRoot.
+        /// </summary>
+        string IWebDriverObjectReference.ObjectReferenceId
+        {
+            get { return this.shadowRootId; }
+        }
+
+        internal static bool ContainsShadowRootReference(Dictionary<string, object> shadowRootDictionary)
+        {
+            if (shadowRootDictionary == null)
+            {
+                throw new ArgumentNullException(nameof(shadowRootDictionary), "The dictionary containing the shadow root reference cannot be null");
+            }
+
+            return shadowRootDictionary.ContainsKey(ShadowRootReferencePropertyName);
+        }
+
+        internal static ShadowRoot FromDictionary(WebDriver driver, Dictionary<string, object> shadowRootDictionary)
+        {
+            return new ShadowRoot(driver, shadowRootDictionary[ShadowRoot.ShadowRootReferencePropertyName].ToString());
+        }
+
         /// <summary>
         /// Finds the first <see cref="IWebElement"/> using the given method.
         /// </summary>
@@ -96,5 +120,12 @@ public ReadOnlyCollection<IWebElement> FindElements(By by)
             Response commandResponse = this.driver.InternalExecute(DriverCommand.FindShadowChildElements, parameters);
             return this.driver.GetElementsFromResponse(commandResponse);
         }
+
+        Dictionary<string, object> IWebDriverObjectReference.ToDictionary()
+        {
+            Dictionary<string, object> shadowRootDictionary = new Dictionary<string, object>();
+            shadowRootDictionary.Add(ShadowRootReferencePropertyName, this.shadowRootId);
+            return shadowRootDictionary;
+        }
     }
 }
diff --git a/dotnet/src/webdriver/TargetLocator.cs b/dotnet/src/webdriver/TargetLocator.cs
@@ -91,13 +91,13 @@ public IWebDriver Frame(IWebElement frameElement)
                 throw new ArgumentNullException(nameof(frameElement), "Frame element cannot be null");
             }
 
-            IWebElementReference elementReference = frameElement as IWebElementReference;
+            IWebDriverObjectReference elementReference = frameElement as IWebDriverObjectReference;
             if (elementReference == null)
             {
                 IWrapsElement elementWrapper = frameElement as IWrapsElement;
                 if (elementWrapper != null)
                 {
-                    elementReference = elementWrapper.WrappedElement as IWebElementReference;
+                    elementReference = elementWrapper.WrappedElement as IWebDriverObjectReference;
                 }
             }
 
@@ -108,7 +108,7 @@ public IWebDriver Frame(IWebElement frameElement)
 
             // TODO: Remove "ELEMENT" addition when all remote ends are spec-compliant.
             Dictionary<string, object> elementDictionary = elementReference.ToDictionary();
-            elementDictionary.Add("ELEMENT", elementReference.ElementReferenceId);
+            elementDictionary.Add("ELEMENT", elementReference.ObjectReferenceId);
 
             Dictionary<string, object> parameters = new Dictionary<string, object>();
             parameters.Add("id", elementDictionary);

diff --git a/dotnet/src/webdriver/WebDriver.cs b/dotnet/src/webdriver/WebDriver.cs
@@ -940,13 +940,13 @@ protected object ExecuteScriptCommand(string script, string commandName, params
         private static object ConvertObjectToJavaScriptObject(object arg)
         {
             IWrapsElement argAsWrapsElement = arg as IWrapsElement;
-            IWebElementReference argAsElementReference = arg as IWebElementReference;
+            IWebDriverObjectReference argAsObjectReference = arg as IWebDriverObjectReference;
             IEnumerable argAsEnumerable = arg as IEnumerable;
             IDictionary argAsDictionary = arg as IDictionary;
 
-            if (argAsElementReference == null && argAsWrapsElement != null)
+            if (argAsObjectReference == null && argAsWrapsElement != null)
             {
-                argAsElementReference = argAsWrapsElement.WrappedElement as IWebElementReference;
+                argAsObjectReference = argAsWrapsElement.WrappedElement as IWebDriverObjectReference;
             }
 
             object converted = null;
@@ -955,11 +955,11 @@ private static object ConvertObjectToJavaScriptObject(object arg)
             {
                 converted = arg;
             }
-            else if (argAsElementReference != null)
+            else if (argAsObjectReference != null)
             {
                 // TODO: Remove "ELEMENT" addition when all remote ends are spec-compliant.
-                Dictionary<string, object> elementDictionary = argAsElementReference.ToDictionary();
-                converted = elementDictionary;
+                Dictionary<string, object> webDriverObjectReferenceDictionary = argAsObjectReference.ToDictionary();
+                converted = webDriverObjectReferenceDictionary;
             }
             else if (argAsDictionary != null)
             {
@@ -1026,6 +1026,10 @@ private object ParseJavaScriptReturnValue(object responseValue)
                 {
                     returnValue = this.elementFactory.CreateElement(resultAsDictionary);
                 }
+                else if (ShadowRoot.ContainsShadowRootReference(resultAsDictionary))
+                {
+                    returnValue = ShadowRoot.FromDictionary(this, resultAsDictionary);
+                }
                 else
                 {
                     // Recurse through the dictionary, re-parsing each value.

diff --git a/dotnet/src/webdriver/WebElement.cs b/dotnet/src/webdriver/WebElement.cs
@@ -29,7 +29,7 @@
 
 namespace OpenQA.Selenium
 {
-    public class WebElement : IWebElement, IFindsElement, IWrapsDriver, ILocatable, ITakesScreenshot, IWebElementReference
+    public class WebElement : IWebElement, IFindsElement, IWrapsDriver, ILocatable, ITakesScreenshot, IWebDriverObjectReference
     {
         /// <summary>
         /// The property name that represents a web element in the wire protocol.
@@ -250,7 +250,7 @@ public virtual ICoordinates Coordinates
         /// <summary>
         /// Gets the internal ID of the element.
         /// </summary>
-        string IWebElementReference.ElementReferenceId
+        string IWebDriverObjectReference.ObjectReferenceId
         {
             get { return this.elementId; }
         }
@@ -695,7 +695,7 @@ public override bool Equals(object obj)
             return false;
         }
 
-        Dictionary<string, object> IWebElementReference.ToDictionary()
+        Dictionary<string, object> IWebDriverObjectReference.ToDictionary()
         {
             Dictionary<string, object> elementDictionary = new Dictionary<string, object>();
             elementDictionary.Add(ElementReferencePropertyName, this.elementId);
@@ -753,9 +753,10 @@ private string UploadFile(string localFile)
                 throw new WebDriverException("Cannot upload " + localFile, e);
             }
         }
-        private IWebElementReference ToElementReference()
+
+        private IWebDriverObjectReference ToElementReference()
         {
-            return this as IWebElementReference;
+            return this as IWebDriverObjectReference;
         }
     }
 }
diff --git a/dotnet/test/common/DevTools/DevToolsConsoleTest.cs b/dotnet/test/common/DevTools/DevToolsConsoleTest.cs
@@ -19,11 +19,11 @@ public class DevToolsConsoleTest : DevToolsTestFixture
         [IgnoreBrowser(Selenium.Browser.Safari, "Safari does not support Chrome DevTools Protocol")]
         public async Task VerifyMessageAdded()
         {
-            var domains = session.GetVersionSpecificDomains<V93.DevToolsSessionDomains>();
+            var domains = session.GetVersionSpecificDomains<V96.DevToolsSessionDomains>();
             string consoleMessage = "Hello Selenium";
 
             ManualResetEventSlim sync = new ManualResetEventSlim(false);
-            EventHandler<V93.Console.MessageAddedEventArgs> messageAddedHandler = (sender, e) =>
+            EventHandler<V96.Console.MessageAddedEventArgs> messageAddedHandler = (sender, e) =>
             {
                 Assert.That(e.Message.Text, Is.EqualTo(consoleMessage));
                 sync.Set();

diff --git a/dotnet/test/common/DevTools/DevToolsLogTest.cs b/dotnet/test/common/DevTools/DevToolsLogTest.cs
@@ -19,12 +19,12 @@ public class DevToolsLogTest : DevToolsTestFixture
         [IgnoreBrowser(Selenium.Browser.Safari, "Safari does not support Chrome DevTools Protocol")]
         public async Task VerifyEntryAddedAndClearLog()
         {
-            var domains = session.GetVersionSpecificDomains<V93.DevToolsSessionDomains>();
+            var domains = session.GetVersionSpecificDomains<V96.DevToolsSessionDomains>();
             ManualResetEventSlim sync = new ManualResetEventSlim(false);
-            EventHandler<V93.Log.EntryAddedEventArgs> entryAddedHandler = (sender, e) =>
+            EventHandler<V96.Log.EntryAddedEventArgs> entryAddedHandler = (sender, e) =>
             {
                 Assert.That(e.Entry.Text.Contains("404"));
-                Assert.That(e.Entry.Level == V93.Log.LogEntryLevelValues.Error);
+                Assert.That(e.Entry.Level == V96.Log.LogEntryLevelValues.Error);
                 sync.Set();
             };