selenium-webdriver 4.5.0 → 4.14.0

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

data/lib/selenium/webdriver/bidi/navigate_result.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 NavigateResult
+        attr_accessor :url, :navigation_id
+
+        def initialize(url:, navigation_id:)
+          @url = url
+          @navigation_id = navigation_id
+        end
+      end # NavigateResult
+    end # BiDi
+  end # WebDriver
+end # Selenium

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

@@ -32,6 +32,19 @@ module Selenium
           Status.new(status['ready'], status['message'])
         end
 
+        def subscribe(events, browsing_contexts = nil)
+          events_list = Array(events)
+          browsing_contexts_list = browsing_contexts.nil? ? nil : Array(browsing_contexts)
+
+          @bidi.send_cmd('session.subscribe', events: events_list, contexts: browsing_contexts_list)
+        end
+
+        def unsubscribe(events, browsing_contexts = nil)
+          events_list = Array(events)
+          browsing_contexts_list = browsing_contexts.nil? ? nil : Array(browsing_contexts)
+
+          @bidi.send_cmd('session.unsubscribe', events: events_list, contexts: browsing_contexts_list)
+        end
       end # Session
     end # BiDi
   end # WebDriver

data/lib/selenium/webdriver/bidi.rb

@@ -21,6 +21,8 @@ module Selenium
   module WebDriver
     class BiDi
       autoload :Session, 'selenium/webdriver/bidi/session'
+      autoload :LogInspector, 'selenium/webdriver/bidi/log_inspector'
+      autoload :BrowsingContext, 'selenium/webdriver/bidi/browsing_context'
 
       def initialize(url:)
         @ws = WebSocketConnection.new(url: url)
@@ -35,7 +37,7 @@ module Selenium
       end
 
       def session
-        Session.new(self)
+        @session ||= Session.new(self)
       end
 
       def send_cmd(method, **params)
@@ -49,7 +51,6 @@ module Selenium
       def error_message(message)
         "#{message['error']}: #{message['message']}\n#{message['stacktrace']}"
       end
-
     end # BiDi
   end # WebDriver
 end # Selenium

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

@@ -17,32 +17,23 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chromium/driver'
+
 module Selenium
   module WebDriver
     module Chrome
-
       #
       # Driver implementation for Chrome.
       # @api private
       #
 
-      class Driver < WebDriver::Driver
-        EXTENSIONS = [DriverExtensions::HasCDP,
-                      DriverExtensions::HasBiDi,
-                      DriverExtensions::HasCasting,
-                      DriverExtensions::HasNetworkConditions,
-                      DriverExtensions::HasNetworkInterception,
-                      DriverExtensions::HasWebStorage,
-                      DriverExtensions::HasLaunching,
-                      DriverExtensions::HasLocation,
-                      DriverExtensions::HasPermissions,
-                      DriverExtensions::DownloadsFiles,
-                      DriverExtensions::HasDevTools,
-                      DriverExtensions::HasAuthentication,
-                      DriverExtensions::HasLogs,
-                      DriverExtensions::HasLogEvents,
-                      DriverExtensions::HasPinnedScripts,
-                      DriverExtensions::PrintsPage].freeze
+      class Driver < Chromium::Driver
+        include LocalDriver
+
+        def initialize(options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(options, service, url)
+          super(caps: caps, url: url, **opts)
+        end
 
         def browser
           :chrome
@@ -50,21 +41,9 @@ module Selenium
 
         private
 
-        def devtools_url
-          uri = URI(devtools_address)
-          response = Net::HTTP.get(uri.hostname, '/json/version', uri.port)
-
-          JSON.parse(response)['webSocketDebuggerUrl']
-        end
-
-        def devtools_version
-          Integer(capabilities.browser_version.split('.').first)
-        end
-
         def devtools_address
           "http://#{capabilities['goog:chromeOptions']['debuggerAddress']}"
         end
-
       end # Driver
     end # Chrome
   end # WebDriver

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

@@ -17,93 +17,26 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chromium/features'
+
 module Selenium
   module WebDriver
     module Chrome
       module Features
+        include WebDriver::Chromium::Features
 
         CHROME_COMMANDS = {
-          launch_app: [:post, 'session/:session_id/chromium/launch_app'],
           get_cast_sinks: [:get, 'session/:session_id/goog/cast/get_sinks'],
           set_cast_sink_to_use: [:post, 'session/:session_id/goog/cast/set_sink_to_use'],
           start_cast_tab_mirroring: [:post, 'session/:session_id/goog/cast/start_tab_mirroring'],
           start_cast_desktop_mirroring: [:post, 'session/:session_id/goog/cast/start_desktop_mirroring'],
           get_cast_issue_message: [:get, 'session/:session_id/goog/cast/get_issue_message'],
           stop_casting: [:post, 'session/:session_id/goog/cast/stop_casting'],
-          get_network_conditions: [:get, 'session/:session_id/chromium/network_conditions'],
-          set_network_conditions: [:post, 'session/:session_id/chromium/network_conditions'],
-          delete_network_conditions: [:delete, 'session/:session_id/chromium/network_conditions'],
-          set_permission: [:post, 'session/:session_id/permissions'],
-          send_command: [:post, 'session/:session_id/goog/cdp/execute'],
-          get_available_log_types: [:get, 'session/:session_id/se/log/types'],
-          get_log: [:post, 'session/:session_id/se/log']
+          send_command: [:post, 'session/:session_id/goog/cdp/execute']
         }.freeze
 
         def commands(command)
-          CHROME_COMMANDS[command] || self.class::COMMANDS[command]
-        end
-
-        def launch_app(id)
-          execute :launch_app, {}, {id: id}
-        end
-
-        def cast_sinks
-          execute :get_cast_sinks
-        end
-
-        def cast_sink_to_use=(name)
-          execute :set_cast_sink_to_use, {}, {sinkName: name}
-        end
-
-        def cast_issue_message
-          execute :cast_issue_message
-        end
-
-        def start_cast_tab_mirroring(name)
-          execute :start_cast_tab_mirroring, {}, {sinkName: name}
-        end
-
-        def start_cast_desktop_mirroring(name)
-          execute :start_cast_desktop_mirroring, {}, {sinkName: name}
-        end
-
-        def stop_casting(name)
-          execute :stop_casting, {}, {sinkName: name}
-        end
-
-        def set_permission(name, value)
-          execute :set_permission, {}, {descriptor: {name: name}, state: value}
-        end
-
-        def network_conditions
-          execute :get_network_conditions
-        end
-
-        def network_conditions=(conditions)
-          execute :set_network_conditions, {}, {network_conditions: conditions}
-        end
-
-        def delete_network_conditions
-          execute :delete_network_conditions
-        end
-
-        def send_command(command_params)
-          execute :send_command, {}, command_params
-        end
-
-        def available_log_types
-          types = execute :get_available_log_types
-          Array(types).map(&:to_sym)
-        end
-
-        def log(type)
-          data = execute :get_log, {}, {type: type.to_s}
-
-          Array(data).map do |l|
-            LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
-          rescue KeyError
-            next
-          end
+          CHROME_COMMANDS[command] || CHROMIUM_COMMANDS[command] || self.class::COMMANDS[command]
         end
       end # Bridge
     end # Chrome

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

@@ -17,258 +17,24 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chromium/options'
+
 module Selenium
   module WebDriver
     module Chrome
-      class Options < WebDriver::Options
-        attr_accessor :profile, :logging_prefs
-
+      class Options < Chromium::Options
         KEY = 'goog:chromeOptions'
         BROWSER = 'chrome'
 
-        # see: http://chromedriver.chromium.org/capabilities
-        CAPABILITIES = {args: 'args',
-                        binary: 'binary',
-                        local_state: 'localState',
-                        prefs: 'prefs',
-                        detach: 'detach',
-                        debugger_address: 'debuggerAddress',
-                        exclude_switches: 'excludeSwitches',
-                        minidump_path: 'minidumpPath',
-                        emulation: 'mobileEmulation',
-                        perf_logging_prefs: 'perfLoggingPrefs',
-                        window_types: 'windowTypes',
-                        android_package: 'androidPackage',
-                        android_activity: 'androidActivity',
-                        android_device_serial: 'androidDeviceSerial',
-                        android_use_running_app: 'androidUseRunningApp'}.freeze
-
-        # NOTE: special handling of 'extensions' to validate when set instead of when used
-        attr_reader :extensions
-
-        # Create a new Options instance.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Chrome::Options.new(args: ['start-maximized', 'user-data-dir=/tmp/temp_profile'])
-        #   driver = Selenium::WebDriver.for(:chrome, capabilities: options)
-        #
-        # @param [Profile] profile An instance of a Chrome::Profile Class
-        # @param [Hash] opts the pre-defined options to create the Chrome::Options with
-        # @option opts [Array] encoded_extensions List of extensions that do not need to be Base64 encoded
-        # @option opts [Array<String>] args List of command-line arguments to use when starting Chrome
-        # @option opts [String] binary Path to the Chrome executable to use
-        # @option opts [Hash] prefs A hash with each entry consisting of the name of the preference and its value
-        # @option opts [Array<String>] extensions A list of paths to (.crx) Chrome extensions to install on startup
-        # @option opts [Hash] options A hash for raw options
-        # @option opts [Hash] emulation A hash for raw emulation options
-        # @option opts [Hash] local_state A hash for the Local State file in the user data folder
-        # @option opts [Boolean] detach whether browser is closed when the driver is sent the quit command
-        # @option opts [String] debugger_address address of a Chrome debugger server to connect to
-        # @option opts [Array<String>] exclude_switches command line switches to exclude
-        # @option opts [String] minidump_path Directory to store Chrome minidumps (linux only)
-        # @option opts [Hash] perf_logging_prefs A hash for performance logging preferences
-        # @option opts [Array<String>] window_types A list of window types to appear in the list of window handles
-        #
-
-        def initialize(profile: nil, **opts)
-          super(**opts)
-
-          @profile = profile
-
-          @options = {args: [],
-                      prefs: {},
-                      emulation: {},
-                      extensions: [],
-                      local_state: {},
-                      exclude_switches: [],
-                      perf_logging_prefs: {},
-                      window_types: []}.merge(@options)
-
-          @logging_prefs = options.delete(:logging_prefs) || {}
-          @encoded_extensions = @options.delete(:encoded_extensions) || []
-          @extensions = []
-          @options.delete(:extensions).each { |ext| validate_extension(ext) }
-        end
-
-        #
-        # Add an extension by local path.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_extension('/path/to/extension.crx')
-        #
-        # @param [String] path The local path to the .crx file
-        #
-
-        def add_extension(path)
-          validate_extension(path)
-        end
-
-        #
-        # Add an extension by local path.
-        #
-        # @example
-        #   extensions = ['/path/to/extension.crx', '/path/to/other.crx']
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.extensions = extensions
-        #
-        # @param [Array<String>] extensions A list of paths to (.crx) Chrome extensions to install on startup
-        #
-
-        def extensions=(extensions)
-          extensions.each { |ext| validate_extension(ext) }
-        end
-
-        #
-        # Add an extension by Base64-encoded string.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_encoded_extension(encoded_string)
-        #
-        # @param [String] encoded The Base64-encoded string of the .crx file
-        #
-
-        def add_encoded_extension(encoded)
-          @encoded_extensions << encoded
-        end
-
-        #
-        # Add a command-line argument to use when starting Chrome.
-        #
-        # @example Start Chrome maximized
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_argument('start-maximized')
-        #
-        # @param [String] arg The command-line argument to add
-        #
-
-        def add_argument(arg)
-          @options[:args] << arg
-        end
-
-        #
-        # Add a preference that is only applied to the user profile in use.
-        #
-        # @example Set the default homepage
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_preference('homepage', 'http://www.seleniumhq.com/')
-        #
-        # @param [String] name Key of the preference
-        # @param [Boolean, String, Integer] value Value of the preference
-        #
-
-        def add_preference(name, value)
-          @options[:prefs][name] = value
-        end
-
-        #
-        # Run Chrome in headless mode.
-        #
-        # @example Enable headless mode
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.headless!
-        #
-
-        def headless!
-          add_argument '--headless'
-        end
-
-        #
-        # Add emulation device information
-        #
-        # see: http://chromedriver.chromium.org/mobile-emulation
-        #
-        # @example Start Chrome in mobile emulation mode by device name
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_emulation(device_name: 'iPhone 6')
-        #
-        # @example Start Chrome in mobile emulation mode by device metrics
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_emulation(device_metrics: {width: 400, height: 800, pixelRatio: 1, touch: true})
-        #
-        # @param [Hash] opts the pre-defined options for adding mobile emulation values
-        # @option opts [String] :device_name A valid device name from the Chrome DevTools Emulation panel
-        # @option opts [Hash] :device_metrics Hash containing width, height, pixelRatio, touch
-        # @option opts [String] :user_agent Full user agent
-        #
-
-        def add_emulation(**opts)
-          @options[:emulation] = opts
-        end
-
-        #
-        # Enables mobile browser use on Android.
-        #
-        # @see https://chromedriver.chromium.org/getting-started/getting-started---android
-        #
-        # @param [String] package The package name of the Chrome or WebView app.
-        # @param [String] serial_number The device serial number on which to launch the Chrome or WebView app.
-        # @param [String] use_running_app When true uses an already-running Chrome or WebView app,
-        #   instead of launching the app with a clear data directory.
-        # @param [String] activity Name of the Activity hosting the WebView (Not available on Chrome Apps).
-        #
-
-        def enable_android(package: 'com.android.chrome', serial_number: nil, use_running_app: nil, activity: nil)
-          @options[:android_package] = package
-          @options[:android_activity] = activity unless activity.nil?
-          @options[:android_device_serial] = serial_number unless serial_number.nil?
-          @options[:android_use_running_app] = use_running_app unless use_running_app.nil?
-        end
-
         private
 
         def enable_logging(browser_options)
           browser_options['goog:loggingPrefs'] = @logging_prefs
         end
 
-        def process_browser_options(browser_options)
-          enable_logging(browser_options) unless @logging_prefs.empty?
-
-          options = browser_options[self.class::KEY]
-          options['binary'] ||= binary_path if binary_path
-
-          check_w3c(options[:w3c]) if options.key?(:w3c)
-
-          if @profile
-            options['args'] ||= []
-            options['args'] << "--user-data-dir=#{@profile.directory}"
-          end
-
-          return if (@encoded_extensions + @extensions).empty?
-
-          options['extensions'] = @encoded_extensions + @extensions.map { |ext| encode_extension(ext) }
-        end
-
-        def check_w3c(w3c)
-          if w3c
-            WebDriver.logger.warn("Setting 'w3c: true' is redundant and will no longer be allowed", id: :w3c)
-            return
-          end
-
-          raise Error::InvalidArgumentError,
-                "Setting 'w3c: false' is not allowed.\n" \
-                "Please update to W3C Syntax: https://www.selenium.dev/blog/2022/legacy-protocol-support/"
-        end
-
         def binary_path
           Chrome.path
         end
-
-        def encode_extension(path)
-          File.open(path, 'rb') { |crx_file| Base64.strict_encode64 crx_file.read }
-        end
-
-        def validate_extension(path)
-          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.file?(path)
-          raise Error::WebDriverError, "file was not an extension #{path.inspect}" unless File.extname(path) == '.crx'
-
-          @extensions << path
-        end
-
-        def camelize?(key)
-          !%w[localState prefs].include?(key)
-        end
       end # Options
     end # Chrome
   end # WebDriver