puppeteer-ruby 0.35.0 → 0.37.1

data/lib/puppeteer/devices.rb

@@ -1,3 +1,5 @@
+require_relative './device'
+
 Puppeteer::DEVICES = Hash[
   [
     {
@@ -156,6 +158,84 @@ Puppeteer::DEVICES = Hash[
         isLandscape: true,
       },
     },
+    {
+      name: 'Galaxy S8',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 7.0; SM-G950U Build/NRD90M) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36',
+      viewport: {
+        width: 360,
+        height: 740,
+        deviceScaleFactor: 3,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: false,
+      },
+    },
+    {
+      name: 'Galaxy S8 landscape',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 7.0; SM-G950U Build/NRD90M) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36',
+      viewport: {
+        width: 740,
+        height: 360,
+        deviceScaleFactor: 3,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: true,
+      },
+    },
+    {
+      name: 'Galaxy S9+',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 8.0.0; SM-G965U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.111 Mobile Safari/537.36',
+      viewport: {
+        width: 320,
+        height: 658,
+        deviceScaleFactor: 4.5,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: false,
+      },
+    },
+    {
+      name: 'Galaxy S9+ landscape',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 8.0.0; SM-G965U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.111 Mobile Safari/537.36',
+      viewport: {
+        width: 658,
+        height: 320,
+        deviceScaleFactor: 4.5,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: true,
+      },
+    },
+    {
+      name: 'Galaxy Tab S4',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 8.1.0; SM-T837A) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.80 Safari/537.36',
+      viewport: {
+        width: 712,
+        height: 1138,
+        deviceScaleFactor: 2.25,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: false,
+      },
+    },
+    {
+      name: 'Galaxy Tab S4 landscape',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 8.1.0; SM-T837A) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.80 Safari/537.36',
+      viewport: {
+        width: 1138,
+        height: 712,
+        deviceScaleFactor: 2.25,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: true,
+      },
+    },
     {
       name: 'iPad',
       userAgent:
@@ -1001,6 +1081,58 @@ Puppeteer::DEVICES = Hash[
         isLandscape: true,
       },
     },
+    {
+      name: 'Pixel 3',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 9; Pixel 3 Build/PQ1A.181105.017.A1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.158 Mobile Safari/537.36',
+      viewport: {
+        width: 393,
+        height: 786,
+        deviceScaleFactor: 2.75,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: false,
+      },
+    },
+    {
+      name: 'Pixel 3 landscape',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 9; Pixel 3 Build/PQ1A.181105.017.A1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.158 Mobile Safari/537.36',
+      viewport: {
+        width: 786,
+        height: 393,
+        deviceScaleFactor: 2.75,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: true,
+      },
+    },
+    {
+      name: 'Pixel 4',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 10; Pixel 4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Mobile Safari/537.36',
+      viewport: {
+        width: 353,
+        height: 745,
+        deviceScaleFactor: 3,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: false,
+      },
+    },
+    {
+      name: 'Pixel 4 landscape',
+      userAgent:
+        'Mozilla/5.0 (Linux; Android 10; Pixel 4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Mobile Safari/537.36',
+      viewport: {
+        width: 745,
+        height: 353,
+        deviceScaleFactor: 3,
+        isMobile: true,
+        hasTouch: true,
+        isLandscape: true,
+      },
+    },
   ].map do |json|
     [
       json[:name],

data/lib/puppeteer/dom_world.rb

@@ -233,12 +233,13 @@ class Puppeteer::DOMWorld
   # @param url [String?]
   # @param path [String?]
   # @param content [String?]
+  # @param id [String?]
   # @param type [String?]
-  def add_script_tag(url: nil, path: nil, content: nil, type: nil)
+  def add_script_tag(url: nil, path: nil, content: nil, id: nil, type: nil)
     if url
       begin
         return execution_context.
-          evaluate_handle(ADD_SCRIPT_URL, url, type || '').
+          evaluate_handle(ADD_SCRIPT_URL, url, id, type || '').
           as_element
       rescue Puppeteer::ExecutionContext::EvaluationError # for Chrome
         raise "Loading script from #{url} failed"
@@ -251,13 +252,13 @@ class Puppeteer::DOMWorld
       contents = File.read(path)
       contents += "//# sourceURL=#{path.gsub(/\n/, '')}"
       return execution_context.
-        evaluate_handle(ADD_SCRIPT_CONTENT, contents, type || '').
+        evaluate_handle(ADD_SCRIPT_CONTENT, contents, id, type || 'text/javascript').
         as_element
     end
 
     if content
       return execution_context.
-        evaluate_handle(ADD_SCRIPT_CONTENT, content, type || '').
+        evaluate_handle(ADD_SCRIPT_CONTENT, content, id, type || 'text/javascript').
         as_element
     end
 
@@ -265,11 +266,11 @@ class Puppeteer::DOMWorld
   end
 
   ADD_SCRIPT_URL = <<~JAVASCRIPT
-  async (url, type) => {
+  async (url, id, type) => {
     const script = document.createElement('script');
     script.src = url;
-    if (type)
-      script.type = type;
+    if (id) script.id = id;
+    if (type) script.type = type;
     const promise = new Promise((res, rej) => {
       script.onload = res;
       script.onerror = rej;
@@ -281,11 +282,11 @@ class Puppeteer::DOMWorld
   JAVASCRIPT
 
   ADD_SCRIPT_CONTENT = <<~JAVASCRIPT
-  (content, type) => {
-    if (type === undefined) type = 'text/javascript';
+  (content, id, type) => {
     const script = document.createElement('script');
     script.type = type;
     script.text = content;
+    if (id) script.id = id;
     let error = null;
     script.onerror = e => error = e;
     document.head.appendChild(script);

data/lib/puppeteer/element_handle/offset.rb

@@ -0,0 +1,28 @@
+class Puppeteer::ElementHandle < Puppeteer::JSHandle
+  # A class to represent (x, y)-offset coordinates
+  class Offset
+    def initialize(x:, y:)
+      @x = x
+      @y = y
+    end
+
+    def self.from(offset)
+      case offset
+      when nil
+        nil
+      when Hash
+        if offset[:x] && offset[:y]
+          Offset.new(x: offset[:x], y: offset[:y])
+        else
+          raise ArgumentError.new('offset parameter must have x, y coordinates')
+        end
+      when Offset
+        offset
+      else
+        raise ArgumentError.new('Offset.from(Hash|Offset)')
+      end
+    end
+
+    attr_reader :x, :y
+  end
+end

data/lib/puppeteer/element_handle/point.rb

@@ -21,6 +21,17 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
       )
     end
 
+    def ==(other)
+      case other
+      when Hash
+        @x == other[:x] && @y == other[:y]
+      when Point
+        @x == other.x && @y == other.y
+      else
+        super
+      end
+    end
+
     attr_reader :x, :y
   end
 end

data/lib/puppeteer/element_handle.rb

@@ -1,5 +1,6 @@
 require_relative './element_handle/bounding_box'
 require_relative './element_handle/box_model'
+require_relative './element_handle/offset'
 require_relative './element_handle/point'
 
 class Puppeteer::ElementHandle < Puppeteer::JSHandle
@@ -79,7 +80,9 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
   end
 
-  def clickable_point
+  def clickable_point(offset = nil)
+    offset_param = Offset.from(offset)
+
     result =
       begin
         @remote_object.content_quads(@client)
@@ -105,6 +108,19 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
       raise ElementNotVisibleError.new
     end
 
+    if offset_param
+      # Return the point of the first quad identified by offset.
+      quad = quads.first
+      min_x = quad.map(&:x).min
+      min_y = quad.map(&:y).min
+      if min_x && min_y
+        return Point.new(
+          x: min_x + offset_param.x,
+          y: min_y + offset_param.y,
+        )
+      end
+    end
+
     # Return the middle point of the first quad.
     quads.first.reduce(:+) / 4
   end
@@ -139,14 +155,56 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   # @param delay [Number]
   # @param button [String] "left"|"right"|"middle"
   # @param click_count [Number]
-  def click(delay: nil, button: nil, click_count: nil)
+  # @param offset [Hash]
+  def click(delay: nil, button: nil, click_count: nil, offset: nil)
     scroll_into_view_if_needed
-    point = clickable_point
+    point = clickable_point(offset)
     @page.mouse.click(point.x, point.y, delay: delay, button: button, click_count: click_count)
   end
 
   define_async_method :async_click
 
+  class DragInterceptionNotEnabledError < StandardError
+    def initialize
+      super('Drag Interception is not enabled!')
+    end
+  end
+
+  def drag(x:, y:)
+    unless @page.drag_interception_enabled?
+      raise DragInterceptionNotEnabledError.new
+    end
+    scroll_into_view_if_needed
+    start = clickable_point
+    @page.mouse.drag(start, Point.new(x: x, y: y))
+  end
+
+  def drag_enter(data)
+    scroll_into_view_if_needed
+    target = clickable_point
+    @page.mouse.drag_enter(target, data)
+  end
+
+  def drag_over(data)
+    scroll_into_view_if_needed
+    target = clickable_point
+    @page.mouse.drag_over(target, data)
+  end
+
+  def drop(data)
+    scroll_into_view_if_needed
+    target = clickable_point
+    @page.mouse.drop(target, data)
+  end
+
+  # @param target [ElementHandle]
+  def drag_and_drop(target, delay: nil)
+    scroll_into_view_if_needed
+    start_point = clickable_point
+    target_point = target.clickable_point
+    @page.mouse.drag_and_drop(start_point, target_point, delay: delay)
+  end
+
   # @return [Array<String>]
   def select(*values)
     if nonstring = values.find { |value| !value.is_a?(String) }
@@ -395,10 +453,12 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   define_async_method :async_Sx
 
   # in JS, #isIntersectingViewport.
+  # @param threshold [Float|nil]
   # @return [Boolean]
-  def intersecting_viewport?
+  def intersecting_viewport?(threshold: nil)
+    option_threshold = threshold || 0
     js = <<~JAVASCRIPT
-    async element => {
+    async (element, threshold) => {
       const visibleRatio = await new Promise(resolve => {
         const observer = new IntersectionObserver(entries => {
           resolve(entries[0].intersectionRatio);
@@ -406,11 +466,12 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
         });
         observer.observe(element);
       });
-      return visibleRatio > 0;
+      if (threshold === 1) return visibleRatio === 1;
+      else return visibleRatio > threshold;
     }
     JAVASCRIPT
 
-    evaluate(js)
+    evaluate(js, option_threshold)
   end
 
   # @param quad [Array<Point>]

data/lib/puppeteer/frame.rb

@@ -157,8 +157,9 @@ class Puppeteer::Frame
   # @param path [String?]
   # @param content [String?]
   # @param type [String?]
-  def add_script_tag(url: nil, path: nil, content: nil, type: nil)
-    @main_world.add_script_tag(url: url, path: path, content: content, type: type)
+  # @param id [String?]
+  def add_script_tag(url: nil, path: nil, content: nil, type: nil, id: nil)
+    @main_world.add_script_tag(url: url, path: path, content: content, type: type, id: id)
   end
 
   # @param url [String?]

data/lib/puppeteer/js_coverage.rb

@@ -12,6 +12,14 @@ class Puppeteer::JSCoverage
     attr_reader :url, :ranges, :text
   end
 
+  class ItemWithRawScriptCoverage < Item
+    def initialize(url:, ranges:, text:, raw_script_coverage:)
+      super(url: url, ranges: ranges, text: text)
+      @raw_script_coverage = raw_script_coverage
+    end
+    attr_reader :raw_script_coverage
+  end
+
   # @param client [Puppeteer::CDPSession]
   def initialize(client)
     @client = client
@@ -20,7 +28,10 @@ class Puppeteer::JSCoverage
     @script_sources = {}
   end
 
-  def start(reset_on_navigation: nil, report_anonymous_scripts: nil)
+  def start(
+        reset_on_navigation: nil,
+        report_anonymous_scripts: nil,
+        include_raw_script_coverage: nil)
     raise 'JSCoverage is already enabled' if @enabled
 
     @reset_on_navigation =
@@ -30,6 +41,7 @@ class Puppeteer::JSCoverage
         true
       end
     @report_anonymous_scripts = report_anonymous_scripts || false
+    @include_raw_script_coverage = include_raw_script_coverage || false
     @enabled = true
     @script_urls.clear
     @script_sources.clear
@@ -43,7 +55,7 @@ class Puppeteer::JSCoverage
     await_all(
       @client.async_send_message('Profiler.enable'),
       @client.async_send_message('Profiler.startPreciseCoverage',
-        callCount: false,
+        callCount: @include_raw_script_coverage,
         detailed: true,
       ),
       @client.async_send_message('Debugger.enable'),
@@ -107,11 +119,20 @@ class Puppeteer::JSCoverage
         end
       end
 
-      coverage << Item.new(
-        url: url,
-        ranges: convert_to_disjoint_ranges(flatten_ranges),
-        text: text,
-      )
+      if @include_raw_script_coverage
+        coverage << ItemWithRawScriptCoverage.new(
+          url: url,
+          ranges: convert_to_disjoint_ranges(flatten_ranges),
+          text: text,
+          raw_script_coverage: entry,
+        )
+      else
+        coverage << Item.new(
+          url: url,
+          ranges: convert_to_disjoint_ranges(flatten_ranges),
+          text: text,
+        )
+      end
     end
 
     coverage

data/lib/puppeteer/launcher/launch_options.rb

@@ -35,9 +35,9 @@ module Puppeteer::Launcher
       @channel = options[:channel]
       @executable_path = options[:executable_path]
       @ignore_default_args = options[:ignore_default_args] || false
-      @handle_SIGINT = options[:handle_SIGINT] || true
-      @handle_SIGTERM = options[:handle_SIGTERM] || true
-      @handle_SIGHUP = options[:handle_SIGHUP] || true
+      @handle_SIGINT = options.fetch(:handle_SIGINT, true)
+      @handle_SIGTERM = options.fetch(:handle_SIGTERM, true)
+      @handle_SIGHUP = options.fetch(:handle_SIGHUP, true)
       @timeout = options[:timeout] || 30000
       @dumpio = options[:dumpio] || false
       @env = options[:env] || ENV

data/lib/puppeteer/mouse.rb

@@ -94,6 +94,8 @@ class Puppeteer::Mouse
     )
   end
 
+  define_async_method :async_up
+
   # Dispatches a `mousewheel` event.
   #
   # @param delta_x [Integer]
@@ -110,5 +112,56 @@ class Puppeteer::Mouse
     )
   end
 
-  define_async_method :async_up
+  def drag(start, target)
+    promise = resolvable_future do |f|
+      @client.once('Input.dragIntercepted') do |event|
+        f.fulfill(event['data'])
+      end
+    end
+    move(start.x, start.y)
+    down
+    move(target.x, target.y)
+    promise.value!
+  end
+
+  def drag_enter(target, data)
+    @client.send_message('Input.dispatchDragEvent',
+      type: 'dragEnter',
+      x: target.x,
+      y: target.y,
+      modifiers: @keyboard.modifiers,
+      data: data,
+    )
+  end
+
+  def drag_over(target, data)
+    @client.send_message('Input.dispatchDragEvent',
+      type: 'dragOver',
+      x: target.x,
+      y: target.y,
+      modifiers: @keyboard.modifiers,
+      data: data,
+    )
+  end
+
+  def drop(target, data)
+    @client.send_message('Input.dispatchDragEvent',
+      type: 'drop',
+      x: target.x,
+      y: target.y,
+      modifiers: @keyboard.modifiers,
+      data: data,
+    )
+  end
+
+  def drag_and_drop(start, target, delay: nil)
+    data = drag(start, target)
+    drag_enter(target, data)
+    drag_over(target, data)
+    if delay
+      sleep(delay / 1000.0)
+    end
+    drop(target, data)
+    up
+  end
 end

data/lib/puppeteer/network_condition.rb

@@ -0,0 +1,12 @@
+class Puppeteer::NetworkCondition
+  # @param download [Number] Download speed (bytes/s)
+  # @param upload [Number] Upload speed (bytes/s)
+  # @param latency [Number] Latency (ms)
+  def initialize(download:, upload:, latency:)
+    @download = download
+    @upload = upload
+    @latency = latency
+  end
+
+  attr_reader :download, :upload, :latency
+end

data/lib/puppeteer/network_conditions.rb

@@ -0,0 +1,24 @@
+require_relative './network_condition'
+
+Puppeteer::NETWORK_CONDITIONS = {
+  'Slow 3G' => Puppeteer::NetworkCondition.new(
+    download: ((500 * 1000) / 8) * 0.8,
+    upload: ((500 * 1000) / 8) * 0.8,
+    latency: 400 * 5,
+  ),
+  'Fast 3G' => Puppeteer::NetworkCondition.new(
+    download: ((1.6 * 1000 * 1000) / 8) * 0.9,
+    upload: ((750 * 1000) / 8) * 0.9,
+    latency: 150 * 3.75,
+  ),
+}
+
+module Puppeteer::NetworkConditions
+  module_function def slow_3g
+    Puppeteer::NETWORK_CONDITIONS['Slow 3G']
+  end
+
+  module_function def fast_3g
+    Puppeteer::NETWORK_CONDITIONS['Fast 3G']
+  end
+end

data/lib/puppeteer/network_manager.rb

@@ -13,6 +13,46 @@ class Puppeteer::NetworkManager
     attr_reader :username, :password
   end
 
+  class InternalNetworkCondition
+    attr_writer :offline, :upload, :download, :latency
+
+    def initialize(client)
+      @client = client
+      @offline = false
+      @upload = -1
+      @download = -1
+      @latency = 0
+    end
+
+    def offline_mode=(value)
+      return if @offline == value
+      @offline = value
+      update_network_conditions
+    end
+
+    def network_condition=(network_condition)
+      if network_condition
+        @upload = network_condition.upload
+        @download = network_condition.download
+        @latency = network_condition.latency
+      else
+        @upload = -1
+        @download = -1
+        @latency = 0
+      end
+      update_network_conditions
+    end
+
+    private def update_network_conditions
+      @client.send_message('Network.emulateNetworkConditions',
+        offline: @offline,
+        latency: @latency,
+        downloadThroughput: @download,
+        uploadThroughput: @upload,
+      )
+    end
+  end
+
   # @param {!Puppeteer.CDPSession} client
   # @param {boolean} ignoreHTTPSErrors
   # @param {!Puppeteer.FrameManager} frameManager
@@ -29,13 +69,12 @@ class Puppeteer::NetworkManager
 
     @extra_http_headers = {}
 
-    @offline = false
-
     @attempted_authentications = Set.new
     @user_request_interception_enabled = false
     @protocol_request_interception_enabled = false
     @user_cache_disabled = false
     @request_id_to_interception_id = {}
+    @internal_network_condition = InternalNetworkCondition.new(@client)
 
     @client.on_event('Fetch.requestPaused') do |event|
       handle_request_paused(event)
@@ -94,21 +133,23 @@ class Puppeteer::NetworkManager
 
   # @param value [TrueClass|FalseClass]
   def offline_mode=(value)
-    return if @offline == value
-    @offline = value
-    @client.send_message('Network.emulateNetworkConditions',
-      offline: @offline,
-      # values of 0 remove any active throttling. crbug.com/456324#c9
-      latency: 0,
-      downloadThroughput: -1,
-      uploadThroughput: -1,
-    )
+    @internal_network_condition.offline_mode=(value)
+  end
+
+  # @param network_condition [Puppeteer::NetworkCondition|nil]
+  def emulate_network_conditions(network_condition)
+    @internal_network_condition.network_condition = network_condition
   end
 
   # @param user_agent [String]
-  def user_agent=(user_agent)
-    @client.send_message('Network.setUserAgentOverride', userAgent: user_agent)
+  # @param user_agent_metadata [Hash]
+  def set_user_agent(user_agent, user_agent_metadata = nil)
+    @client.send_message('Network.setUserAgentOverride', {
+      userAgent: user_agent,
+      userAgentMetadata: user_agent_metadata,
+    }.compact)
   end
+  alias_method :user_agent=, :set_user_agent
 
   def cache_enabled=(enabled)
     @user_cache_disabled = !enabled