cuprite 0.2.0

data/lib/capybara/cuprite/errors.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Cuprite
+    class Error < StandardError; end
+    class NoSuchWindowError < Error; end
+
+    class ClientError < Error
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+    end
+
+    class BrowserError < ClientError
+      def code
+        response["code"]
+      end
+
+      def data
+        response["data"]
+      end
+
+      def message
+        response["message"]
+      end
+    end
+
+    class JavaScriptError < ClientError
+      attr_reader :class_name, :message
+
+      def initialize(response)
+        super
+        @class_name, @message = response.values_at("className", "description")
+      end
+    end
+
+    class StatusFailError < ClientError
+      def message
+        "Request to #{response["url"]} failed to reach server, check DNS and/or server status"
+      end
+    end
+
+    class FrameNotFound < ClientError
+      def name
+        response["args"].first
+      end
+
+      def message
+        "The frame "#{name}" was not found."
+      end
+    end
+
+    class InvalidSelector < ClientError
+      def initialize(response, method, selector)
+        super(response)
+        @method, @selector = method, selector
+      end
+
+      def message
+        "Browser raised error trying to find #{@method}: #{@selector.inspect}"
+      end
+    end
+
+    class MouseEventFailed < ClientError
+      attr_reader :name, :selector, :position
+
+      def initialize(*)
+        super
+        data = /\A\w+: (\w+), (.+?), ([\d\.-]+), ([\d\.-]+)/.match(@response)
+        @name, @selector = data.values_at(1, 2)
+        @position = data.values_at(3, 4).map(&:to_f)
+      end
+
+
+      def message
+        "Firing a #{name} at coordinates [#{position.join(", ")}] failed. Cuprite detected " \
+          "another element with CSS selector \"#{selector}\" at this position. " \
+          "It may be overlapping the element you are trying to interact with. " \
+          "If you don't care about overlapping elements, try using node.trigger(\"#{name}\")."
+      end
+    end
+
+    class NodeError < ClientError
+      attr_reader :node
+
+      def initialize(node, response)
+        @node = node
+        super(response)
+      end
+    end
+
+    class ObsoleteNode < NodeError
+      def message
+        "The element you are trying to interact with is either not part of the DOM, or is " \
+        "not currently visible on the page (perhaps display: none is set). " \
+        "It is possible the element has been replaced by another element and you meant to interact with " \
+        "the new element. If so you need to do a new find in order to get a reference to the " \
+        "new element."
+      end
+    end
+
+    class KeyError < ::ArgumentError
+      def initialize(response)
+        super(response["args"].first)
+      end
+    end
+
+    class TimeoutError < Error
+      def message
+        "Timed out waiting for response. It's possible that this happened " \
+        "because something took a very long time (for example a page load " \
+        "was slow). If so, setting the Cuprite :timeout option to a higher " \
+        "value might help."
+      end
+    end
+
+    class ScriptTimeoutError < Error
+      def message
+        "Timed out waiting for evaluated script to resturn a value"
+      end
+    end
+
+    class DeadBrowser < Error
+      def initialize(message = "Chrome is dead")
+        super
+      end
+    end
+  end
+end

data/lib/capybara/cuprite/network/error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Capybara::Cuprite::Network
+  class Error
+    def initialize(data)
+      @data = data
+    end
+
+    def id
+      @data["networkRequestId"]
+    end
+
+    def url
+      @data["url"]
+    end
+
+    def description
+      @data["text"]
+    end
+
+    def time
+      @time ||= Time.strptime(@data["timestamp"].to_s, "%s")
+    end
+  end
+end

data/lib/capybara/cuprite/network/request.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "time"
+
+module Capybara::Cuprite::Network
+  class Request
+    attr_accessor :response, :error
+
+    def initialize(data)
+      @data = data
+    end
+
+    def id
+      @data["id"]
+    end
+
+    def url
+      @data["url"]
+    end
+
+    def method
+      @data["method"]
+    end
+
+    def headers
+      @data["headers"]
+    end
+
+    def time
+      @time ||= Time.strptime(@data["time"].to_s, "%s")
+    end
+  end
+end

data/lib/capybara/cuprite/network/response.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Capybara::Cuprite::Network
+  class Response
+    def initialize(data)
+      @data = data
+    end
+
+    def id
+      @data["id"]
+    end
+
+    def url
+      @data["url"]
+    end
+
+    def status
+      @data["status"]
+    end
+
+    def status_text
+      @data["statusText"]
+    end
+
+    def headers
+      @data["headers"]
+    end
+
+    # FIXME: didn't check if we have it on redirect response
+    def redirect_url
+      @data["redirectURL"]
+    end
+
+    def body_size
+      @body_size ||= @data.dig("headers", "Content-Length").to_i
+    end
+
+    def content_type
+      @content_type ||= @data.dig("headers", "contentType").sub(/;.*\z/, "")
+    end
+  end
+end

data/lib/capybara/cuprite/node.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+module Capybara::Cuprite
+  class Node < Capybara::Driver::Node
+    attr_reader :target_id, :node
+
+    def initialize(driver, target_id, node)
+      super(driver, self)
+      @target_id, @node = target_id, node
+    end
+
+    def browser
+      driver.browser
+    end
+
+    def command(name, *args)
+      browser.send(name, @node, *args)
+    rescue BrowserError => e
+      case e.message
+      when "Cuprite.ObsoleteNode"
+        raise ObsoleteNode.new(self, e.response)
+      when "Cuprite.MouseEventFailed"
+        raise MouseEventFailed.new(self, e.response)
+      else
+        raise
+      end
+    end
+
+    def parents
+      command(:parents).map do |parent|
+        self.class.new(driver, parent["target_id"], parent["node"])
+      end
+    end
+
+    def find(method, selector)
+      command(:find_within, method, selector).map do |node|
+        self.class.new(driver, @target_id, node)
+      end
+    end
+
+    def find_xpath(selector)
+      find(:xpath, selector)
+    end
+
+    def find_css(selector)
+      find(:css, selector)
+    end
+
+    def all_text
+      filter_text(command(:all_text))
+    end
+
+    def visible_text
+      if Capybara::VERSION.to_f < 3.0
+        filter_text(command(:visible_text))
+      else
+        command(:visible_text).to_s
+                              .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
+                              .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+                              .gsub(/\n+/, "\n")
+                              .tr("\u00a0", " ")
+      end
+    end
+
+    def property(name)
+      command(:property, name)
+    end
+
+    def [](name)
+      # Although the attribute matters, the property is consistent. Return that in
+      # preference to the attribute for links and images.
+      if ((tag_name == "img") && (name == "src")) || ((tag_name == "a") && (name == "href"))
+        # if attribute exists get the property
+        return command(:attribute, name) && command(:property, name)
+      end
+
+      value = property(name)
+      value = command(:attribute, name) if value.nil? || value.is_a?(Hash)
+
+      value
+    end
+
+    def attributes
+      command(:attributes)
+    end
+
+    def value
+      command(:value)
+    end
+
+    def set(value, options = {})
+      warn "Options passed to Node#set but Cuprite doesn't currently support any - ignoring" unless options.empty?
+
+      if tag_name == "input"
+        case self[:type]
+        when "radio"
+          click
+        when "checkbox"
+          click if value != checked?
+        when "file"
+          files = value.respond_to?(:to_ary) ? value.to_ary.map(&:to_s) : value.to_s
+          command(:select_file, files)
+        else
+          command(:set, value.to_s)
+        end
+      elsif tag_name == "textarea"
+        command(:set, value.to_s)
+      elsif self[:isContentEditable]
+        command(:delete_text)
+        send_keys(value.to_s)
+      end
+    end
+
+    def select_option
+      command(:select, true)
+    end
+
+    def unselect_option
+      command(:select, false) ||
+        raise(Capybara::UnselectNotAllowed, "Cannot unselect option from single select box.")
+    end
+
+    def tag_name
+      @tag_name ||= @node["nodeName"].downcase
+    end
+
+    def visible?
+      command(:visible?)
+    end
+
+    def checked?
+      self[:checked]
+    end
+
+    def selected?
+      !!self[:selected]
+    end
+
+    def disabled?
+      command(:disabled?)
+    end
+
+    def click(keys = [], offset = {})
+      command(:click, keys, offset)
+    end
+
+    def right_click(keys = [], offset = {})
+      command(:right_click, keys, offset)
+    end
+
+    def double_click(keys = [], offset = {})
+      command(:double_click, keys, offset)
+    end
+
+    def hover
+      command(:hover)
+    end
+
+    def drag_to(other)
+      command(:drag, other.node)
+    end
+
+    def drag_by(x, y)
+      command(:drag_by, x, y)
+    end
+
+    def trigger(event)
+      command(:trigger, event)
+    end
+
+    def ==(other)
+      # We compare backendNodeId because once nodeId is sent to frontend backend
+      # never returns same nodeId sending 0. In other words frontend is
+      # responsible for keeping track of node ids.
+      @target_id == other.target_id && @node["backendNodeId"] == other.node["backendNodeId"]
+    end
+
+    def send_keys(*keys)
+      command(:send_keys, keys)
+    end
+    alias_method :send_key, :send_keys
+
+    def path
+      command(:path)
+    end
+
+    def inspect
+      %(#<#{self.class} @target_id=#{@target_id.inspect} @node=#{@node.inspect}>)
+    end
+
+    # @api private
+    def to_json(*)
+      JSON.generate(as_json)
+    end
+
+    # @api private
+    def as_json(*)
+      # FIXME: Where this method is used and why attr is called id?
+      { ELEMENT: { target_id: @target_id, id: @node } }
+    end
+
+    private
+
+    def filter_text(text)
+      if Capybara::VERSION.to_f < 3
+        Capybara::Helpers.normalize_whitespace(text.to_s)
+      else
+        text.gsub(/[\u200b\u200e\u200f]/, "")
+            .gsub(/[\ \n\f\t\v\u2028\u2029]+/, " ")
+            .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
+            .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+            .tr("\u00a0", " ")
+      end
+    end
+  end
+end