cypress-wait-until

Add the Cypress waiting power to virtually everything 🎉

<br />

Use this plugin to wait for everything not expected by Cypress wait.

Installation

bashCopy
npm i -D cypress-wait-until
# or
yarn add -D cypress-wait-until

Usage

cypress-wait-until extends Cypress' cy command.

Add this line to your project's cypress/support/commands.js:

javascriptCopy
import 'cypress-wait-until';

Then, in your test, you can write

javascriptCopy
// wait until a cookie is set
cy.waitUntil(() => cy.getCookie('token').then(cookie => Boolean(cookie && cookie.value)));

// wait until a global variable has an expected value
cy.waitUntil(() => cy.window().then(win => win.foo === "bar"));

// sync function works too!
cy.waitUntil(() => true);

// with all the available options
cy.waitUntil(() => cy.window().then(win => win.foo === "bar"), {
  errorMsg: 'This is a custom error message', // overrides the default error message
  timeout: 2000, // waits up to 2000 ms, default to 5000
  interval: 500 // performs the check every 500 ms, default to 200
});

If you return a truthy value, it becomes the subject for the next command. So you can assert about
it too

javascriptCopy
// wait until the Recaptcha token will be added to the dedicated hidden input field...
cy.waitUntil(() => cy.get("input[type=hidden]#recaptchatoken").then($el => $el.val()))
  // ... then, check that it's valid string asserting about it
  .then(token => expect(token).to.be.a("string").to.have.length.within(1, 1000));

The waitUntil command could be chained to other commands too. As an example, the following codes are equivalent

javascriptCopy
cy.waitUntil(() => cy.getCookie('token').then(cookie => cookie.value === '<EXPECTED_VALUE>'));
// is equivalent to
cy.wrap('<EXPECTED_VALUE>')
  .waitUntil((subject) => cy.getCookie('token').then(cookie => cookie.value === subject));

Please note

• do not expect that the previous command is retried. Only what's inside the checkFunction body is retried

javascriptCopy
cy.getCookie('token') // will not be retried
  .waitUntil(cookie => cookie.value === '<EXPECTED_VALUE>');

• you cannot put assertions inside checkFunction. There is no way to avoid a test failure if an assertion throws an error. You must manually check what the assertions would check for you. The most common case is checking that an element exists or not, instead of using cy.get('#id').should('exist') you should check that Cypress.$('#id').length is greater than 0. Here you can find a deeper explanation

• nested cy.waitUntil calls don't respect timeout options. timeout and interval are converted to a number of retries. If the parent cy.waitUntil retries 10 times and the nested one 15 times, then the latter will be run 150 times before giving up, resulting in an extremely long wait. See the discussion for more info

TypeScript

If you use TypeScript you can define the checkFunction returning type too. Take a look at the plugin.spec.ts file to read about the cy.waitUntil signature.

IMPORTANT:

1. Remember to add cypress-wait-until to the cypress/tsconfig.json file

javascriptCopy
{
  "compilerOptions": {
    "types": ["cypress", "cypress-wait-until"]
  }
}

2. If you are encountering "cy.waitUntil is not a function" or "cy.waitUntil is undefined", you might need to specify the support file in your cypress.json for the import to work correctly:

javascriptCopy
{
  "supportFile": "cypress/support/commands.ts"
}

Arguments

• checkFunction

A function that must return a truthy value when the wait is over.

• options:Object (optional)

Pass in an options object to change the default behavior of cy.waitUntil().

Option	Type	Default	Description
errorMsg	string | function	"Timed out retrying"	The error message to write. If it's a function, it will receive the last result and the options passed to cy.waitUntil
timeout	number	5000	Time to wait for the checkFunction to return a truthy value before throwing an error.
interval	number	200	Time to wait between the checkFunction invocations.
description	string	"waitUntil"	The name logged into the Cypress Test Runner.
logger	function	Cypress.log	A custom logger in place of the default Cypress.log. It's useful just for debugging purposes.
log	boolean	true	Enable/disable logging.
customMessage	string	undefined	String logged after the options.description.
verbose	boolean	false	If every single check result must be logged.
customCheckMessage	string	undefined	Like customMessage, but used for every single check. Useless if verbose is not set to true.

Log options are a lot, take a look at the next screenshot to understand how they are printed

<br /> <br />

Could cy.waitUntil avoid failing the test?

No. cy.waitUntil waits for something that must happen, otherwise the test will fail. Cypress enforces to avoid conditional testing and the plugin agrees with that.

There are cases where conditional testing makes sense but if cy.waitUntil would have this capability everyone will use it to create conditional tests, treating the Cypress feature—because avoiding conditional testing is a feature—as "a bug".

If you need conditional testing you could write your own recursive promise check function (take a look here and here where it is explained how to do that) where you manage your case. After all, cy.waitUntil is just a recursive promise manager 😊

Why did we write it?

A lot of StackOverflow users had some difficulties in implementing a recursive promise with Cypress
just to repeatedly check for something to happen (see two of the various questions about the topic: How can i wait for each element in a list to update to a certain
text?
And How do I wait until a cookie is
set?).
<br />
This plugin is dedicated to them ❤️

Open Source Saturday

This project has been made during one of the Open Source Saturdays, a series of Milan-based events
where everyone codes just to spread some Open Source love ❤️

Contributing

Contributes are welcome, if you need to run the tests through npm test, you must update the package.json configuration setting cypressUploadRecordings to false (or set your own Cypress recording key).

Contributors

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://twitter.com/NoriSte"><img src="https://avatars0.githubusercontent.com/u/173663?v=4?s=100" width="100px;" alt="Stefano Magni"/><br />_{<b>Stefano Magni</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/commits?author=NoriSte" title="Code">💻</a> <a href="https://github.com/NoriSte/cypress-wait-until/commits?author=NoriSte" title="Tests">⚠️</a> <a href="https://github.com/NoriSte/cypress-wait-until/commits?author=NoriSte" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/allevo"><img src="https://avatars1.githubusercontent.com/u/1054125?v=4?s=100" width="100px;" alt="Tommaso Allevi"/><br />_{<b>Tommaso Allevi</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/commits?author=allevo" title="Code">💻</a> <a href="https://github.com/NoriSte/cypress-wait-until/commits?author=allevo" title="Tests">⚠️</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/brogueady"><img src="https://avatars2.githubusercontent.com/u/10169795?v=4?s=100" width="100px;" alt="brogueady"/><br />_{<b>brogueady</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/commits?author=brogueady" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/seeu1"><img src="https://avatars3.githubusercontent.com/u/57105774?v=4?s=100" width="100px;" alt="seeu1"/><br />_<b>seeu1</b></a><br /><a href="#ideas-seeu1" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/sweir27"><img src="https://avatars3.githubusercontent.com/u/2081340?v=4?s=100" width="100px;" alt="Sarah Weir"/><br />_{<b>Sarah Weir</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/issues?q=author%3Asweir27" title="Bug reports">🐛</a> <a href="https://github.com/NoriSte/cypress-wait-until/commits?author=sweir27" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/john20xdoe"><img src="https://avatars3.githubusercontent.com/u/14521605?v=4?s=100" width="100px;" alt="Lee Alexis"/><br />_{<b>Lee Alexis</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/commits?author=john20xdoe" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/peburrows"><img src="https://avatars3.githubusercontent.com/u/778?v=4?s=100" width="100px;" alt="Phil Burrows"/><br />_{<b>Phil Burrows</b>}</a><br /><a href="#ideas-peburrows" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/NoriSte/cypress-wait-until/commits?author=peburrows" title="Code">💻</a> <a href="https://github.com/NoriSte/cypress-wait-until/commits?author=peburrows" title="Tests">⚠️</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/LeoVie"><img src="https://avatars0.githubusercontent.com/u/7249788?v=4?s=100" width="100px;" alt="Leo Viezens"/><br />_{<b>Leo Viezens</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/commits?author=LeoVie" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://pierluc.io/"><img src="https://avatars.githubusercontent.com/u/2636763?v=4?s=100" width="100px;" alt="Pier-Luc Gendreau"/><br />_{<b>Pier-Luc Gendreau</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/commits?author=Zertz" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/liambutler"><img src="https://avatars.githubusercontent.com/u/24389501?v=4?s=100" width="100px;" alt="Liam Butler"/><br />_{<b>Liam Butler</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/commits?author=liambutler" title="Code">💻</a> <a href="https://github.com/NoriSte/cypress-wait-until/commits?author=liambutler" title="Tests">⚠️</a></td> <td align="center" valign="top" width="14.28%"><a href="http://knorrium.info"><img src="https://avatars.githubusercontent.com/u/100320?v=4?s=100" width="100px;" alt="Felipe Knorr Kuhn"/><br />_{<b>Felipe Knorr Kuhn</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/commits?author=knorrium" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://oleksiikachan.com"><img src="https://avatars.githubusercontent.com/u/14169061?v=4?s=100" width="100px;" alt="Oleksii Kachan"/><br />_{<b>Oleksii Kachan</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/issues?q=author%3AOleksiiKachan" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="https://www.strangeplanet.fr"><img src="https://avatars.githubusercontent.com/u/41597?v=4?s=100" width="100px;" alt="Damien Sorel"/><br />_{<b>Damien Sorel</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/issues?q=author%3Amistic100" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/piccit"><img src="https://avatars.githubusercontent.com/u/6035529?v=4?s=100" width="100px;" alt="piccit"/><br />_{<b>piccit</b>}</a><br /><a href="https://github.com/NoriSte/cypress-wait-until/issues?q=author%3Apiccit" title="Bug reports">🐛</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification. Contributions of any kind welcome!