selenium-webdriver 4.2.1 → 4.15.0

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

@@ -51,7 +51,7 @@ module Selenium
             Safari::Driver.new(**opts)
           when :firefox, :ff
             Firefox::Driver.new(**opts)
-          when :edge
+          when :edge, :microsoftedge, :msedge
             Edge::Driver.new(**opts)
           when :remote
             Remote::Driver.new(**opts)
@@ -69,8 +69,8 @@ module Selenium
       #
 
       def initialize(bridge: nil, listener: nil, **opts)
-        @service = nil
         @devtools = nil
+        @bidi = nil
         bridge ||= create_bridge(**opts)
         add_extensions(bridge.browser)
         @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
@@ -127,14 +127,6 @@ module Selenium
         bridge.action(**opts)
       end
 
-      def mouse
-        bridge.mouse
-      end
-
-      def keyboard
-        bridge.keyboard
-      end
-
       #
       # Opens the specified URL in the browser.
       #
@@ -180,8 +172,9 @@ module Selenium
       def quit
         bridge.quit
       ensure
-        @service&.stop
+        @service_manager&.stop
         @devtools&.close
+        @bidi&.close
       end
 
       #
@@ -189,7 +182,10 @@ module Selenium
       #
 
       def close
-        bridge.close
+        # If no top-level browsing contexts are open after calling close,
+        # it indicates that the WebDriver session is closed.
+        # If the WebDriver session is closed, the BiDi session also needs to be closed.
+        bridge.close.tap { |handles| @bidi&.close if handles&.empty? }
       end
 
       #
@@ -248,25 +244,34 @@ module Selenium
         bridge.execute_async_script(script, *args)
       end
 
+      #
+      # @return [VirtualAuthenticator]
+      # @see VirtualAuthenticator
+      #
+
+      def add_virtual_authenticator(options)
+        bridge.add_virtual_authenticator(options)
+      end
+
       #-------------------------------- sugar  --------------------------------
 
       #
       #   driver.first(id: 'foo')
       #
 
-      alias_method :first, :find_element
+      alias first find_element
 
       #
       #   driver.all(class: 'bar') #=> [#<WebDriver::Element:0x1011c3b88, ...]
       #
 
-      alias_method :all, :find_elements
+      alias all find_elements
 
       #
       #   driver.script('function() { ... };')
       #
 
-      alias_method :script, :execute_script
+      alias script execute_script
 
       # Get the first element matching the given selector. If given a
       # String or Symbol, it will be used as the id of the element.
@@ -307,72 +312,15 @@ module Selenium
 
       attr_reader :bridge
 
-      def create_bridge(**opts)
-        opts[:url] ||= service_url(opts)
-        caps = opts.delete(:capabilities)
-        # NOTE: This is deprecated
-        cap_array = caps.is_a?(Hash) ? [caps] : Array(caps)
-
-        desired_capabilities = opts.delete(:desired_capabilities)
-        if desired_capabilities
-          WebDriver.logger.deprecate(':desired_capabilities as a parameter for driver initialization',
-                                     ':capabilities with an Array value of capabilities/options if necessary',
-                                     id: :desired_capabilities)
-          desired_capabilities = Remote::Capabilities.new(desired_capabilities) if desired_capabilities.is_a?(Hash)
-          cap_array << desired_capabilities
-        end
-
-        options = opts.delete(:options)
-        if options
-          WebDriver.logger.deprecate(':options as a parameter for driver initialization',
-                                     ':capabilities with an Array of value capabilities/options if necessary',
-                                     id: :browser_options)
-          cap_array << options
+      def create_bridge(caps:, url:, http_client: nil)
+        Remote::Bridge.new(http_client: http_client, url: url).tap do |bridge|
+          bridge.create_session(caps)
         end
-
-        capabilities = generate_capabilities(cap_array)
-
-        bridge_opts = {http_client: opts.delete(:http_client), url: opts.delete(:url)}
-        raise ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
-
-        bridge = Remote::Bridge.new(**bridge_opts)
-
-        bridge.create_session(capabilities)
-        bridge
       end
 
-      def generate_capabilities(cap_array)
-        cap_array.map { |cap|
-          if cap.is_a? Symbol
-            cap = Remote::Capabilities.send(cap)
-          elsif cap.is_a? Hash
-            new_message = 'Capabilities instance initialized with the Hash, or build values with Options class'
-            WebDriver.logger.deprecate("passing a Hash value to :capabilities",
-                                       new_message,
-                                       id: :capabilities_hash)
-            cap = Remote::Capabilities.new(cap)
-          elsif !cap.respond_to? :as_json
-            msg = ":capabilities parameter only accepts objects responding to #as_json which #{cap.class} does not"
-            raise ArgumentError, msg
-          end
-          cap&.as_json
-        }.inject(:merge) || Remote::Capabilities.send(browser || :new)
-      end
-
-      def service_url(opts)
-        service_config = opts.delete(:service)
-        %i[driver_opts driver_path port].each do |key|
-          next unless opts.key? key
-
-          WebDriver.logger.deprecate(":#{key}", ':service with an instance of Selenium::WebDriver::Service',
-                                     id: "service_#{key}".to_sym)
-        end
-        service_config ||= Service.send(browser,
-                                        args: opts.delete(:driver_opts),
-                                        path: opts.delete(:driver_path),
-                                        port: opts.delete(:port))
-        @service = service_config.launch
-        @service.uri
+      def service_url(service)
+        @service_manager = service.launch
+        @service_manager.uri
       end
 
       def screenshot
@@ -382,11 +330,13 @@ module Selenium
       def add_extensions(browser)
         extensions = case browser
                      when :chrome, :msedge
-                       Chrome::Driver::EXTENSIONS
+                       Chromium::Driver::EXTENSIONS
                      when :firefox
                        Firefox::Driver::EXTENSIONS
                      when :safari, :safari_technology_preview
                        Safari::Driver::EXTENSIONS
+                     when :ie, :internet_explorer
+                       IE::Driver::EXTENSIONS
                      else
                        []
                      end

data/lib/selenium/webdriver/common/driver_extensions/downloads_files.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module DownloadsFiles
-
         #
         # Sets download path for Chromium.
         #
@@ -38,7 +37,6 @@ module Selenium
           }
           @bridge.send_command(params)
         end
-
       end # DownloadsFiles
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/full_page_screenshot.rb

@@ -36,7 +36,6 @@ module Selenium
         def full_screenshot
           @bridge.full_screenshot
         end
-
       end # FullPageScreenshot
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_addons.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasAddons
-
         #
         # Installs addon.
         #
@@ -43,7 +42,6 @@ module Selenium
         def uninstall_addon(id)
           @bridge.uninstall_addon(id)
         end
-
       end # HasAddons
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_apple_permissions.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasApplePermissions
-
         #
         # Returns permissions.
         #
@@ -44,7 +43,6 @@ module Selenium
         def permissions=(permissions)
           @bridge.permissions = permissions
         end
-
       end # HasPermissions
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_authentication.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasAuthentication
-
         #
         # Registers basic authentication handler which is automatically
         # used whenever browser gets an authentication required response.
@@ -82,7 +81,6 @@ module Selenium
             )
           end
         end
-
       end # HasAuthentication
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_bidi.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasBiDi
-
         #
         # Retrieves WebDriver BiDi connection.
         #
@@ -31,7 +30,6 @@ module Selenium
         def bidi
           @bidi ||= Selenium::WebDriver::BiDi.new(url: capabilities[:web_socket_url])
         end
-
       end # HasBiDi
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_casting.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasCasting
-
         #
         # What devices ("sinks") are available to be cast to.
         #

data/lib/selenium/webdriver/common/driver_extensions/has_cdp.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasCDP
-
         #
         # Returns network conditions.
         #
@@ -31,7 +30,6 @@ module Selenium
         def execute_cdp(cmd, **params)
           @bridge.send_command(cmd: cmd, params: params)
         end
-
       end # HasCDP
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_context.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasContext
-
         #
         # Sets the context that Selenium commands are running in using
         #         a `with` statement. The state of the context on the server is
@@ -37,7 +36,6 @@ module Selenium
         def context
           @bridge.context
         end
-
       end # HasContext
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_debugger.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasDebugger
-
         #
         # Attaches debugger to session.
         #
@@ -35,7 +34,6 @@ module Selenium
         def attach_debugger
           @bridge.attach_debugger
         end
-
       end # HasDebugger
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_devtools.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasDevTools
-
         #
         # Retrieves connection to DevTools.
         #
@@ -36,7 +35,6 @@ module Selenium
             Selenium::WebDriver::DevTools.new(url: devtools_url)
           end
         end
-
       end # HasDevTools
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_file_downloads.rb

@@ -0,0 +1,65 @@
+# 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 DriverExtensions
+      module HasFileDownloads
+        def downloadable_files
+          verify_enabled
+
+          @bridge.downloadable_files['names']
+        end
+
+        def download_file(file_name, target_directory)
+          verify_enabled
+
+          response = @bridge.download_file(file_name)
+          contents = response['contents']
+
+          File.open("#{file_name}.zip", 'wb') { |f| f << Base64.decode64(contents) }
+          target_directory += '/' unless target_directory.end_with?('/')
+          FileUtils.mkdir_p(target_directory)
+
+          begin
+            Zip::File.open("#{file_name}.zip") do |zip|
+              zip.each { |entry| zip.extract(entry, "#{target_directory}#{file_name}") }
+            end
+          ensure
+            FileUtils.rm_f("#{file_name}.zip")
+          end
+        end
+
+        def delete_downloadable_files
+          verify_enabled
+
+          @bridge.delete_downloadable_files
+        end
+
+        private
+
+        def verify_enabled
+          return if capabilities['se:downloadsEnabled']
+
+          raise Error::WebDriverError, 'You must enable downloads in order to work with downloadable files.'
+        end
+      end # HasFileDownloads
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_launching.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasLaunching
-
         #
         # Launches Chromium app specified by id.
         #
@@ -31,7 +30,6 @@ module Selenium
         def launch_app(id)
           @bridge.launch_app(id)
         end
-
       end # HasLaunching
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_log_events.rb

@@ -137,7 +137,6 @@ module Selenium
         def mutation_listener
           @mutation_listener ||= read_atom(:mutationListener)
         end
-
       end # HasLogEvents
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_network_conditions.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasNetworkConditions
-
         #
         # Returns network conditions.
         #
@@ -61,7 +60,6 @@ module Selenium
         def delete_network_conditions
           @bridge.delete_network_conditions
         end
-
       end # HasNetworkConditions
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_network_interception.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasNetworkInterception
-
         #
         # Intercepts requests coming from browser allowing
         # to either pass them through like proxy or provide
@@ -61,74 +60,8 @@ module Selenium
         #
 
         def intercept(&block)
-          devtools.network.set_cache_disabled(cache_disabled: true)
-          devtools.fetch.on(:request_paused) do |params|
-            id = params['requestId']
-            if params.key?('responseStatusCode') || params.key?('responseErrorReason')
-              intercept_response(id, params, &pending_response_requests.delete(id))
-            else
-              intercept_request(id, params, &block)
-            end
-          end
-          devtools.fetch.enable(patterns: [{requestStage: 'Request'}, {requestStage: 'Response'}])
-        end
-
-        private
-
-        def pending_response_requests
-          @pending_response_requests ||= {}
-        end
-
-        def intercept_request(id, params, &block)
-          original = DevTools::Request.from(id, params)
-          mutable = DevTools::Request.from(id, params)
-
-          block.call(mutable) do |&continue| # rubocop:disable Performance/RedundantBlockCall
-            pending_response_requests[id] = continue
-
-            if original == mutable
-              devtools.fetch.continue_request(request_id: id)
-            else
-              devtools.fetch.continue_request(
-                request_id: id,
-                url: mutable.url,
-                method: mutable.method,
-                post_data: mutable.post_data,
-                headers: mutable.headers.map do |k, v|
-                  {name: k, value: v}
-                end
-              )
-            end
-          end
-        end
-
-        def intercept_response(id, params)
-          return devtools.fetch.continue_request(request_id: id) unless block_given?
-
-          body = fetch_response_body(id)
-          original = DevTools::Response.from(id, body, params)
-          mutable = DevTools::Response.from(id, body, params)
-          yield mutable
-
-          if original == mutable
-            devtools.fetch.continue_request(request_id: id)
-          else
-            devtools.fetch.fulfill_request(
-              request_id: id,
-              body: (Base64.strict_encode64(mutable.body) if mutable.body),
-              response_code: mutable.code,
-              response_headers: mutable.headers.map do |k, v|
-                {name: k, value: v}
-              end
-            )
-          end
-        end
-
-        def fetch_response_body(id)
-          devtools.fetch.get_response_body(request_id: id).dig('result', 'body')
-        rescue Error::WebDriverError
-          # CDP fails to get body on certain responses (301) and raises:
-          # Can only get response body on requests captured after headers received.
+          @interceptor ||= DevTools::NetworkInterceptor.new(devtools)
+          @interceptor.intercept(&block)
         end
       end # HasNetworkInterception
     end # DriverExtensions

data/lib/selenium/webdriver/common/driver_extensions/has_permissions.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasPermissions
-
         #
         # Set one permission.
         #
@@ -44,7 +43,6 @@ module Selenium
             @bridge.set_permission(key, value)
           end
         end
-
       end # HasPermissions
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_pinned_scripts.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasPinnedScripts
-
         #
         # Returns the list of all pinned scripts.
         #
@@ -70,7 +69,6 @@ module Selenium
           devtools.page.remove_script_to_evaluate_on_new_document(identifier: script.devtools_identifier)
           pinned_scripts.delete(script)
         end
-
       end # HasPinnedScripts
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_finder.rb

@@ -0,0 +1,45 @@
+# 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
+    class DriverFinder
+      def self.path(options, klass)
+        path = klass.driver_path
+        path = path.call if path.is_a?(Proc)
+
+        path ||= begin
+          SeleniumManager.driver_path(options) unless options.is_a?(Remote::Capabilities)
+        rescue StandardError => e
+          raise Error::NoSuchDriverError, "Unable to obtain #{klass::EXECUTABLE} using Selenium Manager; #{e.message}"
+        end
+
+        begin
+          Platform.assert_executable(path)
+        rescue TypeError
+          raise Error::NoSuchDriverError, "Unable to locate or obtain #{klass::EXECUTABLE}"
+        rescue Error::WebDriverError => e
+          raise Error::NoSuchDriverError, "#{klass::EXECUTABLE} located, but: #{e.message}"
+        end
+
+        path
+      end
+    end
+  end
+end

data/lib/selenium/webdriver/common/element.rb

@@ -43,7 +43,7 @@ module Selenium
       def ==(other)
         other.is_a?(self.class) && ref == other.ref
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       def hash
         [@id, @bridge].hash
@@ -101,7 +101,7 @@ module Selenium
       # if it exists. If it does not, then the value of the attribute with the given name is returned.
       # If neither exists, null is returned.
       #
-      # The "style" attribute is converted as best can be to a text representation with a trailing semi-colon.
+      # The "style" attribute is converted as best can be to a text representation with a trailing semicolon.
       #
       # The following are deemed to be "boolean" attributes, and will return either "true" or "false":
       #
@@ -207,7 +207,7 @@ module Selenium
       def send_keys(*args)
         bridge.send_keys_to_element @id, Keys.encode(args)
       end
-      alias_method :send_key, :send_keys
+      alias send_key send_keys
 
       #
       # If this element is a text entry element, this will clear the value. Has no effect on other
@@ -275,7 +275,7 @@ module Selenium
       def css_value(prop)
         bridge.element_value_of_css_property @id, prop
       end
-      alias_method :style, :css_value
+      alias style css_value
 
       #
       # Get the location of this element.
@@ -333,18 +333,18 @@ module Selenium
       #   element.first(id: 'foo')
       #
 
-      alias_method :first, :find_element
+      alias first find_element
 
       #
       #   element.all(class: 'bar')
       #
 
-      alias_method :all, :find_elements
+      alias all find_elements
 
       #
       #   element['class'] or element[:class] #=> "someclass"
       #
-      alias_method :[], :attribute
+      alias [] attribute
 
       #
       # @api private