selenium-webdriver 4.6.1 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e5a3a63437323859cfcd9e2c2de24eb03db07baf71783ce64b720ea50b51517
-  data.tar.gz: ac97d032d52743c7a514dfd027d54696361ee9a98253600de092e3eb9c374b0a
+  metadata.gz: 0e30bfb529c5499329e02fe9a1e511b5bf0d358444f66a2afd45e98783e6b3d1
+  data.tar.gz: 10b0e20b9ad667fe4b872c7721926009065af0807da3f156f99d76ca42531e5b
 SHA512:
-  metadata.gz: b5959ce29798e1fed97317ed4839e2e520100f299451589ec5833a36e0d445a53b9d6deba43f99ba132d5f366c3dd9de6b481f6efde97e04bfd07f088895f2c8
-  data.tar.gz: 280a4a659cf212b04a6426acad25b701a9c4a8a34ac9a43fbe368fade7f05092da377fbdbb1d95a65787021ac2074ec7b826a3d1abd072576be48fabd574a2b3
+  metadata.gz: 967e493c8a785e817e9a117da8d642d1b9529ad13fa7be53dc7b3305cae9bf7031fc5497c84a0aeb9551aa8bf0d5325479362f8180c7e683c6a6a4e06fbb7b2f
+  data.tar.gz: a5d37e0f131b8004141b91c1b3a70412c16a65c7615bae1fee3f5a112bce45471211fe2507a356c1bcd8f01c43b49a44f3da31430fd01f0f964aaaf3ca757d9d

data/CHANGES

@@ -1,3 +1,17 @@
+4.7.0 (2022-12-01)
+=========================
+BiDi:
+  * Released selenium-devtools 0.108.0 (supports CDP v85, v106, v107, v108)
+  * Fix bug with socket stability
+
+Ruby:
+  * Remove dependency on ChildProcess gem in favor of native Process.spawn (#11251)
+  * Add support for Selenium Manager to work with IE Driver
+  * Improve error handling for Selenium Manager
+
+Safari:
+  * Fix bug preventing Safari Options from being used with Safari Technology Preview
+
 4.6.1 (2022-11-04)
 =========================
 Ruby:
@@ -15,7 +29,6 @@ Ruby:
   * Make sure selenium-manager is packed into gem
   * Fix platform list in #scroll_by guard
 
-
 4.5.0 (2022-09-28)
 =========================
 

data/lib/selenium/server.rb

@@ -17,7 +17,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'childprocess'
+require 'selenium/webdriver/common/child_process'
 require 'selenium/webdriver/common/socket_poller'
 require 'net/http'
 
@@ -237,7 +237,7 @@ module Selenium
 
       begin
         @process.poll_for_exit(5)
-      rescue ChildProcess::TimeoutError
+      rescue WebDriver::ChildProcess::TimeoutError
         @process.stop
       end
     rescue Errno::ECHILD
@@ -252,16 +252,13 @@ module Selenium
         properties = @additional_args.dup - @additional_args.delete_if { |arg| arg[/^-D/] }
         args = ['-jar', @jar, @role, '--port', @port.to_s]
         server_command = ['java'] + properties + args + @additional_args
-        cp = ChildProcess.build(*server_command)
+        cp = WebDriver::ChildProcess.build(*server_command)
         WebDriver.logger.debug("Executing Process #{server_command}")
 
-        io = cp.io
-
         if @log.is_a?(String)
-          @log_file = File.open(@log, 'w')
-          io.stdout = io.stderr = @log_file
+          cp.io = @log
         elsif @log
-          io.inherit!
+          cp.io = :out
         end
 
         cp.detach = @background

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

@@ -0,0 +1,126 @@
+# 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
+
+    #
+    # @api private
+    #
+
+    class ChildProcess
+      TimeoutError = Class.new(StandardError)
+
+      SIGTERM = 'TERM'
+      SIGKILL = 'KILL'
+
+      POLL_INTERVAL = 0.1
+
+      attr_accessor :detach
+      attr_writer :io
+
+      def self.build(*command)
+        new(*command)
+      end
+
+      def initialize(*command)
+        @command = command
+        @detach = false
+        @pid = nil
+        @status = nil
+      end
+
+      def io
+        @io ||= Platform.null_device
+      end
+
+      def start
+        options = {%i[out err] => io}
+        options[:pgroup] = true unless Platform.windows? # NOTE: this is a bug only in Windows 7
+
+        WebDriver.logger.debug("Starting process: #{@command} with #{options}")
+        @pid = Process.spawn(*@command, options)
+        WebDriver.logger.debug("  -> pid: #{@pid}")
+
+        Process.detach(@pid) if detach
+      end
+
+      def stop(timeout = 3)
+        return unless @pid
+        return if exited?
+
+        WebDriver.logger.debug("Sending TERM to process: #{@pid}")
+        terminate(@pid)
+        poll_for_exit(timeout)
+
+        WebDriver.logger.debug("  -> stopped #{@pid}")
+      rescue TimeoutError, Errno::EINVAL
+        WebDriver.logger.debug("    -> sending KILL to process: #{@pid}")
+        kill(@pid)
+        wait
+        WebDriver.logger.debug("      -> killed #{@pid}")
+      end
+
+      def alive?
+        @pid && !exited?
+      end
+
+      def exited?
+        return unless @pid
+
+        WebDriver.logger.debug("Checking if #{@pid} is exited:")
+        _, @status = Process.waitpid2(@pid, Process::WNOHANG | Process::WUNTRACED) if @status.nil?
+        return if @status.nil?
+
+        exit_code = @status.exitstatus || @status.termsig
+        WebDriver.logger.debug("  -> exit code is #{exit_code.inspect}")
+
+        !!exit_code
+      end
+
+      def poll_for_exit(timeout)
+        WebDriver.logger.debug("Polling #{timeout} seconds for exit of #{@pid}")
+
+        end_time = Time.now + timeout
+        sleep POLL_INTERVAL until exited? || Time.now > end_time
+
+        raise TimeoutError, "  ->  #{@pid} still alive after #{timeout} seconds" unless exited?
+      end
+
+      def wait
+        return if exited?
+
+        _, @status = Process.waitpid2(@pid)
+      end
+
+      private
+
+      def terminate(pid)
+        Process.kill(SIGTERM, pid)
+      end
+
+      def kill(pid)
+        Process.kill(SIGKILL, pid)
+      rescue Errno::ECHILD, Errno::ESRCH
+        # already dead
+      end
+
+    end # ChildProcess
+  end # WebDriver
+end # Selenium

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

@@ -78,6 +78,10 @@ module Selenium
         engine == :jruby
       end
 
+      def truffleruby?
+        engine == :truffleruby
+      end
+
       def ruby_version
         RUBY_VERSION
       end

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

@@ -17,6 +17,8 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'open3'
+
 module Selenium
   module WebDriver
     #
@@ -32,12 +34,12 @@ module Selenium
         # @return [String] the path to the correct driver.
         def driver_path(driver_name)
           @driver_path ||= begin
-            unless %w[chromedriver geckodriver msedgedriver].include?(driver_name)
+            unless %w[chromedriver geckodriver msedgedriver IEDriverServer.exe].include?(driver_name)
               msg = "Unable to locate driver with name: #{driver_name}"
               raise Error::WebDriverError, msg
             end
 
-            location = run("#{binary} --driver #{driver_name}").split("\t").last.strip
+            location = run("#{binary} --driver #{driver_name}")
             WebDriver.logger.debug("Driver found at #{location}")
             Platform.assert_executable location
 
@@ -72,13 +74,16 @@ module Selenium
           WebDriver.logger.debug("Executing Process #{command}")
 
           begin
-            result = `#{command}`
-            return result if result.match?(/^INFO\t/)
+            stdout, stderr, status = Open3.capture3(command)
           rescue StandardError => e
-            raise Error::WebDriverError, "Unsuccessful command executed: #{command}; #{e.message}"
+            raise Error::WebDriverError, "Unsuccessful command executed: #{command}", e.message
+          end
+
+          if status.exitstatus.positive?
+            raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{stdout}#{stderr}"
           end
 
-          raise Error::WebDriverError, "Unsuccessful command executed: #{command}"
+          stdout.gsub("INFO\t", '').strip
         end
       end
     end # SeleniumManager

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

@@ -102,7 +102,7 @@ module Selenium
         begin
           path ||= SeleniumManager.driver_path(self.class::EXECUTABLE)
         rescue Error::WebDriverError => e
-          WebDriver.logger.debug("Unable obtain driver using Selenium Manager; #{e.message}")
+          WebDriver.logger.debug("Unable obtain driver using Selenium Manager\n #{e.message}")
         end
 
         raise Error::WebDriverError, self.class::MISSING_TEXT unless path

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

@@ -79,12 +79,7 @@ module Selenium
       def build_process(*command)
         WebDriver.logger.debug("Executing Process #{command}")
         @process = ChildProcess.build(*command)
-        if WebDriver.logger.debug?
-          @process.io.stdout = @process.io.stderr = WebDriver.logger.io
-        elsif Platform.jruby?
-          # Apparently we need to read the output of drivers on JRuby.
-          @process.io.stdout = @process.io.stderr = File.new(Platform.null_device, 'w')
-        end
+        @process.io = WebDriver.logger.io if WebDriver.logger.debug?
 
         @process
       end
@@ -104,8 +99,6 @@ module Selenium
 
       def start_process
         @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
-        # NOTE: this is a bug only in Windows 7
-        @process.leader = true unless Platform.windows?
         @process.start
       end
 
@@ -113,7 +106,6 @@ module Selenium
         return if process_exited?
 
         @process.stop STOP_TIMEOUT
-        @process.io.stdout.close if Platform.jruby? && !WebDriver.logger.debug?
       end
 
       def stop_server

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

@@ -66,8 +66,7 @@ module Selenium
 
       def can_lock?
         @server = TCPServer.new(Platform.localhost, @port)
-        ChildProcess.close_on_exec @server
-
+        @server.close_on_exec = true
         true
       rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => e
         WebDriver.logger.debug("#{self}: #{e.message}")

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

@@ -22,6 +22,11 @@ require 'websocket'
 module Selenium
   module WebDriver
     class WebSocketConnection
+      CONNECTION_ERRORS = [
+        Errno::ECONNRESET, # connection is aborted (browser process was killed)
+        Errno::EPIPE # broken pipe (browser process was killed)
+      ].freeze
+
       RESPONSE_WAIT_TIMEOUT = 30
       RESPONSE_WAIT_INTERVAL = 0.1
 
@@ -90,6 +95,8 @@ module Selenium
               end
             end
           end
+        rescue *CONNECTION_ERRORS
+          Thread.stop
         end
       end
 
@@ -122,6 +129,8 @@ module Selenium
           Thread.current.report_on_exception = true
 
           yield params
+        rescue *CONNECTION_ERRORS
+          Thread.stop
         end
       end
 

data/lib/selenium/webdriver/common.rb

@@ -96,3 +96,4 @@ require 'selenium/webdriver/common/driver'
 require 'selenium/webdriver/common/element'
 require 'selenium/webdriver/common/shadow_root'
 require 'selenium/webdriver/common/websocket_connection'
+require 'selenium/webdriver/common/child_process'

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

@@ -26,7 +26,7 @@ module Selenium
         # @see https://developer.apple.com/documentation/webkit/about_webdriver_for_safari
         CAPABILITIES = {automatic_inspection: 'safari:automaticInspection',
                         automatic_profiling: 'safari:automaticProfiling'}.freeze
-        BROWSER = 'safari'
+        BROWSER = Selenium::WebDriver::Safari.technology_preview? ? "Safari Technology Preview" : 'safari'
 
         def add_option(name, value = nil)
           key = name.is_a?(Hash) ? name.keys.first : name

data/lib/selenium/webdriver/support/nightly_version_generator.rb

@@ -0,0 +1,60 @@
+# 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.
+
+require 'date'
+
+module Selenium
+  module WebDriver
+    module Support
+
+      #
+      # Updates version in `version.rb` file with nightly suffix:
+      #   - VERSION = '4.6.1'
+      #   + VERSION = '4.6.1.nightly.20221126'
+      #
+      # @api private
+      #
+
+      class NightlyVersionGenerator
+
+        REGEXP = /VERSION = ['"]([\d.]+)['"]/.freeze
+
+        def self.call(version_file, version_suffix)
+          version_suffix ||= Date.today.strftime('%Y%m%d')
+          version_file_contents = File.read(version_file)
+          version_file_contents.gsub!(REGEXP) do
+            old_version = Regexp.last_match(1)
+            new_version = [old_version, 'nightly', version_suffix].join('.')
+            puts("#{old_version} -> #{new_version}")
+
+            "VERSION = '#{new_version}'"
+          end
+
+          File.write(version_file, version_file_contents)
+        end
+
+      end # NightlyVersionGenerator
+    end # Support
+  end # WebDriver
+end # Selenium
+
+if __FILE__ == $PROGRAM_NAME
+  version_file, version_suffix = *ARGV
+  Selenium::WebDriver::Support::NightlyVersionGenerator.call(version_file, version_suffix)
+end

data/lib/selenium/webdriver/support/select.rb

@@ -86,7 +86,7 @@ module Selenium
         #
         #     <option value="foo">Bar</option>
         #
-        # When slecting by :value, selects all options that have a value matching the argument. That is, when given "foo" this
+        # When selecting by :value, selects all options that have a value matching the argument. That is, when given "foo" this
         # would select an option like:
         #
         #     <option value="foo">Bar</option>

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.6.1'
+    VERSION = '4.7.0'
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver.rb

@@ -17,7 +17,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'childprocess'
 require 'tmpdir'
 require 'fileutils'
 require 'date'

data/selenium-webdriver.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.homepage = 'https://selenium.dev'
   s.metadata = {
     'changelog_uri' => 'https://github.com/SeleniumHQ/selenium/blob/trunk/rb/CHANGES',
+    'github_repo' => 'ssh://github.com/SeleniumHQ/selenium',
     'source_code_uri' => 'https://github.com/SeleniumHQ/selenium/tree/trunk/rb',
     'rubygems_mfa_required' => 'true'
   }
@@ -48,13 +49,10 @@ Gem::Specification.new do |s|
   s.bindir = 'bin'
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'childprocess', ['>= 0.5', '< 5.0']
   s.add_runtime_dependency 'rexml', ['~> 3.2', '>= 3.2.5']
   s.add_runtime_dependency 'rubyzip', ['>= 1.2.2', '< 3.0']
   s.add_runtime_dependency 'websocket', ['~> 1.0']
 
-  # childprocess requires ffi on windows but doesn't declare it in its dependencies
-  s.add_development_dependency 'ffi'
   s.add_development_dependency 'pry', ['~> 0.14']
   s.add_development_dependency 'rack', ['~> 2.0']
   s.add_development_dependency 'rake'

metadata

@@ -1,37 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: selenium-webdriver
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Alex Rodionov
 - Titus Fortner
 - Thomas Walpole
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: childprocess
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -86,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: ffi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -293,6 +259,7 @@ files:
 - lib/selenium/webdriver/common.rb
 - lib/selenium/webdriver/common/action_builder.rb
 - lib/selenium/webdriver/common/alert.rb
+- lib/selenium/webdriver/common/child_process.rb
 - lib/selenium/webdriver/common/driver.rb
 - lib/selenium/webdriver/common/driver_extensions/downloads_files.rb
 - lib/selenium/webdriver/common/driver_extensions/full_page_screenshot.rb
@@ -415,7 +382,6 @@ files:
 - lib/selenium/webdriver/support.rb
 - lib/selenium/webdriver/support/abstract_event_listener.rb
 - lib/selenium/webdriver/support/block_event_listener.rb
-- lib/selenium/webdriver/support/cdp/domain.rb.erb
 - lib/selenium/webdriver/support/cdp_client_generator.rb
 - lib/selenium/webdriver/support/color.rb
 - lib/selenium/webdriver/support/escaper.rb
@@ -423,6 +389,7 @@ files:
 - lib/selenium/webdriver/support/guards.rb
 - lib/selenium/webdriver/support/guards/guard.rb
 - lib/selenium/webdriver/support/guards/guard_condition.rb
+- lib/selenium/webdriver/support/nightly_version_generator.rb
 - lib/selenium/webdriver/support/relative_locator.rb
 - lib/selenium/webdriver/support/select.rb
 - lib/selenium/webdriver/version.rb
@@ -432,9 +399,10 @@ licenses:
 - Apache-2.0
 metadata:
   changelog_uri: https://github.com/SeleniumHQ/selenium/blob/trunk/rb/CHANGES
+  github_repo: ssh://github.com/SeleniumHQ/selenium
   source_code_uri: https://github.com/SeleniumHQ/selenium/tree/trunk/rb
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -449,8 +417,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Selenium is a browser automation tool for automated testing of webapps and
   more

data/lib/selenium/webdriver/support/cdp/domain.rb.erb

@@ -1,63 +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.
-
-# This file is automatically generated. Any changes will be lost!
-module Selenium
-  module DevTools
-    module <%= version %>
-      class <%= domain[:domain] %>
-        <% if domain[:events] %>
-        EVENTS = {
-          <% domain[:events].each do |event| %>
-          <%= h.snake_case(event[:name]) %>: '<%= event[:name] %>',
-          <% end %>
-        }.freeze
-        <% end %>
-
-        def initialize(devtools)
-          @devtools = devtools
-        end
-
-        def on(event, &block)
-          event = EVENTS[event] if event.is_a?(Symbol)
-          @devtools.callbacks["<%= domain[:domain] %>.#{event}"] << block
-        end
-
-        <% domain[:commands].each do |command| %>
-        <% if command[:parameters] %>
-        def <%= h.snake_case(command[:name]) %>(<%= h.kwargs(command[:parameters]) %>)
-        <% else %>
-        def <%= h.snake_case(command[:name]) %>
-        <% end %>
-          <% if command[:parameters] %>
-          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>',
-            <% until command[:parameters].empty? %>
-              <% parameter = command[:parameters].shift %>
-                             <%= parameter[:name] %>: <%= h.snake_case(parameter[:name]) %><%= command[:parameters].empty? ? ')' : ',' %>
-            <% end %>
-          <% else %>
-          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>')
-          <% end %>
-        end
-
-        <% end %>
-      end # <%= domain[:domain] %>
-    end # <%= version %>
-  end # DevTools
-end # Selenium