Remove OSS dialect errors

As a part of initiative to remove OSS dialect and support only W3C, all
the errors not compliant to specification  were removed. It seems like
server/grid passes through all the errors from drivers without altering
them (with the only exception of custom error when trying to upload
multiple files to server using POST /se/file - it's handled just fine
by Ruby bindings).

Author: p0deje

Diff for: rb/lib/selenium/webdriver/common/error.rb

@@ -20,188 +20,119 @@ module WebDriver
     module Error
 
       #
-      # Returns exception from code (Integer - OSS, String - W3C).
-      # @param [Integer, String, nil] code
-      #
-
-      def self.for_code(code)
-        case code
-        when nil, 0
-          nil
-        when Integer
-          ERRORS.fetch(code)
-        when String
-          klass_name = code.split(' ').map(&:capitalize).join.sub(/Error$/, '')
-          const_get("#{klass_name}Error", false)
-        end
-      rescue KeyError, NameError
+      # Returns exception from its string representation.
+      # @param [String, nil] error
+      #
+
+      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
-
-      #
-      # 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.
-      #
-
-      class ElementNotVisibleError < WebDriverError; end # 11
+      class StaleElementReferenceError < 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
-
-      #
-      # An attempt was made to select an element that cannot be selected.
-      #
-
-      class ElementNotSelectableError < WebDriverError; end # 15
-      class NoSuchDocumentError < WebDriverError; end # 16
+      class UnknownError < WebDriverError; end
 
       #
       # An error occurred while executing JavaScript supplied by the user.
       #
 
-      class JavascriptError < WebDriverError; end # 17
-      class NoScriptResultError < WebDriverError; end # 18
+      class JavascriptError < WebDriverError; end
 
       #
-      # An error occurred while searching for an element by XPath.
+      # An operation did not complete before its timeout expired.
       #
 
-      class XPathLookupError < WebDriverError; end # 19
-      class NoSuchCollectionError < WebDriverError; end # 20
+      class TimeOutError < WebDriverError; end
 
       #
-      # An operation did not complete before its timeout expired.
+      # A command to switch to a window could not be satisfied because
+      # the window could not be found.
       #
 
-      class TimeOutError < WebDriverError; end # 21
-
-      class NullPointerError < WebDriverError; end # 22
-      class NoSuchWindowError < WebDriverError; end # 23
+      class NoSuchWindowError < 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
@@ -269,66 +200,6 @@ class ElementClickInterceptedError < WebDriverError; end
 
       class UnsupportedOperationError < WebDriverError; end
 
-      # Aliases for OSS dialect.
-      ScriptTimeoutError  = ScriptTimeOutError
-      TimeoutError        = TimeOutError
-      NoAlertOpenError    = NoAlertPresentError
-
-      # Aliases for backwards compatibility.
-      ObsoleteElementError      = StaleElementReferenceError
-      UnhandledError            = UnknownError
-      UnexpectedJavascriptError = JavascriptError
-      ElementNotDisplayedError  = 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
-
     end # Error
   end # WebDriver
 end # Selenium

Diff for: rb/lib/selenium/webdriver/remote/response.rb

@@ -18,12 +18,13 @@
 module Selenium
   module WebDriver
     module Remote
+
+      #
       # @api private
-      class Response
-        STACKTRACE_KEY = 'stackTrace'.freeze
+      #
 
+      class Response
         attr_reader :code, :payload
-        attr_writer :payload
 
         def initialize(code, payload = nil)
           @code    = code
@@ -33,32 +34,16 @@ def initialize(code, payload = nil)
         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
@@ -72,12 +57,7 @@ def assert_ok
           raise Error::ServerError, self
         end
 
-        def add_backtrace(ex)
-          return unless error_payload.is_a?(Hash)
-
-          server_trace = error_payload[STACKTRACE_KEY] ||
-                         error_payload[STACKTRACE_KEY.downcase] ||
-                         error_payload.dig('value', STACKTRACE_KEY)
+        def add_backtrace(ex, server_trace)
           return unless server_trace
 
           backtrace = case server_trace
@@ -107,20 +87,14 @@ def backtrace_from_remote(server_trace)
           end.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 process_error
+          return unless self['value'].is_a?(Hash)
 
-        def value
-          return unless error_payload.is_a? Hash
-          @value ||= error_payload['value'] || error_payload['message']
+          [
+            self['value']['error'],
+            self['value']['message'],
+            self['value']['stacktrace']
+          ]
         end
       end # Response
     end # Remote

Diff for: rb/spec/integration/selenium/webdriver/element_spec.rb

@@ -75,7 +75,8 @@ module WebDriver
         expect(element.attribute('value')).to be_empty
 
         file = Tempfile.new('file-upload')
-        path = WebDriver::Platform.windows_path(file.path) if WebDriver::Platform.windows?
+        path = file.path
+        path = WebDriver::Platform.windows_path(path) if WebDriver::Platform.windows?
 
         element.send_keys path