puppeteer-ruby 0.34.2 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b57897093b83b5817c3fc7e533542cc817cda1299b5cece2a05d9d7850cce8c
-  data.tar.gz: 39b21af3b69fee33fa3e191bd93f11efde50b20e26e5b24b0ea82a8a2e44bc3d
+  metadata.gz: 1d4af926ca9ad39046dcc4ce9507622bf72c3263b747516ee1ba642c02e8e38d
+  data.tar.gz: 3eff89952883a47270dee6a9ee7281609dbbe7bac197eada9e6b6dcabbaa1f78
 SHA512:
-  metadata.gz: 8cf6ae4da0e3dd3b21090dd792b1611726022665e61c8ee9c0f8de9451445f723192d0b1fc5e8f22a8cfdeb17b62059d97bb4570f47b13789b296f59b1e2e532
-  data.tar.gz: 83aa119d4469e380fbd7d9fb81240a976d3ee7d465eb7ee3c662c65187c1161c6711df73dab88f47f404ea01dd2ddb3299307be7e0f78c9eb068edb44e4b11df
+  metadata.gz: d83085eb31bb6d0d9f125e4c82fe172f46676bc373bd7652b2be430984570f7facff20bd3b1da20dbcb41beca52a740064b9b6d5cb6f51a69bf8f4f97e699947
+  data.tar.gz: 141bed0475d5e40a0ddb9ec0cb2a82f44313a14e835a7d5cc271a413dad0c9881658a81f0ec0567d7896a7658539fc131bb5069c1c07c6573f6b633c99a53f8e

data/CHANGELOG.md

@@ -1,7 +1,34 @@
-### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.2...master)]
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.36.0...master)]
 
 * xxx
 
+### 0.36.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.35.1...0.36.0)]
+
+New features:
+
+* Drag and Drop feature introduced in Puppeteer 10.1
+* `Page#emulateNetworkConditions`, `Page#emulateCPUThrottling`
+* `Page#exposeFunction`
+* Metrics
+
+### 0.35.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.35.0...0.35.1)]
+
+New features:
+
+* Allow Rails users to use this library without `require 'puppeteer'`.
+
+### 0.35.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.3...0.35.0)]
+
+New features:
+
+* Add `channel` parameter for Puppeteer.launch. Now `channel: chrome` or `channel: chrome-canary` (chrome-beta, chrome-dev is also available) automatically detects the executablePath of Google Chrome. Windows/macOS users can also use `channel: msedge`.
+
+### 0.34.3 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.2...0.34.3)]
+
+Bugfix:
+
+* Fix wait_for_xxx's timeout error type.
+
 ### 0.34.2 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.1...0.34.2)]
 
 New features:

data/README.md

@@ -20,31 +20,29 @@ gem 'puppeteer-ruby'
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install puppeteer-ruby
+    $ bundle install
 
 ### Capture a site
 
 ```ruby
-require 'puppeteer'
+require 'puppeteer-ruby'
 
 Puppeteer.launch(headless: false) do |browser|
-  page = browser.pages.first || browser.new_page
+  page = browser.new_page
   page.goto("https://github.com/YusukeIwaki")
   page.screenshot(path: "YusukeIwaki.png")
 end
 ```
 
+NOTE: `require 'puppeteer-ruby'` is not necessary in Rails.
+
 ### Simple scraping
 
 ```ruby
-require 'puppeteer'
+require 'puppeteer-ruby'
 
 Puppeteer.launch(headless: false, slow_mo: 50, args: ['--guest', '--window-size=1280,800']) do |browser|
-  page = browser.pages.first || browser.new_page
+  page = browser.new_page
   page.viewport = Puppeteer::Viewport.new(width: 1280, height: 800)
   page.goto("https://github.com/", wait_until: 'domcontentloaded')
 
@@ -69,10 +67,10 @@ end
 ### Evaluate JavaScript
 
 ```ruby
-require 'puppeteer'
+require 'puppeteer-ruby'
 
 Puppeteer.launch do |browser|
-  page = browser.pages.last || browser.new_page
+  page = browser.new_page
   page.goto 'https://github.com/YusukeIwaki'
 
   # Get the "viewport" of the page, as reported by the page.

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
-- Puppeteer version: v10.0.0
-- puppeteer-ruby version: 0.34.1
+- Puppeteer version: v10.2.0
+- puppeteer-ruby version: 0.36.0
 
 ## Puppeteer
 
@@ -13,7 +13,7 @@
 * ~~errors~~
 * executablePath => `#executable_path`
 * launch
-* ~~networkConditions~~
+* networkConditions => `#network_conditions`
 * product
 * ~~registerCustomQueryHandler~~
 * ~~unregisterCustomQueryHandler~~
@@ -78,18 +78,20 @@
 * content
 * cookies
 * coverage
+* createPDFStream => `#create_pdf_stream`
 * deleteCookie => `#delete_cookie`
 * emulate
+* emulateCPUThrottling => `#emulate_cpu_throttling`
 * emulateIdleState => `#emulate_idle_state`
 * emulateMediaFeatures => `#emulate_media_features`
 * emulateMediaType => `#emulate_media_type`
-* ~~emulateNetworkConditions~~
+* emulateNetworkConditions => `#emulate_network_conditions`
 * emulateTimezone => `#emulate_timezone`
 * emulateVisionDeficiency => `#emulate_vision_deficiency`
 * evaluate
 * evaluateHandle => `#evaluate_handle`
 * evaluateOnNewDocument => `#evaluate_on_new_document`
-* ~~exposeFunction~~
+* exposeFunction => `#expose_function`
 * focus
 * frames
 * goBack => `#go_back`
@@ -97,10 +99,11 @@
 * goto
 * hover
 * isClosed => `#closed?`
+* isDragInterceptionEnabled => `#drag_interception_enabled?`
 * isJavaScriptEnabled => `#javascript_enabled?`
 * keyboard
 * mainFrame => `#main_frame`
-* ~~metrics~~
+* metrics
 * mouse
 * pdf
 * queryObjects => `#query_objects`
@@ -113,6 +116,7 @@
 * setCookie => `#set_cookie`
 * setDefaultNavigationTimeout => `#default_navigation_timeout=`
 * setDefaultTimeout => `#default_timeout=`
+* ~~setDragInterception~~
 * setExtraHTTPHeaders => `#extra_http_headers=`
 * setGeolocation => `#geolocation=`
 * setJavaScriptEnabled => `#javascript_enabled=`
@@ -162,6 +166,11 @@
 
 * click
 * down
+* drag
+* dragAndDrop => `#drag_and_drop`
+* dragEnter => `#drag_enter`
+* dragOver => `#drag_over`
+* drop
 * move
 * up
 * wheel
@@ -260,8 +269,14 @@
 * boundingBox => `#bounding_box`
 * boxModel => `#box_model`
 * click
+* clickablePoint => `#clickable_point`
 * contentFrame => `#content_frame`
 * dispose
+* drag
+* dragAndDrop => `#drag_and_drop`
+* dragEnter => `#drag_enter`
+* dragOver => `#drag_over`
+* drop
 * evaluate
 * evaluateHandle => `#evaluate_handle`
 * executionContext => `#execution_context`
@@ -282,8 +297,12 @@
 ## ~~HTTPRequest~~
 
 * ~~abort~~
+* ~~abortErrorReason~~
 * ~~continue~~
+* ~~continueRequestOverrides~~
+* ~~enqueueInterceptAction~~
 * ~~failure~~
+* ~~finalizeInterceptions~~
 * ~~frame~~
 * ~~headers~~
 * ~~isNavigationRequest~~
@@ -293,6 +312,7 @@
 * ~~resourceType~~
 * ~~respond~~
 * ~~response~~
+* ~~responseForRequest~~
 * ~~url~~
 
 ## ~~HTTPResponse~~

data/lib/puppeteer-ruby.rb

@@ -0,0 +1,2 @@
+# just an alias.
+require 'puppeteer'

data/lib/puppeteer.rb

@@ -5,7 +5,6 @@ module Puppeteer; end
 require 'puppeteer/env'
 
 # Custom data types.
-require 'puppeteer/device'
 require 'puppeteer/events'
 require 'puppeteer/errors'
 require 'puppeteer/geolocation'
@@ -44,6 +43,7 @@ require 'puppeteer/keyboard'
 require 'puppeteer/launcher'
 require 'puppeteer/lifecycle_watcher'
 require 'puppeteer/mouse'
+require 'puppeteer/network_conditions'
 require 'puppeteer/network_manager'
 require 'puppeteer/page'
 require 'puppeteer/protocol_stream_reader'

data/lib/puppeteer/concurrent_ruby_utils.rb

@@ -3,11 +3,11 @@ module Puppeteer::ConcurrentRubyUtils
   module ConcurrentPromisesFutureExtension
     # Extension for describing 2 concurrent tasks smartly.
     #
-    # page.async_for_navigation.with_waiting_for_complete do
+    # page.async_wait_for_navigation.with_waiting_for_complete do
     #   page.click('#submit')
     # end
     def with_waiting_for_complete(&block)
-      async_block_call = Concurrent::Promises.future do
+      async_block_call = Concurrent::Promises.delay do
         block.call
       rescue => err
         Logger.new($stderr).warn(err)

data/lib/puppeteer/define_async_method.rb

@@ -40,7 +40,7 @@ module Puppeteer::DefineAsyncMethod
                 end
               end
 
-            async_block_call = Concurrent::Promises.future do
+            async_block_call = Concurrent::Promises.delay do
               block.call
             rescue => err
               Logger.new($stderr).warn(err)

data/lib/puppeteer/devices.rb

@@ -1,3 +1,5 @@
+require_relative './device'
+
 Puppeteer::DEVICES = Hash[
   [
     {

data/lib/puppeteer/element_handle.rb

@@ -147,6 +147,47 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
 
   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) }

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'

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/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,15 +133,12 @@ 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]

data/lib/puppeteer/page.rb

@@ -2,11 +2,13 @@ require 'base64'
 require 'json'
 require "stringio"
 
+require_relative './page/metrics'
 require_relative './page/pdf_options'
 require_relative './page/screenshot_options'
 require_relative './page/screenshot_task_queue'
 
 class Puppeteer::Page
+  include Puppeteer::DebugPrint
   include Puppeteer::EventCallbackable
   include Puppeteer::IfPresent
   using Puppeteer::DefineAsyncMethod
@@ -46,6 +48,8 @@ class Puppeteer::Page
     @screenshot_task_queue = ScreenshotTaskQueue.new
 
     @workers = {}
+    @user_drag_interception_enabled = false
+
     @client.on_event('Target.attachedToTarget') do |event|
       if event['targetInfo']['type'] != 'worker'
         # If we don't detach from service workers, they will never die.
@@ -102,7 +106,9 @@ class Puppeteer::Page
     @client.on('Runtime.consoleAPICalled') do |event|
       handle_console_api(event)
     end
-    # client.on('Runtime.bindingCalled', event => this._onBindingCalled(event));
+    @client.on('Runtime.bindingCalled') do |event|
+      handle_binding_called(event)
+    end
     @client.on_event('Page.javascriptDialogOpening') do |event|
       handle_dialog_opening(event)
     end
@@ -112,7 +118,9 @@ class Puppeteer::Page
     @client.on_event('Inspector.targetCrashed') do |event|
       handle_target_crashed
     end
-    # client.on('Performance.metrics', event => this._emitMetrics(event));
+    @client.on_event('Performance.metrics') do |event|
+      emit_event(PageEmittedEvents::Metrics, MetricsEvent.new(event))
+    end
     @client.on_event('Log.entryAdded') do |event|
       handle_log_entry_added(event)
     end
@@ -134,6 +142,11 @@ class Puppeteer::Page
     )
   end
 
+  def drag_interception_enabled?
+    @user_drag_interception_enabled
+  end
+  alias_method :drag_interception_enabled, :drag_interception_enabled?
+
   # @param event_name [Symbol]
   def on(event_name, &block)
     unless PageEmittedEvents.values.include?(event_name.to_s)
@@ -266,10 +279,20 @@ class Puppeteer::Page
     @frame_manager.network_manager.request_interception = value
   end
 
+  def drag_interception_enabled=(enabled)
+    @user_drag_interception_enabled = enabled
+    @client.send_message('Input.setInterceptDrags', enabled: enabled)
+  end
+
   def offline_mode=(enabled)
     @frame_manager.network_manager.offline_mode = enabled
   end
 
+  # @param network_condition [Puppeteer::NetworkCondition|nil]
+  def emulate_network_conditions(network_condition)
+    @frame_manager.network_manager.emulate_network_conditions(network_condition)
+  end
+
   # @param {number} timeout
   def default_navigation_timeout=(timeout)
     @timeout_settings.default_navigation_timeout = timeout
@@ -392,6 +415,51 @@ class Puppeteer::Page
     main_frame.add_style_tag(url: url, path: path, content: content)
   end
 
+  # @param name [String]
+  # @param puppeteer_function [Proc]
+  def expose_function(name, puppeteer_function)
+    if @page_bindings[name]
+      raise ArgumentError.new("Failed to add page binding with name `#{name}` already exists!")
+    end
+    @page_bindings[name] = puppeteer_function
+
+    add_page_binding = <<~JAVASCRIPT
+    function (type, bindingName) {
+      /* Cast window to any here as we're about to add properties to it
+      * via win[bindingName] which TypeScript doesn't like.
+      */
+      const win = window;
+      const binding = win[bindingName];
+
+      win[bindingName] = (...args) => {
+        const me = window[bindingName];
+        let callbacks = me.callbacks;
+        if (!callbacks) {
+          callbacks = new Map();
+          me.callbacks = callbacks;
+        }
+        const seq = (me.lastSeq || 0) + 1;
+        me.lastSeq = seq;
+        const promise = new Promise((resolve, reject) =>
+          callbacks.set(seq, { resolve, reject })
+        );
+        binding(JSON.stringify({ type, name: bindingName, seq, args }));
+        return promise;
+      };
+    }
+    JAVASCRIPT
+
+    source = JavaScriptFunction.new(add_page_binding, ['exposedFun', name]).source
+    @client.send_message('Runtime.addBinding', name: name)
+    @client.send_message('Page.addScriptToEvaluateOnNewDocument', source: source)
+
+    promises = @frame_manager.frames.map do |frame|
+      frame.async_evaluate("() => #{source}")
+    end
+    await_all(*promises)
+
+    nil
+  end
   # /**
   #  * @param {string} name
   #  * @param {Function} puppeteerFunction
@@ -440,36 +508,10 @@ class Puppeteer::Page
     @frame_manager.network_manager.user_agent = user_agent
   end
 
-  # /**
-  #  * @return {!Promise<!Metrics>}
-  #  */
-  # async metrics() {
-  #   const response = await this._client.send('Performance.getMetrics');
-  #   return this._buildMetricsObject(response.metrics);
-  # }
-
-  # /**
-  #  * @param {!Protocol.Performance.metricsPayload} event
-  #  */
-  # _emitMetrics(event) {
-  #   this.emit(PageEmittedEvents::Metrics, {
-  #     title: event.title,
-  #     metrics: this._buildMetricsObject(event.metrics)
-  #   });
-  # }
-
-  # /**
-  #  * @param {?Array<!Protocol.Performance.Metric>} metrics
-  #  * @return {!Metrics}
-  #  */
-  # _buildMetricsObject(metrics) {
-  #   const result = {};
-  #   for (const metric of metrics || []) {
-  #     if (supportedMetrics.has(metric.name))
-  #       result[metric.name] = metric.value;
-  #   }
-  #   return result;
-  # }
+  def metrics
+    response = @client.send_message('Performance.getMetrics')
+    Metrics.new(response['metrics'])
+  end
 
   class PageError < StandardError ; end
 
@@ -506,56 +548,51 @@ class Puppeteer::Page
     add_console_message(event['type'], values, event['stackTrace'])
   end
 
-  # /**
-  #  * @param {!Protocol.Runtime.bindingCalledPayload} event
-  #  */
-  # async _onBindingCalled(event) {
-  #   const {name, seq, args} = JSON.parse(event.payload);
-  #   let expression = null;
-  #   try {
-  #     const result = await this._pageBindings.get(name)(...args);
-  #     expression = helper.evaluationString(deliverResult, name, seq, result);
-  #   } catch (error) {
-  #     if (error instanceof Error)
-  #       expression = helper.evaluationString(deliverError, name, seq, error.message, error.stack);
-  #     else
-  #       expression = helper.evaluationString(deliverErrorValue, name, seq, error);
-  #   }
-  #   this._client.send('Runtime.evaluate', { expression, contextId: event.executionContextId }).catch(debugError);
-
-  #   /**
-  #    * @param {string} name
-  #    * @param {number} seq
-  #    * @param {*} result
-  #    */
-  #   function deliverResult(name, seq, result) {
-  #     window[name]['callbacks'].get(seq).resolve(result);
-  #     window[name]['callbacks'].delete(seq);
-  #   }
+  def handle_binding_called(event)
+    execution_context_id = event['executionContextId']
+    payload =
+      begin
+        JSON.parse(event['payload'])
+      rescue
+        # The binding was either called by something in the page or it was
+        # called before our wrapper was initialized.
+        return
+      end
+    name = payload['name']
+    seq = payload['seq']
+    args = payload['args']
 
-  #   /**
-  #    * @param {string} name
-  #    * @param {number} seq
-  #    * @param {string} message
-  #    * @param {string} stack
-  #    */
-  #   function deliverError(name, seq, message, stack) {
-  #     const error = new Error(message);
-  #     error.stack = stack;
-  #     window[name]['callbacks'].get(seq).reject(error);
-  #     window[name]['callbacks'].delete(seq);
-  #   }
+    if payload['type'] != 'exposedFun' || !@page_bindings[name]
+      return
+    end
 
-  #   /**
-  #    * @param {string} name
-  #    * @param {number} seq
-  #    * @param {*} value
-  #    */
-  #   function deliverErrorValue(name, seq, value) {
-  #     window[name]['callbacks'].get(seq).reject(value);
-  #     window[name]['callbacks'].delete(seq);
-  #   }
-  # }
+    expression =
+      begin
+        result = @page_bindings[name].call(*args)
+
+        deliver_result = <<~JAVASCRIPT
+        function (name, seq, result) {
+          window[name].callbacks.get(seq).resolve(result);
+          window[name].callbacks.delete(seq);
+        }
+        JAVASCRIPT
+
+        JavaScriptFunction.new(deliver_result, [name, seq, result]).source
+      rescue => err
+        deliver_error = <<~JAVASCRIPT
+        function (name, seq, message) {
+          const error = new Error(message);
+          window[name].callbacks.get(seq).reject(error);
+          window[name].callbacks.delete(seq);
+        }
+        JAVASCRIPT
+        JavaScriptFunction.new(deliver_error, [name, seq, err.message]).source
+      end
+
+    @client.async_send_message('Runtime.evaluate', expression: expression, contextId: execution_context_id).rescue do |error|
+      debug_puts(error)
+    end
+  end
 
   private def add_console_message(type, args, stack_trace)
     text_tokens = args.map { |arg| arg.remote_object.value }
@@ -631,10 +668,9 @@ class Puppeteer::Page
   # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
   # @return [Puppeteer::Response]
   def reload(timeout: nil, wait_until: nil)
-    await_all(
-      async_wait_for_navigation(timeout: timeout, wait_until: wait_until),
-      @client.async_send_message('Page.reload'),
-    ).first
+    wait_for_navigation(timeout: timeout, wait_until: wait_until) do
+      @client.send_message('Page.reload')
+    end
   end
 
   def wait_for_navigation(timeout: nil, wait_until: nil)
@@ -760,10 +796,9 @@ class Puppeteer::Page
     entries = history['entries']
     index = history['currentIndex'] + delta
     if_present(entries[index]) do |entry|
-      await_all(
-        async_wait_for_navigation(timeout: timeout, wait_until: wait_until),
-        @client.async_send_message('Page.navigateToHistoryEntry', entryId: entry['id']),
-      )
+      wait_for_navigation(timeout: timeout, wait_until: wait_until) do
+        @client.send_message('Page.navigateToHistoryEntry', entryId: entry['id'])
+      end
     end
   end
 
@@ -799,6 +834,15 @@ class Puppeteer::Page
     @client.send_message('Emulation.setEmulatedMedia', media: media_type_str)
   end
 
+  # @param factor [Number|nil] Factor at which the CPU will be throttled (2x, 2.5x. 3x, ...). Passing `nil` disables cpu throttling.
+  def emulate_cpu_throttling(factor)
+    if factor.nil? || factor >= 1
+      @client.send_message('Emulation.setCPUThrottlingRate', rate: factor || 1)
+    else
+      raise ArgumentError.new('Throttling rate should be greater or equal to 1')
+    end
+  end
+
   # @param features [Array]
   def emulate_media_features(features)
     if features.nil?

data/lib/puppeteer/page/metrics.rb

@@ -0,0 +1,49 @@
+class Puppeteer::Page
+  class Metrics
+    SUPPORTED_KEYS = Set.new([
+      'Timestamp',
+      'Documents',
+      'Frames',
+      'JSEventListeners',
+      'Nodes',
+      'LayoutCount',
+      'RecalcStyleCount',
+      'LayoutDuration',
+      'RecalcStyleDuration',
+      'ScriptDuration',
+      'TaskDuration',
+      'JSHeapUsedSize',
+      'JSHeapTotalSize',
+    ]).freeze
+
+    SUPPORTED_KEYS.each do |key|
+      attr_reader key
+    end
+
+    # @param metrics_result [Hash] response for Performance.getMetrics
+    def initialize(metrics_response)
+      metrics_response.each do |metric|
+        if SUPPORTED_KEYS.include?(metric['name'])
+          instance_variable_set(:"@#{metric['name']}", metric['value'])
+        end
+      end
+    end
+
+    def [](key)
+      if SUPPORTED_KEYS.include?(key.to_s)
+        instance_variable_get(:"@#{key}")
+      else
+        raise ArgumentError.new("invalid metric key specified: #{key}")
+      end
+    end
+  end
+
+  class MetricsEvent
+    def initialize(metrics_event)
+      @title = metrics_event['title']
+      @metrics = Metrics.new(metrics_event['metrics'])
+    end
+
+    attr_reader :title, :metrics
+  end
+end

data/lib/puppeteer/puppeteer.rb

@@ -11,6 +11,7 @@ class Puppeteer::Puppeteer
   class NoViewport ; end
 
   # @param product [String]
+  # @param channel [String|Symbol]
   # @param executable_path [String]
   # @param ignore_default_args [Array<String>|nil]
   # @param handle_SIGINT [Boolean]
@@ -30,6 +31,7 @@ class Puppeteer::Puppeteer
   # @return [Puppeteer::Browser]
   def launch(
     product: nil,
+    channel: nil,
     executable_path: nil,
     ignore_default_args: nil,
     handle_SIGINT: nil,
@@ -48,6 +50,7 @@ class Puppeteer::Puppeteer
     slow_mo: nil
   )
     options = {
+      channel: channel&.to_s,
       executable_path: executable_path,
       ignore_default_args: ignore_default_args,
       handle_SIGINT: handle_SIGINT,
@@ -118,8 +121,8 @@ class Puppeteer::Puppeteer
   end
 
   # @return [String]
-  def executable_path
-    launcher.executable_path
+  def executable_path(channel: nil)
+    launcher.executable_path(channel: channel)
   end
 
   private def launcher
@@ -146,6 +149,11 @@ class Puppeteer::Puppeteer
   #   # ???
   # end
 
+  # @return [Puppeteer::NetworkConditions]
+  def network_conditions
+    Puppeteer::NetworkConditions
+  end
+
   # @param args [Array<String>]
   # @param user_data_dir [String]
   # @param devtools [Boolean]

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 module Puppeteer
-  VERSION = '0.34.2'
+  VERSION = '0.36.0'
 end

data/lib/puppeteer/wait_task.rb

@@ -3,7 +3,7 @@ class Puppeteer::WaitTask
 
   class TerminatedError < StandardError; end
 
-  class TimeoutError < StandardError
+  class TimeoutError < ::Puppeteer::TimeoutError
     def initialize(title:, timeout:)
       super("waiting for #{title} failed: timeout #{timeout}ms exceeded")
     end

data/puppeteer-ruby.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rollbar'
   spec.add_development_dependency 'rspec', '~> 3.10.0 '
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 1.17.0'
+  spec.add_development_dependency 'rubocop', '~> 1.19.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'webrick'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.34.2
+  version: 0.36.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -244,15 +244,14 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
-- Dockerfile
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- docker-compose.yml
 - docs/api_coverage.md
+- lib/puppeteer-ruby.rb
 - lib/puppeteer.rb
 - lib/puppeteer/aria_query_handler.rb
 - lib/puppeteer/browser.rb
@@ -294,7 +293,6 @@ files:
 - lib/puppeteer/keyboard/key_description.rb
 - lib/puppeteer/keyboard/us_keyboard_layout.rb
 - lib/puppeteer/launcher.rb
-- lib/puppeteer/launcher/base.rb
 - lib/puppeteer/launcher/browser_options.rb
 - lib/puppeteer/launcher/chrome.rb
 - lib/puppeteer/launcher/chrome_arg_options.rb
@@ -302,8 +300,11 @@ files:
 - lib/puppeteer/launcher/launch_options.rb
 - lib/puppeteer/lifecycle_watcher.rb
 - lib/puppeteer/mouse.rb
+- lib/puppeteer/network_condition.rb
+- lib/puppeteer/network_conditions.rb
 - lib/puppeteer/network_manager.rb
 - lib/puppeteer/page.rb
+- lib/puppeteer/page/metrics.rb
 - lib/puppeteer/page/pdf_options.rb
 - lib/puppeteer/page/screenshot_options.rb
 - lib/puppeteer/page/screenshot_task_queue.rb

data/Dockerfile

@@ -1,9 +0,0 @@
-FROM circleci/ruby:3.0.0-rc1-buster-node-browsers
-
-USER root
-
-RUN wget -O nightly.tar.bz2 "https://download.mozilla.org/?product=firefox-nightly-latest-ssl&os=linux64&lang=en-US" \
-    && tar xf nightly.tar.bz2 \
-    && ln -s $(pwd)/firefox/firefox /usr/bin/firefox
-
-USER circleci

data/docker-compose.yml

@@ -1,34 +0,0 @@
-version: "3"
-services:
-  chrome:
-    tty: true
-    stdin_open: true
-    build: .
-    environment:
-      BUNDLE_PATH: /usr/local/bundle
-      DEBUG: 1
-      CI: 1
-    volumes:
-      - .:/puppeteer-ruby
-      - bundle-data:/usr/local/bundle
-    working_dir: /puppeteer-ruby
-    command: bundle exec rspec
-
-  firefox:
-    tty: true
-    stdin_open: true
-    build: .
-    environment:
-      BUNDLE_PATH: /usr/local/bundle
-      PUPPETEER_PRODUCT_RSPEC: firefox
-      DEBUG: 1
-      CI: 1
-    volumes:
-      - .:/puppeteer-ruby
-      - bundle-data:/usr/local/bundle
-    working_dir: /puppeteer-ruby
-    command: bundle exec rspec spec/integration/
-
-volumes:
-  bundle-data:
-    driver: local

data/lib/puppeteer/launcher/base.rb

@@ -1,66 +0,0 @@
-module Puppeteer::Launcher
-  class Base
-    # @param {string} projectRoot
-    # @param {string} preferredRevision
-    def initialize(project_root:, preferred_revision:, is_puppeteer_core:)
-      @project_root = project_root
-      @preferred_revision = preferred_revision
-      @is_puppeteer_core = is_puppeteer_core
-    end
-
-    class ExecutablePathNotFound < StandardError; end
-
-    # @returns [String] Chrome Executable file path.
-    # @raise [ExecutablePathNotFound]
-    def resolve_executable_path
-      if !@is_puppeteer_core
-        # puppeteer-core doesn't take into account PUPPETEER_* env variables.
-        executable_path = ENV['PUPPETEER_EXECUTABLE_PATH']
-        if FileTest.exist?(executable_path)
-          return executable_path
-        end
-        raise ExecutablePathNotFound.new(
-          "Tried to use PUPPETEER_EXECUTABLE_PATH env variable to launch browser but did not find any executable at: #{executable_path}",
-        )
-      end
-
-      # temporal logic.
-      if Puppeteer.env.darwin?
-        case self
-        when Chrome
-          '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'
-        when Firefox
-          '/Applications/Firefox Nightly.app/Contents/MacOS/firefox'
-        end
-      elsif Puppeteer.env.windows?
-        case self
-        when Chrome
-          'C:\Program Files\Google\Chrome\Application\chrome.exe'
-          # 'C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe'
-        when Firefox
-          'C:\Program Files\Firefox Nightly\firefox.exe'
-        end
-      else
-        case self
-        when Chrome
-          '/usr/bin/google-chrome'
-        when Firefox
-          '/usr/bin/firefox'
-        end
-      end
-
-      # const browserFetcher = new BrowserFetcher(launcher._projectRoot);
-      # if (!launcher._isPuppeteerCore) {
-      #   const revision = process.env['PUPPETEER_CHROMIUM_REVISION'];
-      #   if (revision) {
-      #     const revisionInfo = browserFetcher.revisionInfo(revision);
-      #     const missingText = !revisionInfo.local ? 'Tried to use PUPPETEER_CHROMIUM_REVISION env variable to launch browser but did not find executable at: ' + revisionInfo.executablePath : null;
-      #     return {executablePath: revisionInfo.executablePath, missingText};
-      #   }
-      # }
-      # const revisionInfo = browserFetcher.revisionInfo(launcher._preferredRevision);
-      # const missingText = !revisionInfo.local ? `Browser is not downloaded. Run "npm install" or "yarn install"` : null;
-      # return {executablePath: revisionInfo.executablePath, missingText};
-    end
-  end
-end