puppeteer-ruby 0.31.0 → 0.31.6

data/lib/puppeteer.rb

@@ -1,6 +1,6 @@
 require 'concurrent'
 
-class Puppeteer; end
+module Puppeteer; end
 
 require 'puppeteer/env'
 
@@ -43,6 +43,7 @@ require 'puppeteer/lifecycle_watcher'
 require 'puppeteer/mouse'
 require 'puppeteer/network_manager'
 require 'puppeteer/page'
+require 'puppeteer/puppeteer'
 require 'puppeteer/query_handler_manager'
 require 'puppeteer/remote_object'
 require 'puppeteer/request'
@@ -59,9 +60,9 @@ require 'puppeteer/web_socket_transport'
 require 'puppeteer/element_handle'
 
 # ref: https://github.com/puppeteer/puppeteer/blob/master/lib/Puppeteer.js
-class Puppeteer
-  def self.method_missing(method, *args, **kwargs, &block)
-    @puppeteer ||= Puppeteer.new(
+module Puppeteer
+  module_function def method_missing(method, *args, **kwargs, &block)
+    @puppeteer ||= ::Puppeteer::Puppeteer.new(
       project_root: __dir__,
       preferred_revision: '706915',
       is_puppeteer_core: true,
@@ -73,167 +74,4 @@ class Puppeteer
       @puppeteer.public_send(method, *args, **kwargs, &block)
     end
   end
-
-  # @param project_root [String]
-  # @param prefereed_revision [String]
-  # @param is_puppeteer_core [String]
-  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 product [String]
-  # @param executable_path [String]
-  # @param ignore_default_args [Array<String>|nil]
-  # @param handle_SIGINT [Boolean]
-  # @param handle_SIGTERM [Boolean]
-  # @param handle_SIGHUP [Boolean]
-  # @param timeout [Integer]
-  # @param dumpio [Boolean]
-  # @param env [Hash]
-  # @param pipe [Boolean]
-  # @param args [Array<String>]
-  # @param user_data_dir [String]
-  # @param devtools [Boolean]
-  # @param headless [Boolean]
-  # @param ignore_https_errors [Boolean]
-  # @param default_viewport [Puppeteer::Viewport|nil]
-  # @param slow_mo [Integer]
-  # @return [Puppeteer::Browser]
-  def launch(
-    product: nil,
-    executable_path: nil,
-    ignore_default_args: nil,
-    handle_SIGINT: nil,
-    handle_SIGTERM: nil,
-    handle_SIGHUP: nil,
-    timeout: nil,
-    dumpio: nil,
-    env: nil,
-    pipe: nil,
-    args: nil,
-    user_data_dir: nil,
-    devtools: nil,
-    headless: nil,
-    ignore_https_errors: nil,
-    default_viewport: nil,
-    slow_mo: nil
-  )
-    options = {
-      executable_path: executable_path,
-      ignore_default_args: ignore_default_args,
-      handle_SIGINT: handle_SIGINT,
-      handle_SIGTERM: handle_SIGTERM,
-      handle_SIGHUP: handle_SIGHUP,
-      timeout: timeout,
-      dumpio: dumpio,
-      env: env,
-      pipe: pipe,
-      args: args,
-      user_data_dir: user_data_dir,
-      devtools: devtools,
-      headless: headless,
-      ignore_https_errors: ignore_https_errors,
-      default_viewport: default_viewport,
-      slow_mo: slow_mo,
-    }
-
-    @product_name ||= product
-    browser = launcher.launch(options)
-    if block_given?
-      begin
-        yield(browser)
-      ensure
-        browser.close
-      end
-    else
-      browser
-    end
-  end
-
-  # @param browser_ws_endpoint [String]
-  # @param browser_url [String]
-  # @param transport [Puppeteer::WebSocketTransport]
-  # @param ignore_https_errors [Boolean]
-  # @param default_viewport [Puppeteer::Viewport|nil]
-  # @param slow_mo [Integer]
-  # @return [Puppeteer::Browser]
-  def connect(
-    browser_ws_endpoint: nil,
-    browser_url: nil,
-    transport: nil,
-    ignore_https_errors: nil,
-    default_viewport: nil,
-    slow_mo: nil
-  )
-    options = {
-      browser_ws_endpoint: browser_ws_endpoint,
-      browser_url: browser_url,
-      transport: transport,
-      ignore_https_errors: ignore_https_errors,
-      default_viewport: default_viewport,
-      slow_mo: slow_mo,
-    }.compact
-    browser = launcher.connect(options)
-    if block_given?
-      begin
-        yield(browser)
-      ensure
-        browser.disconnect
-      end
-    else
-      browser
-    end
-  end
-
-  # @return [String]
-  def executable_path
-    launcher.executable_path
-  end
-
-  private def launcher
-    @launcher ||= Puppeteer::Launcher.new(
-      project_root: @project_root,
-      preferred_revision: @preferred_revision,
-      is_puppeteer_core: @is_puppeteer_core,
-      product: @product_name,
-    )
-  end
-
-  # @return [String]
-  def product
-    launcher.product
-  end
-
-  # @return [Puppeteer::Devices]
-  def devices
-    Puppeteer::Devices
-  end
-
-  # # @return {Object}
-  # def errors
-  #   # ???
-  # end
-
-  # @param args [Array<String>]
-  # @param user_data_dir [String]
-  # @param devtools [Boolean]
-  # @param headless [Boolean]
-  # @return [Array<String>]
-  def default_args(args: nil, user_data_dir: nil, devtools: nil, headless: nil)
-    options = {
-      args: args,
-      user_data_dir: user_data_dir,
-      devtools: devtools,
-      headless: headless,
-    }.compact
-    launcher.default_args(options)
-  end
-
-  # @param {!BrowserFetcher.Options=} options
-  # @return {!BrowserFetcher}
-  def createBrowserFetcher(options = {})
-    BrowserFetcher.new(@project_root, options)
-  end
 end

data/lib/puppeteer/connection.rb

@@ -46,7 +46,11 @@ class Puppeteer::Connection
     @transport.on_message do |data|
       message = JSON.parse(data)
       sleep_before_handling_message(message)
-      async_handle_message(message)
+      if should_handle_synchronously?(message)
+        handle_message(message)
+      else
+        async_handle_message(message)
+      end
     end
     @transport.on_close do |reason, code|
       handle_close
@@ -71,6 +75,40 @@ class Puppeteer::Connection
     sleep 0.004
   end
 
+  private def should_handle_synchronously?(message)
+    return true if message['id']
+
+    case message['method']
+    when nil
+      false
+    when /^Network\./
+      # Puppeteer doesn't handle any Network monitoring responses.
+      # So we don't care their handling order.
+      false
+    when /^Page\.frame/
+      # Page.frameAttached
+      # Page.frameNavigated
+      # Page.frameDetached
+      # Page.frameStoppedLoading
+      true
+    when 'Page.lifecycleEvent'
+      true
+    when /^Runtime\.executionContext/
+      # - Runtime.executionContextCreated
+      # - Runtime.executionContextDestroyed
+      # - Runtime.executionContextsCleared
+      # These events should be strictly ordered.
+      true
+    when 'Target.attachedToTarget', 'Target.detachedFromTarget'
+      true
+    when 'Target.targetCreated'
+      # type=page must be handled asynchronously for avoiding wait timeout...
+      message.dig('params', 'targetInfo', 'type') == 'browser'
+    else
+      false
+    end
+  end
+
   def self.from_session(session)
     session.connection
   end

data/lib/puppeteer/element_handle.rb

@@ -183,7 +183,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
 
     if error_path = file_paths.find { |file_path| !File.exist?(file_path) }
-      raise ArgmentError.new("#{error_path} does not exist or is not readable")
+      raise ArgumentError.new("#{error_path} does not exist or is not readable")
     end
 
     backend_node_id = @remote_object.node_info(@client)["node"]["backendNodeId"]
@@ -201,9 +201,9 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
         element.dispatchEvent(new Event('change', { bubbles: true }));
       }
       JAVASCRIPT
-      await this.evaluate(fn)
+      await evaluate(fn)
     else
-      @remote_object.set_file_input_files(@client, file_paths, backend_node_id)
+      @remote_object.set_file_input_files(@client, file_paths.map { |path| File.expand_path(path) }, backend_node_id)
     end
   end
 

data/lib/puppeteer/env.rb

@@ -20,8 +20,8 @@ class Puppeteer::Env
   end
 end
 
-class Puppeteer
-  def self.env
-    Puppeteer::Env.new
+module Puppeteer
+  module_function def env
+    ::Puppeteer::Env.new
   end
 end

data/lib/puppeteer/page.rb

@@ -202,6 +202,7 @@ class Puppeteer::Page
   end
 
   attr_reader :javascript_enabled, :target
+  alias_method :javascript_enabled?, :javascript_enabled
 
   def browser
     @target.browser
@@ -586,6 +587,16 @@ class Puppeteer::Page
     emit_event(PageEmittedEvents::Dialog, dialog)
   end
 
+  private def set_transparent_background_color(&block)
+    @client.send_message(
+      'Emulation.setDefaultBackgroundColorOverride',
+      color: { r: 0, g: 0, b: 0, a: 0 })
+  end
+
+  private def reset_default_background_color(&block)
+    @client.send_message('Emulation.setDefaultBackgroundColorOverride')
+  end
+
   # @return [String]
   def url
     main_frame.url
@@ -948,18 +959,14 @@ class Puppeteer::Page
     end
 
     should_set_default_background = screenshot_options.omit_background? && format == 'png'
-    if should_set_default_background
-      @client.send_message('Emulation.setDefaultBackgroundColorOverride', color: { r: 0, g: 0, b: 0, a: 0 })
-    end
+    set_transparent_background_color if should_set_default_background
     screenshot_params = {
       format: format,
       quality: screenshot_options.quality,
       clip: clip,
     }.compact
     result = @client.send_message('Page.captureScreenshot', screenshot_params)
-    if should_set_default_background
-      @client.send_message('Emulation.setDefaultBackgroundColorOverride')
-    end
+    reset_default_background_color if should_set_default_background
 
     if screenshot_options.full_page? && @viewport
       self.viewport = @viewport
@@ -988,7 +995,7 @@ class Puppeteer::Page
 
     def read
       out = StringIO.new
-      File.open(@path, 'w') do |file|
+      File.open(@path, 'wb') do |file|
         eof = false
         until eof
           response = @client.send_message('IO.read', handle: @handle)
@@ -1017,7 +1024,10 @@ class Puppeteer::Page
   # @return [String]
   def pdf(options = {})
     pdf_options = PDFOptions.new(options)
+    omit_background = options[:omit_background]
+    set_transparent_background_color if omit_background
     result = @client.send_message('Page.printToPDF', pdf_options.page_print_args)
+    reset_default_background_color if omit_background
     ProtocolStreamReader.new(client: @client, handle: result['stream'], path: pdf_options.path).read
   rescue => err
     if err.message.include?('PrintToPDF is not implemented')

data/lib/puppeteer/page/pdf_options.rb

@@ -52,24 +52,24 @@ class Puppeteer::Page
     end
 
     PAPER_FORMATS = {
-      letter: PaperSize.new(width: 8.5, height: 11),
-      legal: PaperSize.new(width: 8.5, height: 14),
-      tabloid: PaperSize.new(width: 11, height: 17),
-      ledger: PaperSize.new(width: 17, height: 11),
-      a0: PaperSize.new(width: 33.1, height: 46.8),
-      a1: PaperSize.new(width: 23.4, height: 33.1),
-      a2: PaperSize.new(width: 16.54, height: 23.4),
-      a3: PaperSize.new(width: 11.7, height: 16.54),
-      a4: PaperSize.new(width: 8.27, height: 11.7),
-      a5: PaperSize.new(width: 5.83, height: 8.27),
-      a6: PaperSize.new(width: 4.13, height: 5.83),
+      'letter' => PaperSize.new(width: 8.5, height: 11),
+      'legal' => PaperSize.new(width: 8.5, height: 14),
+      'tabloid' => PaperSize.new(width: 11, height: 17),
+      'ledger' => PaperSize.new(width: 17, height: 11),
+      'a0' => PaperSize.new(width: 33.1, height: 46.8),
+      'a1' => PaperSize.new(width: 23.4, height: 33.1),
+      'a2' => PaperSize.new(width: 16.54, height: 23.4),
+      'a3' => PaperSize.new(width: 11.7, height: 16.54),
+      'a4' => PaperSize.new(width: 8.27, height: 11.7),
+      'a5' => PaperSize.new(width: 5.83, height: 8.27),
+      'a6' => PaperSize.new(width: 4.13, height: 5.83),
     }
 
     UNIT_TO_PIXELS = {
-      px: 1,
-      in: 96,
-      cm: 37.8,
-      mm: 3.78,
+      'px' => 1,
+      'in' => 96,
+      'cm' => 37.8,
+      'mm' => 3.78,
     }
 
     # @param parameter [String|Integer|nil]

data/lib/puppeteer/puppeteer.rb

@@ -0,0 +1,164 @@
+class Puppeteer::Puppeteer
+  # @param project_root [String]
+  # @param prefereed_revision [String]
+  # @param is_puppeteer_core [String]
+  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 product [String]
+  # @param executable_path [String]
+  # @param ignore_default_args [Array<String>|nil]
+  # @param handle_SIGINT [Boolean]
+  # @param handle_SIGTERM [Boolean]
+  # @param handle_SIGHUP [Boolean]
+  # @param timeout [Integer]
+  # @param dumpio [Boolean]
+  # @param env [Hash]
+  # @param pipe [Boolean]
+  # @param args [Array<String>]
+  # @param user_data_dir [String]
+  # @param devtools [Boolean]
+  # @param headless [Boolean]
+  # @param ignore_https_errors [Boolean]
+  # @param default_viewport [Puppeteer::Viewport|nil]
+  # @param slow_mo [Integer]
+  # @return [Puppeteer::Browser]
+  def launch(
+    product: nil,
+    executable_path: nil,
+    ignore_default_args: nil,
+    handle_SIGINT: nil,
+    handle_SIGTERM: nil,
+    handle_SIGHUP: nil,
+    timeout: nil,
+    dumpio: nil,
+    env: nil,
+    pipe: nil,
+    args: nil,
+    user_data_dir: nil,
+    devtools: nil,
+    headless: nil,
+    ignore_https_errors: nil,
+    default_viewport: nil,
+    slow_mo: nil
+  )
+    options = {
+      executable_path: executable_path,
+      ignore_default_args: ignore_default_args,
+      handle_SIGINT: handle_SIGINT,
+      handle_SIGTERM: handle_SIGTERM,
+      handle_SIGHUP: handle_SIGHUP,
+      timeout: timeout,
+      dumpio: dumpio,
+      env: env,
+      pipe: pipe,
+      args: args,
+      user_data_dir: user_data_dir,
+      devtools: devtools,
+      headless: headless,
+      ignore_https_errors: ignore_https_errors,
+      default_viewport: default_viewport,
+      slow_mo: slow_mo,
+    }
+
+    @product_name ||= product
+    browser = launcher.launch(options)
+    if block_given?
+      begin
+        yield(browser)
+      ensure
+        browser.close
+      end
+    else
+      browser
+    end
+  end
+
+  # @param browser_ws_endpoint [String]
+  # @param browser_url [String]
+  # @param transport [Puppeteer::WebSocketTransport]
+  # @param ignore_https_errors [Boolean]
+  # @param default_viewport [Puppeteer::Viewport|nil]
+  # @param slow_mo [Integer]
+  # @return [Puppeteer::Browser]
+  def connect(
+    browser_ws_endpoint: nil,
+    browser_url: nil,
+    transport: nil,
+    ignore_https_errors: nil,
+    default_viewport: nil,
+    slow_mo: nil
+  )
+    options = {
+      browser_ws_endpoint: browser_ws_endpoint,
+      browser_url: browser_url,
+      transport: transport,
+      ignore_https_errors: ignore_https_errors,
+      default_viewport: default_viewport,
+      slow_mo: slow_mo,
+    }.compact
+    browser = launcher.connect(options)
+    if block_given?
+      begin
+        yield(browser)
+      ensure
+        browser.disconnect
+      end
+    else
+      browser
+    end
+  end
+
+  # @return [String]
+  def executable_path
+    launcher.executable_path
+  end
+
+  private def launcher
+    @launcher ||= Puppeteer::Launcher.new(
+      project_root: @project_root,
+      preferred_revision: @preferred_revision,
+      is_puppeteer_core: @is_puppeteer_core,
+      product: @product_name,
+    )
+  end
+
+  # @return [String]
+  def product
+    launcher.product
+  end
+
+  # @return [Puppeteer::Devices]
+  def devices
+    Puppeteer::Devices
+  end
+
+  # # @return {Object}
+  # def errors
+  #   # ???
+  # end
+
+  # @param args [Array<String>]
+  # @param user_data_dir [String]
+  # @param devtools [Boolean]
+  # @param headless [Boolean]
+  # @return [Array<String>]
+  def default_args(args: nil, user_data_dir: nil, devtools: nil, headless: nil)
+    options = {
+      args: args,
+      user_data_dir: user_data_dir,
+      devtools: devtools,
+      headless: headless,
+    }.compact
+    launcher.default_args(options)
+  end
+
+  # @param {!BrowserFetcher.Options=} options
+  # @return {!BrowserFetcher}
+  def createBrowserFetcher(options = {})
+    BrowserFetcher.new(@project_root, options)
+  end
+end