puppeteer-ruby 0.43.0 → 0.43.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da17d477ad97a3197fa0eacf237e784204439efdca104e2a304d5cfb58c449d3
-  data.tar.gz: f56c151a8d7ebd8ac0ff71feafe5a90dcdd14ed997aaa9ea8e198ddd345b93dd
+  metadata.gz: e723d5efd8074f8c70f1b94de1399f35ec39eca88fd86d1991b036db32d783a8
+  data.tar.gz: 463781ad3737b5db0f09b2ba9ec2ed8f62863991c011291437230c512671e0ba
 SHA512:
-  metadata.gz: 3db33eea6388dd6c743395c9e3cd583d95a3f2147627ae371390e40bf6269f32d689687e8adf0fdaef8b99134b6bad2ee55061ca66c037407ec681ee62b61188
-  data.tar.gz: 2b169890fd8c5dde6850fff2439e5d43c03fa1b65e906ce443389c0599cf31d0e88af1ca0203c12cff90b2789c14af7a992d1c6b95caf7e78b9dadbf4d4a0f09
+  metadata.gz: 46462c2894970d02792d5021088252fce262f41f81531449a73d9d40745ede1742fe187cde65cae64222ba817366500d347ca310aa658147040e4fbfa5d1b5db
+  data.tar.gz: d5b6e7ae1e0efc6c1e69e7bb136f90dfdc1c2370c29ec4bf9a6877c22bbe38cd6a81f698f086dce3157800bdfc7bfcb06f7eb35b518434870fd95456dc1fbe3c

data/CHANGELOG.md

@@ -1,7 +1,11 @@
-### main [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.43.0...main)]
+### main [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.43.1...main)]
 
 - xxx
 
+### 0.43.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.43.0...0.43.1)]
+
+- Port Puppeteer v16.1 features, including bugfix and XPath query handler.
+
 ### 0.43.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.42.0...0.43.0)]
 
 - Port Puppeteer v16.0 features. Increasing stability.

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
 - Puppeteer version: v16.2.0
-- puppeteer-ruby version: 0.43.0
+- puppeteer-ruby version: 0.43.1
 
 ## Puppeteer
 

data/lib/puppeteer/browser.rb

@@ -196,7 +196,7 @@ class Puppeteer::Browser
       session: session,
       browser_context: context,
       target_manager: @target_manager,
-      session_factory: -> { @connection.create_session(target_info) },
+      session_factory: -> (auto_attach_emulated) { @connection.create_session(target_info, auto_attach_emulated: auto_attach_emulated) },
       ignore_https_errors: @ignore_https_errors,
       default_viewport: @default_viewport,
       is_page_target_callback: @is_page_target_callback,

data/lib/puppeteer/chrome_target_manager.rb

@@ -1,4 +1,5 @@
 class Puppeteer::ChromeTargetManager
+  include Puppeteer::DebugPrint
   include Puppeteer::EventCallbackable
 
   def initialize(connection:, target_factory:, target_filter_callback:)
@@ -33,20 +34,34 @@ class Puppeteer::ChromeTargetManager
     )
 
     setup_attachment_listeners(@connection)
-    @connection.async_send_message('Target.setDiscoverTargets', discover: true)
+    @connection.async_send_message('Target.setDiscoverTargets', {
+      discover: true,
+      filter: [
+        { type: 'tab', exclude: true },
+        {},
+      ],
+    }).then do
+      store_existing_targets_for_init
+    end.rescue do |err|
+      debug_puts(err)
+    end
   end
 
-  def init
+  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)
+      if @target_filter_callback.call(target_info) && target_info.type != 'browser'
         @target_ids_for_init << target_id
       end
     end
+  end
+
+  def init
     @connection.send_message('Target.setAutoAttach', {
       waitForDebuggerOnStart: true,
       flatten: true,
       autoAttach: true,
     })
+    finish_initialization_if_ready
     @initialize_promise.value!
   end
 
@@ -114,7 +129,7 @@ class Puppeteer::ChromeTargetManager
       # Special case (https://crbug.com/1338156): currently, shared_workers
       # don't get auto-attached. This should be removed once the auto-attach
       # works.
-      @connection.create_session(target_info)
+      @connection.create_session(target_info, auto_attach_emulated: true)
     end
   end
 
@@ -170,6 +185,8 @@ class Puppeteer::ChromeTargetManager
       end
     }
 
+    return unless @connection.auto_attached?(target_info.target_id)
+
     # 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
@@ -197,6 +214,8 @@ class Puppeteer::ChromeTargetManager
       return
     end
 
+    is_existing_target = @attached_targets_by_target_id.has_key?(target_info.target_id)
+
     target = @attached_targets_by_target_id[target_info.target_id] || @target_factory.call(target_info, session)
     setup_attachment_listeners(session)
 
@@ -218,11 +237,10 @@ class Puppeteer::ChromeTargetManager
     end
 
     @target_ids_for_init.delete(target.target_id)
-    future { emit_event(TargetManagerEmittedEvents::TargetAvailable, target) }
-
-    if @target_ids_for_init.empty?
-      @initialize_promise.fulfill(nil) unless @initialize_promise.resolved?
+    unless is_existing_target
+      future { emit_event(TargetManagerEmittedEvents::TargetAvailable, target) }
     end
+    finish_initialization_if_ready
 
     future do
       # TODO: the browser might be shutting down here. What do we do with the error?
@@ -239,8 +257,8 @@ class Puppeteer::ChromeTargetManager
     end
   end
 
-  private def finish_initialization_if_ready(target_id)
-    @target_ids_for_init.delete(target_id)
+  private def finish_initialization_if_ready(target_id = nil)
+    @target_ids_for_init.delete(target_id) if target_id
     if @target_ids_for_init.empty?
       @initialize_promise.fulfill(nil) unless @initialize_promise.resolved?
     end

data/lib/puppeteer/connection.rb

@@ -319,15 +319,18 @@ class Puppeteer::Connection
   end
 
   def auto_attached?(target_id)
-    @manually_attached.include?(target_id)
+    !@manually_attached.include?(target_id)
   end
 
   # @param {Protocol.Target.TargetInfo} targetInfo
   # @return [CDPSession]
-  def create_session(target_info)
-    @manually_attached << target_info.target_id
+  def create_session(target_info, auto_attach_emulated: false)
+    unless auto_attach_emulated
+      @manually_attached << target_info.target_id
+    end
     result = send_message('Target.attachToTarget', targetId: target_info.target_id, flatten: true)
     session_id = result['sessionId']
+    @manually_attached.delete(target_info.target_id)
     @sessions[session_id]
   end
 end

data/lib/puppeteer/dom_world.rb

@@ -539,49 +539,6 @@ class Puppeteer::DOMWorld
     handle.as_element
   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]
-  def wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil, root: nil)
-    option_wait_for_visible = visible || false
-    option_wait_for_hidden = hidden || false
-    option_timeout = timeout || @timeout_settings.timeout
-    option_root = root
-
-    polling =
-      if option_wait_for_visible || option_wait_for_hidden
-        'raf'
-      else
-        'mutation'
-      end
-    title = "XPath #{xpath}#{option_wait_for_hidden ? 'to be hidden' : ''}"
-
-    xpath_predicate = make_predicate_string(
-      predicate_arg_def: '(root, selector, waitForVisible, waitForHidden)',
-      predicate_body: <<~JAVASCRIPT
-        const node = document.evaluate(selector, root, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
-        return checkWaitForOptions(node, waitForVisible, waitForHidden);
-      JAVASCRIPT
-    )
-
-    wait_task = Puppeteer::WaitTask.new(
-      dom_world: self,
-      predicate_body: xpath_predicate,
-      title: title,
-      polling: polling,
-      timeout: option_timeout,
-      args: [xpath, option_wait_for_visible, option_wait_for_hidden],
-      root: option_root,
-    )
-    handle = wait_task.await_promise
-    unless handle.as_element
-      handle.dispose
-      return nil
-    end
-    handle.as_element
-  end
-
   # @param page_function [String]
   # @param args [Array]
   # @param polling [Integer|String]

data/lib/puppeteer/element_handle.rb

@@ -125,28 +125,14 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   # Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default
   # value can be changed by using the {@link Page.setDefaultTimeout} method.
   def wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil)
-    frame = @context.frame
-
-    secondary_world = frame.secondary_world
-    adopted_root = secondary_world.execution_context.adopt_element_handle(self)
     param_xpath =
       if xpath.start_with?('//')
         ".#{xpath}"
       else
         xpath
       end
-    unless param_xpath.start_with?('.//')
-      adopted_root.dispose
-      raise ArgumentError.new("Unsupported xpath expression: #{xpath}")
-    end
-    handle = secondary_world.wait_for_xpath(param_xpath, visible: visible, hidden: hidden, timeout: timeout, root: adopted_root)
-    adopted_root.dispose
-    return nil unless handle
 
-    main_world = frame.main_world
-    result = main_world.execution_context.adopt_element_handle(handle)
-    handle.dispose
-    result
+    wait_for_selector("xpath/#{param_xpath}", visible: visible, hidden: hidden, timeout: timeout)
   end
 
   define_async_method :async_wait_for_xpath
@@ -623,21 +609,14 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   # @param expression [String]
   # @return [Array<ElementHandle>]
   def Sx(expression)
-    fn = <<~JAVASCRIPT
-    (element, expression) => {
-      const document = element.ownerDocument || element;
-      const iterator = document.evaluate(expression, element, null, XPathResult.ORDERED_NODE_ITERATOR_TYPE);
-      const array = [];
-      let item;
-      while ((item = iterator.iterateNext()))
-        array.push(item);
-      return array;
-    }
-    JAVASCRIPT
-    handles = evaluate_handle(fn, expression)
-    properties = handles.properties
-    handles.dispose
-    properties.values.map(&:as_element).compact
+    param_xpath =
+      if expression.start_with?('//')
+        ".#{expression}"
+      else
+        expression
+      end
+
+    query_selector_all("xpath/#{param_xpath}")
   end
 
   define_async_method :async_Sx

data/lib/puppeteer/frame.rb

@@ -106,7 +106,14 @@ class Puppeteer::Frame
   # @param {string} expression
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
   def Sx(expression)
-    @main_world.Sx(expression)
+    param_xpath =
+      if expression.start_with?('//')
+        ".#{expression}"
+      else
+        expression
+      end
+
+    query_selector_all("xpath/#{param_xpath}")
   end
 
   define_async_method :async_Sx
@@ -274,14 +281,14 @@ class Puppeteer::Frame
   # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
   # @param timeout [Integer]
   def wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil)
-    handle = @secondary_world.wait_for_xpath(xpath, visible: visible, hidden: hidden, timeout: timeout)
-    if !handle
-      return nil
-    end
-    main_execution_context = @main_world.execution_context
-    result = main_execution_context.adopt_element_handle(handle)
-    handle.dispose
-    result
+    param_xpath =
+      if xpath.start_with?('//')
+        ".#{xpath}"
+      else
+        xpath
+      end
+
+    wait_for_selector("xpath/#{param_xpath}", visible: visible, hidden: hidden, timeout: timeout)
   end
 
   define_async_method :async_wait_for_xpath

data/lib/puppeteer/frame_manager.rb

@@ -144,13 +144,13 @@ class Puppeteer::FrameManager
           watcher.same_document_navigation_promise
         end,
       )
+
+      watcher.navigation_response
     rescue Puppeteer::TimeoutError => err
       raise NavigationError.new(err)
     ensure
       watcher.dispose
     end
-
-    watcher.navigation_response
   end
 
   # @param timeout [number|nil]
@@ -168,13 +168,13 @@ class Puppeteer::FrameManager
         watcher.same_document_navigation_promise,
         watcher.new_document_navigation_promise,
       )
+
+      watcher.navigation_response
     rescue Puppeteer::TimeoutError => err
       raise NavigationError.new(err)
     ensure
       watcher.dispose
     end
-
-    watcher.navigation_response
   end
 
   # @param event [Hash]

data/lib/puppeteer/lifecycle_watcher.rb

@@ -81,7 +81,10 @@ class Puppeteer::LifecycleWatcher
       @frame_manager.add_event_listener(FrameManagerEmittedEvents::FrameSwapped, &method(:handle_frame_swapped)),
       @frame_manager.add_event_listener(FrameManagerEmittedEvents::FrameDetached, &method(:handle_frame_detached)),
     ]
-    @listener_ids['network_manager'] = @frame_manager.network_manager.add_event_listener(NetworkManagerEmittedEvents::Request, &method(:handle_request))
+    @listener_ids['network_manager'] = [
+      @frame_manager.network_manager.add_event_listener(NetworkManagerEmittedEvents::Request, &method(:handle_request)),
+      @frame_manager.network_manager.add_event_listener(NetworkManagerEmittedEvents::Response, &method(:handle_response)),
+    ]
 
     @same_document_navigation_promise = resolvable_future
     @lifecycle_promise = resolvable_future
@@ -90,10 +93,24 @@ class Puppeteer::LifecycleWatcher
     check_lifecycle_complete
   end
 
+  class AnotherRequestReceivedError < StandardError ; end
+
   # @param [Puppeteer::HTTPRequest] request
   def handle_request(request)
     return if request.frame != @frame || !request.navigation_request?
     @navigation_request = request
+    @navigation_response_received&.reject(AnotherRequestReceivedError.new('New navigation request was received'))
+    @navigation_response_received = resolvable_future
+    if request.response && !@navigation_response_received.resolved?
+      @navigation_response_received.fulfill(nil)
+    end
+  end
+
+  # @param [Puppeteer::HTTPResponse] response
+  def handle_response(response)
+    return if @navigation_request&.internal&.request_id  != response.request.internal.request_id
+
+    @navigation_response_received.fulfill(nil) unless @navigation_response_received.resolved?
   end
 
   # @param frame [Puppeteer::Frame]
@@ -107,6 +124,8 @@ class Puppeteer::LifecycleWatcher
 
   # @return [Puppeteer::HTTPResponse]
   def navigation_response
+    # Continue with a possibly null response.
+    @navigation_response_received.value! rescue nil
     if_present(@navigation_request) do |request|
       request.response
     end
@@ -175,8 +194,8 @@ class Puppeteer::LifecycleWatcher
     if_present(@listener_ids['frame_manager']) do |ids|
       @frame_manager.remove_event_listener(*ids)
     end
-    if_present(@listener_ids['network_manager']) do |id|
-      @frame_manager.network_manager.remove_event_listener(id)
+    if_present(@listener_ids['network_manager']) do |ids|
+      @frame_manager.network_manager.remove_event_listener(*ids)
     end
   end
 end

data/lib/puppeteer/query_handler_manager.rb

@@ -6,6 +6,7 @@ class Puppeteer::QueryHandlerManager
   def query_handlers
     @query_handlers ||= {
       aria: Puppeteer::AriaQueryHandler.new,
+      xpath: xpath_handler,
     }
   end
 
@@ -16,6 +17,40 @@ class Puppeteer::QueryHandlerManager
     )
   end
 
+  private def xpath_handler
+    @xpath_handler ||= Puppeteer::CustomQueryHandler.new(
+      query_one: <<~JAVASCRIPT,
+      (element, selector) => {
+        const doc = element.ownerDocument || document;
+        const result = doc.evaluate(
+          selector,
+          element,
+          null,
+          XPathResult.FIRST_ORDERED_NODE_TYPE
+        );
+        return result.singleNodeValue;
+      }
+      JAVASCRIPT
+      query_all: <<~JAVASCRIPT,
+      (element, selector) => {
+        const doc = element.ownerDocument || document;
+        const iterator = doc.evaluate(
+          selector,
+          element,
+          null,
+          XPathResult.ORDERED_NODE_ITERATOR_TYPE
+        );
+        const array = [];
+        let item;
+        while ((item = iterator.iterateNext())) {
+          array.push(item);
+        }
+        return array;
+      }
+      JAVASCRIPT
+    )
+  end
+
   class Result
     def initialize(query_handler:, selector:)
       @query_handler = query_handler

data/lib/puppeteer/target.rb

@@ -93,7 +93,7 @@ class Puppeteer::Target
   end
 
   def create_cdp_session
-    @session_factory.call
+    @session_factory.call(false)
   end
 
   def target_manager
@@ -102,7 +102,7 @@ class Puppeteer::Target
 
   def page
     if @is_page_target_callback.call(@target_info) && @page.nil?
-      client = @session || @session_factory.call
+      client = @session || @session_factory.call(true)
       @page = Puppeteer::Page.create(client, self, @ignore_https_errors, @default_viewport)
     end
     @page

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 module Puppeteer
-  VERSION = '0.43.0'
+  VERSION = '0.43.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.43.0
+  version: 0.43.1
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-13 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby