capybara-lockstep 0.4.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 783200fa3cbde0166b11c213bb677250021185b7c9898a3fd95594dd8433b89a
-  data.tar.gz: 77efe617f3ce7f138da78e8b9db031b9a8f75f07d3afe8379ae903266a9fa389
+  metadata.gz: 4ece5e0daeb6883b02791ed06f6ff2afca446e5aa5635f22d3ec5b94d0e96aa7
+  data.tar.gz: 5e4d53a8c59f71071aa48fee8ec87fa62e5c189e026b5cac563fd9427a082c59
 SHA512:
-  metadata.gz: 6ec80d343f193b6b5a166bae1bf5ab6be2e7ae2e3c82d903596e4c604985d96382cce5012df5abdb714da614d8741f062386d60a47a1a3340734c22e46814949
-  data.tar.gz: 02e870bc8b8377be23e0ec97086219c7fd75a098f6f4eeda953dac86b7eb3a957d93984fb26265e8322c21989daa28cf4713ee3dc1772cd652f493e7999b6b57
+  metadata.gz: 7e68bf91ab8b5ecf91b145159697e7990dbbbb3a5497955d50d91ea83d802c50195f803ae1fd029b2b76dc18b407bd1995b03aa292e30873cd35f8746dfa509e
+  data.tar.gz: 8fb8d9b19fc47b5769208d36125b6cc2fb40375a8d5b46216ec318a3fd8459ca26f6bf22f352efcf350b7d7cbfe89f7bb866633fb4e096812b7d31513d4c7bae

data/.github/workflows/test.yml

@@ -0,0 +1,50 @@
+---
+name: Tests
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+  workflow_dispatch:
+    branches:
+    - master  
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 3
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - ruby: 2.6.6
+          gemfile: Gemfile
+        - ruby: 2.7.2
+          gemfile: Gemfile
+        - ruby: 3.0.1
+          gemfile: Gemfile
+    env:
+      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:
+        ruby-version: "${{ matrix.ruby }}"
+    - name: Bundle
+      run: |
+        gem install bundler:2.2.15
+        bundle install --no-deployment
+    - name: Run tests
+      uses: nick-invision/retry@v2
+      with:
+        timeout_seconds: 30
+        max_attempts: 3
+        command: bundle exec rake spec

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -0,0 +1,69 @@
+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.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

@@ -8,5 +8,9 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
+gem 'jasmine'
+gem 'thin' # ruby 3 does not include a webserver
+gem 'chrome_remote'
 
 gem 'byebug'
+gem 'gemika'

data/Gemfile.lock

@@ -1,15 +1,16 @@
 PATH
   remote: .
   specs:
-    capybara-lockstep (0.4.0)
+    capybara-lockstep (1.1.0)
       activesupport (>= 3.2)
       capybara (>= 2.0)
+      ruby2_keywords
       selenium-webdriver (>= 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -27,16 +28,26 @@ GEM
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
     childprocess (3.0.0)
+    chrome_remote (0.3.0)
+      websocket-driver (~> 0.6)
     concurrent-ruby (1.1.8)
+    daemons (1.3.1)
     diff-lcs (1.3)
-    i18n (1.8.9)
+    eventmachine (1.2.7)
+    gemika (0.6.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
+    jasmine (3.6.0)
+      jasmine-core (~> 3.6.0)
+      phantomjs
+      rack (>= 1.2.1)
+      rake
+    jasmine-core (3.6.0)
+    mini_mime (1.1.0)
     minitest (5.14.4)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.11.3-x86_64-linux)
       racc (~> 1.4)
+    phantomjs (2.1.1.0)
     public_suffix (4.0.6)
     racc (1.5.2)
     rack (2.2.3)
@@ -57,12 +68,20 @@ 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)
       rubyzip (>= 1.2.2)
+    thin (1.8.0)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
     zeitwerk (2.4.2)
@@ -73,8 +92,12 @@ PLATFORMS
 DEPENDENCIES
   byebug
   capybara-lockstep!
+  chrome_remote
+  gemika
+  jasmine
   rake (~> 13.0)
   rspec (~> 3.0)
+  thin
 
 BUNDLED WITH
-   2.2.12
+   2.2.15

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,32 +26,50 @@ 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).
 
-Whenever Capybara visits a new URL:
+Before Capybara simulates a user interaction (clicking, typing, etc.) or before it visits a new URL:
 
-- capybara-lockstep waits for all document resources to load.
+- capybara-lockstep waits for all document resources to load (images, CSS, fonts, frames).
+- capybara-lockstep waits for any AJAX requests to finish.
 - capybara-lockstep waits for client-side JavaScript to render or hydrate DOM elements.
-- capybara-lockstep waits for any AJAX requests.
 - 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 inserted `<img>` or `<iframe>` elements to load.
 
-Whenever Capybara simulates a user interaction (clicking, typing, etc.):
+In summary Capybara can no longer observe the page while HTTP requests are in flight.
+This covers most async work that causes flaky tests.
 
-- capybara-lockstep waits for any AJAX requests.
-- 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).
+You can also configure capybara-lockstep to [wait for other async work](#signaling-asynchronous-work) that does not involve the network, like animations.
 
 
 Installation
@@ -80,105 +101,81 @@ 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? %>
 ```
 
-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 the document was loaded. This JavaScript enhances existing DOM elements ("hydration") or renders additional element into the DOM.
+### Verify successful integration
 
-capybara-lockstep needs to know when your JavaScript is done hydrating and rendering, so it can automatically wait for initialization after every Capybara `visit()`.
+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 hydrating and rendering.
-
-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.
-
-If all your initializing JavaScript runs synchronously on `DOMContentLoaded`, you can remove `[data-initializing]` in an event handler:
+You should see messages like this in your console:
 
-```js
-document.addEventListener('DOMContentLoaded', function() {
-  // Initialize the page here
-  document.body.removeAttribute('data-initializing')
-})
+```text
+[capybara-lockstep] Synchronizing
+[capybara-lockstep] Finished waiting for JavaScript
+[capybara-lockstep] Synchronized successfully
 ```
 
-If you do any asynchronous initialization work (like lazy-loading another script) you should only remove `[data-initializing]` once that is done:
+Note that you may see some failures from tests with wrong assertions, which previously passed due to lucky timing.
 
-```js
-document.addEventListener('DOMContentLoaded', function() {
-  import('huge-library').then(function({ hugeLibrary }) {
-    hugeLibrary.initialize()
-    document.body.removeAttribute('data-initializing')
-  })
-})
-```
 
-If you call libraries during initialization, you may need to check the library code to see whether it finishes synchronously or asynchronously. E.g. if you discover that a library delays work for a task, you must also wait another task to remove `[data-initializing]`:
 
-```js
-document.addEventListener('DOMContentLoaded', function() {
-  Libary.doWorkInNextTask()
-  setTimeout(function() { document.body.removeAttribute('data-initializing') })
-})
-```
+## Signaling asynchronous work
 
-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]`:
+By default capybara-lockstep blocks all async work that 
+
+If for some reason you want capybara-lockstep to consider additional asynchronous work as "busy", you can do so:
 
 ```js
-up.compiler('body', function(body) {
-  body.removeAttribute('data-initializing')
+CapybaraLockstep.startWork('Eject warp core')
+doAsynchronousWork().then(function() {
+  CapybaraLockstep.stopWork('Eject warp core')
 })
 ```
 
-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]`:
+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
-app.directive('body', function() {
-  return {
-    restrict: 'E',
-    link: function() {
-      document.body.removeAttribute('data-initializing')
-    }
-  }
-})
+```text
+[capybara-lockstep] Started work: Eject warp core [1 jobs]
+[capybara-lockstep] Finished work: Eject warp core [0 jobs]
 ```
 
-### Verify successful integration
+You may omit the string argument, in which case nothing will be logged, but the work will still be tracked.
 
-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:
+## Note on interacting with the JavaScript API
 
-```text
-[capybara-lockstep] Synchronizing
-[capybara-lockstep] Finished waiting for JavaScript
-[capybara-lockstep] Synchronized successfully
-```
+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.
 
-Note that you may see some failures from tests with wrong assertions, which sometimes passed due to lucky timing.
+```js
+if (window.CapybaraLockstep) {
+  // interact with CapybaraLockstep
+}
+```
 
 
 ## Performance impact
@@ -187,7 +184,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
@@ -224,27 +221,23 @@ You may also configure logging to an existing logger object:
 Capybara::Lockstep.debug = Rails.logger
 ```
 
+### Logging in the browser only
 
-## Disabling synchronization
-
-Sometimes you want to disable browser synchronization, e.g. to observe a loading spinner during a long-running request.
-
-To disable synchronization:
+To enable logging in the browser console (but not STDOUT), include the [JavaScript snippet](#including-the-javascript-snippet) with `{ debug: true }`:
 
 ```ruby
-begin
-  Capybara::Lockstep.enabled = false
-  do_unsynchronized_work
-ensure
-  Capybara::Lockstep.enabled = true
-end
+capybara_lockstep(debug: true)
 ```
 
 ## Synchronization timeout
 
 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:
 
@@ -252,10 +245,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
 ```
 
 
@@ -275,48 +277,82 @@ You may also synchronize from your client-side JavaScript. The following will ru
 CapybaraLockstep.synchronize(callback)
 ```
 
-## Signaling asynchronous work
 
-If for some reason you want capybara-lockstep to consider additional asynchronous work as "busy", you can do so:
+## Disabling synchronization
 
-```js
-CapybaraLockstep.startWork('Eject warp core')
-doAsynchronousWork().then(function() {
-  CapybaraLockstep.stopWork('Eject warp core')
-})
+Sometimes you want to disable browser synchronization, e.g. to observe a loading spinner during a long-running request.
+
+To disable automatic synchronization:
+
+```ruby
+begin
+  Capybara::Lockstep.mode = :manual
+  do_unsynchronized_work
+ensure
+  Capybara::Lockstep.mode = :auto
+end
 ```
 
-The string argument is used for logging (when logging is enabled). In this case you should see messages like this in your browser's JavaScript console:
+In the `:manual` mode you may still force synchronization by calling `Capybara::Lockstep.synchronize` manually.
 
-```text
-[capybara-lockstep] Started work: Eject warp core [1 jobs]
-[capybara-lockstep] Finished work: Eject warp core [0 jobs]
+To completely disable synchronization:
+
+```ruby
+Capybara::Lockstep.mode = :off
+Capybara::Lockstep.synchronize # will not synchronize
 ```
 
-You may omit the string argument, in which case nothing will be logged, but the work will still be tracked.
 
 
-## Note on interacting with the JavaScript API
+## Handling legacy promises
 
-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.
+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.
 
-```
-if (window.CapybaraLockstep) {
-  // interact with CapybaraLockstep
-}
+This means there is a time window in which all AJAX requests have finished, but their callbacks have not yet run:
+
+```js
+$.ajax('/foo').then(function() {
+  // This callback runs one task after the response was received
+})
 ```
 
-## Development
+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:
 
-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.
+```js
+Capybara:Lockstep.wait_tasks = 1
+```
 
-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).
+If you see longer `then()` chains in your code, you may need to configure a higher number of tasks to wait.
+
+This will have a negative performance impact on your test suite.
 
 
 ## Contributing
 
 Pull requests are welcome on GitHub at <https://github.com/makandra/capybara-lockstep>.
 
+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.
+
+### Manually testing a change
+
+To test an unrelased change with a test suite, we recommend to temporarily link the local repository from your test suites's `Gemfile`:
+
+```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`.
+
+### Releasing a new version
+
+- 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