puppeteer-ruby 0.35.0 → 0.37.1

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/page/screenshot_options.rb

@@ -15,7 +15,7 @@ class Puppeteer::Page
     # @params options [Hash]
     def initialize(options)
       if options[:type]
-        unless [:png, :jpeg].include?(options[:type].to_sym)
+        unless [:png, :jpeg, :webp].include?(options[:type].to_sym)
           raise ArgumentError.new("Unknown options.type value: #{options[:type]}")
         end
         @type = options[:type]
@@ -25,6 +25,8 @@ class Puppeteer::Page
           @type = 'png'
         elsif mime_types.include?('image/jpeg')
           @type = 'jpeg'
+        elsif mime_types.include?('image/webp')
+          @type = 'webp'
         else
           raise ArgumentError.new("Unsupported screenshot mime type resolved: #{mime_types}, path: #{options[:path]}")
         end

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
@@ -381,8 +404,9 @@ class Puppeteer::Page
   # @param path [String?]
   # @param content [String?]
   # @param type [String?]
-  def add_script_tag(url: nil, path: nil, content: nil, type: nil)
-    main_frame.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_frame.add_script_tag(url: url, path: path, content: content, type: type, id: id)
   end
 
   # @param url [String?]
@@ -392,37 +416,51 @@ class Puppeteer::Page
     main_frame.add_style_tag(url: url, path: path, content: content)
   end
 
-  # /**
-  #  * @param {string} name
-  #  * @param {Function} puppeteerFunction
-  #  */
-  # async exposeFunction(name, puppeteerFunction) {
-  #   if (this._pageBindings.has(name))
-  #     throw new Error(`Failed to add page binding with name ${name}: window['${name}'] already exists!`);
-  #   this._pageBindings.set(name, puppeteerFunction);
-
-  #   const expression = helper.evaluationString(addPageBinding, name);
-  #   await this._client.send('Runtime.addBinding', {name: name});
-  #   await this._client.send('Page.addScriptToEvaluateOnNewDocument', {source: expression});
-  #   await Promise.all(this.frames().map(frame => frame.evaluate(expression).catch(debugError)));
-
-  #   function addPageBinding(bindingName) {
-  #     const binding = window[bindingName];
-  #     window[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({name: bindingName, seq, args}));
-  #       return promise;
-  #     };
-  #   }
-  # }
+  # @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 username [String?]
   # @param password [String?]
@@ -436,40 +474,16 @@ class Puppeteer::Page
   end
 
   # @param user_agent [String]
-  def user_agent=(user_agent)
-    @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;
-  # }
+  # @param user_agent_metadata [Hash]
+  def set_user_agent(user_agent, user_agent_metadata = nil)
+    @frame_manager.network_manager.set_user_agent(user_agent, user_agent_metadata)
+  end
+  alias_method :user_agent=, :set_user_agent
+
+  def metrics
+    response = @client.send_message('Performance.getMetrics')
+    Metrics.new(response['metrics'])
+  end
 
   class PageError < StandardError ; end
 
@@ -506,56 +520,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);
-  #   }
-
-  #   /**
-  #    * @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);
-  #   }
-
-  #   /**
-  #    * @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);
-  #   }
-  # }
+  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']
+
+    if payload['type'] != 'exposedFun' || !@page_bindings[name]
+      return
+    end
+
+    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 +640,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 +768,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 +806,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?
@@ -921,7 +937,7 @@ class Puppeteer::Page
     main_frame.title
   end
 
-  # @param type [String] "png"|"jpeg"
+  # @param type [String] "png"|"jpeg"|"webp"
   # @param path [String]
   # @param full_page [Boolean]
   # @param clip [Hash]
@@ -1015,11 +1031,20 @@ class Puppeteer::Page
 
   # @return [Enumerable<String>]
   def create_pdf_stream(options = {})
+    timeout_helper = Puppeteer::TimeoutHelper.new('Page.printToPDF',
+                      timeout_ms: options[:timeout],
+                      default_timeout_ms: 30000)
     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
+    result =
+      begin
+        timeout_helper.with_timeout do
+          @client.send_message('Page.printToPDF', pdf_options.page_print_args)
+        end
+      ensure
+        reset_default_background_color if omit_background
+      end
 
     Puppeteer::ProtocolStreamReader.new(
       client: @client,

data/lib/puppeteer/puppeteer.rb

@@ -149,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/timeout_helper.rb

@@ -0,0 +1,22 @@
+require 'timeout'
+
+class Puppeteer::TimeoutHelper
+  # @param timeout_ms [String|Integer|nil]
+  # @param default_timeout_ms [Integer]
+  def initialize(task_name, timeout_ms:, default_timeout_ms:)
+    @task_name = task_name
+    @timeout_ms = (timeout_ms || default_timeout_ms).to_i
+  end
+
+  def with_timeout(&block)
+    if @timeout_ms > 0
+      begin
+        Timeout.timeout(@timeout_ms / 1000.0, &block)
+      rescue Timeout::Error
+        raise Puppeteer::TimeoutError.new("waiting for #{@task_name} failed: timeout #{@timeout_ms}ms exceeded")
+      end
+    else
+      block.call
+    end
+  end
+end

data/lib/puppeteer/tracing.rb

@@ -27,11 +27,16 @@ class Puppeteer::Tracing
       option_categories << 'disabled-by-default-devtools.screenshot'
     end
 
+    ex_cat = option_categories.select { |cat| cat.start_with?('-') }.map { |cat| cat[1..-1] }
+    in_cat = option_categories.reject { |cat| cat.start_with?('-') }
     @path = path
     @recording = true
     @client.send_message('Tracing.start',
       transferMode: 'ReturnAsStream',
-      categories: option_categories.join(','),
+      traceConfig: {
+        excludedCategories: ex_cat,
+        includedCategories: in_cat,
+      },
     )
   end
 

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 module Puppeteer
-  VERSION = '0.35.0'
+  VERSION = '0.37.1'
 end

data/lib/puppeteer/web_socket.rb

@@ -55,6 +55,7 @@ class Puppeteer::WebSocket
   def initialize(url:, max_payload_size:)
     @impl = DriverImpl.new(url)
     @driver = ::WebSocket::Driver.client(@impl, max_length: max_payload_size)
+    @driver.set_header('User-Agent', "Puppeteer #{Puppeteer::VERSION}")
 
     setup
     @driver.start

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'
@@ -54,6 +54,7 @@ require 'puppeteer/request'
 require 'puppeteer/response'
 require 'puppeteer/target'
 require 'puppeteer/tracing'
+require 'puppeteer/timeout_helper'
 require 'puppeteer/timeout_settings'
 require 'puppeteer/touch_screen'
 require 'puppeteer/version'
@@ -66,17 +67,19 @@ require 'puppeteer/element_handle'
 
 # ref: https://github.com/puppeteer/puppeteer/blob/master/lib/Puppeteer.js
 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,
-    )
-
-    if kwargs.empty? # for Ruby < 2.7
-      @puppeteer.public_send(method, *args, &block)
-    else
-      @puppeteer.public_send(method, *args, **kwargs, &block)
+  @puppeteer ||= ::Puppeteer::Puppeteer.new(
+    project_root: __dir__,
+    preferred_revision: '706915',
+    is_puppeteer_core: true,
+  ).tap do |instance|
+    instance.public_methods(false).each do |method_name|
+      define_singleton_method(method_name) do |*args, **kwargs, &block|
+        if kwargs.empty? # for Ruby < 2.7
+          @puppeteer.public_send(method_name, *args, &block)
+        else
+          @puppeteer.public_send(method_name, *args, **kwargs, &block)
+        end
+      end
     end
   end
 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.18.0'
+  spec.add_development_dependency 'rubocop', '~> 1.22.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'webrick'