selenium-webdriver 4.11.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55c2b164be56b90064957852c6b1f890f9cda063d5c0ef164752b7c67f6e40bb
-  data.tar.gz: 778d0c6d2450a3d178d709762c76b9ef2c24832131d4487f6c84b5789a32b1de
+  metadata.gz: 450f23e323427314096b116a5ab78eb32015b00dc5c56d237b2752b87d04c36e
+  data.tar.gz: a65e8ab198e7c2a0e67a553700a24647e6b2e9d84868a845f3b5074991efa1b2
 SHA512:
-  metadata.gz: 6777b04b259f2e7be27d7c2635f77b0e9006464f931e1e79a1e10f517474b71344534a8b02ba84445801581f4c50cb79901d15ef8e74133c08357625e5ad9de6
-  data.tar.gz: 5f1e3af40a4bbcc3e4e77407321d64b1e6920ca91fcf7605bce780d42138fd587bfc951563205d8cf6e4b63952e7e4e35dd52aba496fcb1e468e6a086c81c92d
+  metadata.gz: a6e1db6add8c3791a107fc670e82f54350afbd79a7fa238ab140d5881a59347b2dfe3f3512bfb16476bbf0b7c419088350a5b357067b1ef2c9efb5a5be2890c6
+  data.tar.gz: d96ba24461b579290ca5e02bbb27013557fba5bcba84fd9efa0c7b75e497b6f71b24641ae88bea49ffb1ad9721dedfe12fb7b2f1864a67c4c44761dc1c94f34e

data/CHANGES

@@ -1,3 +1,24 @@
+4.13.0 (2023-09-25)
+=========================
+Ruby:
+  * Fix bug preventing using performance logging with chromium
+  * Allow users to set Selenium Manager path by environment variable (#12752)
+  * Allow service to be started before the driver
+  * remove deprecated driver extensions for location and network connection
+
+BiDi:
+  * Released selenium-devtools 0.117.0 (supports CDP v85, v115, v116, v117)
+
+4.12.0 (2023-08-31)
+=========================
+Ruby:
+  * Fix bug preventing good error messages in Selenium Manager when stdout empty
+  * Fix bug with Firefox not loading net/http library by default (#12506)
+  * Remove support for using capabilities in local drivers
+
+BiDi:
+  * Released selenium-devtools 0.116.0 (supports CDP v85, v114, v115, v116)
+
 4.11.0 (2023-07-31)
 =========================
 Ruby:

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

@@ -30,8 +30,8 @@ module Selenium
       class Driver < Chromium::Driver
         include LocalDriver
 
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          caps, url = initialize_local_driver(capabilities, options, service, url)
+        def initialize(options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(options, service, url)
           super(caps: caps, url: url, **opts)
         end
 

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

@@ -24,6 +24,13 @@ module Selenium
         DEFAULT_PORT = 9515
         EXECUTABLE = 'chromedriver'
         SHUTDOWN_SUPPORTED = true
+
+        def log
+          return @log unless @log.is_a? String
+
+          @args += ['--log-path', @log]
+          @log = nil
+        end
       end # Service
     end # Chrome
   end # WebDriver

data/lib/selenium/webdriver/chrome.rb

@@ -17,8 +17,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'net/http'
-
 module Selenium
   module WebDriver
     module Chrome

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

@@ -33,7 +33,6 @@ module Selenium
                       DriverExtensions::HasNetworkInterception,
                       DriverExtensions::HasWebStorage,
                       DriverExtensions::HasLaunching,
-                      DriverExtensions::HasLocation,
                       DriverExtensions::HasPermissions,
                       DriverExtensions::DownloadsFiles,
                       DriverExtensions::HasDevTools,

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

@@ -47,7 +47,7 @@ module Selenium
         #
         # @example
         #   options = Selenium::WebDriver::Chrome::Options.new(args: ['start-maximized', 'user-data-dir=/tmp/temp_profile'])
-        #   driver = Selenium::WebDriver.for(:chrome, capabilities: options)
+        #   driver = Selenium::WebDriver.for(:chrome, options: options)
         #
         # @param [Profile] profile An instance of a Chrome::Profile Class
         # @param [Hash] opts the pre-defined options to create the Chrome::Options with

data/lib/selenium/webdriver/chromium.rb

@@ -17,8 +17,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'net/http'
-
 module Selenium
   module WebDriver
     module Chromium

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

@@ -33,8 +33,6 @@ module Selenium
       # correctly when using asynchronous.
       #
       # @param [Selenium::WebDriver::Remote::Bridge] bridge the bridge for the current driver instance.
-      # @param [Selenium::WebDriver::Interactions::PointerInput] deprecated_mouse PointerInput for the mouse.
-      # @param [Selenium::WebDriver::Interactions::KeyInput] deprecated_keyboard KeyInput for the keyboard.
       # @param [Boolean] deprecated_async Whether to perform the actions asynchronously per device.
       #   Defaults to false for backwards compatibility.
       # @param [Array<Selenium::WebDriver::Interactions::InputDevices>] devices list of valid sources of input.

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

@@ -318,18 +318,6 @@ module Selenium
         end
       end
 
-      def generate_capabilities(capabilities)
-        Array(capabilities).map { |cap|
-          if cap.is_a? Symbol
-            cap = WebDriver::Options.send(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)
-      end
-
       def service_url(service)
         @service_manager = service.launch
         @service_manager.uri

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

@@ -20,35 +20,26 @@
 module Selenium
   module WebDriver
     module LocalDriver
-      def initialize_local_driver(capabilities, options, service, url)
+      def initialize_local_driver(options, service, url)
         raise ArgumentError, "Can't initialize #{self.class} with :url" if url
 
         service ||= Service.send(browser)
-        caps = process_options(options, capabilities, service)
+        caps = process_options(options, service)
         url = service_url(service)
 
         [caps, url]
       end
 
-      def process_options(options, capabilities, service)
+      def process_options(options, service)
         default_options = Options.send(browser)
+        options ||= default_options
 
-        if options && capabilities
-          msg = "Don't use both :options and :capabilities when initializing #{self.class}, prefer :options"
-          raise ArgumentError, msg
-        elsif options && !options.is_a?(default_options.class)
+        unless options.is_a?(default_options.class)
           raise ArgumentError, ":options must be an instance of #{default_options.class}"
-        elsif capabilities
-          WebDriver.logger.deprecate("The :capabilities parameter for #{self.class}",
-                                     ":options argument with an instance of #{self.class}",
-                                     id: :capabilities)
-          service.executable_path ||= WebDriver::DriverFinder.path(capabilities, service.class)
-          generate_capabilities(capabilities)
-        else
-          options ||= default_options
-          service.executable_path ||= WebDriver::DriverFinder.path(options, service.class)
-          options.as_json
         end
+
+        service.executable_path ||= WebDriver::DriverFinder.path(options, service.class)
+        options.as_json
       end
     end
   end

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

@@ -75,31 +75,36 @@ module Selenium
         # @return [String] the path to the correct selenium manager
         def binary
           @binary ||= begin
-            path = File.expand_path(bin_path, __FILE__)
-            path << if Platform.windows?
-                      '/windows/selenium-manager.exe'
-                    elsif Platform.mac?
-                      '/macos/selenium-manager'
-                    elsif Platform.linux?
-                      '/linux/selenium-manager'
-                    end
-            location = File.expand_path(path, __FILE__)
-
-            begin
-              Platform.assert_file(location)
-              Platform.assert_executable(location)
-            rescue TypeError
-              raise Error::WebDriverError,
-                    "Unable to locate or obtain Selenium Manager binary; #{location} is not a valid file object"
-            rescue Error::WebDriverError => e
-              raise Error::WebDriverError, "Selenium Manager binary located, but #{e.message}"
-            end
-
-            WebDriver.logger.debug("Selenium Manager binary found at #{location}", id: :selenium_manager)
+            location = ENV.fetch('SE_MANAGER_PATH', begin
+              directory = File.expand_path(bin_path, __FILE__)
+              if Platform.windows?
+                "#{directory}/windows/selenium-manager.exe"
+              elsif Platform.mac?
+                "#{directory}/macos/selenium-manager"
+              elsif Platform.linux?
+                "#{directory}/linux/selenium-manager"
+              end
+            end)
+
+            validate_location(location)
             location
           end
         end
 
+        def validate_location(location)
+          begin
+            Platform.assert_file(location)
+            Platform.assert_executable(location)
+          rescue TypeError
+            raise Error::WebDriverError,
+                  "Unable to locate or obtain Selenium Manager binary; #{location} is not a valid file object"
+          rescue Error::WebDriverError => e
+            raise Error::WebDriverError, "Selenium Manager binary located, but #{e.message}"
+          end
+
+          WebDriver.logger.debug("Selenium Manager binary found at #{location}", id: :selenium_manager)
+        end
+
         def run(*command)
           command += %w[--output json]
           command << '--debug' if WebDriver.logger.debug?
@@ -108,22 +113,20 @@ module Selenium
 
           begin
             stdout, stderr, status = Open3.capture3(*command)
-            json_output = stdout.empty? ? nil : JSON.parse(stdout)
-            result = json_output['result']
           rescue StandardError => e
             raise Error::WebDriverError, "Unsuccessful command executed: #{command}; #{e.message}"
           end
 
-          (json_output&.fetch('logs') || []).each do |log|
+          json_output = stdout.empty? ? {} : JSON.parse(stdout)
+          (json_output['logs'] || []).each do |log|
             level = log['level'].casecmp('info').zero? ? 'debug' : log['level'].downcase
             WebDriver.logger.send(level, log['message'], id: :selenium_manager)
           end
 
-          if status.exitstatus.positive?
-            raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{result}#{stderr}"
-          end
+          result = json_output['result']
+          return result unless status.exitstatus.positive?
 
-          result
+          raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{result}#{stderr}"
         end
       end
     end # SeleniumManager

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

@@ -87,6 +87,10 @@ module Selenium
       end
 
       def launch
+        @executable_path ||= begin
+          default_options = WebDriver.const_get("#{self.class.name.split('::')[2]}::Options").new
+          DriverFinder.path(default_options, self.class)
+        end
         ServiceManager.new(self).tap(&:start)
       end
 

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

@@ -40,8 +40,8 @@ module Selenium
         @executable_path = config.executable_path
         @host = Platform.localhost
         @port = config.port
-        @extra_args = config.args
         @io = config.log
+        @extra_args = config.args
         @shutdown_supported = config.shutdown_supported
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1

data/lib/selenium/webdriver/common.rb

@@ -68,10 +68,8 @@ require 'selenium/webdriver/common/html5/local_storage'
 require 'selenium/webdriver/common/html5/session_storage'
 require 'selenium/webdriver/common/driver_extensions/has_web_storage'
 require 'selenium/webdriver/common/driver_extensions/downloads_files'
-require 'selenium/webdriver/common/driver_extensions/has_location'
 require 'selenium/webdriver/common/driver_extensions/has_session_id'
 require 'selenium/webdriver/common/driver_extensions/has_network_conditions'
-require 'selenium/webdriver/common/driver_extensions/has_network_connection'
 require 'selenium/webdriver/common/driver_extensions/has_network_interception'
 require 'selenium/webdriver/common/driver_extensions/has_apple_permissions'
 require 'selenium/webdriver/common/driver_extensions/has_permissions'

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

@@ -30,8 +30,8 @@ module Selenium
       class Driver < Chromium::Driver
         include LocalDriver
 
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          caps, url = initialize_local_driver(capabilities, options, service, url)
+        def initialize(options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(options, service, url)
           super(caps: caps, url: url, **opts)
         end
 

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

@@ -24,6 +24,13 @@ module Selenium
         DEFAULT_PORT = 9515
         EXECUTABLE = 'msedgedriver'
         SHUTDOWN_SUPPORTED = true
+
+        def log
+          return @log unless @log.is_a? String
+
+          @args += ['--log-path', @log]
+          @log = nil
+        end
       end # Service
     end # Edge
   end # WebDriver

data/lib/selenium/webdriver/edge.rb

@@ -17,8 +17,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'net/http'
-
 module Selenium
   module WebDriver
     module Edge

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

@@ -38,8 +38,8 @@ module Selenium
 
         include LocalDriver
 
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          caps, url = initialize_local_driver(capabilities, options, service, url)
+        def initialize(options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(options, service, url)
           super(caps: caps, url: url, **opts)
         end
 

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

@@ -45,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

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

@@ -31,8 +31,8 @@ module Selenium
 
         include LocalDriver
 
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          caps, url = initialize_local_driver(capabilities, options, service, url)
+        def initialize(options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(options, service, url)
           super(caps: caps, url: url, **opts)
         end
 

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

@@ -53,12 +53,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

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

@@ -60,6 +60,18 @@ module Selenium
           end
           options ? options.as_json : generate_capabilities(capabilities)
         end
+
+        def generate_capabilities(capabilities)
+          Array(capabilities).map { |cap|
+            if cap.is_a? Symbol
+              cap = WebDriver::Options.send(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)
+        end
       end # Driver
     end # Remote
   end # WebDriver

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

@@ -32,8 +32,8 @@ module Selenium
 
         include LocalDriver
 
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          caps, url = initialize_local_driver(capabilities, options, service, url)
+        def initialize(options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(options, service, url)
           super(caps: caps, url: url, **opts)
         end
 

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.11.0'
+    VERSION = '4.13.0'
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver.rb

@@ -23,6 +23,7 @@ require 'date'
 require 'json'
 require 'set'
 require 'uri'
+require 'net/http'
 
 require 'selenium/webdriver/atoms'
 require 'selenium/webdriver/common'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-webdriver
 version: !ruby/object:Gem::Version
-  version: 4.11.0
+  version: 4.13.0
 platform: ruby
 authors:
 - Alex Rodionov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -259,11 +259,9 @@ files:
 - lib/selenium/webdriver/common/driver_extensions/has_debugger.rb
 - lib/selenium/webdriver/common/driver_extensions/has_devtools.rb
 - lib/selenium/webdriver/common/driver_extensions/has_launching.rb
-- lib/selenium/webdriver/common/driver_extensions/has_location.rb
 - lib/selenium/webdriver/common/driver_extensions/has_log_events.rb
 - lib/selenium/webdriver/common/driver_extensions/has_logs.rb
 - lib/selenium/webdriver/common/driver_extensions/has_network_conditions.rb
-- lib/selenium/webdriver/common/driver_extensions/has_network_connection.rb
 - lib/selenium/webdriver/common/driver_extensions/has_network_interception.rb
 - lib/selenium/webdriver/common/driver_extensions/has_permissions.rb
 - lib/selenium/webdriver/common/driver_extensions/has_pinned_scripts.rb

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

@@ -1,36 +0,0 @@
-# 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.
-
-# TODO: Deprecated; Delete after 4.0 release
-module Selenium
-  module WebDriver
-    module DriverExtensions
-      module HasLocation
-        def location
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support getting location'
-        end
-
-        def location=(*)
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support setting location'
-        end
-        alias set_location location
-      end # HasLocation
-    end # DriverExtensions
-  end # WebDriver
-end # Selenium

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

@@ -1,37 +0,0 @@
-# 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.
-
-# TODO: Deprecated; Delete after 4.0 release
-module Selenium
-  module WebDriver
-    module DriverExtensions
-      module HasNetworkConnection
-        def network_connection_type
-          raise Error::UnsupportedOperationError,
-                'The W3C standard does not currently support getting network connection'
-        end
-
-        def network_connection_type=(*)
-          raise Error::UnsupportedOperationError,
-                'The W3C standard does not currently support setting network connection'
-        end
-      end # HasNetworkConnection
-    end # DriverExtensions
-  end # WebDriver
-end # Selenium