puppeteer-ruby 0.34.3 → 0.37.0

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/chrome.rb

@@ -2,7 +2,13 @@ require 'tmpdir'
 
 # https://github.com/puppeteer/puppeteer/blob/main/src/node/Launcher.ts
 module Puppeteer::Launcher
-  class Chrome < Base
+  class Chrome
+    def initialize(project_root:, preferred_revision:, is_puppeteer_core:)
+      @project_root = project_root
+      @preferred_revision = preferred_revision
+      @is_puppeteer_core = is_puppeteer_core
+    end
+
     # @param {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions)=} options
     # @return {!Promise<!Browser>}
     def launch(options = {})
@@ -38,7 +44,12 @@ module Puppeteer::Launcher
         chrome_arguments << "--user-data-dir=#{temporary_user_data_dir}"
       end
 
-      chrome_executable = @launch_options.executable_path || resolve_executable_path
+      chrome_executable =
+        if @launch_options.channel
+          executable_path_for_channel(@launch_options.channel.to_s)
+        else
+          @launch_options.executable_path || executable_path_for_channel('chrome')
+        end
       use_pipe = chrome_arguments.include?('--remote-debugging-pipe')
       runner = Puppeteer::BrowserRunner.new(chrome_executable, chrome_arguments, temporary_user_data_dir)
       runner.start(
@@ -201,8 +212,57 @@ module Puppeteer::Launcher
     end
 
     # @return {string}
-    def executable_path
-      resolve_executable_path
+    def executable_path(channel: nil)
+      if channel
+        executable_path_for_channel(channel.to_s)
+      else
+        executable_path_for_channel('chrome')
+      end
+    end
+
+    CHROMIUM_CHANNELS = {
+      windows: {
+        'chrome' => "#{ENV['PROGRAMFILES']}\\Google\\Chrome\\Application\\chrome.exe",
+        'chrome-beta' => "#{ENV['PROGRAMFILES']}\\Google\\Chrome Beta\\Application\\chrome.exe",
+        'chrome-canary' => "#{ENV['PROGRAMFILES']}\\Google\\Chrome SxS\\Application\\chrome.exe",
+        'chrome-dev' => "#{ENV['PROGRAMFILES']}\\Google\\Chrome Dev\\Application\\chrome.exe",
+        'msedge' => "#{ENV['PROGRAMFILES(X86)']}\\Microsoft\\Edge\\Application\\msedge.exe",
+      },
+      darwin: {
+        'chrome' => '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
+        'chrome-beta' => '/Applications/Google Chrome Beta.app/Contents/MacOS/Google Chrome Beta',
+        'chrome-canary' => '/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary',
+        'chrome-dev' => '/Applications/Google Chrome Dev.app/Contents/MacOS/Google Chrome Dev',
+        'msedge' => '/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge',
+      },
+      linux: {
+        'chrome' => '/opt/google/chrome/chrome',
+        'chrome-beta' => '/opt/google/chrome-beta/chrome',
+        'chrome-dev' => '/opt/google/chrome-unstable/chrome',
+      },
+    }.freeze
+
+    # @param channel [String]
+    private def executable_path_for_channel(channel)
+      chrome_path_map =
+        if Puppeteer.env.windows?
+          CHROMIUM_CHANNELS[:windows]
+        elsif Puppeteer.env.darwin?
+          CHROMIUM_CHANNELS[:darwin]
+        else
+          CHROMIUM_CHANNELS[:linux]
+        end
+
+      chrome_path = chrome_path_map[channel]
+      unless chrome_path
+        raise ArgumentError.new("Invalid channel: '#{channel}'. Allowed channel is #{chrome_path_map.keys}")
+      end
+
+      unless File.exist?(chrome_path)
+        raise "#{channel} is not installed on this system.\nExpected path: #{chrome_path}"
+      end
+
+      chrome_path
     end
 
     def product

data/lib/puppeteer/launcher/firefox.rb

@@ -2,7 +2,13 @@ require 'tmpdir'
 
 # https://github.com/puppeteer/puppeteer/blob/main/src/node/Launcher.ts
 module Puppeteer::Launcher
-  class Firefox < Base
+  class Firefox
+    def initialize(project_root:, preferred_revision:, is_puppeteer_core:)
+      @project_root = project_root
+      @preferred_revision = preferred_revision
+      @is_puppeteer_core = is_puppeteer_core
+    end
+
     # @param {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions)=} options
     # @return {!Promise<!Browser>}
     def launch(options = {})
@@ -32,7 +38,12 @@ module Puppeteer::Launcher
         firefox_arguments << temporary_user_data_dir
       end
 
-      firefox_executable = @launch_options.executable_path || resolve_executable_path
+      firefox_executable =
+        if @launch_options.channel
+          executable_path_for_channel(@launch_options.channel.to_s)
+        else
+          @launch_options.executable_path || executable_path_for_channel('nightly')
+        end
       runner = Puppeteer::BrowserRunner.new(firefox_executable, firefox_arguments, temporary_user_data_dir)
       runner.start(
         handle_SIGHUP: @launch_options.handle_SIGHUP?,
@@ -123,8 +134,41 @@ module Puppeteer::Launcher
     end
 
     # @return {string}
-    def executable_path
-      resolve_executable_path
+    def executable_path(channel: nil)
+      if channel
+        executable_path_for_channel(channel.to_s)
+      else
+        executable_path_for_channel('firefox')
+      end
+    end
+
+    FIREFOX_EXECUTABLE_PATHS = {
+      windows: "#{ENV['PROGRAMFILES']}\\Firefox Nightly\\firefox.exe",
+      darwin: '/Applications/Firefox Nightly.app/Contents/MacOS/firefox',
+      linux: '/usr/bin/firefox',
+    }.freeze
+
+    # @param channel [String]
+    private def executable_path_for_channel(channel)
+      allowed = ['firefox', 'firefox-nightly', 'nightly']
+      unless allowed.include?(channel)
+        raise ArgumentError.new("Invalid channel: '#{channel}'. Allowed channel is #{allowed}")
+      end
+
+      firefox_path =
+        if Puppeteer.env.windows?
+          FIREFOX_EXECUTABLE_PATHS[:windows]
+        elsif Puppeteer.env.darwin?
+          FIREFOX_EXECUTABLE_PATHS[:darwin]
+        else
+          FIREFOX_EXECUTABLE_PATHS[:linux]
+        end
+
+      unless File.exist?(firefox_path)
+        raise "Nightly version of Firefox is not installed on this system.\nExpected path: #{firefox_path}"
+      end
+
+      firefox_path
     end
 
     def product

data/lib/puppeteer/launcher/launch_options.rb

@@ -32,6 +32,7 @@ module Puppeteer::Launcher
     # @property {!Object<string, string | undefined>=} env
     # @property {boolean=} pipe
     def initialize(options)
+      @channel = options[:channel]
       @executable_path = options[:executable_path]
       @ignore_default_args = options[:ignore_default_args] || false
       @handle_SIGINT = options[:handle_SIGINT] || true
@@ -43,7 +44,7 @@ module Puppeteer::Launcher
       @pipe = options[:pipe] || false
     end
 
-    attr_reader :executable_path, :ignore_default_args, :timeout, :env
+    attr_reader :channel, :executable_path, :ignore_default_args, :timeout, :env
 
     def handle_SIGINT?
       @handle_SIGINT

data/lib/puppeteer/launcher.rb

@@ -1,4 +1,3 @@
-require_relative './launcher/base'
 require_relative './launcher/browser_options'
 require_relative './launcher/chrome'
 require_relative './launcher/chrome_arg_options'