cuprite 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf587bbc10c2a41b7b147aef2a354a557413ee32a5b692a97c47a48be92aa2ca
-  data.tar.gz: 77e2b75819381d839138b1b1a6107b8b6851312086aaafe60a00c4ada722bd52
+  metadata.gz: d183c86ecad6aaaf681364bda5ee919e5952a2b3a8d55cad40b3a6cec57ff26f
+  data.tar.gz: cccf18bb4e24c66262a0a6302ea7611e3aa1897c9b2442c24cfbc0feedfb46b1
 SHA512:
-  metadata.gz: 48b56880683350d80c332badd609be3af6ccbe7806ea60b81e4db4cd6bf2501716d5e140d65ab84e74c71376b585097fe8e19d4d139e4bb631d214feb354fcf3
-  data.tar.gz: 47ce6354f72acf22ca8f337b667481eddc5cb4ad0910b8e96a0a80eb7551fe8d33468c8664ab49b165969fdc1d8f11e5c607f597c354a90624fb7683ed2af5f5
+  metadata.gz: '056827d707f4e8388aa2350b53791d060f7c30872d5930311606d750822483a667b5d74093e03217cfa3a342c4fe8cd5d5b766fd3155de9c5ff0c6da6b335a17'
+  data.tar.gz: 389f981e6ae4b3a06cc3babbb70b942b0e2a8844bee690fc508af111bab65b333777f7b330554d2ae0f43abae918e3395ff1ae306b17df015efe94eaebd8c0e8

data/README.md

@@ -5,8 +5,7 @@
 Cuprite is a pure Ruby driver (read as _no_ Java/Selenium/WebDriver/ChromeDriver
 requirement) for [Capybara](https://github.com/teamcapybara/capybara). It allows
 you to run your Capybara tests on a headless [Chrome](https://www.google.com/chrome/)
-or [Chromium](https://www.chromium.org/) browser while the latter is prefered
-for now because we work with tip-of-tree [protocol](https://chromedevtools.github.io/devtools-protocol/).
+or [Chromium](https://www.chromium.org/) browser by [CDP protocol](https://chromedevtools.github.io/devtools-protocol/).
 
 The emphasis was made on raw CDP protocol because Headless Chrome allows you to
 do so many cool things that are barely supported by WebDriver because it should
@@ -21,8 +20,8 @@ Poltergest/PhantomJS:
 
 ```
 cuprite:
-Finished in 8 minutes 44 seconds (files took 0.97501 seconds to load)
-1531 examples, 0 failures, 112 pending
+Finished in 8 minutes 58 seconds (files took 0.89959 seconds to load)
+1555 examples, 0 failures, 27 pending
 
 selenium headless chrome:
 Finished in 9 minutes 13 seconds (files took 0.97749 seconds to load)
@@ -39,11 +38,6 @@ Finished in 11 minutes 49 seconds (files took 0.54019 seconds to load)
 gem "cuprite"
 ```
 
-Though we recommend using github until we release 1.0:
-``` ruby
-gem "cuprite", github: "machinio/cuprite"
-```
-
 and run `bundle install`.
 
 In your test setup add:
@@ -137,13 +131,25 @@ end
 
 `options` is a hash of options. The following options are supported:
 
-* `:browser` (Hash) - Hash of options to be passed to chrome process:
-  * `:path` (String) - Path to chrome binary, you can also set ENV variable as
-    `BROWSER_PATH=some/path/chrome bundle exec rspec`
-  * `:window_size` (Array) - The dimensions of the browser window in which to
+* `:browser_path` (String) - Path to chrome binary, you can also set ENV
+    variable as `BROWSER_PATH=some/path/chrome bundle exec rspec`.
+* `:headless` (Boolean) - Set browser as headless or not, `true` by default.
+* `:logger` (Object responding to `puts`) - When present, debug output is
+    written to this object.
+* `:timeout` (Numeric) - The number of seconds we'll wait for a response when
+    communicating with browser. Default is 30.
+* `:js_errors` (Boolean) - When true, JavaScript errors get re-raised in Ruby.
+* `:window_size` (Array) - The dimensions of the browser window in which to
     test, expressed as a 2-element array, e.g. [1024, 768]. Default: [1024, 768]
-  * `:port` (Integer) - Remote debugging port for headless Chrome
-  * `:host` (String) - Remote debugging address for headless Chrome
+* `:browser_options` (Hash) - Additional command line options,
+    [see them all](https://peter.sh/experiments/chromium-command-line-switches/)
+    e.g. `{ "ignore-certificate-errors" => nil }`
+* `:extensions` (Array) - An array of JS files to be preloaded into the browser
+* `:port` (Integer) - Remote debugging port for headless Chrome
+* `:host` (String) - Remote debugging address for headless Chrome
+* `:url_blacklist` (Array) - array of strings to match against requested URLs
+* `:url_whitelist` (Array) - array of strings to match against requested URLs
+
 
 ### URL Blacklisting & Whitelisting ###
 Cuprite supports URL blacklisting, which allows you to prevent scripts from

data/lib/capybara/cuprite/browser.rb

@@ -34,12 +34,13 @@ module Capybara::Cuprite
                 go_back go_forward find_modal accept_confirm dismiss_confirm
                 accept_prompt dismiss_prompt reset_modals) => :page
 
-    attr_reader :process, :logger
+    attr_reader :process, :logger, :js_errors
     attr_writer :timeout
 
     def initialize(options = nil)
       @options = Hash(options)
       @logger, @timeout = @options.values_at(:logger, :timeout)
+      @js_errors = @options.fetch(:js_errors, false)
 
       if ENV["CUPRITE_DEBUG"]
         STDOUT.sync = true
@@ -79,16 +80,7 @@ module Capybara::Cuprite
     end
 
     def visible_text(node)
-      begin
-        evaluate_on(node: node, expr: "_cuprite.visibleText(this)")
-      rescue BrowserError => e
-        # FIXME: ObsoleteNode first arg is node, so it should be in node class
-        if e.message == "No node with given id found"
-          raise ObsoleteNode.new(self, e.response)
-        end
-
-        raise
-      end
+      evaluate_on(node: node, expr: "_cuprite.visibleText(this)")
     end
 
     def delete_text(node)
@@ -96,32 +88,36 @@ module Capybara::Cuprite
     end
 
     def select_file(node, value)
-      raise NotImplementedError
+      page.command("DOM.setFileInputFiles", nodeId: node["nodeId"], files: Array(value))
     end
 
-    def render(path, _options = {})
-      # check_render_options!(options)
-      # options[:full] = !!options[:full]
-      data = Base64.decode64(render_base64)
-      File.open(path.to_s, "wb") { |f| f.write(data) }
+    def render(path, options = {})
+      format = options.delete(:format)
+      options = options.merge(path: path)
+      bin = Base64.decode64(render_base64(format, options))
+      File.open(path.to_s, "wb") { |f| f.write(bin) }
     end
 
-    def render_base64(format = "png", _options = {})
-      # check_render_options!(options)
-      # options[:full] = !!options[:full]
-      page.command("Page.captureScreenshot", format: format)["data"]
+    def render_base64(format, options = {})
+      options = render_options(format, options)
+
+      if options[:format].to_s == "pdf"
+        options = {}
+        options[:paperWidth] = @paper_size[:width].to_f if @paper_size
+        options[:paperHeight] = @paper_size[:height].to_f if @paper_size
+        options[:scale] = @zoom_factor if @zoom_factor
+        page.command("Page.printToPDF", **options)
+      else
+        page.command("Page.captureScreenshot", **options)
+      end.fetch("data")
     end
 
     def set_zoom_factor(zoom_factor)
-      raise NotImplementedError
+      @zoom_factor = zoom_factor.to_f
     end
 
     def set_paper_size(size)
-      raise NotImplementedError
-    end
-
-    def set_proxy(ip, port, type, user, password)
-      raise NotImplementedError
+      @paper_size = size
     end
 
     def headers=(headers)
@@ -198,6 +194,7 @@ module Capybara::Cuprite
 
     def reset
       @headers = {}
+      @zoom_factor = nil
       targets.reset
     end
 
@@ -216,6 +213,10 @@ module Capybara::Cuprite
       command("Browser.crash")
     end
 
+    def browser_error
+      page.evaluate("_cuprite.browserError()")
+    end
+
     def command(*args)
       id = @client.command(*args)
       @client.wait(id: id)
@@ -236,10 +237,36 @@ module Capybara::Cuprite
       @client = Client.new(self, @process.ws_url)
     end
 
-    def check_render_options!(options)
-      return if !options[:full] || !options.key?(:selector)
-      warn "Ignoring :selector in #render since :full => true was given at #{caller(1..1).first}"
-      options.delete(:selector)
+    def render_options(format, opts)
+      options = {}
+
+      format ||= File.extname(opts[:path]).delete(".") || "png"
+      format = "jpeg" if format == "jpg"
+      raise "Not supported format: #{format}. jpeg | png | pdf" if format !~ /jpeg|png|pdf/i
+      options.merge!(format: format)
+
+      options.merge!(quality: opts[:quality] ? opts[:quality] : 75) if format == "jpeg"
+
+      warn "Ignoring :selector in #render since full: true was given at #{caller(1..1).first}" if !!opts[:full] && opts[:selector]
+
+      if !!opts[:full]
+        width, height = page.evaluate("[document.documentElement.offsetWidth, document.documentElement.offsetHeight]")
+        options.merge!(clip: { x: 0, y: 0, width: width, height: height, scale: @zoom_factor || 1.0 }) if width > 0 && height > 0
+      elsif opts[:selector]
+        rect = page.evaluate("document.querySelector('#{opts[:selector]}').getBoundingClientRect()")
+        options.merge!(clip: { x: rect["x"], y: rect["y"], width: rect["width"], height: rect["height"], scale: @zoom_factor || 1.0 })
+      end
+
+      if @zoom_factor
+        if !options[:clip]
+          width, height = page.evaluate("[document.documentElement.clientWidth, document.documentElement.clientHeight]")
+          options[:clip] = { x: 0, y: 0, width: width, height: height }
+        end
+
+        options[:clip].merge!(scale: @zoom_factor)
+      end
+
+      options
     end
 
     def find_all(method, selector, within = nil)

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

@@ -75,8 +75,8 @@ module Capybara::Cuprite
         evaluate_on(node: node, expr: %(_cuprite.trigger(this, "#{event}")), **options)
       end
 
-      def scroll_to(left, top)
-        raise NotImplementedError
+      def scroll_to(top, left)
+        execute("window.scrollTo(#{top}, #{left})")
       end
 
       def send_keys(node, keys)
@@ -171,7 +171,16 @@ module Capybara::Cuprite
       end
 
       def get_content_quads(node)
-        result = command("DOM.getContentQuads", nodeId: node["nodeId"])
+        begin
+          result = command("DOM.getContentQuads", nodeId: node["nodeId"])
+        rescue BrowserError => e
+          if e.message == "Could not compute content quads."
+            raise MouseEventFailed.new("MouseEventFailed: click, none, 0, 0")
+          else
+            raise
+          end
+        end
+
         raise "Node is either not visible or not an HTMLElement" if result["quads"].size == 0
 
         # FIXME: Case when a few quads returned

data/lib/capybara/cuprite/browser/javascripts/index.js

@@ -24,7 +24,7 @@ class Cuprite {
           results.push(xpath.snapshotItem(i));
         }
       } else {
-        results = within.querySelectorAll(selector);
+        results = Array.from(within.querySelectorAll(selector));
       }
 
       return results;
@@ -441,6 +441,10 @@ class Cuprite {
   }
 
   isCyclic(object) {
+    if (Array.isArray(object) && object.every(n => n instanceof Node)) {
+      return false;
+    }
+
     try {
       this._json.stringify(object);
       return false;
@@ -448,6 +452,11 @@ class Cuprite {
       return true;
     }
   }
+
+  // This command is purely for testing error handling
+  browserError() {
+    throw new Error("zomg");
+  }
 }
 
 window._cuprite = new Cuprite;

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

@@ -90,11 +90,17 @@ module Capybara::Cuprite
         @client.close
       end
 
-      def resize(width, height)
+      def resize(width: nil, height: nil, fullscreen: false)
         result = @browser.command("Browser.getWindowForTarget", targetId: @target_id)
         @window_id, @bounds = result.values_at("windowId", "bounds")
-        @browser.command("Browser.setWindowBounds", windowId: @window_id, bounds: { width: width, height: height })
-        command("Emulation.setDeviceMetricsOverride", width: width, height: height, deviceScaleFactor: 1, mobile: false)
+
+        if fullscreen
+          @browser.command("Browser.setWindowBounds", windowId: @window_id, bounds: { windowState: "fullscreen" })
+        else
+          @browser.command("Browser.setWindowBounds", windowId: @window_id, bounds: { windowState: "normal" })
+          @browser.command("Browser.setWindowBounds", windowId: @window_id, bounds: { width: width, height: height, windowState: "normal" })
+          command("Emulation.setDeviceMetricsOverride", width: width, height: height, deviceScaleFactor: 1, mobile: false)
+        end
       end
 
       def refresh
@@ -182,7 +188,7 @@ module Capybara::Cuprite
           @wait = 0
         end
 
-        response = @client.wait(id: id)
+        @client.wait(id: id)
       end
 
       private
@@ -196,16 +202,27 @@ module Capybara::Cuprite
           end
         end
 
+        if @browser.js_errors
+          @client.subscribe("Runtime.exceptionThrown") do |params|
+            Thread.main.raise JavaScriptError.new(params.dig("exceptionDetails", "exception"))
+          end
+        end
+
         @client.subscribe("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 }
-            default = params["defaultPrompt"]
             response = @modal_response || params["defaultPrompt"]
             options.merge!(promptText: response) if response
             @client.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
+            @client.command("Page.handleJavaScriptDialog", **options)
           end
         end
 
@@ -280,6 +297,9 @@ module Capybara::Cuprite
         command("Runtime.enable")
         command("Log.enable")
         command("Network.enable")
+        if Capybara.save_path
+          command("Page.setDownloadBehavior", behavior: "allow", downloadPath: Capybara.save_path)
+        end
 
         @browser.extensions.each do |extension|
           @client.command("Page.addScriptToEvaluateOnNewDocument", source: extension)

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

@@ -53,20 +53,27 @@ module Capybara::Cuprite
       end
 
       def initialize(options)
-        @options = options.fetch(:browser, {})
+        @options = {}
 
-        detect_browser_path
+        detect_browser_path(options)
 
         window_size = options.fetch(:window_size, [1024, 768])
-        @options = @options.merge("window-size" => window_size.join(","))
+        @options.merge!("window-size" => window_size.join(","))
 
         port = options.fetch(:port, BROWSER_PORT)
-        @options = @options.merge("remote-debugging-port" => port)
+        @options.merge!("remote-debugging-port" => port)
 
         host = options.fetch(:host, BROWSER_HOST)
-        @options = @options.merge("remote-debugging-address" => host)
+        @options.merge!("remote-debugging-address" => host)
 
         @options = DEFAULT_OPTIONS.merge(@options)
+
+        unless options.fetch(:headless, true)
+          @options.delete("headless")
+          @options.delete("disable-gpu")
+        end
+
+        @options.merge!(options.fetch(:browser_options, {}))
       end
 
       def start
@@ -99,15 +106,24 @@ module Capybara::Cuprite
         start
       end
 
-      def detect_browser_path
-        exe = @options[:path] || BROWSER_PATH
-        if RUBY_PLATFORM.include?('darwin')
-          exe ||= "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
-          @path = exe if File.exist?(exe)
-        else
-          exe ||= "chrome"
-          @path = Cliver.detect(exe) || Cliver.detect("google-chrome")
-        end
+      private
+
+      def detect_browser_path(options)
+        @path =
+          options[:browser_path] ||
+          BROWSER_PATH || (
+            if RUBY_PLATFORM.include?('darwin')
+              [
+                "/Applications/Chromium.app/Contents/MacOS/Chromium",
+                "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
+              ].find { |path| File.exist?(path) }
+            else
+              %w[chromium google-chrome-unstable google-chrome-beta google-chrome chrome].reduce(nil) do |path, exe|
+                path = Cliver.detect(exe)
+                break path if path
+              end
+            end
+          )
 
         unless @path
           message = "Could not find an executable `#{exe}`. Try to make it " \
@@ -117,8 +133,6 @@ module Capybara::Cuprite
         end
       end
 
-      private
-
       def redirect_stdout(write_io)
         if Capybara::Cuprite.mri?
           yield

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

@@ -76,8 +76,19 @@ module Capybara::Cuprite
           options = options.merge(executionContextId: execution_context_id)
         end
 
-        command("Runtime.callFunctionOn", **options)
-          .dig("result").tap { |r| handle_error(r) }
+        begin
+          attempts ||= 1
+          response = command("Runtime.callFunctionOn", **options)
+          response.dig("result").tap { |r| handle_error(r) }
+        rescue BrowserError => e
+          case e.message
+          when "No node with given id found", "Could not find node with given id", "Cannot find context with specified id"
+            sleep 0.1
+            attempts += 1
+            options = options.merge(executionContextId: execution_context_id)
+            retry if attempts <= 3
+          end
+        end
       end
 
       # FIXME: We should have a central place to handle all type of errors

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

@@ -107,7 +107,14 @@ module Capybara::Cuprite
       end
 
       def targets
-        @browser.command("Target.getTargets")["targetInfos"]
+        attempts ||= 1
+        # Targets cannot be empty the must be at least one default target.
+        targets = @browser.command("Target.getTargets")["targetInfos"]
+        raise TypeError if targets.empty?
+        targets
+      rescue TypeError
+        attempts += 1
+        retry if attempts < 3
       end
 
       def default?(target)

data/lib/capybara/cuprite/driver.rb

@@ -14,7 +14,7 @@ module Capybara::Cuprite
 
     def initialize(app, options = {})
       @app     = app
-      @options = options.freeze
+      @options = options
       @started = false
     end
 
@@ -152,7 +152,7 @@ module Capybara::Cuprite
     end
 
     def resize(width, height)
-      browser.resize(width, height)
+      browser.resize(width: width, height: height)
     end
     alias_method :resize_window, :resize
 
@@ -172,6 +172,12 @@ module Capybara::Cuprite
       end
     end
 
+    def fullscreen_window(handle)
+      within_window(handle) do
+        browser.resize(fullscreen: true)
+      end
+    end
+
     def scroll_to(left, top)
       browser.scroll_to(left, top)
     end
@@ -184,8 +190,11 @@ module Capybara::Cuprite
       browser.clear_network_traffic
     end
 
-    def set_proxy(ip, port, type = "http", user = nil, password = nil)
-      browser.set_proxy(ip, port, type, user, password)
+    # FIXME: check user/pass proxy auth
+    def set_proxy(ip, port, type = "http", user = nil, password = nil, bypass = nil)
+      @options[:browser] ||= {}
+      @options[:browser].merge!("proxy-server" => "#{type}=#{ip}:#{port}")
+      @options[:browser].merge!("proxy-bypass-list" => bypass) if bypass
     end
 
     def headers

data/lib/capybara/cuprite/node.rb

@@ -17,7 +17,7 @@ module Capybara::Cuprite
       browser.send(name, @node, *args)
     rescue BrowserError => e
       case e.message
-      when "Cuprite.ObsoleteNode"
+      when "No node with given id found"
         raise ObsoleteNode.new(self, e.response)
       when "Cuprite.MouseEventFailed"
         raise MouseEventFailed.new(self, e.response)
@@ -168,6 +168,29 @@ module Capybara::Cuprite
       command(:trigger, event)
     end
 
+    def scroll_to(element, location, position = nil)
+      if element.is_a?(Node)
+        scroll_element_to_location(element, location)
+      elsif location.is_a?(Symbol)
+        scroll_to_location(location)
+      else
+        scroll_to_coords(*position)
+      end
+      self
+    end
+
+    def scroll_by(x, y)
+      driver.execute_script <<~JS, self, x, y
+        var el = arguments[0];
+        if (el.scrollBy){
+          el.scrollBy(arguments[1], arguments[2]);
+        } else {
+          el.scrollTop = el.scrollTop + arguments[2];
+          el.scrollLeft = el.scrollLeft + arguments[1];
+        }
+      JS
+    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
@@ -212,5 +235,50 @@ module Capybara::Cuprite
             .tr("\u00a0", " ")
       end
     end
+
+    def scroll_element_to_location(element, location)
+      scroll_opts = case location
+      when :top
+        'true'
+      when :bottom
+        'false'
+      when :center
+        "{behavior: 'instant', block: 'center'}"
+      else
+        raise ArgumentError, "Invalid scroll_to location: #{location}"
+      end
+      driver.execute_script <<~JS, element
+        arguments[0].scrollIntoView(#{scroll_opts})
+      JS
+    end
+
+    def scroll_to_location(location)
+      scroll_y = case location
+      when :top
+        '0'
+      when :bottom
+        'arguments[0].scrollHeight'
+      when :center
+        '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'
+      end
+      driver.execute_script <<~JS, self
+        if (arguments[0].scrollTo){
+          arguments[0].scrollTo(0, #{scroll_y});
+        } else {
+          arguments[0].scrollTop = #{scroll_y};
+        }
+      JS
+    end
+
+    def scroll_to_coords(x, y)
+      driver.execute_script <<~JS, self, x, y
+        if (arguments[0].scrollTo){
+          arguments[0].scrollTo(arguments[1], arguments[2]);
+        } else {
+          arguments[0].scrollTop = arguments[2];
+          arguments[0].scrollLeft = arguments[1];
+        }
+      JS
+    end
   end
 end

data/lib/capybara/cuprite/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Cuprite
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuprite
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -176,6 +176,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Cuprite is a driver for Capybara that allows you to run your tests on
   a headless Chrome browser
 email: