selenium-webdriver 3.142.1 → 4.1.0

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

@@ -20,12 +20,13 @@
 module Selenium
   module WebDriver
     module Remote
+
+      #
       # @api private
-      class Response
-        STACKTRACE_KEY = 'stackTrace'
+      #
 
+      class Response
         attr_reader :code, :payload
-        attr_writer :payload
 
         def initialize(code, payload = nil)
           @code    = code
@@ -35,33 +36,16 @@ module Selenium
         end
 
         def error
-          klass = Error.for_code(status) || return
+          error, message, backtrace = process_error
+          klass = Error.for_error(error) || return
 
-          ex = klass.new(error_message)
+          ex = klass.new(message)
           ex.set_backtrace(caller)
-          add_backtrace ex
+          add_backtrace ex, backtrace
 
           ex
         end
 
-        def error_message
-          val = value
-
-          case val
-          when Hash
-            msg = val['message']
-            return 'unknown error' unless msg
-
-            msg << ": #{val['alert']['text'].inspect}" if val['alert'].is_a?(Hash) && val['alert']['text']
-            msg << " (#{val['class']})" if val['class']
-            msg
-          when String
-            val
-          else
-            "unknown error, status=#{status}: #{val.inspect}"
-          end
-        end
-
         def [](key)
           @payload[key]
         end
@@ -76,14 +60,7 @@ module Selenium
           raise Error::ServerError, self
         end
 
-        def add_backtrace(ex)
-          return unless error_payload.is_a?(Hash)
-
-          # Legacy Firefox returns String in ['value'], while we expect Hash.
-          # Use #dig when Firefox legacy is removed (4.0).
-          server_trace = error_payload[STACKTRACE_KEY] ||
-                         error_payload[STACKTRACE_KEY.downcase] ||
-                         (error_payload['value'] && error_payload['value'][STACKTRACE_KEY])
+        def add_backtrace(ex, server_trace)
           return unless server_trace
 
           backtrace = case server_trace
@@ -113,22 +90,14 @@ module Selenium
           }.compact
         end
 
-        def error_payload
-          # Even errors are wrapped in 'value' for w3c
-          # Grab 'value' key for error, leave original payload alone and let the bridge process
-          @error_payload ||= !@payload.key?('sessionId') ? @payload['value'] : @payload
-        end
-
-        def status
-          return unless error_payload.is_a? Hash
-
-          @status ||= error_payload['status'] || error_payload['error']
-        end
-
-        def value
-          return unless error_payload.is_a? Hash
+        def process_error
+          return unless self['value'].is_a?(Hash)
 
-          @value ||= error_payload['value'] || error_payload['message']
+          [
+            self['value']['error'],
+            self['value']['message'],
+            self['value']['stacktrace']
+          ]
         end
       end # Response
     end # Remote

data/lib/selenium/webdriver/remote.rb

@@ -18,18 +18,21 @@
 # under the License.
 
 require 'uri'
-
-require 'selenium/webdriver/remote/bridge'
-require 'selenium/webdriver/remote/driver'
-require 'selenium/webdriver/remote/response'
 require 'selenium/webdriver/remote/server_error'
-require 'selenium/webdriver/remote/http/common'
-require 'selenium/webdriver/remote/http/default'
 
-require 'selenium/webdriver/remote/capabilities'
-require 'selenium/webdriver/remote/oss/bridge'
-require 'selenium/webdriver/remote/oss/commands'
+module Selenium
+  module WebDriver
+    module Remote
+      autoload :Bridge,       'selenium/webdriver/remote/bridge'
+      autoload :Driver,       'selenium/webdriver/remote/driver'
+      autoload :Response,     'selenium/webdriver/remote/response'
+      autoload :Capabilities, 'selenium/webdriver/remote/capabilities'
+      autoload :COMMANDS,     'selenium/webdriver/remote/commands'
 
-require 'selenium/webdriver/remote/w3c/bridge'
-require 'selenium/webdriver/remote/w3c/capabilities'
-require 'selenium/webdriver/remote/w3c/commands'
+      module Http
+        autoload :Common,  'selenium/webdriver/remote/http/common'
+        autoload :Default, 'selenium/webdriver/remote/http/default'
+      end
+    end
+  end
+end

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

@@ -27,41 +27,13 @@ module Selenium
       #
 
       class Driver < WebDriver::Driver
-        include DriverExtensions::HasDebugger
-        include DriverExtensions::HasPermissions
-        include DriverExtensions::TakesScreenshot
-
-        def initialize(opts = {})
-          opts[:desired_capabilities] = create_capabilities(opts)
-
-          opts[:url] ||= service_url(opts)
-
-          listener = opts.delete(:listener)
-          @bridge = Remote::Bridge.handshake(opts)
-          @bridge.extend Bridge
-
-          super(@bridge, listener: listener)
-        end
+        EXTENSIONS = [DriverExtensions::HasDebugger,
+                      DriverExtensions::HasApplePermissions,
+                      DriverExtensions::HasWebStorage].freeze
 
         def browser
           :safari
         end
-
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
-
-        private
-
-        def create_capabilities(opts = {})
-          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.safari }
-          options = opts.delete(:options) { Options.new }
-          caps.merge!(options.as_json)
-          caps
-        end
-
       end # Driver
     end # Safari
   end # WebDriver

data/lib/selenium/webdriver/safari/{bridge.rb → features.rb}

@@ -20,17 +20,17 @@
 module Selenium
   module WebDriver
     module Safari
-      module Bridge
+      module Features
 
         # https://developer.apple.com/library/content/documentation/NetworkingInternetWeb/Conceptual/WebDriverEndpointDoc/Commands/Commands.html
-        COMMANDS = {
-          get_permissions: [:get, '/session/:session_id/apple/permissions'],
-          set_permissions: [:post, '/session/:session_id/apple/permissions'],
-          attach_debugger: [:post, '/session/:session_id/apple/attach_debugger']
+        SAFARI_COMMANDS = {
+          get_permissions: [:get, 'session/:session_id/apple/permissions'],
+          set_permissions: [:post, 'session/:session_id/apple/permissions'],
+          attach_debugger: [:post, 'session/:session_id/apple/attach_debugger']
         }.freeze
 
         def commands(command)
-          COMMANDS[command] || super
+          SAFARI_COMMANDS[command] || self.class::COMMANDS[command]
         end
 
         def permissions

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

@@ -20,40 +20,21 @@
 module Selenium
   module WebDriver
     module Safari
-      class Options
-        attr_accessor :automatic_inspection, :automatic_profiling
+      class Options < WebDriver::Options
+        attr_accessor :options
 
-        #
-        # Create a new Options instance for W3C-capable versions of Safari.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Safari::Options.new(automatic_inspection: true)
-        #   driver = Selenium::WebDriver.for :safari, options: options
-        #
-        # @param [Hash] opts the pre-defined options to create the Safari::Options with
-        # @option opts [Boolean] :automatic_inspection Preloads Web Inspector and JavaScript debugger. Default is false
-        # @option opts [Boolean] :automatic_profiling Preloads Web Inspector and starts a timeline recording. Default is false
-        #
         # @see https://developer.apple.com/documentation/webkit/about_webdriver_for_safari
-        #
+        CAPABILITIES = {automatic_inspection: 'safari:automaticInspection',
+                        automatic_profiling: 'safari:automaticProfiling'}.freeze
+        BROWSER = 'safari'
 
-        def initialize(**opts)
-          @automatic_inspection = opts.delete(:automatic_inspection) || false
-          @automatic_profiling = opts.delete(:automatic_profiling) || false
-        end
-
-        #
-        # @api private
-        #
-
-        def as_json(*)
-          opts = {}
+        def add_option(name, value = nil)
+          key = name.is_a?(Hash) ? name.keys.first : name
+          raise ArgumentError, 'Safari does not support options that are not namespaced' unless key.to_s.include?(':')
 
-          opts['safari:automaticInspection'] = true if @automatic_inspection
-          opts['safari:automaticProfiling'] = true if @automatic_profiling
-
-          opts
+          super
         end
+
       end # Options
     end # Safari
   end # WebDriver

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

@@ -20,18 +20,14 @@
 module Selenium
   module WebDriver
     module Safari
-      #
-      # @api private
-      #
-
       class Service < WebDriver::Service
-        @default_port = 7050
-        @executable = 'safaridriver'
-        @missing_text = <<~ERROR
+        DEFAULT_PORT = 7050
+        EXECUTABLE = 'safaridriver'
+        MISSING_TEXT = <<~ERROR
           Unable to find Apple's safaridriver which comes with Safari 10.
           More info at https://webkit.org/blog/6900/webdriver-support-in-safari-10/
         ERROR
-        @shutdown_supported = false
+        SHUTDOWN_SUPPORTED = false
       end # Service
     end # Safari
   end # WebDriver

data/lib/selenium/webdriver/safari.rb

@@ -17,20 +17,28 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/safari/bridge'
-require 'selenium/webdriver/safari/driver'
-require 'selenium/webdriver/safari/options'
-
 module Selenium
   module WebDriver
     module Safari
+      autoload :Features, 'selenium/webdriver/safari/features'
+      autoload :Driver, 'selenium/webdriver/safari/driver'
+      autoload :Options, 'selenium/webdriver/safari/options'
+      autoload :Service, 'selenium/webdriver/safari/service'
+
       class << self
+        attr_accessor :use_technology_preview
+
         def technology_preview
           "/Applications/Safari\ Technology\ Preview.app/Contents/MacOS/safaridriver"
         end
 
         def technology_preview!
-          self.driver_path = technology_preview
+          Service.driver_path = technology_preview
+          @use_technology_preview = true
+        end
+
+        def technology_preview?
+          use_technology_preview
         end
 
         def path=(path)
@@ -48,18 +56,18 @@ module Selenium
 
         def driver_path=(path)
           WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path=',
-                                     'Selenium::WebDriver::Safari::Service#driver_path='
+                                     'Selenium::WebDriver::Safari::Service#driver_path=',
+                                     id: :driver_path
           Selenium::WebDriver::Safari::Service.driver_path = path
         end
 
         def driver_path
           WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path',
-                                     'Selenium::WebDriver::Safari::Service#driver_path'
+                                     'Selenium::WebDriver::Safari::Service#driver_path',
+                                     id: :driver_path
           Selenium::WebDriver::Safari::Service.driver_path
         end
       end
     end # Safari
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/safari/service'

data/lib/selenium/webdriver/support/block_event_listener.rb

@@ -25,7 +25,7 @@ module Selenium
           @callback = callback
         end
 
-        def method_missing(meth, *args) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+        def method_missing(meth, *args) # rubocop:disable Style/MissingRespondToMissing
           @callback.call meth, *args
         end
       end # BlockEventListener

data/lib/selenium/webdriver/support/cdp/domain.rb.erb

@@ -0,0 +1,63 @@
+# 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!
+module Selenium
+  module DevTools
+    module <%= version %>
+      class <%= domain[:domain] %>
+        <% if domain[:events] %>
+        EVENTS = {
+          <% domain[:events].each do |event| %>
+          <%= h.snake_case(event[:name]) %>: '<%= event[:name] %>',
+          <% end %>
+        }.freeze
+        <% end %>
+
+        def initialize(devtools)
+          @devtools = devtools
+        end
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @devtools.callbacks["<%= domain[:domain] %>.#{event}"] << block
+        end
+
+        <% domain[:commands].each do |command| %>
+        <% if command[:parameters] %>
+        def <%= h.snake_case(command[:name]) %>(<%= h.kwargs(command[:parameters]) %>)
+        <% else %>
+        def <%= h.snake_case(command[:name]) %>
+        <% end %>
+          <% if command[:parameters] %>
+          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>',
+            <% until command[:parameters].empty? %>
+              <% parameter = command[:parameters].shift %>
+                             <%= parameter[:name] %>: <%= h.snake_case(parameter[:name]) %><%= command[:parameters].empty? ? ')' : ',' %>
+            <% end %>
+          <% else %>
+          @devtools.send_cmd('<%= domain[:domain] %>.<%= command[:name] %>')
+          <% end %>
+        end
+
+        <% end %>
+      end # <%= domain[:domain] %>
+    end # <%= version %>
+  end # DevTools
+end # Selenium

data/lib/selenium/webdriver/support/cdp_client_generator.rb

@@ -0,0 +1,108 @@
+# 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 'erb'
+require 'fileutils'
+require 'json'
+
+module Selenium
+  module WebDriver
+    module Support
+      class CDPClientGenerator
+        # Input JSON files are generated from PDL tasks.
+        TEMPLATE_PATH = File.expand_path('cdp/domain.rb.erb', __dir__)
+
+        RESERVED_KEYWORDS = %w[end].freeze
+
+        def call(output_dir:, version:, browser_protocol_path: nil, js_protocol_path: nil, loader_path: nil, **)
+          @template = ERB.new(File.read(TEMPLATE_PATH))
+          @output_dir = output_dir
+          @loader_path = loader_path || "#{@output_dir}.rb"
+          @version = version
+
+          browser_protocol_path ||= File.expand_path('cdp/browser_protocol.json', __dir__)
+          js_protocol_path ||= File.expand_path('cdp/js_protocol.json', __dir__)
+
+          browser_protocol = JSON.parse(File.read(browser_protocol_path), symbolize_names: true)
+          js_protocol = JSON.parse(File.read(js_protocol_path), symbolize_names: true)
+
+          FileUtils.mkdir_p(@output_dir)
+
+          browser_protocol[:domains].each(&method(:process_domain))
+          js_protocol[:domains].each(&method(:process_domain))
+          require_file
+        end
+
+        def process_domain(domain)
+          result = @template.result_with_hash(domain: domain, version: @version.upcase, h: self)
+          filename = File.join(@output_dir, "#{snake_case(domain[:domain])}.rb")
+          File.write(filename, remove_empty_lines(result))
+        end
+
+        def snake_case(string)
+          name = string.gsub('JavaScript', 'Javascript')
+                       .gsub(/([A-Z]+)([A-Z][a-z]{2,})/, '\1_\2')
+                       .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                       .downcase
+          # Certain CDP parameters conflict with Ruby keywords
+          # so we prefix the name with underscore.
+          name = "_#{name}" if RESERVED_KEYWORDS.include?(name)
+
+          name
+        end
+
+        def kwargs(parameters)
+          parameters = parameters.map do |parameter|
+            if parameter[:optional]
+              "#{snake_case(parameter[:name])}: nil"
+            else
+              "#{snake_case(parameter[:name])}:"
+            end
+          end
+          parameters.join(', ')
+        end
+
+        def remove_empty_lines(string)
+          string.split("\n").reject { |l| l =~ /^\s+$/ }.join("\n")
+        end
+
+        def require_file
+          # rubocop:disable Lint/InterpolationCheck
+          dynamic_location = '#{File.dirname(File.absolute_path(__FILE__))}'
+          # rubocop:enable Lint/InterpolationCheck
+
+          require_all = "Dir.glob(\"#{dynamic_location}/#{@version}/*\", &method(:require))"
+          File.open(@loader_path, 'w') { |file| file.write(require_all) }
+        end
+      end
+    end
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  browser_protocol_path, js_protocol_path, output_dir, loader_path, version = *ARGV
+
+  Selenium::WebDriver::Support::CDPClientGenerator.new.call(
+    browser_protocol_path: browser_protocol_path,
+    js_protocol_path: js_protocol_path,
+    output_dir: output_dir,
+    loader_path: loader_path,
+    version: version
+  )
+end

data/lib/selenium/webdriver/support/color.rb

@@ -72,7 +72,7 @@ module Selenium
           end
         end
 
-        def self.from_hsl(h, s, l, a) # rubocop:disable Naming/UncommunicativeMethodParamName
+        def self.from_hsl(h, s, l, a) # rubocop:disable Naming/MethodParameterName
           h = Float(h) / 360
           s = Float(s) / 100
           l = Float(l) / 100
@@ -138,7 +138,7 @@ module Selenium
         end
 
         def hex
-          format '#%02x%02x%02x', red, green, blue
+          format '#%<red>02x%<green>02x%<blue>02x', red: red, green: green, blue: blue
         end
       end # Color
     end # Support

data/lib/selenium/webdriver/support/event_firing_bridge.rb

@@ -76,7 +76,7 @@ module Selenium
             @delegate.find_element_by how, what, parent
           end
 
-          Element.new self, e.ref
+          Element.new self, e.ref.last
         end
 
         def find_elements_by(how, what, parent = nil)
@@ -84,7 +84,7 @@ module Selenium
             @delegate.find_elements_by(how, what, parent)
           end
 
-          es.map { |e| Element.new self, e.ref }
+          es.map { |e| Element.new self, e.ref.last }
         end
 
         def execute_script(script, *args)
@@ -109,7 +109,7 @@ module Selenium
         end
 
         def driver
-          @driver ||= Driver.new(self)
+          @driver ||= Driver.new(bridge: self)
         end
 
         def dispatch(name, *args)
@@ -120,7 +120,7 @@ module Selenium
           returned
         end
 
-        def method_missing(meth, *args, &blk) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+        def method_missing(meth, *args, &blk) # rubocop:disable Style/MissingRespondToMissing
           @delegate.__send__(meth, *args, &blk)
         end
       end # EventFiringBridge

data/lib/selenium/webdriver/support/guards/guard.rb

@@ -0,0 +1,89 @@
+# 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 Support
+      class Guards
+
+        #
+        # Guard derived from RSpec example metadata.
+        # @api private
+        #
+
+        class Guard
+
+          attr_reader :guarded, :type, :messages, :reason
+
+          def initialize(guarded, type, guards = nil)
+            @guarded = guarded
+            @tracker = guards&.bug_tracker || ''
+            @messages = guards&.messages || {}
+            @messages[:unknown] = 'TODO: Investigate why this is failing and file a bug report'
+            @type = type
+
+            @reason = @guarded.delete(:reason)
+          end
+
+          def message
+            details = case @reason
+                      when Integer
+                        "Bug Filed: #{@tracker}/#{@reason}"
+                      when Symbol
+                        @messages[@reason]
+                      when String
+                        @reason
+                      else
+                        'no reason given'
+                      end
+
+            case @type
+            when :exclude
+              "Test not guarded because it breaks test run; #{details}"
+            when :exclusive
+              "Test does not apply to this configuration; #{details}"
+            else
+              "Test guarded; #{details}"
+            end
+          end
+
+          # Bug is present on all configurations specified
+          def except?
+            @type == :except
+          end
+
+          # Bug is present on all configurations not specified
+          def only?
+            @type == :only
+          end
+
+          # Bug is present on all configurations specified, but test can not be run because it breaks other tests
+          def exclude?
+            @type == :exclude
+          end
+
+          # Test only applies to configurations specified
+          def exclusive?
+            @type == :exclusive
+          end
+        end # Guard
+      end # Guards
+    end # Support
+  end # WebDriver
+end # Selenium