apparition 0.1.0 → 0.2.0

data/lib/capybara/apparition/dev_tools_protocol/remote_object.rb

@@ -19,13 +19,16 @@ module Capybara::Apparition
       def cyclic_checked_value(object_cache)
         if object?
           if array?
-            extract_properties_array(get_remote_object(object_id), object_cache)
+            extract_properties_array(get_remote_object(id), object_cache)
           elsif node?
             params
-          elsif object_class?
-            extract_properties_object(get_remote_object(object_id), object_cache)
+          elsif date?
+            res = get_date_string(id)
+            DateTime.parse(res)
+          elsif object_class? || css_style?
+            extract_properties_object(get_remote_object(id), object_cache)
           elsif window_class?
-            { object_id: object_id }
+            { object_id: id }
           else
             params['value']
           end
@@ -38,13 +41,15 @@ module Capybara::Apparition
 
       def object?; type == 'object' end
       def array?; subtype == 'array' end
+      def date?; subtype == 'date' end
       def node?; subtype == 'node' end
       def object_class?; classname == 'Object' end
+      def css_style?; classname == 'CSSStyleDeclaration' end
       def window_class?; classname == 'Window' end
 
       def type; params['type'] end
       def subtype; params['subtype'] end
-      def object_id; params['objectId'] end
+      def id; params['objectId'] end
       def classname; params['className'] end
 
       def extract_properties_array(properties, object_cache)
@@ -80,8 +85,15 @@ module Capybara::Apparition
         end
       end
 
-      def get_remote_object(id)
-        @page.command('Runtime.getProperties', objectId: id, ownProperties: true)['result']
+      def get_remote_object(id, own_props = true)
+        @page.command('Runtime.getProperties', objectId: id, ownProperties: own_props)['result']
+      end
+
+      def get_date_string(id)
+        @page.command('Runtime.callFunctionOn',
+                      functionDeclaration: 'function(){ return this.toUTCString() }',
+                      objectId: id,
+                      returnByValue: true).dig('result', 'value')
       end
     end
   end

data/lib/capybara/apparition/dev_tools_protocol/session.rb

@@ -3,12 +3,11 @@
 module Capybara::Apparition
   module DevToolsProtocol
     class Session
-      attr_reader :browser, :connection, :target_id, :session_id
+      attr_reader :browser, :connection, :session_id
 
-      def initialize(browser, connection, target_id, session_id)
+      def initialize(browser, connection, session_id)
         @browser = browser
         @connection = connection
-        @target_id = target_id
         @session_id = session_id
         @handlers = []
       end

data/lib/capybara/apparition/driver.rb

@@ -4,6 +4,7 @@ require 'uri'
 require 'forwardable'
 require 'capybara/apparition/driver/chrome_client'
 require 'capybara/apparition/driver/launcher'
+require 'capybara/apparition/configuration'
 
 module Capybara::Apparition
   class Driver < Capybara::Driver::Base
@@ -15,7 +16,7 @@ module Capybara::Apparition
 
     delegate %i[restart current_url status_code body
                 title frame_title frame_url switch_to_frame
-                window_handles close_window open_new_window switch_to_window within_window
+                window_handles close_window switch_to_window
                 paper_size= zoom_factor=
                 scroll_to
                 network_traffic clear_network_traffic
@@ -32,6 +33,7 @@ module Capybara::Apparition
       @browser   = nil
       @inspector = nil
       @client    = nil
+      @launcher  = nil
       @started   = false
     end
 
@@ -45,14 +47,14 @@ module Capybara::Apparition
 
     def browser
       @browser ||= begin
-        browser = Browser.new(client, browser_logger)
-        browser.js_errors = options.fetch(:js_errors, true)
-        browser.ignore_https_errors = options.fetch(:ignore_https_errors, false)
-        browser.extensions = options.fetch(:extensions, [])
-        browser.debug      = options.fetch(:debug, false)
-        browser.url_blacklist = options[:url_blacklist] || []
-        browser.url_whitelist = options[:url_whitelist] || []
-        browser
+        Browser.new(client, browser_logger) do |browser|
+          browser.js_errors = options.fetch(:js_errors, true)
+          browser.ignore_https_errors = options.fetch(:ignore_https_errors, false)
+          browser.extensions = options.fetch(:extensions, [])
+          browser.debug      = options.fetch(:debug, false)
+          browser.url_blacklist = options[:url_blacklist] || []
+          browser.url_whitelist = options[:url_whitelist] || []
+        end
       end
     end
 
@@ -114,20 +116,26 @@ module Capybara::Apparition
     end
 
     def evaluate_script(script, *args)
-      unwrap_script_result(browser.evaluate(script, *native_args(args)))
+      retry_if_wrong_world do
+        unwrap_script_result(browser.evaluate(script, *native_args(args)))
+      end
     end
 
     def evaluate_async_script(script, *args)
-      unwrap_script_result(browser.evaluate_async(script, session_wait_time, *native_args(args)))
+      retry_if_wrong_world do
+        unwrap_script_result(browser.evaluate_async(script, session_wait_time, *native_args(args)))
+      end
     end
 
     def execute_script(script, *args)
-      browser.execute(script, *native_args(args))
+      retry_if_wrong_world do
+        browser.execute(script, *native_args(args))
+      end
       nil
     end
 
     def current_window_handle
-      browser.window_handle
+      browser.current_window_handle
     end
 
     def no_such_window_error
@@ -158,28 +166,33 @@ module Capybara::Apparition
     def resize(width, height)
       browser.resize(width, height, screen: options[:screen_size])
     end
-    alias resize_window resize
+
+    def resize_window(width, height)
+      warn '[DEPRECATION] Capybara::Apparition::Driver#resize_window ' \
+        'is deprecated. Please use Capybara::Window#resize_to instead.'
+      resize(width, height)
+    end
 
     def resize_window_to(handle, width, height)
-      within_window(handle) do
+      _within_window(handle) do
         resize(width, height)
       end
     end
 
     def maximize_window(handle)
-      within_window(handle) do
+      _within_window(handle) do
         browser.maximize
       end
     end
 
     def fullscreen_window(handle)
-      within_window(handle) do
+      _within_window(handle) do
         browser.fullscreen
       end
     end
 
     def window_size(handle)
-      within_window(handle) do
+      _within_window(handle) do
         evaluate_script('[window.innerWidth, window.innerHeight]')
       end
     end
@@ -266,12 +279,12 @@ module Capybara::Apparition
         write.close
       end
 
-      STDERR.puts "Apparition execution paused. Press enter (or run 'kill -CONT #{Process.pid}') to continue."
+      STDERR.puts "Apparition execution paused. Press enter (or run 'kill -CONT #{Process.pid}') to continue." # rubocop:disable Style/StderrPuts
 
       signal = false
       old_trap = trap('SIGCONT') do
         signal = true
-        STDERR.puts "\nSignal SIGCONT received"
+        STDERR.puts "\nSignal SIGCONT received" # rubocop:disable Style/StderrPuts
       end
       # wait for data on STDIN or signal SIGCONT received
       keyboard = IO.select([read], nil, nil, 1) until keyboard || signal
@@ -286,7 +299,7 @@ module Capybara::Apparition
       end
     ensure
       trap('SIGCONT', old_trap) # Restore the previous signal handler, if there was one.
-      STDERR.puts 'Continuing'
+      STDERR.puts 'Continuing' # rubocop:disable Style/StderrPuts
     end
 
     def wait?
@@ -336,8 +349,53 @@ module Capybara::Apparition
       console_messages('error')
     end
 
+    def within_window(selector, &block)
+      warn 'Driver#within_window is deprecated, please switch to using Session#within_window instead.'
+      _within_window(selector, &block)
+      orig_window = current_window_handle
+      switch_to_window(selector)
+      begin
+        yield
+      ensure
+        switch_to_window(orig_window)
+      end
+    end
+
+    def version
+      chrome_version = browser.command('Browser.getVersion')
+      format(VERSION_STRING,
+             capybara: Capybara::VERSION,
+             apparition: Capybara::Apparition::VERSION,
+             chrome: chrome_version['product'])
+    end
+
+    def open_new_window
+      # needed because Capybara does arity detection on this method
+      browser.open_new_window
+    end
+
   private
 
+    def retry_if_wrong_world
+      timer = Capybara::Helpers.timer(expire_in: session_wait_time)
+      begin
+        yield
+      rescue WrongWorld
+        retry unless timer.expired?
+        raise
+      end
+    end
+
+    def _within_window(selector)
+      orig_window = current_window_handle
+      switch_to_window(selector)
+      begin
+        yield
+      ensure
+        switch_to_window(orig_window)
+      end
+    end
+
     def browser_options
       @options[:browser_options]
     end
@@ -363,7 +421,16 @@ module Capybara::Apparition
       if @options[:skip_image_loading]
         browser_options['blink-settings'] = [browser_options['blink-settings'], 'imagesEnabled=false'].compact.join(',')
       end
+
       @options[:browser_options] = browser_options
+      process_cw_options(@options[:cw_options])
+    end
+
+    def process_cw_options(cw_options)
+      return if cw_options.nil?
+
+      (options[:url_blacklist] ||= []).concat cw_options[:url_blacklist]
+      options[:js_errors] ||= cw_options[:js_errors]
     end
 
     def process_browser_options(options)
@@ -464,5 +531,12 @@ module Capybara::Apparition
         arg
       end
     end
+
+    VERSION_STRING = <<~VERSION
+      Versions in use:
+      Capybara: %<capybara>s
+      Apparition: %<apparition>s
+      Chrome: %<chrome>s
+    VERSION
   end
 end

data/lib/capybara/apparition/driver/chrome_client.rb

@@ -92,7 +92,7 @@ module Capybara::Apparition
     def send_msg(command, params)
       msg_id, msg = generate_msg(command, params)
       @send_mutex.synchronize do
-        puts "#{Time.now.to_i}: sending msg: #{msg}" if ENV['DEBUG']
+        puts "#{Time.now.to_i}: sending msg: #{msg}" if ENV['DEBUG'] == 'V'
         @ws.send_msg(msg)
       end
       msg_id
@@ -141,7 +141,7 @@ module Capybara::Apparition
 
     def read_msg
       msg = JSON.parse(@ws.read_msg)
-      puts "#{Time.now.to_i}: got msg: #{msg}" if ENV['DEBUG']
+      puts "#{Time.now.to_i}: got msg: #{msg}" if ENV['DEBUG'] == 'V'
       # Check if it's an event and push on event queue
       @events.push msg.dup if msg['method']
 
@@ -162,7 +162,7 @@ module Capybara::Apparition
         @msg_mutex.synchronize do
           @message_available.wait(@msg_mutex, 0.1)
           (@responses.keys & @async_ids).each do |msg_id|
-            puts "Cleaning up response for #{msg_id}" if ENV['DEBUG'] == 'v'
+            puts "Cleaning up response for #{msg_id}" if ENV['DEBUG'] == 'V'
             @responses.delete(msg_id)
             @async_ids.delete(msg_id)
           end

data/lib/capybara/apparition/driver/launcher.rb

@@ -3,7 +3,7 @@
 module Capybara::Apparition
   class Browser
     class Launcher
-      KILL_TIMEOUT = 2
+      KILL_TIMEOUT = 5
 
       def self.start(*args)
         new(*args).tap(&:start)
@@ -12,10 +12,11 @@ module Capybara::Apparition
       def self.process_killer(pid)
         proc do
           begin
+            sleep 1
             if Capybara::Apparition.windows?
               ::Process.kill('KILL', pid)
             else
-              ::Process.kill('TERM', pid)
+              ::Process.kill('USR1', pid)
               timer = Capybara::Helpers.timer(expire_in: KILL_TIMEOUT)
               while ::Process.wait(pid, ::Process::WNOHANG).nil?
                 sleep 0.05
@@ -137,7 +138,7 @@ module Capybara::Apparition
         when /darwin|mac os/
           macosx_path
         when /linux|solaris|bsd/
-          find_first_binary('google-chrome', 'chrome') || '/usr/bin/chrome'
+          linux_path
         else
           raise ArgumentError, "unknown os: #{host_os.inspect}"
         end
@@ -148,26 +149,36 @@ module Capybara::Apparition
       end
 
       def windows_path
-        raise ArgumentError, 'Not yet Implemented'
+        envs = %w[LOCALAPPDATA PROGRAMFILES PROGRAMFILES(X86)]
+        directories = %w[\\Google\\Chrome\\Application \\Chromium\\Application]
+        files = %w[chrome.exe]
+
+        directories.product(envs, files).lazy.map { |(dir, env, file)| "#{ENV[env]}\\#{dir}\\#{file}" }
+                   .find { |f| File.exist?(f) } || find_first_binary(*files)
       end
 
       def macosx_path
-        path = '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'
-        path = File.expand_path("~#{path}") unless File.exist?(path)
-        path = find_first_binary('Google Chrome') unless File.exist?(path)
-        path
+        directories = ['', File.expand_path('~')]
+        files = ['/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
+                 '/Applications/Chromium.app/Contents/MacOS/Chromium']
+        directories.product(files).map(&:join).find { |f| File.exist?(f) } ||
+          find_first_binary('Google Chrome', 'Chromium')
+      end
+
+      def linux_path
+        directories = %w[/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin /opt/google/chrome]
+        files = %w[google-chrome chrome chromium chromium-browser]
+
+        directories.product(files).map { |p| p.join('/') }.find { |f| File.exist?(f) } ||
+          find_first_binary(*files)
       end
 
       def find_first_binary(*binaries)
         paths = ENV['PATH'].split(File::PATH_SEPARATOR)
 
-        binaries.each do |binary|
-          paths.each do |path|
-            full_path = File.join(path, binary)
-            exe = Dir.glob(full_path).find { |f| File.executable?(f) }
-            return exe if exe
-          end
-        end
+        binaries.product(paths).lazy.map do |(binary, path)|
+          Dir.glob(File.join(path, binary)).find { |f| File.executable?(f) }
+        end.reject(&:nil?).first
       end
 
       # Chromium command line options
@@ -187,6 +198,7 @@ module Capybara::Apparition
         disable-prompt-on-repost
         disable-sync
         disable-translate
+        disable-session-crashed-bubble
         metrics-recording-only
         no-first-run
         safebrowsing-disable-auto-update

data/lib/capybara/apparition/driver/response.rb

@@ -15,7 +15,7 @@ module Capybara::Apparition
           handle_error(resp['error']) if resp['error']
           resp
         end.last
-        puts "Processed msg: #{@msg_ids.last} in #{Time.now - @send_time} seconds" if ENV['DEBUG']
+        puts "Processed msg: #{@msg_ids.last} in #{Time.now - @send_time} seconds" if ENV['DEBUG'] == 'V'
 
         response['result']
       end

data/lib/capybara/apparition/errors.rb

@@ -45,7 +45,7 @@ module Capybara
       end
 
       def message
-        'There was an error inside the Puppeteer portion of Apparition. ' \
+        'There was an error inside Apparition. ' \
           'If this is the error returned, and not the cause of a more detailed error response, ' \
           'this is probably a bug, so please report it. ' \
           "\n\n#{name}: #{error_parameters}"
@@ -57,7 +57,7 @@ module Capybara
       #   response['args'].first.map { |data| JSErrorItem.new(data['message'], data['stack']) }
       # end
       def javascript_errors
-        [response]
+        [message: response]
       end
 
       def message
@@ -65,7 +65,7 @@ module Capybara
           "If you don't care about these errors, you can ignore them by " \
           'setting js_errors: false in your Apparition configuration (see ' \
           'documentation for details).' \
-          "\n\n#{javascript_errors.map(&:to_s).join("\n")}"
+          "\n\n#{javascript_errors.map { |err| err[:message] }.join("\n")}"
       end
     end
 

data/lib/capybara/apparition/node.rb

@@ -33,9 +33,9 @@ module Capybara::Apparition
         Capybara::Apparition::Node.new(driver, @page, r_o['objectId'])
       end
     rescue ::Capybara::Apparition::BrowserError => e
-      raise unless e.name =~ /is not a valid (XPath expression|selector)/
+      raise unless /is not a valid (XPath expression|selector)/.match? e.name
 
-      raise Capybara::Apparition::InvalidSelector, [method, selector]
+      raise Capybara::Apparition::InvalidSelector, 'args' => [method, selector]
     end
 
     def find_xpath(selector)
@@ -71,6 +71,18 @@ module Capybara::Apparition
       visible_text
     end
 
+    # capybara-webkit method
+    def inner_html
+      self[:innerHTML]
+    end
+
+    # capybara-webkit method
+    def inner_html=(value)
+      driver.execute_script <<~JS, self, value
+        arguments[0].innerHTML = arguments[1]
+      JS
+    end
+
     def property(name)
       evaluate_on('name => this[name]', value: name)
     end
@@ -118,10 +130,13 @@ module Capybara::Apparition
         when 'datetime-local'
           set_datetime_local(value)
         else
-          set_text(value.to_s, delay: options.fetch(:delay, 0))
+          set_text(value.to_s, { delay: 0 }.merge(options))
         end
       elsif tag_name == 'textarea'
         set_text(value.to_s)
+      elsif tag_name == 'select'
+        warn "Setting the value of a select element via 'set' is deprecated, please use 'select' or 'select_option'."
+        evaluate_on '()=>{ this.value = arguments[0] }', value: value.to_s
       elsif self[:isContentEditable]
         delete_text
         send_keys(value.to_s, delay: options.fetch(:delay, 0))
@@ -150,6 +165,10 @@ module Capybara::Apparition
       evaluate_on VISIBLE_JS
     end
 
+    def obscured?(x: nil, y: nil)
+      evaluate_on(OBSCURED_JS) == true
+    end
+
     def checked?
       self[:checked]
     end
@@ -227,6 +246,10 @@ module Capybara::Apparition
       evaluate_on DISPATCH_EVENT_JS, { value: event_type }, { value: name }, value: opts.merge(options)
     end
 
+    def submit
+      evaluate_on '()=>{ this.submit() }'
+    end
+
     def ==(other)
       evaluate_on('el => this == el', objectId: other.id)
     rescue ObsoleteNode
@@ -710,6 +733,24 @@ module Capybara::Apparition
       }
     JS
 
+    OBSCURED_JS = <<~JS
+      function(x, y) {
+        var box = this.getBoundingClientRect();
+        if (x == null) x = box.width/2;
+        if (y == null) y = box.height/2 ;
+
+        var px = box.left + x,
+            py = box.top + y,
+            e = document.elementFromPoint(px, py);
+
+        if (!this.contains(e))
+          return true;
+
+        return { x: px, y: py };
+      }
+    JS
+
+
     DELETE_TEXT_JS = <<~JS
       function(){
         range = document.createRange();