import {Component} from 'react'; import type {InjectedRouter} from 'react-router'; import {cache} from '@emotion/css'; // eslint-disable-line @emotion/no-vanilla import {CacheProvider, ThemeProvider} from '@emotion/react'; import * as rtl from '@testing-library/react'; // eslint-disable-line no-restricted-imports import userEvent from '@testing-library/user-event'; // eslint-disable-line no-restricted-imports import {makeTestQueryClient} from 'sentry-test/queryClient'; import GlobalModal from 'sentry/components/globalModal'; import type {Organization} from 'sentry/types/organization'; import {QueryClientProvider} from 'sentry/utils/queryClient'; import {lightTheme} from 'sentry/utils/theme'; import {OrganizationContext} from 'sentry/views/organizationContext'; import {RouteContext} from 'sentry/views/routeContext'; import {instrumentUserEvent} from '../instrumentedEnv/userEventIntegration'; import {initializeOrg} from './initializeOrg'; type ProviderOptions = { /** * Sets legacy context providers. This value is directly passed to a * `getChildContext`. */ context?: Record; /** * Sets the OrganizationContext. You may pass null to provide no organization */ organization?: Partial | null; /** * Sets the RouterContext */ router?: Partial; }; type Options = ProviderOptions & rtl.RenderOptions; function createProvider(contextDefs: Record) { return class ContextProvider extends Component<{children?: React.ReactNode}> { static childContextTypes = contextDefs.childContextTypes; getChildContext() { return contextDefs.context; } render() { return this.props.children; } }; } function makeAllTheProviders({context, ...initializeOrgOptions}: ProviderOptions) { const {organization, router, routerContext} = initializeOrg( initializeOrgOptions as any ); const ContextProvider = context ? createProvider(context) : createProvider(routerContext); // In some cases we may want to not provide an organization at all const optionalOrganization = initializeOrgOptions.organization === null ? null : organization; return function ({children}: {children?: React.ReactNode}) { return ( {children} ); }; } /** * Try avoiding unnecessary context and just mount your component. If it works, * then you dont need anything else. * * render(); * * If your component requires routerContext or organization to render, pass it * via context options argument. render(, {context: * routerContext, organization}); */ function render(ui: React.ReactElement, options?: Options) { options = options ?? {}; const {context, organization, ...otherOptions} = options; let {router} = options; if (router === undefined && context?.context?.router) { router = context.context.router; } const AllTheProviders = makeAllTheProviders({ context, organization, router, }); return rtl.render(ui, {wrapper: AllTheProviders, ...otherOptions}); } /** * @deprecated * Use userEvent over fireEvent where possible. * More details: https://kentcdodds.com/blog/common-mistakes-with-react-testing-library#not-using-testing-libraryuser-event */ const fireEvent = rtl.fireEvent; function renderGlobalModal(options?: Options) { const result = render(, options); /** * Helper that waits for the modal to be removed from the DOM. You may need to * wait for the modal to be removed to avoid any act warnings. */ function waitForModalToHide() { return rtl.waitFor(() => { expect(rtl.screen.queryByRole('dialog')).not.toBeInTheDocument(); }); } return {...result, waitForModalToHide}; } /** * This cannot be implemented as a Sentry Integration because Jest creates an * isolated environment for each test suite. This means that if we were to apply * the monkey patching ahead of time, it would be shadowed by Jest. */ instrumentUserEvent(); // eslint-disable-next-line no-restricted-imports, import/export export * from '@testing-library/react'; // eslint-disable-next-line import/export export {render, renderGlobalModal, userEvent, fireEvent};