Jest测试中状态更新不影响UI时如何避免not wrapped in act(...)警告
在使用Jest配合@testing-library/react v11.2.2编写组件测试时,会遇到「not wrapped in act(...)」警告。尤其当异步触发的状态更新执行后,组件UI没有任何可感知的变化、没有可以用来做等待的断言时,会疑惑该怎么处理这类警告,甚至不确定能不能直接忽略。
示例业务组件
import React, {useEffect, useState} from 'react'; import {getData} from 'services'; const MyComponent = () => { const [arr, setArr] = useState([]); useEffect(() => { (async () => { const {items} = await getData(); setArr(items); })(); }, []); return ( <div> {!(arr.length > 0) && <p>no array items</p>} {arr.length > 0 && ( <ul> {arr.map(item => ( <li key={item.id}>{item.name}</li> ))} </ul> )} </div> ); }; export default MyComponent;
触发警告的测试用例
测试目标是验证:当getData()返回空数组时,组件可以正常渲染「no array items」提示。
import React from 'react'; import {getData} from 'services'; import {render, screen} from 'testUtils'; import MyComponent from './MyComponent'; jest.mock('services', () => ({ getData: jest.fn(), })); it('renders', () => { getData.mockResolvedValue({items: []}); render(<MyComponent />); expect(screen.getByText('no array items')).toBeInTheDocument(); });
这个测试可以正常通过,但会触发act警告:测试执行完成时,异步的getData()还没resolve,后续的setArr(items)状态更新发生在测试作用域之外,没有被act方法包裹。
场景特殊性
- 这个案例里,
getData()返回的空数组和组件初始的arr状态完全一致,异步流程走完后,因为state没有变化,React会跳过重渲染,UI始终保持「no array items」的状态,没有可以用来等待状态更新完成的UI变化断言。 - 单纯写
expect(getData).toHaveBeenCalledTimes(1)只能验证请求函数被调用,没法覆盖调用完成后的状态更新环节,没法消除警告。 - 之前尝试的「手动加2秒setTimeout等待setArr执行」的写法也没有效果,警告依旧存在。
核心诉求
有没有办法仅通过修改测试用例消除这个警告,完全不需要为了适配测试修改业务组件代码(比如把请求逻辑上移、添加测试专用跳过逻辑、把内部state改成prop传入这类重构)。
可行的解决方案
完全不需要修改业务组件,针对你使用的@testing-library/react v11.2.2版本,用框架自带的waitFor工具就可以彻底消除警告:
- 把测试方法声明为async异步函数
- 用
waitFor包裹对getData调用的断言。waitFor会自动清空微任务队列,拦截队列中排队的setArr状态更新,自动把这些更新纳入act的包裹范围——哪怕这些更新因为state值和之前完全一致、不会触发UI重渲染,也不会触发act警告。
示例修正后的测试代码:
import {render, screen, waitFor} from 'testUtils'; it('renders', async () => { getData.mockResolvedValue({items: []}); render(<MyComponent />); expect(screen.getByText('no array items')).toBeInTheDocument(); // 等待所有排队的异步状态更新执行完成 await waitFor(() => { expect(getData).toHaveBeenCalledTimes(1); }); });
为什么之前的手动setTimeout无效
Promise的then回调、setArr这类状态更新逻辑是在微任务队列执行的,而手动写的setTimeout回调属于宏任务队列,两者执行优先级不同:就算你等2秒,测试里的setTimeout回调本身没有被act包裹,根本没法拦截到之前已经排队的状态更新,自然消不掉警告。
不建议直接忽略这个警告
这个提示本质是在提醒你:测试没有完整覆盖组件的所有异步执行时机。哪怕当前场景下的状态更新不会改变UI,后续如果业务逻辑调整(比如getData返回非空数据、空返回时也会触发其他副作用),你很可能因为漏掉这个等待环节,写出不稳定、容易随机失败的测试用例。
内容的提问来源于stack exchange,提问作者cjl750

