How to make Jest wait for all asynchronous code to finish execution before expecting an assertion

by

Updated for Jest 27+

For jest 27+, you can also use process.nextTick:

await new Promise(process.nextTick);

(Thanks to Adrian Godong in the comments)

Original Answer

Here’s a snippet that waits until pending Promises are resolved:

const flushPromises = () => new Promise(setImmediate);

Note that setImmediate is a non-standard feature (and is not expected to become standard). But if it’s sufficient for your test environment, should be a good solution. Its description:

This method is used to break up long running operations and run a callback function immediately after the browser has completed other operations such as events and display updates.

Here’s roughly how to use it using async/await:

it('is an example using flushPromises', async () => {
    const wrapper = mount(<App/>);
    await flushPromises();
    wrapper.update(); // In my experience, Enzyme didn't always facilitate component updates based on state changes resulting from Promises -- hence this forced re-render

    // make assertions 
});

I used this a lot in this project if you want some working real-world examples.

More Related Contents:

  1. Testing React components that fetches data using Hooks
  2. how to change jest mock function return value in each test?
  3. How to resolve “Cannot use import statement outside a module” in jest
  4. Testing with React’s Jest and Enzyme when simulated clicks call a function that calls a promise
  5. How can I use Jest to spy on a method call?
  6. Recommended approach for route-based tests within routes of react-router
  7. Simulate a button click in Jest
  8. How to resolve “Cannot use import statement outside a module” from Jest when running tests?
  9. SyntaxError with Jest and React and importing CSS files
  10. Jest setup “SyntaxError: Unexpected token export”
  11. Jest test fails : TypeError: window.matchMedia is not a function
  12. How to solve the “update was not wrapped in act()” warning in testing-library-react?
  13. How do I set a timezone in my Jest config?
  14. How to test a react component that is dependent on useContext hook?
  15. Importing images breaks jest test
  16. Jest spyOn function called
  17. How to test style for a React component attribute with Enzyme
  18. How to mock React component methods with jest and enzyme
  19. How to test Async Storage with Jest?
  20. jest: Test suite failed to run, SyntaxError: Unexpected token import
  21. forEach() in React JSX does not output any HTML
  22. Starter create-react-app with IE11 polyfill import still aborts in IE11
  23. What does the error “JSX element type ‘…’ does not have any construct or call signatures” mean?
  24. How to combine multiple inline style objects?
  25. When do I choose React state Vs Redux Store
  26. React.useState does not reload state from props
  27. TypeError: evt.target is null in functional setState
  28. React router 4 does not update view on link, but does on refresh
  29. require is not defined
  30. import a module from node_modules with babel but failed

Leave a Comment