capybara-lightpanda 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 759abeb96b5d6898d9458d2e81af39b97d155766cfd2c80fa1ed363409a6aff6
-  data.tar.gz: 66d54d836501ab8ec7d3cc23ffc389f58777c938a19490f9dc81a076819b4489
+  metadata.gz: d38fc6a0a5cbba01bba3a0a1363d8e0577dc99c2cb8a77b81f407b273a91863b
+  data.tar.gz: 21cdea0aeba27736c52f800c22e850d80ea15d3c7bb1c6c9b173421bb227be7d
 SHA512:
-  metadata.gz: ffdc46e2b18c6ce822fb7765cc668bfda6594e1ce27f9ad88b29e4d9a34f6882b80aad54fcb0581d460e68b3fbcaaaa853017f825295b1a8758a244da520d12d
-  data.tar.gz: 6ae51661f2a7108ec85bebf773965dd792f74d04b80cdff7c5992b41be5c32f15b3d7e08d97a64212a64a812be4ebe811f222ad6fa91866888d1f6e50a805b71
+  metadata.gz: ec4a2743650df3602c43fc393a82af00c19c5b44d59fab31156aed0b3252e8fb7f3c5f06df1b6e2fe994c9b974a1b21b29707c22c6bff571d4c2b6aca195add4
+  data.tar.gz: ba19fbd3c2754eae2b6d3af02584d739eba498b93e0e0ff392f9dc7a9feefdc1af1ff68081cd5b6963ca41c768cf8cebcf3b48b9debd9923e5142b15ac1c9223

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.14.1] - 2026-10-12
+
+### Fixed
+
+- **A click that loads a new page waits for that page's scripts.** `click` used to return as soon as the new document existed, before its deferred and module scripts had run. Apps load Stimulus, Turbo and Bootstrap that way, so the next action could land on a page whose handlers were not wired yet: a Bootstrap collapse that did not open, a `confirm()` that never showed (`accept_confirm` raised `ModalNotFound`) while the form was submitted anyway, a form posted before its JavaScript was ready. The click now also waits for `DOMContentLoaded`, as Cuprite waits for the load event. `send_keys`, `go_back` and `go_forward` wait the same way when they load a new page. Clicks that don't navigate are as fast as before.
+- **A click on a link that Turbo hands back to the browser waits for the new page.** With Turbo on the page, such a click returned immediately on the page being left, because Turbo reported activity and went idle again before the navigation started.
+
 ## [0.14.0] - 2026-10-11
 
 ### Fixed

data/lib/capybara/lightpanda/browser.rb

@@ -167,6 +167,7 @@ module Capybara
         subscribe_to_console_capture
         subscribe_to_execution_context
         subscribe_to_navigation
+        subscribe_to_document_ready
         subscribe_to_turbo_signals
         # Network owns the Network.* domain: enabling installs traffic
         # tracking AND the navigation-response capture behind status_code.
@@ -425,13 +426,15 @@ module Capybara
       #
       # Sniff window: the action returns synchronously, but the CDP events
       # signalling its async fallout arrive later on the dispatch thread. We
-      # poll briefly for any of them — a main-frame navigation start (see
-      # subscribe_to_navigation), Runtime.executionContextsCleared, or the
-      # turbo sentinel — and if none fires within the window, assume the
-      # action was inert and exit fast. Lightpanda announces a navigation
-      # ~5 ms after the click but only swaps the execution context once the
-      # response lands, so watching the context alone returned on the old
-      # document whenever the server took longer than the window.
+      # poll briefly for either of them — a main-frame navigation start (see
+      # subscribe_to_navigation) or Runtime.executionContextsCleared — and if
+      # none fires within the window, assume the action was inert and exit
+      # fast. Lightpanda announces a navigation ~5 ms after the click but only
+      # swaps the execution context once the response lands, so watching the
+      # context alone returned on the old document whenever the server took
+      # longer than the window. The turbo sentinel does not end the sniff
+      # (it is awaited after): Turbo goes busy then idle within a few ms on a
+      # link it hands back to the browser, before the navigation start lands.
       SNIFF_WINDOW = 0.05
       private_constant :SNIFF_WINDOW
 
@@ -444,7 +447,6 @@ module Capybara
           navigating = @navigation_event.iteration > prior_navigation_iteration
           break if navigating
           break if @default_context_event.iteration > prior_context_iteration
-          break unless @turbo_event.set?
           break if monotonic_time > sniff_deadline
 
           sleep 0.001
@@ -452,7 +454,10 @@ module Capybara
 
         # Only a navigation this action started is awaited: one left pending
         # by an earlier load must not make every later click pay the timeout.
-        @navigation_event.wait(@options.timeout) if navigating
+        if navigating
+          @navigation_event.wait(@options.timeout)
+          wait_for_document_ready
+        end
         @default_context_event.wait(@options.timeout)
         @turbo_event.wait(@options.timeout)
         check_unhandled_modal!
@@ -658,6 +663,64 @@ module Capybara
         end
       end
 
+      # The new document's context exists before its deferred and module
+      # scripts have run: this event marks the end of that phase, at
+      # Page.domContentEventFired or anything later that proves it is over
+      # (load, the frame stopping, the document request failing).
+      def subscribe_to_document_ready
+        @document_ready_event = Utils::Event.new
+        @document_ready_event.set
+
+        on("Page.frameStartedNavigating") do |params|
+          @document_ready_event.reset if main_frame_navigation_start?(params)
+        end
+        on("Page.domContentEventFired") { @document_ready_event.set }
+        on("Page.loadEventFired") { @document_ready_event.set }
+        on("Page.frameStoppedLoading") do |params|
+          @document_ready_event.set if params["frameId"] == @target_id
+        end
+        on("Network.loadingFailed") do |params|
+          @document_ready_event.set if params["requestId"] == @navigation_request_id
+        end
+      end
+
+      # After a click that navigated, the next action must not run before the
+      # new page's JS has wired its handlers: Stimulus, Bootstrap's data-api
+      # and Turbo load as module scripts, which run after the document commits
+      # and before DOMContentLoaded. Cuprite waits for the load event. The
+      # event is awaited briefly, then document.readyState is polled for the
+      # rest of the budget, as #go_to does (lightpanda-io/browser#1801: page
+      # events may never come). Never raises: a page that never settles costs
+      # the timeout once, then the action returns as it did before.
+      DOCUMENT_READY_EVENT_WAIT = 2
+      private_constant :DOCUMENT_READY_EVENT_WAIT
+
+      def wait_for_document_ready
+        deadline = monotonic_time + @options.timeout
+        return if @document_ready_event.wait([DOCUMENT_READY_EVENT_WAIT, @options.timeout].min)
+
+        remaining = deadline - monotonic_time
+        return unless remaining.positive?
+
+        Utils::Wait.until(timeout: remaining, interval: 0.1) do
+          @document_ready_event.set? || @client.closed? || document_complete?
+        end
+      rescue TimeoutError
+        nil
+      end
+
+      def document_complete?
+        response = @client.command(
+          "Runtime.evaluate",
+          { expression: "document.readyState", returnByValue: true },
+          session_id: @session_id,
+          timeout: 2
+        )
+        response.dig("result", "value") == "complete"
+      rescue Error
+        false
+      end
+
       def main_frame_navigation_start?(params)
         params["frameId"] == @target_id && !params["navigationType"].to_s.match?(/same/i)
       end

data/lib/capybara/lightpanda/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Lightpanda
-    VERSION = "0.14.0"
+    VERSION = "0.14.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-lightpanda
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Navid Emad