capybara-lockstep 0.4.0 → 1.1.0

data/lib/capybara-lockstep/helper.rb

@@ -17,13 +17,22 @@ module Capybara
           tag_options[:nonce] = options.fetch(:nonce, true)
         end
 
-        full_js = capybara_lockstep_js
+        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?))
-          full_js += "\nCapybaraLockstep.debug = #{debug.to_json}"
+          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
 
-        javascript_tag(full_js, tag_options)
+        js
       end
 
     end

data/lib/capybara-lockstep/lockstep.rb

@@ -23,14 +23,26 @@ module Capybara
         page.instance_variable_set(:@lockstep_synchronized, value)
       end
 
-      def synchronize(lazy: false)
-        if (lazy && synchronized?) || synchronizing? || disabled?
+      def synchronize(lazy: false, log: nil)
+        if (lazy && synchronized?) || synchronizing? || mode == :off
           return
         end
 
+        # Allow passing a log message that is only logged
+        # when we're actually synchronizing.
+        if log
+          self.log(log)
+        end
+
         synchronize_now
       end
 
+      def auto_synchronize(**options)
+        if mode == :auto
+          synchronize(**options)
+        end
+      end
+
       private
 
       def synchronize_now
@@ -39,6 +51,8 @@ module Capybara
 
         log 'Synchronizing'
 
+        start_time = current_seconds
+
         begin
           with_max_wait_time(timeout) do
             message_from_js = evaluate_async_script(<<~JS)
@@ -54,6 +68,8 @@ module Capybara
               if (protocol === 'data:' || protocol == 'about:') {
                 done(#{ERROR_PAGE_MISSING.to_json})
               } else if (document.readyState === 'complete') {
+                // WebDriver always waits for the `load` event after a visit(),
+                // unless a different page load strategy was configured.
                 synchronize()
               } else {
                 window.addEventListener('load', synchronize)
@@ -67,14 +83,21 @@ module Capybara
               log(message_from_js)
             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.
+          timeout_message = "Could not synchronize within #{timeout} seconds"
+          log timeout_message
+          if timeout_with == :error
+            raise Timeout, timeout_message
+          else
+            # Don't raise an error, this may happen if the server is slow to respond.
+            # We will retry on the next Capybara synchronize call.
+          end
         rescue ::Selenium::WebDriver::Error::UnexpectedAlertOpenError
           log ERROR_ALERT_OPEN
           # Don't raise an error, this will happen in an innocent test.
@@ -124,6 +147,10 @@ module Capybara
         # no-op
       end
 
+      def current_seconds
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
     end
 
   end

data/lib/capybara-lockstep/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Lockstep
-    VERSION = "0.4.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-lockstep
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-07-08 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