capybara-lightpanda 0.2.2 → 0.4.0

data/lib/capybara/lightpanda/client/web_socket.rb

@@ -43,7 +43,7 @@ module Capybara
         end
 
         def closed?
-          @status == :closed
+          @status == :closed || @status == :error
         end
 
         def open?
@@ -102,10 +102,15 @@ module Capybara
           end
 
           @driver.on(:error) do |event|
+            # Do NOT raise here. This callback fires synchronously from
+            # @driver.parse(data) inside the reader thread, which sets
+            # abort_on_exception = true. Raising DeadBrowserError escapes
+            # the reader's narrow IO rescue and aborts the entire Ruby
+            # process. Mark the connection dead and let Client#command
+            # surface DeadBrowserError on its next dispatch via closed?.
+            @logger&.puts("✗ WebSocket error: #{event.message}")
             @status = :error
             @messages.close
-
-            raise DeadBrowserError, "WebSocket error: #{event.message}"
           end
         end
 
@@ -152,10 +157,25 @@ module Capybara
         def parse_message(data)
           JSON.parse(data, max_nesting: false)
         rescue JSON::ParserError => e
-          warn "Failed to parse WebSocket message: #{e.message}"
+          warn_parse_failure(e.message)
 
           nil
         end
+
+        # Dedupe identical parse-failure warnings per WebSocket instance.
+        # Lightpanda occasionally emits CDP frames that embed a bare
+        # `undefined` token (invalid JSON — see upstream-wishlist.md A41)
+        # and a complex page reproduces the same frame on every load,
+        # which previously flooded test output with one warn per frame.
+        # Surface the first occurrence per unique error so the upstream
+        # regression stays visible, then suppress repeats.
+        def warn_parse_failure(message)
+          @parse_warnings ||= {}
+          return if @parse_warnings[message]
+
+          @parse_warnings[message] = true
+          warn "Failed to parse WebSocket message: #{message}"
+        end
       end
     end
   end

data/lib/capybara/lightpanda/client.rb

@@ -71,6 +71,11 @@ module Capybara
         @ws&.close
         @message_thread&.join(1) || @message_thread&.kill
         @subscriber.clear
+        # Wake any in-flight callers blocked on `pending.value!(timeout)` so
+        # they raise DeadBrowserError immediately (via the `@ws.closed?` check
+        # in #command) instead of stalling for the full @options.timeout — a
+        # 30s freeze per pending command on a dying browser.
+        fail_pending_commands
         @pendings.clear
       end
 
@@ -92,6 +97,14 @@ module Capybara
         @mutex.synchronize { @command_id += 1 }
       end
 
+      # Resolve every pending IVar with nil so blocked callers fall through
+      # `pending.value!(timeout)` immediately. `try_set` is a no-op if the
+      # IVar already carries a real response (race-safe against an in-flight
+      # handle_message that landed just before close).
+      def fail_pending_commands
+        @pendings.each_value { |ivar| ivar.try_set(nil) }
+      end
+
       def start_message_thread
         @message_thread = Thread.new do
           Thread.current.abort_on_exception = true

data/lib/capybara/lightpanda/cookies.rb

@@ -77,7 +77,8 @@ module Capybara
         find { |cookie| cookie.name == name }
       end
 
-      def set(name:, value:, domain: nil, path: "/", secure: false, http_only: false, expires: nil)
+      def set(name:, value:, domain: nil, path: "/", secure: false, http_only: false, # rubocop:disable Metrics/ParameterLists
+              same_site: nil, expires: nil)
         params = {
           name: name,
           value: value,
@@ -87,6 +88,10 @@ module Capybara
         }
 
         params[:domain] = domain if domain
+        # CDP rejects unknown SameSite values; pass through only the canonical
+        # spec strings ("Strict" / "Lax" / "None") so YAML noise from a hand-
+        # edited file doesn't reach the browser.
+        params[:sameSite] = same_site if %w[Strict Lax None].include?(same_site)
         params[:expires] = expires.to_i if expires
 
         browser.command("Network.setCookie", **params)
@@ -123,7 +128,7 @@ module Capybara
 
       # set() takes keyword args, but YAML round-trips give us a hash with the
       # raw CDP keys (camelCase). Normalize and forward.
-      def restore_cookie(hash)
+      def restore_cookie(hash) # rubocop:disable Metrics/PerceivedComplexity
         attrs = hash.transform_keys(&:to_s)
         params = {
           name: attrs["name"],
@@ -133,6 +138,7 @@ module Capybara
           http_only: attrs["httpOnly"] || false,
         }
         params[:domain] = attrs["domain"] if attrs["domain"]
+        params[:same_site] = attrs["sameSite"] if attrs["sameSite"]
         exp = attrs["expires"]
         params[:expires] = Time.at(exp) if exp.is_a?(Numeric) && exp.positive?
         set(**params)

data/lib/capybara/lightpanda/driver.rb

@@ -10,7 +10,7 @@ module Capybara
 
       attr_reader :app, :options
 
-      delegate %i[current_url title] => :browser
+      delegate %i[current_url title status_code response_headers] => :browser
 
       def initialize(app, options = {})
         super()
@@ -31,6 +31,22 @@ module Capybara
         false
       end
 
+      # Escape hatch to the underlying Browser for callers that need raw CDP
+      # access — e.g. Lightpanda's `LP.*` extensions (`getMarkdown`,
+      # `getSemanticTree`, `detectForms`, …) that aren't worth exposing through
+      # the Capybara DSL. Mirrors `capybara-playwright-driver`'s
+      # `with_playwright_page`. Yields the Browser; returns whatever the block
+      # returns.
+      #
+      #   driver.with_lightpanda_browser do |browser|
+      #     browser.page_command("LP.getMarkdown")
+      #   end
+      def with_lightpanda_browser(&block)
+        raise ArgumentError, "block must be given" unless block
+
+        block.call(browser)
+      end
+
       def visit(url)
         @started = true
         browser.go_to(url)
@@ -189,8 +205,11 @@ module Capybara
 
       def save_screenshot(path, **_options)
         browser.screenshot(path: path)
-      rescue BinaryError, BinaryNotFoundError
-        # Browser can't start (e.g., version too old) — don't crash teardown
+      rescue BinaryError, BinaryNotFoundError, BrowserError, TimeoutError
+        # Browser can't start (version too old), is already dead (DeadBrowserError),
+        # the CDP call timed out, or returned any other CDP-level error. Teardown
+        # screenshots are best-effort — swallow so the real test failure surfaces
+        # instead of a "browser already gone" stack trace.
         nil
       end
 
@@ -221,12 +240,15 @@ module Capybara
       end
 
       # Expanded error list for Capybara retry logic (Cuprite pattern).
+      # MouseEventFailed is in Cuprite's list, but Lightpanda has no
+      # rendering engine and the gem dispatches clicks through JS — the
+      # underlying CDP Input.dispatchMouseEvent path doesn't run, so
+      # MouseEventFailed is never raised.
       def invalid_element_errors
         [
           NodeNotFoundError,
           NoExecutionContextError,
           ObsoleteNode,
-          MouseEventFailed,
         ]
       end
 

data/lib/capybara/lightpanda/element_extension.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Escape hatch onto Capybara::Node::Element so users can reach our driver-level
+# Node (and its remote_object_id, `call`, etc.) without going through
+# `element.base`. Mirrors capybara-playwright-driver's
+# `with_playwright_element_handle` (lib/capybara/playwright/node.rb). The is_a?
+# guard keeps the patch safe when both this gem and another Capybara driver
+# are loaded in the same process.
+module Capybara
+  module Lightpanda
+    module ElementExtension
+      def with_lightpanda_node(&block)
+        raise ArgumentError, "block must be given" unless block
+        raise "#{base.inspect} is not a Capybara::Lightpanda::Node" unless base.is_a?(Capybara::Lightpanda::Node)
+
+        block.call(base)
+      end
+    end
+  end
+end
+Capybara::Node::Element.prepend(Capybara::Lightpanda::ElementExtension)

data/lib/capybara/lightpanda/headers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Lightpanda
+    # Hash subclass that downcases the lookup key. CDP returns response headers
+    # with lowercased names ("content-type"), but Capybara callers reach for
+    # the canonical casing ("Content-Type"). Mirrors capybara-playwright-driver's
+    # Headers class (lib/capybara/playwright/page.rb).
+    class Headers < Hash
+      def [](key)
+        super(key.to_s.downcase)
+      end
+    end
+  end
+end