puppeteer-ruby 0.0.9 → 0.0.14

data/lib/puppeteer/launcher.rb

@@ -4,13 +4,13 @@ require_relative './launcher/chrome'
 require_relative './launcher/chrome_arg_options'
 require_relative './launcher/launch_options'
 
-# https://github.com/puppeteer/puppeteer/blob/master/lib/Launcher.js
+# https://github.com/puppeteer/puppeteer/blob/main/src/node/Launcher.ts
 module Puppeteer::Launcher
-  # @param {string} projectRoot
-  # @param {string} preferredRevision
-  # @param {boolean} isPuppeteerCore
-  # @param {string=} product
-  # @return {!Puppeteer.ProductLauncher}
+  # @param project_root [String]
+  # @param prefereed_revision [String]
+  # @param is_puppeteer_core [String]
+  # @param product [String] 'chrome' or 'firefox' (not implemented yet)
+  # @return [Puppeteer::Launcher::Chrome]
   module_function def new(project_root:, preferred_revision:, is_puppeteer_core:, product:)
     if product == 'firefox'
       raise NotImplementedError.new('FirefoxLauncher is not implemented yet.')

data/lib/puppeteer/launcher/chrome.rb

@@ -1,6 +1,6 @@
 require 'tmpdir'
 
-# https://github.com/puppeteer/puppeteer/blob/master/lib/Launcher.js
+# https://github.com/puppeteer/puppeteer/blob/main/src/node/Launcher.ts
 module Puppeteer::Launcher
   class Chrome < Base
     # @param {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions)=} options
@@ -139,6 +139,7 @@ module Puppeteer::Launcher
       end
     end
 
+    # @return [DefaultArgs]
     def default_args(options = nil)
       if options.nil?
         @default_args ||= DefaultArgs.new(@chrome_arg_options)
@@ -147,8 +148,7 @@ module Puppeteer::Launcher
       end
     end
 
-    # @param {!(Launcher.BrowserOptions & {browserWSEndpoint?: string, browserURL?: string, transport?: !Puppeteer.ConnectionTransport})} options
-    # @return {!Promise<!Browser>}
+    # @return [Puppeteer::Browser]
     def connect(options = {})
       @browser_options = BrowserOptions.new(options)
       browser_ws_endpoint = options[:browser_ws_endpoint]
@@ -187,11 +187,13 @@ module Puppeteer::Launcher
 
     # @return [Puppeteer::Connection]
     private def connect_with_browser_url(browser_url)
-      raise NotImplementedError.new('Puppeteer#connect with browserUrl is not implemented yet.')
-      # const connectionURL = await getWSEndpoint(browserURL);
-      # const connectionTransport = await WebSocketTransport.create(
-      #   connectionURL
-      # );
+      require 'net/http'
+      uri = URI(browser_url)
+      uri.path = '/json/version'
+      response_body = Net::HTTP.get(uri)
+      json = JSON.parse(response_body)
+      connection_url = json['webSocketDebuggerUrl']
+      connect_with_browser_ws_endpoint(connection_url)
     end
 
     # @return [Puppeteer::Connection]

data/lib/puppeteer/mouse.rb

@@ -1,5 +1,5 @@
 class Puppeteer::Mouse
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   module Button
     NONE = 'none'
@@ -44,13 +44,7 @@ class Puppeteer::Mouse
     end
   end
 
-  # @param x [number]
-  # @param y [number]
-  # @param steps [number]
-  # @return [Future]
-  async def async_move(x, y, steps: nil)
-    move(x, y, steps: steps)
-  end
+  define_async_method :async_move
 
   # @param x [number]
   # @param y [number]
@@ -61,27 +55,16 @@ class Puppeteer::Mouse
     # D, [2020-04-15T17:09:47.898422 #88683] DEBUG -- : SEND >> {"sessionId":"0B09EA5E18DEE403E525B3E7FCD7E225","method":"Input.dispatchMouseEvent","params":{"type":"mouseReleased","button":"left","x":0,"y":0,"modifiers":0,"clickCount":1},"id":24}
     # D, [2020-04-15T17:09:47.899711 #88683] DEBUG -- : SEND >> {"sessionId":"0B09EA5E18DEE403E525B3E7FCD7E225","method":"Input.dispatchMouseEvent","params":{"type":"mousePressed","button":"left","x":0,"y":0,"modifiers":0,"clickCount":1},"id":25}
     # D, [2020-04-15T17:09:47.900237 #88683] DEBUG -- : SEND >> {"sessionId":"0B09EA5E18DEE403E525B3E7FCD7E225","method":"Input.dispatchMouseEvent","params":{"type":"mouseMoved","button":"left","x":187,"y":283,"modifiers":0},"id":26}
-    # So we execute move in advance.
+    # So we execute them sequential
     move(x, y)
+    down(button: button, click_count: click_count)
     if delay
-      down(button: button, click_count: click_count)
       sleep(delay / 1000.0)
-      up(button: button, click_count: click_count)
-    else
-      await_all(
-        async_down(button: button, click_count: click_count),
-        async_up(button: button, click_count: click_count),
-      )
     end
+    up(button: button, click_count: click_count)
   end
 
-  # @param x [number]
-  # @param y [number]
-  # @param {!{delay?: number, button?: "left"|"right"|"middle", clickCount?: number}=} options
-  # @return [Future]
-  async def async_click(x, y, delay: nil, button: nil, click_count: nil)
-    click(x, y, delay: delay, button: button, click_count: click_count)
-  end
+  define_async_method :async_click
 
   # @param {!{button?: "left"|"right"|"middle", clickCount?: number}=} options
   def down(button: nil, click_count: nil)
@@ -96,11 +79,7 @@ class Puppeteer::Mouse
     )
   end
 
-  # @param {!{button?: "left"|"right"|"middle", clickCount?: number}=} options
-  # @return [Future]
-  async def async_down(button: nil, click_count: nil)
-    down(button: button, click_count: click_count)
-  end
+  define_async_method :async_down
 
   # @param {!{button?: "left"|"right"|"middle", clickCount?: number}=} options
   def up(button: nil, click_count: nil)
@@ -115,9 +94,5 @@ class Puppeteer::Mouse
     )
   end
 
-  # @param {!{button?: "left"|"right"|"middle", clickCount?: number}=} options
-  # @return [Future]
-  async def async_up(button: nil, click_count: nil)
-    up(button: button, click_count: click_count)
-  end
+  define_async_method :async_up
 end

data/lib/puppeteer/page.rb

@@ -5,7 +5,7 @@ require_relative './page/screenshot_options'
 class Puppeteer::Page
   include Puppeteer::EventCallbackable
   include Puppeteer::IfPresent
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.CDPSession} client
   # @param {!Puppeteer.Target} target
@@ -109,7 +109,7 @@ class Puppeteer::Page
     @client.on_event 'Page.fileChooserOpened' do |event|
       handle_file_chooser(event)
     end
-    @target.on_close do
+    @target.is_closed_promise.then do
       emit_event 'Events.Page.Close'
       @closed = true
     end
@@ -124,6 +124,45 @@ class Puppeteer::Page
     )
   end
 
+  EVENT_MAPPINGS = {
+    close: 'Events.Page.Close',
+    # console: 'Events.Page.Console',
+    # dialog: 'Events.Page.Dialog',
+    domcontentloaded: 'Events.Page.DOMContentLoaded',
+    # error:
+    frameattached: 'Events.Page.FrameAttached',
+    framedetached: 'Events.Page.FrameDetached',
+    framenavigated: 'Events.Page.FrameNavigated',
+    load: 'Events.Page.Load',
+    # metrics: 'Events.Page.Metrics',
+    # pageerror: 'Events.Page.PageError',
+    popup: 'Events.Page.Popup',
+    request: 'Events.Page.Request',
+    requestfailed: 'Events.Page.RequestFailed',
+    requestfinished: 'Events.Page.RequestFinished',
+    response: 'Events.Page.Response',
+    # workercreated: 'Events.Page.WorkerCreated',
+    # workerdestroyed: 'Events.Page.WorkerDestroyed',
+  }
+
+  # @param event_name [Symbol]
+  def on(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
+  # @param event_name [Symbol]
+  def once(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
   def handle_file_chooser(event)
     return if @file_chooser_interceptors.empty?
 
@@ -166,12 +205,7 @@ class Puppeteer::Page
     end
   end
 
-  # @param timeout [Integer]
-  # @return [Future<Puppeteer::FileChooser>]
-  async def async_wait_for_file_chooser(timeout: nil)
-    wait_for_file_chooser(timeout: timeout)
-  end
-
+  define_async_method :async_wait_for_file_chooser
 
   # /**
   #  * @param {!{longitude: number, latitude: number, accuracy: (number|undefined)}} options
@@ -266,6 +300,8 @@ class Puppeteer::Page
     main_frame.S(selector)
   end
 
+  define_async_method :async_S
+
   # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
@@ -273,6 +309,8 @@ class Puppeteer::Page
     main_frame.SS(selector)
   end
 
+  define_async_method :async_SS
+
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
   # @return {!Promise<!Puppeteer.JSHandle>}
@@ -281,6 +319,8 @@ class Puppeteer::Page
     context.evaluate_handle(page_function, *args)
   end
 
+  define_async_method :async_evaluate_handle
+
   # @param {!Puppeteer.JSHandle} prototypeHandle
   # @return {!Promise<!Puppeteer.JSHandle>}
   def query_objects(prototype_handle)
@@ -296,13 +336,7 @@ class Puppeteer::Page
     main_frame.Seval(selector, page_function, *args)
   end
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param selector [String]
-  # @param page_function [String]
-  # @return [Future]
-  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]
@@ -312,13 +346,7 @@ class Puppeteer::Page
     main_frame.SSeval(selector, page_function, *args)
   end
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param selector [String]
-  # @param page_function [String]
-  # @return [Future]
-  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 {string} expression
@@ -327,6 +355,8 @@ class Puppeteer::Page
     main_frame.Sx(expression)
   end
 
+  define_async_method :async_Sx
+
   # /**
   #  * @param {!Array<string>} urls
   #  * @return {!Promise<!Array<Network.Cookie>>}
@@ -651,15 +681,10 @@ class Puppeteer::Page
   # @param timeout [number|nil]
   # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
   private def wait_for_navigation(timeout: nil, wait_until: nil)
-    main_frame.wait_for_navigation(timeout: timeout, wait_until: wait_until)
+    main_frame.send(:wait_for_navigation, 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
 
   # /**
   #  * @param {(string|Function)} urlOrPredicate
@@ -792,6 +817,8 @@ class Puppeteer::Page
     main_frame.evaluate(page_function, *args)
   end
 
+  define_async_method :async_evaluate
+
   # /**
   #  * @param {Function|string} pageFunction
   #  * @param {!Array<*>} args
@@ -806,9 +833,9 @@ class Puppeteer::Page
     @frame_manager.network_manager.cache_enabled = enabled
   end
 
-  # @return {!Promise<string>}
+  # @return [String]
   def title
-    @title
+    main_frame.title
   end
 
   # /**
@@ -943,16 +970,18 @@ class Puppeteer::Page
   #   return await helper.readProtocolStream(this._client, result.stream, path);
   # }
 
-  # @param {!{runBeforeUnload: (boolean|undefined)}=} options
-  def close
-    # assert(!!this._client._connection, 'Protocol error: Connection closed. Most likely the page has been closed.');
-    # const runBeforeUnload = !!options.runBeforeUnload;
-    # if (runBeforeUnload) {
-    #   await this._client.send('Page.close');
-    # } else {
-    #   await this._client._connection.send('Target.closeTarget', { targetId: this._target._targetId });
-    #   await this._target._isClosedPromise;
-    # }
+  # @param run_before_unload [Boolean]
+  def close(run_before_unload: false)
+    unless @client.connection
+      raise 'Protocol error: Connection closed. Most likely the page has been closed.'
+    end
+
+    if run_before_unload
+      @client.send_message('Page.close')
+    else
+      @client.connection.send_message('Target.closeTarget', targetId: @target.target_id)
+      await @target.is_closed_promise
+    end
   end
 
   # @return [boolean]
@@ -970,20 +999,15 @@ class Puppeteer::Page
     main_frame.click(selector, delay: delay, button: button, click_count: click_count)
   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
+  define_async_method :async_click
 
   # @param {string} selector
   def focus(selector)
     main_frame.focus(selector)
   end
 
+  define_async_method :async_focus
+
   # @param {string} selector
   def hover(selector)
     main_frame.hover(selector)
@@ -996,15 +1020,14 @@ class Puppeteer::Page
     main_frame.select(selector, *values)
   end
 
+  define_async_method :async_select
+
   # @param selector [String]
   def tap(selector)
     main_frame.tap(selector)
   end
 
-  # @param selector [String]
-  async def async_tap(selector)
-    tap(selector)
-  end
+  define_async_method :async_tap
 
   # @param selector [String]
   # @param text [String]
@@ -1013,6 +1036,8 @@ class Puppeteer::Page
     main_frame.type_text(selector, text, delay: delay)
   end
 
+  define_async_method :async_type_text
+
   # /**
   #  * @param {(string|number|Function)} selectorOrFunctionOrTimeout
   #  * @param {!{visible?: boolean, hidden?: boolean, timeout?: number, polling?: string|number}=} options
@@ -1031,13 +1056,7 @@ class Puppeteer::Page
     main_frame.wait_for_selector(selector, visible: visible, hidden: hidden, timeout: timeout)
   end
 
-  # @param selector [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.
-  # @param timeout [Integer]
-  async def async_wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil)
-    wait_for_selector(selector, visible: visible, hidden: hidden, timeout: timeout)
-  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.
@@ -1047,13 +1066,7 @@ class Puppeteer::Page
     main_frame.wait_for_xpath(xpath, visible: visible, hidden: hidden, timeout: timeout)
   end
 
-  # @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.
-  # @param timeout [Integer]
-  async def async_wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil)
-    wait_for_xpath(xpath, visible: visible, hidden: hidden, timeout: timeout)
-  end
+  define_async_method :async_wait_for_xpath
 
   # @param {Function|string} pageFunction
   # @param {!{polling?: string|number, timeout?: number}=} options
@@ -1062,4 +1075,6 @@ class Puppeteer::Page
   def wait_for_function(page_function, options = {}, *args)
     main_frame.wait_for_function(page_function, options, *args)
   end
+
+  define_async_method :async_wait_for_function
 end

data/lib/puppeteer/remote_object.rb

@@ -1,7 +1,7 @@
 # providing #valueFromRemoteObject, #releaseObject
 class Puppeteer::RemoteObject
   include Puppeteer::DebugPrint
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param payload [Hash]
   def initialize(payload)
@@ -62,6 +62,15 @@ class Puppeteer::RemoteObject
     client.send_message('DOM.getContentQuads', objectId: @object_id)
   end
 
+  # used in ElementHandle#_box_model
+  def box_model(client)
+    client.send_message('DOM.getBoxModel', objectId: @object_id)
+  rescue => err
+    debug_puts(err)
+    nil
+  end
+
+
   # helper#valueFromRemoteObject
   def value
     if @unserializable_value
@@ -102,10 +111,7 @@ class Puppeteer::RemoteObject
     nil
   end
 
-  # @param client [Puppeteer::CDPSession]
-  async def async_release(client)
-    release(client)
-  end
+  define_async_method :async_release
 
   def converted_arg
     # ported logic from ExecutionContext#convertArgument