I have this react query hook: import { useTranslation } from 'react-i18next'; import {…
- User
I have this react query hook:
import { useTranslation } from 'react-i18next';
import { getListCompetitionsAPI } from 'api/ManualActionsAPI'; import { activityLogHooks } from 'constants/ActivityLog'; import { BranchStatus } from 'models/BranchStatus'; import { Competition } from 'models/Competition'; import { pleaseTryAgainMessage } from 'utils/Context';
import { useQueryWrapper } from '../shared';
interface UseListCompetitionsInterface { result: Competition[]; status: BranchStatus; }
export const useListCompetitions = ( sportId: number, ): UseListCompetitionsInterface => { const { t } = useTranslation(); const { result, branchStatus: status } = useQueryWrapper< Competition[], number
( [activityLogHooks.listAudits, sportId], () => getListCompetitionsAPI(sportId), { meta: { errorMessage: pleaseTryAgainMessage(t, 'listing the competitions'), }, enabled: !!sportId, }, );
return { result, status }; };
This is the useQueryWrapper:
import { QueryFunction, QueryObserverResult, QueryStatus, RefetchOptions, RefetchQueryFilters, UseQueryOptions, useQuery, } from '@tanstack/react-query';
import { BranchStatus } from 'models/BranchStatus';
const queryStatusToBranchStatus: Record< QueryStatus | 'loading' | 'error' | 'success' | 'idle', BranchStatus
= { success: BranchStatus.FINISHED, loading: BranchStatus.LOADING, error: BranchStatus.ERROR, idle: BranchStatus.IDLE, };
interface UseQueryWrapperInterface { result: T; branchStatus: BranchStatus; refetch: ( options?: (RefetchOptions & RefetchQueryFilters) | undefined, ) => Promise; }
export const useQueryWrapper = <T, K>( key: string[] | [string, K], func: QueryFunction, opts?: UseQueryOptions, ): UseQueryWrapperInterface => { const { data, status, refetch } = useQuery(key, func, opts); const result = data as T; const branchStatus = queryStatusToBranchStatus[status]; return { result, branchStatus, refetch }; };
When running this unit test:
it('should handle fetch failure', async () => { (getListCompetitionsAPI as jest.Mock).mockImplementationOnce(() => Promise.reject('Error'), );
const { result } = renderHook(() => useListCompetitions(sportId), { wrapper: ({ children }) => ( <QueryClientProvider client={queryClient}> {children} </QueryClientProvider> ), }); await waitFor(() => { expect(getListCompetitionsAPI).toHaveBeenCalled(); expect(result.current.status).toBe('error'); });});
I get this error:
Expected: "error" Received: "loading"
- Assistant
The issue here is that the
waitForfunction is not waiting for the status to change from "loading" to "error". To fix this, you can use thewaitForfunction from the@testing-library/react-hookspackage to wait for the status change.Here's the updated test with
waitFor:import { renderHook, act, waitFor } from '@testing-library/react-hooks'; // ... other imports it('should handle fetch failure', async () => { (getListCompetitionsAPI as jest.Mock).mockImplementationOnce(() => Promise.reject('Error'), ); const { result, waitForNextUpdate } = renderHook(() => useListCompetitions(sportId), { wrapper: ({ children }) => ( <QueryClientProvider client={queryClient}> {children} </QueryClientProvider> ), }); // Trigger the side effect await act(async () => { await waitForNextUpdate(); }); // Now wait for the status to change await waitFor(() => { expect(result.current.status).toBe(BranchStatus.ERROR); }); // Check if getListCompetitionsAPI has been called expect(getListCompetitionsAPI).toHaveBeenCalled(); });In the updated test, we use the
waitForNextUpdatefunction from therenderHookto wait for the first update, which corresponds to the side effect. After that update, we usewaitForto wait for the result's current status to change to 'error'. This should resolve the issue and make the test pass.
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.