puppeteer-ruby 0.0.22 → 0.28.1

data/lib/puppeteer/browser_runner.rb

@@ -14,7 +14,6 @@ class Puppeteer::BrowserRunner
     @proc = nil
     @connection = nil
     @closed = true
-    @listeners = []
   end
 
   attr_reader :proc, :connection

data/lib/puppeteer/cdp_session.rb

@@ -9,7 +9,7 @@ class Puppeteer::CDPSession
   # @param {string} targetType
   # @param {string} sessionId
   def initialize(connection, target_type, session_id)
-    @callbacks = {}
+    @callbacks = Concurrent::Hash.new
     @connection = connection
     @target_type = target_type
     @session_id = session_id
@@ -31,10 +31,14 @@ class Puppeteer::CDPSession
     if !@connection
       raise Error.new("Protocol error (#{method}): Session closed. Most likely the #{@target_type} has been closed.")
     end
-    id = @connection.raw_send(message: { sessionId: @session_id, method: method, params: params })
+
     promise = resolvable_future
-    callback = Puppeteer::Connection::MessageCallback.new(method: method, promise: promise)
-    @callbacks[id] = callback
+
+    @connection.generate_id do |id|
+      @callbacks[id] = Puppeteer::Connection::MessageCallback.new(method: method, promise: promise)
+      @connection.raw_send(id: id, message: { sessionId: @session_id, method: method, params: params })
+    end
+
     promise
   end
 
@@ -44,10 +48,10 @@ class Puppeteer::CDPSession
       if callback = @callbacks.delete(message['id'])
         callback_with_message(callback, message)
       else
-        raise Error.new("unknown id: #{id}")
+        raise Error.new("unknown id: #{message['id']}")
       end
     else
-      emit_event message['method'], message['params']
+      emit_event(message['method'], message['params'])
     end
   end
 
@@ -79,7 +83,7 @@ class Puppeteer::CDPSession
     end
     @callbacks.clear
     @connection = nil
-    emit_event 'Events.CDPSession.Disconnected'
+    emit_event(CDPSessionEmittedEvents::Disconnected)
   end
 
   # @param event_name [String]

data/lib/puppeteer/concurrent_ruby_utils.rb

@@ -39,9 +39,12 @@ module Puppeteer::ConcurrentRubyUtils
     end
   end
 
-  def future(&block)
-    Concurrent::Promises.future do
-      block.call
+  def future(*args, &block)
+    Concurrent::Promises.future(*args) do |*block_args|
+      block.call(*block_args)
+    rescue Puppeteer::TimeoutError
+      # suppress error logging
+      raise
     rescue => err
       Logger.new($stderr).warn(err)
       raise err

data/lib/puppeteer/connection.rb

@@ -39,7 +39,7 @@ class Puppeteer::Connection
   def initialize(url, transport, delay = 0)
     @url = url
     @last_id = 0
-    @callbacks = {}
+    @callbacks = Concurrent::Hash.new
     @delay = delay
 
     @transport = transport
@@ -52,7 +52,7 @@ class Puppeteer::Connection
       handle_close
     end
 
-    @sessions = {}
+    @sessions = Concurrent::Hash.new
     @closed = false
   end
 
@@ -92,22 +92,41 @@ class Puppeteer::Connection
   end
 
   def async_send_message(method, params = {})
-    id = raw_send(message: { method: method, params: params })
     promise = resolvable_future
-    @callbacks[id] = MessageCallback.new(method: method, promise: promise)
+
+    generate_id do |id|
+      @callbacks[id] = MessageCallback.new(method: method, promise: promise)
+      raw_send(id: id, message: { method: method, params: params })
+    end
+
     promise
   end
 
-  private def generate_id
-    @last_id += 1
+  # package private. not intended to use externally.
+  #
+  # ```usage
+  # connection.generate_id do |generated_id|
+  #   # play with generated_id
+  # end
+  # ````
+  #
+  def generate_id(&block)
+    block.call(@last_id += 1)
   end
 
-  def raw_send(message:)
-    id = generate_id
+  # package private. not intended to use externally.
+  def raw_send(id:, message:)
+    # In original puppeteer (JS) implementation,
+    # id is generated here using #generate_id and the id argument is not passed to #raw_send.
+    #
+    # However with concurrent-ruby, '#handle_message' is sometimes called
+    # just soon after @transport.send_text and **before returning the id.**
+    #
+    # So we have to know the message id in advance before send_text.
+    #
     payload = JSON.fast_generate(message.compact.merge(id: id))
     @transport.send_text(payload)
     request_debug_printer.handle_payload(payload)
-    id
   end
 
   # Just for effective debugging :)
@@ -211,7 +230,7 @@ class Puppeteer::Connection
         end
       end
     else
-      emit_event message['method'], message['params']
+      emit_event(message['method'], message['params'])
     end
   end
 
@@ -233,7 +252,7 @@ class Puppeteer::Connection
       session.handle_closed
     end
     @sessions.clear
-    emit_event 'Events.Connection.Disconnected'
+    emit_event(ConnectionEmittedEvents::Disconnected)
   end
 
   def on_close(&block)

data/lib/puppeteer/define_async_method.rb

@@ -10,12 +10,21 @@ module Puppeteer::DefineAsyncMethod
       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
+      define_method(async_method_name) do |*args, **kwargs|
+        if kwargs.empty? # for Ruby < 2.7
+          Concurrent::Promises.future do
+            original_method.bind(self).call(*args)
+          rescue => err
+            Logger.new($stderr).warn(err)
+            raise err
+          end
+        else
+          Concurrent::Promises.future do
+            original_method.bind(self).call(*args, **kwargs)
+          rescue => err
+            Logger.new($stderr).warn(err)
+            raise err
+          end
         end
       end
     end

data/lib/puppeteer/dom_world.rb

@@ -134,7 +134,7 @@ class Puppeteer::DOMWorld
 
   # @return [String]
   def content
-    evaluate <<-JAVASCRIPT
+    evaluate(<<-JAVASCRIPT)
     () => {
       let retVal = '';
       if (document.doctype)
@@ -151,7 +151,7 @@ class Puppeteer::DOMWorld
   # @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
+    option_timeout = 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

data/lib/puppeteer/event_callbackable.rb

@@ -31,6 +31,8 @@ module Puppeteer::EventCallbackable
     (@event_listeners[event_name] ||= EventListeners.new).add(&block)
   end
 
+  alias_method :on, :add_event_listener
+
   def remove_event_listener(*id_args)
     (@event_listeners ||= {}).each do |event_name, listeners|
       id_args.each do |id|
@@ -50,6 +52,8 @@ module Puppeteer::EventCallbackable
     end
   end
 
+  alias_method :once, :observe_first
+
   def on_event(event_name, &block)
     @event_callbackable_handlers ||= {}
     @event_callbackable_handlers[event_name] = block

data/lib/puppeteer/events.rb

@@ -0,0 +1,184 @@
+require 'digest/md5'
+
+module EventsDefinitionUtils
+  refine Kernel do
+    # Symbol is used to prevent external parties listening to these events
+    def Symbol(str)
+      Digest::MD5.hexdigest(str)
+    end
+  end
+
+  refine Hash do
+    def define_const_into(target_module)
+      each do |key, value|
+        target_module.const_set(key, value)
+        target_module.define_singleton_method(key) { value }
+      end
+      keyset = Set.new(keys)
+      valueset = Set.new(values)
+      target_module.define_singleton_method(:keys) { keyset }
+      target_module.define_singleton_method(:values) { valueset }
+    end
+  end
+end
+
+using EventsDefinitionUtils
+
+# Internal events that the Connection class emits.
+module ConnectionEmittedEvents ; end
+
+{
+  Disconnected: Symbol('Connection.Disconnected'),
+}.define_const_into(ConnectionEmittedEvents)
+
+# Internal events that the CDPSession class emits.
+module CDPSessionEmittedEvents ; end
+
+{
+  Disconnected: Symbol('CDPSession.Disconnected'),
+}.define_const_into(CDPSessionEmittedEvents)
+
+# All the events a Browser may emit.
+module BrowserEmittedEvents ; end
+
+{
+  # Emitted when Puppeteer gets disconnected from the Chromium instance. This might happen because of one of the following:
+  # - Chromium is closed or crashed
+  # - The Browser#disconnect method was called.
+  Disconnected: 'disconnected',
+
+  # Emitted when the url of a target changes. Contains a {@link Target} instance.
+  TargetChanged: 'targetchanged',
+
+  # Emitted when a target is created, for example when a new page is opened by
+  # window.open or by Browser#newPage
+  # Contains a Target instance.
+  TargetCreated: 'targetcreated',
+
+  # Emitted when a target is destroyed, for example when a page is closed.
+  # Contains a Target instance.
+  TargetDestroyed: 'targetdestroyed',
+}.define_const_into(BrowserEmittedEvents)
+
+module BrowserContextEmittedEvents ; end
+
+{
+  # Emitted when the url of a target inside the browser context changes.
+  # Contains a Target instance.
+  TargetChanged: 'targetchanged',
+
+  # Emitted when a target is created, for example when a new page is opened by
+  # window.open or by BrowserContext#newPage
+  # Contains a Target instance.
+  TargetCreated: 'targetcreated',
+
+  # Emitted when a target is destroyed within the browser context, for example when a page is closed.
+  # Contains a Target instance.
+  TargetDestroyed: 'targetdestroyed',
+}.define_const_into(BrowserContextEmittedEvents)
+
+# We use symbols to prevent any external parties listening to these events.
+# They are internal to Puppeteer.
+module NetworkManagerEmittedEvents ; end
+
+{
+  Request: Symbol('NetworkManager.Request'),
+  Response: Symbol('NetworkManager.Response'),
+  RequestFailed: Symbol('NetworkManager.RequestFailed'),
+  RequestFinished: Symbol('NetworkManager.RequestFinished'),
+}.define_const_into(NetworkManagerEmittedEvents)
+
+
+# We use symbols to prevent external parties listening to these events.
+# They are internal to Puppeteer.
+module FrameManagerEmittedEvents ; end
+
+{
+  FrameAttached: Symbol('FrameManager.FrameAttached'),
+  FrameNavigated: Symbol('FrameManager.FrameNavigated'),
+  FrameDetached: Symbol('FrameManager.FrameDetached'),
+  LifecycleEvent: Symbol('FrameManager.LifecycleEvent'),
+  FrameNavigatedWithinDocument: Symbol('FrameManager.FrameNavigatedWithinDocument'),
+  ExecutionContextCreated: Symbol('FrameManager.ExecutionContextCreated'),
+  ExecutionContextDestroyed: Symbol('FrameManager.ExecutionContextDestroyed'),
+}.define_const_into(FrameManagerEmittedEvents)
+
+# All the events that a page instance may emit.
+module PageEmittedEvents ; end
+
+{
+  # Emitted when the page closes.
+  Close: 'close',
+
+  # Emitted when JavaScript within the page calls one of console API methods,
+  # e.g. `console.log` or `console.dir`. Also emitted if the page throws an
+  # error or a warning.
+  Console: 'console',
+
+  # Emitted when a JavaScript dialog appears, such as `alert`, `prompt`,
+  # `confirm` or `beforeunload`. Puppeteer can respond to the dialog via
+  # Dialog#accept or Dialog#dismiss.
+  Dialog: 'dialog',
+
+  # Emitted when the JavaScript
+  # {https://developer.mozilla.org/en-US/docs/Web/Events/DOMContentLoaded DOMContentLoaded} event is dispatched.
+  DOMContentLoaded: 'domcontentloaded',
+
+  # Emitted when the page crashes. Will contain an `Error`.
+  Error: 'error',
+
+  # Emitted when a frame is attached. Will contain a Frame.
+  FrameAttached: 'frameattached',
+  # Emitted when a frame is detached. Will contain a Frame.
+  FrameDetached: 'framedetached',
+  # Emitted when a frame is navigated to a new URL. Will contain a {@link Frame}.
+  FrameNavigated: 'framenavigated',
+
+  # Emitted when the JavaScript
+  # {https://developer.mozilla.org/en-US/docs/Web/Events/load | load} event is dispatched.
+  Load: 'load',
+
+  # Emitted when the JavaScript code makes a call to `console.timeStamp`. For
+  # the list of metrics see {@link Page.metrics | page.metrics}.
+  #
+  # Contains an object with two properties:
+  # - `title`: the title passed to `console.timeStamp`
+  # - `metrics`: objec containing metrics as key/value pairs. The values will be `number`s.
+  Metrics: 'metrics',
+
+  # Emitted when an uncaught exception happens within the page.
+  # Contains an `Error`.
+  PageError: 'pageerror',
+
+  # Emitted when the page opens a new tab or window.
+  # Contains a Page corresponding to the popup window.
+  Popup: 'popup',
+
+  # Emitted when a page issues a request and contains a HTTPRequest.
+  #
+  # The object is readonly. See Page#setRequestInterception for intercepting and mutating requests.
+  Request: 'request',
+
+  # Emitted when a request fails, for example by timing out.
+  #
+  # Contains a HTTPRequest.
+  #
+  # NOTE: HTTP Error responses, such as 404 or 503, are still successful
+  # responses from HTTP standpoint, so request will complete with
+  # `requestfinished` event and not with `requestfailed`.
+  RequestFailed: 'requestfailed',
+
+  # Emitted when a request finishes successfully. Contains a HTTPRequest.
+  RequestFinished: 'requestfinished',
+
+  # Emitted when a response is received. Contains a HTTPResponse.
+  Response: 'response',
+
+  # Emitted when a dedicated
+  # {https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API WebWorker} is spawned by the page.
+  WorkerCreated: 'workercreated',
+
+  # Emitted when a dedicated
+  # {https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API WebWorker} is destroyed by the page.
+  WorkerDestroyed: 'workerdestroyed',
+}.define_const_into(PageEmittedEvents)

data/lib/puppeteer/exception_details.rb

@@ -0,0 +1,38 @@
+# Original implementation, helpers.getExceptionMessage
+class Puppeteer::ExceptionDetails
+  # @param exception_details [Hash]
+  def initialize(exception_details)
+    @exception_details = exception_details
+  end
+
+  def message
+    # "exceptionDetails"=>{"exceptionId"=>1, "text"=>"Uncaught", "lineNumber"=>12, "columnNumber"=>10, "url"=>"http://127.0.0.1:4567/error.html",
+    #  "stackTrace"=>{"callFrames"=>[
+    #   {"functionName"=>"c", "scriptId"=>"6", "url"=>"http://127.0.0.1:4567/error.html", "lineNumber"=>12, "columnNumber"=>10},
+    #   {"functionName"=>"b", "scriptId"=>"6", "url"=>"http://127.0.0.1:4567/error.html", "lineNumber"=>8, "columnNumber"=>4},
+    #   {"functionName"=>"a", "scriptId"=>"6", "url"=>"http://127.0.0.1:4567/error.html", "lineNumber"=>4, "columnNumber"=>4},
+    #   {"functionName"=>"", "scriptId"=>"6", "url"=>"http://127.0.0.1:4567/error.html", "lineNumber"=>1, "columnNumber"=>0}
+    #  ]},
+    #  "exception"=>{"type"=>"object", "subtype"=>"error", "className"=>"Error", "description"=>"Error: Fancy error!\n    at c (http://127.0.0.1:4567/error.html:13:11)\n    at b (http://127.0.0.1:4567/error.html:9:5)\n    at a (http://127.0.0.1:4567/error.html:5:5)\n    at http://127.0.0.1:4567/error.html:2:1", "objectId"=>"{\"injectedScriptId\":3,\"id\":1}", "preview"=>{"type"=>"object", "subtype"=>"error", "description"=>"Error: Fancy error!\n    at c (http://127.0.0.1:4567/error.html:13:11)\n    at b (http://127.0.0.1:4567/error.html:9:5)\n    at a (http://127.0.0.1:4567/error.html:5:5)\n    at http://127.0.0.1:4567/error.html:2:1", "overflow"=>false, "properties"=>[{"name"=>"stack", "type"=>"string", "value"=>"Error: Fancy error!\n    at c (http://127.0.0.1:456…:5:5)\n    at http://127.0.0.1:4567/error.html:2:1"}, {"name"=>"message", "type"=>"string", "value"=>"Fancy error!"}]}}
+    if @exception_details['exception']
+      return exception_description_or_value(@exception_details['exception'])
+    end
+
+    messages = []
+    messages << @exception_details['text']
+
+    if @exception_details['stackTrace']
+      @exception_details['stackTrace']['callFrames'].each do |call_frame|
+        location = "#{call_frame['url']}:#{call_frame['lineNumber']}:#{call_frame['columnNumber']}"
+        function_name = call_frame['functionName'] || '<anonymous>'
+        messages << "at #{function_name} (#{location})"
+      end
+    end
+
+    messages.join("\n    ")
+  end
+
+  private def exception_description_or_value(exception)
+    exception['description'] || exception['value']
+  end
+end

data/lib/puppeteer/frame_manager.rb

@@ -27,31 +27,31 @@ class Puppeteer::FrameManager
     # @type {!Set<string>}
     @isolated_worlds = Set.new
 
-    @client.on_event 'Page.frameAttached' do |event|
+    @client.on_event('Page.frameAttached') do |event|
       handle_frame_attached(event['frameId'], event['parentFrameId'])
     end
-    @client.on_event 'Page.frameNavigated' do |event|
+    @client.on_event('Page.frameNavigated') do |event|
       handle_frame_navigated(event['frame'])
     end
-    @client.on_event 'Page.navigatedWithinDocument' do |event|
+    @client.on_event('Page.navigatedWithinDocument') do |event|
       handle_frame_navigated_within_document(event['frameId'], event['url'])
     end
-    @client.on_event 'Page.frameDetached' do |event|
+    @client.on_event('Page.frameDetached') do |event|
       handle_frame_detached(event['frameId'])
     end
-    @client.on_event 'Page.frameStoppedLoading' do |event|
+    @client.on_event('Page.frameStoppedLoading') do |event|
       handle_frame_stopped_loading(event['frameId'])
     end
-    @client.on_event 'Runtime.executionContextCreated' do |event|
+    @client.on_event('Runtime.executionContextCreated') do |event|
       handle_execution_context_created(event['context'])
     end
-    @client.on_event 'Runtime.executionContextDestroyed' do |event|
+    @client.on_event('Runtime.executionContextDestroyed') do |event|
       handle_execution_context_destroyed(event['executionContextId'])
     end
-    @client.on_event 'Runtime.executionContextsCleared' do |event|
+    @client.on_event('Runtime.executionContextsCleared') do |event|
       handle_execution_contexts_cleared
     end
-    @client.on_event 'Page.lifecycleEvent' do |event|
+    @client.on_event('Page.lifecycleEvent') do |event|
       handle_lifecycle_event(event)
     end
   end
@@ -121,6 +121,8 @@ class Puppeteer::FrameManager
         document_navigation_promise,
         watcher.timeout_or_termination_promise,
       )
+    rescue Puppeteer::TimeoutError => err
+      raise NavigationError.new(err)
     ensure
       watcher.dispose
     end
@@ -143,6 +145,8 @@ class Puppeteer::FrameManager
         watcher.same_document_navigation_promise,
         watcher.new_document_navigation_promise,
       )
+    rescue Puppeteer::TimeoutError => err
+      raise NavigationError.new(err)
     ensure
       watcher.dispose
     end
@@ -155,7 +159,7 @@ class Puppeteer::FrameManager
     frame = @frames[event['frameId']]
     return if !frame
     frame.handle_lifecycle_event(event['loaderId'], event['name'])
-    emit_event 'Events.FrameManager.LifecycleEvent', frame
+    emit_event(FrameManagerEmittedEvents::LifecycleEvent, frame)
   end
 
   # @param {string} frameId
@@ -163,7 +167,7 @@ class Puppeteer::FrameManager
     frame = @frames[frame_id]
     return if !frame
     frame.handle_loading_stopped
-    emit_event 'Events.FrameManager.LifecycleEvent', frame
+    emit_event(FrameManagerEmittedEvents::LifecycleEvent, frame)
   end
 
   # @param frame_tree [Hash]
@@ -211,7 +215,7 @@ class Puppeteer::FrameManager
     frame = Puppeteer::Frame.new(self, @client, parent_frame, frame_id)
     @frames[frame_id] = frame
 
-    emit_event 'Events.FrameManager.FrameAttached', frame
+    emit_event(FrameManagerEmittedEvents::FrameAttached, frame)
   end
 
   # @param frame_payload [Hash]
@@ -252,7 +256,7 @@ class Puppeteer::FrameManager
     # Update frame payload.
     frame.navigated(frame_payload)
 
-    emit_event 'Events.FrameManager.FrameNavigated', frame
+    emit_event(FrameManagerEmittedEvents::FrameNavigated, frame)
   end
 
   # @param name [String]
@@ -280,8 +284,8 @@ class Puppeteer::FrameManager
     frame = @frames[frame_id]
     return unless frame
     frame.navigated_within_document(url)
-    emit_event 'Events.FrameManager.FrameNavigatedWithinDocument', frame
-    emit_event 'Events.FrameManager.FrameNavigated', frame
+    emit_event(FrameManagerEmittedEvents::FrameNavigatedWithinDocument, frame)
+    emit_event(FrameManagerEmittedEvents::FrameNavigated, frame)
   end
 
   # @param frame_id [String]
@@ -349,7 +353,7 @@ class Puppeteer::FrameManager
     end
     frame.detach
     @frames.delete(frame.id)
-    emit_event 'Events.FrameManager.FrameDetached', frame
+    emit_event(FrameManagerEmittedEvents::FrameDetached, frame)
   end
 
   private def assert_no_legacy_navigation_options(wait_until:)