apparition 0.0.1 → 0.0.2

data/lib/capybara/apparition/node/drag.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Capybara::Apparition
+  module Drag
+    def drag_to(other, delay: 0.1)
+      return html5_drag_to(other) if html5_draggable?
+
+      pos = visible_center
+      raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['drag_to']) if pos.nil?
+
+      test = mouse_event_test(pos)
+      raise ::Capybara::Apparition::MouseEventFailed.new(self, 'args' => ['drag', test.selector, pos]) unless test.success
+
+      begin
+        @page.mouse.move_to(pos).down
+        sleep delay
+
+        other_pos = other.visible_center
+        raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['drag_to']) if other_pos.nil?
+
+        @page.mouse.move_to(other_pos.merge(button: 'left'))
+        sleep delay
+      ensure
+        @page.mouse.up
+      end
+    end
+
+    def drag_by(x, y, delay: 0.1)
+      pos = visible_center
+      raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['hover']) if pos.nil?
+
+      other_pos = { x: pos[:x] + x, y: pos[:y] + y }
+      raise ::Capybara::Apparition::MouseEventFailed.new(self, 'args' => ['drag', test['selector'], pos]) unless mouse_event_test?(pos)
+
+      @page.mouse.move_to(pos).down
+      sleep delay
+      @page.mouse.move_to(other_pos.merge(button: 'left'))
+      sleep delay
+      @page.mouse.up
+    end
+
+  private
+
+    def html5_drag_to(element)
+      driver.execute_script MOUSEDOWN_TRACKER
+      scroll_if_needed
+      @page.mouse.move_to(element.visible_center).down
+      if driver.evaluate_script('window.capybara_mousedown_prevented')
+        element.scroll_if_needed
+        @page.mouse.move_to(element.visible_center).up
+      else
+        driver.execute_script HTML5_DRAG_DROP_SCRIPT, self, element
+        @page.mouse.up(element.visible_center)
+      end
+    end
+
+    def html5_draggable?
+      native.property('draggable')
+    end
+
+    MOUSEDOWN_TRACKER = <<~JS
+      document.addEventListener('mousedown', ev => {
+        window.capybara_mousedown_prevented = ev.defaultPrevented;
+      }, { once: true, passive: true })
+    JS
+
+    HTML5_DRAG_DROP_SCRIPT = <<~JS
+      var source = arguments[0];
+      var target = arguments[1];
+
+      function rectCenter(rect){
+        return new DOMPoint(
+          (rect.left + rect.right)/2,
+          (rect.top + rect.bottom)/2
+        );
+      }
+
+      function pointOnRect(pt, rect) {
+      	var rectPt = rectCenter(rect);
+      	var slope = (rectPt.y - pt.y) / (rectPt.x - pt.x);
+
+      	if (pt.x <= rectPt.x) { // left side
+      		var minXy = slope * (rect.left - pt.x) + pt.y;
+      		if (rect.top <= minXy && minXy <= rect.bottom)
+            return new DOMPoint(rect.left, minXy);
+      	}
+
+      	if (pt.x >= rectPt.x) { // right side
+      		var maxXy = slope * (rect.right - pt.x) + pt.y;
+      		if (rect.top <= maxXy && maxXy <= rect.bottom)
+            return new DOMPoint(rect.right, maxXy);
+      	}
+
+      	if (pt.y <= rectPt.y) { // top side
+      		var minYx = (rectPt.top - pt.y) / slope + pt.x;
+      		if (rect.left <= minYx && minYx <= rect.right)
+            return new DOMPoint(minYx, rect.top);
+      	}
+
+      	if (pt.y >= rectPt.y) { // bottom side
+      		var maxYx = (rect.bottom - pt.y) / slope + pt.x;
+      		if (rect.left <= maxYx && maxYx <= rect.right)
+            return new DOMPoint(maxYx, rect.bottom);
+      	}
+
+        return new DOMPoint(pt.x,pt.y);
+      }
+
+      var dt = new DataTransfer();
+      var opts = { cancelable: true, bubbles: true, dataTransfer: dt };
+
+      if (source.tagName == 'A'){
+        dt.setData('text/uri-list', source.href);
+        dt.setData('text', source.href);
+      }
+      if (source.tagName == 'IMG'){
+        dt.setData('text/uri-list', source.src);
+        dt.setData('text', source.src);
+      }
+
+      var dragEvent = new DragEvent('dragstart', opts);
+      source.dispatchEvent(dragEvent);
+      target.scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
+      var targetRect = target.getBoundingClientRect();
+      var sourceCenter = rectCenter(source.getBoundingClientRect());
+
+      // fire 2 dragover events to simulate dragging with a direction
+      var entryPoint = pointOnRect(sourceCenter, targetRect)
+      var dragOverOpts = Object.assign({clientX: entryPoint.x, clientY: entryPoint.y}, opts);
+      var dragOverEvent = new DragEvent('dragover', dragOverOpts);
+      target.dispatchEvent(dragOverEvent);
+
+      var targetCenter = rectCenter(targetRect);
+      dragOverOpts = Object.assign({clientX: targetCenter.x, clientY: targetCenter.y}, opts);
+      dragOverEvent = new DragEvent('dragover', dragOverOpts);
+      target.dispatchEvent(dragOverEvent);
+
+      var dragLeaveEvent = new DragEvent('dragleave', opts);
+      target.dispatchEvent(dragLeaveEvent);
+      if (dragOverEvent.defaultPrevented) {
+        var dropEvent = new DragEvent('drop', opts);
+        target.dispatchEvent(dropEvent);
+      }
+      var dragEndEvent = new DragEvent('dragend', opts);
+      source.dispatchEvent(dragEndEvent);
+    JS
+  end
+end

data/lib/capybara/apparition/page.rb

@@ -12,20 +12,24 @@ module Capybara::Apparition
     attr_accessor :perm_headers, :temp_headers, :temp_no_redirect_headers
     attr_reader :network_traffic
 
-    def self.create(browser, session, id, ignore_https_errors: nil, screenshot_task_queue: nil, js_errors: false)
+    def self.create(browser, session, id, ignore_https_errors: false, screenshot_task_queue: nil, js_errors: false)
       session.command 'Page.enable'
-      session.command 'Page.setLifecycleEventsEnabled', enabled: true
-      session.command 'Page.setDownloadBehavior', behavior: 'allow', downloadPath: Capybara.save_path
+
+      # Provides a lot of info - but huge overhead
+      # session.command 'Page.setLifecycleEventsEnabled', enabled: true
 
       page = Page.new(browser, session, id, ignore_https_errors, screenshot_task_queue, js_errors)
 
       session.command 'Network.enable'
       session.command 'Runtime.enable'
       session.command 'Security.enable'
-      session.command 'Security.setOverrideCertificateErrors', override: true if ignore_https_errors
+      # session.command 'Security.setOverrideCertificateErrors', override: true if ignore_https_errors
+      session.command 'Security.setIgnoreCertificateErrors', ignore: !!ignore_https_errors
       session.command 'DOM.enable'
       # session.command 'Log.enable'
-
+      if Capybara.save_path
+        session.command 'Page.setDownloadBehavior', behavior: 'allow', downloadPath: Capybara.save_path
+      end
       page
     end
 
@@ -121,17 +125,23 @@ module Capybara::Apparition
         params = {}
         params[:paperWidth] = @browser.paper_size[:width].to_f if @browser.paper_size
         params[:paperHeight] = @browser.paper_size[:height].to_f if @browser.paper_size
+        params[:scale] = @browser.zoom_factor if @browser.zoom_factor
         command('Page.printToPDF', params)
       else
-        if options[:selector]
+        clip_options = if options[:selector]
           pos = evaluate("document.querySelector('#{options.delete(:selector)}').getBoundingClientRect().toJSON();")
-          options[:clip] = %w[x y width height].each_with_object('scale' => 1) { |key, hash| hash[key] = pos[key] }
+          %w[x y width height].each_with_object({}) { |key, hash| hash[key] = pos[key] }
         elsif options[:full]
-          options[:clip] = evaluate <<~JS
+          evaluate <<~JS
             { width: document.documentElement.clientWidth, height: document.documentElement.clientHeight}
           JS
-          options[:clip].merge!(x: 0, y: 0, scale: 1)
+        else
+          evaluate <<~JS
+            { width: window.innerWidth, height: window.innerHeight }
+          JS
         end
+        options[:clip] = { x: 0, y: 0, scale: 1 }.merge(clip_options)
+        options[:clip][:scale] = @browser.zoom_factor || 1
         command('Page.captureScreenshot', options)
       end['data']
     end
@@ -139,10 +149,11 @@ module Capybara::Apparition
     def push_frame(frame_el)
       node = command('DOM.describeNode', objectId: frame_el.base.id)
       frame_id = node['node']['frameId']
-      start = Time.now
+
+      timer = Capybara::Helpers.timer(expire_in: 10)
       while (frame = @frames.get(frame_id)).nil? || frame.loading?
         # Wait for the frame creation messages to be processed
-        if Time.now - start > 10
+        if timer.expired?
           puts 'Timed out waiting from frame to be ready'
           # byebug
           raise TimeoutError.new('push_frame')
@@ -217,10 +228,10 @@ module Capybara::Apparition
     attr_reader :status_code
 
     def wait_for_loaded(allow_obsolete: false)
-      start = Time.now
+      timer = Capybara::Helpers.timer(expire_in: 10)
       cf = current_frame
       until cf.usable? || (allow_obsolete && cf.obsolete?) || @js_error
-        if Time.now - start > 10
+        if timer.expired?
           puts 'Timedout waiting for page to be loaded'
           # byebug
           raise TimeoutError.new('wait_for_loaded')
@@ -248,6 +259,9 @@ module Capybara::Apparition
       navigate_opts = { url: url, transitionType: 'reload' }
       navigate_opts[:referrer] = extra_headers['Referer'] if extra_headers['Referer']
       response = command('Page.navigate', navigate_opts)
+
+      raise StatusFailError, 'args' => [url, response['errorText']] if response['errorText']
+
       main_frame.loading(response['loaderId'])
       wait_for_loaded
     rescue TimeoutError
@@ -306,11 +320,11 @@ module Capybara::Apparition
     end
 
     def command(name, **params)
-      @browser.command_for_session(@session.session_id, name, params)
+      @browser.command_for_session(@session.session_id, name, params).result
     end
 
     def async_command(name, **params)
-      @browser.command_for_session(@session.session_id, name, params, async: true)
+      @browser.command_for_session(@session.session_id, name, params).discard_result
     end
 
     def extra_headers
@@ -378,6 +392,8 @@ module Capybara::Apparition
 
       @session.on 'Page.windowOpen' do |params|
         puts "**** windowOpen was called with: #{params}" if ENV['DEBUG']
+        # TODO: find a better way to handle this
+        sleep 0.4 # wait a bit so the window has time to start loading
       end
 
       @session.on 'Page.frameAttached' do |params|
@@ -399,16 +415,31 @@ module Capybara::Apparition
         end
       end
 
-      @session.on 'Page.lifecycleEvent' do |params|
-        puts "Lifecycle: #{params['name']} - frame: #{params['frameId']} - loader: #{params['loaderId']}" if ENV['DEBUG']
-        case params['name']
-        when 'init'
-          @frames.get(params['frameId'])&.loading(params['loaderId'])
-        when 'firstMeaningfulPaintCandidate',
-             'networkIdle'
-          frame = @frames.get(params['frameId'])
-          frame.loaded! if frame.loader_id == params['loaderId']
-        end
+      @session.on 'Page.frameStartedLoading' do |params|
+        @frames.get(params['frameId'])&.loading(-1)
+      end
+
+      @session.on 'Page.frameStoppedLoading' do |params|
+        @frames.get(params['frameId'])&.loaded!
+      end
+
+      # @session.on 'Page.lifecycleEvent' do |params|
+      #   # Provides a lot of useful info - but lots of overhead
+      #   puts "Lifecycle: #{params['name']} - frame: #{params['frameId']} - loader: #{params['loaderId']}" if ENV['DEBUG']
+      #   case params['name']
+      #   when 'init'
+      #     @frames.get(params['frameId'])&.loading(params['loaderId'])
+      #   when 'firstMeaningfulPaint',
+      #        'networkIdle'
+      #     @frames.get(params['frameId']).tap do |frame|
+      #       frame.loaded! if frame.loader_id == params['loaderId']
+      #     end
+      #   end
+      # end
+
+      @session.on('Page.domContentEventFired') do |params|
+        # TODO: Really need something better than this
+        main_frame.loaded! if @status_code != 200
       end
 
       @session.on 'Page.navigatedWithinDocument' do |params|
@@ -466,7 +497,7 @@ module Capybara::Apparition
       @session.on 'Network.loadingFailed' do |params|
         req = @network_traffic.find { |request| request.request_id == params['requestId'] }
         req&.blocked_params = params if params['blockedReason']
-        puts "Loading Failed - request: #{params['requestId']}: #{params['errorText']}" if params['type'] == 'Document'
+        puts "Loading Failed - request: #{params['requestId']} : #{params['errorText']}" if params['type'] == 'Document'
       end
 
       @session.on 'Network.requestIntercepted' do |params|
@@ -484,6 +515,10 @@ module Capybara::Apparition
         )
       end
 
+      # @session.on 'Security.certificateError' do |params|
+      #   async_command 'Network.continueInterceptedRequest', interceptionId: id, **params
+      # end
+
       # @session.on 'Log.entryAdded' do |params|
       #   log_entry = params['entry']
       #   if params.values_at('source', 'level') == ['javascript', 'error']
@@ -634,7 +669,6 @@ module Capybara::Apparition
     def decode_result(result, object_cache = {})
       if result['type'] == 'object'
         if result['subtype'] == 'array'
-          # remoteObject = @browser.command('Runtime.getProperties',
           remote_object = command('Runtime.getProperties',
                                   objectId: result['objectId'],
                                   ownProperties: true)
@@ -655,7 +689,7 @@ module Capybara::Apparition
 
             # releasePromises = [helper.releaseObject(@element._client, remoteObject)]
           end
-
+          command('Runtime.releaseObject', objectId: result['objectId'])
           return results
         elsif result['subtype'] == 'node'
           return result
@@ -667,10 +701,10 @@ module Capybara::Apparition
                       .find { |prop| prop['name'] == '[[StableObjectId]]' }
                       .dig('value', 'value')
           # We could actually return cyclic objects here but Capybara would need to be updated to support
-          return '(cyclic structure)' if object_cache.key?(stable_id)
-
           # return object_cache[stable_id] if object_cache.key?(stable_id)
 
+          return '(cyclic structure)' if object_cache.key?(stable_id)
+
           object_cache[stable_id] = {}
           properties = remote_object['result']
 

data/lib/capybara/apparition/response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Capybara::Apparition
+  class ChromeClient
+    class Response
+      def initialize(client, *msg_ids, send_time: nil)
+        @send_time = send_time
+        @msg_ids = msg_ids
+        @client = client
+      end
+
+      def result
+        response = @msg_ids.map do |id|
+          resp = @client.send(:wait_for_msg_response, id)
+          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']
+
+        response['result']
+      end
+
+      def discard_result
+        @msg_ids.each { |id| @client.add_async_id id }
+        @result_time = Time.now
+        nil
+      end
+
+    private
+
+      def handle_error(error)
+        case error['code']
+        when -32_000
+          raise WrongWorld.new(nil, error)
+        else
+          raise CDPError.new(error)
+        end
+      end
+    end
+  end
+end

data/lib/capybara/apparition/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Apparition
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apparition
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Thomas Walpole
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -197,7 +197,6 @@ files:
 - lib/capybara/apparition.rb
 - lib/capybara/apparition/browser.rb
 - lib/capybara/apparition/chrome_client.rb
-- lib/capybara/apparition/command.rb
 - lib/capybara/apparition/cookie.rb
 - lib/capybara/apparition/dev_tools_protocol/session.rb
 - lib/capybara/apparition/dev_tools_protocol/target.rb
@@ -215,7 +214,9 @@ files:
 - lib/capybara/apparition/network_traffic/request.rb
 - lib/capybara/apparition/network_traffic/response.rb
 - lib/capybara/apparition/node.rb
+- lib/capybara/apparition/node/drag.rb
 - lib/capybara/apparition/page.rb
+- lib/capybara/apparition/response.rb
 - lib/capybara/apparition/utility.rb
 - lib/capybara/apparition/version.rb
 - lib/capybara/apparition/web_socket_client.rb
@@ -238,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Chrome driver using CDP for Capybara

data/lib/capybara/apparition/command.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'securerandom'
-
-module Capybara::Apparition
-  class Command
-    attr_reader :id
-    attr_reader :name
-    attr_accessor :args
-
-    def initialize(name, params = {})
-      @id = SecureRandom.uuid
-      @name = name
-      @params = params
-    end
-
-    def message
-      JSON.dump('id' => @id, 'name' => @name, 'params' => @params)
-    end
-  end
-end