2021年React中如何使用jsdom测试图片onload和onerror事件?
问题描述
我使用react-testing-lib进行测试,项目中有一个全局通用的图片组件,我尝试在CRA默认构建的测试环境下搭配jsdom测试该组件,发现实现难度较高,我查阅了部分资料。
我已经将jest(26.6.0)和jsdom(16.6.0)升级到最新版本,也尝试过使用canvas、jest-canvas-mock库。
以下是我的示例代码:
Image.js
import { useState } from "react"; export default function Image({ src = "" }) { const [status,setStatus] = useState("Loading") const handleOnLoad = () => { setStatus("handleOnLoad"); }; const handleOnError = () => { setStatus("handleOnError"); }; return ( <div> {status} <img alt={status} width="50" src={src} onLoad={handleOnLoad} onError={handleOnError} /> </div> ); }
Image.test.js
import { render, screen } from "@testing-library/react"; import "@testing-library/jest-dom/extend-expect"; import "jest-canvas-mock"; import Image from "./Image"; describe('Test', () => { it("Image shouldss render correctly", async () => { render(<Image src="LOAD_SUCCESS_SRC" />); await screen.findByText(/handleOnLoad/i); }); })
但最终jsdom无法触发对应的事件。相关说明提到:
当浏览器被配置为不加载图片时不会触发load事件。jsdom默认配置为不加载任何外部资源,因此遵循浏览器的这一行为,图片和其他不加载的资源(如视频、音频、link rel=preload等)表现一致。
解决方案
你可以通过以下两种常用方案解决该问题:
方案1:手动触发img事件(推荐,测试稳定无额外依赖)
无需修改业务组件,仅调整测试用例,通过@testing-library/react提供的fireEvent手动触发load/error事件即可完成测试,修改后的测试代码如下:
import { render, screen, fireEvent } from "@testing-library/react"; import "@testing-library/jest-dom/extend-expect"; import Image from "./Image"; describe('Image组件测试', () => { // 测试图片加载成功场景 it("图片加载成功时正常触发onLoad回调", async () => { render(<Image src="test-src" />); const imgElement = screen.getByRole('img'); // 手动触发load事件 fireEvent.load(imgElement); expect(await screen.findByText(/handleOnLoad/i)).toBeInTheDocument(); }); // 测试图片加载失败场景 it("图片加载失败时正常触发onError回调", async () => { render(<Image src="test-src" />); const imgElement = screen.getByRole('img'); // 手动触发error事件 fireEvent.error(imgElement); expect(await screen.findByText(/handleOnError/i)).toBeInTheDocument(); }); })
方案2:配置jsdom允许加载图片资源(不推荐)
你也可以在jest配置中开启jsdom的资源加载权限,但该方案会发起真实网络请求,容易导致测试不稳定、执行耗时变长,仅在必须真实加载资源的特殊场景使用。
内容的提问来源于stack exchange,提问作者Mifas
相关产品推荐
相关产品推荐

