puppeteer-ruby 0.37.1 → 0.38.0

data/lib/puppeteer/page.rb

@@ -50,19 +50,26 @@ class Puppeteer::Page
     @workers = {}
     @user_drag_interception_enabled = false
 
-    @client.on_event('Target.attachedToTarget') do |event|
-      if event['targetInfo']['type'] != 'worker'
+    @client.add_event_listener('Target.attachedToTarget') do |event|
+      if event['targetInfo']['type'] != 'worker' && event['targetInfo']['type'] != 'iframe'
         # If we don't detach from service workers, they will never die.
+        # We still want to attach to workers for emitting events.
+        # We still want to attach to iframes so sessions may interact with them.
+        # We detach from all other types out of an abundance of caution.
+        # See https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/devtools_agent_host_impl.cc?ss=chromium&q=f:devtools%20-f:out%20%22::kTypePage%5B%5D%22
+        # for the complete list of available types.
         @client.async_send_message('Target.detachFromTarget', sessionId: event['sessionId'])
         next
       end
 
-      session = Puppeteer::Connection.from_session(@client).session(event['sessionId']) # rubocop:disable Lint/UselessAssignment
-      #   const worker = new Worker(session, event.targetInfo.url, this._addConsoleMessage.bind(this), this._handleException.bind(this));
-      #   this._workers.set(event.sessionId, worker);
-      #   this.emit(PageEmittedEvents::WorkerCreated, worker);
+      if event['targetInfo']['type'] == 'worker'
+        session = Puppeteer::Connection.from_session(@client).session(event['sessionId']) # rubocop:disable Lint/UselessAssignment
+        #   const worker = new Worker(session, event.targetInfo.url, this._addConsoleMessage.bind(this), this._handleException.bind(this));
+        #   this._workers.set(event.sessionId, worker);
+        #   this.emit(PageEmittedEvents::WorkerCreated, worker);
+      end
     end
-    @client.on_event('Target.detachedFromTarget') do |event|
+    @client.add_event_listener('Target.detachedFromTarget') do |event|
       session_id = event['sessionId']
       worker = @workers[session_id]
       next unless worker
@@ -103,10 +110,10 @@ class Puppeteer::Page
     @client.on_event('Page.loadEventFired') do |event|
       emit_event(PageEmittedEvents::Load)
     end
-    @client.on('Runtime.consoleAPICalled') do |event|
+    @client.add_event_listener('Runtime.consoleAPICalled') do |event|
       handle_console_api(event)
     end
-    @client.on('Runtime.bindingCalled') do |event|
+    @client.add_event_listener('Runtime.bindingCalled') do |event|
       handle_binding_called(event)
     end
     @client.on_event('Page.javascriptDialogOpening') do |event|
@@ -153,6 +160,12 @@ class Puppeteer::Page
       raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{PageEmittedEvents.values.to_a.join(", ")}")
     end
 
+    if event_name.to_s == 'request'
+      super('request') do |req|
+        req.enqueue_intercept_action(-> { block.call(req) })
+      end
+    end
+
     super(event_name.to_s, &block)
   end
 
@@ -512,7 +525,7 @@ class Puppeteer::Page
       return
     end
 
-    context = @frame_manager.execution_context_by_id(event['executionContextId'])
+    context = @frame_manager.execution_context_by_id(event['executionContextId'], @client)
     values = event['args'].map do |arg|
       remote_object = Puppeteer::RemoteObject.new(arg)
       Puppeteer::JSHandle.create(context: context, remote_object: remote_object)
@@ -638,7 +651,7 @@ class Puppeteer::Page
 
   # @param timeout [number|nil]
   # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  # @return [Puppeteer::Response]
+  # @return [Puppeteer::HTTPResponse]
   def reload(timeout: nil, wait_until: nil)
     wait_for_navigation(timeout: timeout, wait_until: wait_until) do
       @client.send_message('Page.reload')
@@ -658,28 +671,50 @@ class Puppeteer::Page
   private def wait_for_network_manager_event(event_name, predicate:, timeout:)
     option_timeout = timeout || @timeout_settings.timeout
 
-    @wait_for_network_manager_event_listener_ids ||= {}
-    if_present(@wait_for_network_manager_event_listener_ids[event_name]) do |listener_id|
+    promise = resolvable_future
+
+    listener_id = @frame_manager.network_manager.add_event_listener(event_name) do |event_target|
+      if predicate.call(event_target)
+        promise.fulfill(event_target)
+      end
+    end
+
+    begin
+      # Timeout.timeout(0) means "no limit" for timeout.
+      Timeout.timeout(option_timeout / 1000.0) do
+        await_any(promise, session_close_promise)
+      end
+    rescue Timeout::Error
+      raise Puppeteer::TimeoutError.new("waiting for #{event_name} failed: timeout #{option_timeout}ms exceeded")
+    ensure
       @frame_manager.network_manager.remove_event_listener(listener_id)
     end
+  end
+
+  private def wait_for_frame_manager_event(*event_names, predicate:, timeout:)
+    option_timeout = timeout || @timeout_settings.timeout
 
     promise = resolvable_future
 
-    @wait_for_network_manager_event_listener_ids[event_name] =
-      @frame_manager.network_manager.add_event_listener(event_name) do |event_target|
+    listener_ids = event_names.map do |event_name|
+      @frame_manager.add_event_listener(event_name) do |event_target|
         if predicate.call(event_target)
-          promise.fulfill(nil)
+          promise.fulfill(event_target) unless promise.resolved?
         end
       end
+    end
 
     begin
+      # Timeout.timeout(0) means "no limit" for timeout.
       Timeout.timeout(option_timeout / 1000.0) do
         await_any(promise, session_close_promise)
       end
     rescue Timeout::Error
-      raise Puppeteer::TimeoutError.new("waiting for #{event_name} failed: timeout #{timeout}ms exceeded")
+      raise Puppeteer::TimeoutError.new("waiting for #{event_names.join(" or ")} failed: timeout #{option_timeout}ms exceeded")
     ensure
-      @frame_manager.network_manager.remove_event_listener(@wait_for_network_manager_event_listener_ids[event_name])
+      listener_ids.each do |listener_id|
+        @frame_manager.remove_event_listener(listener_id)
+      end
     end
   end
 
@@ -702,7 +737,7 @@ class Puppeteer::Page
       if url
         -> (request) { request.url == url }
       else
-        -> (request) { predicate.call(request) }
+        predicate
       end
 
     wait_for_network_manager_event(NetworkManagerEmittedEvents::Request,
@@ -722,7 +757,7 @@ class Puppeteer::Page
   #  wait_for_request(predicate: -> (req){ req.url.start_with?('https://example.com/search') })
   #
   # @param url [String]
-  # @param predicate [Proc(Puppeteer::Request -> Boolean)]
+  # @param predicate [Proc(Puppeteer::HTTPRequest -> Boolean)]
   define_async_method :async_wait_for_request
 
   def wait_for_response(url: nil, predicate: nil, timeout: nil)
@@ -736,7 +771,7 @@ class Puppeteer::Page
       if url
         -> (response) { response.url == url }
       else
-        -> (response) { predicate.call(response) }
+        predicate
       end
 
     wait_for_network_manager_event(NetworkManagerEmittedEvents::Response,
@@ -748,9 +783,37 @@ class Puppeteer::Page
   # @!method async_wait_for_response(url: nil, predicate: nil, timeout: nil)
   #
   # @param url [String]
-  # @param predicate [Proc(Puppeteer::Request -> Boolean)]
+  # @param predicate [Proc(Puppeteer::HTTPRequest -> Boolean)]
   define_async_method :async_wait_for_response
 
+  def wait_for_frame(url: nil, predicate: nil, timeout: nil)
+    if !url && !predicate
+      raise ArgumentError.new('url or predicate must be specified')
+    end
+    if predicate && !predicate.is_a?(Proc)
+      raise ArgumentError.new('predicate must be a proc.')
+    end
+    frame_predicate =
+      if url
+        -> (frame) { frame.url == url }
+      else
+        predicate
+      end
+
+    wait_for_frame_manager_event(
+      FrameManagerEmittedEvents::FrameAttached,
+      FrameManagerEmittedEvents::FrameNavigated,
+      predicate: frame_predicate,
+      timeout: timeout,
+    )
+  end
+
+  # @!method async_wait_for_frame(url: nil, predicate: nil, timeout: nil)
+  #
+  # @param url [String]
+  # @param predicate [Proc(Puppeteer::Frame -> Boolean)]
+  define_async_method :async_wait_for_frame
+
   # @param timeout [number|nil]
   # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
   def go_back(timeout: nil, wait_until: nil)

data/lib/puppeteer/puppeteer.rb

@@ -44,6 +44,7 @@ class Puppeteer::Puppeteer
     args: nil,
     user_data_dir: nil,
     devtools: nil,
+    debugging_port: nil,
     headless: nil,
     ignore_https_errors: nil,
     default_viewport: NoViewport.new,
@@ -63,6 +64,7 @@ class Puppeteer::Puppeteer
       args: args,
       user_data_dir: user_data_dir,
       devtools: devtools,
+      debugging_port: debugging_port,
       headless: headless,
       ignore_https_errors: ignore_https_errors,
       default_viewport: default_viewport,

data/lib/puppeteer/target.rb

@@ -119,6 +119,11 @@ class Puppeteer::Target
     end
   end
 
+  # @internal
+  def raw_type
+    @target_info.type
+  end
+
   # @return {!Puppeteer.Browser}
   def browser
     @browser_context.browser

data/lib/puppeteer/version.rb

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

data/lib/puppeteer/wait_task.rb

@@ -37,7 +37,7 @@ class Puppeteer::WaitTask
 
     # Since page navigation requires us to re-install the pageScript, we should track
     # timeout on our end.
-    if timeout
+    if timeout && timeout > 0
       timeout_error = TimeoutError.new(title: title, timeout: timeout)
       Concurrent::Promises.schedule(timeout / 1000.0) { terminate(timeout_error) unless @timeout_cleared }
     end

data/lib/puppeteer.rb

@@ -33,10 +33,13 @@ require 'puppeteer/dialog'
 require 'puppeteer/dom_world'
 require 'puppeteer/emulation_manager'
 require 'puppeteer/exception_details'
+require 'puppeteer/executable_path_finder'
 require 'puppeteer/execution_context'
 require 'puppeteer/file_chooser'
 require 'puppeteer/frame'
 require 'puppeteer/frame_manager'
+require 'puppeteer/http_request'
+require 'puppeteer/http_response'
 require 'puppeteer/js_coverage'
 require 'puppeteer/js_handle'
 require 'puppeteer/keyboard'
@@ -50,8 +53,6 @@ require 'puppeteer/protocol_stream_reader'
 require 'puppeteer/puppeteer'
 require 'puppeteer/query_handler_manager'
 require 'puppeteer/remote_object'
-require 'puppeteer/request'
-require 'puppeteer/response'
 require 'puppeteer/target'
 require 'puppeteer/tracing'
 require 'puppeteer/timeout_helper'

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.22.0'
+  spec.add_development_dependency 'rubocop', '~> 1.23.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'webrick'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.37.1
+  version: 0.38.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -282,11 +282,14 @@ files:
 - lib/puppeteer/event_callbackable.rb
 - lib/puppeteer/events.rb
 - lib/puppeteer/exception_details.rb
+- lib/puppeteer/executable_path_finder.rb
 - lib/puppeteer/execution_context.rb
 - lib/puppeteer/file_chooser.rb
 - lib/puppeteer/frame.rb
 - lib/puppeteer/frame_manager.rb
 - lib/puppeteer/geolocation.rb
+- lib/puppeteer/http_request.rb
+- lib/puppeteer/http_response.rb
 - lib/puppeteer/if_present.rb
 - lib/puppeteer/js_coverage.rb
 - lib/puppeteer/js_handle.rb
@@ -313,8 +316,6 @@ files:
 - lib/puppeteer/puppeteer.rb
 - lib/puppeteer/query_handler_manager.rb
 - lib/puppeteer/remote_object.rb
-- lib/puppeteer/request.rb
-- lib/puppeteer/response.rb
 - lib/puppeteer/target.rb
 - lib/puppeteer/timeout_helper.rb
 - lib/puppeteer/timeout_settings.rb