capybara 3.29.0 → 3.37.1

data/lib/capybara/selenium/driver_specializations/chrome_driver.rb

@@ -7,27 +7,25 @@ module Capybara::Selenium::Driver::ChromeDriver
   def self.extended(base)
     bridge = base.send(:bridge)
     bridge.extend Capybara::Selenium::ChromeLogs unless bridge.respond_to?(:log)
-    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)
     base.options[:native_displayed] = false if base.options[:native_displayed].nil?
   end
 
   def fullscreen_window(handle)
     within_given_window(handle) do
-      begin
-        super
-      rescue NoMethodError => e
-        raise unless e.message.match?(/full_screen_window/)
-
-        result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
-        result['value']
-      end
+      super
+    rescue NoMethodError => e
+      raise unless e.message.include?('full_screen_window')
+
+      result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
+      result['value']
     end
   end
 
   def resize_window_to(handle, width, height)
     super
   rescue Selenium::WebDriver::Error::UnknownError => e
-    raise unless e.message.match?(/failed to change window state/)
+    raise unless e.message.include?('failed to change window state')
 
     # Chromedriver doesn't wait long enough for state to change when coming out of fullscreen
     # and raises unnecessary error. Wait a bit and try again.
@@ -40,7 +38,7 @@ module Capybara::Selenium::Driver::ChromeDriver
     return unless @browser
 
     switch_to_window(window_handles.first)
-    window_handles.slice(1..-1).each { |win| close_window(win) }
+    window_handles.slice(1..).each { |win| close_window(win) }
     return super if chromedriver_version < 73
 
     timer = Capybara::Helpers.timer(expire_in: 10)
@@ -65,7 +63,7 @@ private
   end
 
   def clear_all_storage?
-    storage_clears.none? { |s| s == false }
+    storage_clears.none? false
   end
 
   def uniform_storage_clear?
@@ -96,7 +94,7 @@ private
 
   def execute_cdp(cmd, params = {})
     if browser.respond_to? :execute_cdp
-      browser.execute_cdp(cmd, params)
+      browser.execute_cdp(cmd, **params)
     else
       args = { cmd: cmd, params: params }
       result = bridge.http.call(:post, "session/#{bridge.session_id}/goog/cdp/execute", args)

data/lib/capybara/selenium/driver_specializations/edge_driver.rb

@@ -5,7 +5,7 @@ require 'capybara/selenium/nodes/edge_node'
 module Capybara::Selenium::Driver::EdgeDriver
   def self.extended(base)
     bridge = base.send(:bridge)
-    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)
     base.options[:native_displayed] = false if base.options[:native_displayed].nil?
   end
 
@@ -13,21 +13,19 @@ module Capybara::Selenium::Driver::EdgeDriver
     return super if edgedriver_version < 75
 
     within_given_window(handle) do
-      begin
-        super
-      rescue NoMethodError => e
-        raise unless e.message.match?(/full_screen_window/)
-
-        result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
-        result['value']
-      end
+      super
+    rescue NoMethodError => e
+      raise unless e.message.include?('full_screen_window')
+
+      result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
+      result['value']
     end
   end
 
   def resize_window_to(handle, width, height)
     super
   rescue Selenium::WebDriver::Error::UnknownError => e
-    raise unless e.message.match?(/failed to change window state/)
+    raise unless e.message.include?('failed to change window state')
 
     # Chromedriver doesn't wait long enough for state to change when coming out of fullscreen
     # and raises unnecessary error. Wait a bit and try again.
@@ -41,7 +39,7 @@ module Capybara::Selenium::Driver::EdgeDriver
     return unless @browser
 
     switch_to_window(window_handles.first)
-    window_handles.slice(1..-1).each { |win| close_window(win) }
+    window_handles.slice(1..).each { |win| close_window(win) }
 
     timer = Capybara::Helpers.timer(expire_in: 10)
     begin
@@ -74,7 +72,7 @@ private
   end
 
   def clear_all_storage?
-    storage_clears.none? { |s| s == false }
+    storage_clears.none? false
   end
 
   def uniform_storage_clear?

data/lib/capybara/selenium/driver_specializations/firefox_driver.rb

@@ -6,7 +6,7 @@ module Capybara::Selenium::Driver::FirefoxDriver
   def self.extended(driver)
     driver.extend Capybara::Selenium::Driver::W3CFirefoxDriver if w3c?(driver)
     bridge = driver.send(:bridge)
-    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)
   end
 
   def self.w3c?(driver)
@@ -46,13 +46,13 @@ module Capybara::Selenium::Driver::W3CFirefoxDriver
       begin
         # Firefox 68 hangs if we try to switch windows while a modal is visible
         browser.switch_to.alert&.dismiss
-      rescue Selenium::WebDriver::Error::NoSuchAlertError # rubocop:disable Lint/HandleExceptions
+      rescue Selenium::WebDriver::Error::NoSuchAlertError
         # Swallow
       end
     end
 
     switch_to_window(window_handles.first)
-    window_handles.slice(1..-1).each { |win| close_window(win) }
+    window_handles.slice(1..).each { |win| close_window(win) }
     super
   end
 
@@ -61,7 +61,7 @@ module Capybara::Selenium::Driver::W3CFirefoxDriver
     accept_modal :confirm, wait: 0.1 do
       super
     end
-  rescue Capybara::ModalNotFound # rubocop:disable Lint/HandleExceptions
+  rescue Capybara::ModalNotFound
     # No modal was opened - page has refreshed - ignore
   end
 

data/lib/capybara/selenium/extensions/find.rb

@@ -28,7 +28,7 @@ module Capybara
         hints_js, functions = build_hints_js(uses_visibility, styles, position)
         return [] unless functions.any?
 
-        es_context.execute_script(hints_js, elements).map! do |results|
+        (es_context.execute_script(hints_js, elements) || []).map! do |results|
           hint = {}
           hint[:style] = results.pop if functions.include?(:style_func)
           hint[:position] = results.pop if functions.include?(:position_func)
@@ -100,9 +100,9 @@ module Capybara
       def is_displayed_atom # rubocop:disable Naming/PredicateName
         @@is_displayed_atom ||= begin # rubocop:disable Style/ClassVars
           browser.send(:bridge).send(:read_atom, 'isDisplayed')
-                                rescue StandardError
-                                  # If the atom doesn't exist or other error
-                                  ''
+        rescue StandardError
+          # If the atom doesn't exist or other error
+          ''
         end
       end
     end

data/lib/capybara/selenium/extensions/html5_drag.rb

@@ -4,25 +4,32 @@ class Capybara::Selenium::Node
   module Html5Drag
     # Implement methods to emulate HTML5 drag and drop
 
-    def drag_to(element, html5: nil, delay: 0.05)
+    def drag_to(element, html5: nil, delay: 0.05, drop_modifiers: [])
+      drop_modifiers = Array(drop_modifiers)
+
       driver.execute_script MOUSEDOWN_TRACKER
       scroll_if_needed { browser_action.click_and_hold(native).perform }
       html5 = !driver.evaluate_script(LEGACY_DRAG_CHECK, self) if html5.nil?
       if html5
-        perform_html5_drag(element, delay)
+        perform_html5_drag(element, delay, drop_modifiers)
       else
-        perform_legacy_drag(element)
+        perform_legacy_drag(element, drop_modifiers)
       end
     end
 
   private
 
-    def perform_legacy_drag(element)
-      element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
+    def perform_legacy_drag(element, drop_modifiers)
+      element.scroll_if_needed do
+        # browser_action.move_to(element.native).release.perform
+        keys_down = modifiers_down(browser_action, drop_modifiers)
+        keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)
+        keys_up.perform
+      end
     end
 
-    def perform_html5_drag(element, delay)
-      driver.evaluate_async_script HTML5_DRAG_DROP_SCRIPT, self, element, delay * 1000
+    def perform_html5_drag(element, delay, drop_modifiers)
+      driver.evaluate_async_script HTML5_DRAG_DROP_SCRIPT, self, element, delay * 1000, normalize_keys(drop_modifiers)
       browser_action.release.perform
     end
 
@@ -153,6 +160,14 @@ class Capybara::Selenium::Node
         var targetRect = target.getBoundingClientRect();
         var sourceCenter = rectCenter(source.getBoundingClientRect());
 
+        for (var i = 0; i < drop_modifier_keys.length; i++) {
+          key = drop_modifier_keys[i];
+          if (key == "control"){
+            key = "ctrl"
+          }
+          opts[key + 'Key'] = true;
+        }
+
         // fire 2 dragover events to simulate dragging with a direction
         var entryPoint = pointOnRect(sourceCenter, targetRect)
         var dragOverOpts = Object.assign({clientX: entryPoint.x, clientY: entryPoint.y}, opts);
@@ -166,17 +181,18 @@ class Capybara::Selenium::Node
         var dragOverOpts = Object.assign({clientX: targetCenter.x, clientY: targetCenter.y}, opts);
         var dragOverEvent = new DragEvent('dragover', dragOverOpts);
         target.dispatchEvent(dragOverEvent);
-        window.setTimeout(dragLeave, step_delay, dragOverEvent.defaultPrevented);
+        window.setTimeout(dragLeave, step_delay, dragOverEvent.defaultPrevented, dragOverOpts);
       }
 
-      function dragLeave(drop) {
-        var dragLeaveEvent = new DragEvent('dragleave', opts);
+      function dragLeave(drop, dragOverOpts) {
+        var dragLeaveOptions = Object.assign({}, opts, dragOverOpts);
+        var dragLeaveEvent = new DragEvent('dragleave', dragLeaveOptions);
         target.dispatchEvent(dragLeaveEvent);
         if (drop) {
-          var dropEvent = new DragEvent('drop', opts);
+          var dropEvent = new DragEvent('drop', dragLeaveOptions);
           target.dispatchEvent(dropEvent);
         }
-        var dragEndEvent = new DragEvent('dragend', opts);
+        var dragEndEvent = new DragEvent('dragend', dragLeaveOptions);
         source.dispatchEvent(dragEndEvent);
         callback.call(true);
       }
@@ -184,7 +200,8 @@ class Capybara::Selenium::Node
       var source = arguments[0],
           target = arguments[1],
           step_delay = arguments[2],
-          callback = arguments[3];
+          drop_modifier_keys = arguments[3],
+          callback = arguments[4];
 
       var dt = new DataTransfer();
       var opts = { cancelable: true, bubbles: true, dataTransfer: dt };

data/lib/capybara/selenium/extensions/scroll.rb

@@ -45,20 +45,18 @@ module Capybara
         JS
       end
 
+      SCROLL_POSITIONS = {
+        top: '0',
+        bottom: 'arguments[0].scrollHeight',
+        center: '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'
+      }.freeze
+
       def scroll_to_location(location)
-        scroll_y = case location
-        when :top
-          '0'
-        when :bottom
-          'arguments[0].scrollHeight'
-        when :center
-          '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'
-        end
         driver.execute_script <<~JS, self
           if (arguments[0].scrollTo){
-            arguments[0].scrollTo(0, #{scroll_y});
+            arguments[0].scrollTo(0, #{SCROLL_POSITIONS[location]});
           } else {
-            arguments[0].scrollTop = #{scroll_y};
+            arguments[0].scrollTop = #{SCROLL_POSITIONS[location]};
           }
         JS
       end

data/lib/capybara/selenium/logger_suppressor.rb

@@ -8,8 +8,14 @@ module Capybara
         super
       end
 
-      def deprecate(*)
-        super unless @suppress_for_capybara
+      def deprecate(*args, **opts, &block)
+        return if @suppress_for_capybara
+
+        if opts.empty?
+          super(*args, &block) # support Selenium 3
+        else
+          super
+        end
       end
 
       def suppress_deprecations

data/lib/capybara/selenium/node.rb

@@ -14,7 +14,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def all_text
-    text = driver.evaluate_script('arguments[0].textContent', self)
+    text = driver.evaluate_script('arguments[0].textContent', self) || ''
     text.gsub(/[\u200b\u200e\u200f]/, '')
         .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
         .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
@@ -53,8 +53,15 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   #   :none =>  append the new value to the existing value <br/>
   #   :backspace => send backspace keystrokes to clear the field <br/>
   #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]
+  # @option options [Boolean] :rapid (nil) Whether setting text inputs should use a faster &quot;rapid&quot; mode<br/>
+  #   nil => Text inputs with length greater than 30 characters will be set using a faster driver script mode<br/>
+  #   true => Rapid mode will be used regardless of input length<br/>
+  #   false => Sends keys via conventional mode. This may be required to avoid losing key-presses if you have certain
+  #            Javascript interactions on form inputs<br/>
   def set(value, **options)
-    raise ArgumentError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}" if value.is_a?(Array) && !multiple?
+    if value.is_a?(Array) && !multiple?
+      raise ArgumentError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}"
+    end
 
     tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }
     @tag_name ||= tag_name
@@ -76,11 +83,13 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
         set_datetime_local(value)
       when 'color'
         set_color(value)
+      when 'range'
+        set_range(value)
       else
-        set_text(value, options)
+        set_text(value, **options)
       end
     when 'textarea'
-      set_text(value, options)
+      set_text(value, **options)
     else
       set_content_editable(value)
     end
@@ -100,10 +109,23 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     click_options = ClickOptions.new(keys, options)
     return native.click if click_options.empty?
 
-    click_with_options(click_options)
+    perform_with_options(click_options) do |action|
+      target = click_options.coords? ? nil : native
+      if click_options.delay.zero?
+        action.click(target)
+      else
+        action.click_and_hold(target)
+        if w3c?
+          action.pause(action.pointer_inputs.first, click_options.delay)
+        else
+          action.pause(click_options.delay)
+        end
+        action.release
+      end
+    end
   rescue StandardError => e
     if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
-       e.message.match?(/Other element would receive the click/)
+       e.message.include?('Other element would receive the click')
       scroll_to_center
     end
 
@@ -112,14 +134,26 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
 
   def right_click(keys = [], **options)
     click_options = ClickOptions.new(keys, options)
-    click_with_options(click_options) do |action|
-      click_options.coords? ? action.context_click : action.context_click(native)
+    perform_with_options(click_options) do |action|
+      target = click_options.coords? ? nil : native
+      if click_options.delay.zero?
+        action.context_click(target)
+      elsif w3c?
+        action.move_to(target) if target
+        action.pointer_down(:right)
+              .pause(action.pointer_inputs.first, click_options.delay)
+              .pointer_up(:right)
+      else
+        raise ArgumentError, 'Delay is not supported when right clicking with legacy (non-w3c) selenium driver'
+      end
     end
   end
 
   def double_click(keys = [], **options)
     click_options = ClickOptions.new(keys, options)
-    click_with_options(click_options) do |action|
+    raise ArgumentError, "double_click doesn't support a delay option" unless click_options.delay.zero?
+
+    perform_with_options(click_options) do |action|
       click_options.coords? ? action.double_click : action.double_click(native)
     end
   end
@@ -132,11 +166,17 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     scroll_if_needed { browser_action.move_to(native).perform }
   end
 
-  def drag_to(element, **)
+  def drag_to(element, drop_modifiers: [], **)
+    drop_modifiers = Array(drop_modifiers)
     # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary
     # which means Seleniums `drag_and_drop` is now broken - do it manually
     scroll_if_needed { browser_action.click_and_hold(native).perform }
-    element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
+    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
+    element.scroll_if_needed do
+      keys_down = modifiers_down(browser_action, drop_modifiers)
+      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)
+      keys_up.perform
+    end
   end
 
   def drop(*_)
@@ -164,10 +204,6 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     native.attribute('isContentEditable') == 'true'
   end
 
-  def ==(other)
-    native == other.native
-  end
-
   def path
     driver.evaluate_script GET_XPATH_SCRIPT, self
   end
@@ -183,6 +219,13 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     native.rect
   end
 
+  def shadow_root
+    raise_error 'You must be using Selenium 4.1+ for shadow_root support' unless native.respond_to? :shadow_root
+
+    root = native.shadow_root
+    root && build_node(native.shadow_root)
+  end
+
 protected
 
   def scroll_if_needed
@@ -202,7 +245,7 @@ protected
     JS
     begin
       driver.execute_script(script, self)
-    rescue StandardError # rubocop:disable Lint/HandleExceptions
+    rescue StandardError
       # Swallow error if scrollIntoView with options isn't supported
     end
   end
@@ -232,26 +275,38 @@ private
     find_xpath(XPath.ancestor(:select)[1]).first
   end
 
-  def set_text(value, clear: nil, **_unused)
+  def set_text(value, clear: nil, rapid: nil, **_unused)
     value = value.to_s
     if value.empty? && clear.nil?
       native.clear
     elsif clear == :backspace
       # Clear field by sending the correct number of backspace keys.
       backspaces = [:backspace] * self.value.to_s.length
-      send_keys(*([:end] + backspaces + [value]))
+      send_keys(:end, *backspaces, value)
     elsif clear.is_a? Array
       send_keys(*clear, value)
     else
       driver.execute_script 'arguments[0].select()', self unless clear == :none
-      send_keys(value)
+      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)
+        send_keys(value[0..3])
+        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]
+        send_keys(value[-3..])
+      else
+        send_keys(value)
+      end
     end
   end
 
-  def click_with_options(click_options)
+  def auto_rapid_set_length
+    30
+  end
+
+  def perform_with_options(click_options, &block)
+    raise ArgumentError, 'A block must be provided' unless block
+
     scroll_if_needed do
       action_with_modifiers(click_options) do |action|
-        if block_given?
+        if block
           yield action
         else
           click_options.coords? ? action.click : action.click(native)
@@ -288,6 +343,10 @@ private
     update_value_js(value)
   end
 
+  def set_range(value) # rubocop:disable Naming/AccessorMethodName
+    update_value_js(value)
+  end
+
   def update_value_js(value)
     driver.execute_script(<<-JS, self, value)
       if (arguments[0].readOnly) { return };
@@ -373,10 +432,12 @@ private
 
   def modifiers_down(actions, keys)
     each_key(keys) { |key| actions.key_down(key) }
+    actions
   end
 
   def modifiers_up(actions, keys)
     each_key(keys) { |key| actions.key_up(key) }
+    actions
   end
 
   def browser
@@ -391,18 +452,30 @@ private
     browser.action
   end
 
-  def each_key(keys)
-    keys.each do |key|
-      key = case key
+  def capabilities
+    browser.capabilities
+  end
+
+  def w3c?
+    (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
+      capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
+  end
+
+  def normalize_keys(keys)
+    keys.map do |key|
+      case key
       when :ctrl then :control
       when :command, :cmd then :meta
       else
         key
       end
-      yield key
     end
   end
 
+  def each_key(keys, &block)
+    normalize_keys(keys).each(&block)
+  end
+
   def find_context
     native
   end
@@ -423,11 +496,20 @@ private
     JS
   end
 
+  def native_id
+    # Selenium 3 -> 4 changed the return of ref
+    type_or_id, id = native.ref
+    id || type_or_id
+  end
+
   GET_XPATH_SCRIPT = <<~'JS'
     (function(el, xml){
       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;
@@ -469,6 +551,16 @@ private
     })(arguments[0], arguments[1], arguments[2])
   JS
 
+  RAPID_APPEND_TEXT = <<~'JS'
+    (function(el, value) {
+      value = el.value + value;
+      if (el.maxLength && el.maxLength != -1){
+        value = value.slice(0, el.maxLength);
+      }
+      el.value = value;
+    })(arguments[0], arguments[1])
+  JS
+
   # SettableValue encapsulates time/date field formatting
   class SettableValue
     attr_reader :value
@@ -525,7 +617,11 @@ private
     end
 
     def empty?
-      keys.empty? && !coords?
+      keys.empty? && !coords? && delay.zero?
+    end
+
+    def delay
+      options[:delay] || 0
     end
   end
   private_constant :ClickOptions