selenium-webdriver 3.142.7 → 4.10.0

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

@@ -20,7 +20,10 @@
 module Selenium
   module WebDriver
     class Element
+      ELEMENT_KEY = 'element-6066-11e4-a52e-4f735466cecf'
+
       include SearchContext
+      include TakesScreenshot
 
       #
       # Creates a new Element
@@ -40,10 +43,10 @@ module Selenium
       def ==(other)
         other.is_a?(self.class) && ref == other.ref
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       def hash
-        @id.hash ^ @bridge.hash
+        [@id, @bridge].hash
       end
 
       #
@@ -89,13 +92,18 @@ module Selenium
       end
 
       #
-      # Get the value of a the given attribute of the element. Will return the current value, even if
-      # this has been modified after the page has been loaded. More exactly, this method will return
-      # the value of the given attribute, unless that attribute is not present, in which case the
-      # value of the property with the same name is returned. If neither value is set, nil is
-      # returned. The "style" attribute is converted as best can be to a text representation with a
-      # trailing semi-colon. The following are deemed to be "boolean" attributes, and will
-      # return either "true" or "false":
+      # This method attempts to provide the most likely desired current value for the attribute
+      # of the element, even when that desired value is actually a JavaScript property.
+      # It is implemented with a custom JavaScript atom. To obtain the exact value of the attribute or property,
+      # use #dom_attribute or #property methods respectively.
+      #
+      # More exactly, this method will return the value of the property with the given name,
+      # if it exists. If it does not, then the value of the attribute with the given name is returned.
+      # If neither exists, null is returned.
+      #
+      # The "style" attribute is converted as best can be to a text representation with a trailing semicolon.
+      #
+      # The following are deemed to be "boolean" attributes, and will return either "true" or "false":
       #
       # async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked,
       # defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate,
@@ -103,29 +111,73 @@ module Selenium
       # nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking,
       # selected, spellcheck, truespeed, willvalidate
       #
-      # Finally, the following commonly mis-capitalized attribute/property names are evaluated as
-      # expected:
+      # Finally, the following commonly mis-capitalized attribute/property names are evaluated as expected:
       #
-      # class, readonly
+      # When the value of "class" is requested, the "className" property is returned.
+      # When the value of "readonly" is requested, the "readOnly" property is returned.
       #
       # @param [String] name attribute name
       # @return [String, nil] attribute value
       #
+      # @see #dom_attribute
+      # @see #property
+      #
 
       def attribute(name)
         bridge.element_attribute self, name
       end
 
       #
-      # Get the value of a the given property with the same name of the element. If the value is not
-      # set, nil is returned.
+      # Gets the value of a declared HTML attribute of this element.
+      #
+      # As opposed to the #attribute method, this method
+      # only returns attributes declared in the element's HTML markup.
+      #
+      # If the attribute is not set, nil is returned.
+      #
+      # @param [String] name attribute name
+      # @return [String, nil] attribute value
+      #
+      # @see #attribute
+      # @see #property
+      #
+
+      def dom_attribute(name)
+        bridge.element_dom_attribute @id, name
+      end
+
+      #
+      # Gets the value of a JavaScript property of this element
+      # This will return the current value,
+      # even if this has been modified after the page has been loaded.
+      # If the value is not set, nil is returned.
       #
       # @param [String] name property name
       # @return [String, nil] property value
       #
 
       def property(name)
-        bridge.element_property self, name
+        bridge.element_property @id, name
+      end
+
+      #
+      # Gets the computed WAI-ARIA role of element
+      #
+      # @return [String]
+      #
+
+      def aria_role
+        bridge.element_aria_role @id
+      end
+
+      #
+      # Gets the computed WAI-ARIA label of element.
+      #
+      # @return [String]
+      #
+
+      def accessible_name
+        bridge.element_aria_label @id
       end
 
       #
@@ -155,7 +207,7 @@ module Selenium
       def send_keys(*args)
         bridge.send_keys_to_element @id, Keys.encode(args)
       end
-      alias_method :send_key, :send_keys
+      alias send_key send_keys
 
       #
       # If this element is a text entry element, this will clear the value. Has no effect on other
@@ -223,7 +275,7 @@ module Selenium
       def css_value(prop)
         bridge.element_value_of_css_property @id, prop
       end
-      alias_method :style, :css_value
+      alias style css_value
 
       #
       # Get the location of this element.
@@ -265,33 +317,42 @@ module Selenium
         bridge.element_size @id
       end
 
+      #
+      # Returns the shadow root of an element.
+      #
+      # @return [WebDriver::ShadowRoot]
+      #
+
+      def shadow_root
+        bridge.shadow_root @id
+      end
+
       #-------------------------------- sugar  --------------------------------
 
       #
       #   element.first(id: 'foo')
       #
 
-      alias_method :first, :find_element
+      alias first find_element
 
       #
       #   element.all(class: 'bar')
       #
 
-      alias_method :all, :find_elements
+      alias all find_elements
 
       #
       #   element['class'] or element[:class] #=> "someclass"
       #
-      alias_method :[], :attribute
+      alias [] attribute
 
-      #
-      # for SearchContext and execute_script
       #
       # @api private
+      # @see SearchContext
       #
 
       def ref
-        @id
+        [:element, @id]
       end
 
       #
@@ -312,12 +373,7 @@ module Selenium
       #
 
       def as_json(*)
-        key = if bridge.dialect == :w3c
-                'element-6066-11e4-a52e-4f735466cecf'
-              else
-                'ELEMENT'
-              end
-        @id.is_a?(Hash) ? @id : {key => @id}
+        @id.is_a?(Hash) ? @id : {ELEMENT_KEY => @id}
       end
 
       private
@@ -330,6 +386,10 @@ module Selenium
 
         tn == 'option' || (tn == 'input' && %w[radio checkbox].include?(type))
       end
+
+      def screenshot
+        bridge.element_screenshot(@id)
+      end
     end # Element
   end # WebDriver
 end # Selenium

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

@@ -19,191 +19,148 @@
 
 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
+      SUPPORT_MSG = 'For documentation on this error, please visit:'
+      ERROR_URL = 'https://www.selenium.dev/documentation/webdriver/troubleshooting/errors'
 
-      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
+      class WebDriverError < StandardError; end
 
       #
       # An element could not be located on the page using the given search parameters.
       #
 
-      class NoSuchElementError < WebDriverError; end # 7
+      class NoSuchElementError < WebDriverError
+        def initialize(msg = '')
+          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}#no-such-element-exception")
+        end
+      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
+        def initialize(msg = '')
+          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}#stale-element-reference-exception")
+        end
+      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
+        def initialize(msg = '')
+          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}#invalid-selector-exception")
+        end
+      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 +228,15 @@ 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
+      #
+      # Indicates that driver was not specified and could not be located.
+      #
 
-      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
+      class NoSuchDriverError < WebDriverError
+        def initialize(msg = '')
+          super("#{msg}; #{SUPPORT_MSG} #{ERROR_URL}/driver_location")
         end
       end
-
     end # Error
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/html5/shared_web_storage.rb

@@ -26,8 +26,8 @@ module Selenium
         def key?(key)
           keys.include? key
         end
-        alias_method :member?, :key?
-        alias_method :has_key?, :key?
+        alias member? key?
+        alias has_key? key?
 
         def fetch(key)
           return self[key] if key? key

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

@@ -22,8 +22,15 @@ require 'securerandom'
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Superclass for the input device sources
+      # Manages Array of Interaction instances for the device
+      #
+      # @api private
+      #
+
       class InputDevice
-        attr_reader :name, :actions
+        attr_reader :name, :actions, :type
 
         def initialize(name = nil)
           @name = name || SecureRandom.uuid
@@ -44,9 +51,8 @@ module Selenium
           add_action(Pause.new(self, duration))
         end
 
-        def no_actions? # Determine if only pauses are present
-          actions = @actions.reject { |action| action.type == Interaction::PAUSE }
-          actions.empty?
+        def encode
+          {type: type, id: name, actions: @actions.map(&:encode)} unless @actions.empty?
         end
       end # InputDevice
     end # Interactions

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

@@ -20,34 +20,24 @@
 module Selenium
   module WebDriver
     module Interactions
-      class Interaction
-        PAUSE = :pause
+      #
+      # Superclass for classes defining actions
+      # Do not initialize directly, only use subclass
+      #
+      # @api private
+      #
 
-        attr_reader :source
+      class Interaction
+        attr_reader :type
 
         def initialize(source)
-          raise TypeError, "#{source.type} is not a valid input type" unless Interactions::SOURCE_TYPES.include? source.type
-
-          @source = source
+          assert_source(source)
         end
-      end
 
-      class Pause < Interaction
-        def initialize(source, duration = nil)
-          super(source)
-          @duration = duration
+        def assert_source(_source)
+          raise NotImplementedError, 'subclass responsibility'
         end
-
-        def type
-          PAUSE
-        end
-
-        def encode
-          output = {type: type}
-          output[:duration] = (@duration * 1000).to_i if @duration
-          output
-        end
-      end # Interaction
+      end
     end # Interactions
   end # WebDriver
 end # Selenium