cuprite 0.6.0 → 0.7.0

data/lib/capybara/cuprite/node.rb

@@ -1,24 +1,27 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Capybara::Cuprite
   class Node < Capybara::Driver::Node
-    attr_reader :target_id, :node
+    attr_reader :node
 
-    def initialize(driver, target_id, node)
-      super(driver, self)
-      @target_id, @node = target_id, node
-    end
+    extend Forwardable
 
-    def browser
-      driver.browser
+    delegate %i(description) => :node
+    delegate %i(browser) => :driver
+
+    def initialize(driver, node)
+      super(driver, self)
+      @node = node
     end
 
     def command(name, *args)
-      browser.send(name, @node, *args)
-    rescue BrowserError => e
+      browser.send(name, node, *args)
+    rescue Ferrum::NodeNotFoundError => e
+      raise ObsoleteNode.new(self, e.response)
+    rescue Ferrum::BrowserError => e
       case e.message
-      when "No node with given id found"
-        raise ObsoleteNode.new(self, e.response)
       when "Cuprite.MouseEventFailed"
         raise MouseEventFailed.new(self, e.response)
       else
@@ -28,13 +31,7 @@ module Capybara::Cuprite
 
     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)
+        self.class.new(driver, parent)
       end
     end
 
@@ -46,6 +43,12 @@ module Capybara::Cuprite
       find(:css, selector)
     end
 
+    def find(method, selector)
+      command(:find_within, method, selector).map do |node|
+        self.class.new(driver, node)
+      end
+    end
+
     def all_text
       filter_text(command(:all_text))
     end
@@ -69,7 +72,8 @@ module Capybara::Cuprite
     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 (tag_name == "img" && name == "src") ||
+         (tag_name == "a" && name == "href")
         # if attribute exists get the property
         return command(:attribute, name) && command(:property, name)
       end
@@ -121,7 +125,7 @@ module Capybara::Cuprite
     end
 
     def tag_name
-      @tag_name ||= @node["nodeName"].downcase
+      @tag_name ||= description["nodeName"].downcase
     end
 
     def visible?
@@ -141,15 +145,15 @@ module Capybara::Cuprite
     end
 
     def click(keys = [], offset = {})
-      command(:click, keys, offset)
+      prepare_and_click(:left, __method__, keys, offset)
     end
 
     def right_click(keys = [], offset = {})
-      command(:right_click, keys, offset)
+      prepare_and_click(:right, __method__, keys, offset)
     end
 
     def double_click(keys = [], offset = {})
-      command(:double_click, keys, offset)
+      prepare_and_click(:double, __method__, keys, offset)
     end
 
     def hover
@@ -157,7 +161,7 @@ module Capybara::Cuprite
     end
 
     def drag_to(other)
-      command(:drag, other.node)
+      command(:drag, other)
     end
 
     def drag_by(x, y)
@@ -192,10 +196,7 @@ module Capybara::Cuprite
     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"]
+      node == other.native.node
     end
 
     def send_keys(*keys)
@@ -208,7 +209,7 @@ module Capybara::Cuprite
     end
 
     def inspect
-      %(#<#{self.class} @target_id=#{@target_id.inspect} @node=#{@node.inspect}>)
+      %(#<#{self.class} @node=#{@node.inspect}>)
     end
 
     # @api private
@@ -218,12 +219,17 @@ module Capybara::Cuprite
 
     # @api private
     def as_json(*)
-      # FIXME: Where this method is used and why attr is called id?
-      { ELEMENT: { target_id: @target_id, id: @node } }
+      # FIXME: Where is this method used and why attr is called id?
+      { ELEMENT: { node: node, id: node.node_id } }
     end
 
     private
 
+    def prepare_and_click(mode, name, keys, offset)
+      command(:before_click, name, keys, offset)
+      node.click(mode: mode, keys: keys, offset: offset)
+    end
+
     def filter_text(text)
       if Capybara::VERSION.to_f < 3
         Capybara::Helpers.normalize_whitespace(text.to_s)

data/lib/capybara/cuprite/page.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Capybara::Cuprite
+  module Page
+    MODAL_WAIT = ENV.fetch("CUPRITE_MODAL_WAIT", 0.05).to_f
+
+    def initialize(*args)
+      super
+      @accept_modal = []
+      @modal_messages = []
+    end
+
+    def set(node, value)
+      object_id = command("DOM.resolveNode", nodeId: node.node_id).dig("object", "objectId")
+      evaluate("_cuprite.set(arguments[0], arguments[1])", { "objectId" => object_id }, value)
+    end
+
+    def select(node, value)
+      evaluate_on(node: node, expression: "_cuprite.select(this, #{value})")
+    end
+
+    def trigger(node, event)
+      options = {}
+      options.merge!(wait: Ferrum::Mouse::CLICK_WAIT) if event.to_s == "click"
+      evaluate_on(node: node, expression: %(_cuprite.trigger(this, "#{event}")), **options)
+    end
+
+    def hover(node)
+      evaluate_on(node: node, expression: "_cuprite.scrollIntoViewport(this)")
+      x, y = find_position(node)
+      command("Input.dispatchMouseEvent", type: "mouseMoved", x: x, y: y)
+    end
+
+    def send_keys(node, keys)
+      if !evaluate_on(node: node, expression: %(_cuprite.containsSelection(this)))
+        before_click(node, "click")
+        node.click(mode: :left, keys: keys)
+      end
+
+      keyboard.type(keys)
+    end
+
+    def accept_confirm
+      @accept_modal << true
+    end
+
+    def dismiss_confirm
+      @accept_modal << false
+    end
+
+    def accept_prompt(modal_response)
+      @accept_modal << true
+      @modal_response = modal_response
+    end
+
+    def dismiss_prompt
+      @accept_modal << false
+    end
+
+    def find_modal(options)
+      start = Ferrum.monotonic_time
+      timeout = options.fetch(:wait) { session_wait_time }
+      expect_text = options[:text]
+      expect_regexp = expect_text.is_a?(Regexp) ? expect_text : Regexp.escape(expect_text.to_s)
+      not_found_msg = "Unable to find modal dialog"
+      not_found_msg += " with #{expect_text}" if expect_text
+
+      begin
+        modal_text = @modal_messages.shift
+        raise Capybara::ModalNotFound if modal_text.nil? || (expect_text && !modal_text.match(expect_regexp))
+      rescue Capybara::ModalNotFound => e
+        raise e, not_found_msg if Ferrum.timeout?(start, timeout)
+        sleep(MODAL_WAIT)
+        retry
+      end
+
+      modal_text
+    end
+
+    def reset_modals
+      @accept_modal = []
+      @modal_response = nil
+      @modal_messages = []
+    end
+
+    def before_click(node, name, keys = [], offset = {})
+      evaluate_on(node: node, expression: "_cuprite.scrollIntoViewport(this)")
+      x, y = find_position(node, offset[:x], offset[:y])
+      evaluate_on(node: node, expression: "_cuprite.mouseEventTest(this, '#{name}', #{x}, #{y})")
+      true
+    rescue Ferrum::JavaScriptError => e
+      raise MouseEventFailed.new(e.message) if e.class_name == "MouseEventFailed"
+    end
+
+    def switch_to_frame(handle)
+      case handle
+      when :parent
+        @frame_stack.pop
+      when :top
+        @frame_stack = []
+      else
+        @frame_stack << handle
+        inject_extensions
+      end
+    end
+
+    private
+
+    def prepare_page
+      super
+
+      intercept_request if !Array(@browser.url_whitelist).empty? ||
+                           !Array(@browser.url_blacklist).empty?
+
+      on(:request_intercepted) do |request, index, total|
+        if @browser.url_blacklist && !@browser.url_blacklist.empty?
+          if @browser.url_blacklist.any? { |r| request.match?(r) }
+            request.abort and return
+          else
+            request.continue and return
+          end
+        elsif @browser.url_whitelist && !@browser.url_whitelist.empty?
+          if @browser.url_whitelist.any? { |r| request.match?(r) }
+            request.continue and return
+          else
+            request.abort and return
+          end
+        elsif index + 1 < total
+          # There are other callbacks that may handle this request
+          next
+        else
+          # If there are no callbacks then just continue
+          request.continue
+        end
+      end
+
+      @client.on("Page.javascriptDialogOpening") do |params|
+        accept_modal = @accept_modal.last
+        if accept_modal == true || accept_modal == false
+          @accept_modal.pop
+          @modal_messages << params["message"]
+          options = { accept: accept_modal }
+          response = @modal_response || params["defaultPrompt"]
+          options.merge!(promptText: response) if response
+          command("Page.handleJavaScriptDialog", **options)
+        else
+          warn "Modal window has been opened, but you didn't wrap your code into (`accept_prompt` | `dismiss_prompt` | `accept_confirm` | `dismiss_confirm` | `accept_alert`), accepting by default"
+          options = { accept: true }
+          response = params["defaultPrompt"]
+          options.merge!(promptText: response) if response
+          command("Page.handleJavaScriptDialog", **options)
+        end
+      end
+    end
+
+    def find_position(node, *args)
+      x, y = node.find_position(*args)
+    rescue Ferrum::BrowserError => e
+      if e.message == "Could not compute content quads."
+        raise MouseEventFailed.new("MouseEventFailed: click, none, 0, 0")
+      else
+        raise
+      end
+    end
+  end
+end

data/lib/capybara/cuprite/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Cuprite
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuprite
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2019-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -31,39 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: websocket-driver
+  name: ferrum
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: cliver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: image_size
   requirement: !ruby/object:Gem::Requirement
@@ -202,25 +182,12 @@ files:
 - README.md
 - lib/capybara/cuprite.rb
 - lib/capybara/cuprite/browser.rb
-- lib/capybara/cuprite/browser/client.rb
-- lib/capybara/cuprite/browser/dom.rb
-- lib/capybara/cuprite/browser/frame.rb
-- lib/capybara/cuprite/browser/input.json
-- lib/capybara/cuprite/browser/input.rb
-- lib/capybara/cuprite/browser/javascripts/index.js
-- lib/capybara/cuprite/browser/net.rb
-- lib/capybara/cuprite/browser/page.rb
-- lib/capybara/cuprite/browser/process.rb
-- lib/capybara/cuprite/browser/runtime.rb
-- lib/capybara/cuprite/browser/targets.rb
-- lib/capybara/cuprite/browser/web_socket.rb
 - lib/capybara/cuprite/cookie.rb
 - lib/capybara/cuprite/driver.rb
 - lib/capybara/cuprite/errors.rb
-- lib/capybara/cuprite/network/error.rb
-- lib/capybara/cuprite/network/request.rb
-- lib/capybara/cuprite/network/response.rb
+- lib/capybara/cuprite/javascripts/index.js
 - lib/capybara/cuprite/node.rb
+- lib/capybara/cuprite/page.rb
 - lib/capybara/cuprite/version.rb
 homepage: https://github.com/machinio/cuprite
 licenses:
@@ -241,8 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Headless Chrome driver for Capybara

data/lib/capybara/cuprite/browser/client.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require "timeout"
-require "capybara/cuprite/browser/web_socket"
-
-module Capybara::Cuprite
-  class Browser
-    class Client
-      class IdError < RuntimeError; end
-
-      def initialize(browser, ws_url, allow_slowmo = true)
-        @command_id = 0
-        @subscribed = Hash.new { |h, k| h[k] = [] }
-        @browser, @allow_slowmo = browser, allow_slowmo
-        @commands = Queue.new
-        @ws = WebSocket.new(ws_url, @browser.logger)
-
-        @thread = Thread.new do
-          while message = @ws.messages.pop
-            method, params = message.values_at("method", "params")
-            if method
-              @subscribed[method].each { |b| b.call(params) }
-            else
-              @commands.push(message)
-            end
-          end
-
-          @commands.close
-        end
-      end
-
-      def command(method, params = {})
-        message = build_message(method, params)
-        sleep(@browser.slowmo) if !@browser.slowmo.nil? && @allow_slowmo
-        @ws.send_message(message)
-        message[:id]
-      end
-
-      def wait(id:)
-        message = Timeout.timeout(@browser.timeout, TimeoutError) { @commands.pop }
-        raise DeadBrowser unless message
-        raise IdError if message["id"] != id
-        error, response = message.values_at("error", "result")
-        raise BrowserError.new(error) if error
-        response
-      rescue IdError
-        retry
-      end
-
-      def subscribe(event, &block)
-        @subscribed[event] << block
-        true
-      end
-
-      def close
-        @ws.close
-        # Give a thread some time to handle a tail of messages
-        Timeout.timeout(1) { @thread.join }
-      rescue Timeout::Error
-        @thread.kill
-      end
-
-      private
-
-      def build_message(method, params)
-        { method: method, params: params }.merge(id: next_command_id)
-      end
-
-      def next_command_id
-        @command_id += 1
-      end
-    end
-  end
-end