puppeteer-ruby 0.0.11 → 0.0.16

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)
@@ -210,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
@@ -251,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?
@@ -147,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
@@ -411,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

data/lib/puppeteer/execution_context.rb

@@ -1,6 +1,6 @@
 class Puppeteer::ExecutionContext
   include Puppeteer::IfPresent
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   EVALUATION_SCRIPT_URL = '__puppeteer_evaluation_script__'
   SOURCE_URL_REGEX = /^[\040\t]*\/\/[@#] sourceURL=\s*(\S*?)\s*$/m
@@ -16,11 +16,6 @@ class Puppeteer::ExecutionContext
 
   attr_reader :client, :world
 
-  # only used in DomWorld#delete_context
-  def _context_id
-    @context_id
-  end
-
   # @return [Puppeteer::Frame]
   def frame
     if_present(@world) do |world|

data/lib/puppeteer/frame.rb

@@ -1,5 +1,5 @@
 class Puppeteer::Frame
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!FrameManager} frameManager
   # @param {!Puppeteer.CDPSession} client
@@ -39,12 +39,7 @@ class Puppeteer::Frame
     @frame_manager.wait_for_frame_navigation(self, timeout: timeout, wait_until: wait_until)
   end
 
-  # @param timeout [number|nil]
-  # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  # @return [Future]
-  async def async_wait_for_navigation(timeout: nil, wait_until: nil)
-    wait_for_navigation(timeout: timeout, wait_until: wait_until)
-  end
+  define_async_method :async_wait_for_navigation
 
   def execution_context
     @main_world.execution_context
@@ -56,12 +51,16 @@ class Puppeteer::Frame
     @main_world.evaluate_handle(page_function, *args)
   end
 
+  define_async_method :async_evaluate_handle
+
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
   def evaluate(page_function, *args)
     @main_world.evaluate(page_function, *args)
   end
 
+  define_async_method :async_evaluate
+
   # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @return {!Promise<?Puppeteer.ElementHandle>}
@@ -69,6 +68,7 @@ class Puppeteer::Frame
     @main_world.S(selector)
   end
 
+  define_async_method :async_S
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} expression
@@ -77,6 +77,7 @@ class Puppeteer::Frame
     @main_world.Sx(expression)
   end
 
+  define_async_method :async_Sx
 
   # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
@@ -87,6 +88,8 @@ class Puppeteer::Frame
     @main_world.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 {string} selector
   # @param {Function|string} pageFunction
@@ -96,6 +99,8 @@ class Puppeteer::Frame
     @main_world.SSeval(selector, page_function, *args)
   end
 
+  define_async_method :async_SSeval
+
   # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
@@ -103,12 +108,16 @@ class Puppeteer::Frame
     @main_world.SS(selector)
   end
 
+  define_async_method :async_SS
+
+  # @return [String]
   def content
     @secondary_world.content
   end
 
-  # @param {string} html
-  # @param {!{timeout?: number, waitUntil?: string|!Array<string>}=} options
+  # @param html [String]
+  # @param timeout [Integer]
+  # @param wait_until [String|Array<String>]
   def set_content(html, timeout: nil, wait_until: nil)
     @secondary_world.set_content(html, timeout: timeout, wait_until: wait_until)
   end
@@ -152,15 +161,6 @@ class Puppeteer::Frame
     @main_world.add_style_tag(style_tag)
   end
 
-  # @param selector [String]
-  # @param delay [Number]
-  # @param button [String] "left"|"right"|"middle"
-  # @param click_count [Number]
-  # @return [Future]
-  async def async_click(selector, delay: nil, button: nil, click_count: nil)
-    click(selector, delay: delay, button: button, click_count: click_count)
-  end
-
   # @param selector [String]
   # @param delay [Number]
   # @param button [String] "left"|"right"|"middle"
@@ -169,11 +169,15 @@ class Puppeteer::Frame
     @secondary_world.click(selector, delay: delay, button: button, click_count: click_count)
   end
 
+  define_async_method :async_click
+
   # @param {string} selector
   def focus(selector)
     @secondary_world.focus(selector)
   end
 
+  define_async_method :async_focus
+
   # @param {string} selector
   def hover(selector)
     @secondary_world.hover(selector)
@@ -186,11 +190,15 @@ class Puppeteer::Frame
     @secondary_world.select(selector, *values)
   end
 
+  define_async_method :async_select
+
   # @param {string} selector
   def tap(selector)
     @secondary_world.tap(selector)
   end
 
+  define_async_method :async_tap
+
   # @param selector [String]
   # @param text [String]
   # @param delay [Number]
@@ -198,27 +206,7 @@ class Puppeteer::Frame
     @main_world.type_text(selector, text, delay: delay)
   end
 
-  # /**
-  #  * @param {(string|number|Function)} selectorOrFunctionOrTimeout
-  #  * @param {!Object=} options
-  #  * @param {!Array<*>} args
-  #  * @return {!Promise<?Puppeteer.JSHandle>}
-  #  */
-  # waitFor(selectorOrFunctionOrTimeout, options = {}, ...args) {
-  #   const xPathPattern = '//';
-
-  #   if (helper.isString(selectorOrFunctionOrTimeout)) {
-  #     const string = /** @type {string} */ (selectorOrFunctionOrTimeout);
-  #     if (string.startsWith(xPathPattern))
-  #       return this.waitForXPath(string, options);
-  #     return this.waitForSelector(string, options);
-  #   }
-  #   if (helper.isNumber(selectorOrFunctionOrTimeout))
-  #     return new Promise(fulfill => setTimeout(fulfill, /** @type {number} */ (selectorOrFunctionOrTimeout)));
-  #   if (typeof selectorOrFunctionOrTimeout === 'function')
-  #     return this.waitForFunction(selectorOrFunctionOrTimeout, options, ...args);
-  #   return Promise.reject(new Error('Unsupported target type: ' + (typeof selectorOrFunctionOrTimeout)));
-  # }
+  define_async_method :async_type_text
 
   # @param selector [String]
   # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
@@ -235,6 +223,8 @@ class Puppeteer::Frame
     result
   end
 
+  define_async_method :async_wait_for_selector
+
   # @param xpath [String]
   # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
   # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
@@ -250,6 +240,8 @@ class Puppeteer::Frame
     result
   end
 
+  define_async_method :async_wait_for_xpath
+
   # @param {Function|string} pageFunction
   # @param {!{polling?: string|number, timeout?: number}=} options
   # @param {!Array<*>} args
@@ -258,6 +250,9 @@ class Puppeteer::Frame
     @main_world.wait_for_function(page_function, options, *args)
   end
 
+  define_async_method :async_wait_for_function
+
+  # @return [String]
   def title
     @secondary_world.title
   end