puppeteer-ruby 0.50.1 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e905c9995f718c953c11c9c199e7c945c0d413750becae8bdbc13cc4c0c1e5f
-  data.tar.gz: 9fec2af23369834b277ec50ef655b4a086b9df67698465f133b1af2ed059b11e
+  metadata.gz: dc3601ac8a64edb1a6054663944d5244eb0fcbc774b2d2f73529eef194031689
+  data.tar.gz: c364f8b73fc4dc6a591baca37e2e116d3147c5572f42dd026de77e36b0842851
 SHA512:
-  metadata.gz: e636edbdf0dcb3731e7b688936f4c04bf7b9f21668ce6ed712d993e2dac41b748f4e49e89b9b43ddfcdd2b37138275bf1b95e5191d7d09cd1d3df664f6838358
-  data.tar.gz: 1e7478c8a4757743d6e31321af550b0900b04a46785b51ac2bb0203060d1456e8917722ad6631ae86a546b8fccb7f1947b185b7c9007e7720773a1772146557a
+  metadata.gz: a4de65d9249823c8532150d9cbeace0670d5e0c35de747193bee4923edb751b3dcc7a46aa6ec5f58393e20fabe9933b12eaca0ac47ead1d91c5793fec8ca0e9b
+  data.tar.gz: 4d5d39fe7dac8d74a3f90478f3bae1bd7e9dcb14018518551ca4ca7d59f48ed1e9f9e7205c33956d82591b2985b4fecd5f1eb4f0af8efc03f4a1b3f22a0b2281

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
-- Puppeteer version: v24.35.0
-- puppeteer-ruby version: 0.50.1
+- Puppeteer version: v24.42.0
+- puppeteer-ruby version: 0.51.0
 
 ## Puppeteer
 
@@ -25,8 +25,9 @@
 * ~~deleteCookie~~
 * ~~deleteMatchingCookies~~
 * disconnect
+* extensions
 * ~~getWindowBounds~~
-* ~~installExtension~~
+* installExtension => `#install_extension`
 * isConnected => `#connected?`
 * newPage => `#new_page`
 * pages
@@ -34,10 +35,11 @@
 * ~~removeScreen~~
 * ~~screens~~
 * ~~setCookie~~
+* setPermission => `#set_permission`
 * ~~setWindowBounds~~
 * target
 * targets
-* ~~uninstallExtension~~
+* uninstallExtension => `#uninstall_extension`
 * userAgent => `#user_agent`
 * version
 * waitForTarget => `#wait_for_target`
@@ -55,6 +57,7 @@
 * overridePermissions => `#override_permissions`
 * pages
 * setCookie => `#set_cookie`
+* setPermission => `#set_permission`
 * targets
 * waitForTarget => `#wait_for_target`
 
@@ -124,7 +127,7 @@
 * $$eval => `#eval_on_selector_all`
 * $eval => `#eval_on_selector`
 * asLocator => `#as_locator`
-* ~~autofill~~
+* autofill
 * ~~backendNodeId~~
 * boundingBox => `#bounding_box`
 * boxModel => `#box_model`
@@ -163,6 +166,12 @@
 * ~~once~~
 * ~~removeAllListeners~~
 
+## Extension
+
+* pages
+* triggerAction => `#trigger_action`
+* workers
+
 ## ~~ExtensionTransport~~
 
 * ~~close~~
@@ -188,6 +197,7 @@
 * content
 * evaluate
 * evaluateHandle => `#evaluate_handle`
+* extensionRealms => `#extension_realms`
 * focus
 * frameElement => `#frame_element`
 * goto
@@ -321,6 +331,7 @@
 * bringToFront => `#bring_to_front`
 * browser
 * browserContext => `#browser_context`
+* captureHeapSnapshot => `#capture_heap_snapshot`
 * click
 * close
 * content
@@ -341,6 +352,7 @@
 * evaluateHandle => `#evaluate_handle`
 * evaluateOnNewDocument => `#evaluate_on_new_document`
 * exposeFunction => `#expose_function`
+* extensionRealms => `#extension_realms`
 * focus
 * frames
 * ~~getDefaultNavigationTimeout~~
@@ -348,6 +360,7 @@
 * goBack => `#go_back`
 * goForward => `#go_forward`
 * goto
+* ~~hasDevTools~~
 * hover
 * isClosed => `#closed?`
 * isDragInterceptionEnabled => `#drag_interception_enabled?`
@@ -384,6 +397,7 @@
 * tap
 * target
 * title
+* triggerExtensionAction => `#trigger_extension_action`
 * type => `#type_text`
 * url
 * viewport
@@ -402,6 +416,13 @@
 ## ~~ProtocolError~~
 
 
+## ~~Realm~~
+
+* ~~evaluate~~
+* ~~evaluateHandle~~
+* ~~extension~~
+* ~~waitForFunction~~
+
 ## ~~ScreenRecorder~~
 
 * ~~stop~~
@@ -417,7 +438,7 @@
 
 ## Target
 
-* ~~asPage~~
+* asPage => `#as_page`
 * browser
 * browserContext => `#browser_context`
 * createCDPSession => `#create_cdp_session`
@@ -448,6 +469,17 @@
 ## ~~UnsupportedOperation~~
 
 
+## ~~WebMCP~~
+
+* ~~tools~~
+
+## ~~WebMCPTool~~
+
+* ~~execute~~
+
+## ~~WebMCPToolCall~~
+
+
 ## WebWorker
 
 * close

data/lib/puppeteer/browser.rb

@@ -14,6 +14,8 @@ class Puppeteer::Browser
   # @rbs ignore_https_errors: bool -- Ignore HTTPS errors
   # @rbs default_viewport: Puppeteer::Viewport? -- Default viewport
   # @rbs network_enabled: bool -- Whether network events are enabled
+  # @rbs issues_enabled: bool -- Whether issues events are enabled
+  # @rbs block_list: Array[String]? -- URL block list patterns
   # @rbs process: Puppeteer::BrowserRunner::BrowserProcess? -- Browser process handle
   # @rbs close_callback: Proc -- Close callback
   # @rbs target_filter_callback: Proc? -- Target filter callback
@@ -25,6 +27,8 @@ class Puppeteer::Browser
                   ignore_https_errors:,
                   default_viewport:,
                   network_enabled: true,
+                  issues_enabled: true,
+                  block_list: nil,
                   process:,
                   close_callback:,
                   target_filter_callback:,
@@ -36,6 +40,8 @@ class Puppeteer::Browser
       ignore_https_errors: ignore_https_errors,
       default_viewport: default_viewport,
       network_enabled: network_enabled,
+      issues_enabled: issues_enabled,
+      block_list: block_list,
       process: process,
       close_callback: close_callback,
       target_filter_callback: target_filter_callback,
@@ -51,6 +57,8 @@ class Puppeteer::Browser
   # @rbs ignore_https_errors: bool -- Ignore HTTPS errors
   # @rbs default_viewport: Puppeteer::Viewport? -- Default viewport
   # @rbs network_enabled: bool -- Whether network events are enabled
+  # @rbs issues_enabled: bool -- Whether issues events are enabled
+  # @rbs block_list: Array[String]? -- URL block list patterns
   # @rbs process: Puppeteer::BrowserRunner::BrowserProcess? -- Browser process handle
   # @rbs close_callback: Proc -- Close callback
   # @rbs target_filter_callback: Proc? -- Target filter callback
@@ -62,6 +70,8 @@ class Puppeteer::Browser
                  ignore_https_errors:,
                  default_viewport:,
                  network_enabled: true,
+                 issues_enabled: true,
+                 block_list: nil,
                  process:,
                  close_callback:,
                  target_filter_callback:,
@@ -73,6 +83,8 @@ class Puppeteer::Browser
     @ignore_https_errors = ignore_https_errors
     @default_viewport = default_viewport
     @network_enabled = network_enabled
+    @issues_enabled = issues_enabled
+    @block_list = block_list
     @process = process
     @connection = connection
     @close_callback = close_callback
@@ -89,7 +101,9 @@ class Puppeteer::Browser
       connection: connection,
       target_factory: method(:create_target),
       target_filter_callback: @target_filter_callback,
+      block_list: block_list,
     )
+    @extensions = {}
   end
 
   private def default_target_filter_callback(target_info)
@@ -163,6 +177,10 @@ class Puppeteer::Browser
     @target_manager
   end
 
+  private def connection
+    @connection
+  end
+
   # @rbs return: Puppeteer::BrowserContext -- New incognito browser context
   def create_incognito_browser_context
     result = @connection.send_message('Target.createBrowserContext')
@@ -196,6 +214,13 @@ class Puppeteer::Browser
     @default_context
   end
 
+  # @rbs origin: String -- Origin URL, or '*' for all origins
+  # @rbs permissions: Array[Hash[Symbol | String, untyped]] -- Permission descriptors and states
+  # @rbs return: void -- No return value
+  def set_permission(origin, *permissions)
+    @default_context.set_permission(origin, *permissions)
+  end
+
   # @rbs context_id: String? -- Browser context ID
   # @rbs return: void -- No return value
   def dispose_context(context_id)
@@ -369,6 +394,63 @@ class Puppeteer::Browser
     Version.fetch(@connection).user_agent
   end
 
+  # @rbs page_target_id: String -- Page target id
+  # @rbs return: String? -- DevTools target id for page
+  def _has_devtools_target(page_target_id)
+    result = @connection.send_message('Target.getDevToolsTarget', targetId: page_target_id)
+    result['targetId']
+  end
+
+  # @rbs path: String -- Extension path
+  # @rbs return: String -- Installed extension id
+  def install_extension(path)
+    result = @connection.send_message('Extensions.loadUnpacked', path: path)
+    extension_id = result['id']
+    @extensions.delete(extension_id)
+    extension_id
+  end
+
+  # @rbs extension_id: String -- Extension id
+  # @rbs return: void -- No return value
+  def uninstall_extension(extension_id)
+    @connection.send_message('Extensions.uninstall', id: extension_id)
+    @extensions.delete(extension_id)
+  end
+
+  # @rbs return: Hash[String, Puppeteer::Extension] -- Installed extensions
+  def extensions
+    response = @connection.send_message('Extensions.getExtensions')
+    extension_map = {}
+    response.fetch('extensions', []).each do |payload|
+      extension_id = payload['id']
+      existing_extension = @extensions[extension_id]
+      extension_map[extension_id] =
+        if existing_extension
+          existing_extension
+        else
+          Puppeteer::Extension.new(
+            id: extension_id,
+            version: payload['version'],
+            name: payload['name'],
+            path: payload['path'],
+            enabled: payload['enabled'],
+            browser: self,
+          )
+        end
+    end
+    @extensions = extension_map
+  end
+
+  # @rbs return: bool -- Whether issue events are enabled
+  def issues_enabled?
+    @issues_enabled
+  end
+
+  # @rbs return: Array[String]? -- URL block list patterns
+  def block_list
+    @block_list
+  end
+
   # @rbs return: void -- No return value
   def close
     @close_callback.call

data/lib/puppeteer/browser_connector.rb

@@ -28,6 +28,8 @@ class Puppeteer::BrowserConnector
       ignore_https_errors: @browser_options.ignore_https_errors?,
       default_viewport: @browser_options.default_viewport,
       network_enabled: @browser_options.network_enabled,
+      issues_enabled: @browser_options.issues_enabled,
+      block_list: @browser_options.block_list,
       process: nil,
       close_callback: -> { connection.send_message('Browser.close') },
       target_filter_callback: @browser_options.target_filter,

data/lib/puppeteer/browser_context.rb

@@ -153,6 +153,44 @@ class Puppeteer::BrowserContext
     }.compact)
   end
 
+  # @param origin [String] Use '*' to apply to all origins.
+  # @param permissions [Array<Hash>] { permission: { name:, userVisibleOnly:, sysex:, panTiltZoom:, allowWithoutSanitization: }, state: 'granted'|'denied'|'prompt' }
+  def set_permission(origin, *permissions)
+    permissions.each do |permission|
+      descriptor = hash_value(permission, 'permission')
+      state = hash_value(permission, 'state')
+      unless descriptor.is_a?(Hash)
+        raise ArgumentError.new('Each permission entry must include a permission descriptor')
+      end
+      unless state
+        raise ArgumentError.new('Each permission entry must include state')
+      end
+
+      name = hash_value(descriptor, 'name')
+      unless name
+        raise ArgumentError.new('Permission descriptor must include name')
+      end
+
+      protocol_permission = { name: name.to_s }
+      {
+        userVisibleOnly: %w[userVisibleOnly user_visible_only],
+        sysex: %w[sysex],
+        panTiltZoom: %w[panTiltZoom pan_tilt_zoom],
+        allowWithoutSanitization: %w[allowWithoutSanitization allow_without_sanitization],
+      }.each do |protocol_key, keys|
+        value = hash_value(descriptor, *keys)
+        protocol_permission[protocol_key] = value unless value.nil?
+      end
+
+      @connection.send_message('Browser.setPermission', {
+        origin: origin == '*' ? nil : origin,
+        browserContextId: @id,
+        permission: protocol_permission,
+        setting: state.to_s,
+      }.compact)
+    end
+  end
+
   def clear_permission_overrides
     if @id
       @connection.send_message('Browser.resetPermissions', browserContextId: @id)
@@ -214,6 +252,9 @@ class Puppeteer::BrowserContext
       normalized = normalize_cookie_hash(cookie)
       partition_key = normalized.delete('partitionKey') || normalized.delete('partition_key')
       normalized['partitionKey'] = convert_partition_key_for_cdp(partition_key) if partition_key
+      same_site = normalized.delete('sameSite') || normalized.delete('same_site')
+      converted_same_site = convert_same_site_for_cdp(same_site)
+      normalized['sameSite'] = converted_same_site if converted_same_site
       normalized
     end
     @connection.send_message('Storage.setCookies', {
@@ -277,9 +318,7 @@ class Puppeteer::BrowserContext
   end
 
   private def normalize_cookie_hash(cookie)
-    cookie.each_with_object({}) do |(key, value), normalized|
-      normalized[key.to_s] = value
-    end
+    cookie.transform_keys(&:to_s)
   end
 
   private def hash_value(hash, *keys)
@@ -305,6 +344,15 @@ class Puppeteer::BrowserContext
     }
   end
 
+  private def convert_same_site_for_cdp(same_site)
+    case same_site
+    when 'Strict', 'Lax', 'None'
+      same_site
+    else
+      nil
+    end
+  end
+
   private def convert_partition_key_from_cdp(partition_key)
     return nil if partition_key.nil?
     return partition_key if partition_key.is_a?(String)

data/lib/puppeteer/chrome_target_manager.rb

@@ -2,7 +2,7 @@ class Puppeteer::ChromeTargetManager
   include Puppeteer::DebugPrint
   include Puppeteer::EventCallbackable
 
-  def initialize(connection:, target_factory:, target_filter_callback:)
+  def initialize(connection:, target_factory:, target_filter_callback:, block_list: nil)
     @discovered_targets_by_target_id = {}
     @attached_targets_by_target_id = {}
     @attached_targets_by_session_id = {}
@@ -13,8 +13,13 @@ class Puppeteer::ChromeTargetManager
     @connection = connection
     @target_filter_callback = target_filter_callback
     @target_factory = target_factory
+    @block_list = block_list
+    if @block_list && !@block_list.is_a?(Array)
+      raise ArgumentError.new('block_list must be an Array of URL patterns')
+    end
     @target_interceptors = {}
     @initialize_promise = Async::Promise.new
+    @initial_attach_done = false
 
     @connection_event_listeners = []
     @connection_event_listeners << @connection.add_event_listener(
@@ -52,7 +57,7 @@ class Puppeteer::ChromeTargetManager
 
   private def store_existing_targets_for_init
     @discovered_targets_by_target_id.each do |target_id, target_info|
-      if @target_filter_callback.call(target_info) && target_info.type != 'browser'
+      if @target_filter_callback.call(target_info) && target_info.type != 'browser' && url_allowed?(target_info.url)
         @target_ids_for_init << target_id
       end
     end
@@ -64,6 +69,7 @@ class Puppeteer::ChromeTargetManager
       flatten: true,
       autoAttach: true,
     })
+    @initial_attach_done = true
     finish_initialization_if_ready
     @initialize_promise.wait
   end
@@ -149,11 +155,11 @@ class Puppeteer::ChromeTargetManager
     target_info = @discovered_targets_by_target_id.delete(target_id)
     finish_initialization_if_ready(target_id)
 
-    if target_info.type == 'service_worker' && @attached_targets_by_target_id.has_key?(target_id)
+    if target_info&.type == 'service_worker'
       # Special case for service workers: report TargetGone event when
       # the worker is destroyed.
       target = @attached_targets_by_target_id.delete(target_id)
-      emit_event(TargetManagerEmittedEvents::TargetGone, target)
+      emit_event(TargetManagerEmittedEvents::TargetGone, target) if target
     end
   end
 
@@ -161,11 +167,11 @@ class Puppeteer::ChromeTargetManager
     target_info = Puppeteer::Target::TargetInfo.new(event['targetInfo'])
     @discovered_targets_by_target_id[target_info.target_id] = target_info
 
-    if @ignored_targets.include?(target_info.target_id) || !@attached_targets_by_target_id.has_key?(target_info.target_id) || !target_info.attached
+    if @ignored_targets.include?(target_info.target_id) || !target_info.attached
       return
     end
     original_target = @attached_targets_by_target_id[target_info.target_id]
-    emit_event(TargetManagerEmittedEvents::TargetChanged, original_target, target_info)
+    emit_event(TargetManagerEmittedEvents::TargetChanged, original_target, target_info) if original_target
   end
 
   class SessionNotCreatedError < Puppeteer::Error ; end
@@ -204,6 +210,12 @@ class Puppeteer::ChromeTargetManager
 
     return unless @connection.auto_attached?(target_info.target_id)
 
+    if !@initial_attach_done && !url_allowed?(target_info.url)
+      finish_initialization_if_ready(target_info.target_id)
+      silent_detach.call
+      return
+    end
+
     # Special case for service workers: being attached to service workers will
     # prevent them from ever being destroyed. Therefore, we silently detach
     # from service workers unless the connection was manually created via
@@ -270,6 +282,7 @@ class Puppeteer::ChromeTargetManager
         flatten: true,
         autoAttach: true,
       }))
+      maybe_setup_network_conditions(session)
       Puppeteer::AsyncUtils.await(session.async_send_message('Runtime.runIfWaitingForDebugger'))
     rescue => err
       Logger.new($stderr).warn(err)
@@ -292,4 +305,38 @@ class Puppeteer::ChromeTargetManager
     @attached_targets_by_target_id.delete(target.target_id)
     emit_event(TargetManagerEmittedEvents::TargetGone, target)
   end
+
+  private def url_allowed?(url)
+    return true if @block_list.nil? || @block_list.empty?
+    return true if url.nil? || url.empty? || url == 'about:blank'
+
+    @block_list.none? do |pattern|
+      File.fnmatch?(pattern, url, File::FNM_EXTGLOB)
+    rescue ArgumentError
+      false
+    end
+  end
+
+  private def maybe_setup_network_conditions(session)
+    return if @block_list.nil? || @block_list.empty?
+
+    matched_network_conditions = @block_list.map do |pattern|
+      {
+        urlPattern: pattern,
+        latency: 0,
+        downloadThroughput: -1,
+        uploadThroughput: -1,
+      }
+    end
+    Puppeteer::AsyncUtils.await(session.async_send_message('Network.enable'))
+    Puppeteer::AsyncUtils.await(session.async_send_message('Network.emulateNetworkConditionsByRule', {
+      matchedNetworkConditions: matched_network_conditions,
+      offline: true,
+    }))
+  rescue => err
+    message = err.message.to_s.downcase
+    return if message.include?('target closed') || message.include?('session closed') || message.include?('not found')
+
+    raise
+  end
 end

data/lib/puppeteer/debug_print.rb

@@ -1,20 +1,16 @@
 require 'logger'
 
 module Puppeteer::DebugPrint
-  if Puppeteer.env.debug?
-    def debug_puts(*args, **kwargs)
-      @__debug_logger ||= Logger.new($stdout)
-      @__debug_logger.debug(*args, **kwargs)
-    end
+  def debug_puts(*args, **kwargs)
+    return unless Puppeteer.env.debug?
 
-    def debug_print(*args)
-      print(*args)
-    end
-  else
-    def debug_puts(*args, **kwargs)
-    end
+    @__debug_logger ||= Logger.new($stdout)
+    @__debug_logger.debug(*args, **kwargs)
+  end
+
+  def debug_print(*args)
+    return unless Puppeteer.env.debug?
 
-    def debug_print(*args)
-    end
+    print(*args)
   end
 end

data/lib/puppeteer/element_handle.rb

@@ -540,6 +540,22 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
   end
 
+  # @rbs credit_card: Hash[Symbol | String, untyped]? -- Credit card autofill payload
+  # @rbs address: Hash[Symbol | String, untyped]? -- Address autofill payload
+  # @rbs return: void -- No return value
+  def autofill(credit_card: nil, address: nil)
+    node_info = @remote_object.node_info(@client)
+    field_id = node_info.dig('node', 'backendNodeId')
+    @client.send_message('Autofill.trigger', {
+      fieldId: field_id,
+      frameId: @frame.id,
+      card: credit_card,
+      address: address,
+    }.compact)
+  end
+
+  define_async_method :async_autofill
+
   # @rbs block: Proc? -- Optional block for Object#tap usage
   # @rbs return: Puppeteer::ElementHandle | nil -- Element handle or nil
   def tap(&block)

data/lib/puppeteer/events.rb

@@ -135,6 +135,9 @@ module PageEmittedEvents ; end
   # Emitted when a frame is navigated to a new URL. Will contain a {@link Frame}.
   FrameNavigated: 'framenavigated',
 
+  # Emitted when a DevTools issue is reported.
+  Issue: 'issue',
+
   # Emitted when the JavaScript
   # {https://developer.mozilla.org/en-US/docs/Web/Events/load | load} event is dispatched.
   Load: 'load',

data/lib/puppeteer/execution_context.rb

@@ -52,13 +52,18 @@ class Puppeteer::ExecutionContext
     # @param context_id [String]
     # @return [Object|JSHandle]
     def evaluate_with(client:, context_id:)
-      result = client.send_message('Runtime.evaluate',
-        expression: expression_with_source_url,
-        contextId: context_id,
-        returnByValue: @return_by_value,
-        awaitPromise: true,
-        userGesture: true,
-      )
+      result =
+        begin
+          client.send_message('Runtime.evaluate',
+            expression: expression_with_source_url,
+            contextId: context_id,
+            returnByValue: @return_by_value,
+            awaitPromise: true,
+            userGesture: true,
+          )
+        rescue Puppeteer::Connection::ProtocolError => err
+          raise @execution_context.send(:rewrite_evaluation_error, err)
+        end
       # }).catch(rewriteError);
 
       exception_details = result['exceptionDetails']
@@ -110,14 +115,19 @@ class Puppeteer::ExecutionContext
       # Original puppeteer implementation take it into consideration.
       # But we don't support the syntax here.
 
-      result = client.send_message('Runtime.callFunctionOn',
-        functionDeclaration: function_declaration,
-        executionContextId: context_id,
-        arguments: converted_args,
-        returnByValue: @return_by_value,
-        awaitPromise: true,
-        userGesture: true,
-      ) # .catch(rewriteError);
+      result =
+        begin
+          client.send_message('Runtime.callFunctionOn',
+            functionDeclaration: function_declaration,
+            executionContextId: context_id,
+            arguments: converted_args,
+            returnByValue: @return_by_value,
+            awaitPromise: true,
+            userGesture: true,
+          )
+        rescue Puppeteer::Connection::ProtocolError => err
+          raise @execution_context.send(:rewrite_evaluation_error, err)
+        end # .catch(rewriteError);
 
       exception_details = result['exceptionDetails']
       if exception_details
@@ -337,6 +347,18 @@ class Puppeteer::ExecutionContext
     )
   end
 
+  # @param error [Puppeteer::Connection::ProtocolError]
+  # @return [StandardError]
+  private def rewrite_evaluation_error(error)
+    message = error.message
+    if message.end_with?('Cannot find context with specified id') ||
+       message.end_with?('Inspected target navigated or closed')
+      return Puppeteer::Error.new('Execution context was destroyed, most likely because of a navigation.')
+    end
+
+    error
+  end
+
   # @rbs page_function: String -- JavaScript code to check
   # @rbs return: bool -- Whether the code represents a function
   private def function_string?(page_function)