puppeteer-ruby 0.40.5 → 0.40.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f6c1abfbf66f645ac208cf5f3f0ad24c4ae421e576c5b1516803cdc897bad22
-  data.tar.gz: a40b422147eff9261720975d8009ecc3fbd24a1f0d2d828f1fe3b5dce31f5c24
+  metadata.gz: 51b26b6b3710f06e7a7cfb7e9f5730bbb9517396fd30a7f271161820bb6902c6
+  data.tar.gz: 528fd6520a029cf9d85424a105cf19a156f428435dc795a8b8753c8cbfa442db
 SHA512:
-  metadata.gz: f532e2ff58c283c0904d5c76c0e9254d5b91be1f6ff7c576b728d91a727b0bb246f9d0eefe1461b1a7ba28607f33ac7a541d9d9a9ee3da0e5742c330f3c01b6e
-  data.tar.gz: c0dab5bca1e3ae23c6c2f3866cb3127024a9fd9663e01ff20d7edd68ef60060fc2203ffe81d80f322a10428ea4632193e1eef8b502e3375ea0c8413a3172dc61
+  metadata.gz: ad616ae1574e76f71cb7e7cb1dae5cba4ae4ad65865ab6a5e6cb92c6033b9ce654de2b364b5d5351e69302f88fc48231c2a9bd97765af9ed827862e762f9d748
+  data.tar.gz: 9a194d8df09c6c6eda97ef095d67dafd693b7ff386e612d926925bdbcf41b3b2a21c06862eff90525e39f85c7d8a5ded419bb8c4b4a3ecb33413c7ccdf47215e

data/CHANGELOG.md

@@ -1,7 +1,11 @@
-### main [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.40.5...main)]
+### main [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.40.6...main)]
 
 - xxx
 
+### 0.40.6 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.40.5...0.40.6)]
+
+- Port Puppeteer v13.1-v13.5 features mainly for request interception.
+
 ### 0.40.5 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.40.4...0.40.5)]
 
 Bugfix:

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
-- Puppeteer version: v13.5.1
-- puppeteer-ruby version: 0.40.4
+- Puppeteer version: v13.5.2
+- puppeteer-ruby version: 0.40.6
 
 ## Puppeteer
 
@@ -310,8 +310,8 @@
 * frame
 * headers
 * initiator
-* ~~interceptResolutionState~~
-* ~~isInterceptResolutionHandled~~
+* interceptResolutionState => `#intercept_resolution_state`
+* isInterceptResolutionHandled => `#intercept_resolution_handled?`
 * isNavigationRequest => `#navigation_request?`
 * method
 * postData => `#post_data`

data/lib/puppeteer/http_request.rb

@@ -2,6 +2,8 @@ class Puppeteer::HTTPRequest
   include Puppeteer::DebugPrint
   include Puppeteer::IfPresent
 
+  DEFAULT_INTERCEPT_RESOLUTION_PRIORITY = 0
+
   # defines some methods used only in NetworkManager, Response
   class InternalAccessor
     def initialize(request)
@@ -38,6 +40,43 @@ class Puppeteer::HTTPRequest
     end
   end
 
+  class InterceptResolutionState
+    def self.abort(priority: nil)
+      new(action: 'abort', priority: priority)
+    end
+
+    def self.respond(priority: nil)
+      new(action: 'respond', priority: priority)
+    end
+
+    def self.continue(priority: nil)
+      new(action: 'continue', priority: priority)
+    end
+
+    def self.disabled(priority: nil)
+      new(action: 'disabled', priority: priority)
+    end
+
+    def self.none(priority: nil)
+      new(action: 'none', priority: priority)
+    end
+
+    def self.already_handled(priority: nil)
+      new(action: 'already-handled', priority: priority)
+    end
+
+    private def initialize(action:, priority:)
+      @action = action
+      @priority = priority
+    end
+
+    def priority_unspecified?
+      @priority.nil?
+    end
+
+    attr_reader :action, :priority
+  end
+
   # @param client [Puppeteer::CDPSession]
   # @param frame [Puppeteer::Frame]
   # @param interception_id [string|nil]
@@ -57,9 +96,8 @@ class Puppeteer::HTTPRequest
     @frame = frame
     @redirect_chain = redirect_chain
     @continue_request_overrides = {}
-    @current_strategy = 'none'
-    @current_priority = nil
-    @intercept_actions = []
+    @intercept_resolution_state = InterceptResolutionState.none
+    @intercept_handlers = []
     @initiator = event['initiator']
 
     @headers = {}
@@ -115,19 +153,29 @@ class Puppeteer::HTTPRequest
     @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
+  # @returns An InterceptResolutionState object describing the current resolution
+  #  action and priority.
+  #
+  #  InterceptResolutionState contains:
+  #    action: InterceptResolutionAction
+  #    priority?: number
+  #
+  #  InterceptResolutionAction is one of: `abort`, `respond`, `continue`,
+  #  `disabled`, `none`, or `alreay-handled`
+  def intercept_resolution_state
     if !@allow_interception
-      ['disabled']
+      InterceptResolutionState.disabled
     elsif @interception_handled
-      ['already-handled']
+      InterceptResolutionState.already_handled
     else
-      [@current_strategy, @current_priority]
+      @intercept_resolution_state.dup
     end
   end
 
+  def intercept_resolution_handled?
+    @interception_handled
+  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
@@ -135,19 +183,19 @@ class Puppeteer::HTTPRequest
   #
   # @param pending_handler [Proc]
   def enqueue_intercept_action(pending_handler)
-    @intercept_actions << pending_handler
+    @intercept_handlers << 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
+    @intercept_handlers.each(&:call)
+    case @intercept_resolution.action
+    when 'abort'
       abort_impl(**@abort_error_reason)
-    when :respond
+    when 'respond'
       respond_impl(**@response_for_request)
-    when :continue
+    when 'continue'
       continue_impl(@continue_request_overrides)
     end
   end
@@ -220,17 +268,16 @@ class Puppeteer::HTTPRequest
     end
 
     @continue_request_overrides = overrides
-    if @current_priority.nil? || priority > @current_priority
-      @current_strategy = :continue
-      @current_priority = priority
+    if @intercept_resolution_state.priority_unspecified? || priority > @intercept_resolution_state.priority
+      @intercept_resolution_state = InterceptResolutionState.continue(priority: priority)
       return
     end
 
-    if priority == @current_priority
-      if @current_strategy == :abort || @current_strategy == :respond
+    if priority == @intercept_resolution_state.priority
+      if @intercept_resolution_state.action == :abort || @intercept_resolution_state.action == :respond
         return
       end
-      @current_strategy = :continue
+      @intercept_resolution_state = InterceptResolutionState.continue(priority: priority)
     end
   end
 
@@ -284,17 +331,16 @@ class Puppeteer::HTTPRequest
       body: body,
     }
 
-    if @current_priority.nil? || priority > @current_priority
-      @current_strategy = :respond
-      @current_priority = priority
+    if @intercept_resolution_state.priority_unspecified? || priority > @intercept_resolution_state.priority
+      @intercept_resolution_state = InterceptResolutionState.respond(priority: priority)
       return
     end
 
-    if priority == @current_priority
-      if @current_strategy == :abort
+    if priority == @intercept_resolution_state.priority
+      if @intercept_resolution_state.action == :abort
         return
       end
-      @current_strategy = :respond
+      @intercept_resolution_state = InterceptResolutionState.respond(priority: priority)
     end
   end
 
@@ -360,9 +406,8 @@ class Puppeteer::HTTPRequest
     end
     @abort_error_reason = error_reason
 
-    if @current_priority.nil? || priority > @current_priority
-      @current_strategy = :abort
-      @current_priority = priority
+    if @intercept_resolution_state.priority_unspecified? || priority > @intercept_resolution_state.priority
+      @intercept_resolution_state = InterceptResolutionState.abort(priority: priority)
     end
   end
 

data/lib/puppeteer/network_manager.rb

@@ -217,6 +217,7 @@ class Puppeteer::NetworkManager
       # CDP may have sent a Fetch.requestPaused event already. Check for it.
       if_present(@network_event_manager.get_request_paused(network_request_id)) do |request_paused_event|
         fetch_request_id = request_paused_event['requestId']
+        patch_request_event_headers(event, request_paused_event)
         handle_request(event, fetch_request_id)
         @network_event_manager.forget_request_paused(network_request_id)
       end
@@ -277,12 +278,19 @@ class Puppeteer::NetworkManager
     end
 
     if request_will_be_sent_event
+      patch_request_event_headers(request_will_be_sent_event, event)
       handle_request(request_will_be_sent_event, fetch_request_id)
     else
       @network_event_manager.store_request_paused(network_request_id, event)
     end
   end
 
+  private def patch_request_event_headers(request_will_be_sent_event, request_paused_event)
+    request_will_be_sent_event['request']['headers'].merge!(
+      # includes extra headers, like: Accept, Origin
+      request_paused_event['request']['headers'])
+  end
+
   private def handle_request(event, fetch_request_id)
     redirect_chain = []
     if event['redirectResponse']

data/lib/puppeteer/page.rb

@@ -389,7 +389,18 @@ class Puppeteer::Page
     @client.send_message('Network.getCookies', urls: (urls.empty? ? [url] : urls))['cookies']
   end
 
+  # check if each cookie element has required fields ('name' and 'value')
+  private def assert_cookie_params(cookies, requires:)
+    return if cookies.all? do |cookie|
+      requires.all? { |field_name| cookie[field_name] || cookie[field_name.to_s] }
+    end
+
+    raise ArgumentError.new("Each coookie must have #{requires.join(" and ")} attribute.")
+  end
+
   def delete_cookie(*cookies)
+    assert_cookie_params(cookies, requires: %i(name))
+
     page_url = url
     starts_with_http = page_url.start_with?("http")
     cookies.each do |cookie|
@@ -399,6 +410,8 @@ class Puppeteer::Page
   end
 
   def set_cookie(*cookies)
+    assert_cookie_params(cookies, requires: %i(name value))
+
     page_url = url
     starts_with_http = page_url.start_with?("http")
     items = cookies.map do |cookie|

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 module Puppeteer
-  VERSION = '0.40.5'
+  VERSION = '0.40.6'
 end

data/puppeteer-ruby.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rollbar'
   spec.add_development_dependency 'rspec', '~> 3.11.0'
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 1.26.0'
+  spec.add_development_dependency 'rubocop', '~> 1.27.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.40.5
+  version: 0.40.6
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-26 00:00:00.000000000 Z
+date: 2022-04-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.26.0
+        version: 1.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: 1.27.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement