capybara-lockstep 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 495d3ed978e831569eb691423ab97e79b4a354e415ce7247c7fba01916bce60a
-  data.tar.gz: bb51f4acfbd6cbe7b19f3e326d7e8d771004babe1ed415ca9f283c1301822ac9
+  metadata.gz: 514789431b5b017176575acd43c1a5b6558040f31cf7cb4ac119cf10e756dbee
+  data.tar.gz: 2945ac3b32b7f83a7bc2bd14848f67950c12e5063033d8dbe2063788dfe8c024
 SHA512:
-  metadata.gz: aeb726459feb3f529e02bc8cc5d8c8cd5afe2377d7906ff5e78485137770ad851cfa7e9a175a3f9ff59bbf2deb4a8fc0d14a06af584928e552a8d25bba3ddc43
-  data.tar.gz: 8f6955613d8a1073dcfeb26d003a22c0694462bdbab917ae66f31b11bbca2af36d5164394e4eafd18157b57d5684d7c9ae2afce4c0693230f91aca7c532d8528
+  metadata.gz: b2dac0508c3caaa13fd28fe285c9c3b7d2b796dfba6c2bf788578ffee90135b6504a2e9b731d8bf4496806723d26c28bf5ccb536e5de21c2b5661b354a9e2de1
+  data.tar.gz: 4e80b685b588dfded10cb0783cbe62aceb00517199ef5527ce76fb76a234c96eb913ec0e7d08df2e22a7dd5a2b2d475bed0d4318add6ddee9fd27403afc2e0fe

data/CHANGELOG.md

@@ -3,6 +3,21 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+# 2.1.0
+
+- We now synchronize for an additional [JavaScript task](https://jakearchibald.com/2015/tasks-microtasks-queues-and-schedules/) after `history.pushState()`, `history.replaceState()`, `history.forward()`, `history.back()` and `history.go()`.
+- We now synchronize for an additional JavaScript task after `popstate` and `hashchange` events.
+- We now synchronize for an additional JavaScript task when the window is resized.
+- You can now disable automatic synchronization for the duration of a block: `Capybara::Lockstep.with_mode(:manual) { ... }`.
+
+
+# 2.0.3
+
+- Fix a bug where we wouldn't wait for an additional [JavaScript task](https://jakearchibald.com/2015/tasks-microtasks-queues-and-schedules/) after a tracked event or async job.
+- Fix a bug where the `Capybara::Lockstep.wait_tasks` configuration would be ignored.
+- Fix a bug where the `capybara_lockstep_js` helper (for use without Rails) would not include the current configuration. 
+
+
 # 2.0.2
 
 - Fix a bug where setting a logger object with `Capybara::Lockstep.debug = logger` would crash (by @dorianmarie).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capybara-lockstep (2.0.2)
+    capybara-lockstep (2.1.0)
       activesupport (>= 4.2)
       capybara (>= 3.0)
       ruby2_keywords

data/README.md

@@ -349,7 +349,23 @@ ensure
 end
 ```
 
-In the `:manual` mode you may still force synchronization by calling `Capybara::Lockstep.synchronize` manually.
+You can also disable automatic synchronization for the duration of a block:
+
+```ruby
+Capybara::Lockstep.with_mode(:manual) do
+  do_unsynchronized_work
+end
+```
+
+In the `:manual` mode you may still force synchronization by calling `Capybara::Lockstep.synchronize` manually:
+
+```ruby
+Capybara::Lockstep.with_mode(:manual) do
+  do_some_work
+  Capybara::Lockstep.synchronize
+  do_other_work
+end
+```
 
 To completely disable synchronization, even when `Capybara::Lockstep.synchronize` is called:
 
@@ -360,6 +376,8 @@ Capybara::Lockstep.synchronize # will not synchronize
 
 
 
+
+
 ## Handling legacy promises
 
 Legacy promise implementations (like jQuery's `$.Deferred` and AngularJS' `$q`) work using [tasks instead of microtasks](https://jakearchibald.com/2015/tasks-microtasks-queues-and-schedules/). Their AJAX implementations (like `$.ajax()` and `$http`) use task-based promises to signal that a request is done.
@@ -377,7 +395,7 @@ It is theoretically possible that your test will observe the browser in that win
 Any issues caused by this will usually be mitigated by Capybara's retry logic. **If** you think that this is an issue for your test suite, you can configure capybara-headless to wait additional tasks before it considers the browser to be idle:
 
 ```ruby
-Capybara::Lockstep.wait_tasks = 2 // default is 1
+Capybara::Lockstep.wait_tasks = 2 # default is 1
 ```
 
 If you see longer chains of `then()` or nested `setTimeout()` calls in your code, you may need to configure a higher number of tasks to wait.

data/lib/capybara-lockstep/configuration.rb

@@ -58,7 +58,7 @@ module Capybara
         self.mode = temporary_mode
         block.call
       ensure
-        self.mode = temporary_mode
+        self.mode = old_mode
       end
 
       def enabled=(enabled)

data/lib/capybara-lockstep/helper.js

@@ -4,14 +4,14 @@ window.CapybaraLockstep = (function() {
   let jobCount
   let idleCallbacks
   let finishedWorkTags
-  let waitTasks
+  let defaultWaitTasks
   reset()
 
   function reset() {
     jobCount = 0
     idleCallbacks = []
     finishedWorkTags = []
-    waitTasks = 1
+    defaultWaitTasks = 1
     debug = false
   }
 
@@ -57,8 +57,9 @@ window.CapybaraLockstep = (function() {
     promise.then(taggedStopWork, taggedStopWork)
   }
 
-  function stopWork(tag) {
-    afterWaitTasks(stopWorkNow.bind(this, tag))
+  function stopWork(tag, waitAdditionalTasks = 0) {
+    let effectiveWaitTasks = defaultWaitTasks + waitAdditionalTasks
+    afterWaitTasks(stopWorkNow.bind(this, tag), effectiveWaitTasks)
   }
 
   function stopWorkNow(tag) {
@@ -92,6 +93,27 @@ window.CapybaraLockstep = (function() {
     }
   }
 
+  function trackHistory() {
+    // Wait an additional task because some browsers seem to require additional
+    // time before the URL changes.
+    trackEvent(document, 'popstate', 1)
+    trackEvent(document, 'hashchange', 1)
+
+    // API: https://developer.mozilla.org/en-US/docs/Web/API/History
+    for (let method of ['pushState', 'popState', 'forward', 'back', 'go']) {
+      let workTag = `history.${method}()`
+      let nativeImpl = history[method]
+      history[method] = function(...args) {
+        try {
+          startWork(workTag)
+          return nativeImpl.apply(history, args)
+        } finally {
+          stopWork(workTag, 1)
+        }
+      }
+    }
+  }
+
   function trackXHR() {
     let oldOpen = XMLHttpRequest.prototype.open
     let oldSend = XMLHttpRequest.prototype.send
@@ -135,7 +157,7 @@ window.CapybaraLockstep = (function() {
     // CapybaraLockstep.track() is called as the first script in the head.
     // jQuery will be loaded after us, so we wait until DOMContentReady.
     whenReady(function() {
-      if (!window.jQuery || waitTasks > 0) {
+      if (!window.jQuery || defaultWaitTasks > 0) {
         return
       }
 
@@ -255,9 +277,12 @@ window.CapybaraLockstep = (function() {
     }
   }
 
-  function afterWaitTasks(fn, tasksLeft = waitTasks) {
-    if (tasksLeft > 0) {
-      afterWaitTasks(fn, tasksLeft - 1)
+  function afterWaitTasks(fn, waitTasks = defaultWaitTasks) {
+    if (waitTasks > 0) {
+      // Wait 1 task and recurse
+      setTimeout(function() {
+        afterWaitTasks(fn, waitTasks - 1)
+      })
     } else {
       fn()
     }
@@ -279,14 +304,16 @@ window.CapybaraLockstep = (function() {
     })
   }
 
-  function trackInteraction(eventType) {
-    document.addEventListener(eventType, function() {
+  function trackEvent(eventTarget, eventType, waitAdditionalTasks = 0) {
+    eventTarget.addEventListener(eventType, function() {
       // Only litter the log with interaction events if we're actually going
       // to be busy for at least 1 task.
-      if (waitTasks > 0) {
+      let effectiveWaitTasks = defaultWaitTasks + waitAdditionalTasks
+
+      if (effectiveWaitTasks > 0) {
         let tag = eventType
         startWork(tag)
-        stopWork(tag)
+        stopWork(tag, waitAdditionalTasks)
       }
     })
   }
@@ -294,17 +321,19 @@ window.CapybaraLockstep = (function() {
   function track() {
     trackOldUnpoly()
     trackFetch()
+    trackHistory()
     trackXHR()
     trackRemoteElements()
     trackJQuery()
-    trackInteraction('touchstart')
-    trackInteraction('mousedown')
-    trackInteraction('click')
-    trackInteraction('keydown')
-    trackInteraction('focusin')
-    trackInteraction('focusout')
-    trackInteraction('input')
-    trackInteraction('change')
+    trackEvent(document, 'touchstart')
+    trackEvent(document, 'mousedown')
+    trackEvent(document, 'click')
+    trackEvent(document, 'keydown')
+    trackEvent(document, 'focusin')
+    trackEvent(document, 'focusout')
+    trackEvent(document, 'input')
+    trackEvent(document, 'change')
+    trackEvent(window, 'resize', 1)
   }
 
   function synchronize(callback) {
@@ -324,7 +353,7 @@ window.CapybaraLockstep = (function() {
     synchronize: synchronize,
     reset: reset,
     set debug(value) { debug = value },
-    set waitTasks(value) { waitTasks = value }
+    set waitTasks(value) { defaultWaitTasks = value }
   }
 })()
 

data/lib/capybara-lockstep/helper.rb

@@ -3,10 +3,10 @@ module Capybara
     module Helper
 
       JS_PATH = File.expand_path('../helper.js', __FILE__)
-      JS = IO.read(JS_PATH)
+      HELPER_JS = IO.read(JS_PATH)
 
-      def capybara_lockstep_js
-        JS
+      def capybara_lockstep_js(options = {})
+        HELPER_JS + capybara_lockstep_config_js(options)
       end
 
       def capybara_lockstep(options = {})
@@ -17,10 +17,11 @@ module Capybara
           tag_options[:nonce] = options.fetch(:nonce, true)
         end
 
-        js = capybara_lockstep_js + capybara_lockstep_config_js(options)
-        javascript_tag(js, tag_options)
+        javascript_tag(capybara_lockstep_js(options), tag_options)
       end
 
+      private
+
       def capybara_lockstep_config_js(options = {})
         js = ''
 

data/lib/capybara-lockstep/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Lockstep
-    VERSION = "2.0.2"
+    VERSION = "2.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-lockstep
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara