selenium-webdriver 4.0.0.beta1 → 4.0.0.rc1

data/lib/selenium/webdriver/atoms/mutationListener.js

@@ -1,3 +1,20 @@
+// 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.
+
 (function () {
   const observer = new MutationObserver((mutations) => {
     for (const mutation of mutations) {

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

@@ -27,37 +27,40 @@ module Selenium
       #
 
       class Driver < WebDriver::Driver
-        include DriverExtensions::HasNetworkConditions
-        include DriverExtensions::HasWebStorage
-        include DriverExtensions::HasLocation
-        include DriverExtensions::DownloadsFiles
-        include DriverExtensions::HasDevTools
-        include DriverExtensions::HasAuthentication
-        include DriverExtensions::HasLogs
-        include DriverExtensions::HasLogEvents
-        include DriverExtensions::PrintsPage
+        EXTENSIONS = [DriverExtensions::HasCDP,
+                      DriverExtensions::HasNetworkConditions,
+                      DriverExtensions::HasNetworkInterception,
+                      DriverExtensions::HasWebStorage,
+                      DriverExtensions::HasLocation,
+                      DriverExtensions::DownloadsFiles,
+                      DriverExtensions::HasDevTools,
+                      DriverExtensions::HasAuthentication,
+                      DriverExtensions::HasLogs,
+                      DriverExtensions::HasLogEvents,
+                      DriverExtensions::HasPinnedScripts,
+                      DriverExtensions::PrintsPage].freeze
 
         def browser
           :chrome
         end
 
-        def bridge_class
-          Bridge
-        end
+        private
 
-        def execute_cdp(cmd, **params)
-          @bridge.send_command(cmd: cmd, params: params)
-        end
+        def devtools_url
+          uri = URI(devtools_address)
+          response = Net::HTTP.get(uri.hostname, '/json/version', uri.port)
 
-        private
+          JSON.parse(response)['webSocketDebuggerUrl']
+        end
 
         def devtools_version
           Integer(capabilities.browser_version.split('.').first)
         end
 
-        def debugger_address
-          capabilities['goog:chromeOptions']['debuggerAddress']
+        def devtools_address
+          "http://#{capabilities['goog:chromeOptions']['debuggerAddress']}"
         end
+
       end # Driver
     end # Chrome
   end # WebDriver

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

@@ -230,7 +230,7 @@ module Selenium
         end
 
         def camelize?(key)
-          !['prefs'].include?(key)
+          !%w[localState prefs].include?(key)
         end
       end # Options
     end # Chrome

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

@@ -27,12 +27,11 @@ module Selenium
       class Profile
         include ProfileHelper
 
-        attr_reader :directory
-
         def initialize(model = nil)
           @model = verify_model(model)
           @extensions = []
           @encoded_extensions = []
+          @directory = nil
         end
 
         def add_extension(path)
@@ -45,6 +44,10 @@ module Selenium
           @encoded_extensions << encoded
         end
 
+        def directory
+          @directory || layout_on_disk
+        end
+
         #
         # Set a preference in the profile.
         #

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

@@ -39,7 +39,9 @@ module Selenium
           driver_args << "--log-path=#{driver_opts.delete(:log_path)}" if driver_opts.key?(:log_path)
           driver_args << "--url-base=#{driver_opts.delete(:url_base)}" if driver_opts.key?(:url_base)
           driver_args << "--port-server=#{driver_opts.delete(:port_server)}" if driver_opts.key?(:port_server)
-          driver_args << "--whitelisted-ips=#{driver_opts.delete(:whitelisted_ips)}" if driver_opts.key?(:whitelisted_ips)
+          if driver_opts.key?(:whitelisted_ips)
+            driver_args << "--whitelisted-ips=#{driver_opts.delete(:whitelisted_ips)}"
+          end
           driver_args << "--verbose" if driver_opts.key?(:verbose)
           driver_args << "--silent" if driver_opts.key?(:silent)
           driver_args

data/lib/selenium/webdriver/chrome.rb

@@ -22,7 +22,7 @@ require 'net/http'
 module Selenium
   module WebDriver
     module Chrome
-      autoload :Bridge, 'selenium/webdriver/chrome/bridge'
+      autoload :Features, 'selenium/webdriver/chrome/features'
       autoload :Driver, 'selenium/webdriver/chrome/driver'
       autoload :Profile, 'selenium/webdriver/chrome/profile'
       autoload :Options, 'selenium/webdriver/chrome/options'

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

@@ -71,11 +71,13 @@ module Selenium
       def initialize(bridge: nil, listener: nil, **opts)
         @service = nil
         bridge ||= create_bridge(**opts)
+        add_extensions(bridge.browser)
         @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
       end
 
       def inspect
-        format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2, browser: bridge.browser.inspect
+        format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2,
+                                                              browser: bridge.browser.inspect
       end
 
       #
@@ -295,7 +297,9 @@ module Selenium
       # @see SearchContext
       #
 
-      def ref; end
+      def ref
+        [:driver, nil]
+      end
 
       private
 
@@ -329,7 +333,7 @@ module Selenium
         bridge_opts = {http_client: opts.delete(:http_client), url: opts.delete(:url)}
         raise ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
 
-        bridge = (respond_to?(:bridge_class) ? bridge_class : Remote::Bridge).new(**bridge_opts)
+        bridge = Remote::Bridge.new(**bridge_opts)
 
         bridge.create_session(capabilities)
         bridge
@@ -340,8 +344,9 @@ module Selenium
           if cap.is_a? Symbol
             cap = Remote::Capabilities.send(cap)
           elsif cap.is_a? Hash
+            new_message = 'Capabilities instance initialized with the Hash, or build values with Options class'
             WebDriver.logger.deprecate("passing a Hash value to :capabilities",
-                                       'Capabilities instance initialized with the Hash, or build values with Options class',
+                                       new_message,
                                        id: :capabilities_hash)
             cap = Remote::Capabilities.new(cap)
           elsif !cap.respond_to? :as_json
@@ -371,6 +376,20 @@ module Selenium
       def screenshot
         bridge.screenshot
       end
+
+      def add_extensions(browser)
+        extensions = case browser
+                     when :chrome, :msedge
+                       Chrome::Driver::EXTENSIONS
+                     when :firefox
+                       Firefox::Driver::EXTENSIONS
+                     when :safari, :safari_technology_preview
+                       Safari::Driver::EXTENSIONS
+                     else
+                       []
+                     end
+        extensions.each { |extension| extend extension }
+      end
     end # Driver
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/{devtools/v87/schema.rb → common/driver_extensions/full_page_screenshot.rb}

@@ -17,32 +17,27 @@
 # specific language governing permissions and limitations
 # under the License.
 
-# This file is automatically generated. Any changes will be lost!
 module Selenium
   module WebDriver
-    class DevTools
-      def schema
-        @schema ||= V87::Schema.new(self)
-      end
+    module DriverExtensions
+      module FullPageScreenshot
+        #
+        # Save a PNG screenshot of the full page to the given path
+        #
+        # @api public
+        #
 
-      module V87
-        class Schema
+        def save_full_page_screenshot(path)
+          save_screenshot(path, full_page: true)
+        end
 
-          def initialize(devtools)
-            @devtools = devtools
-          end
+        private
 
-          def on(event, &block)
-            event = EVENTS[event] if event.is_a?(Symbol)
-            @devtools.callbacks["Schema.#{event}"] << block
-          end
+        def full_screenshot
+          @bridge.full_screenshot
+        end
 
-          def get_domains
-            @devtools.send_cmd('Schema.getDomains')
-          end
-
-        end # V87
-      end # Schema
-    end # DevTools
+      end # FullPageScreenshot
+    end # DriverExtensions
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/{edge/bridge.rb → common/driver_extensions/has_cdp.rb}

@@ -17,21 +17,22 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/chrome/bridge'
-
 module Selenium
   module WebDriver
-    module Edge
-      class Bridge < WebDriver::Chrome::Bridge
+    module DriverExtensions
+      module HasCDP
 
-        COMMANDS = WebDriver::Chrome::Bridge::COMMANDS.merge(
-          send_command: [:post, 'session/:session_id/ms/cdp/execute']
-        ).freeze
+        #
+        # Returns network conditions.
+        #
+        # @return [Hash]
+        #
 
-        def commands(command)
-          COMMANDS[command] || super
+        def execute_cdp(cmd, **params)
+          @bridge.send_command(cmd: cmd, params: params)
         end
-      end # Bridge
-    end # Edge
+
+      end # HasCDP
+    end # DriverExtensions
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_devtools.rb

@@ -29,7 +29,12 @@ module Selenium
         #
 
         def devtools
-          @devtools ||= DevTools.new(url: debugger_address, version: devtools_version)
+          @devtools ||= begin
+            require 'selenium/devtools'
+            Selenium::DevTools.version ||= devtools_version
+            Selenium::DevTools.load_version
+            Selenium::WebDriver::DevTools.new(url: devtools_url)
+          end
         end
 
       end # HasDevTools

data/lib/selenium/webdriver/common/driver_extensions/has_log_events.rb

@@ -112,8 +112,7 @@ module Selenium
 
           devtools.runtime.add_binding(name: '__webdriver_attribute')
           execute_script(mutation_listener)
-          script = devtools.page.add_script_to_evaluate_on_new_document(source: mutation_listener)
-          pinned_scripts[mutation_listener] = script['identifier']
+          devtools.page.add_script_to_evaluate_on_new_document(source: mutation_listener)
 
           devtools.runtime.on(:binding_called, &method(:log_mutation_event))
         end
@@ -139,10 +138,6 @@ module Selenium
           @mutation_listener ||= read_atom(:mutationListener)
         end
 
-        def pinned_scripts
-          @pinned_scripts ||= {}
-        end
-
       end # HasLogEvents
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_network_connection.rb

@@ -23,11 +23,13 @@ module Selenium
     module DriverExtensions
       module HasNetworkConnection
         def network_connection_type
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support getting network connection'
+          raise Error::UnsupportedOperationError,
+                'The W3C standard does not currently support getting network connection'
         end
 
         def network_connection_type=(*)
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support setting network connection'
+          raise Error::UnsupportedOperationError,
+                'The W3C standard does not currently support setting network connection'
         end
       end # HasNetworkConnection
     end # DriverExtensions

data/lib/selenium/webdriver/common/driver_extensions/has_network_interception.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
+    module DriverExtensions
+      module HasNetworkInterception
+
+        #
+        # Intercepts requests coming from browser allowing
+        # to either pass them through like proxy or provide
+        # a stubbed response instead.
+        #
+        # @example Log requests and pass through
+        #   driver.intercept do |request|
+        #     puts "#{request.method} #{request.url}"
+        #     request.continue
+        #   end
+        #
+        # @example Stub response for image requests
+        #   driver.intercept do |request|
+        #     if request.url.match?(/\.png$/)
+        #       request.respond(body: File.read('myfile.png'))
+        #     else
+        #       request.continue
+        #     end
+        #   end
+        #
+        # @param [#call] block which is called when request is interecepted
+        # @yieldparam [DevTools::Request]
+        #
+
+        def intercept
+          devtools.network.set_cache_disabled(cache_disabled: true)
+          devtools.fetch.on(:request_paused) do |params|
+            request = DevTools::Request.new(
+              devtools: devtools,
+              id: params['requestId'],
+              url: params.dig('request', 'url'),
+              method: params.dig('request', 'method'),
+              headers: params.dig('request', 'headers')
+            )
+            yield request
+          end
+          devtools.fetch.enable
+        end
+
+      end # HasNetworkInterception
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_pinned_scripts.rb

@@ -0,0 +1,77 @@
+# 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
+    module DriverExtensions
+      module HasPinnedScripts
+
+        #
+        # Returns the list of all pinned scripts.
+        #
+        # @return [Array<DevTools::PinnedScript>]
+        #
+
+        def pinned_scripts
+          @pinned_scripts ||= []
+        end
+
+        #
+        # Pins JavaScript snippet that is available during the whole
+        # session on every page. This allows to store and call
+        # scripts without sending them over the wire every time.
+        #
+        # @example
+        #   script = driver.pin_script('return window.location.href')
+        #   driver.execute_script(script)
+        #   # navigate to a new page
+        #   driver.execute_script(script)
+        #
+        # @param [String] script
+        # @return [DevTools::PinnedScript]
+        #
+
+        def pin_script(script)
+          script = DevTools::PinnedScript.new(script)
+          pinned_scripts << script
+
+          devtools.page.enable
+          devtools.runtime.evaluate(expression: script.callable)
+          response = devtools.page.add_script_to_evaluate_on_new_document(source: script.callable)
+          script.devtools_identifier = response.dig('result', 'identifier')
+
+          script
+        end
+
+        #
+        # Unpins script making it undefined for the subsequent calls.
+        #
+        # @param [DevTools::PinnedScript]
+        #
+
+        def unpin_script(script)
+          devtools.runtime.evaluate(expression: script.remove)
+          devtools.page.remove_script_to_evaluate_on_new_document(identifier: script.devtools_identifier)
+          pinned_scripts.delete(script)
+        end
+
+      end # HasPinnedScripts
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium