selenium-webdriver 3.142.6 → 4.1.0

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

@@ -19,191 +19,134 @@
 
 module Selenium
   module WebDriver
-    module Error # rubocop:disable Metrics/ModuleLength
+    module Error
 
       #
-      # Returns exception from code (Integer - OSS, String - W3C).
-      # @param [Integer, String, nil] code
+      # Returns exception from its string representation.
+      # @param [String, nil] error
       #
 
-      def self.for_code(code)
-        case code
-        when nil, 0
-          nil
-        when Integer
-          Object.const_get(ERRORS.fetch(code).to_s)
-        when String
-          klass_name = code.split(' ').map(&:capitalize).join.sub(/Error$/, '')
-          const_get("#{klass_name}Error", false)
-        end
-      rescue KeyError, NameError
+      def self.for_error(error)
+        return if error.nil?
+
+        klass_name = error.split(' ').map(&:capitalize).join.sub(/Error$/, '')
+        const_get("#{klass_name}Error", false)
+      rescue NameError
         WebDriverError
       end
 
       class WebDriverError < StandardError; end
 
-      class IndexOutOfBoundsError < WebDriverError; end # 1
-      class NoCollectionError < WebDriverError; end # 2
-      class NoStringError < WebDriverError; end # 3
-      class NoStringLengthError < WebDriverError; end # 4
-      class NoStringWrapperError < WebDriverError; end # 5
-      class NoSuchDriverError < WebDriverError; end # 6
-
       #
       # An element could not be located on the page using the given search parameters.
       #
 
-      class NoSuchElementError < WebDriverError; end # 7
+      class NoSuchElementError < WebDriverError; end
 
       #
       # A command to switch to a frame could not be satisfied because the frame could not be found.
       #
 
-      class NoSuchFrameError < WebDriverError; end # 8
+      class NoSuchFrameError < WebDriverError; end
 
       #
       # A command could not be executed because the remote end is not aware of it.
       #
 
-      class UnknownCommandError < WebDriverError; end # 9
+      class UnknownCommandError < WebDriverError; end
 
       #
       # A command failed because the referenced element is no longer attached to the DOM.
       #
 
-      class StaleElementReferenceError < WebDriverError; end # 10
+      class StaleElementReferenceError < WebDriverError; end
 
       #
-      # Raised to indicate that although an element is present on the DOM, it is not visible, and
-      # so is not able to be interacted with.
+      # A command failed because the referenced shadow root is no longer attached to the DOM.
       #
 
-      class ElementNotVisibleError < WebDriverError; end # 11
+      class DetachedShadowRootError < WebDriverError; end
 
       #
       # The target element is in an invalid state, rendering it impossible to interact with, for
       # example if you click a disabled element.
       #
 
-      class InvalidElementStateError < WebDriverError; end # 12
+      class InvalidElementStateError < WebDriverError; end
 
       #
       # An unknown error occurred in the remote end while processing the command.
       #
 
-      class UnknownError < WebDriverError; end # 13
-      class ExpectedError < WebDriverError; end # 14
+      class UnknownError < WebDriverError; end
 
       #
-      # An attempt was made to select an element that cannot be selected.
+      # An error occurred while executing JavaScript supplied by the user.
       #
 
-      class ElementNotSelectableError < WebDriverError; end # 15
-      class NoSuchDocumentError < WebDriverError; end # 16
+      class JavascriptError < WebDriverError; end
 
       #
-      # An error occurred while executing JavaScript supplied by the user.
+      # An operation did not complete before its timeout expired.
       #
 
-      class JavascriptError < WebDriverError; end # 17
-      class NoScriptResultError < WebDriverError; end # 18
+      class TimeoutError < WebDriverError; end
 
       #
-      # An error occurred while searching for an element by XPath.
+      # A command to switch to a window could not be satisfied because
+      # the window could not be found.
       #
 
-      class XPathLookupError < WebDriverError; end # 19
-      class NoSuchCollectionError < WebDriverError; end # 20
+      class NoSuchWindowError < WebDriverError; end
 
       #
-      # An operation did not complete before its timeout expired.
+      # The element does not have a shadow root.
       #
 
-      class TimeOutError < WebDriverError; end # 21
-
-      class NullPointerError < WebDriverError; end # 22
-      class NoSuchWindowError < WebDriverError; end # 23
+      class NoSuchShadowRootError < WebDriverError; end
 
       #
       # An illegal attempt was made to set a cookie under a different domain than the current page.
       #
 
-      class InvalidCookieDomainError < WebDriverError; end # 24
+      class InvalidCookieDomainError < WebDriverError; end
 
       #
       # A command to set a cookie's value could not be satisfied.
       #
 
-      class UnableToSetCookieError < WebDriverError; end # 25
-
-      #
-      # Raised when an alert dialog is present that has not been dealt with.
-      #
-      class UnhandledAlertError < WebDriverError; end # 26
+      class UnableToSetCookieError < WebDriverError; end
 
       #
       # An attempt was made to operate on a modal dialog when one was not open:
       #
-      #   * W3C dialect is NoSuchAlertError
-      #   * OSS dialect is NoAlertPresentError
-      #
-      # We want to allow clients to rescue NoSuchAlertError as a superclass for
-      # dialect-agnostic implementation, so NoAlertPresentError should inherit from it.
-      #
 
       class NoSuchAlertError < WebDriverError; end
-      class NoAlertPresentError < NoSuchAlertError; end # 27
 
       #
       # A script did not complete before its timeout expired.
       #
 
-      class ScriptTimeOutError < WebDriverError; end # 28
-
-      #
-      # The coordinates provided to an interactions operation are invalid.
-      #
-
-      class InvalidElementCoordinatesError < WebDriverError; end # 29
-
-      #
-      # Indicates that IME support is not available. This exception is rasied for every IME-related
-      # method call if IME support is not available on the machine.
-      #
-
-      class IMENotAvailableError < WebDriverError; end # 30
-
-      #
-      # Indicates that activating an IME engine has failed.
-      #
-
-      class IMEEngineActivationFailedError < WebDriverError; end # 31
+      class ScriptTimeoutError < WebDriverError; end
 
       #
       # Argument was an invalid selector.
       #
 
-      class InvalidSelectorError < WebDriverError; end # 32
+      class InvalidSelectorError < WebDriverError; end
 
       #
       # A new session could not be created.
       #
 
-      class SessionNotCreatedError < WebDriverError; end # 33
+      class SessionNotCreatedError < WebDriverError; end
 
       #
       # The target for mouse interaction is not in the browser's viewport and cannot be brought
       # into that viewport.
       #
 
-      class MoveTargetOutOfBoundsError < WebDriverError; end # 34
-
-      #
-      # Indicates that the XPath selector is invalid
-      #
-
-      class InvalidXpathSelectorError < WebDriverError; end
-      class InvalidXpathSelectorReturnTyperError < WebDriverError; end
+      class MoveTargetOutOfBoundsError < WebDriverError; end
 
       #
       # A command could not be completed because the element is not pointer or keyboard
@@ -271,113 +214,6 @@ module Selenium
 
       class UnsupportedOperationError < WebDriverError; end
 
-      # Aliases for OSS dialect.
-      ScriptTimeoutError  = Class.new(ScriptTimeOutError)
-      TimeoutError        = Class.new(TimeOutError)
-      NoAlertOpenError    = Class.new(NoAlertPresentError)
-
-      # Aliases for backwards compatibility.
-      ObsoleteElementError      = Class.new(StaleElementReferenceError)
-      UnhandledError            = Class.new(UnknownError)
-      UnexpectedJavascriptError = Class.new(JavascriptError)
-      ElementNotDisplayedError  = Class.new(ElementNotVisibleError)
-
-      #
-      # @api private
-      #
-
-      ERRORS = {
-        1 => IndexOutOfBoundsError,
-        2 => NoCollectionError,
-        3 => NoStringError,
-        4 => NoStringLengthError,
-        5 => NoStringWrapperError,
-        6 => NoSuchDriverError,
-        7 => NoSuchElementError,
-        8 => NoSuchFrameError,
-        9 => UnknownCommandError,
-        10 => StaleElementReferenceError,
-        11 => ElementNotVisibleError,
-        12 => InvalidElementStateError,
-        13 => UnknownError,
-        14 => ExpectedError,
-        15 => ElementNotSelectableError,
-        16 => NoSuchDocumentError,
-        17 => JavascriptError,
-        18 => NoScriptResultError,
-        19 => XPathLookupError,
-        20 => NoSuchCollectionError,
-        21 => TimeOutError,
-        22 => NullPointerError,
-        23 => NoSuchWindowError,
-        24 => InvalidCookieDomainError,
-        25 => UnableToSetCookieError,
-        26 => UnhandledAlertError,
-        27 => NoAlertPresentError,
-        28 => ScriptTimeOutError,
-        29 => InvalidElementCoordinatesError,
-        30 => IMENotAvailableError,
-        31 => IMEEngineActivationFailedError,
-        32 => InvalidSelectorError,
-        33 => SessionNotCreatedError,
-        34 => MoveTargetOutOfBoundsError,
-        # The following are W3C-specific errors,
-        # they don't really need error codes, we just make them up!
-        51 => InvalidXpathSelectorError,
-        52 => InvalidXpathSelectorReturnTyperError,
-        60 => ElementNotInteractableError,
-        61 => InvalidArgumentError,
-        62 => NoSuchCookieError,
-        63 => UnableToCaptureScreenError
-      }.freeze
-
-      DEPRECATED_ERRORS = {
-        IndexOutOfBoundsError: nil,
-        NoCollectionError: nil,
-        NoStringError: nil,
-        NoStringLengthError: nil,
-        NoStringWrapperError: nil,
-        NoSuchDriverError: nil,
-        ElementNotVisibleError: ElementNotInteractableError,
-        InvalidElementStateError: ElementNotInteractableError,
-        ElementNotSelectableError: ElementNotInteractableError,
-        ExpectedError: nil,
-        NoSuchDocumentError: nil,
-        NoScriptResultError: nil,
-        XPathLookupError: InvalidSelectorError,
-        NoSuchCollectionError: nil,
-        UnhandledAlertError: UnexpectedAlertOpenError,
-        NoAlertPresentError: NoSuchAlertError,
-        NoAlertOpenError: NoSuchAlertError,
-        ScriptTimeOutError: ScriptTimeoutError,
-        InvalidElementCoordinatesError: nil,
-        IMENotAvailableError: nil,
-        IMEEngineActivationFailedError: nil,
-        InvalidXpathSelectorError: InvalidSelectorError,
-        InvalidXpathSelectorReturnTyperError: InvalidSelectorError,
-        TimeOutError: TimeoutError,
-        ObsoleteElementError: StaleElementReferenceError,
-        UnhandledError: UnknownError,
-        UnexpectedJavascriptError: JavascriptError,
-        ElementNotDisplayedError: ElementNotInteractableError
-      }.freeze
-
-      DEPRECATED_ERRORS.keys.each do |oss_error|
-        remove_const oss_error
-      end
-
-      def self.const_missing(const_name)
-        super unless DEPRECATED_ERRORS.key?(const_name)
-        if DEPRECATED_ERRORS[const_name]
-          WebDriver.logger.deprecate("Selenium::WebDriver::Error::#{const_name}",
-                                     "#{DEPRECATED_ERRORS[const_name]} (ensure the driver supports W3C WebDriver specification)")
-          DEPRECATED_ERRORS[const_name]
-        else
-          WebDriver.logger.deprecate("Selenium::WebDriver::Error::#{const_name}")
-          WebDriverError
-        end
-      end
-
     end # Error
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/interactions/interaction.rb

@@ -26,7 +26,10 @@ module Selenium
         attr_reader :source
 
         def initialize(source)
-          raise TypeError, "#{source.type} is not a valid input type" unless Interactions::SOURCE_TYPES.include? source.type
+          unless Interactions::SOURCE_TYPES.include? source.type
+            raise TypeError,
+                  "#{source.type} is not a valid input type"
+          end
 
           @source = source
         end

data/lib/selenium/webdriver/common/interactions/key_actions.rb

@@ -22,7 +22,7 @@ module Selenium
     module KeyActions
       #
       # Performs a key press. Does not release the key - subsequent interactions may assume it's kept pressed.
-      # Note that the key is never released implicitly - either W3CActionBuilder#key_up(key) or W3CActionBuilder#release_actions
+      # Note that the key is never released implicitly - either ActionBuilder#key_up(key) or ActionBuilder#release_actions
       # must be called to release the key.
       #
       # @example Press a key
@@ -41,7 +41,7 @@ module Selenium
       #   @param [Element] element An optional element to move to first
       #   @param [Symbol, String] key The key to press
       #   @param [Symbol, String] device Optional name of the KeyInput device to press the key on
-      # @return [W3CActionBuilder] A self reference
+      # @return [ActionBuilder] A self reference
       #
 
       def key_down(*args, device: nil)
@@ -68,7 +68,7 @@ module Selenium
       #   @param [Element] element An optional element to move to first
       #   @param [Symbol, String] key The key to release
       #   @param [Symbol, String] device Optional name of the KeyInput device to release the key on
-      # @return [W3CActionBuilder] A self reference
+      # @return [ActionBuilder] A self reference
       #
 
       def key_up(*args, device: nil)
@@ -98,7 +98,7 @@ module Selenium
       #   @param [Element] element An optional element to move to first
       #   @param [Array, Symbol, String] keys The key(s) to press and release
       #   @param [Symbol, String] device Optional name of the KeyInput device to press and release the keys on
-      # @return [W3CActionBuilder] A self reference
+      # @return [ActionBuilder] A self reference
       #
 
       def send_keys(*args, device: nil)
@@ -130,7 +130,7 @@ module Selenium
       # @option args [Symbol, String] key The key to perform the action with
       # @param [Symbol] action The name of the key action to perform
       # @param [Symbol, String] device optional name of the KeyInput device to press the key on
-      # @return [W3CActionBuilder] A self reference
+      # @return [ActionBuilder] A self reference
       #
 
       def key_action(*args, action: nil, device: nil)

data/lib/selenium/webdriver/common/interactions/pointer_actions.rb

@@ -42,7 +42,7 @@ module Selenium
       # @param [Selenium::WebDriver::Interactions::PointerPress::BUTTONS] button the button to press.
       # @param [Symbol || String] device optional name of the PointerInput device with the button
       #   that will be pressed
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def pointer_down(button, device: nil)
@@ -59,7 +59,7 @@ module Selenium
       # @param [Selenium::WebDriver::Interactions::PointerPress::BUTTONS] button the button to release.
       # @param [Symbol || String] device optional name of the PointerInput device with the button that will
       #   be released
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def pointer_up(button, device: nil)
@@ -71,7 +71,7 @@ module Selenium
       # view and its location is calculated using getBoundingClientRect.  Then the
       # mouse is moved to optional offset coordinates from the element.
       #
-      # This is adapted to be backward compatible from non-W3C actions. W3C calculates offset from the center point
+      # This is adapted to be backward compatible from non- actions.  calculates offset from the center point
       # of the element
       #
       # Note that when using offsets, both coordinates need to be passed.
@@ -92,7 +92,7 @@ module Selenium
       # @param [Integer] down_by Optional offset from the top-left corner. A negative value means
       #   coordinates above the element.
       # @param [Symbol || String] device optional name of the PointerInput device to move.
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def move_to(element, right_by = nil, down_by = nil, device: nil)
@@ -129,7 +129,7 @@ module Selenium
       # @param [Integer] right_by horizontal offset. A negative value means moving the mouse left.
       # @param [Integer] down_by vertical offset. A negative value means moving the mouse up.
       # @param [Symbol || String] device optional name of the PointerInput device to move
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       # @raise [MoveTargetOutOfBoundsError] if the provided offset is outside the document's boundaries.
       #
 
@@ -156,7 +156,7 @@ module Selenium
       # @param [Integer] x horizontal position. Equivalent to a css 'left' value.
       # @param [Integer] y vertical position. Equivalent to a css 'top' value.
       # @param [Symbol || String] device optional name of the PointerInput device to move
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       # @raise [MoveTargetOutOfBoundsError] if the provided x or y value is outside the document's boundaries.
       #
 
@@ -183,7 +183,7 @@ module Selenium
       #
       # @param [Selenium::WebDriver::Element] element the element to move to and click.
       # @param [Symbol || String] device optional name of the PointerInput device to click with
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def click_and_hold(element = nil, device: nil)
@@ -202,7 +202,7 @@ module Selenium
       #
       # @param [Symbol || String] device optional name of the PointerInput device with the button
       #   that will be released
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def release(device: nil)
@@ -229,7 +229,7 @@ module Selenium
       # @param [Selenium::WebDriver::Element] element An optional element to click.
       # @param [Symbol || String] device optional name of the PointerInput device with the button
       #   that will be clicked
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def click(element = nil, device: nil)
@@ -258,7 +258,7 @@ module Selenium
       # @param [Selenium::WebDriver::Element] element An optional element to move to.
       # @param [Symbol || String] device optional name of the PointerInput device with the button
       #   that will be double-clicked
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def double_click(element = nil, device: nil)
@@ -286,7 +286,7 @@ module Selenium
       # @param [Selenium::WebDriver::Element] element An element to context click.
       # @param [Symbol || String] device optional name of the PointerInput device with the button
       #   that will be context-clicked
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def context_click(element = nil, device: nil)
@@ -312,7 +312,7 @@ module Selenium
       #   mouse at.
       # @param [Symbol || String] device optional name of the PointerInput device with the button
       #   that will perform the drag and drop
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def drag_and_drop(source, target, device: nil)
@@ -336,7 +336,7 @@ module Selenium
       # @param [Integer] down_by vertical move offset.
       # @param [Symbol || String] device optional name of the PointerInput device with the button
       #   that will perform the drag and drop
-      # @return [W3CActionBuilder] A self reference.
+      # @return [ActionBuilder] A self reference.
       #
 
       def drag_and_drop_by(source, right_by, down_by, device: nil)

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

@@ -30,14 +30,14 @@ module Selenium
 
       def as_json(*)
         {
-          'level' => level,
           'timestamp' => timestamp,
+          'level' => level,
           'message' => message
         }
       end
 
       def to_s
-        "#{level} #{time}: #{message}"
+        "#{time} #{level}: #{message}"
       end
 
       def time

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

@@ -40,13 +40,17 @@ module Selenium
                      :close,
                      :debug, :debug?,
                      :info, :info?,
-                     :warn, :warn?,
+                     :warn?,
                      :error, :error?,
                      :fatal, :fatal?,
                      :level, :level=
 
-      def initialize
-        @logger = create_logger($stdout)
+      #
+      # @param [String] progname Allow child projects to use Selenium's Logger pattern
+      #
+      def initialize(progname = 'Selenium')
+        @logger = create_logger(progname)
+        @ignored = []
       end
 
       #
@@ -73,28 +77,63 @@ module Selenium
         @logger.instance_variable_get(:@logdev).dev
       end
 
+      #
+      # Will not log the provided ID.
+      #
+      # @param [Array, Symbol] id
+      #
+      def ignore(id)
+        Array(id).each { |ignore| @ignored << ignore }
+      end
+
+      #
+      # Overrides default #warn to skip ignored messages by provided id
+      #
+      # @param [String] message
+      # @param [Symbol, Array<Sybmol>] id
+      # @yield see #deprecate
+      #
+      def warn(message, id: [])
+        id = Array(id)
+        return if (@ignored & id).any?
+
+        msg = id.empty? ? message : "[#{id.map(&:inspect).join(', ')}] #{message} "
+        msg += " #{yield}" if block_given?
+
+        @logger.warn { msg }
+      end
+
       #
       # Marks code as deprecated with/without replacement.
       #
       # @param [String] old
       # @param [String, nil] new
+      # @param [Symbol, Array<Symbol>] id
+      # @param [String] reference
+      # @yield appends additional message to end of provided template
       #
-      def deprecate(old, new = nil)
-        message = +"[DEPRECATION] #{old} is deprecated"
+      def deprecate(old, new = nil, id: [], reference: '', &block)
+        id = Array(id)
+        return if @ignored.include?(:deprecations) || (@ignored & id).any?
+
+        ids = id.empty? ? '' : "[#{id.map(&:inspect).join(', ')}] "
+
+        message = +"[DEPRECATION] #{ids}#{old} is deprecated"
         message << if new
                      ". Use #{new} instead."
                    else
-                     ' and will be removed in the next releases.'
+                     ' and will be removed in a future release.'
                    end
+        message << " See explanation for this deprecation: #{reference}." unless reference.empty?
 
-        warn message
+        warn message, &block
       end
 
       private
 
-      def create_logger(output)
-        logger = ::Logger.new(output)
-        logger.progname = 'Selenium'
+      def create_logger(name)
+        logger = ::Logger.new($stdout)
+        logger.progname = name
         logger.level = default_level
         logger.formatter = proc do |severity, time, progname, msg|
           "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
@@ -104,11 +143,7 @@ module Selenium
       end
 
       def default_level
-        if $DEBUG || ENV.key?('DEBUG')
-          :debug
-        else
-          :warn
-        end
+        $DEBUG || ENV.key?('DEBUG') ? :debug : :warn
       end
     end # Logger
   end # WebDriver