puppeteer-ruby 0.37.1 → 0.37.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56a2cd3d9440bce6f77f2a072e8c8e7ea83fdd3d65a7e85e1887f7f7dd4481ce
-  data.tar.gz: 337c5cd7e4c23bd5e3c154bbaaae229d4285c8ba491ca427197ee7449c1f1849
+  metadata.gz: a83ed41b8bd2c8068dc4a1738fa16abe80e88e59fb21c4768994ae640bb5b567
+  data.tar.gz: 6e67fb0d381644bb376d09d01213320170aa5f9ec429694c9b98888bd2006722
 SHA512:
-  metadata.gz: '005883b864a160d29a8879a8d54945edbce02f6d1b80a0f8816d84244b46c62d11417e2bcf2bc67e8b7f7a4486dc201ecb2961070fe875fc948be0483be8bcee'
-  data.tar.gz: 1a7cd9d0c2aacde091d0f6d0738c61e4a28a96830f2b65dae8e6e84fd3c190ea69bf8e964748d61020f264bfcbc25901e4e1895289b1a98a7d5452c03e2647de
+  metadata.gz: b229ccf33f63425298aa0d70051d6d6a1d61d9509bf6030499521b11494fb7b9ece03fa63ab5c31be6b0a552f28b5d7b571b6c930027445cee60bbcadaada24c
+  data.tar.gz: 6f35fb3ea22f4cd557e062576fdb95939f16e62c611f09469bf8d7647f72ff380000e1b94ac8e1412b03f9107124a5ce21914c4e2b839e893ecd275ed73b9ef3

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.37.1...master)]
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.37.2...master)]
 
 - xxx
 
+### 0.37.2 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.37.1...0.37.2)]
+
+Bugfix:
+
+- `timeout: 0` did set the timeout value to zero. Now it disables the timeout as expected.
+
 ### 0.37.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.37.0...0.37.1)]
 
 Bugfix:

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
-- Puppeteer version: v10.4.0
-- puppeteer-ruby version: 0.37.1
+- Puppeteer version: v11.0.0
+- puppeteer-ruby version: 0.37.2
 
 ## Puppeteer
 
@@ -134,6 +134,7 @@
 * viewport
 * ~~waitFor~~
 * waitForFileChooser => `#wait_for_file_chooser`
+* ~~waitForFrame~~
 * waitForFunction => `#wait_for_function`
 * waitForNavigation => `#wait_for_navigation`
 * ~~waitForNetworkIdle~~
@@ -226,6 +227,7 @@
 * goto
 * hover
 * isDetached => `#detached?`
+* ~~isOOPFrame~~
 * name
 * parentFrame => `#parent_frame`
 * select
@@ -295,43 +297,44 @@
 * type => `#type_text`
 * uploadFile => `#upload_file`
 
-## ~~HTTPRequest~~
-
-* ~~abort~~
-* ~~abortErrorReason~~
-* ~~continue~~
-* ~~continueRequestOverrides~~
-* ~~enqueueInterceptAction~~
-* ~~failure~~
-* ~~finalizeInterceptions~~
-* ~~frame~~
-* ~~headers~~
-* ~~isNavigationRequest~~
-* ~~method~~
-* ~~postData~~
-* ~~redirectChain~~
-* ~~resourceType~~
-* ~~respond~~
-* ~~response~~
-* ~~responseForRequest~~
-* ~~url~~
+## HTTPRequest
+
+* abort
+* abortErrorReason => `#abort_error_reason`
+* continue
+* continueRequestOverrides => `#continue_request_overrides`
+* enqueueInterceptAction => `#enqueue_intercept_action`
+* failure
+* finalizeInterceptions => `#finalize_interceptions`
+* frame
+* headers
+* ~~initiator~~
+* isNavigationRequest => `#navigation_request?`
+* method
+* postData => `#post_data`
+* redirectChain => `#redirect_chain`
+* resourceType => `#resource_type`
+* respond
+* response
+* responseForRequest => `#response_for_request`
+* url
 
-## ~~HTTPResponse~~
+## HTTPResponse
 
-* ~~buffer~~
-* ~~frame~~
+* buffer
+* frame
 * ~~fromCache~~
 * ~~fromServiceWorker~~
-* ~~headers~~
-* ~~json~~
+* headers
+* json
 * ~~ok~~
-* ~~remoteAddress~~
-* ~~request~~
-* ~~securityDetails~~
-* ~~status~~
-* ~~statusText~~
-* ~~text~~
-* ~~url~~
+* remoteAddress => `#remote_address`
+* request
+* securityDetails => `#security_details`
+* status
+* statusText => `#status_text`
+* text
+* url
 
 ## ~~SecurityDetails~~
 
@@ -357,6 +360,7 @@
 
 * connection
 * detach
+* ~~id~~
 * send
 
 ## Coverage

data/lib/puppeteer/frame.rb

@@ -28,7 +28,7 @@ class Puppeteer::Frame
   # @param rederer [String]
   # @param timeout [number|nil]
   # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  # @return [Puppeteer::Response]
+  # @return [Puppeteer::HTTPResponse]
   def goto(url, referer: nil, timeout: nil, wait_until: nil)
     @frame_manager.navigate_frame(self, url, referer: referer, timeout: timeout, wait_until: wait_until)
   end

data/lib/puppeteer/frame_manager.rb

@@ -82,7 +82,7 @@ class Puppeteer::FrameManager
   # @param frame [Puppeteer::Frame]
   # @param url [String]
   # @param {!{referer?: string, timeout?: number, waitUntil?: string|!Array<string>}=} options
-  # @return [Puppeteer::Response]
+  # @return [Puppeteer::HTTPResponse]
   def navigate_frame(frame, url, referer: nil, timeout: nil, wait_until: nil)
     assert_no_legacy_navigation_options(wait_until: wait_until)
 
@@ -132,7 +132,7 @@ class Puppeteer::FrameManager
 
   # @param timeout [number|nil]
   # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  # @return [Puppeteer::Response]
+  # @return [Puppeteer::HTTPResponse]
   def wait_for_frame_navigation(frame, timeout: nil, wait_until: nil)
     assert_no_legacy_navigation_options(wait_until: wait_until)
 

data/lib/puppeteer/{request.rb → http_request.rb}

@@ -1,4 +1,4 @@
-class Puppeteer::Request
+class Puppeteer::HTTPRequest
   include Puppeteer::DebugPrint
   include Puppeteer::IfPresent
 
@@ -16,7 +16,7 @@ class Puppeteer::Request
       @request.instance_variable_get(:@interception_id)
     end
 
-    # @param response [Puppeteer::Response]
+    # @param response [Puppeteer::HTTPResponse]
     def response=(response)
       @request.instance_variable_set(:@response, response)
     end
@@ -56,6 +56,12 @@ class Puppeteer::Request
     @post_data = event['request']['postData']
     @frame = frame
     @redirect_chain = redirect_chain
+    @continue_request_overrides = {}
+    @current_strategy = 'none'
+    @current_priority = nil
+    @intercept_actions = []
+    @initiator = event['initiator']
+
     @headers = {}
     event['request']['headers'].each do |key, value|
       @headers[key.downcase] = value
@@ -68,6 +74,76 @@ class Puppeteer::Request
   attr_reader :internal
   attr_reader :url, :resource_type, :method, :post_data, :headers, :response, :frame
 
+  private def assert_interception_allowed
+    unless @allow_interception
+      raise InterceptionNotEnabledError.new
+    end
+  end
+
+  private def assert_interception_not_handled
+    if @interception_handled
+      raise AlreadyHandledError.new
+    end
+  end
+
+  # @returns the `ContinueRequestOverrides` that will be used
+  # if the interception is allowed to continue (ie, `abort()` and
+  # `respond()` aren't called).
+  def continue_request_overrides
+    assert_interception_allowed
+    @continue_request_overrides
+  end
+
+  # @returns The `ResponseForRequest` that gets used if the
+  # interception is allowed to respond (ie, `abort()` is not called).
+  def response_for_request
+    assert_interception_allowed
+    @response_for_request
+  end
+
+  # @returns the most recent reason for aborting the request
+  def abort_error_reason
+    assert_interception_allowed
+    @abort_error_reason
+  end
+
+  # @returns An array of the current intercept resolution strategy and priority
+  # `[strategy,priority]`. Strategy is one of: `abort`, `respond`, `continue`,
+  #  `disabled`, `none`, or `already-handled`.
+  def intercept_resolution
+    if !@allow_interception
+      ['disabled']
+    elsif @interception_handled
+      ['already-handled']
+    else
+      [@current_strategy, @current_priority]
+    end
+  end
+
+  # Adds an async request handler to the processing queue.
+  # Deferred handlers are not guaranteed to execute in any particular order,
+  # but they are guarnateed to resolve before the request interception
+  # is finalized.
+  #
+  # @param pending_handler [Proc]
+  def enqueue_intercept_action(pending_handler)
+    @intercept_actions << pending_handler
+  end
+
+  # Awaits pending interception handlers and then decides how to fulfill
+  # the request interception.
+  def finalize_interceptions
+    @intercept_actions.each(&:call)
+    case @intercept_resolution
+    when :abort
+      abort_impl(**@abort_error_reason)
+    when :respond
+      respond_impl(**@response_for_request)
+    when :continue
+      continue_impl(@continue_request_overrides)
+    end
+  end
+
   def navigation_request?
     @is_navigation_request
   end
@@ -116,24 +192,43 @@ class Puppeteer::Request
   #   end
   #
   # @param error_code [String|Symbol]
-  def continue(url: nil, method: nil, post_data: nil, headers: nil)
+  def continue(url: nil, method: nil, post_data: nil, headers: nil, priority: nil)
     # Request interception is not supported for data: urls.
     return if @url.start_with?('data:')
 
-    unless @allow_interception
-      raise InterceptionNotEnabledError.new
-    end
-    if @interception_handled
-      raise AlreadyHandledError.new
-    end
-    @interception_handled = true
+    assert_interception_allowed
+    assert_interception_not_handled
 
     overrides = {
       url: url,
       method: method,
-      post_data: post_data,
+      postData: post_data,
       headers: headers_to_array(headers),
     }.compact
+
+    if priority.nil?
+      continue_impl(overrides)
+      return
+    end
+
+    @continue_request_overrides = overrides
+    if @current_priority.nil? || priority > @current_priority
+      @current_strategy = :continue
+      @current_priority = priority
+      return
+    end
+
+    if priority == @current_priority
+      if @current_strategy == :abort || @current_strategy == :respond
+        return
+      end
+      @current_strategy = :continue
+    end
+  end
+
+  private def continue_impl(overrides)
+    @interception_handled = true
+
     begin
       @client.send_message('Fetch.continueRequest',
         requestId: @interception_id,
@@ -162,16 +257,40 @@ class Puppeteer::Request
   # @param headers [Hash<String, String>]
   # @param content_type [String]
   # @param body [String]
-  def respond(status: nil, headers: nil, content_type: nil, body: nil)
+  def respond(status: nil, headers: nil, content_type: nil, body: nil, priority: nil)
     # Mocking responses for dataURL requests is not currently supported.
     return if @url.start_with?('data:')
 
-    unless @allow_interception
-      raise InterceptionNotEnabledError.new
+    assert_interception_allowed
+    assert_interception_not_handled
+
+    if priority.nil?
+      respond_impl(status: status, headers: headers, content_type: content_type, body: body)
+      return
     end
-    if @interception_handled
-      raise AlreadyHandledError.new
+
+    @response_for_request = {
+      status: status,
+      headers: headers,
+      content_type: content_type,
+      body: body,
+    }
+
+    if @current_priority.nil? || priority > @current_priority
+      @current_strategy = :respond
+      @current_priority = priority
+      return
+    end
+
+    if priority == @current_priority
+      if @current_strategy == :abort
+        return
+      end
+      @current_strategy = :respond
     end
+  end
+
+  private def respond_impl(status: nil, headers: nil, content_type: nil, body: nil)
     @interception_handled = true
 
     mock_response_headers = {}
@@ -191,6 +310,7 @@ class Puppeteer::Request
       responseHeaders: headers_to_array(mock_response_headers),
       body: if_present(body) { |mock_body| Base64.strict_encode64(mock_body) },
     }.compact
+
     begin
       @client.send_message('Fetch.fulfillRequest',
         requestId: @interception_id,
@@ -216,7 +336,7 @@ class Puppeteer::Request
   #   end
   #
   # @param error_code [String|Symbol]
-  def abort(error_code: :failed)
+  def abort(error_code: :failed, priority: nil)
     # Request interception is not supported for data: urls.
     return if @url.start_with?('data:')
 
@@ -224,12 +344,21 @@ class Puppeteer::Request
     unless error_reason
       raise ArgumentError.new("Unknown error code: #{error_code}")
     end
-    unless @allow_interception
-      raise InterceptionNotEnabledError.new
+    assert_interception_allowed
+    assert_interception_not_handled
+
+    if priority.nil?
+      abort_impl(error_reason)
     end
-    if @interception_handled
-      raise AlreadyHandledError.new
+    @abort_error_reason = error_reason
+
+    if @current_priority.nil? || priority > @current_priority
+      @current_strategy = :abort
+      @current_priority = priority
     end
+  end
+
+  private def abort_impl(error_reason)
     @interception_handled = true
 
     begin

data/lib/puppeteer/{response.rb → http_response.rb}

@@ -1,6 +1,6 @@
 require 'json'
 
-class Puppeteer::Response
+class Puppeteer::HTTPResponse
   include Puppeteer::IfPresent
 
   class Redirected < StandardError
@@ -29,7 +29,7 @@ class Puppeteer::Response
   end
 
   # @param client [Puppeteer::CDPSession]
-  # @param request [Puppeteer::Request]
+  # @param request [Puppeteer::HTTPRequest]
   # @param response_payload [Hash]
   def initialize(client, request, response_payload)
     @client = client

data/lib/puppeteer/lifecycle_watcher.rb

@@ -88,7 +88,7 @@ class Puppeteer::LifecycleWatcher
     check_lifecycle_complete
   end
 
-  # @param [Puppeteer::Request] request
+  # @param [Puppeteer::HTTPRequest] request
   def handle_request(request)
     return if request.frame != @frame || !request.navigation_request?
     @navigation_request = request
@@ -103,7 +103,7 @@ class Puppeteer::LifecycleWatcher
     check_lifecycle_complete
   end
 
-  # @return [Puppeteer::Response]
+  # @return [Puppeteer::HTTPResponse]
   def navigation_response
     if_present(@navigation_request) do |request|
       request.response

data/lib/puppeteer/network_manager.rb

@@ -251,9 +251,14 @@ class Puppeteer::NetworkManager
       end
     end
     frame = if_present(event['frameId']) { |frame_id| @frame_manager.frame(frame_id) }
-    request = Puppeteer::Request.new(@client, frame, interception_id, @user_request_interception_enabled, event, redirect_chain)
+    request = Puppeteer::HTTPRequest.new(@client, frame, interception_id, @user_request_interception_enabled, event, redirect_chain)
     @request_id_to_request[event['requestId']] = request
     emit_event(NetworkManagerEmittedEvents::Request, request)
+    begin
+      request.finalize_interceptions
+    rescue => err
+      debug_puts(err)
+    end
   end
 
   private def handle_request_served_from_cache(event)
@@ -262,13 +267,13 @@ class Puppeteer::NetworkManager
     end
   end
 
-  # @param request [Puppeteer::Request]
+  # @param request [Puppeteer::HTTPRequest]
   # @param response_payload [Hash]
   private def handle_request_redirect(request, response_payload)
-    response = Puppeteer::Response.new(@client, request, response_payload)
+    response = Puppeteer::HTTPResponse.new(@client, request, response_payload)
     request.internal.response = response
     request.internal.redirect_chain << request
-    response.internal.body_loaded_promise.reject(Puppeteer::Response::Redirected.new)
+    response.internal.body_loaded_promise.reject(Puppeteer::HTTPResponse::Redirected.new)
     @request_id_to_request.delete(request.internal.request_id)
     @attempted_authentications.delete(request.internal.interception_id)
     emit_event(NetworkManagerEmittedEvents::Response, response)
@@ -281,7 +286,7 @@ class Puppeteer::NetworkManager
     # FileUpload sends a response without a matching request.
     return unless request
 
-    response = Puppeteer::Response.new(@client, request, event['response'])
+    response = Puppeteer::HTTPResponse.new(@client, request, event['response'])
     request.internal.response = response
     emit_event(NetworkManagerEmittedEvents::Response, response)
   end

data/lib/puppeteer/page.rb

@@ -153,6 +153,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
 
@@ -638,7 +644,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')
@@ -668,11 +674,12 @@ class Puppeteer::Page
     @wait_for_network_manager_event_listener_ids[event_name] =
       @frame_manager.network_manager.add_event_listener(event_name) do |event_target|
         if predicate.call(event_target)
-          promise.fulfill(nil)
+          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
@@ -722,7 +729,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)
@@ -748,7 +755,7 @@ 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
 
   # @param timeout [number|nil]

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 module Puppeteer
-  VERSION = '0.37.1'
+  VERSION = '0.37.2'
 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

@@ -37,6 +37,8 @@ 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 +52,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.37.2
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-11-21 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
@@ -287,6 +287,8 @@ files:
 - 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 +315,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