puppeteer-ruby 0.51.0 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74f00095ae82e1e4502260b99ff766cc46c758ae5e762050a6e7c46b7249f469
-  data.tar.gz: a197f92fc8b7ccbe2904c088d52e60409af119d94449a6a4e9f518601c4c5788
+  metadata.gz: dc3601ac8a64edb1a6054663944d5244eb0fcbc774b2d2f73529eef194031689
+  data.tar.gz: c364f8b73fc4dc6a591baca37e2e116d3147c5572f42dd026de77e36b0842851
 SHA512:
-  metadata.gz: df595ba0c4996b100b1d8b22bb35e0e0ce9b6552d368c11fc25b9c8cf60c1a270b651f6f96e6c1b65b64d32550b71c402a059a0fd4d3a1393a394b65de472aef
-  data.tar.gz: f82344aba53b730d5fdb7273ef29fdb07d0b8aadc831d680fd5611d55df980955cb5fd5cbdbe78d0de88c70d689f738952187193b4f006386a2170970f928dd2
+  metadata.gz: a4de65d9249823c8532150d9cbeace0670d5e0c35de747193bee4923edb751b3dcc7a46aa6ec5f58393e20fabe9933b12eaca0ac47ead1d91c5793fec8ca0e9b
+  data.tar.gz: 4d5d39fe7dac8d74a3f90478f3bae1bd7e9dcb14018518551ca4ca7d59f48ed1e9f9e7205c33956d82591b2985b4fecd5f1eb4f0af8efc03f4a1b3f22a0b2281

data/docs/api_coverage.md

@@ -1,5 +1,5 @@
 # API coverages
-- Puppeteer version: v24.37.0
+- 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
@@ -38,7 +39,7 @@
 * ~~setWindowBounds~~
 * target
 * targets
-* ~~uninstallExtension~~
+* uninstallExtension => `#uninstall_extension`
 * userAgent => `#user_agent`
 * version
 * waitForTarget => `#wait_for_target`
@@ -126,7 +127,7 @@
 * $$eval => `#eval_on_selector_all`
 * $eval => `#eval_on_selector`
 * asLocator => `#as_locator`
-* ~~autofill~~
+* autofill
 * ~~backendNodeId~~
 * boundingBox => `#bounding_box`
 * boxModel => `#box_model`
@@ -165,6 +166,12 @@
 * ~~once~~
 * ~~removeAllListeners~~
 
+## Extension
+
+* pages
+* triggerAction => `#trigger_action`
+* workers
+
 ## ~~ExtensionTransport~~
 
 * ~~close~~
@@ -190,6 +197,7 @@
 * content
 * evaluate
 * evaluateHandle => `#evaluate_handle`
+* extensionRealms => `#extension_realms`
 * focus
 * frameElement => `#frame_element`
 * goto
@@ -344,6 +352,7 @@
 * evaluateHandle => `#evaluate_handle`
 * evaluateOnNewDocument => `#evaluate_on_new_document`
 * exposeFunction => `#expose_function`
+* extensionRealms => `#extension_realms`
 * focus
 * frames
 * ~~getDefaultNavigationTimeout~~
@@ -351,6 +360,7 @@
 * goBack => `#go_back`
 * goForward => `#go_forward`
 * goto
+* ~~hasDevTools~~
 * hover
 * isClosed => `#closed?`
 * isDragInterceptionEnabled => `#drag_interception_enabled?`
@@ -387,6 +397,7 @@
 * tap
 * target
 * title
+* triggerExtensionAction => `#trigger_extension_action`
 * type => `#type_text`
 * url
 * viewport
@@ -405,6 +416,13 @@
 ## ~~ProtocolError~~
 
 
+## ~~Realm~~
+
+* ~~evaluate~~
+* ~~evaluateHandle~~
+* ~~extension~~
+* ~~waitForFunction~~
+
 ## ~~ScreenRecorder~~
 
 * ~~stop~~
@@ -420,7 +438,7 @@
 
 ## Target
 
-* ~~asPage~~
+* asPage => `#as_page`
 * browser
 * browserContext => `#browser_context`
 * createCDPSession => `#create_cdp_session`
@@ -451,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')
@@ -376,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/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
@@ -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)

data/lib/puppeteer/extension.rb

@@ -0,0 +1,70 @@
+# rbs_inline: enabled
+
+class Puppeteer::Extension
+  # @rbs id: String -- Extension id
+  # @rbs version: String -- Extension version
+  # @rbs name: String -- Extension name
+  # @rbs path: String -- Extension path
+  # @rbs enabled: bool -- Whether extension is enabled
+  # @rbs browser: Puppeteer::Browser -- Browser instance
+  # @rbs return: void -- No return value
+  def initialize(id:, version:, name:, path:, enabled:, browser:)
+    @id = id
+    @version = version
+    @name = name
+    @path = path
+    @enabled = enabled
+    @browser = browser
+  end
+
+  # @rbs return: String -- Extension id
+  attr_reader :id
+
+  # @rbs return: String -- Extension version
+  attr_reader :version
+
+  # @rbs return: String -- Extension name
+  attr_reader :name
+
+  # @rbs return: String -- Extension path
+  attr_reader :path
+
+  # @rbs return: bool -- Whether extension is enabled
+  attr_reader :enabled
+
+  # @rbs return: Array[Puppeteer::CdpWebWorker] -- Extension workers
+  def workers
+    extension_prefix = "chrome-extension://#{@id}"
+    extension_targets = @browser.targets.select do |target|
+      target.type == 'service_worker' && target.url.start_with?(extension_prefix)
+    end
+    extension_targets.filter_map do |target|
+      target.worker
+    rescue
+      nil
+    end
+  end
+
+  # @rbs return: Array[Puppeteer::Page] -- Extension pages
+  def pages
+    extension_prefix = "chrome-extension://#{@id}"
+    extension_targets = @browser.targets.select do |target|
+      target_url = target.url
+      ['page', 'background_page'].include?(target.type) && target_url.start_with?(extension_prefix)
+    end
+    extension_targets.filter_map do |target|
+      target.as_page
+    rescue
+      nil
+    end
+  end
+
+  # @rbs page: Puppeteer::Page -- Target page
+  # @rbs return: void -- No return value
+  def trigger_action(page)
+    page.browser.send(:connection).send_message('Extensions.triggerAction', {
+      id: @id,
+      targetId: page._tab_id,
+    })
+  end
+end

data/lib/puppeteer/frame.rb

@@ -19,6 +19,7 @@ class Puppeteer::Frame
     @url = 'about:blank'
     @lifecycle_events = Set.new
     @child_frames = Set.new
+    @extension_worlds = {}
     if parent_frame
       parent_frame._child_frames << self
     end
@@ -71,7 +72,7 @@ class Puppeteer::Frame
     @client != @frame_manager.client
   end
 
-  attr_accessor :frame_manager, :id, :loader_id, :lifecycle_events, :main_world, :puppeteer_world
+  attr_accessor :frame_manager, :id, :loader_id, :lifecycle_events, :main_world, :puppeteer_world, :extension_worlds
   attr_reader :client
 
   # @rbs other: Object -- Other object to compare
@@ -229,6 +230,11 @@ class Puppeteer::Frame
     @url
   end
 
+  # @rbs return: Array[untyped] -- Extension execution realms for this frame
+  def extension_realms
+    @extension_worlds.values
+  end
+
   # @rbs return: Puppeteer::Frame? -- Parent frame
   def parent_frame
     @parent_frame
@@ -425,6 +431,7 @@ class Puppeteer::Frame
     @detached = true
     @main_world.detach
     @puppeteer_world.detach
+    @extension_worlds.each_value(&:detach)
     if @parent_frame
       @parent_frame._child_frames.delete(self)
     end