capybara-lockstep 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58ff0d51fafccaca566a89722c750b18db169331d57070c5db7d5de32620d648
-  data.tar.gz: f6f859ded650d9b2dba0c43bbb7b19333e505ed57aa0d883b0a2981e5928f1a8
+  metadata.gz: aa8ccde381bb125f66222689d93c93008ec2137cfabc664a6ce83ff0701cd7a8
+  data.tar.gz: 7485b88104f0c4b43387f252e600ad7dc23a917eac28914249b8f279d5ab9df3
 SHA512:
-  metadata.gz: 4c1ba4546483509650a7423d04e0acffaf286db556ae431152076478e5d2ca7611a915e9f666c077d9c9c205cb4703d2cf29341e52a0b39493c4b11b78e6a883
-  data.tar.gz: 1e890d3d985af8ce4d623778781cfc06a1242d83d1c93b98bc550997e3044066544dc15100ccdb28e89090e1b865d7720200a84f8461984655b0f87fcf795281
+  metadata.gz: 19f52ab1ca0e9f30fe8be0e791b66bcefe9992d958a104a30c602987e310363587f075f7af19bebf8248e76836a008601c700092bc3b1d53fff3fda5b764dcdc
+  data.tar.gz: e6380494b6940092842f87e54c898e6a2da9311aa2fd1951a602fb193fb44c7ee6f96907704d80382bd1cc2ccc31a7e0b433e27da8906f889aa6f7178fcd2dff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capybara-lockstep (0.2.2)
+    capybara-lockstep (0.2.3)
       activesupport (>= 3.2)
       capybara (>= 2.0)
       selenium-webdriver (>= 3)
@@ -9,11 +9,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.3)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     capybara (3.35.3)
@@ -25,13 +26,15 @@ GEM
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
     childprocess (3.0.0)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.3)
-    i18n (1.8.2)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     mini_mime (1.0.2)
-    minitest (5.14.1)
-    nokogiri (1.11.1-x86_64-linux)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     public_suffix (4.0.6)
     racc (1.5.2)
@@ -53,15 +56,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
-    rubyzip (1.3.0)
+    rubyzip (2.3.0)
     selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)
       rubyzip (>= 1.2.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     xpath (3.2.0)
       nokogiri (~> 1.8)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -59,7 +59,7 @@ Installation
 Check if your application satisfies all requirements for capybara-lockstep:
 
 - Capybara 2 or higher.
-- Your Capybara driver must use [selenium-webdriver](https://rubygems.org/gems/selenium-webdriver/). capybara-headless deactivates itself for any other driver.
+- Your Capybara driver must use [selenium-webdriver](https://rubygems.org/gems/selenium-webdriver/). capybara-lockstep deactivates itself for any other driver.
 - This gem was only tested with a Selenium-controlled Chrome browser. [Chrome in headless mode](https://makandracards.com/makandra/492109-running-capybara-tests-in-headless-chrome) is recommended, but not required.
 - This gem was only tested with Rails, but there's no Rails dependency.
 

data/lib/capybara-lockstep/capybara_ext.rb

@@ -1,24 +1,38 @@
 module Capybara
   module Lockstep
     module VisitWithWaiting
-      def visit(*args, **kwargs, &block)
-        super(*args, **kwargs, &block).tap do
+      def visit(*args, &block)
+        visiting_remote_url = !args[0].start_with?('data:')
+
+        Capybara::Lockstep.catch_up
+
+        super(*args, &block).tap do
           # There is a step that changes drivers mid-scenario.
           # It works by creating a new Capybara session and re-visits the
           # URL from the previous session. If this happens before a URL is ever
           # loaded, it re-visits the URL "data:", which will never "finish"
           # initializing.
-          unless args[0].start_with?('data:')
+          if visiting_remote_url
             Capybara::Lockstep.await_initialized
           end
         end
       end
     end
+  end
+end
 
+
+Capybara::Session.class_eval do
+  prepend Capybara::Lockstep::VisitWithWaiting
+end
+
+module Capybara
+  module Lockstep
     module AwaitIdle
       def await_idle(meth)
         mod = Module.new do
           define_method meth do |*args, &block|
+            Capybara::Lockstep.catch_up
             super(*args, &block).tap do
               Capybara::Lockstep.await_idle
             end
@@ -30,10 +44,6 @@ module Capybara
   end
 end
 
-Capybara::Session.class_eval do
-  prepend Capybara::Lockstep::VisitWithWaiting
-end
-
 # Capybara 3 has driver-specific Node classes which sometimes
 # super to Capybara::Selenium::Node, but not always.
 node_classes = [
@@ -69,3 +79,19 @@ node_classes.each do |node_class|
     await_idle :trigger
   end
 end
+
+module Capybara
+  module Lockstep
+    module SynchronizeWithCatchUp
+      def synchronize(*args, &block)
+        Capybara::Lockstep.catch_up
+
+        super(*args, &block)
+      end
+    end
+  end
+end
+
+Capybara::Node::Base.class_eval do
+  prepend Capybara::Lockstep::SynchronizeWithCatchUp
+end

data/lib/capybara-lockstep/lockstep.rb

@@ -5,25 +5,28 @@ module Capybara
       include Configuration
 
       def await_idle
+        @delay_await_idle = false
         return unless enabled?
 
-        ignoring_alerts do
-          # evaluate_async_script also times out after Capybara.default_max_wait_time
-          with_max_wait_time(timeout) do
-            message_from_js = evaluate_async_script(<<~JS)
-              let done = arguments[0]
-              if (window.CapybaraLockstep) {
-                CapybaraLockstep.awaitIdle(done)
-              } else {
-                done('Cannot synchronize: Capybara::Lockstep was not included in page')
-              }
-            JS
-            log(message_from_js)
-          end
+        with_max_wait_time(timeout) do
+          message_from_js = evaluate_async_script(<<~JS)
+            let done = arguments[0]
+            if (window.CapybaraLockstep) {
+              CapybaraLockstep.awaitIdle(done)
+            } else {
+              done('Cannot synchronize: Capybara::Lockstep was not included in page')
+            }
+          JS
+          log(message_from_js)
         end
+      rescue ::Selenium::WebDriver::Error::UnexpectedAlertOpenError
+        log 'Cannot synchronize: Alert is open'
+        @delay_await_idle = true
       end
 
       def await_initialized
+        @delay_await_initialized = false
+        @delay_await_idle = false # since we're also waiting for idle
         return unless enabled?
 
         # We're retrying the initialize check every few ms.
@@ -41,6 +44,29 @@ module Capybara
             raise Busy, reason
           end
         end
+      rescue ::Selenium::WebDriver::Error::UnexpectedAlertOpenError
+        log 'Cannot synchronize: Alert is open'
+        @delay_await_initialized = true
+      end
+
+      def catch_up
+        return if @catching_up
+
+        begin
+          @catching_up = true
+          if @delay_await_initialized
+            log 'Retrying synchronization'
+            await_initialized
+          # elsif browser_made_full_page_load?
+          #   log 'Browser loaded new page'
+          #   await_initialized
+          elsif @delay_await_idle
+            log 'Retrying synchronization'
+            await_idle
+          end
+        ensure
+          @catching_up = false
+        end
       end
 
       def idle?
@@ -72,31 +98,34 @@ module Capybara
 
       private
 
+      def browser_made_full_page_load?
+        # Page change without visit()
+        page.has_css?('body[data-hydrating]')
+      end
+
       def initialize_reason
-        ignoring_alerts do
-          execute_script(<<~JS)
-            if (location.href.indexOf('data:') == 0) {
-              return 'Requesting initial page'
-            }
+        execute_script(<<~JS)
+          if (location.href.indexOf('data:') == 0) {
+            return 'Requesting initial page'
+          }
 
-            if (document.readyState !== "complete") {
-              return 'Document is loading'
-            }
+          if (document.readyState !== "complete") {
+            return 'Document is loading'
+          }
 
-            // The application layouts render a <body data-initializing>.
-            // The [data-initializing] attribute is removed by an Angular directive or Unpoly compiler (frontend).
-            // to signal that all elements have been activated.
-            if (document.querySelector('body[data-initializing]')) {
-              return 'DOM is being hydrated'
-            }
+          // The application layouts render a <body data-initializing>.
+          // The [data-initializing] attribute is removed by an Angular directive or Unpoly compiler (frontend).
+          // to signal that all elements have been activated.
+          if (document.querySelector('body[data-initializing]')) {
+            return 'DOM is being hydrated'
+          }
 
-            if (window.CapybaraLockstep && CapybaraLockstep.isBusy()) {
-              return 'JavaScript or AJAX requests are running'
-            }
+          if (window.CapybaraLockstep && CapybaraLockstep.isBusy()) {
+            return 'JavaScript or AJAX requests are running'
+          }
 
-            return false
-          JS
-        end
+          return false
+        JS
       end
 
       def page
@@ -105,12 +134,6 @@ module Capybara
 
       delegate :evaluate_script, :evaluate_async_script, :execute_script, :driver, to: :page
 
-      def ignoring_alerts(&block)
-        block.call
-      rescue ::Selenium::WebDriver::Error::UnexpectedAlertOpenError
-        # noop
-      end
-
       def with_max_wait_time(seconds, &block)
         old_max_wait_time = Capybara.default_max_wait_time
         Capybara.default_max_wait_time = seconds

data/lib/capybara-lockstep/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Lockstep
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-lockstep
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Henning Koch