capybara-lockstep 0.3.2 → 0.7.0

data/lib/capybara-lockstep/helper.rb

@@ -17,7 +17,22 @@ module Capybara
           tag_options[:nonce] = options.fetch(:nonce, true)
         end
 
-        javascript_tag(capybara_lockstep_js, tag_options)
+        js = capybara_lockstep_js + capybara_lockstep_config_js(options)
+        javascript_tag(js, tag_options)
+      end
+
+      def capybara_lockstep_config_js(options = {})
+        js = ''
+
+        if (debug = options.fetch(:debug, Lockstep.debug?))
+          js += "\nCapybaraLockstep.debug = #{debug.to_json}"
+        end
+
+        if (wait_tasks = options.fetch(:wait_tasks, Lockstep.wait_tasks))
+          js += "\nCapybaraLockstep.waitTasks = #{wait_tasks.to_json}"
+        end
+
+        js
       end
 
     end

data/lib/capybara-lockstep/lockstep.rb

@@ -1,10 +1,16 @@
 module Capybara
   module Lockstep
+    ERROR_SNIPPET_MISSING = 'Cannot synchronize: capybara-lockstep JavaScript snippet is missing'
+    ERROR_PAGE_MISSING = 'Cannot synchronize before initial Capybara visit'
+    ERROR_ALERT_OPEN = 'Cannot synchronize while an alert is open'
+    ERROR_NAVIGATED_AWAY = "Browser navigated away while synchronizing"
+
     class << self
       include Configuration
       include Logging
 
-      attr_accessor :synchronized
+      attr_accessor :synchronizing
+      alias synchronizing? synchronizing
 
       def synchronized?
         value = page.instance_variable_get(:@lockstep_synchronized)
@@ -17,19 +23,24 @@ module Capybara
         page.instance_variable_set(:@lockstep_synchronized, value)
       end
 
-      ERROR_SNIPPET_MISSING = 'Cannot synchronize: Capybara::Lockstep JavaScript snippet is missing on page'
-      ERROR_PAGE_MISSING = 'Cannot synchronize before initial Capybara visit'
-      ERROR_ALERT_OPEN = 'Cannot synchronize while an alert is open'
-
       def synchronize(lazy: false)
-        if (lazy && synchronized?) || @synchronizing || disabled?
+        if (lazy && synchronized?) || synchronizing? || disabled?
           return
         end
 
-        @synchronizing = true
+        synchronize_now
+      end
+
+      private
+
+      def synchronize_now
+        self.synchronizing = true
+        self.synchronized = false
 
         log 'Synchronizing'
 
+        start_time = current_seconds
+
         begin
           with_max_wait_time(timeout) do
             message_from_js = evaluate_async_script(<<~JS)
@@ -54,31 +65,46 @@ module Capybara
             case message_from_js
             when ERROR_PAGE_MISSING
               log(message_from_js)
-              self.synchronized = false
             when ERROR_SNIPPET_MISSING
               log(message_from_js)
-              self.synchronized = false
             else
               log message_from_js
-              log "Synchronized successfully"
+              end_time = current_seconds
+              ms_elapsed = ((end_time.to_f - start_time) * 1000).round
+              log "Synchronized successfully [#{ms_elapsed} ms]"
               self.synchronized = true
             end
           end
+        rescue ::Selenium::WebDriver::Error::ScriptTimeoutError
+          log "Could not synchronize within #{timeout} seconds"
+          # Don't raise an error, this may happen if the server is slow to respond.
+          # We will retry on the next Capybara synchronize call.
         rescue ::Selenium::WebDriver::Error::UnexpectedAlertOpenError
           log ERROR_ALERT_OPEN
-          @synchronized = false
           # Don't raise an error, this will happen in an innocent test.
           # We will retry on the next Capybara synchronize call.
+        rescue ::Selenium::WebDriver::Error::JavascriptError => e
+          # When the URL changes while a script is running, my current selenium-webdriver
+          # raises a Selenium::WebDriver::Error::JavascriptError with the message:
+          # "javascript error: document unloaded while waiting for result".
+          # We will retry on the next Capybara synchronize call, by then we should see
+          # the new page.
+          if e.message.include?('unload')
+            log ERROR_NAVIGATED_AWAY
+          else
+            unhandled_synchronize_error(e)
+          end
         rescue StandardError => e
-          log "#{e.class.name} while synchronizing: #{e.message}"
-          @synchronized = false
-          raise e
+          unhandled_synchronize_error(e)
         ensure
-          @synchronizing = false
+          self.synchronizing = false
         end
       end
 
-      private
+      def unhandled_synchronize_error(e)
+        log "#{e.class.name} while synchronizing: #{e.message}"
+        raise e
+      end
 
       def page
         Capybara.current_session
@@ -102,6 +128,10 @@ module Capybara
         # no-op
       end
 
+      def current_seconds
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
     end
 
   end

data/lib/capybara-lockstep/logging.rb

@@ -3,8 +3,8 @@ module Capybara
     module Logging
       def log(message)
         if debug? && message.present?
-          message = "[Capybara::Lockstep] #{message}"
-          if @debug.respond_to?(:debug)
+          message = "[capybara-lockstep] #{message}"
+          if is_logger?(@debug)
             # If someone set Capybara::Lockstep to a logger, use that
             @debug.debug(message)
           else
@@ -13,6 +13,12 @@ module Capybara
           end
         end
       end
+
+      private
+
+      def is_logger?(object)
+        @debug.respond_to?(:debug)
+      end
     end
   end
 end

data/lib/capybara-lockstep/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Lockstep
-    VERSION = "0.3.2"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-lockstep
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.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'
 description: 
 email:
 - henning.koch@makandra.de
@@ -59,9 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -100,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Synchronize Capybara commands with client-side JavaScript and AJAX requests