puppeteer-ruby 0.0.10 → 0.0.15

data/lib/puppeteer/concurrent_ruby_utils.rb

@@ -1,5 +1,8 @@
 # utility methods for Concurrent::Promises.
 module Puppeteer::ConcurrentRubyUtils
+  # wait for all promises.
+  # REMARK: This method doesn't assure the order of calling.
+  # for example, await_all(async1, async2) calls calls2 -> calls1 often.
   def await_all(*args)
     if args.length == 1 && args[0].is_a?(Enumerable)
       Concurrent::Promises.zip(*(args[0])).value!
@@ -8,6 +11,9 @@ module Puppeteer::ConcurrentRubyUtils
     end
   end
 
+  # wait for first promises.
+  # REMARK: This method doesn't assure the order of calling.
+  # for example, await_all(async1, async2) calls calls2 -> calls1 often.
   def await_any(*args)
     if args.length == 1 && args[0].is_a?(Enumerable)
       Concurrent::Promises.any(*(args[0])).value!
@@ -29,8 +35,12 @@ module Puppeteer::ConcurrentRubyUtils
     Concurrent::Promises.future(&block)
   end
 
-  def resolvable_future
-    Concurrent::Promises.resolvable_future
+  def resolvable_future(&block)
+    future = Concurrent::Promises.resolvable_future
+    if block
+      block.call(future)
+    end
+    future
   end
 end
 

data/lib/puppeteer/connection.rb

@@ -3,7 +3,7 @@ require 'json'
 class Puppeteer::Connection
   include Puppeteer::DebugPrint
   include Puppeteer::EventCallbackable
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   class ProtocolError < StandardError
     def initialize(method:, error_message:, error_data: nil)
@@ -44,7 +44,9 @@ class Puppeteer::Connection
 
     @transport = transport
     @transport.on_message do |data|
-      async_handle_message(JSON.parse(data))
+      message = JSON.parse(data)
+      sleep_before_handling_message(message)
+      async_handle_message(message)
     end
     @transport.on_close do |reason, code|
       handle_close(reason, code)
@@ -54,6 +56,16 @@ class Puppeteer::Connection
     @closed = false
   end
 
+  private def sleep_before_handling_message(message)
+    # Puppeteer doesn't handle any Network monitoring responses.
+    # So we don't have to sleep.
+    return if message['method']&.start_with?('Network.')
+
+    # For some reasons, sleeping a bit reduces trivial errors...
+    # 4ms is an interval of internal shared timer of WebKit.
+    sleep 0.004
+  end
+
   def self.from_session(session)
     session.connection
   end
@@ -198,9 +210,7 @@ class Puppeteer::Connection
     end
   end
 
-  private async def async_handle_message(message)
-    handle_message(message)
-  end
+  private define_async_method :async_handle_message
 
   private def handle_close
     return if @closed
@@ -239,16 +249,6 @@ class Puppeteer::Connection
   def create_session(target_info)
     result = send_message('Target.attachToTarget', targetId: target_info.target_id, flatten: true)
     session_id = result['sessionId']
-
-    # Target.attachedToTarget is often notified after the result of Target.attachToTarget.
-    # D, [2020-04-04T23:04:30.736311 #91875] DEBUG -- : RECV << {"id"=>2, "result"=>{"sessionId"=>"DA002F8A95B04710502CB40D8430B95A"}}
-    # D, [2020-04-04T23:04:30.736649 #91875] DEBUG -- : RECV << {"method"=>"Target.attachedToTarget", "params"=>{"sessionId"=>"DA002F8A95B04710502CB40D8430B95A", "targetInfo"=>{"targetId"=>"EBAB949A7DE63F12CB94268AD3A9976B", "type"=>"page", "title"=>"about:blank", "url"=>"about:blank", "attached"=>true, "browserContextId"=>"46D23767E9B79DD9E589101121F6DADD"}, "waitingForDebugger"=>false}}
-    # So we have to wait for "Target.attachedToTarget" a bit.
-    20.times do
-      if @sessions[session_id]
-        return @sessions[session_id]
-      end
-      sleep 0.1
-    end
+    @sessions[session_id]
   end
 end

data/lib/puppeteer/define_async_method.rb

@@ -0,0 +1,23 @@
+module Puppeteer::DefineAsyncMethod
+  refine Class do
+    def define_async_method(async_method_name)
+      unless async_method_name.to_s.start_with?('async_')
+        raise ArgumentError.new('async method name should start with "async_"')
+      end
+
+      if method_defined?(async_method_name) || private_method_defined?(async_method_name)
+        raise ArgumentError.new("#{async_method_name} is already defined")
+      end
+
+      original_method = instance_method(async_method_name[6..-1])
+      define_method(async_method_name) do |*args|
+        Concurrent::Promises.future do
+          original_method.bind(self).call(*args)
+        rescue => err
+          Logger.new(STDERR).warn(err)
+          raise err
+        end
+      end
+    end
+  end
+end

data/lib/puppeteer/dom_world.rb

@@ -2,7 +2,7 @@ require 'thread'
 
 # https://github.com/puppeteer/puppeteer/blob/master/src/DOMWorld.js
 class Puppeteer::DOMWorld
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.FrameManager} frameManager
   # @param {!Puppeteer.Frame} frame
@@ -12,7 +12,6 @@ class Puppeteer::DOMWorld
     @frame = frame
     @timeout_settings = timeout_settings
     @context_promise = resolvable_future
-    @pending_destroy = []
     @wait_tasks = Set.new
     @detached = false
   end
@@ -24,22 +23,12 @@ class Puppeteer::DOMWorld
     @wait_tasks
   end
 
-  # @param {?Puppeteer.ExecutionContext} context
+  # @param context [Puppeteer::ExecutionContext]
   def context=(context)
-    # D, [2020-04-12T22:45:03.938754 #46154] DEBUG -- : RECV << {"method"=>"Runtime.executionContextCreated", "params"=>{"context"=>{"id"=>3, "origin"=>"https://github.com", "name"=>"", "auxData"=>{"isDefault"=>true, "type"=>"default", "frameId"=>"3AD7F1E82BCBA88BFE31D03BC49FF6CB"}}}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # D, [2020-04-12T22:45:03.938856 #46154] DEBUG -- : RECV << {"method"=>"Runtime.executionContextCreated", "params"=>{"context"=>{"id"=>4, "origin"=>"://", "name"=>"__puppeteer_utility_world__", "auxData"=>{"isDefault"=>false, "type"=>"isolated", "frameId"=>"3AD7F1E82BCBA88BFE31D03BC49FF6CB"}}}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # D, [2020-04-12T22:45:03.938960 #46154] DEBUG -- : RECV << {"method"=>"Runtime.executionContextDestroyed", "params"=>{"executionContextId"=>1}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # D, [2020-04-12T22:45:03.939110 #46154] DEBUG -- : RECV << {"method"=>"Page.frameNavigated", "params"=>{"frame"=>{"id"=>"3AD7F1E82BCBA88BFE31D03BC49FF6CB", "loaderId"=>"301B349884E582986C502CBE020966DF", "url"=>"https://github.com/", "securityOrigin"=>"https://github.com", "mimeType"=>"text/html"}}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # D, [2020-04-12T22:45:03.939793 #46154] DEBUG -- : RECV << {"method"=>"Runtime.executionContextDestroyed", "params"=>{"executionContextId"=>2}, "sessionId"=>"636CEF0C4FEAFC4FE815E9E7B5F7BA68"}
-    # executionContextDestroyed is often notified after executionContextCreated.
-
     if context
-      if @context_promise.fulfilled?
-        @pending_destroy << context._context_id
-        @document = nil
-        @context_promise = resolvable_future
+      unless @context_promise.resolved?
+        @context_promise.fulfill(context)
       end
-      @context_promise.fulfill(context)
       @wait_tasks.each(&:async_rerun)
     else
       raise ArgumentError.new("context should now be nil. Use #delete_context for clearing document.")
@@ -47,12 +36,8 @@ class Puppeteer::DOMWorld
   end
 
   def delete_context(execution_context_id)
-    if @pending_destroy.include?(execution_context_id)
-      @pending_destroy.delete(execution_context_id)
-    else
-      @document = nil
-      @context_promise = resolvable_future
-    end
+    @document = nil
+    @context_promise = resolvable_future
   end
 
   def has_context?
@@ -97,17 +82,18 @@ class Puppeteer::DOMWorld
     document.S(selector)
   end
 
-  class DocumentEvaluationError < StandardError; end
-
   private def evaluate_document
     # sometimes execution_context.evaluate_handle('document') returns null object.
     # D, [2020-04-24T02:17:51.023631 #220] DEBUG -- : RECV << {"id"=>20, "result"=>{"result"=>{"type"=>"object", "subtype"=>"null", "value"=>nil}}, "sessionId"=>"78E9CF1E14D81294E320E7C20E5CDE06"}
     # retry if so.
-    5.times do
-      handle = execution_context.evaluate_handle('document')
-      return handle if handle.is_a?(Puppeteer::ElementHandle)
+    Timeout.timeout(3) do
+      loop do
+        handle = execution_context.evaluate_handle('document')
+        return handle if handle.is_a?(Puppeteer::ElementHandle)
+      end
     end
-    raise DocumentEvaluationError.new("'document' object cannot be evaluated as an Element")
+  rescue Timeout::Error
+    raise 'Bug of puppeteer-ruby...'
   end
 
   private def document
@@ -146,45 +132,48 @@ class Puppeteer::DOMWorld
     document.SS(selector)
   end
 
-  # /**
-  #  * @return {!Promise<String>}
-  #  */
-  # async content() {
-  #   return await this.evaluate(() => {
-  #     let retVal = '';
-  #     if (document.doctype)
-  #       retVal = new XMLSerializer().serializeToString(document.doctype);
-  #     if (document.documentElement)
-  #       retVal += document.documentElement.outerHTML;
-  #     return retVal;
-  #   });
-  # }
+  # @return [String]
+  def content
+    evaluate <<-JAVASCRIPT
+    () => {
+      let retVal = '';
+      if (document.doctype)
+        retVal = new XMLSerializer().serializeToString(document.doctype);
+      if (document.documentElement)
+        retVal += document.documentElement.outerHTML;
+      return retVal;
+    }
+    JAVASCRIPT
+  end
 
-  # /**
-  #  * @param {string} html
-  #  * @param {!{timeout?: number, waitUntil?: string|!Array<string>}=} options
-  #  */
-  # async setContent(html, options = {}) {
-  #   const {
-  #     waitUntil = ['load'],
-  #     timeout = this._timeoutSettings.navigationTimeout(),
-  #   } = options;
-  #   // We rely upon the fact that document.open() will reset frame lifecycle with "init"
-  #   // lifecycle event. @see https://crrev.com/608658
-  #   await this.evaluate(html => {
-  #     document.open();
-  #     document.write(html);
-  #     document.close();
-  #   }, html);
-  #   const watcher = new LifecycleWatcher(this._frameManager, this._frame, waitUntil, timeout);
-  #   const error = await Promise.race([
-  #     watcher.timeoutOrTerminationPromise(),
-  #     watcher.lifecyclePromise(),
-  #   ]);
-  #   watcher.dispose();
-  #   if (error)
-  #     throw error;
-  # }
+  # @param html [String]
+  # @param timeout [Integer]
+  # @param wait_until [String|Array<String>]
+  def set_content(html, timeout: nil, wait_until: nil)
+    option_wait_until = [wait_until || 'load'].flatten
+    option_timeout = @timeout_settings.navigation_timeout
+
+    # We rely upon the fact that document.open() will reset frame lifecycle with "init"
+    # lifecycle event. @see https://crrev.com/608658
+    js = <<-JAVASCRIPT
+    (html) => {
+      document.open();
+      document.write(html);
+      document.close();
+    }
+    JAVASCRIPT
+    evaluate(js, html)
+
+    watcher = Puppeteer::LifecycleWatcher.new(@frame_manager, @frame, option_wait_until, option_timeout)
+    begin
+      await_any(
+        watcher.timeout_or_termination_promise,
+        watcher.lifecycle_promise,
+      )
+    ensure
+      watcher.dispose
+    end
+  end
 
   # /**
   #  * @param {!{url?: string, path?: string, content?: string, type?: string}} options
@@ -410,12 +399,10 @@ class Puppeteer::DOMWorld
   #   return new WaitTask(this, pageFunction, 'function', polling, timeout, ...args).promise;
   # }
 
-  # /**
-  #  * @return {!Promise<string>}
-  #  */
-  # async title() {
-  #   return this.evaluate(() => document.title);
-  # }
+  # @return [String]
+  def title
+    evaluate('() => document.title')
+  end
 
   # @param selector_or_xpath [String]
   # @param is_xpath [Boolean]

data/lib/puppeteer/element_handle.rb

@@ -4,7 +4,7 @@ require_relative './element_handle/point'
 
 class Puppeteer::ElementHandle < Puppeteer::JSHandle
   include Puppeteer::IfPresent
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param context [Puppeteer::ExecutionContext]
   # @param client [Puppeteer::CDPSession]
@@ -105,11 +105,11 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
   end
 
-  #  async hover() {
-  #    await this._scrollIntoViewIfNeeded();
-  #    const {x, y} = await this._clickablePoint();
-  #    await this._page.mouse.move(x, y);
-  #  }
+  def hover
+    scroll_into_view_if_needed
+    point = clickable_point
+    @page.mouse.move(point.x, point.y)
+  end
 
   # @param delay [Number]
   # @param button [String] "left"|"right"|"middle"
@@ -120,12 +120,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     @page.mouse.click(point.x, point.y, delay: delay, button: button, click_count: click_count)
   end
 
-  # @param delay [Number]
-  # @param button [String] "left"|"right"|"middle"
-  # @param click_count [Number]
-  async def async_click(delay: nil, button: nil, click_count: nil)
-    click(delay: delay, button: button, click_count: click_count)
-  end
+  define_async_method :async_click
 
   # @return [Array<String>]
   def select(*values)
@@ -195,17 +190,13 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     @page.touchscreen.tap(point.x, point.y)
   end
 
-  async def async_tap
-    tap
-  end
+  define_async_method :async_tap
 
   def focus
     evaluate('element => element.focus()')
   end
 
-  async def async_focus
-    focus
-  end
+  define_async_method :async_focus
 
   # @param text [String]
   # @param delay [number|nil]
@@ -214,12 +205,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     @page.keyboard.type_text(text, delay: delay)
   end
 
-  # @param text [String]
-  # @param delay [number|nil]
-  # @return [Future]
-  async def async_type_text(text, delay: nil)
-    type_text(text, delay: delay)
-  end
+  define_async_method :async_type_text
 
   # @param key [String]
   # @param delay [number|nil]
@@ -228,12 +214,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     @page.keyboard.press(key, delay: delay)
   end
 
-  # @param key [String]
-  # @param delay [number|nil]
-  # @return [Future]
-  async def async_press(key, delay: nil)
-    press(key, delay: delay)
-  end
+  define_async_method :async_press
 
   # @return [BoundingBox|nil]
   def bounding_box
@@ -356,13 +337,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     result
   end
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param selector [String]
-  # @param page_function [String]
-  # @return [Object]
-  async def async_Seval(selector, page_function, *args)
-    Seval(selector, page_function, *args)
-  end
+  define_async_method :async_Seval
 
   # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param selector [String]
@@ -379,13 +354,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     result
   end
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param selector [String]
-  # @param page_function [String]
-  # @return [Object]
-  async def async_SSeval(selector, page_function, *args)
-    SSeval(selector, page_function, *args)
-  end
+  define_async_method :async_SSeval
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param expression [String]
@@ -408,6 +377,8 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     properties.values.map(&:as_element).compact
   end
 
+  define_async_method :async_Sx
+
   #  /**
   #   * @returns {!Promise<boolean>}
   #   */

data/lib/puppeteer/emulation_manager.rb

@@ -1,5 +1,5 @@
 class Puppeteer::EmulationManager
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.CDPSession} client
   def initialize(client)
@@ -38,9 +38,5 @@ class Puppeteer::EmulationManager
     reload_needed
   end
 
-  # @param viewport [Puppeteer::Viewport]
-  # @return [Future<true|false>]
-  async def async_emulate_viewport(viewport)
-    emulate_viewport(viewport)
-  end
+  define_async_method :async_emulate_viewport
 end

data/lib/puppeteer/event_callbackable.rb

@@ -39,6 +39,17 @@ module Puppeteer::EventCallbackable
     end
   end
 
+  def observe_first(event_name, &block)
+    listener_id = add_event_listener(event_name) do |*args, **kwargs|
+      if kwargs.empty?
+        block.call(*args)
+      else
+        block.call(*args, **kwargs)
+      end
+      remove_event_listener(listener_id)
+    end
+  end
+
   def on_event(event_name, &block)
     @event_callbackable_handlers ||= {}
     @event_callbackable_handlers[event_name] = block