Merge pull request #2406 from teamcapybara/shadow_dom_path

Detect shadow dom elements when calling `path`

Author: twalpole

lib/capybara/selenium/node.rb

@@ -493,6 +493,9 @@ def attrs(*attr_names)
       var xpath = '';
     	var pos, tempitem2;
 
+      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {
+        return ": Shadow DOM element - no XPath :"
+        };
       while(el !== xml.documentElement) {
         pos = 0;
         tempitem2 = el;

lib/capybara/spec/public/test.js

@@ -271,5 +271,10 @@ $(function() {
   });
   $('#multiple-file, #hidden_file').change(function(e){
     $('body').append($('<p class="file_change">File input changed</p>'));
-  })
+  });
+
+  var shadow = document.querySelector('#shadow').attachShadow({mode: 'open'});
+  var span = document.createElement('span');
+  span.textContent = 'The things we do in the shadows';
+  shadow.appendChild(span);
 });

lib/capybara/spec/session/node_spec.rb

@@ -409,6 +409,17 @@
       element = @session.find(:link, 'Second Link')
       expect(@session.find(:xpath, element.path)).to eq(element)
     end
+
+    it 'reports when element in shadow dom', requires: [:shadow_dom] do
+      @session.visit('/with_js')
+      shadow = @session.find(:css, '#shadow')
+      element = @session.evaluate_script(<<~JS, shadow)
+        (function(root){
+          return root.shadowRoot.querySelector('span');
+        })(arguments[0])
+      JS
+      expect(element.path).to eq ": Shadow DOM element - no XPath :"
+    end
   end
 
   describe '#trigger', requires: %i[js trigger] do

lib/capybara/spec/views/with_js.erb

@@ -152,6 +152,7 @@
       <p>This is an HTML5 draggable element.</p>
     </div>
 
+    <div id="shadow"></div>
     <script type="text/javascript">
       // a javascript comment
       var aVar = 123;

spec/dsl_spec.rb

@@ -8,7 +8,7 @@ class TestClass
 end
 
 Capybara::SpecHelper.run_specs TestClass.new, 'DSL', capybara_skip: %i[
-  js modals screenshot frames windows send_keys server hover about_scheme psc download css driver scroll spatial html_validation
+  js modals screenshot frames windows send_keys server hover about_scheme psc download css driver scroll spatial html_validation shadow_dom
 ] do |example|
   case example.metadata[:full_description]
   when /has_css\? should support case insensitive :class and :id options/

spec/rack_test_spec.rb

@@ -27,6 +27,7 @@ module TestSessions
   scroll
   spatial
   html_validation
+  shadow_dom
 ]
 Capybara::SpecHelper.run_specs TestSessions::RackTest, 'RackTest', capybara_skip: skipped_tests do |example|
   case example.metadata[:full_description]