测试 Testing
React Query 是通过 hook 工作的——要么是我们提供的 hook,要么是围绕它们定制的 hook。
在 React v17 或更早的版本中,如果需要为这些自定义 hook 编写单元测试,你可以通过React Hooks Testing Library库来完成。
通过运行以下命令进行安装:
1npm install @testing-library/react-hooks react-test-renderer --save-dev(react-test-renderer 是 @testing-library/react-hooks 的对等依赖项,并且需要与你使用的 React 版本相对应。)
注意:当使用 React v18 或更高版本时,
render-hook可以直接通过@testing-library/react包使用,不再需要@testing-library/react-hooks
我们的第一个测试
一旦安装,就可以编写一个简单的测试。给定下面的自定义钩子:
1export function useCustomHook() {2 return useQuery({ queryKey: ["customHook"], queryFn: () => "Hello" });3}在 React v17 之前的版本,我们可以为此编写一个如下的测试:
1const queryClient = new QueryClient();2const wrapper = ({ children }) => (3 <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>4);5 6const { result, waitFor } = renderHook(() => useCustomHook(), { wrapper });7 8await waitFor(() => result.current.isSuccess);9 10expect(result.current.data).toEqual("Hello");在 React v18 之后的版本,waitFor 的语义发生了变化,上面的测试需要做一定的修改:
1import { renderHook, waitFor } from "@testing-library/react";2 3...4 5const { result } = renderHook(() => useCustomHook(), { wrapper });6 7await waitFor(() => expect(result.current.isSuccess).toBe(true));注意,我们提供了一个自定义包装器,用于构建 QueryClient 和 QueryClientProvider。这有助于确保我们的测试与任何其他测试完全隔离。
该包装器可以只编写一次。但是这样的话,在每次测试之前,我们都需要清除 QueryClient;并且测试没法并行运行,否则一个测试会影响其他测试的结果。
关闭重试机制
React Query 底层默认以指数回退的形式重试三次,这也意味着要处理应该错误的测试时有可能会遇到超时等意外情况。
关闭重试机制的最简单的方法是通过QueryClientProvider。让我们对上面的示例进行简单的扩展:
1const queryClient = new QueryClient({2 defaultOptions: {3 queries: {4 // ✅ turns retries off5 retry: false,6 },7 },8});9const wrapper = ({ children }) => (10 <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>11);这将使组件树中的所有查询都变为"无重试"的。
当然,在useQuery显示的启用了重试时,那个重试的优先级最高,而不会被该设置覆盖掉。
例如你设置了一个需要 5 次重试的查询,重试会正常生效,因为默认的全局配置只是作为 fallback 而存在。
关闭关于网络的错误日志
在测试时,通常我们会关闭关于网络错误的日志(文件/Console)。
为此,我们可以传递一个自定义的日志记录器给 QueryClient:
1// 在你测试之前,设置它2import { QueryClient } from "@tanstack/react-query";3 4const queryClient = new QueryClient({5 logger: {6 log: console.log,7 warn: console.warn,8 // ✅ console 里没有错误记录了9 error: process.env.NODE_ENV === "test" ? () => {} : console.error,10 },11});在 Jest 中将 cacheTime 设置为 Infinity
默认情况下,cacheTime 设置为 5 分钟。这意味着缓存的 GC 计时器会每 5 分钟触发一次。
如果使用 Jest,可以将 cacheTime 设置为 Infinity,以防止出现“Jest did not exit one second after the test run completed”的错误消息。
测试网络调用
React Query 的主要用途是缓存网络请求,因此,必须测试我们的代码是否在第一时间发出了正确的网络请求。
有很多方法可以用来测试,但是对于这个例子,我们将使用 nock。
给定下面的自定义钩子:
1function useFetchData() {2 return useQuery({3 queryKey: ["fetchData"],4 queryFn: () => request("/api/data"),5 });6}我们可以为此编写一个测试,如下所示:
1const queryClient = new QueryClient();2const wrapper = ({ children }) => (3 <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>4);5 6const expectation = nock("http://example.com").get("/api/data").reply(200, {7 answer: 42,8});9 10const { result, waitFor } = renderHook(() => useFetchData(), { wrapper });11 12await waitFor(() => {13 return result.current.isSuccess;14});15 16expect(result.current.data).toEqual({ answer: 42 });在这里,我们使用 waitFor 来进行等待动作,直到查询状态表明请求已成功。
这样我们就知道 hook 已经完成并且应该具有正确的数据。注意:当使用 React v18 时,waitFor的语义已经改变,具体细节请参考上一个测试。
测试 加载更多/无限滚动
首先,我们需要模拟我们的 API 响应
1function generateMockedResponse(page) {2 return {3 page: page,4 items: [...]5 }6}然后,我们的 nock 配置需要根据页面区分响应,我们将使用 uri 来做到这一点。
uri 的值在这里将是类似 "/?page=1 或 /?page=2 这种。
1const expectation = nock("http://example.com")2 .persist()3 .query(true)4 .get("/api/data")5 .reply(200, (uri) => {6 const url = new URL(`http://example.com${uri}`);7 const { page } = Object.fromEntries(url.searchParams);8 return generateMockedResponse(page);9 });(请注意 .persist(),因为我们将多次调用这个接口)
现在我们可以安全地运行我们的测试了,这里的技巧是在调用 fetchNextPage() 之后等待 isFetching 和 !isFetching :
1const { result, waitFor } = renderHook(() => useInfiniteQueryCustomHook(), {2 wrapper,3});4 5await waitFor(() => result.current.isSuccess);6 7expect(result.current.data.pages).toStrictEqual(generateMockedResponse(1));8 9result.current.fetchNextPage();10 11await waitFor(() =>12 expect(result.current.data.pages).toStrictEqual([13 ...generateMockedResponse(1),14 ...generateMockedResponse(2),15 ])16);17 18expectation.done();注意:当使用 React v18 时,waitFor的语义已经改变,具体细节请参考上上一个测试。
延伸阅读
有关如何通过mock-service-worker的相关设置来进行测试,请参阅此社区资源