capybara-lockstep 2.3.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4d067d73940b41b147af2e4acfba7ec42258be32c9a953178a6566b2ea02d47
-  data.tar.gz: b5acd048164fa863786b6b3f60695877d7052f87a14207f9d4e851c5334cca13
+  metadata.gz: cc60ce49170390b7a2160291bcee08a08a22bceacaf58e12b2f2bc5ebadf484e
+  data.tar.gz: dd6c60d318fe9f336462a3dcff507acf0120036d8ea160a97a5125ab94dc4248
 SHA512:
-  metadata.gz: a3181f8725182d43722551b220759f705742b0d2e88bea4b244fae812a3ab2390465adb62b07c8a3e59f9c3959a635ca286825d4c6dc5eae4db35101e0635221
-  data.tar.gz: 64dd439ed268526b97543ccab8f64396a3ea83a6cd4eb39ba9e55b04155c69d1029afe5761bba27c7fe04bc8f62e59ff157527ce02f1b492aae432f70e2e071a
+  metadata.gz: fcf26ef14e209a4fd8f6353c129fe9b88b97feb58dd787ebccddc3e19980802ebec1403a374cf580c1798ecf3bc30e365eba1218f40d3b0af3bbbc6f80ca9904
+  data.tar.gz: f8db9ee7dbc655724cab11b6f2e3a181ae182579ba78b5f193174b7a78951f407275e49dbceec0b10b4f41cb9abbdc28233a271b781ba686f4bc030e2b932c35

data/.ruby-version

@@ -1 +1 @@
-3.4.1
+4.0.1

data/CHANGELOG.md

@@ -12,6 +12,33 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 -
 
+
+# 2.3.2 - 2026-09-11
+
+## Compatible changes
+
+- Treat a Selenium `UnknownError` carrying the CDP message `Promise was collected` as a benign "navigated away" event,
+- like the existing `document unloaded` `JavascriptError`. Newer Chrome (141+) with selenium-webdriver 4.41 reports
+- a destroyed JS execution context (e.g. Turbo frame swaps, SPA navigations) this way, which previously surfaced as
+- a flaky, hard-to-diagnose test failure.
+- Skip client synchronization when the effective timeout is not positive. Capybara evaluates filter blocks
+- (e.g. `has_css?('.foo') { |node| node.has_field?('bar') }`) with `using_wait_time(0)`. A nested lookup inside such
+- a block triggered a synchronization with a timeout of 0 when the client was out of sync (e.g. after a timed-out
+- synchronization or on a page without the capybara-lockstep snippet). Capybara's Selenium driver persisted that 0
+- as the WebDriver script timeout, so every later script-based command (including Capybara's visibility checks)
+- failed with `Selenium::WebDriver::Error::ScriptTimeoutError`. This only affected the default configuration
+- (`Capybara::Lockstep.timeout = nil`).
+
+# 2.3.1 - 2026-02-17
+
+## Compatible changes
+
+- Add tests for Ruby 4.0
+- Increase `required_ruby_version` and `activesupport` minimum version in gemspec so people
+  on legacy Ruby and Rails versions don't receive future upgrades
+- Drop tests and support for Ruby < 3 and Rails < 7
+- Drop dependency on `ruby2_keywords`
+
 # 2.3.0
 
 - Added support for cuprite as the capybara driver

data/Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in capybara-lockstep.gemspec
 gemspec
 
-gem 'activesupport', '~> 6.0'
+gem 'activesupport', '~> 8.0'
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
@@ -14,7 +14,7 @@ gem 'sinatra'
 gem 'thin' # ruby 3 does not include a webserver
 gem 'puma'
 gem 'byebug'
-gem 'gemika', '>= 0.8.1'
+gem 'gemika'
 gem 'capybara', '>= 3'
 gem 'selenium-webdriver', '>= 4'
 gem 'cuprite'
@@ -25,3 +25,6 @@ gem 'cuprite'
 # indirect dependencies ourselves.
 gem 'base64' # needed by selenium-webdriver (and potentially others)
 gem 'bigdecimal' # needed by activesupport (and potentially others)
+gem 'ostruct'
+gem 'logger'
+gem 'cgi'

data/Gemfile.lock

@@ -1,20 +1,26 @@
 PATH
   remote: .
   specs:
-    capybara-lockstep (2.3.0)
-      activesupport (>= 4.2)
+    capybara-lockstep (2.3.2)
+      activesupport (>= 7.0)
       capybara (>= 3.0)
-      ruby2_keywords
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.7)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     base64 (0.2.0)
@@ -29,13 +35,16 @@ GEM
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
+    cgi (0.5.1)
     childprocess (4.1.0)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
     cuprite (0.17)
       capybara (~> 3.0)
       ferrum (~> 0.17.0)
     daemons (1.4.1)
     diff-lcs (1.5.1)
+    drb (2.2.3)
     eventmachine (1.2.7)
     ferrum (0.17.1)
       addressable (~> 2.5)
@@ -43,19 +52,24 @@ GEM
       concurrent-ruby (~> 1.1)
       webrick (~> 1.7)
       websocket-driver (~> 0.7)
-    gemika (0.8.1)
-    i18n (1.12.0)
+    gemika (2.0.0)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
+    json (2.18.1)
+    logger (1.7.0)
     matrix (0.4.2)
     mini_mime (1.1.5)
     mini_portile2 (2.8.5)
-    minitest (5.16.3)
+    minitest (6.0.1)
+      prism (~> 1.5)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.6.1)
     nokogiri (1.15.5)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
+    ostruct (0.6.3)
+    prism (1.9.0)
     public_suffix (5.0.4)
     puma (6.4.0)
       nio4r (~> 2.0)
@@ -85,6 +99,7 @@ GEM
       rspec (>= 3.0)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
+    securerandom (0.4.1)
     selenium-webdriver (4.1.0)
       childprocess (>= 0.5, < 5.0)
       rexml (~> 3.2, >= 3.2.5)
@@ -99,8 +114,9 @@ GEM
       eventmachine (~> 1.0, >= 1.0.4)
       rack (>= 1, < 3)
     tilt (2.3.0)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.1.1)
     webrick (1.9.1)
     websocket-driver (0.8.0)
       base64
@@ -108,20 +124,22 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 6.0)
+  activesupport (~> 8.0)
   base64
   bigdecimal
   byebug
   capybara (>= 3)
   capybara-lockstep!
+  cgi
   cuprite
-  gemika (>= 0.8.1)
+  gemika
+  logger
+  ostruct
   puma
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -342,6 +342,8 @@ Capybara::Lockstep.timeout = 5 # seconds
 
 By default Capybara will **not** raise an error after a timeout. You may occasionally get a slow server response, and Capybara will retry synchronization before the next interaction or `visit`. This is often good enough.
 
+When the effective timeout is `0` (e.g. inside a Capybara filter block, which Capybara evaluates with `using_wait_time(0)`), capybara-lockstep skips the synchronization, logs `Cannot synchronize client with a timeout of 0 seconds` and retries on the next interaction.
+
 If you want to be strict you may configure that an `Capybara::Lockstep::Timeout` error is raised after a timeout:
 
 ```ruby
@@ -468,6 +470,8 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 capybara-lockstep supports both the `selenium-webdriver` and `cuprite` as drivers for capybara.
 
+Make sure, your chromedriver version is up to date.
+
 To run all the tests for all supported drivers, run `rake spec:all`.
 
 To run all the tests for a specific driver, run `rake spec:selenium` or `rake spec:cuprite`.

data/capybara-lockstep.gemspec

@@ -5,33 +5,26 @@ Gem::Specification.new do |spec|
   spec.version       = Capybara::Lockstep::VERSION
   spec.authors       = ["Henning Koch"]
   spec.email         = ["henning.koch@makandra.de"]
-
-  spec.summary       = "Synchronize Capybara commands with client-side JavaScript and AJAX requests"
   spec.homepage      = "https://github.com/makandra/capybara-lockstep"
+  spec.summary       = "Synchronize Capybara commands with client-side JavaScript and AJAX requests"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "bug_tracker_uri" => "#{spec.homepage}/issues",
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => 'true',
+  }
 
-  spec.metadata["bug_tracker_uri"] = "https://github.com/makandra/capybara-lockstep/issues"
-  spec.metadata["changelog_uri"] = "https://github.com/makandra/capybara-lockstep/blob/main/CHANGELOG.md"
-  spec.metadata["rubygems_mfa_required"] = 'true'
+  spec.files = `git ls-files`.split("\n").select { |f| !File.symlink?(f) && !f.match(%r{^(spec|dev|media|.github)/}) }
+  spec.require_paths = ["lib"]
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
-  end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.executables   = []
 
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "capybara", ">= 3.0"
-  spec.add_dependency "activesupport", ">= 4.2"
-  spec.add_dependency "ruby2_keywords"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency "capybara", ">= 3.0"
+  spec.add_dependency "activesupport", ">= 7.0"
 end

data/lib/capybara-lockstep/capybara_ext.rb

@@ -1,5 +1,3 @@
-require 'ruby2_keywords'
-
 module Capybara
   module Lockstep
     module SynchronizeMacros
@@ -13,43 +11,37 @@ module Capybara
 
       def synchronize_before(meth, lazy:)
         @synchronize_before_module.module_eval do
-          define_method meth do |*args, &block|
+          define_method meth do |*args, **kwargs, &block|
             @synchronize_before_count ||= 0
             @synchronize_before_count += 1
             Lockstep.auto_synchronize(lazy: lazy, log: "Synchronizing before ##{meth}") if @synchronize_before_count == 1
-            super(*args, &block)
+            super(*args, **kwargs, &block)
           ensure
             @synchronize_before_count -= 1
           end
-
-          ruby2_keywords meth
         end
       end
 
       def synchronize_after(meth)
         @synchronize_after_module.module_eval do
-          define_method meth do |*args, &block|
+          define_method meth do |*args, **kwargs, &block|
             @synchronize_after_count ||= 0
             @synchronize_after_count += 1
-            super(*args, &block)
+            super(*args, **kwargs, &block)
           ensure
             Lockstep.auto_synchronize(log: "Synchronizing after ##{meth}") if @synchronize_after_count == 1
             @synchronize_after_count -= 1
           end
-
-          ruby2_keywords meth
         end
       end
 
       def unsynchronize_after(meth)
         @unsynchronize_after_module.module_eval do
-          define_method meth do |*args, &block|
-            super(*args, &block)
+          define_method meth do |*args, **kwargs, &block|
+            super(*args, **kwargs, &block)
           ensure
             Lockstep.unsynchronize
           end
-
-          ruby2_keywords meth
         end
       end
     end
@@ -82,7 +74,7 @@ end
 module Capybara
   module Lockstep
     module VisitWithWaiting
-      def visit(*args, &block)
+      def visit(*args, **kwargs, &block)
         # For some reason, in Capybara proper, visit(nil) navigates to the root route.
         # We mimic this behavior for (1) parity and (2) to not crash when we inspect the URL below.
         url = args[0].presence || '/'
@@ -104,15 +96,13 @@ module Capybara
           Lockstep.auto_synchronize(lazy: false, log: "Synchronizing before visiting #{url}")
         end
 
-        super(*args, &block).tap do
+        super(*args, **kwargs, &block).tap do
           if visiting_real_url
             # We haven't yet synchronized the new screen.
             Lockstep.unsynchronize
           end
         end
       end
-
-      ruby2_keywords :visit
     end
   end
 end
@@ -127,7 +117,7 @@ module Capybara
 
       def synchronize_around_script_method(meth)
         mod = Module.new do
-          define_method meth do |script, *args, &block|
+          define_method meth do |script, *args, **kwargs, &block|
             # Synchronization uses execute_script itself, so don't synchronize when
             # we're already synchronizing.
             if !Lockstep.synchronizing?
@@ -142,7 +132,7 @@ module Capybara
               Lockstep.auto_synchronize(lazy: !script_may_navigate_away, log: "Synchronizing before script: #{script}")
             end
 
-            super(script, *args, &block)
+            super(script, *args, **kwargs, &block)
           ensure
             if !Lockstep.synchronizing?
               # We haven't yet synchronized with whatever changes the JavaScript
@@ -150,8 +140,6 @@ module Capybara
               Lockstep.unsynchronize
             end
           end
-
-          ruby2_keywords meth
         end
         prepend(mod)
       end
@@ -246,16 +234,14 @@ end
 module Capybara
   module Lockstep
     module SynchronizeWithCatchUp
-      def synchronize(*args, &block)
+      def synchronize(*args, **kwargs, &block)
         # This method is called by Capybara before most interactions with
         # the browser. It is a different method than Capybara::Lockstep.synchronize!
         # We use the { lazy } option to only synchronize when we're out of sync.
         Lockstep.auto_synchronize(lazy: true, log: 'Synchronizing before node access')
 
-        super(*args, &block)
+        super(*args, **kwargs, &block)
       end
-
-      ruby2_keywords :synchronize
     end
   end
 end

data/lib/capybara-lockstep/client/selenium.rb

@@ -32,6 +32,22 @@ module Capybara
         else
           unhandled_synchronize_error(e)
         end
+      rescue ::Selenium::WebDriver::Error::UnknownError => e
+        # Newer Chrome (e.g. chrome-headless-shell 141) with selenium-webdriver 4.41
+        # reports the same "navigated away" condition differently than the older
+        # JavascriptError "document unloaded" message handled above. When an interaction
+        # destroys the JS execution context that owns our pending async probe (a Turbo
+        # frame swap or an SPA navigation), the promise can never resolve and the driver
+        # raises a Selenium::WebDriver::Error::UnknownError wrapping the CDP error:
+        # 'unknown error: unhandled inspector error: {"code":-32000,"message":"Promise was collected"}'.
+        # Treat this symmetrically to the 'unload' branch above: leave the client
+        # unsynchronized and retry on the next Capybara synchronize call, by then we
+        # should see the new page. Any other UnknownError is still unexpected and re-raised.
+        if e.message.include?('Promise was collected')
+          log ERROR_NAVIGATED_AWAY
+        else
+          unhandled_synchronize_error(e)
+        end
       rescue StandardError => e
         unhandled_synchronize_error(e)
       end

data/lib/capybara-lockstep/client.rb

@@ -37,6 +37,18 @@ module Capybara
         # If synchronization fails below we consider us unsynchronized after.
         self.synchronized = false
 
+        # Capybara evaluates filter blocks with `using_wait_time(0)`. Our default timeout is
+        # Capybara.default_max_wait_time, so a nested lookup inside such a block would try
+        # to synchronize with a timeout of 0. An async script can never finish within 0 seconds,
+        # and Capybara's Selenium driver would persist that 0 as the WebDriver script timeout,
+        # breaking every later script-based command with a ScriptTimeoutError.
+        if timeout <= 0
+          log "Cannot synchronize client with a timeout of #{timeout} seconds"
+          # Don't raise an error, this will happen in an innocent test.
+          # We will retry on the next Capybara synchronize call with a real timeout.
+          return
+        end
+
         # Running the synchronization script while an alert is open would close the alert,
         # most likely causing subsequent expectations to fail.
         if alert_present?

data/lib/capybara-lockstep/page_access.rb

@@ -25,8 +25,6 @@ module Capybara
         false
       end
 
-      private
-
       def selenium_driver?
         defined?(Capybara::Selenium::Driver) && driver.is_a?(Capybara::Selenium::Driver)
       end
@@ -35,7 +33,6 @@ module Capybara
         defined?(Capybara::Cuprite::Driver) && driver.is_a?(Capybara::Cuprite::Driver)
       end
 
-
     end
   end
 end

data/lib/capybara-lockstep/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Lockstep
-    VERSION = "2.3.0"
+    VERSION = "2.3.2"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capybara-lockstep
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.2
 platform: ruby
 authors:
 - Henning Koch
 bindir: exe
 cert_chain: []
-date: 2025-09-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -29,35 +29,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: ruby2_keywords
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 email:
 - henning.koch@makandra.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -86,12 +71,6 @@ files:
 - lib/capybara-lockstep/server.rb
 - lib/capybara-lockstep/util.rb
 - lib/capybara-lockstep/version.rb
-- media/logo.dark.shapes.svg
-- media/logo.dark.text.svg
-- media/logo.light.shapes.svg
-- media/logo.light.text.svg
-- media/makandra-with-bottom-margin.dark.svg
-- media/makandra-with-bottom-margin.light.svg
 - tasks/spec_tasks.rb
 homepage: https://github.com/makandra/capybara-lockstep
 licenses:
@@ -109,14 +88,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Synchronize Capybara commands with client-side JavaScript and AJAX requests
 test_files: []

data/.github/workflows/test.yml

@@ -1,61 +0,0 @@
----
-name: Tests
-on:
-  push:
-    branches:
-    - main
-  pull_request:
-    branches:
-    - main
-  workflow_dispatch:
-    branches:
-    - main
-jobs:
-  test:
-    runs-on: ubuntu-24.04
-    timeout-minutes: 3
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-        - ruby: 2.7.2
-          gemfile: Gemfile
-          capybara_driver: selenium
-        - ruby: 2.7.2
-          gemfile: Gemfile
-          capybara_driver: cuprite
-        - ruby: 3.2.0
-          gemfile: Gemfile
-          capybara_driver: selenium
-        - ruby: 3.4.1
-          gemfile: Gemfile
-          capybara_driver: selenium
-        - ruby: 3.4.1
-          gemfile: Gemfile
-          capybara_driver: cuprite
-    env:
-      BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
-      CAPYBARA_DRIVER: "${{ matrix.capybara_driver }}"
-    steps:
-    - uses: actions/checkout@v3
-    - name: Install Chrome
-      uses: browser-actions/setup-chrome@latest
-    - name: Show Chrome version
-      run: chrome --version
-    - name: Install ChromeDriver
-      uses: nanasess/setup-chromedriver@master
-      if: "${{ matrix.capybara_driver == 'selenium' }}"
-    - name: Install ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: "${{ matrix.ruby }}"
-    - name: Bundle
-      run: |
-        gem install bundler:2.3.1
-        bundle install --no-deployment
-    - name: Run tests
-      uses: nick-invision/retry@v2
-      with:
-        timeout_seconds: 30
-        max_attempts: 3
-        command: bundle exec rake spec