When to use act() in jest unit tests with react-dom

Question

According to the react unit testing documentation:

act()

To prepare a component for assertions, wrap the code rendering it and performing updates inside an act() call. This makes your test run closer to how React works in the browser.

But the test runs perfectly fine in both cases:

Without act()

it('Should return some text', () => {
  render(<TestComponent />, container);
  expect(container.textContent).toBe('some text');
});

With act()

it('Should return some text', () => {
  act(() => {
    render(<TestComponent />, container);
  });

  expect(container.textContent).toBe('some text');
})

The questions is: What exactly act() does, and when should someone use it?

score 36 · Accepted Answer · answered Feb 11 '20 at 09:26

36

From the act() docs:

When writing UI tests, tasks like rendering, user events, or data fetching can be considered as “units” of interaction with a user interface. React provides a helper called act() that makes sure all updates related to these “units” have been processed and applied to the DOM before you make any assertions

Further reading and examples: https://github.com/mrdulin/react-act-examples/blob/master/sync.md

answered Feb 11 '20 at 09:26

Lin Du

88,126
95
281
483

1

Why this piece of text is not already in the [`act()` documentation](https://reactjs.org/docs/test-utils.html#act)? – Mohammad Dehghan Aug 29 '22 at 12:23
1

Unfortunately the content of the link seems to be outdated. Most examples don't work anymore / work differently now. ( Details: Where the author claim `act` is needed, it's actually not needed. Where the author claims xxx will help, it doesn't) – DarkTrick Nov 19 '22 at 02:51
@lin-du is there anything in your forked repo that wasn't in the original one? https://github.com/threepointone/react-act-examples/blob/master/sync.md – Francesc Rosas Apr 21 '23 at 18:38
Would you say that act() waits for the useEffect to complete itself before applying the expect()? – mac Jul 21 '23 at 11:15

score 17 · Answer 2 · answered Aug 25 '21 at 19:37

In simple terms:

ReactTestUtil's act() makes sure that anything that might take time - rendering, user events, data fetching - within it is completed before test assertions are run.

act(() => {
    // render components
    });
    // make assertions

If you're using a library like React Testing Library, then things like the render function are already wrapped in act(), and you generally will not need to use it explicitly.

Note that React Testing Library does have it's own act() function, which is simply a wrapper for ReactTestUtil's act(). This may be useful in asynchronous state updates, though other React Testing Library tools like waitFor may be better.

If you have async code inside it you need to add `await act(async () => {` — Fernando, Oct 06 '21 at 14:01

score 3 · Answer 3 · edited Aug 11 '22 at 02:53

3

Basically, act() is used to simulate like react actually works. But if you use render from @testing-library/react, it comes with act() implicitly. You can read more about it in the documentation.

edited Aug 11 '22 at 02:53

BSMP

4,596
8
33
44

answered Jun 20 '21 at 16:58

Nicolás Garcés

39
1

When to use act() in jest unit tests with react-dom

Without act()

With act()

3 Answers3

Linked