selenium-webdriver 4.5.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d753308296c6105d6bdbe84f0bbff8f61064fcf44c40694fbe9c4d8758ff7d21
-  data.tar.gz: 6b277eedd4f26e9baf17b95a7034b7940f4c41c041ba646edda4247c7edaf57c
+  metadata.gz: f1ae360596be57c29db02808a7dae16c36062801e7639e83b366a54cdba5e3b2
+  data.tar.gz: f31169f7cfec055abb7a2f3595eee8e453acf316651a829af5f254a0f824cf9e
 SHA512:
-  metadata.gz: 42dbe1ef868e3be3fddac2add30d0b8bf17a6ae2febff15a6e3d0ce79c3f46122d9e3616a1e1e8e370744e008c4c06ad531b382410753ab6daa3d147c66a8552
-  data.tar.gz: 8e841646f3a38364c55fb5020e0eb30a9076f3fb5ace99e42175f9f07d1634c59ad52dcf84d01530fbc43282d5e7b48fc9058edc905d0eac10cf98babb2ed029
+  metadata.gz: 675dad14a433939c81dabbb0276b1c5a97d95f0b1451ca48aa0e908c2cc0658f1d90e3970be4e3f62e65ff5eaef5cf391b5d646f50413ca46ea2f24de821fb5a
+  data.tar.gz: dd9d26b855e7b1f01f667d113181f6e7b35367ee74459b693a3c5872cc92a9e58f9d2d849de3aaff9738e3e77cb3f3117617219b4f76e2fda2f66bc75279ee8d

data/CHANGES

@@ -1,4 +1,120 @@
-4.5.0 (Unreleased)
+4.9.0 (2023-04-21)
+=========================
+Ruby:
+  * Fix devtools version fallback (#11869)
+  * Fix bug in selenium manager escaping back slashes in Windows (#11884)
+
+BiDi:
+  * Released selenium-devtools 0.112.0 (supports CDP v85, v110, v111, v112)
+
+4.8.6 (2023-03-29)
+=========================
+Ruby:
+  * Properly escape arguments passed to Selenium Manager
+
+4.8.5 (2023-03-28)
+=========================
+Ruby:
+  * Wrapping browser name in quotes when calling Selenium Manager
+
+4.8.4 (2023-03-28)
+=========================
+Ruby:
+  * Update the selenium-manager versions to fix an IE naming issue (#11828)
+
+4.8.3 (2023-03-26)
+=========================
+Ruby:
+  * Still need to use driver finder when using capabilities parameter
+  * Accommodate Driver Finder being sent something other than an Options instance
+
+4.8.2 (2023-03-24)
+=========================
+Ruby:
+  * Ruby driver finder (#11523)
+  * Using json output with Selenium Manager
+
+BiDi:
+  * Released selenium-devtools 0.111.0 (supports CDP v85, v109, v110, v111)
+
+4.8.1 (2023-02-17)
+=========================
+Ruby:
+  * Fix autoload of WebDriver::Remote::Bridge::COMMANDS
+  * Subclass is setting value before the superclass is setting it to nil
+  * Updating Selenium Manager binaries for 4.8.1 release
+
+BiDi:
+  * Released selenium-devtools 0.110.0 (supports CDP v85, v108, v109, v110)
+  * Close BiDi session on closing the last top-level browsing context
+  * Add filtering capability to LogInspector
+
+4.8.0 (2023-01-23)
+=========================
+Ruby:
+  * Allow updating instance variables on service classes
+  * Deprecate extract_service_args processing in service classes
+  * Fix bug preventing sending nil to #send_keys with Remote Driver
+  * Fix bug with IE specific methods not available to IE Driver
+  * Created Chromium superclass for Chrome and Edge
+  * Deprecated platform and version setters/getters in Capabilities class
+  * Revamped driver constructor logic
+  * Fix bug preventing using Safari Technology Preview when using SafariOptions
+  * Fix bug preventing more than one driver type to access Selenium Manager
+  * Defaults to using Options instead of Capabilities
+  * Make Options classes more strict for allowed arguments and types
+  * Removed previously deprecated actions class parameters
+  * Removed Location struct
+  * Add comment with name of large JS executions (#11038)
+  * update logger with link on how to use it (#11478)
+  * Deprecate #add_option for Option classes in favor of constructor and attr_accessor
+  * Deprecate all unrecognized capabilities for Options classes
+  * Deprecate support for :capabilities for local drivers
+  * Deprecate browser class methods for Capabilities
+  * Deprecate #headless! for Chrome and Firefox
+
+BiDi:
+  * Released selenium-devtools 0.109.0 (supports CDP v85, v107, v108, v109)
+  * Add LogInspector (#11368)
+  * Add Browsing context commands (#11446)
+
+4.7.1 (2022-12-02)
+=========================
+Ruby:
+  * Fix bug preventing selenium manager from using Internet Explorer
+
+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:
+  * fix bug preventing selenium-manager from being executable by default
+
+4.6.0 (2022-11-04)
+=========================
+BiDi:
+  * Released selenium-devtools 0.107.0 (supports CDP v85, v105, v106, v107)
+
+Ruby:
+  * firefox scroll by amount is only failing on mac
+  * add initial support for selenium manager
+  * Revert "[rb] do not allow Select class to work with disabled selects"
+  * Make sure selenium-manager is packed into gem
+  * Fix platform list in #scroll_by guard
+
+4.5.0 (2022-09-28)
 =========================
 
 BiDi:

data/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 Software Freedom Conservancy (SFC)
+   Copyright 2023 Software Freedom Conservancy (SFC)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/NOTICE

@@ -1,2 +1,2 @@
-Copyright 2011-2022 Software Freedom Conservancy
+Copyright 2011-2023 Software Freedom Conservancy
 Copyright 2004-2011 Selenium committers

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'
 
@@ -210,6 +210,7 @@ module Selenium
       begin
         Net::HTTP.get(@host, '/selenium-server/driver/?cmd=shutDownSeleniumServer', @port)
       rescue Errno::ECONNREFUSED
+        nil
       end
 
       stop_process if @process
@@ -237,7 +238,7 @@ module Selenium
 
       begin
         @process.poll_for_exit(5)
-      rescue ChildProcess::TimeoutError
+      rescue WebDriver::ChildProcess::TimeoutError
         @process.stop
       end
     rescue Errno::ECHILD
@@ -252,16 +253,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/atoms.rb

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Atoms
-
       private
 
       def read_atom(function)
@@ -28,10 +27,10 @@ module Selenium
       end
 
       def execute_atom(function_name, *arguments)
-        script = format("return (%<atom>s).apply(null, arguments)", atom: read_atom(function_name))
+        script = format("/* #{function_name} */return (%<atom>s).apply(null, arguments)",
+                        atom: read_atom(function_name))
         execute_script(script, *arguments)
       end
-
     end # Atoms
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/bidi/browsing_context.rb

@@ -0,0 +1,88 @@
+# 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_relative 'navigate_result'
+require_relative 'browsing_context_info'
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class BrowsingContext
+        attr_accessor :id
+
+        READINESS_STATE = {
+          none: 'none',
+          interactive: 'interactive',
+          complete: 'complete'
+        }.freeze
+
+        def initialize(driver:, browsing_context_id: nil, type: nil, reference_context: nil)
+          unless driver.capabilities.web_socket_url
+            raise Error::WebDriverError,
+                  'WebDriver instance must support BiDi protocol'
+          end
+
+          unless type.nil? || %i[window tab].include?(type)
+            raise ArgumentError,
+                  "Valid types are :window & :tab. Received: #{type.inspect}"
+          end
+
+          @bidi = driver.bidi
+          @id = browsing_context_id.nil? ? create(type, reference_context)['context'] : browsing_context_id
+        end
+
+        def navigate(url:, readiness_state: nil)
+          unless readiness_state.nil? || READINESS_STATE.key?(readiness_state)
+            raise ArgumentError,
+                  "Valid readiness states are :none, :interactive & :complete. Received: #{readiness_state.inspect}"
+          end
+
+          navigate_result = @bidi.send_cmd('browsingContext.navigate', context: @id, url: url,
+                                                                       wait: READINESS_STATE[readiness_state])
+
+          NavigateResult.new(
+            url: navigate_result['url'],
+            navigation_id: navigate_result['navigation']
+          )
+        end
+
+        def get_tree(max_depth: nil)
+          result = @bidi.send_cmd('browsingContext.getTree', root: @id, maxDepth: max_depth).dig('contexts', 0)
+
+          BrowsingContextInfo.new(
+            id: result['context'],
+            url: result['url'],
+            children: result['children'],
+            parent_context: result['parent']
+          )
+        end
+
+        def close
+          @bidi.send_cmd('browsingContext.close', context: @id)
+        end
+
+        private
+
+        def create(type, reference_context)
+          @bidi.send_cmd('browsingContext.create', type: type.to_s, referenceContext: reference_context)
+        end
+      end # BrowsingContext
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/browsing_context_info.rb

@@ -0,0 +1,35 @@
+# 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 BiDi
+      class BrowsingContextInfo
+        attr_accessor :id, :url, :children, :parent_browsing_context
+
+        def initialize(id:, url:, children:, parent_context:)
+          @id = id
+          @url = url
+          @children = children
+          @parent_browsing_context = parent_context
+        end
+      end # BrowsingContextInfo
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/base_log_entry.rb

@@ -0,0 +1,35 @@
+# 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 BiDi
+      class BaseLogEntry
+        attr_accessor :level, :text, :timestamp, :stack_trace
+
+        def initialize(level:, text:, timestamp:, stack_trace:)
+          @level = level
+          @text = text
+          @timestamp = timestamp
+          @stack_trace = stack_trace
+        end
+      end # BaseLogEntry
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/console_log_entry.rb

@@ -0,0 +1,35 @@
+# 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 BiDi
+      class ConsoleLogEntry < GenericLogEntry
+        attr_accessor :method, :realm, :args
+
+        def initialize(method:, realm:, args:, **opts)
+          super(**opts)
+          @method = method
+          @realm = realm
+          @args = args
+        end
+      end # ConsoleLogEntry
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/filter_by.rb

@@ -0,0 +1,40 @@
+# 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 BiDi
+      class FilterBy
+        attr_accessor :level
+
+        def initialize(level)
+          @level = level
+        end
+
+        def self.log_level(level = nil)
+          unless %w[debug error info warning].include?(level)
+            raise Error::WebDriverError,
+                  "Valid log levels are 'debug', 'error', 'info' and 'warning'. Received: #{level}"
+          end
+          FilterBy.new(level)
+        end
+      end # FilterBy
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/generic_log_entry.rb

@@ -0,0 +1,33 @@
+# 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 BiDi
+      class GenericLogEntry < BaseLogEntry
+        attr_accessor :type
+
+        def initialize(level:, text:, timestamp:, type:, stack_trace:)
+          super(level: level, text: text, timestamp: timestamp, stack_trace: stack_trace)
+          @type = type
+        end
+      end # GenericLogEntry
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log/javascript_log_entry.rb

@@ -0,0 +1,33 @@
+# 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 BiDi
+      class JavascriptLogEntry < GenericLogEntry
+        attr_accessor :type
+
+        def initialize(level:, text:, timestamp:, type:, stack_trace:)
+          super(level: level, text: text, timestamp: timestamp, type: type, stack_trace: stack_trace)
+          @type = 'javascript'
+        end
+      end # JavascriptLogEntry
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi/log_inspector.rb

@@ -0,0 +1,143 @@
+# 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!
+
+require_relative 'log/base_log_entry'
+require_relative 'log/generic_log_entry'
+require_relative 'log/console_log_entry'
+require_relative 'log/javascript_log_entry'
+require_relative 'log/filter_by'
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class LogInspector
+        EVENTS = {
+          entry_added: 'entryAdded'
+        }.freeze
+
+        LOG_LEVEL = {
+          DEBUG: 'debug',
+          ERROR: 'error',
+          INFO: 'info',
+          WARNING: 'warning'
+        }.freeze
+
+        def initialize(driver, browsing_context_ids = nil)
+          unless driver.capabilities.web_socket_url
+            raise Error::WebDriverError,
+                  'WebDriver instance must support BiDi protocol'
+          end
+
+          @bidi = driver.bidi
+          @bidi.session.subscribe('log.entryAdded', browsing_context_ids)
+        end
+
+        def on_console_entry(filter_by = nil, &block)
+          check_valid_filter(filter_by)
+
+          on_log do |params|
+            type = params['type']
+            console_log_events(params, filter_by, &block) if type.eql?('console')
+          end
+        end
+
+        def on_javascript_log(filter_by = nil, &block)
+          check_valid_filter(filter_by)
+
+          on_log do |params|
+            type = params['type']
+            javascript_log_events(params, filter_by, &block) if type.eql?('javascript')
+          end
+        end
+
+        def on_javascript_exception(&block)
+          on_log do |params|
+            type = params['type']
+            javascript_log_events(params, FilterBy.log_level('error'), &block) if type.eql?('javascript')
+          end
+        end
+
+        def on_log(filter_by = nil, &block)
+          unless filter_by.nil?
+            check_valid_filter(filter_by)
+
+            on(:entry_added) do |params|
+              yield(params) if params['level'] == filter_by.level
+            end
+            return
+          end
+
+          on(:entry_added, &block)
+        end
+
+        private
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @bidi.callbacks["log.#{event}"] << block
+        end
+
+        def check_valid_filter(filter_by)
+          return if filter_by.nil? || filter_by.instance_of?(FilterBy)
+
+          raise "Pass valid FilterBy object. Received: #{filter_by.inspect}"
+        end
+
+        def console_log_events(params, filter_by)
+          event = ConsoleLogEntry.new(
+            level: params['level'],
+            text: params['text'],
+            timestamp: params['timestamp'],
+            type: params['type'],
+            method: params['method'],
+            realm: params['realm'],
+            args: params['args'],
+            stack_trace: params['stackTrace']
+          )
+
+          unless filter_by.nil?
+            yield(event) if params['level'] == filter_by.level
+            return
+          end
+
+          yield(event)
+        end
+
+        def javascript_log_events(params, filter_by)
+          event = JavascriptLogEntry.new(
+            level: params['level'],
+            text: params['text'],
+            timestamp: params['timestamp'],
+            type: params['type'],
+            stack_trace: params['stackTrace']
+          )
+
+          unless filter_by.nil?
+            yield(event) if params['level'] == filter_by.level
+            return
+          end
+
+          yield(event)
+        end
+      end # LogInspector
+    end # Bidi
+  end # WebDriver
+end # Selenium