puppeteer-ruby 0.45.6 → 0.50.0.alpha5

data/lib/puppeteer/frame.rb

@@ -1,10 +1,13 @@
+# rbs_inline: enabled
+
 class Puppeteer::Frame
   using Puppeteer::DefineAsyncMethod
 
-  # @param frame_manager [Puppeteer::FrameManager]
-  # @param parent_frame [Puppeteer::Frame|nil]
-  # @param frame_id [String]
-  # @param client [Puppeteer::CDPSession]
+  # @rbs frame_manager: Puppeteer::FrameManager -- Owning frame manager
+  # @rbs parent_frame: Puppeteer::Frame? -- Parent frame
+  # @rbs frame_id: String -- Frame ID
+  # @rbs client: Puppeteer::CDPSession -- CDP session
+  # @rbs return: void -- No return value
   def initialize(frame_manager, parent_frame, frame_id, client)
     @frame_manager = frame_manager
     @parent_frame = parent_frame
@@ -13,6 +16,7 @@ class Puppeteer::Frame
     @has_started_loading = false
 
     @loader_id = ''
+    @url = 'about:blank'
     @lifecycle_events = Set.new
     @child_frames = Set.new
     if parent_frame
@@ -22,6 +26,7 @@ class Puppeteer::Frame
     update_client(client)
   end
 
+  # @rbs return: String -- Inspection string
   def inspect
     values = %i[id parent_frame detached loader_id lifecycle_events child_frames].map do |sym|
       value = instance_variable_get(:"@#{sym}")
@@ -30,62 +35,95 @@ class Puppeteer::Frame
     "#<Puppeteer::Frame #{values.join(' ')}>"
   end
 
+  # @rbs return: Puppeteer::CDPSession -- Current CDP session
   def _client
     @client
   end
 
-  # @param client [Puppeteer::CDPSession]
   private def update_client(client)
     @client = client
     @main_world = Puppeteer::IsolaatedWorld.new(@client, @frame_manager, self, @frame_manager.timeout_settings)
     @puppeteer_world = Puppeteer::IsolaatedWorld.new(@client, @frame_manager, self, @frame_manager.timeout_settings)
   end
 
+  # @rbs return: Puppeteer::Page -- Owning page
   def page
     @frame_manager.page
   end
 
+  # @rbs return: bool -- Whether this is an OOPIF frame
   def oop_frame?
     @client != @frame_manager.client
   end
 
   attr_accessor :frame_manager, :id, :loader_id, :lifecycle_events, :main_world, :puppeteer_world
+  attr_reader :client
 
-  def has_started_loading?
-    @has_started_loading
+  # @rbs other: Object -- Other object to compare
+  # @rbs return: bool -- Equality result
+  def ==(other)
+    other = other.__getobj__ if other.is_a?(Puppeteer::ReactorRunner::Proxy)
+    return true if equal?(other)
+    return false unless other.is_a?(Puppeteer::Frame)
+    return false unless @id && other.id
+
+    @id == other.id
   end
 
-  # @param url [String]
-  # @param rederer [String]
-  # @param timeout [number|nil]
-  # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  # @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)
+  # @rbs return: bool -- Whether loading has started
+  def has_started_loading?
+    @has_started_loading
   end
 
-  # @param timeout [number|nil]
-  # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  def wait_for_navigation(timeout: nil, wait_until: nil)
-    @frame_manager.wait_for_frame_navigation(self, timeout: timeout, wait_until: wait_until)
+  # @rbs url: String -- URL to navigate
+  # @rbs referer: String? -- Referer header value
+  # @rbs referrer_policy: String? -- Referrer policy
+  # @rbs timeout: Numeric? -- Navigation timeout in milliseconds
+  # @rbs wait_until: String? -- Lifecycle event to wait for
+  # @rbs return: Puppeteer::HTTPResponse? -- Navigation response
+  def goto(url, referer: nil, referrer_policy: nil, timeout: nil, wait_until: nil)
+    @frame_manager.navigate_frame(
+      self,
+      url,
+      referer: referer,
+      referrer_policy: referrer_policy,
+      timeout: timeout,
+      wait_until: wait_until,
+    )
+  end
+
+  # @rbs timeout: Numeric? -- Navigation timeout in milliseconds
+  # @rbs wait_until: String? -- Lifecycle event to wait for
+  # @rbs ignore_same_document_navigation: bool -- Ignore same-document navigation
+  # @rbs return: Puppeteer::HTTPResponse? -- Navigation response
+  def wait_for_navigation(timeout: nil, wait_until: nil, ignore_same_document_navigation: false)
+    @frame_manager.wait_for_frame_navigation(
+      self,
+      timeout: timeout,
+      wait_until: wait_until,
+      ignore_same_document_navigation: ignore_same_document_navigation,
+    )
   end
 
   define_async_method :async_wait_for_navigation
 
+  # @rbs return: Puppeteer::ExecutionContext -- Main world execution context
   def execution_context
     @main_world.execution_context
   end
 
-  # @param {Function|string} pageFunction
-  # @return {!Promise<!Puppeteer.JSHandle>}
+  # @rbs page_function: String -- Function or expression to evaluate
+  # @rbs args: Array[untyped] -- Arguments for evaluation
+  # @rbs return: Puppeteer::JSHandle -- Handle to evaluation result
   def evaluate_handle(page_function, *args)
     @main_world.evaluate_handle(page_function, *args)
   end
 
   define_async_method :async_evaluate_handle
 
-  # @param {Function|string} pageFunction
-  # @param {!Array<*>} args
+  # @rbs page_function: String -- Function or expression to evaluate
+  # @rbs args: Array[untyped] -- Arguments for evaluation
+  # @rbs return: untyped -- Evaluation result
   def evaluate(page_function, *args)
     @main_world.evaluate(page_function, *args)
   end
@@ -93,8 +131,8 @@ class Puppeteer::Frame
   define_async_method :async_evaluate
 
   # `$()` in JavaScript.
-  # @param {string} selector
-  # @return {!Promise<?Puppeteer.ElementHandle>}
+  # @rbs selector: String -- CSS selector
+  # @rbs return: Puppeteer::ElementHandle? -- Matching element or nil
   def query_selector(selector)
     @main_world.query_selector(selector)
   end
@@ -103,8 +141,8 @@ class Puppeteer::Frame
   define_async_method :async_query_selector
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param {string} expression
-  # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
+  # @rbs expression: String -- XPath expression
+  # @rbs return: Array[Puppeteer::ElementHandle] -- Matching elements
   def Sx(expression)
     param_xpath =
       if expression.start_with?('//')
@@ -119,10 +157,10 @@ class Puppeteer::Frame
   define_async_method :async_Sx
 
   # `$eval()` in JavaScript.
-  # @param {string} selector
-  # @param {Function|string} pageFunction
-  # @param {!Array<*>} args
-  # @return {!Promise<(!Object|undefined)>}
+  # @rbs selector: String -- CSS selector
+  # @rbs page_function: String -- Function or expression to evaluate
+  # @rbs args: Array[untyped] -- Arguments for evaluation
+  # @rbs return: untyped -- Evaluation result
   def eval_on_selector(selector, page_function, *args)
     @main_world.eval_on_selector(selector, page_function, *args)
   end
@@ -131,10 +169,10 @@ class Puppeteer::Frame
   define_async_method :async_eval_on_selector
 
   # `$$eval()` in JavaScript.
-  # @param {string} selector
-  # @param {Function|string} pageFunction
-  # @param {!Array<*>} args
-  # @return {!Promise<(!Object|undefined)>}
+  # @rbs selector: String -- CSS selector
+  # @rbs page_function: String -- Function or expression to evaluate
+  # @rbs args: Array[untyped] -- Arguments for evaluation
+  # @rbs return: untyped -- Evaluation result
   def eval_on_selector_all(selector, page_function, *args)
     @main_world.eval_on_selector_all(selector, page_function, *args)
   end
@@ -143,137 +181,166 @@ class Puppeteer::Frame
   define_async_method :async_eval_on_selector_all
 
   # `$$()` in JavaScript.
-  # @param {string} selector
-  # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
-  def query_selector_all(selector)
-    @main_world.query_selector_all(selector)
+  # @rbs selector: String -- CSS selector
+  # @rbs isolate: bool? -- Use isolated world for queries
+  # @rbs return: Array[Puppeteer::ElementHandle] -- Matching elements
+  def query_selector_all(selector, isolate: nil)
+    @main_world.query_selector_all(selector, isolate: isolate)
   end
   alias_method :SS, :query_selector_all
 
   define_async_method :async_query_selector_all
 
-  # @return [String]
+  # @rbs return: String -- Page HTML content
   def content
     @puppeteer_world.content
   end
 
-  # @param html [String]
-  # @param timeout [Integer]
-  # @param wait_until [String|Array<String>]
+  # @rbs html: String -- HTML content
+  # @rbs timeout: Numeric? -- Navigation timeout in milliseconds
+  # @rbs wait_until: String | Array[String] | nil -- Lifecycle events to wait for
+  # @rbs return: void -- No return value
   def set_content(html, timeout: nil, wait_until: nil)
     @puppeteer_world.set_content(html, timeout: timeout, wait_until: wait_until)
   end
 
-  # @return [String]
+  # @rbs return: String -- Frame name
   def name
     @name || ''
   end
 
-  # @return [String]
+  # @rbs return: String? -- Frame URL
   def url
     @url
   end
 
-  # @return [Frame?]
+  # @rbs return: Puppeteer::Frame? -- Parent frame
   def parent_frame
     @parent_frame
   end
 
+  # @rbs return: Puppeteer::ElementHandle? -- Frame element handle
+  def frame_element
+    parent = parent_frame
+    return nil unless parent
+
+    response = parent.client.send_message('DOM.getFrameOwner', frameId: @id)
+    parent.main_world.adopt_backend_node(response['backendNodeId'])
+  end
+
   protected def _child_frames
     @child_frames
   end
 
+  # @rbs return: Array[Puppeteer::Frame] -- Child frames
   def child_frames
     @child_frames.to_a
   end
 
+  # @rbs return: bool -- Whether the frame is detached
   def detached?
     @detached
   end
 
-  # @param url [String?]
-  # @param path [String?]
-  # @param content [String?]
-  # @param type [String?]
-  # @param id [String?]
+  # @rbs url: String? -- Script URL
+  # @rbs path: String? -- Path to script file
+  # @rbs content: String? -- Script contents
+  # @rbs type: String? -- Script type
+  # @rbs id: String? -- Script element ID
+  # @rbs return: Puppeteer::ElementHandle -- Script element handle
   def add_script_tag(url: nil, path: nil, content: nil, type: nil, id: nil)
     @main_world.add_script_tag(url: url, path: path, content: content, type: type, id: id)
   end
 
-  # @param url [String?]
-  # @param path [String?]
-  # @param content [String?]
+  # @rbs url: String? -- Stylesheet URL
+  # @rbs path: String? -- Path to stylesheet file
+  # @rbs content: String? -- Stylesheet contents
+  # @rbs return: Puppeteer::ElementHandle -- Style element handle
   def add_style_tag(url: nil, path: nil, content: nil)
     @main_world.add_style_tag(url: url, path: path, content: content)
   end
 
-  # @param selector [String]
-  # @param delay [Number]
-  # @param button [String] "left"|"right"|"middle"
-  # @param click_count [Number]
-  def click(selector, delay: nil, button: nil, click_count: nil)
-    @puppeteer_world.click(selector, delay: delay, button: button, click_count: click_count)
+  # @rbs selector: String -- CSS selector
+  # @rbs delay: Numeric? -- Delay between down and up (ms)
+  # @rbs button: String? -- Mouse button
+  # @rbs click_count: Integer? -- Deprecated: use count (click_count only sets clickCount)
+  # @rbs count: Integer? -- Number of clicks to perform
+  # @rbs return: void -- No return value
+  def click(selector, delay: nil, button: nil, click_count: nil, count: nil)
+    @puppeteer_world.click(selector, delay: delay, button: button, click_count: click_count, count: count)
   end
 
   define_async_method :async_click
 
-  # @param {string} selector
+  # @rbs selector: String -- CSS selector
+  # @rbs return: void -- No return value
   def focus(selector)
     @puppeteer_world.focus(selector)
   end
 
   define_async_method :async_focus
 
-  # @param {string} selector
+  # @rbs selector: String -- CSS selector
+  # @rbs return: void -- No return value
   def hover(selector)
     @puppeteer_world.hover(selector)
   end
 
-  # @param {string} selector
-  # @param {!Array<string>} values
-  # @return {!Promise<!Array<string>>}
+  # @rbs selector: String -- CSS selector
+  # @rbs values: Array[String] -- Option values to select
+  # @rbs return: Array[String] -- Selected values
   def select(selector, *values)
     @puppeteer_world.select(selector, *values)
   end
 
   define_async_method :async_select
 
-  # @param {string} selector
+  # @rbs selector: String -- CSS selector
+  # @rbs return: void -- No return value
   def tap(selector)
     @puppeteer_world.tap(selector)
   end
 
   define_async_method :async_tap
 
-  # @param selector [String]
-  # @param text [String]
-  # @param delay [Number]
+  # @rbs selector: String -- CSS selector
+  # @rbs text: String -- Text to type
+  # @rbs delay: Numeric? -- Delay between key presses (ms)
+  # @rbs return: void -- No return value
   def type_text(selector, text, delay: nil)
     @main_world.type_text(selector, text, delay: delay)
   end
 
   define_async_method :async_type_text
 
-  # @param selector [String]
-  # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
-  # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
-  # @param timeout [Integer]
+  # @rbs selector: String -- CSS selector
+  # @rbs visible: bool? -- Wait for element to be visible
+  # @rbs hidden: bool? -- Wait for element to be hidden
+  # @rbs timeout: Numeric? -- Maximum wait time in milliseconds
+  # @rbs return: Puppeteer::ElementHandle? -- Matching element or nil
   def wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil)
     query_handler_manager = Puppeteer::QueryHandlerManager.instance
-    query_handler_manager.detect_query_handler(selector).wait_for(self, visible: visible, hidden: hidden, timeout: timeout)
+    query_handler_manager.detect_query_handler(selector).wait_for(
+      self,
+      visible: visible,
+      hidden: hidden,
+      timeout: timeout,
+    )
   end
 
   define_async_method :async_wait_for_selector
 
-  # @param milliseconds [Integer] the number of milliseconds to wait.
+  # @rbs milliseconds: Numeric -- Time to wait in milliseconds
+  # @rbs return: void -- No return value
   def wait_for_timeout(milliseconds)
-    sleep(milliseconds / 1000.0)
+    Puppeteer::AsyncUtils.sleep_seconds(milliseconds / 1000.0)
   end
 
-  # @param xpath [String]
-  # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
-  # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
-  # @param timeout [Integer]
+  # @rbs xpath: String -- XPath expression
+  # @rbs visible: bool? -- Wait for element to be visible
+  # @rbs hidden: bool? -- Wait for element to be hidden
+  # @rbs timeout: Numeric? -- Maximum wait time in milliseconds
+  # @rbs return: Puppeteer::ElementHandle? -- Matching element or nil
   def wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil)
     param_xpath =
       if xpath.start_with?('//')
@@ -287,37 +354,38 @@ class Puppeteer::Frame
 
   define_async_method :async_wait_for_xpath
 
-  # @param page_function [String]
-  # @param args [Integer|Array]
-  # @param polling [String]
-  # @param timeout [Integer]
-  # @return [Puppeteer::JSHandle]
+  # @rbs page_function: String -- Function or expression to evaluate
+  # @rbs args: Array[untyped] -- Arguments for evaluation
+  # @rbs polling: String | Numeric | nil -- Polling strategy
+  # @rbs timeout: Numeric? -- Maximum wait time in milliseconds
+  # @rbs return: Puppeteer::JSHandle -- Handle to evaluation result
   def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
     @main_world.wait_for_function(page_function, args: args, polling: polling, timeout: timeout)
   end
 
   define_async_method :async_wait_for_function
 
-  # @return [String]
+  # @rbs return: String -- Frame title
   def title
     @puppeteer_world.title
   end
 
-  # @param frame_payload [Hash]
+  # @rbs frame_payload: Hash[String, untyped] -- Frame payload
+  # @rbs return: void -- No return value
   def navigated(frame_payload)
     @name = frame_payload['name']
     @url = "#{frame_payload['url']}#{frame_payload['urlFragment']}"
-
-    # Ensure loaderId updated.
-    # The order of [Page.lifecycleEvent name="init"] and [Page.frameNavigated] is random... for some reason...
-    @loader_id = frame_payload['loaderId'] if frame_payload['loaderId']
   end
 
-  # @param url [String]
+  # @rbs url: String -- Updated URL
+  # @rbs return: void -- No return value
   def navigated_within_document(url)
     @url = url
   end
 
+  # @rbs loader_id: String -- Loader ID
+  # @rbs name: String -- Lifecycle event name
+  # @rbs return: void -- No return value
   def handle_lifecycle_event(loader_id, name)
     if name == 'init'
       @loader_id = loader_id
@@ -326,15 +394,18 @@ class Puppeteer::Frame
     @lifecycle_events << name
   end
 
+  # @rbs return: void -- No return value
   def handle_loading_started
     @has_started_loading = true
   end
 
+  # @rbs return: void -- No return value
   def handle_loading_stopped
     @lifecycle_events << 'DOMContentLoaded'
     @lifecycle_events << 'load'
   end
 
+  # @rbs return: void -- No return value
   def detach
     @detached = true
     @main_world.detach