selenium-webdriver 3.142.7 → 4.10.0

data/lib/selenium/webdriver/devtools/console_event.rb

@@ -0,0 +1,36 @@
+# 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 DevTools
+      class ConsoleEvent
+        attr_accessor :type, :timestamp, :args
+
+        def initialize(type:, timestamp:, args:)
+          @type = type.to_sym
+          @timestamp = Time.at(timestamp / 1000)
+          @args = args.map do |arg|
+            arg.key?('value') ? arg['value'] : arg
+          end
+        end
+      end # ConsoleEvent
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/exception_event.rb

@@ -0,0 +1,34 @@
+# 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 DevTools
+      class ExceptionEvent
+        attr_accessor :description, :timestamp, :stacktrace
+
+        def initialize(description:, timestamp:, stacktrace:)
+          @description = description
+          @timestamp = Time.at(timestamp / 1000)
+          @stacktrace = stacktrace
+        end
+      end # ExceptionEvent
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/mutation_event.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 DevTools
+      class MutationEvent
+        attr_accessor :element, :attribute_name, :current_value, :old_value
+
+        def initialize(element:, attribute_name:, current_value:, old_value:)
+          @element = element
+          @attribute_name = attribute_name
+          @current_value = current_value
+          @old_value = old_value
+        end
+      end # MutationEvent
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/network_interceptor.rb

@@ -0,0 +1,173 @@
+# 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 DevTools
+      #
+      # Wraps the network request/response interception, providing
+      # thread-safety guarantees and handling special cases such as browser
+      # canceling requests midst interception.
+      #
+      # You should not be using this class directly, use Driver#intercept instead.
+      # @api private
+      #
+
+      class NetworkInterceptor
+        # CDP fails to get body on certain responses (301) and raises:
+        # "Can only get response body on requests captured after headers received."
+        CANNOT_GET_BODY_ON_REDIRECT_ERROR_CODE = '-32000'
+
+        # CDP fails to operate with intercepted requests.
+        # Typical reason is browser cancelling intercepted requests/responses.
+        INVALID_INTERCEPTION_ID_ERROR_CODE = '-32602'
+
+        def initialize(devtools)
+          @devtools = devtools
+          @lock = Mutex.new
+        end
+
+        def intercept(&block)
+          devtools.network.on(:loading_failed) { |params| track_cancelled_request(params) }
+          devtools.fetch.on(:request_paused) { |params| request_paused(params, &block) }
+
+          devtools.network.set_cache_disabled(cache_disabled: true)
+          devtools.network.enable
+          devtools.fetch.enable(patterns: [{requestStage: 'Request'}, {requestStage: 'Response'}])
+        end
+
+        private
+
+        attr_accessor :devtools, :lock
+
+        # We should be thread-safe to use the hash without synchronization
+        # because its keys are interception job identifiers and they should be
+        # unique within a devtools session.
+        def pending_response_requests
+          @pending_response_requests ||= {}
+        end
+
+        # Ensure usage of cancelled_requests is thread-safe via synchronization!
+        def cancelled_requests
+          @cancelled_requests ||= []
+        end
+
+        def track_cancelled_request(data)
+          return unless data['canceled']
+
+          lock.synchronize { cancelled_requests << data['requestId'] }
+        end
+
+        def request_paused(data, &block)
+          id = data['requestId']
+          network_id = data['networkId']
+
+          with_cancellable_request(network_id) do
+            if response?(data)
+              block = pending_response_requests.delete(id)
+              intercept_response(id, data, &block)
+            else
+              intercept_request(id, data, &block)
+            end
+          end
+        end
+
+        # The presence of any of these fields indicate we're at the response stage.
+        # @see https://chromedevtools.github.io/devtools-protocol/tot/Fetch/#event-requestPaused
+        def response?(params)
+          params.key?('responseStatusCode') || params.key?('responseErrorReason')
+        end
+
+        def intercept_request(id, params, &block)
+          original = DevTools::Request.from(id, params)
+          mutable = DevTools::Request.from(id, params)
+
+          block.call(mutable) do |&continue| # rubocop:disable Performance/RedundantBlockCall
+            pending_response_requests[id] = continue
+
+            if original == mutable
+              continue_request(original.id)
+            else
+              mutate_request(mutable)
+            end
+          end
+        end
+
+        def intercept_response(id, params)
+          return continue_response(id) unless block_given?
+
+          body = fetch_response_body(id)
+          original = DevTools::Response.from(id, body, params)
+          mutable = DevTools::Response.from(id, body, params)
+          yield mutable
+
+          if original == mutable
+            continue_response(id)
+          else
+            mutate_response(mutable)
+          end
+        end
+
+        def continue_request(id)
+          devtools.fetch.continue_request(request_id: id)
+        end
+        alias continue_response continue_request
+
+        def mutate_request(request)
+          devtools.fetch.continue_request(
+            request_id: request.id,
+            url: request.url,
+            method: request.method,
+            post_data: (Base64.strict_encode64(request.post_data) if request.post_data),
+            headers: request.headers.map do |k, v|
+              {name: k, value: v}
+            end
+          )
+        end
+
+        def mutate_response(response)
+          devtools.fetch.fulfill_request(
+            request_id: response.id,
+            body: (Base64.strict_encode64(response.body) if response.body),
+            response_code: response.code,
+            response_headers: response.headers.map do |k, v|
+              {name: k, value: v}
+            end
+          )
+        end
+
+        def fetch_response_body(id)
+          devtools.fetch.get_response_body(request_id: id).dig('result', 'body')
+        rescue Error::WebDriverError => e
+          raise unless e.message.start_with?(CANNOT_GET_BODY_ON_REDIRECT_ERROR_CODE)
+        end
+
+        def with_cancellable_request(network_id)
+          yield
+        rescue Error::WebDriverError => e
+          raise if e.message.start_with?(INVALID_INTERCEPTION_ID_ERROR_CODE) && !cancelled?(network_id)
+        end
+
+        def cancelled?(network_id)
+          lock.synchronize { !!cancelled_requests.delete(network_id) }
+        end
+      end # NetworkInterceptor
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/pinned_script.rb

@@ -0,0 +1,57 @@
+# 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 DevTools
+      class PinnedScript
+        attr_accessor :key, :devtools_identifier, :script
+
+        def initialize(script)
+          @key = SecureRandom.alphanumeric
+          @script = script
+        end
+
+        #
+        # @api private
+        #
+
+        def callable
+          "function __webdriver_#{key}(arguments) { #{script} }"
+        end
+
+        #
+        # @api private
+        #
+
+        def to_json(*)
+          %{"return __webdriver_#{key}(arguments)"}
+        end
+
+        #
+        # @api private
+        #
+
+        def remove
+          "__webdriver_#{key} = undefined"
+        end
+      end # PinnedScript
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/request.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 DevTools
+      class Request
+        attr_accessor :url, :method, :headers, :post_data
+        attr_reader :id
+
+        #
+        # Creates request from DevTools message.
+        # @api private
+        #
+
+        def self.from(id, params)
+          new(
+            id: id,
+            url: params.dig('request', 'url'),
+            method: params.dig('request', 'method'),
+            headers: params.dig('request', 'headers').dup,
+            post_data: params.dig('request', 'postData')
+          )
+        end
+
+        def initialize(id:, url:, method:, headers:, post_data:)
+          @id = id
+          @url = url
+          @method = method
+          @headers = headers
+          @post_data = post_data
+        end
+
+        def ==(other)
+          self.class == other.class &&
+            id == other.id &&
+            url == other.url &&
+            method == other.method &&
+            headers == other.headers &&
+            post_data == other.post_data
+        end
+
+        def inspect
+          %(#<#{self.class.name} @id="#{id}" @method="#{method}" @url="#{url}")
+        end
+      end # Request
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/response.rb

@@ -0,0 +1,64 @@
+# 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 DevTools
+      class Response
+        attr_accessor :code, :body, :headers
+        attr_reader :id
+
+        #
+        # Creates response from DevTools message.
+        # @api private
+        #
+
+        def self.from(id, encoded_body, params)
+          new(
+            id: id,
+            code: params['responseStatusCode'],
+            body: (Base64.strict_decode64(encoded_body) if encoded_body),
+            headers: params.fetch('responseHeaders', []).each_with_object({}) do |header, hash|
+              hash[header['name']] = header['value']
+            end
+          )
+        end
+
+        def initialize(id:, code:, body:, headers:)
+          @id = id
+          @code = code
+          @body = body
+          @headers = headers
+        end
+
+        def ==(other)
+          self.class == other.class &&
+            id == other.id &&
+            code == other.code &&
+            body == other.body &&
+            headers == other.headers
+        end
+
+        def inspect
+          %(#<#{self.class.name} @id="#{id}" @code="#{code}")
+        end
+      end # Response
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools.rb

@@ -0,0 +1,96 @@
+# 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 DevTools
+      autoload :ConsoleEvent, 'selenium/webdriver/devtools/console_event'
+      autoload :ExceptionEvent, 'selenium/webdriver/devtools/exception_event'
+      autoload :MutationEvent, 'selenium/webdriver/devtools/mutation_event'
+      autoload :NetworkInterceptor, 'selenium/webdriver/devtools/network_interceptor'
+      autoload :PinnedScript, 'selenium/webdriver/devtools/pinned_script'
+      autoload :Request, 'selenium/webdriver/devtools/request'
+      autoload :Response, 'selenium/webdriver/devtools/response'
+
+      def initialize(url:)
+        @ws = WebSocketConnection.new(url: url)
+        @session_id = nil
+        start_session
+      end
+
+      def close
+        @ws.close
+      end
+
+      def callbacks
+        @ws.callbacks
+      end
+
+      def send_cmd(method, **params)
+        data = {method: method, params: params.compact}
+        data[:sessionId] = @session_id if @session_id
+        message = @ws.send_cmd(**data)
+        raise Error::WebDriverError, error_message(message['error']) if message['error']
+
+        message
+      end
+
+      def method_missing(method, *_args)
+        namespace = "Selenium::DevTools::V#{Selenium::DevTools.version}"
+        methods_to_classes = "#{namespace}::METHODS_TO_CLASSES"
+
+        desired_class = if Object.const_defined?(methods_to_classes)
+                          # selenium-devtools 0.113 and newer
+                          "#{namespace}::#{Object.const_get(methods_to_classes)[method]}"
+                        else
+                          # selenium-devtools 0.112 and older
+                          "#{namespace}::#{method.capitalize}"
+                        end
+
+        return unless Object.const_defined?(desired_class)
+
+        self.class.class_eval do
+          define_method(method) do
+            Object.const_get(desired_class).new(self)
+          end
+        end
+
+        send(method)
+      end
+
+      def respond_to_missing?(method, *_args)
+        desired_class = "Selenium::DevTools::V#{Selenium::DevTools.version}::#{method.capitalize}"
+        Object.const_defined?(desired_class)
+      end
+
+      private
+
+      def start_session
+        targets = target.get_targets.dig('result', 'targetInfos')
+        page_target = targets.find { |target| target['type'] == 'page' }
+        session = target.attach_to_target(target_id: page_target['targetId'], flatten: true)
+        @session_id = session.dig('result', 'sessionId')
+      end
+
+      def error_message(error)
+        [error['code'], error['message'], error['data']].join(': ')
+      end
+    end # DevTools
+  end # WebDriver
+end # Selenium

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

@@ -17,49 +17,33 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chromium/driver'
+
 module Selenium
   module WebDriver
     module Edge
-
       #
       # Driver implementation for Microsoft Edge.
       # @api private
       #
 
-      class Driver < WebDriver::Driver
-        include DriverExtensions::TakesScreenshot
-
-        def initialize(opts = {})
-          opts[:desired_capabilities] ||= Remote::Capabilities.edge
-
-          opts[:url] ||= service_url(opts)
-
-          listener = opts.delete(:listener)
+      class Driver < Chromium::Driver
+        include LocalDriver
 
-          # Edge is mostly using W3C dialect, but a request to
-          # create session responds with OSS-like body,
-          # so we need to force W3C implementation.
-          desired_capabilities = opts.delete(:desired_capabilities)
-          bridge = Remote::Bridge.new(opts)
-          capabilities = bridge.create_session(desired_capabilities)
-
-          WebDriver.logger.info 'Forcing W3C dialect.'
-          @bridge = Remote::W3C::Bridge.new(capabilities, bridge.session_id, **opts)
-          @bridge.extend Edge::Bridge
-
-          super(@bridge, listener: listener)
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(capabilities, options, service, url)
+          super(caps: caps, url: url, **opts)
         end
 
         def browser
           :edge
         end
 
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
+        private
 
+        def devtools_address
+          "http://#{capabilities['ms:edgeOptions']['debuggerAddress']}"
+        end
       end # Driver
     end # Edge
   end # WebDriver

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

@@ -0,0 +1,44 @@
+# 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 'selenium/webdriver/chromium/features'
+
+module Selenium
+  module WebDriver
+    module Edge
+      module Features
+        include WebDriver::Chromium::Features
+
+        EDGE_COMMANDS = {
+          get_cast_sinks: [:get, 'session/:session_id/ms/cast/get_sinks'],
+          set_cast_sink_to_use: [:post, 'session/:session_id/ms/cast/set_sink_to_use'],
+          start_cast_tab_mirroring: [:post, 'session/:session_id/ms/cast/start_tab_mirroring'],
+          start_cast_desktop_mirroring: [:post, 'session/:session_id/ms/cast/start_desktop_mirroring'],
+          get_cast_issue_message: [:get, 'session/:session_id/ms/cast/get_issue_message'],
+          stop_casting: [:post, 'session/:session_id/ms/cast/stop_casting'],
+          send_command: [:post, 'session/:session_id/ms/cdp/execute']
+        }.freeze
+
+        def commands(command)
+          EDGE_COMMANDS[command] || CHROMIUM_COMMANDS[command] || self.class::COMMANDS[command]
+        end
+      end # Bridge
+    end # Edge
+  end # WebDriver
+end # Selenium