selenium-webdriver 4.1.0 → 4.23.0

data/lib/selenium/webdriver/firefox/options.rb

@@ -25,11 +25,12 @@ module Selenium
 
         KEY = 'moz:firefoxOptions'
 
-        # see: https://firefox-source-docs.mozilla.org/testing/geckodriver/Capabilities.html
+        # see: https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions
         CAPABILITIES = {binary: 'binary',
                         args: 'args',
                         log: 'log',
                         prefs: 'prefs',
+                        env: 'env',
                         android_package: 'androidPackage',
                         android_activity: 'androidActivity',
                         android_device_serial: 'androidDeviceSerial',
@@ -44,7 +45,7 @@ module Selenium
         #
         # @example
         #   options = Selenium::WebDriver::Firefox::Options.new(args: ['--host=127.0.0.1'])
-        #   driver = Selenium::WebDriver.for :firefox, capabilities: options
+        #   driver = Selenium::WebDriver.for :firefox, options: options
         #
         # @param [Hash] opts the pre-defined options to create the Firefox::Options with
         # @option opts [String] :binary Path to the Firefox executable to use
@@ -56,12 +57,17 @@ module Selenium
         #
 
         def initialize(log_level: nil, **opts)
-          @debugger_address = opts.delete(:debugger_address)
+          @debugger_address = opts.delete(:debugger_address) { true }
+          opts[:accept_insecure_certs] = true unless opts.key?(:accept_insecure_certs)
 
           super(**opts)
 
           @options[:args] ||= []
           @options[:prefs] ||= {}
+          # Firefox 129 onwards the CDP protocol will not be enabled by default. Setting this preference will enable it.
+          # https://fxdx.dev/deprecating-cdp-support-in-firefox-embracing-the-future-with-webdriver-bidi/.
+          @options[:prefs]['remote.active-protocols'] = 3
+          @options[:env] ||= {}
           @options[:log] ||= {level: log_level} if log_level
 
           process_profile(@options.delete(:profile))
@@ -96,18 +102,6 @@ module Selenium
           @options[:prefs][name] = value
         end
 
-        #
-        # Run Firefox in headless mode.
-        #
-        # @example Enable headless mode
-        #   options = Selenium::WebDriver::Firefox::Options.new
-        #   options.headless!
-        #
-
-        def headless!
-          add_argument '-headless'
-        end
-
         #
         # Sets Firefox profile.
         #
@@ -175,7 +169,7 @@ module Selenium
         end
 
         def camelize?(key)
-          key != "prefs"
+          key != 'prefs'
         end
       end # Options
     end # Firefox

data/lib/selenium/webdriver/firefox/profile.rb

@@ -24,17 +24,23 @@ module Selenium
         include ProfileHelper
 
         VALID_PREFERENCE_TYPES = [TrueClass, FalseClass, Integer, Float, String].freeze
+        WEBDRIVER_PREFS = {
+          port: 'webdriver_firefox_port',
+          log_file: 'webdriver.log.file'
+        }.freeze
 
         DEFAULT_PREFERENCES = {
-          "browser.newtabpage.enabled" => false,
-          "browser.startup.homepage" => "about:blank",
-          "browser.usedOnWindows10.introURL" => "about:blank",
-          "network.captive-portal-service.enabled" => false,
-          "security.csp.enable" => false
+          'browser.newtabpage.enabled' => false,
+          'browser.startup.homepage' => 'about:blank',
+          'browser.usedOnWindows10.introURL' => 'about:blank',
+          'network.captive-portal-service.enabled' => false,
+          'security.csp.enable' => false
         }.freeze
 
-        attr_reader   :name, :log_file
-        attr_writer   :secure_ssl, :load_no_focus_lib
+        LOCK_FILES = %w[.parentlock parent.lock lock].freeze
+
+        attr_reader :name, :log_file
+        attr_writer :secure_ssl, :load_no_focus_lib
 
         class << self
           def ini
@@ -96,7 +102,7 @@ module Selenium
             raise TypeError, "expected one of #{VALID_PREFERENCE_TYPES.inspect}, got #{value.inspect}:#{value.class}"
           end
 
-          if value.is_a?(String) && stringified?(value)
+          if value.is_a?(String) && Util.stringified?(value)
             raise ArgumentError, "preference values must be plain strings: #{key.inspect} => #{value.inspect}"
           end
 
@@ -143,7 +149,7 @@ module Selenium
           end
         end
 
-        alias_method :as_json, :encoded
+        alias as_json encoded
 
         private
 
@@ -160,7 +166,7 @@ module Selenium
           destination = File.join(directory, 'extensions')
 
           @extensions.each do |name, extension|
-            WebDriver.logger.debug({extenstion: name}.inspect)
+            WebDriver.logger.debug({extension: name}.inspect, id: :firefox_profile)
             extension.write_to(destination)
           end
         end
@@ -176,7 +182,7 @@ module Selenium
         end
 
         def delete_lock_files(directory)
-          %w[.parentlock parent.lock].each do |name|
+          LOCK_FILES.each do |name|
             FileUtils.rm_f File.join(directory, name)
           end
         end
@@ -204,8 +210,8 @@ module Selenium
           File.read(path).split("\n").each do |line|
             next unless line =~ /user_pref\("([^"]+)"\s*,\s*(.+?)\);/
 
-            key = Regexp.last_match(1).strip
-            value = Regexp.last_match(2).strip
+            key = Regexp.last_match(1)&.strip
+            value = Regexp.last_match(2)&.strip
 
             # wrap the value in an array to make it a valid JSON string.
             prefs[key] = JSON.parse("[#{value}]").first
@@ -221,11 +227,9 @@ module Selenium
             end
           end
         end
+      end
 
-        def stringified?(str)
-          /^".*"$/.match?(str)
-        end
-      end # Profile
+      # Profile
     end # Firefox
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/firefox/profiles_ini.rb

@@ -52,7 +52,7 @@ module Selenium
             when /^\[Profile/
               name, path = nil if path_for(name, is_relative, path)
             when /^Name=(.+)$/
-              name = Regexp.last_match(1).strip
+              name = Regexp.last_match(1)&.strip
             when /^IsRelative=(.+)$/
               is_relative = Regexp.last_match(1).strip == '1'
             when /^Path=(.+)$/

data/lib/selenium/webdriver/firefox/service.rb

@@ -23,25 +23,7 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT = 4444
         EXECUTABLE = 'geckodriver'
-        MISSING_TEXT = <<~ERROR
-          Unable to find Mozilla geckodriver. Please download the server from
-          https://github.com/mozilla/geckodriver/releases and place it somewhere on your PATH.
-          More info at https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver.
-        ERROR
         SHUTDOWN_SUPPORTED = false
-
-        private
-
-        # NOTE: This processing is deprecated
-        def extract_service_args(driver_opts)
-          driver_args = super
-          driver_opts = driver_opts.dup
-          driver_args << "--binary=#{driver_opts[:binary]}" if driver_opts.key?(:binary)
-          driver_args << "--log=#{driver_opts[:log]}" if driver_opts.key?(:log)
-          driver_args << "--marionette-port=#{driver_opts[:marionette_port]}" if driver_opts.key?(:marionette_port)
-          driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key?(:host)
-          driver_args
-        end
       end # Service
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox/util.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# 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
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Firefox
+      # @api private
+      module Util
+        module_function
+
+        def app_data_path
+          case Platform.os
+          when :windows
+            "#{ENV.fetch('APPDATA')}\\Mozilla\\Firefox"
+          when :macosx
+            "#{Platform.home}/Library/Application Support/Firefox"
+          when :unix, :linux
+            "#{Platform.home}/.mozilla/firefox"
+          else
+            raise "Unknown os: #{Platform.os}"
+          end
+        end
+
+        def stringified?(str)
+          str =~ /^".*"$/
+        end
+      end # Util
+    end # Firefox
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/firefox.rb

@@ -24,6 +24,7 @@ require 'rexml/document'
 module Selenium
   module WebDriver
     module Firefox
+      autoload :Util, 'selenium/webdriver/firefox/util'
       autoload :Extension, 'selenium/webdriver/firefox/extension'
       autoload :ProfilesIni, 'selenium/webdriver/firefox/profiles_ini'
       autoload :Profile, 'selenium/webdriver/firefox/profile'
@@ -41,20 +42,6 @@ module Selenium
       # until WebDriver Bidi is available.
       DEVTOOLS_VERSION = 85
 
-      def self.driver_path=(path)
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path=',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path=',
-                                   id: :driver_path
-        Selenium::WebDriver::Firefox::Service.driver_path = path
-      end
-
-      def self.driver_path
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path',
-                                   id: :driver_path
-        Selenium::WebDriver::Firefox::Service.driver_path
-      end
-
       def self.path=(path)
         Platform.assert_executable path
         @path = path

data/lib/selenium/webdriver/ie/driver.rb

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module IE
-
       #
       # Driver implementation for Internet Explorer supporting
       # both OSS and W3C dialects of JSON wire protocol.
@@ -30,6 +29,13 @@ module Selenium
       class Driver < WebDriver::Driver
         EXTENSIONS = [DriverExtensions::HasWebStorage].freeze
 
+        include LocalDriver
+
+        def initialize(options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(options, service, url)
+          super(caps: caps, url: url, **opts)
+        end
+
         def browser
           :internet_explorer
         end

data/lib/selenium/webdriver/ie/features.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# 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
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module IE
+      module Features
+        def command_list
+          self.class::COMMANDS
+        end
+
+        def commands(command)
+          command_list[command]
+        end
+      end # Bridge
+    end # Ie
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/ie/options.rb

@@ -41,7 +41,9 @@ module Selenium
           use_per_process_proxy: 'ie.usePerProcessProxy',
           use_legacy_file_upload_dialog_handling: 'ie.useLegacyFileUploadDialogHandling',
           attach_to_edge_chrome: 'ie.edgechromium',
-          edge_executable_path: 'ie.edgepath'
+          edge_executable_path: 'ie.edgepath',
+          ignore_process_match: 'ie.ignoreprocessmatch',
+          silent: 'silent'
         }.freeze
         BROWSER = 'internet explorer'
 
@@ -52,12 +54,12 @@ module Selenium
         #
         # @example
         #   options = Selenium::WebDriver::IE::Options.new(args: ['--host=127.0.0.1'])
-        #   driver = Selenium::WebDriver.for(:ie, capabilities: options)
+        #   driver = Selenium::WebDriver.for(:ie, options: options)
         #
         # @example
         #   options = Selenium::WebDriver::IE::Options.new
         #   options.element_scroll_behavior = Selenium::WebDriver::IE::Options::SCROLL_BOTTOM
-        #   driver = Selenium::WebDriver.for(:ie, capabilities: options)
+        #   driver = Selenium::WebDriver.for(:ie, options: options)
         #
         # @param [Hash] opts the pre-defined options
         # @option opts [Array<String>] args
@@ -80,7 +82,7 @@ module Selenium
 
         def initialize(**opts)
           @args = (opts.delete(:args) || []).to_set
-          super(**opts)
+          super
 
           @options[:native_events] = true if @options[:native_events].nil?
         end

data/lib/selenium/webdriver/ie/service.rb

@@ -23,29 +23,7 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT = 5555
         EXECUTABLE = 'IEDriverServer'
-        MISSING_TEXT = <<~ERROR
-          Unable to find IEDriverServer. Please download the server from
-          https://www.selenium.dev/downloads/ and place it somewhere on your PATH.
-          More info at https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver.
-        ERROR
         SHUTDOWN_SUPPORTED = true
-
-        private
-
-        # NOTE: This processing is deprecated
-        def extract_service_args(driver_opts)
-          driver_args = super
-          driver_opts = driver_opts.dup
-          driver_args << "--log-level=#{driver_opts[:log_level].to_s.upcase}" if driver_opts.key?(:log_level)
-          driver_args << "--log-file=#{driver_opts[:log_file]}" if driver_opts.key?(:log_file)
-          if driver_opts.key?(:implementation)
-            driver_args << "--implementation=#{driver_opts[:implementation].to_s.upcase}"
-          end
-          driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key?(:host)
-          driver_args << "--extract_path=#{driver_opts[:extract_path]}" if driver_opts.key?(:extract_path)
-          driver_args << "--silent" if driver_opts[:silent] == true
-          driver_args
-        end
       end # Server
     end # IE
   end # WebDriver

data/lib/selenium/webdriver/ie.rb

@@ -20,23 +20,10 @@
 module Selenium
   module WebDriver
     module IE
-      autoload :Driver, 'selenium/webdriver/ie/driver'
-      autoload :Options, 'selenium/webdriver/ie/options'
-      autoload :Service, 'selenium/webdriver/ie/service'
-
-      def self.driver_path=(path)
-        WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path=',
-                                   'Selenium::WebDriver::IE::Service#driver_path=',
-                                   id: :driver_path
-        Selenium::WebDriver::IE::Service.driver_path = path
-      end
-
-      def self.driver_path
-        WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path',
-                                   'Selenium::WebDriver::IE::Service#driver_path',
-                                   id: :driver_path
-        Selenium::WebDriver::IE::Service.driver_path
-      end
+      autoload :Features, 'selenium/webdriver/ie/features'
+      autoload :Driver,   'selenium/webdriver/ie/driver'
+      autoload :Options,  'selenium/webdriver/ie/options'
+      autoload :Service,  'selenium/webdriver/ie/service'
     end # IE
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/remote/bidi_bridge.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# 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
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Remote
+      class BiDiBridge < Bridge
+        attr_reader :bidi
+
+        def create_session(capabilities)
+          super
+          socket_url = @capabilities[:web_socket_url]
+          @bidi = Selenium::WebDriver::BiDi.new(url: socket_url)
+        end
+
+        def quit
+          super
+        ensure
+          bidi.close
+        end
+
+        def close
+          execute(:close_window).tap { |handles| bidi.close if handles.empty? }
+        end
+      end # BiDiBridge
+    end # Remote
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/remote/{commands.rb → bridge/commands.rb}

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Remote
-
       #
       # https://w3c.github.io/webdriver/#endpoints
       # @api private
@@ -60,10 +59,6 @@ module Selenium
           fullscreen_window: [:post, 'session/:session_id/window/fullscreen'],
           minimize_window: [:post, 'session/:session_id/window/minimize'],
           maximize_window: [:post, 'session/:session_id/window/maximize'],
-          set_window_size: [:post, 'session/:session_id/window/size'],
-          get_window_size: [:get, 'session/:session_id/window/size'],
-          set_window_position: [:post, 'session/:session_id/window/position'],
-          get_window_position: [:get, 'session/:session_id/window/position'],
           set_window_rect: [:post, 'session/:session_id/window/rect'],
           get_window_rect: [:get, 'session/:session_id/window/rect'],
           switch_to_frame: [:post, 'session/:session_id/frame'],
@@ -130,7 +125,6 @@ module Selenium
           #
 
           element_click: [:post, 'session/:session_id/element/:id/click'],
-          element_tap: [:post, 'session/:session_id/element/:id/tap'],
           element_clear: [:post, 'session/:session_id/element/:id/clear'],
           element_send_keys: [:post, 'session/:session_id/element/:id/value'],
 
@@ -151,12 +145,31 @@ module Selenium
           take_element_screenshot: [:get, 'session/:session_id/element/:id/screenshot'],
 
           #
-          # server extensions
+          # virtual-authenticator
           #
 
-          upload_file: [:post, 'session/:session_id/se/file']
-        }.freeze
+          add_virtual_authenticator: [:post, 'session/:session_id/webauthn/authenticator'],
+          remove_virtual_authenticator: [:delete, 'session/:session_id/webauthn/authenticator/:authenticatorId'],
+          add_credential: [:post, 'session/:session_id/webauthn/authenticator/:authenticatorId/credential'],
+          get_credentials: [:get, 'session/:session_id/webauthn/authenticator/:authenticatorId/credentials'],
+          remove_credential: [:delete,
+                              'session/:session_id/webauthn/authenticator/:authenticatorId/credentials/:credentialId'],
+          remove_all_credentials: [:delete, 'session/:session_id/webauthn/authenticator/:authenticatorId/credentials'],
+          set_user_verified: [:post, 'session/:session_id/webauthn/authenticator/:authenticatorId/uv'],
+
+          #
+          # federated-credential management
+          #
 
+          get_fedcm_title: [:get, 'session/:session_id/fedcm/gettitle'],
+          get_fedcm_dialog_type: [:get, 'session/:session_id/fedcm/getdialogtype'],
+          get_fedcm_account_list: [:get, 'session/:session_id/fedcm/accountlist'],
+          click_fedcm_dialog_button: [:post, 'session/:session_id/fedcm/clickdialogbutton'],
+          cancel_fedcm_dialog: [:post, 'session/:session_id/fedcm/canceldialog'],
+          select_fedcm_account: [:post, 'session/:session_id/fedcm/selectaccount'],
+          set_fedcm_delay: [:post, 'session/:session_id/fedcm/setdelayenabled'],
+          reset_fedcm_cooldown: [:post, 'session/:session_id/fedcm/resetcooldown']
+        }.freeze
       end # Bridge
     end # Remote
   end # WebDriver

data/lib/selenium/webdriver/remote/bridge/locator_converter.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# 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
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Remote
+      class Bridge
+        class LocatorConverter
+          ESCAPE_CSS_REGEXP = /(['"\\#.:;,!?+<>=~*^$|%&@`{}\-\[\]()])/
+          UNICODE_CODE_POINT = 30
+
+          #
+          # Converts a locator to a specification compatible one.
+          # @param [String, Symbol] how
+          # @param [String] what
+          #
+
+          def convert(how, what)
+            how = SearchContext.finders[how.to_sym] || how
+
+            case how
+            when 'class name'
+              how = 'css selector'
+              what = ".#{escape_css(what.to_s)}"
+            when 'id'
+              how = 'css selector'
+              what = "##{escape_css(what.to_s)}"
+            when 'name'
+              how = 'css selector'
+              what = "*[name='#{escape_css(what.to_s)}']"
+            end
+
+            if what.is_a?(Hash)
+              what = what.each_with_object({}) do |(h, w), hash|
+                h, w = convert(h.to_s, w)
+                hash[h] = w
+              end
+            end
+
+            [how, what]
+          end
+
+          private
+
+          #
+          # Escapes invalid characters in CSS selector.
+          # @see https://mathiasbynens.be/notes/css-escapes
+          #
+
+          def escape_css(string)
+            string = string.gsub(ESCAPE_CSS_REGEXP) { |match| "\\#{match}" }
+            string = "\\#{UNICODE_CODE_POINT + Integer(string[0])} #{string[1..]}" if string[0]&.match?(/[[:digit:]]/)
+
+            string
+          end
+        end # LocatorConverter
+      end # Bridge
+    end # Remote
+  end # WebDriver
+end # Selenium