Testing Asynchronous Code

It’s common in JavaScript for code to run asynchronously. When you have code that runs asynchronously, Jest needs to know when the code it is testing has completed, before it can move on to another test. Jest has several ways to handle this.

Promises

Return a promise from your test, and Jest will wait for that promise to resolve. If the promise is rejected, the test will fail.

For example, let’s say that fetchData returns a promise that is supposed to resolve to the string 'peanut butter'. We could test it with:

  1. test('the data is peanut butter', () => {
  2.   return fetchData().then(data => {
  3.     expect(data).toBe('peanut butter');
  4.   });
  5. });

Async/Await

Alternatively, you can use async and await in your tests. To write an async test, use the async keyword in front of the function passed to test. For example, the same fetchData scenario can be tested with:

  1. test('the data is peanut butter', async () => {
  2.   const data = await fetchData();
  3.   expect(data).toBe('peanut butter');
  4. });
  6. test('the fetch fails with an error', async () => {
  7.   expect.assertions(1);
  8.   try {
  9.     await fetchData();
  10.   } catch (e) {
  11.     expect(e).toMatch('error');
  12.   }
  13. });

You can combine async and await with .resolves or .rejects.

  1. test('the data is peanut butter', async () => {
  2.   await expect(fetchData()).resolves.toBe('peanut butter');
  3. });
  5. test('the fetch fails with an error', async () => {
  6.   await expect(fetchData()).rejects.toMatch('error');
  7. });

In these cases, async and await are effectively syntactic sugar for the same logic as the promises example uses.

Testing Asynchronous Code - 图1caution

Be sure to return (or await) the promise - if you omit the return/await statement, your test will complete before the promise returned from fetchData resolves or rejects.

If you expect a promise to be rejected, use the .catch method. Make sure to add expect.assertions to verify that a certain number of assertions are called. Otherwise, a fulfilled promise would not fail the test.

  1. test('the fetch fails with an error', () => {
  2.   expect.assertions(1);
  3.   return fetchData().catch(e => expect(e).toMatch('error'));
  4. });

Callbacks

If you don’t use promises, you can use callbacks. For example, let’s say that fetchData, instead of returning a promise, expects a callback, i.e. fetches some data and calls callback(null, data) when it is complete. You want to test that this returned data is the string 'peanut butter'.

By default, Jest tests complete once they reach the end of their execution. That means this test will not work as intended:

  1. // Don't do this!
  2. test('the data is peanut butter', () => {
  3.   function callback(error, data) {
  4.     if (error) {
  5.       throw error;
  6.     }
  7.     expect(data).toBe('peanut butter');
  8.   }
  10.   fetchData(callback);
  11. });

The problem is that the test will complete as soon as fetchData completes, before ever calling the callback.

There is an alternate form of test that fixes this. Instead of putting the test in a function with an empty argument, use a single argument called done. Jest will wait until the done callback is called before finishing the test.

  1. test('the data is peanut butter', done => {
  2.   function callback(error, data) {
  3.     if (error) {
  4.       done(error);
  5.       return;
  6.     }
  7.     try {
  8.       expect(data).toBe('peanut butter');
  9.       done();
  10.     } catch (error) {
  11.       done(error);
  12.     }
  13.   }
  15.   fetchData(callback);
  16. });

If done() is never called, the test will fail (with timeout error), which is what you want to happen.

If the expect statement fails, it throws an error and done() is not called. If we want to see in the test log why it failed, we have to wrap expect in a try block and pass the error in the catch block to done. Otherwise, we end up with an opaque timeout error that doesn’t show what value was received by expect(data).

Testing Asynchronous Code - 图2caution

Jest will throw an error, if the same test function is passed a done() callback and returns a promise. This is done as a precaution to avoid memory leaks in your tests.

.resolves / .rejects

You can also use the .resolves matcher in your expect statement, and Jest will wait for that promise to resolve. If the promise is rejected, the test will automatically fail.

  1. test('the data is peanut butter', () => {
  2.   return expect(fetchData()).resolves.toBe('peanut butter');
  3. });

Be sure to return the assertion—if you omit this return statement, your test will complete before the promise returned from fetchData is resolved and then() has a chance to execute the callback.

If you expect a promise to be rejected, use the .rejects matcher. It works analogically to the .resolves matcher. If the promise is fulfilled, the test will automatically fail.

  1. test('the fetch fails with an error', () => {
  2.   return expect(fetchData()).rejects.toMatch('error');
  3. });

None of these forms is particularly superior to the others, and you can mix and match them across a codebase or even in a single file. It just depends on which style you feel makes your tests simpler.