Провайдеры и кастомный render: контекст, роутер, стор
На этой странице
Реальные компоненты зависят от окружения: QueryClient, роутер, тема, i18n, стор, авторизация, feature flags. Вместо того чтобы в каждом тесте вручную собирать дерево провайдеров (или мокать хуки), создают кастомную функцию renderWithProviders, которая оборачивает компонент во все настоящие провайдеры с тестовыми настройками и позволяет переопределить нужное: начальное состояние стора, текущего пользователя, URL, флаги. Важные правила: новый QueryClient на каждый тест с retry: false (иначе кэш протекает между тестами, а ошибки ждут ретраев), новый стор на каждый тест (не синглтон модуля), memory-роутер с нужным начальным URL. Функцию экспортируют из test/utils.tsx вместе с реэкспортом всего из RTL — тесты импортируют render оттуда. Так тесты остаются интеграционными (настоящие провайдеры), но короткими.
Вопрос
Как тестировать компоненты, которым нужны контекст, роутер, QueryClient или стор? Что такое кастомный render?
Кастомный render
// src/test/utils.tsx
import { render, type RenderOptions } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { createMemoryRouter, RouterProvider } from "react-router";
import { ThemeProvider } from "@/shared/ui/theme";
import { I18nProvider } from "@/shared/i18n";
import { SessionContext, type Session } from "@/shared/session";
import { FlagsProvider, type Flags } from "@/shared/flags";
type Options = Omit<RenderOptions, "wrapper"> & {
session?: Session | null;
flags?: Partial<Flags>;
route?: string;
};
export function createTestQueryClient() {
return new QueryClient({
defaultOptions: {
queries: { retry: false, gcTime: Infinity, staleTime: Infinity },
mutations: { retry: false },
},
});
}
export function renderWithProviders(ui: React.ReactElement, { session = testUser, flags = {}, route = "/", ...options }: Options = {}) {
const queryClient = createTestQueryClient();
const router = createMemoryRouter([{ path: "*", element: ui }], { initialEntries: [route] });
const result = render(
<QueryClientProvider client={queryClient}>
<SessionContext value={session}>
<FlagsProvider value={{ ...defaultFlags, ...flags }}>
<I18nProvider locale="ru">
<ThemeProvider theme="light">
<RouterProvider router={router} />
</ThemeProvider>
</I18nProvider>
</FlagsProvider>
</SessionContext>
</QueryClientProvider>,
options,
);
return { ...result, user: userEvent.setup(), queryClient, router };
}
export * from "@testing-library/react";// Тест
import { renderWithProviders, screen } from "@/test/utils";
it("гостю показывает кнопку входа вместо корзины", () => {
renderWithProviders(<Header />, { session: null });
expect(screen.getByRole("link", { name: "Войти" })).toBeInTheDocument();
});
it("новый чекаут за флагом", () => {
renderWithProviders(<CheckoutButton />, { flags: { newCheckout: true } });
expect(screen.getByRole("button", { name: "Оформить в 1 клик" })).toBeInTheDocument();
});Почему новый QueryClient на каждый тест
| Проблема с общим клиентом | Последствие |
|---|---|
| Кэш остаётся после теста | Следующий тест получает чужие данные, порядок тестов влияет на результат |
retry: 3 по умолчанию | Тест ошибки ждёт ретраев с задержками и падает по таймауту |
gcTime таймеры | «Открытые хэндлы» после завершения тестов |
Стор: настоящий, но свежий
// Zustand: фабрика стора вместо синглтона — легко создать новый в тесте
export const createCartStore = (initial: Partial<CartState> = {}) =>
createStore<CartState>()((set) => ({ items: [], ...initial, add: (item) => set((s) => ({ items: [...s.items, item] })) }));it("показывает число товаров из стора", () => {
const store = createCartStore({ items: [item, item] });
render(<CartStoreProvider store={store}><CartBadge /></CartStoreProvider>);
expect(screen.getByRole("status", { name: "Товаров в корзине" })).toHaveTextContent("2");
});Для глобального Zustand-стора без провайдера сбрасывай состояние в afterEach (useCartStore.setState(initialState, true)). Для Redux Toolkit — setupStore(preloadedState) в кастомном render.
Роутер
it("после сохранения переходит на страницу заказа", async () => {
const { user, router } = renderWithProviders(<NewOrderForm />, { route: "/orders/new" });
await user.click(screen.getByRole("button", { name: "Создать" }));
await waitFor(() => expect(router.state.location.pathname).toBe("/orders/42"));
});Лучше проверять то, что видит пользователь после перехода (заголовок новой страницы), если тест рендерит несколько маршрутов. В Next.js хуки next/navigation в Vitest мокают (см. урок про моки) или используют next-router-mock.
Не мокай свой контекст
// ✗ Мок хука — тест не проверяет, что провайдер и потребитель совместимы
vi.mock("@/shared/session", () => ({ useSession: () => ({ user: testUser }) }));
// ✓ Настоящий провайдер с тестовым значением
renderWithProviders(<Header />, { session: { user: testUser } });Тестирование самого провайдера/контекста
it("ThemeProvider переключает тему для потребителей", async () => {
const user = userEvent.setup();
render(
<ThemeProvider defaultTheme="light">
<ThemeToggle />
<ThemeName /> {/* тестовый потребитель: <p>Тема: {theme}</p> */}
</ThemeProvider>,
);
await user.click(screen.getByRole("button", { name: "Сменить тему" }));
expect(screen.getByText("Тема: dark")).toBeInTheDocument();
});
it("useTheme вне провайдера бросает понятную ошибку", () => {
vi.spyOn(console, "error").mockImplementation(() => {});
expect(() => renderHook(() => useTheme())).toThrow(/ThemeProvider/);
});Что важно помнить
- Один
renderWithProvidersсо всеми настоящими провайдерами и опциями-переопределениями. - Новый QueryClient (
retry: false) и новый стор на каждый тест. - Memory-роутер с начальным URL.
- Не мокай свои хуки контекста — передавай значения через провайдеры.
- Экспортируй всё из RTL через
test/utils— один импорт в тестах.
Мини-шпаргалка
renderWithProviders(ui, { session, flags, route }).new QueryClient({ defaultOptions: { queries: { retry: false } } }).- Фабрика стора:
createCartStore(initial). createMemoryRouter(routes, { initialEntries: [route] }).