selenium-webdriver 4.1.0 → 4.28.0

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

@@ -0,0 +1,65 @@
+# 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 LogHandler
+        ConsoleLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source, :method, :args)
+        JavaScriptLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source)
+
+        def initialize(bidi)
+          @bidi = bidi
+          @log_entry_subscribed = false
+        end
+
+        # @return [int] id of the handler
+        # steep:ignore:start
+        def add_message_handler(type)
+          subscribe_log_entry unless @log_entry_subscribed
+          @bidi.add_callback('log.entryAdded') do |params|
+            if params['type'] == type
+              log_entry_klass = type == 'console' ? ConsoleLogEntry : JavaScriptLogEntry
+              yield(log_entry_klass.new(**params))
+            end
+          end
+        end
+        # steep:ignore:end
+
+        # @param [int] id of the handler previously added
+        def remove_message_handler(id)
+          @bidi.remove_callback('log.entryAdded', id)
+          unsubscribe_log_entry if @log_entry_subscribed && @bidi.callbacks['log.entryAdded'].empty?
+        end
+
+        private
+
+        def subscribe_log_entry
+          @bidi.session.subscribe('log.entryAdded')
+          @log_entry_subscribed = true
+        end
+
+        def unsubscribe_log_entry
+          @bidi.session.unsubscribe('log.entryAdded')
+          @log_entry_subscribed = false
+        end
+      end # LogHandler
+    end # Bidi
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,147 @@
+# 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)
+          WebDriver.logger.deprecate('LogInspector class',
+                                     'Script class with driver.script',
+                                     id: :log_inspector)
+
+          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, &)
+          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, &)
+        end
+
+        private
+
+        def on(event, &)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @bidi.add_callback("log.#{event}", &)
+        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/network.rb

@@ -0,0 +1,82 @@
+# 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 Network
+        EVENTS = {
+          before_request: 'network.beforeRequestSent',
+          response_started: 'network.responseStarted',
+          response_completed: 'network.responseCompleted',
+          auth_required: 'network.authRequired',
+          fetch_error: 'network.fetchError'
+        }.freeze
+
+        PHASES = {
+          before_request: 'beforeRequestSent',
+          response_started: 'responseStarted',
+          auth_required: 'authRequired'
+        }.freeze
+
+        def initialize(bidi)
+          @bidi = bidi
+        end
+
+        def add_intercept(phases: [], contexts: nil, url_patterns: nil)
+          @bidi.send_cmd('network.addIntercept', phases: phases, contexts: contexts, urlPatterns: url_patterns)
+        end
+
+        def remove_intercept(intercept)
+          @bidi.send_cmd('network.removeIntercept', intercept: intercept)
+        end
+
+        def continue_with_auth(request_id, username, password)
+          @bidi.send_cmd(
+            'network.continueWithAuth',
+            'request' => request_id,
+            'action' => 'provideCredentials',
+            'credentials' => {
+              'type' => 'password',
+              'username' => username,
+              'password' => password
+            }
+          )
+        end
+
+        def continue_with_request(**args)
+          @bidi.send_cmd(
+            'network.continueWithRequest',
+            request: args[:request_id],
+            'body' => args[:body],
+            'cookies' => args[:cookies],
+            'headers' => args[:headers],
+            'method' => args[:method],
+            'url' => args[:url]
+          )
+        end
+
+        def on(event, &)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @bidi.add_callback(event, &)
+        end
+      end # Network
+    end # BiDi
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,51 @@
+# 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 Session
+        Status = Struct.new(:ready, :message)
+
+        def initialize(bidi)
+          @bidi = bidi
+        end
+
+        def status
+          status = @bidi.send_cmd('session.status')
+          Status.new(**status)
+        end
+
+        def subscribe(events, browsing_contexts = nil)
+          opts = {events: Array(events)}
+          opts[:browsing_contexts] = Array(browsing_contexts) if browsing_contexts
+
+          @bidi.send_cmd('session.subscribe', **opts)
+        end
+
+        def unsubscribe(events, browsing_contexts = nil)
+          opts = {events: Array(events)}
+          opts[:browsing_contexts] = Array(browsing_contexts) if browsing_contexts
+
+          @bidi.send_cmd('session.unsubscribe', **opts)
+        end
+      end # Session
+    end # BiDi
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,42 @@
+# 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 Struct < ::Struct
+        class << self
+          def new(*args, &block)
+            super do
+              define_method(:initialize) do |**kwargs|
+                converted_kwargs = kwargs.transform_keys { |key| self.class.camel_to_snake(key.to_s).to_sym }
+                super(*converted_kwargs.values_at(*self.class.members))
+              end
+              class_eval(&block) if block
+            end
+          end
+
+          def camel_to_snake(camel_str)
+            camel_str.gsub(/([A-Z])/, '_\1').downcase
+          end
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/bidi.rb

@@ -0,0 +1,67 @@
+# 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
+      autoload :Session, 'selenium/webdriver/bidi/session'
+      autoload :LogInspector, 'selenium/webdriver/bidi/log_inspector'
+      autoload :LogHandler, 'selenium/webdriver/bidi/log_handler'
+      autoload :BrowsingContext, 'selenium/webdriver/bidi/browsing_context'
+      autoload :Struct, 'selenium/webdriver/bidi/struct'
+      autoload :Network, 'selenium/webdriver/bidi/network'
+
+      def initialize(url:)
+        @ws = WebSocketConnection.new(url: url)
+      end
+
+      def close
+        @ws.close
+      end
+
+      def callbacks
+        @ws.callbacks
+      end
+
+      def add_callback(event, &)
+        @ws.add_callback(event, &)
+      end
+
+      def remove_callback(event, id)
+        @ws.remove_callback(event, id)
+      end
+
+      def session
+        @session ||= Session.new(self)
+      end
+
+      def send_cmd(method, **params)
+        data = {method: method, params: params.compact}
+        message = @ws.send_cmd(**data)
+        raise Error::WebDriverError, error_message(message) if message['error']
+
+        message['result']
+      end
+
+      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,31 +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::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
@@ -49,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,88 +17,30 @@
 # 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 stop_casting(name)
-          execute :stop_casting, {}, {sinkName: name}
+        def command_list
+          CHROME_COMMANDS.merge(CHROMIUM_COMMANDS).merge(self.class::COMMANDS)
         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
+        def commands(command)
+          command_list[command]
         end
       end # Bridge
     end # Chrome