capybara-lockstep 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f6aba93856539de9e2df301e720cced0c444de2d62436e72ea620765f9b3e1
-  data.tar.gz: 1ae5dc301b4761d7c51796313ea4a6210596b5975e02f639410916ddc53060b5
+  metadata.gz: ec0d3874212ec29a338fa16ef831e76c0b8dc65b4a200f3a305b7ce41bd76957
+  data.tar.gz: b5d48346fb7224b2154512534757ef96638f1df9cc62f9d0f911aac8d6a5f846
 SHA512:
-  metadata.gz: b1dc1f1e4a8af3d4d02f4d7b2aec3ae99844ba42bd3713028a138842bdc296c6bc0ed39688b8c15d7976830cc97df9ebc96cee3f3cfc9ab5f799e99ec59fee23
-  data.tar.gz: 50e27f5304cc7fbc1ed0c74ee87311ef8c8a333ecd4395af7cf155305ce0607f4b0f20defdf901d8f5cb3cbe8fc1ddb23638d9587c27f15e2071aea59c24297c
+  metadata.gz: 4d44c17fa50ca0fd386b34ecea302148989f4d48d63c48820bcfff75bcd51c63cfbacea0053e63fc1c27f6347fbe252f14be83372aed123a6a1c2574328fe42e
+  data.tar.gz: 9e7f5cfcbb6b3750277bc55c37484e17859aa4d96f1b8f7b6c1865f4467ae00fad5311e11ea0bfc73d5b8ec5c925df5c8ec6bb2473da6b431296736c89972794

data/.github/workflows/test.yml

@@ -28,6 +28,12 @@ jobs:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
     steps:
     - uses: actions/checkout@v2
+    - name: Install Chrome
+      uses: browser-actions/setup-chrome@latest
+    - name: Show Chrome version
+      run: chrome --version
+    - name: Install ChromeDriver
+      uses: nanasess/setup-chromedriver@master
     - name: Install ruby
       uses: ruby/setup-ruby@v1
       with:

data/CHANGELOG.md

@@ -2,32 +2,105 @@ 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).
 
+## 1.2.0 - 2022-09-12
 
-## Unreleased
+### Synchronization around history navigation
 
-### Breaking changes
+We now synchronize before and after history navigation using the following Capybara methods:
 
-- 
+- `page.refresh`
+- `page.go_back`
+- `page.go_forward`
 
-### Compatible changes
+We also synchronize before `current_url` in case running a JavaScript task wants to update the URL when done.
 
--
+### Support for tests with multiple tabs or frames
 
-## 0.7.0 - 2021-05-04
+capybara-lockstep now supports test that work with [multiple frames](https://makandracards.com/makandra/34015-use-capybara-commands-inside-an-iframe) or [multiple tabs or windows](https://github.com/teamcapybara/capybara#working-with-windows).
+We now synchronize before and after the following Capybara methods:
 
-### Compatible changes
+- `switch_to_frame`
+- `within_frame`
+- `switch_to_window`
+- `within_window`
 
-- add changelog
-- add gemika for tests with github actions
-- add Ruby 3 support
+### Improved logging
 
-## 0.6.0 - 2021-03-10
-## 0.5.0 - 2021-03-09
-## 0.4.0 - 2021-03-05
-## 0.3.3 - 2021-03-05
-## 0.3.2 - 2021-03-04 
-## 0.3.1 - 2021-03-04
-## 0.3.0 - 2021-03-04
-## 0.2.3 - 2021-03-03
-## 0.2.2 - 2021-03-03
-## 0.2.1 - 2021-03-03 
+- Only log when we're actually synchronizing
+- Log the reason why we're synchronizing (e.g. before node access)
+- Log which browser work we're waiting for (e.g. XHR request, image load)
+
+### Various changes
+
+- Synchronize before accessing `page.html`.
+
+
+## 1.1.1 - 2022-03-16
+
+- Activate rubygems MFA
+
+## 1.1.0
+
+- Stop handling of `[data-initializing]` attribute. Apps that have late initialization after the `load` event can just use `CapybaraLockstep.startWork()`.
+- Remove useless tracking of interaction events like `"click"` or `"focus"`. If such an event handler would start an AJAX request, it is already tracked.
+- On apps with Unpoly 0.x, wait for one more task after `DOMContentLoaded`. Please upgrade to Unpoly 1.x or 2.x, as this logic will be removed in a year or so.
+
+## 1.0.0
+
+- First stable release.
+- Replace option `Capybara::Lockstep.config` (`true`, `false`) with a more refined option `.mode` (`:auto`, `:manual`, `:off`)
+
+## 0.7.0
+
+- Ruby 3 compatibility.
+- Fix logging.
+
+## 0.6.0
+
+- Synchronize around `evaluate_script` and `execute_script`.
+- Improve logging.
+
+## 0.5.0
+
+- Allow developer to signal custom async work.
+- Option to wait additional tasks, to handle legacy promise implementations.
+- Debugging log can be enabled during a running test.
+- Also wait for images and iframes.
+
+## 0.4.0
+
+- Don't fail the test when synchronization times out.
+- Capybara::Lockstep.debug = true will now also enable client-side logging on the browser's JavaScript console.
+- Always wait at least for `Capybara.default_max_wait_time`.
+
+## 0.3.2
+
+- Delay synchronization when an alert is open (instead of failing)
+
+
+## 0.3.1
+
+- Fix typo in log message
+
+## 0.3.0
+
+- Rework entire waiting logic to be lazy.
+- There is now a single method `Capybara::Lockstep.synchronize` (no distinction between awaiting "initialization" and "idle").
+
+## 0.2.3
+
+- When we cannot wait for browser idle due to an open alert, wait before the next Capybara synchronize
+
+## 0.2.2
+
+- Fix incorrect data in gemspec.
+
+
+## 0.2.1
+
+- Internal changes.
+
+
+## 0.2.0
+
+- Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capybara-lockstep (1.0.0)
+    capybara-lockstep (1.2.0)
       activesupport (>= 3.2)
       capybara (>= 2.0)
       ruby2_keywords
@@ -10,32 +10,32 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     byebug (11.1.3)
-    capybara (3.35.3)
+    capybara (3.36.0)
       addressable
+      matrix
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)
       rack (>= 1.6.0)
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
-    childprocess (3.0.0)
+    childprocess (4.1.0)
     chrome_remote (0.3.0)
       websocket-driver (~> 0.6)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.10)
     daemons (1.3.1)
     diff-lcs (1.3)
     eventmachine (1.2.7)
     gemika (0.6.0)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     jasmine (3.6.0)
       jasmine-core (~> 3.6.0)
@@ -43,18 +43,20 @@ GEM
       rack (>= 1.2.1)
       rake
     jasmine-core (3.6.0)
-    mini_mime (1.1.0)
-    minitest (5.14.4)
-    nokogiri (1.11.3-x86_64-linux)
+    matrix (0.4.2)
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    nokogiri (1.13.0-x86_64-linux)
       racc (~> 1.4)
     phantomjs (2.1.1.0)
     public_suffix (4.0.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rake (13.0.1)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -68,10 +70,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
-    ruby2_keywords (0.0.4)
-    rubyzip (2.3.0)
-    selenium-webdriver (3.142.7)
-      childprocess (>= 0.5, < 4.0)
+    ruby2_keywords (0.0.5)
+    rubyzip (2.3.2)
+    selenium-webdriver (4.1.0)
+      childprocess (>= 0.5, < 5.0)
+      rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2)
     thin (1.8.0)
       daemons (~> 1.0, >= 1.0.9)
@@ -84,7 +87,6 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -100,4 +102,4 @@ DEPENDENCIES
   thin
 
 BUNDLED WITH
-   2.2.15
+   2.2.32

data/README.md

@@ -1,12 +1,15 @@
 # capybara-lockstep
 
-This Ruby gem synchronizes [Capybara](https://github.com/teamcapybara/capybara) commands with client-side JavaScript and AJAX requests. This greatly improves the stability of a full-stack integration test suite, even if that suite has timing issues.
+This Ruby gem synchronizes [Capybara](https://github.com/teamcapybara/capybara) commands with client-side JavaScript and AJAX requests. This greatly improves the stability of an end-to-end ("E2E") test suite, even if that suite has timing issues.
+
+The next section explain why your test suite is flaky and how capybara-lockstep can help.\
+If you don't care you may skip to [installation instructions](#installation).
 
 
 Why are tests flaky?
 --------------------
 
-A naively written integration test will have [race conditions](https://makandracards.com/makandra/47336-fixing-flaky-integration-tests) between the test script and the controlled browser. How often these timing issues will fail your test depends on luck and your machine's performance. You may not see these issues for years until a colleague runs your suite on their new laptop.
+A naively written E2E test will have [race conditions](https://makandracards.com/makandra/47336-fixing-flaky-integration-tests) between the test script and the controlled browser. How often these timing issues will fail your test depends on luck and your machine's performance. You may not see these issues for years until a colleague runs your suite on their new laptop.
 
 Here is a typical example for a test that will fail with unlucky timing:
 
@@ -23,28 +26,56 @@ end
 
 This test has four timing issues that may cause it to fail:
 
-1. We click on the "New tweet" button, but the the JS event handler to open the tweet form wasn't registered yet.
+1. We click on the *New tweet* button, but the the JS event handler to open the tweet form wasn't registered yet.
 2. We start filling in the form, but it wasn't loaded yet.
 3. After sending the tweet we immediately navigate away, killing the form submission request that is still in flight. Hence the tweet will never appear in the next step.
 4. We look for the new tweet, but the timeline wasn't loaded yet.
 
-Capybara will retry individual commands or expectations when they fail. However, only issues **2** and **4** can be healed by retrying.
+[Capybara will retry](https://github.com/teamcapybara/capybara#asynchronous-javascript-ajax-and-friends) individual commands or expectations when they fail.\
+However, only issues **2** and **4** can be healed by retrying.
+
+While it is [possible](https://makandracards.com/makandra/47336-fixing-flaky-integration-tests) to remove most of the timing issues above, it requires skill and discipline.\
+capybara-lockstep fixes issues **1**, **2**, **3** and **4** without any changes to the test code.
+
+
+### This is a JavaScript problem
+
+The timing issues above will only manifest in an app where links, forms and buttons are handled by JavaScript.
+
+When all you have is standard HTML links and forms, stock Capybara will not see timing issues:
+
+- After a `visit()` Capybara/WebDriver will wait until the page is completely loaded
+- When following a link Capybara/WebDriver will wait until the link destination is completely loaded
+- When submitting a form Capybara/WebDriver will wait until the response is completely loaded
+
+However, when JavaScript handles a link click, you get **zero guarantees**.\
+Capybara/WebDriver **will not wait** for AJAX requests or any other async work.
 
-While it is [possible](https://makandracards.com/makandra/47336-fixing-flaky-integration-tests) to remove most of the timing issues above, it requires skill and discipline. capybara-lockstep fixes issues **1**, **2**, **3** and **4** without any changes to the test code.
 
 
 How capybara-lockstep helps
 ---------------------------
 
-capybara-lockstep waits until the browser is idle before moving on to the next Capybara command. This greatly relieves the pressure on Capybara's retry logic.
+capybara-lockstep waits until the browser is idle before moving on to the next Capybara command. This greatly relieves the pressure on [Capybara's retry logic](https://github.com/teamcapybara/capybara#asynchronous-javascript-ajax-and-friends).
+
+capybara-lockstep synchronizes before:
+
+- Capybara simulates a user interaction (clicking, typing, etc.)
+- Capybara visits a new URL
+- Capybara executes JavaScript
 
-Whenever Capybara visits a new URL or simulates a user interaction (clicking, typing, etc.):
+When capybara-lockstep synchronizes it will:
 
-- capybara-lockstep waits for all document resources to load.
-- capybara-lockstep waits for client-side JavaScript to render or hydrate DOM elements.
-- capybara-lockstep waits for any AJAX requests.
+- wait for all document resources to load (images, CSS, fonts, frames).
+- wait for client-side JavaScript to render or hydrate DOM elements.
+- wait for any pending AJAX requests to finish and their callbacks to be called.
 - capybara-lockstep waits for dynamically inserted `<script>`s to load (e.g. from [dynamic imports](https://webpack.js.org/guides/code-splitting/#dynamic-imports) or Analytics snippets).
-- capybara-lockstep waits for dynamically `<img>` or `<iframe>` elements to load.
+- capybara-lockstep waits for dynamically inserted `<img>` or `<iframe>` elements to load.
+
+In summary Capybara can no longer observe the page while HTTP requests are in flight.
+This covers most async work that causes flaky tests.
+
+You can also configure capybara-lockstep to [wait for other async work](#signaling-asynchronous-work) that does not involve the network, like animations.
 
 
 Installation
@@ -76,127 +107,90 @@ And then execute:
 $ bundle install
 ```
 
-If you're not using Rails you should also `require 'capybara-lockstep'` in your `spec_helper.rb` (RSpec) or `env.rb` (Cucumber).
+If you're not using Rails you should also `require 'capybara-lockstep'` in your `spec_helper.rb` (RSpec), `test_helper.rb` (Minitest) or `env.rb` (Cucumber).
 
 
 ### Including the JavaScript snippet
 
 capybara-lockstep requires a JavaScript snippet to be embedded by the application under test. If that snippet is missing on a screen, capybara-lockstep will not be able to synchronize with the browser. In that case the test will continue without synchronization.
 
-If you're using Rails you can use the `capybara_lockstep` helper to insert the snippet into your application layouts:
+**If you're using Rails** you can use the `capybara_lockstep` helper to insert the snippet into your application layouts:
 
 ```erb
-<%= capybara_lockstep if Rails.env.test? %>
+<%= capybara_lockstep if defined?(Capybara::Lockstep) %>
 ```
 
-Ideally the snippet should be included in the `<head>` before any other `<script>` tags. If that's impractical you will also see some benefit if you insert it later.
+Ideally the snippet should be included in the `<head>` before any other `<script>` tags.
 
-If you have a strict [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP), the `capybara_lockstep` helper will insert a CSP nonce by default. You can also pass a `:nonce` option.
+**If you're not using Rails** you can `include Capybara::Lockstep::Helper` and access the JavaScript with `capybara_lockstep_script`.
 
-If you're not using Rails you can `include Capybara::Lockstep::Helper` and access the JavaScript with `capybara_lockstep_script`.
+**If you have a strict [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP)** the `capybara_lockstep` Rails helper will insert a CSP nonce by default. You can also pass an explicit nonce string using the `:nonce` option.
 
 
-### Signaling the end of page initialization
 
-Most web applications run some JavaScript after a document has initially loaded. Such JavaScript usually enhances existing DOM elements ("hydration") or renders additional element into the DOM.
+### Verify successful integration
 
-capybara-lockstep will synchronize more reliably if you signal when your JavaScript is done rendering the initial document. After the initial rendering, capybara-lockstep will automatically detect when the browser is busy, even if content is changed dynamically later.
+capybara-lockstep will automatically patch Capybara to wait for the browser after every command.
 
-To signal that JavaScript is still initializing, your application layouts should render the `<body>` element with an `[data-initializing]` attribute:
+Run your test suite to see if integration was successful and whether stability improves. During validation we recommend to activate the [debugging log](#debugging-log) before your test:
 
-```html
-<body data-initializing>
+```ruby
+Capybara::Lockstep.debug = true
 ```
 
-Your application JavaScript should remove the `[data-initializing]` attribute when it is done rendering the initial page.
+You should see messages like this in your console:
 
-More precisely, the attribute should be removed in the same [JavaScript task](https://jakearchibald.com/2015/tasks-microtasks-queues-and-schedules/) ("tick") that will finish initializing. capybara-lockstep will assume that the page will be initialized by the end of this task.
+```text
+[capybara-lockstep] Synchronizing
+[capybara-lockstep] Finished waiting for JavaScript
+[capybara-lockstep] Synchronized successfully
+```
 
-**After the initial rendering, capybara-lockstep will automatically detect when the browser is busy, even if content is changed dynamically later. After the initial page load you no longer need to add or remove the `[data-initializing]` attribute.**
+Note that you may see some failures from tests with wrong assertions, which previously passed due to lucky timing.
 
-#### Example: Vanilla JS
 
-If all your initializing JavaScript runs synchronously on `DOMContentLoaded`, you can remove `[data-initializing]` in an event handler:
 
-```js
-document.addEventListener('DOMContentLoaded', function() {
-  // Initialize the page here
-  document.body.removeAttribute('data-initializing')
-})
-```
+## Signaling asynchronous work
 
-If you call libraries during initialization, you may need to check the library code to see whether it finishes synchronously or asynchronously. Ideally a library offers a callback to notify you when it is done rendering:
+By default capybara-lockstep waits until resources have loaded, AJAX requests have finished and their callbacks have been called.
 
-```js
-document.addEventListener('DOMContentLoaded', function() {
-  Libary.initialize({
-    onFinished: function() {
-      document.body.removeAttribute('data-initializing')
-    }
-  })
-})
-```
-
-When a library offers no such callback, but you see in its code that the library delays work for a task, you must also wait another task to remove `[data-initializing]`:
+You can configure capybara-lockstep to wait for other async work that does not involve the network. Let's say we have an animation that fades in a new element over 2 seconds. The following will prevent Capybara from observing the page while the animation is running:
 
 ```js
-document.addEventListener('DOMContentLoaded', function() {
-  Libary.initialize()
-  setTimeout(function() { document.body.removeAttribute('data-initializing') })
-})
+async function fadeIn(element) {
+  CapybaraLockstep.startWork('Animation')
+  startAnimation(element, 'fade-in')
+  await waitForAnimationEnd(element)
+  CapybaraLockstep.stopWork('Animation')
+}
 ```
 
-If your initialization code lazy-loads another script, you should only remove `[data-initializing]` once that is done:
+The string argument is used for logging (when logging is enabled). It does **not** need to be unique per job. In this case you should see messages like this in your browser's JavaScript console:
 
-```js
-document.addEventListener('DOMContentLoaded', function() {
-  import('huge-library').then(function({ HugeLibrary }) {
-    HugeLibrary.initialize()
-    document.body.removeAttribute('data-initializing')
-  })
-})
+```text
+[capybara-lockstep] Started work: Animation [1 jobs]
+[capybara-lockstep] Finished work: Animation [0 jobs]
 ```
 
+You may omit the string argument, in which case nothing will be logged, but the work will still be tracked.
 
-#### Example: Unpoly
-
-When you're using [Unpoly](https://unpoly.com/) initializing will usually happen synchronously in [compilers](https://unpoly.com/up.compiler). Hence a compiler is a good place to remove `[data-initializing]`:
 
-```js
-up.compiler('body', function(body) {
-  body.removeAttribute('data-initializing')
-})
-```
-
-#### Example: AngularJS 1
+## Note on interacting with the JavaScript API
 
-When you're using [AngularJS 1](https://unpoly.com/) initializing will usually happen synchronously in [directives](https://docs.angularjs.org/guide/directive). Hence a directive is a good place to remove `[data-initializing]`:
+If you only load capybara-lockstep in tests you, should check for the `CapybaraLockstep` global to be defined before you interact with the JavaScript API.
 
 ```js
-app.directive('body', function() {
-  return {
-    restrict: 'E',
-    link: function() {
-      document.body.removeAttribute('data-initializing')
-    }
-  }
-})
+if (window.CapybaraLockstep) {
+  // interact with CapybaraLockstep
+}
 ```
 
-### Verify successful integration
-
-capybara-lockstep will automatically patch Capybara to wait for the browser after every command.
-
-Run your test suite to see if integration was successful and whether stability improves. During validation we recommend to activate `Capybara::Lockstep.debug = true` in your `spec_helper.rb` (RSpec) or `env.rb` (Cucumber). You should see messages like this in your console:
+If you can use ES6 you may also use [optional chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining) to only call a function if `window.CapybaraLockstep` is defined:
 
-```text
-[capybara-lockstep] Synchronizing
-[capybara-lockstep] Finished waiting for JavaScript
-[capybara-lockstep] Synchronized successfully
+```js
+window.CapybaraLockstep?.startWork('Work')
 ```
 
-Note that you may see some failures from tests with wrong assertions, which sometimes passed due to lucky timing.
-
 
 ## Performance impact
 
@@ -204,7 +198,7 @@ capybara-lockstep may or may not impact the runtime of your test suite. It depen
 
 While waiting for the browser to be idle does take a few milliseconds, Capybara no longer needs to retry failed commands. You will also save time from not needing to re-run failed tests.
 
-In casual testing I experienced a performance impact between +/- 10%.
+In casual testing with large test suites I experienced a performance impact between +/- 10%.
 
 
 ## Debugging log
@@ -243,9 +237,9 @@ Capybara::Lockstep.debug = Rails.logger
 
 ### Logging in the browser only
 
-To enable logging in the browser console (but not STDOUT), include the snippet with `{ debug: true }`:
+To enable logging in the browser console (but not STDOUT), include the [JavaScript snippet](#including-the-javascript-snippet) with `{ debug: true }`:
 
-```
+```ruby
 capybara_lockstep(debug: true)
 ```
 
@@ -253,7 +247,11 @@ capybara_lockstep(debug: true)
 
 By default capybara-lockstep will wait `Capybara.default_max_wait_time` seconds for the page initialize and for JavaScript and AJAX request to finish.
 
-When synchronization times out, capybara-lockstep will log but not raise an error.
+When synchronization times out, capybara-lockstep will [log](#debugging-log):
+
+```text
+[capybara-lockstep] Could not synchronize within 3 seconds
+```
 
 You can configure a different timeout:
 
@@ -261,10 +259,19 @@ You can configure a different timeout:
 Capybara::Lockstep.timeout = 5 # seconds
 ```
 
-To revert to defaulting to `Capybara.default_max_wait_time`, set the timeout to `nil`:
+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.
+
+If you want to be strict you may configure that an `Capybara::Lockstep::Timeout` error is raised after a timeout:
+
+```ruby
+Capybara::Lockstep.timeout_with = :error
+```
+
+To revert to defaults:
 
 ```ruby
 Capybara::Lockstep.timeout = nil
+Capybara::Lockstep.timeout_with = nil
 ```
 
 
@@ -300,9 +307,9 @@ ensure
 end
 ```
 
-Note that you may still force synchronization by calling `Capybara::Lockstep.synchronize` manually.
+In the `:manual` mode you may still force synchronization by calling `Capybara::Lockstep.synchronize` manually.
 
-To completely disable synchronization:
+To completely disable synchronization, even when `Capybara::Lockstep.synchronize` is called:
 
 ```ruby
 Capybara::Lockstep.mode = :off
@@ -310,70 +317,59 @@ Capybara::Lockstep.synchronize # will not synchronize
 ```
 
 
-## Signaling asynchronous work
 
-If for some reason you want capybara-lockstep to consider additional asynchronous work as "busy", you can do so:
+## Handling legacy promises
 
-```js
-CapybaraLockstep.startWork('Eject warp core')
-doAsynchronousWork().then(function() {
-  CapybaraLockstep.stopWork('Eject warp core')
-})
-```
+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.
 
-The string argument is used for logging (when logging is enabled). It does **not** need to be unique per job. In this case you should see messages like this in your browser's JavaScript console:
+This means there is a time window in which all AJAX requests have finished, but their callbacks have not yet run:
 
-```text
-[capybara-lockstep] Started work: Eject warp core [1 jobs]
-[capybara-lockstep] Finished work: Eject warp core [0 jobs]
+```js
+$http.get('/foo').then(function() {
+  // This callback runs one task after the response was received
+})
 ```
 
-You may omit the string argument, in which case nothing will be logged, but the work will still be tracked.
-
+It is theoretically possible that your test will observe the browser in that window, and expect content that has not been rendered yet. Affected code must call `then()` on a task-based promise **or** use `setTimeout()` to push work into the next task.
 
-## Note on interacting with the JavaScript API
+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:
 
-If you only load capybara-lockstep in tests you, should check for the `CapybaraLockstep` global to be defined before you interact with the JavaScript API.
-
-```js
-if (window.CapybaraLockstep) {
-  // interact with CapybaraLockstep
-}
+```ruby
+Capybara::Lockstep.wait_tasks = 1
 ```
 
-## Handling legacy promises
+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.
 
-Legacy promise implementations (like jQuery's `$.Deferred` and AngularJS' `$q`) work using tasks instead of microtasks. Their AJAX implementations (like `$.ajax()` and `$http`) use these promises to signal that a request is done.
+Waiting additional tasks will have a negative performance impact on your test suite.
 
-This means there is a time window in which all AJAX requests have finished, but their callbacks have not yet run:
+> **Note:** When capybara-lockstep detects jQuery on the page, it will automatically patch [`$.ajax()`](https://api.jquery.com/jQuery.ajax/) to wait an additional task after the response was received. If your only concern is callbacks to `$.ajax()` you do not need so set `Capybara::Lockstep.wait_tasks`.
 
-```js
-$.ajax('/foo').then(function() {
-  // This callback runs one task after the response was received
-})
-```
 
-It is theoretically possible that your test will observe the browser in that window, and expect content that has not been rendered yet. 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:
+## Contributing
 
-```js
-Capybara:Lockstep.wait_tasks = 1
-```
+Pull requests are welcome on GitHub at <https://github.com/makandra/capybara-lockstep>.
 
-If you see longer `then()` chains in your code, you may need to configure a higher number of tasks to wait.
+After checking out the repo, run `bin/setup` to install dependencies.
 
-This will have a negative performance impact on your test suite.
+Then, run `rake spec` to run the tests.
 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-## Development
+### Manually testing a change
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To test an unrelased change with a test suite, we recommend to temporarily link the local repository from your test suites's `Gemfile`:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+gem 'capybara-lockstep', path: '../capybara-lockstep'
+```
 
+As an alternative you may also install this gem onto your local machine by running `bundle exec rake install`.
 
-## Contributing
+### Releasing a new version
 
-Pull requests are welcome on GitHub at <https://github.com/makandra/capybara-lockstep>.
+- Update the version number in `version.rb`
+ - Run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+ - If RubyGems publishing seems to freeze, try entering your OTP code.
 
 
 ## License

data/capybara-lockstep.gemspec

@@ -14,6 +14,10 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 
+  spec.metadata["bug_tracker_uri"] = "https://github.com/makandra/capybara-lockstep/issues"
+  spec.metadata["changelog_uri"] = "https://github.com/makandra/capybara-lockstep/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = 'true'
+
   # 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

data/lib/capybara-lockstep/capybara_ext.rb

@@ -1,34 +1,99 @@
 require 'ruby2_keywords'
 
+module Capybara
+  module Lockstep
+    module UnsychronizeAfter
+      def unsychronize_after(meth)
+        mod = Module.new do
+          define_method meth do |*args, &block|
+            super(*args, &block)
+          ensure
+            Lockstep.synchronized = false
+          end
+
+          ruby2_keywords meth
+        end
+
+        prepend(mod)
+      end
+    end
+  end
+end
+
+module Capybara
+  module Lockstep
+    module SynchronizeBefore
+      def synchronize_before(meth, lazy:)
+        mod = Module.new do
+          define_method meth do |*args, &block|
+            Lockstep.auto_synchronize(lazy: lazy, log: "Synchronizing before ##{meth}")
+            super(*args, &block)
+          end
+
+          ruby2_keywords meth
+        end
+
+        prepend(mod)
+      end
+    end
+  end
+end
+
+Capybara::Session.class_eval do
+  extend Capybara::Lockstep::SynchronizeBefore
+  extend Capybara::Lockstep::UnsychronizeAfter
+
+  synchronize_before :html, lazy: true # wait until running JavaScript has updated the DOM
+
+  synchronize_before :current_url, lazy: true # wait until running JavaScript has updated the URL
+
+  synchronize_before :refresh, lazy: false # wait until running JavaScript has updated the URL
+  unsychronize_after :refresh # new document is no longer synchronized
+
+  synchronize_before :go_back, lazy: false # wait until running JavaScript has updated the URL
+  unsychronize_after :go_back # new document is no longer synchronized
+
+  synchronize_before :go_forward, lazy: false # wait until running JavaScript has updated the URL
+  unsychronize_after :go_forward # new document is no longer synchronized
+
+  synchronize_before :switch_to_frame, lazy: true # wait until the current frame is done processing
+  unsychronize_after :switch_to_frame # now that we've switched into the new frame, we don't know the document's synchronization state.
+
+  synchronize_before :switch_to_window, lazy: true # wait until the current frame is done processing
+  unsychronize_after :switch_to_window # now that we've switched to the new window, we don't know the document's synchronization state.
+end
+
 module Capybara
   module Lockstep
     module VisitWithWaiting
-      ruby2_keywords def visit(*args, &block)
+      def visit(*args, &block)
         url = args[0]
         # Some of our apps have a Cucumber 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.
         # Also when opening a new tab via Capybara, the initial URL is about:blank.
-        visiting_remote_url = !(url.start_with?('data:') || url.start_with?('about:'))
+        visiting_real_url = !(url.start_with?('data:') || url.start_with?('about:'))
 
-        if visiting_remote_url
+        if visiting_real_url
           # We're about to leave this screen, killing all in-flight requests.
           # Give pending form submissions etc. a chance to finish before we tear down
           # the browser environment.
           #
           # We force a non-lazy synchronization so we pick up all client-side changes
           # that have not been caused by Capybara commands.
-          Lockstep.synchronize(lazy: false)
+          Lockstep.auto_synchronize(lazy: false, log: "Synchronizing before visiting #{url}")
         end
 
         super(*args, &block).tap do
-          if visiting_remote_url
+          if visiting_real_url
             # We haven't yet synchronized the new screen.
             Lockstep.synchronized = false
           end
         end
       end
+
+      ruby2_keywords :visit
     end
   end
 end
@@ -58,14 +123,15 @@ module Capybara
               Lockstep.auto_synchronize(lazy: !script_may_navigate_away, log: "Synchronizing before script: #{script}")
             end
 
-            super(script, *args, &block).tap do
-              if !Lockstep.synchronizing?
-                # We haven't yet synchronized with whatever changes the JavaScript
-                # did on the frontend.
-                Lockstep.synchronized = false
-              end
+            super(script, *args, &block)
+          ensure
+            if !Lockstep.synchronizing?
+              # We haven't yet synchronized with whatever changes the JavaScript
+              # did on the frontend.
+              Lockstep.synchronized = false
             end
           end
+
           ruby2_keywords meth
         end
         prepend(mod)
@@ -84,24 +150,6 @@ Capybara::Session.class_eval do
   # internally and we don't want to synchronize multiple times.
 end
 
-module Capybara
-  module Lockstep
-    module UnsychronizeAfter
-      def unsychronize_after(meth)
-        mod = Module.new do
-          define_method meth do |*args, &block|
-            super(*args, &block).tap do
-              Lockstep.synchronized = false
-            end
-          end
-          ruby2_keywords meth
-        end
-        prepend(mod)
-      end
-    end
-  end
-end
-
 # Capybara 3 has driver-specific Node classes which sometimes
 # super to Capybara::Selenium::Node, but not always.
 node_classes = [
@@ -141,14 +189,16 @@ end
 module Capybara
   module Lockstep
     module SynchronizeWithCatchUp
-      ruby2_keywords def synchronize(*args, &block)
+      def synchronize(*args, &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.
-        Capybara::Lockstep.auto_synchronize(lazy: true)
+        Lockstep.auto_synchronize(lazy: true, log: 'Synchronizing before node access')
 
         super(*args, &block)
       end
+
+      ruby2_keywords :synchronize
     end
   end
 end

data/lib/capybara-lockstep/configuration.rb

@@ -10,6 +10,14 @@ module Capybara
         @timeout = seconds
       end
 
+      def timeout_with
+        @timeout_with.nil? ? :log : @timeout_with
+      end
+
+      def timeout_with=(action)
+        @timeout_with = action&.to_sym
+      end
+
       def debug?
         # @debug may also be a Logger object, so convert it to a boolean
         @debug.nil? ? false : !!@debug
@@ -38,7 +46,7 @@ module Capybara
       end
 
       def mode=(mode)
-        @mode = mode
+        @mode = mode&.to_sym
       end
 
       def enabled=(enabled)

data/lib/capybara-lockstep/errors.rb

@@ -1,6 +1,6 @@
 module Capybara
   module Lockstep
     class Error < StandardError; end
-    class Busy < Error; end
+    class Timeout < Error; end
   end
 end

data/lib/capybara-lockstep/helper.js

@@ -3,12 +3,14 @@ window.CapybaraLockstep = (function() {
   let debug
   let jobCount
   let idleCallbacks
+  let finishedWorkTags
   let waitTasks
   reset()
 
   function reset() {
     jobCount = 0
     idleCallbacks = []
+    finishedWorkTags = []
     waitTasks = 0
     debug = false
   }
@@ -74,12 +76,17 @@ window.CapybaraLockstep = (function() {
     jobCount--
 
     if (tag) {
+      finishedWorkTags.push(tag)
       logPositive('Finished work: %s [%d jobs]', tag, jobCount)
     }
 
-    let idleCallback
-    while (isIdle() && (idleCallback = idleCallbacks.shift())) {
-      idleCallback('Finished waiting for browser')
+    if (isIdle()) {
+      let idleCallback
+      while ((idleCallback = idleCallbacks.shift())) {
+        idleCallback("Finished waiting for " + finishedWorkTags.join(', '))
+      }
+
+      finishedWorkTags = []
     }
   }
 
@@ -123,43 +130,21 @@ window.CapybaraLockstep = (function() {
     }
   }
 
-  function trackInteraction() {
-    // We already override all interaction methods in the Selenium browser nodes, so they
-    // wait for an idle frame afterwards. However a test script might also dispatch synthetic
-    // events with executate_script() to manipulate the browser in ways that are not possible
-    // with the Capybara API. When we observe such an event we wait until the end of the microtask,
-    // assuming any busy action will be queued by then.
-    ['click',  'mousedown', 'keydown', 'change', 'input', 'submit', 'focusin', 'focusout', 'scroll'].forEach(function(eventType) {
-      // Use { useCapture: true } so we get the event before another listener
-      // can prevent it from bubbling up to the document.
-      document.addEventListener(eventType, onInteraction, { capture: true, passive: true })
-    })
-  }
-
-  function onInteraction(event) {
-    startWork()
-    // (1) We wait until the end of this microtask, assuming that any callback that
-    //     would queue an AJAX request or load additional scripts will run by then.
-    // (2) For performance reasons we don't wait for `waitTasks` here.
-    //     Whatever was queued by an event handler should call us again, and then
-    //     we do wait for additional tasks.
-    Promise.resolve().then(stopWorkNow)
-  }
-
   function trackRemoteElements() {
     if (!window.MutationObserver) {
       return
     }
 
-    // Dynamic imports or analytics snippets may insert a <script src>
-    // tag that loads and executes additional JavaScript. We want to be isBusy()
+    // Dynamic imports or analytics snippets may insert a script element
+    // that loads and executes additional JavaScript. We want to be isBusy()
     // until such scripts have loaded or errored.
     let observer = new MutationObserver(onAnyElementChanged)
     observer.observe(document, { subtree: true, childList: true })
   }
 
   function trackJQuery() {
-    // jQuery may be loaded after us, so we wait until DOMContentReady.
+    // 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) {
         return
@@ -180,28 +165,6 @@ window.CapybaraLockstep = (function() {
     })
   }
 
-  let INITIALIZING_ATTRIBUTE = 'data-initializing'
-
-  function trackHydration() {
-    // Until we have a body on which we can observe [data-initializing]
-    // we consider ourselves busy.
-    startWork()
-    whenReady(function() {
-      stopWorkNow()
-      if (document.body.hasAttribute(INITIALIZING_ATTRIBUTE)) {
-        startWork('Page initialization')
-        let observer = new MutationObserver(onInitializingAttributeChanged)
-        observer.observe(document.body, { attributes: true, attributeFilter: [INITIALIZING_ATTRIBUTE] })
-      }
-    })
-  }
-
-  function onInitializingAttributeChanged() {
-    if (!document.body.hasAttribute(INITIALIZING_ATTRIBUTE)) {
-      stopWork('Page initialization')
-    }
-  }
-
   function isRemoteScript(element) {
     if (element.tagName === 'SCRIPT') {
       let src = element.getAttribute('src')
@@ -303,13 +266,28 @@ window.CapybaraLockstep = (function() {
     }
   }
 
+  function trackOldUnpoly() {
+    // CapybaraLockstep.track() is called as the first script in the head.
+    // Unpoly will be loaded after us, so we wait until DOMContentReady.
+    whenReady(function() {
+      // Unpoly 0.x would wait one task after DOMContentLoaded before booting.
+      // There's a slim chance that Capybara can observe the page before compilers have run.
+      // Unpoly 1.0+ runs compilers on DOMContentLoaded, so there's no issue.
+      if (window.up?.version?.startsWith('0.')) {
+        startWork('Old Unpoly')
+        setTimeout(function () {
+          stopWork('Old Unpoly')
+        })
+      }
+    })
+  }
+
   function track() {
+    trackOldUnpoly()
     trackFetch()
     trackXHR()
-    trackInteraction()
     trackRemoteElements()
     trackJQuery()
-    trackHydration()
   }
 
   function synchronize(callback) {

data/lib/capybara-lockstep/lockstep.rb

@@ -13,7 +13,17 @@ module Capybara
       alias synchronizing? synchronizing
 
       def synchronized?
+        # The synchronized flag is per-session (page == Capybara.current_session).
+        # This enables tests that use more than one browser, e.g. to test multi-user interaction:
+        # https://makandracards.com/makandra/474480-how-to-make-a-cucumber-test-work-with-multiple-browser-sessions
+        #
+        # Ideally the synchronized flag would also be per-tab, per-frame and per-document.
+        # We haven't found a way to patch this into Capybara, as there does not seem to be
+        # a persistent object representing a document. Capybara::Node::Document just seems to
+        # be a proxy accessing whatever is the current document. The way we work around this
+        # is that we synchronize before switching tabs or frames.
         value = page.instance_variable_get(:@lockstep_synchronized)
+
         # We consider a new Capybara session to be synchronized.
         # This will be set to false after our first visit().
         value.nil? ? true : value
@@ -24,19 +34,30 @@ module Capybara
       end
 
       def synchronize(lazy: false, log: nil)
+        # The { lazy } option is a performance optimization that will prevent capybara-lockstep
+        # from synchronizing multiple times in expressions like `page.find('.foo').find('.bar')`.
+        # The { lazy } option has nothing todo with :auto mode.
+        #
+        # With { lazy: true } we only synchronize when the Ruby-side thinks we're out of sync.
+        # This saves us an expensive execute_script() roundtrip that goes to the browser and back.
+        # However the knowledge of the Ruby-side is limited: We only assume that we're out of sync
+        # after a page load or after a Capybara command. There may be additional client-side work
+        # that the Ruby-side is not aware of, e.g. an AJAX call scheduled by a timeout.
+        #
+        # With { lazy: false } we force synchronization with the browser, whether the Ruby-side
+        # thinks we're in sync or not. This always makes an execute_script() rountrip, but picks up
+        # non-lazy synchronization so we pick up client-side work that have not been caused
+        # by Capybara commands.
         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
+        synchronize_now(log: log)
       end
 
+      # Automatic synchronization from within the capybara-lockstep should always call #auto_synchronize.
+      # This only synchronizes IFF in :auto mode, i.e. the user has not explicitly disabled automatic syncing.
+      # The :auto mode has nothing to do with the { lazy } option.
       def auto_synchronize(**options)
         if mode == :auto
           synchronize(**options)
@@ -45,11 +66,11 @@ module Capybara
 
       private
 
-      def synchronize_now
+      def synchronize_now(log: 'Synchronizing')
         self.synchronizing = true
         self.synchronized = false
 
-        log 'Synchronizing'
+        self.log(log)
 
         start_time = current_seconds
 
@@ -68,6 +89,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)
@@ -88,9 +111,14 @@ module Capybara
             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.

data/lib/capybara-lockstep/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Lockstep
-    VERSION = "1.0.0"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-lockstep
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -101,6 +101,9 @@ licenses:
 metadata:
   homepage_uri: https://github.com/makandra/capybara-lockstep
   source_code_uri: https://github.com/makandra/capybara-lockstep
+  bug_tracker_uri: https://github.com/makandra/capybara-lockstep/issues
+  changelog_uri: https://github.com/makandra/capybara-lockstep/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: