capybara 3.16.2 → 3.17.0

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

@@ -7,8 +7,8 @@ module Capybara::Selenium::Driver::ChromeDriver
     within_given_window(handle) do
       begin
         super
-      rescue NoMethodError => err
-        raise unless err.message =~ /full_screen_window/
+      rescue NoMethodError => e
+        raise unless e.message.match?(/full_screen_window/)
 
         result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
         result['value']
@@ -19,7 +19,7 @@ module Capybara::Selenium::Driver::ChromeDriver
   def resize_window_to(handle, width, height)
     super
   rescue Selenium::WebDriver::Error::UnknownError => err
-    raise unless err.message =~ /failed to change window state/
+    raise unless err.message.match?(/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,11 +40,21 @@ private
 
   def delete_all_cookies
     execute_cdp('Network.clearBrowserCookies')
-  rescue Selenium::WebDriver::Error::UnhandledError, Selenium::WebDriver::Error::WebDriverError
+  rescue *cdp_unsupported_errors
     # If the CDP clear isn't supported do original limited clear
     super
   end
 
+  def cdp_unsupported_errors
+    @cdp_unsupported_errors ||= [Selenium::WebDriver::Error::WebDriverError].tap do |errors|
+      unless selenium_4?
+        ::Selenium::WebDriver.logger.suppress_deprecations do
+          errors << Selenium::WebDriver::Error::UnhandledError
+        end
+      end
+    end
+  end
+
   def execute_cdp(cmd, params = {})
     args = { cmd: cmd, params: params }
     result = bridge.http.call(:post, "session/#{bridge.session_id}/goog/cdp/execute", args)
@@ -59,3 +69,5 @@ private
     browser.send(:bridge)
   end
 end
+
+Capybara::Selenium::Driver.register_specialization :chrome, Capybara::Selenium::Driver::ChromeDriver

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

@@ -3,6 +3,27 @@
 require 'capybara/selenium/nodes/firefox_node'
 
 module Capybara::Selenium::Driver::FirefoxDriver
+  def self.extended(driver)
+    driver.extend Capybara::Selenium::Driver::W3CFirefoxDriver if w3c?(driver)
+  end
+
+  def self.w3c?(driver)
+    (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
+      driver.browser.capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
+  end
+end
+
+module Capybara::Selenium::Driver::W3CFirefoxDriver
+  class << self
+    def extended(driver)
+      require 'capybara/selenium/patches/pause_duration_fix' if pause_broken?(driver.browser)
+    end
+
+    def pause_broken?(sel_driver)
+      sel_driver.capabilities['moz:geckodriverVersion']&.start_with?('0.22.')
+    end
+  end
+
   def resize_window_to(handle, width, height)
     within_given_window(handle) do
       # Don't set the size if already set - See https://github.com/mozilla/geckodriver/issues/643
@@ -48,3 +69,5 @@ private
     ::Capybara::Selenium::FirefoxNode.new(self, native_node, initial_cache)
   end
 end
+
+Capybara::Selenium::Driver.register_specialization :firefox, Capybara::Selenium::Driver::FirefoxDriver

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

@@ -11,3 +11,8 @@ module Capybara::Selenium::Driver::InternetExplorerDriver
     handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh) }
   end
 end
+
+module Capybara::Selenium
+  Driver.register_specialization :ie, Driver::InternetExplorerDriver
+  Driver.register_specialization :internet_explorer, Driver::InternetExplorerDriver
+end

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

@@ -3,7 +3,17 @@
 require 'capybara/selenium/nodes/safari_node'
 
 module Capybara::Selenium::Driver::SafariDriver
-private # rubocop:disable Layout/IndentationWidth
+  def switch_to_frame(frame)
+    return super unless frame == :parent
+
+    # safaridriver/safari has an issue where switch_to_frame(:parent)
+    # behaves like switch_to_frame(:top)
+    handles = @frame_handles[current_window_handle]
+    browser.switch_to.default_content
+    handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh) }
+  end
+
+private
 
   def build_node(native_node, initial_cache = {})
     ::Capybara::Selenium::SafariNode.new(self, native_node, initial_cache)
@@ -13,3 +23,6 @@ private # rubocop:disable Layout/IndentationWidth
     browser.send(:bridge)
   end
 end
+
+Capybara::Selenium::Driver.register_specialization(/^(safari|Safari_Technology_Preview)$/,
+                                                   Capybara::Selenium::Driver::SafariDriver)

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

@@ -18,44 +18,22 @@ module Capybara
         hints = []
 
         if (els.size > 2) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']
-          els = filter_by_text(els, texts) unless texts.empty?
+          begin
+            els = filter_by_text(els, texts) unless texts.empty?
+            hints_js, functions = build_hints_js(uses_visibility, styles)
 
-          hints_js = +''
-          functions = []
-          if uses_visibility && !is_displayed_atom.empty?
-            hints_js << <<~VISIBILITY_JS
-              var vis_func = #{is_displayed_atom};
-            VISIBILITY_JS
-            functions << 'vis_func'
-          end
-
-          if styles.is_a? Hash
-            hints_js << <<~STYLE_JS
-              var style_func = function(el){
-                var el_styles = window.getComputedStyle(el);
-                return #{styles.keys.map(&:to_s)}.reduce(function(res, style){
-                  res[style] = el_styles[style];
-                  return res;
-                }, {});
-              };
-            STYLE_JS
-            functions << 'style_func'
-          end
-
-          unless functions.empty?
-            hints_js << <<~EACH_JS
-              return arguments[0].map(function(el){
-                return [#{functions.join(',')}].map(function(fn){ return fn.call(null, el) });
-              });
-            EACH_JS
-
-            hints = es_context.execute_script hints_js, els
-            hints.map! do |results|
-              result = {}
-              result[:style] = results.pop if styles.is_a? Hash
-              result[:visible] = results.pop if uses_visibility
-              result
+            unless functions.empty?
+              hints = es_context.execute_script(hints_js, els).map! do |results|
+                hint = {}
+                hint[:style] = results.pop if functions.include?(:style_func)
+                hint[:visible] = results.pop if functions.include?(:vis_func)
+                hint
+              end
             end
+          rescue ::Selenium::WebDriver::Error::StaleElementReferenceError,
+                 ::Capybara::NotSupportedByDriverError
+            # warn 'Unexpected Stale Element Error - skipping optimization'
+            hints = []
           end
         end
         els.map.with_index { |el, idx| build_node(el, hints[idx] || {}) }
@@ -63,7 +41,7 @@ module Capybara
 
       def filter_by_text(elements, texts)
         es_context.execute_script <<~JS, elements, texts
-          var texts = arguments[1]
+          var texts = arguments[1];
           return arguments[0].filter(function(el){
             var content = el.textContent.toLowerCase();
             return texts.every(function(txt){ return content.indexOf(txt.toLowerCase()) != -1 });
@@ -71,6 +49,39 @@ module Capybara
         JS
       end
 
+      def build_hints_js(uses_visibility, styles)
+        functions = []
+        hints_js = +''
+
+        if uses_visibility && !is_displayed_atom.empty?
+          hints_js << <<~VISIBILITY_JS
+            var vis_func = #{is_displayed_atom};
+          VISIBILITY_JS
+          functions << :vis_func
+        end
+
+        if styles.is_a? Hash
+          hints_js << <<~STYLE_JS
+            var style_func = function(el){
+              var el_styles = window.getComputedStyle(el);
+              return #{styles.keys.map(&:to_s)}.reduce(function(res, style){
+                res[style] = el_styles[style];
+                return res;
+              }, {});
+            };
+          STYLE_JS
+          functions << :style_func
+        end
+
+        hints_js << <<~EACH_JS
+          return arguments[0].map(function(el){
+            return [#{functions.join(',')}].map(function(fn){ return fn.call(null, el) });
+          });
+        EACH_JS
+
+        [hints_js, functions]
+      end
+
       def es_context
         respond_to?(:execute_script) ? self : driver
       end

data/lib/capybara/selenium/logger_suppressor.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Selenium
+    module DeprecationSuppressor
+      def deprecate(*)
+        super unless @suppress_for_capybara
+      end
+
+      def suppress_deprecations
+        prev_suppress_for_capybara, @suppress_for_capybara = @suppress_for_capybara, true
+        yield
+      ensure
+        @suppress_for_capybara = prev_suppress_for_capybara
+      end
+    end
+
+    module ErrorSuppressor
+      def for_code(*)
+        ::Selenium::WebDriver.logger.suppress_deprecations do
+          super
+        end
+      end
+    end
+  end
+end
+
+Selenium::WebDriver::Logger.prepend Capybara::Selenium::DeprecationSuppressor
+Selenium::WebDriver::Error.singleton_class.prepend Capybara::Selenium::ErrorSuppressor

data/lib/capybara/selenium/node.rb

@@ -56,9 +56,10 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   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?
 
-    case tag_name
+    tag_name, type = attrs(:tagName, :type)
+    case tag_name.downcase
     when 'input'
-      case self[:type]
+      case type.downcase
       when 'radio'
         click
       when 'checkbox'
@@ -96,13 +97,13 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     return native.click if click_options.empty?
 
     click_with_options(click_options)
-  rescue StandardError => err
-    if err.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
-       err.message =~ /Other element would receive the click/
+  rescue StandardError => e
+    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
+       e.message.match?(/Other element would receive the click/)
       scroll_to_center
     end
 
-    raise err
+    raise e
   end
 
   def right_click(keys = [], **options)
@@ -148,7 +149,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     return true unless native.enabled?
 
     # WebDriver only defines `disabled?` for form controls but fieldset makes sense too
-    tag_name == 'fieldset' && find_xpath('ancestor-or-self::fieldset[@disabled]').any?
+    find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any?
   end
 
   def content_editable?
@@ -211,7 +212,7 @@ private
       # Clear field by JavaScript assignment of the value property.
       # Script can change a readonly element which user input cannot, so
       # don't execute if readonly.
-      driver.execute_script "arguments[0].value = ''", self unless clear == :none
+      driver.execute_script "if (!arguments[0].readOnly){ arguments[0].value = '' }", self unless clear == :none
       send_keys(value)
     end
   end
@@ -269,6 +270,7 @@ private
 
   def update_value_js(value)
     driver.execute_script(<<-JS, self, value)
+      if (arguments[0].readOnly) { return };
       if (document.activeElement !== arguments[0]){
         arguments[0].focus();
       }
@@ -352,6 +354,18 @@ private
     self.class.new(driver, native_node, initial_cache)
   end
 
+  def attrs(*attr_names)
+    return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH']
+
+    driver.evaluate_script <<~'JS', self, attr_names.map(&:to_s)
+      (function(el, names){
+        return names.map(function(name){
+          return el[name]
+        });
+      })(arguments[0], arguments[1]);
+    JS
+  end
+
   GET_XPATH_SCRIPT = <<~'JS'
     (function(el, xml){
       var xpath = '';

data/lib/capybara/selenium/nodes/chrome_node.rb

@@ -14,8 +14,8 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
 
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
     super(value)
-  rescue ::Selenium::WebDriver::Error::ExpectedError => err
-    raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload" if err.message.match?(/File not found : .+\n.+/m)
+  rescue *file_errors => e
+    raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload" if e.message.match?(/File not found : .+\n.+/m)
 
     raise
   end
@@ -28,6 +28,12 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
 
 private
 
+  def file_errors
+    @file_errors = ::Selenium::WebDriver.logger.suppress_deprecations do
+      [::Selenium::WebDriver::Error::ExpectedError]
+    end
+  end
+
   def bridge
     driver.browser.send(:bridge)
   end

data/lib/capybara/server/animation_disabler.rb

@@ -36,7 +36,7 @@ module Capybara
       attr_reader :disable_markup
 
       def html_content?
-        !!(@headers['Content-Type'] =~ /html/)
+        /html/.match?(@headers['Content-Type'])
       end
 
       def insert_disable(html)

data/lib/capybara/server/checker.rb

@@ -12,7 +12,7 @@ module Capybara
 
       def request(&block)
         ssl? ? https_request(&block) : http_request(&block)
-      rescue *TRY_HTTPS_ERRORS
+      rescue *TRY_HTTPS_ERRORS # rubocop:disable Naming/RescuedExceptionsVariableName
         res = https_request(&block)
         @ssl = true
         res

data/lib/capybara/server/middleware.rb

@@ -46,9 +46,9 @@ module Capybara
           @counter.increment
           begin
             @extended_app.call(env)
-          rescue *@server_errors => err
-            @error ||= err
-            raise err
+          rescue *@server_errors => e
+            @error ||= e
+            raise e
           ensure
             @counter.decrement
           end

data/lib/capybara/session/config.rb

@@ -77,24 +77,18 @@ module Capybara
 
     remove_method :app_host=
     def app_host=(url)
-      raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." if url && url !~ URI::DEFAULT_PARSER.make_regexp
+      raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
 
       @app_host = url
     end
 
     remove_method :default_host=
     def default_host=(url)
-      raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." if url && url !~ URI::DEFAULT_PARSER.make_regexp
+      raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
 
       @default_host = url
     end
 
-    remove_method :disable_animation=
-    def disable_animation=(bool_or_allowlist)
-      warn 'Capybara.disable_animation is a beta feature - it may change/disappear in a future point version' if bool_or_allowlist
-      @disable_animation = bool_or_allowlist
-    end
-
     remove_method :test_id=
     ##
     #

data/lib/capybara/spec/session/attach_file_spec.rb

@@ -121,7 +121,7 @@ Capybara::SpecHelper.spec '#attach_file' do
 
   context "with a locator that doesn't exist" do
     it 'should raise an error' do
-      msg = 'Unable to find file field "does not exist"'
+      msg = /Unable to find file field "does not exist"/
       expect do
         @session.attach_file('does not exist', with_os_path_separators(test_file_path))
       end.to raise_error(Capybara::ElementNotFound, msg)

data/lib/capybara/spec/session/check_spec.rb

@@ -83,7 +83,7 @@ Capybara::SpecHelper.spec '#check' do
 
   context "with a locator that doesn't exist" do
     it 'should raise an error' do
-      msg = 'Unable to find checkbox "does not exist"'
+      msg = /Unable to find checkbox "does not exist"/
       expect do
         @session.check('does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)
@@ -171,11 +171,11 @@ Capybara::SpecHelper.spec '#check' do
       end
 
       it 'should raise original error when no label available' do
-        expect { @session.check('form_cars_ariel') }.to raise_error(Capybara::ElementNotFound, 'Unable to find visible checkbox "form_cars_ariel"')
+        expect { @session.check('form_cars_ariel') }.to raise_error(Capybara::ElementNotFound, /Unable to find visible checkbox "form_cars_ariel"/)
       end
 
       it 'should raise error if not allowed to click label' do
-        expect { @session.check('form_cars_mclaren', allow_label_click: false) }.to raise_error(Capybara::ElementNotFound, 'Unable to find visible checkbox "form_cars_mclaren"')
+        expect { @session.check('form_cars_mclaren', allow_label_click: false) }.to raise_error(Capybara::ElementNotFound, /Unable to find visible checkbox "form_cars_mclaren"/)
       end
     end
 
@@ -187,7 +187,7 @@ Capybara::SpecHelper.spec '#check' do
       end
 
       it 'should raise error if checkbox not visible' do
-        expect { @session.check('form_cars_mclaren') }.to raise_error(Capybara::ElementNotFound, 'Unable to find visible checkbox "form_cars_mclaren"')
+        expect { @session.check('form_cars_mclaren') }.to raise_error(Capybara::ElementNotFound, /Unable to find visible checkbox "form_cars_mclaren"/)
       end
 
       it 'should include node filter in error if verified' do