selenium-webdriver 3.141.0 → 3.142.3

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

@@ -1,3 +1,5 @@
+# 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
@@ -45,16 +47,21 @@ module Selenium
       private
 
       def lock
-        max_time = Time.now + @timeout
+        max_time = current_time + @timeout
 
-        sleep 0.1 until can_lock? || Time.now >= max_time
+        sleep 0.1 until can_lock? || current_time >= max_time
 
         return if did_lock?
+
         raise Error::WebDriverError, "unable to bind to locking port #{@port} within #{@timeout} seconds"
       end
 
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
       def release
-        @server && @server.close
+        @server&.close
       end
 
       def can_lock?

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

@@ -1,3 +1,5 @@
+# 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
@@ -54,12 +56,14 @@ module Selenium
 
       CONNECT_TIMEOUT = 5
 
-      NOT_CONNECTED_ERRORS = [Errno::ECONNREFUSED, Errno::ENOTCONN, SocketError]
-      NOT_CONNECTED_ERRORS << Errno::EPERM if Platform.cygwin?
+      NOT_CONNECTED_ERRORS = [Errno::ECONNREFUSED, Errno::ENOTCONN, SocketError].tap { |arr|
+        arr << Errno::EPERM if Platform.cygwin?
+      }.freeze
 
-      CONNECTED_ERRORS = [Errno::EISCONN]
-      CONNECTED_ERRORS << Errno::EINVAL if Platform.windows?
-      CONNECTED_ERRORS << Errno::EALREADY if Platform.wsl?
+      CONNECTED_ERRORS = [Errno::EISCONN].tap { |arr|
+        arr << Errno::EINVAL if Platform.windows?
+        arr << Errno::EALREADY if Platform.wsl?
+      }.freeze
 
       if Platform.jruby?
         # we use a plain TCPSocket here since JRuby has issues select()ing on a connecting socket
@@ -79,7 +83,7 @@ module Selenium
           begin
             sock.connect_nonblock sockaddr
           rescue Errno::EINPROGRESS
-            retry if IO.select(nil, [sock], nil, CONNECT_TIMEOUT)
+            retry if socket_writable?(sock) && conn_completed?(sock)
             raise Errno::ECONNREFUSED
           rescue *CONNECTED_ERRORS
             # yay!
@@ -88,30 +92,34 @@ module Selenium
           sock.close
           true
         rescue *NOT_CONNECTED_ERRORS
-          sock.close if sock
+          sock&.close
           WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
           false
         end
       end
 
+      def socket_writable?(sock)
+        IO.select(nil, [sock], nil, CONNECT_TIMEOUT)
+      end
+
+      def conn_completed?(sock)
+        sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_ERROR).int.zero?
+      end
+
       def with_timeout
-        max_time = time_now + @timeout
+        max_time = current_time + @timeout
 
-        (
+        until current_time > max_time
           return true if yield
-          wait
-        ) until time_now > max_time
 
-        false
-      end
+          sleep @interval
+        end
 
-      def wait
-        sleep @interval
+        false
       end
 
-      # for testability
-      def time_now
-        Time.now
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
     end # SocketPoller
   end # WebDriver

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

@@ -1,3 +1,5 @@
+# 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
@@ -55,10 +57,10 @@ module Selenium
       def window(id)
         if block_given?
           original = begin
-            @bridge.window_handle
-          rescue Error::NoSuchWindowError
-            nil
-          end
+                       @bridge.window_handle
+                     rescue Error::NoSuchWindowError
+                       nil
+                     end
 
           unless @bridge.window_handles.include? id
             raise Error::NoSuchWindowError, "The specified identifier '#{id}' is not found in the window handle list"

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

@@ -1,3 +1,5 @@
+# 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

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

@@ -1,3 +1,5 @@
+# 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
@@ -23,23 +25,20 @@ module Selenium
       #
 
       def initialize(mouse, keyboard, touch_screen)
+        WebDriver.logger.deprecate(self.class.name)
         super(mouse, keyboard)
         @devices[:touch_screen] = touch_screen
       end
 
       def scroll(*args)
-        unless [2, 3].include? args.size
-          raise ArgumentError, "wrong number of arguments, expected 2..3, got #{args.size}"
-        end
+        raise ArgumentError, "wrong number of arguments, expected 2..3, got #{args.size}" unless [2, 3].include? args.size
 
         @actions << [:touch_screen, :scroll, args]
         self
       end
 
       def flick(*args)
-        unless [2, 4].include? args.size
-          raise ArgumentError, "wrong number of arguments, expected 2 or 4, got #{args.size}"
-        end
+        raise ArgumentError, "wrong number of arguments, expected 2 or 4, got #{args.size}" unless [2, 4].include? args.size
 
         @actions << [:touch_screen, :flick, args]
         self

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

@@ -1,3 +1,5 @@
+# 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
@@ -82,7 +84,7 @@ module Selenium
 
           assert_element element
 
-          if (speed.is_a?(String) || speed.is_a?(Symbol)) && FLICK_SPEED.keys.include?(speed.to_sym)
+          if (speed.is_a?(String) || speed.is_a?(Symbol)) && FLICK_SPEED.key?(speed.to_sym)
             WebDriver.logger.deprecate "Passing #{speed.inspect} speed",
                                        "Integer or Selenium::WebDriver::TouchScreen::FLICK_SPEED[:#{speed}]"
             speed = FLICK_SPEED[speed.to_sym]
@@ -113,6 +115,7 @@ module Selenium
 
       def assert_element(element)
         return if element.is_a? Element
+
         raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
       end
     end # TouchScreen

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

@@ -1,3 +1,5 @@
+# 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
@@ -190,6 +192,7 @@ module Selenium
 
       def tick(*action_devices)
         return if @async
+
         @devices.each { |device| device.create_pause unless action_devices.include? device }
       end
 

data/lib/selenium/webdriver/common/{w3c_options.rb → w3c_manager.rb}

@@ -1,3 +1,5 @@
+# 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
@@ -17,7 +19,7 @@
 
 module Selenium
   module WebDriver
-    class W3COptions < Options
+    class W3CManager < Manager
 
       #
       # Get the cookie with the given name

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

@@ -1,3 +1,5 @@
+# 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
@@ -41,15 +43,15 @@ module Selenium
       #
       # Wait until the given block returns a true value.
       #
-      # @raise [Error::TimeOutError]
+      # @raise [Error::TimeoutError]
       # @return [Object] the result of the block
       #
 
       def until
-        end_time = Time.now + @timeout
+        end_time = current_time + @timeout
         last_error = nil
 
-        until Time.now > end_time
+        until current_time > end_time
           begin
             result = yield
             return result if result
@@ -63,12 +65,18 @@ module Selenium
         msg = if @message
                 @message.dup
               else
-                "timed out after #{@timeout} seconds"
+                +"timed out after #{@timeout} seconds"
               end
 
         msg << " (#{last_error.message})" if last_error
 
-        raise Error::TimeOutError, msg
+        raise Error::TimeoutError, msg
+      end
+
+      private
+
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
     end # Wait
   end # WebDriver

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

@@ -1,3 +1,5 @@
+# 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

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

@@ -1,3 +1,5 @@
+# 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
@@ -50,9 +52,7 @@ module Selenium
         def zip(path)
           with_tmp_zip do |zip|
             ::Find.find(path) do |file|
-              unless File.directory?(file)
-                add_zip_entry zip, file, file.sub("#{path}/", '')
-              end
+              add_zip_entry zip, file, file.sub("#{path}/", '') unless File.directory?(file)
             end
 
             zip.commit

data/lib/selenium/webdriver/edge.rb

@@ -1,3 +1,5 @@
+# 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
@@ -20,19 +22,23 @@ require 'net/http'
 require 'selenium/webdriver/edge/bridge'
 require 'selenium/webdriver/edge/driver'
 require 'selenium/webdriver/edge/options'
-require 'selenium/webdriver/edge/service'
 
 module Selenium
   module WebDriver
     module Edge
       def self.driver_path=(path)
-        Platform.assert_executable path
-        @driver_path = path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path=',
+                                   'Selenium::WebDriver::Edge::Service#driver_path='
+        Selenium::WebDriver::Edge::Service.driver_path = path
       end
 
-      def self.driver_path(warning = true)
-        @driver_path ||= nil
+      def self.driver_path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path',
+                                   'Selenium::WebDriver::Edge::Service#driver_path'
+        Selenium::WebDriver::Edge::Service.driver_path
       end
     end # Edge
   end # WebDriver
 end # Selenium
+
+require 'selenium/webdriver/edge/service'

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

@@ -1,3 +1,5 @@
+# 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

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

@@ -1,3 +1,5 @@
+# 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
@@ -28,18 +30,9 @@ module Selenium
         include DriverExtensions::TakesScreenshot
 
         def initialize(opts = {})
-          opts[:desired_capabilities] ||= Remote::W3C::Capabilities.edge
-
-          unless opts.key?(:url)
-            driver_path = opts.delete(:driver_path) || Edge.driver_path
-            driver_opts = opts.delete(:driver_opts) || {}
-            port = opts.delete(:port) || Service::DEFAULT_PORT
+          opts[:desired_capabilities] ||= Remote::Capabilities.edge
 
-            @service = Service.new(driver_path, port, driver_opts)
-            @service.host = 'localhost' if @service.host == '127.0.0.1'
-            @service.start
-            opts[:url] = @service.uri
-          end
+          opts[:url] ||= service_url(opts)
 
           listener = opts.delete(:listener)
 
@@ -64,7 +57,7 @@ module Selenium
         def quit
           super
         ensure
-          @service.stop if @service
+          @service&.stop
         end
 
       end # Driver

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

@@ -1,3 +1,5 @@
+# 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
@@ -55,6 +57,7 @@ module Selenium
 
         def add_extension_path(path)
           raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.directory?(path)
+
           @extension_paths << path
         end
 

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

@@ -1,3 +1,5 @@
+# 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
@@ -23,27 +25,21 @@ module Selenium
       #
 
       class Service < WebDriver::Service
-        DEFAULT_PORT = 17556
-        @executable = 'MicrosoftWebDriver'.freeze
-        @missing_text = <<-ERROR.gsub(/\n +| {2,}/, ' ').freeze
+        @default_port = 17556
+        @executable = 'MicrosoftWebDriver'
+        @missing_text = <<~ERROR
           Unable to find MicrosoftWebDriver. Please download the server from
           https://www.microsoft.com/en-us/download/details.aspx?id=48212 and place it somewhere on your PATH.
           More info at https://github.com/SeleniumHQ/selenium/wiki/MicrosoftWebDriver.
         ERROR
+        @shutdown_supported = true
 
         private
 
-        def start_process
-          @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
-          @process.start
-        end
-
-        def cannot_connect_error_text
-          "unable to connect to MicrosoftWebDriver #{@host}:#{@port}"
-        end
-
+        # Note: This processing is deprecated
         def extract_service_args(driver_opts)
           driver_args = super
+          driver_opts = driver_opts.dup
           driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key? :host
           driver_args << "--package=#{driver_opts[:package]}" if driver_opts.key? :package
           driver_args << "--silent" if driver_opts[:silent] == true

data/lib/selenium/webdriver/firefox.rb

@@ -1,3 +1,5 @@
+# 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
@@ -32,7 +34,6 @@ require 'selenium/webdriver/firefox/legacy/driver'
 require 'selenium/webdriver/firefox/marionette/bridge'
 require 'selenium/webdriver/firefox/marionette/driver'
 require 'selenium/webdriver/firefox/options'
-require 'selenium/webdriver/firefox/service'
 
 module Selenium
   module WebDriver
@@ -44,12 +45,15 @@ module Selenium
       DEFAULT_LOAD_NO_FOCUS_LIB = false
 
       def self.driver_path=(path)
-        Platform.assert_executable path
-        @driver_path = path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path=',
+                                   'Selenium::WebDriver::Firefox::Service#driver_path='
+        Selenium::WebDriver::Firefox::Service.driver_path = path
       end
 
       def self.driver_path
-        @driver_path ||= nil
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path',
+                                   'Selenium::WebDriver::Firefox::Service#driver_path'
+        Selenium::WebDriver::Firefox::Service.driver_path
       end
 
       def self.path=(path)
@@ -58,3 +62,5 @@ module Selenium
     end # Firefox
   end # WebDriver
 end # Selenium
+
+require 'selenium/webdriver/firefox/service'