How to Test Async Code in Node.js: Simple Guide

To test async code in Node.js, use async/await in your test functions and return or await the asynchronous calls. Testing frameworks like Jest or Mocha support this pattern, allowing you to write clear and reliable async tests.

Syntax

Use async before the test function to enable await inside it. Await the asynchronous function call to ensure the test waits for completion before asserting results.

Example parts:

• async () => { ... }: marks the test function as asynchronous.
• await asyncFunction(): waits for the async operation to finish.
• expect(): asserts the expected outcome.

javascript

test('async test example', async () => {
  const result = await asyncFunction();
  expect(result).toBe('done');
});

Example

This example shows how to test an asynchronous function that resolves a promise after a delay. The test waits for the promise to resolve and checks the returned value.

javascript

import { test, expect } from '@jest/globals';

function asyncFunction() {
  return new Promise((resolve) => {
    setTimeout(() => resolve('done'), 100);
  });
}

test('asyncFunction returns done', async () => {
  const result = await asyncFunction();
  expect(result).toBe('done');
});

Output

PASS  ./async.test.js
  ✓ asyncFunction returns done (105 ms)

Common Pitfalls

Common mistakes when testing async code include:

• Not returning or awaiting the async call, causing tests to finish before the async code runs.
• Using callbacks without signaling test completion.
• Forgetting to handle promise rejections, which can cause silent test failures.

Always use async/await or return the promise to ensure proper test flow.

javascript

/* Wrong way: missing await or return */
test('fails silently', () => {
  asyncFunction(); // test ends before promise resolves
  expect(true).toBe(true); // test passes incorrectly
});

/* Right way: await the async call */
test('correct async test', async () => {
  const result = await asyncFunction();
  expect(result).toBe('done');
});

Quick Reference

Tips for testing async code in Node.js:

• Use async keyword on test functions.
• Always await asynchronous calls or return promises.
• Use testing frameworks like Jest or Mocha that support async tests.
• Handle errors with try/catch or .catch() to avoid silent failures.
• Use done callback only if not using async/await.

Key Takeaways

Always use async/await or return promises in your test functions to properly wait for async code.

Testing frameworks like Jest and Mocha natively support async tests with async functions.

Avoid forgetting await or return, which causes tests to pass before async code finishes.

Handle errors in async tests to prevent silent failures.

Use the done callback only if not using async/await syntax.