import * as React from 'react'
import {render, fireEvent, screen, waitFor, renderHook} from '.'
import * as pure from './pure'
export async function testRender() {
const view = render()
// single queries
view.getByText('foo')
view.queryByText('foo')
await view.findByText('foo')
// multiple queries
view.getAllByText('bar')
view.queryAllByText('bar')
await view.findAllByText('bar')
// helpers
const {container, rerender, debug} = view
expectType(container)
return {container, rerender, debug}
}
export async function testPureRender() {
const view = pure.render()
// single queries
view.getByText('foo')
view.queryByText('foo')
await view.findByText('foo')
// multiple queries
view.getAllByText('bar')
view.queryAllByText('bar')
await view.findAllByText('bar')
// helpers
const {container, rerender, debug} = view
expectType(container)
return {container, rerender, debug}
}
export function testRenderOptions() {
const container = document.createElement('div')
const options = {container}
const {container: returnedContainer} = render(, options)
expectType(returnedContainer)
render(, {wrapper: () => null})
}
export function testSVGRenderOptions() {
const container = document.createElementNS(
'http://www.w3.org/2000/svg',
'svg',
)
const options = {container}
const {container: returnedContainer} = render(, options)
expectType(returnedContainer)
}
export function testFireEvent() {
const {container} = render()
fireEvent.click(container)
}
export function testConfigure() {
// test for DTL's config
pure.configure({testIdAttribute: 'foobar'})
pure.configure(existingConfig => ({
testIdAttribute: `modified-${existingConfig.testIdAttribute}`,
}))
// test for RTL's config
pure.configure({reactStrictMode: true})
pure.configure(existingConfig => ({
reactStrictMode: !existingConfig.reactStrictMode,
}))
}
export function testGetConfig() {
// test for DTL's config
pure.getConfig().testIdAttribute
// test for RTL's config
pure.getConfig().reactStrictMode
}
export function testDebug() {
const {debug, getAllByTestId} = render(
<>
Hello World
Hello World
>,
)
debug(getAllByTestId('testid'))
}
export async function testScreen() {
render()
await screen.findByRole('button')
}
export async function testWaitFor() {
const {container} = render()
fireEvent.click(container)
await waitFor(() => {})
}
export function testQueries() {
const {getByLabelText} = render(
,
)
expectType>(
getByLabelText('Username'),
)
const container = document.createElement('div')
const options = {container}
const {getByText} = render(Hello World
, options)
expectType>(
getByText('Hello World'),
)
}
export function wrappedRender(
ui: React.ReactNode,
options?: pure.RenderOptions,
) {
const Wrapper = ({
children,
}: {
children: React.ReactNode
}): React.JSX.Element => {
return {children}
}
return pure.render(ui, {
wrapper: Wrapper,
// testing exactOptionalPropertyTypes comaptibility
hydrate: options?.hydrate,
...options,
})
}
export function wrappedRenderB(
ui: React.ReactNode,
options?: pure.RenderOptions,
) {
const Wrapper: React.FunctionComponent<{children?: React.ReactNode}> = ({
children,
}) => {
return {children}
}
return pure.render(ui, {wrapper: Wrapper, ...options})
}
export function wrappedRenderC(
ui: React.ReactNode,
options?: pure.RenderOptions,
) {
interface AppWrapperProps {
children?: React.ReactNode
userProviderProps?: {user: string}
}
const AppWrapperProps: React.FunctionComponent = ({
children,
userProviderProps = {user: 'TypeScript'},
}) => {
return {children}
}
return pure.render(ui, {wrapper: AppWrapperProps, ...options})
}
export function wrappedRenderHook(
hook: () => unknown,
options?: pure.RenderHookOptions,
) {
interface AppWrapperProps {
children?: React.ReactNode
userProviderProps?: {user: string}
}
const AppWrapperProps: React.FunctionComponent = ({
children,
userProviderProps = {user: 'TypeScript'},
}) => {
return {children}
}
return pure.renderHook(hook, {...options})
}
export function testBaseElement() {
const {baseElement: baseDefaultElement} = render()
expectType(baseDefaultElement)
const container = document.createElement('input')
const {baseElement: baseElementFromContainer} = render(, {container})
expectType(
baseElementFromContainer,
)
const baseElementOption = document.createElement('input')
const {baseElement: baseElementFromOption} = render(, {
baseElement: baseElementOption,
})
expectType(
baseElementFromOption,
)
}
export function testRenderHook() {
const {result, rerender, unmount} = renderHook(() => React.useState(2)[0])
expectType(result.current)
rerender()
unmount()
renderHook(() => null, {wrapper: () => null})
}
export function testRenderHookProps() {
const {result, rerender, unmount} = renderHook(
({defaultValue}) => React.useState(defaultValue)[0],
{initialProps: {defaultValue: 2}},
)
expectType(result.current)
rerender()
unmount()
}
export function testContainer() {
render('a', {container: document.createElement('div')})
render('a', {container: document.createDocumentFragment()})
// Only allowed in React 19
render('a', {container: document})
render('a', {container: document.createElement('div'), hydrate: true})
// Only allowed for createRoot but typing `render` appropriately makes it harder to compose.
render('a', {container: document.createDocumentFragment(), hydrate: true})
render('a', {container: document, hydrate: true})
renderHook(() => null, {container: document.createElement('div')})
renderHook(() => null, {container: document.createDocumentFragment()})
// Only allowed in React 19
renderHook(() => null, {container: document})
renderHook(() => null, {
container: document.createElement('div'),
hydrate: true,
})
// Only allowed for createRoot but typing `render` appropriately makes it harder to compose.
renderHook(() => null, {
container: document.createDocumentFragment(),
hydrate: true,
})
renderHook(() => null, {container: document, hydrate: true})
}
export function testErrorHandlers() {
// React 19 types are not used in tests. Verify manually if this works with `"@types/react": "npm:types-react@rc"`
render(null, {
// Should work with React 19 types
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
onCaughtError: () => {},
})
render(null, {
// Should never work as it's not supported yet.
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error
onUncaughtError: () => {},
})
render(null, {
onRecoverableError: (error, errorInfo) => {
console.error(error)
console.log(errorInfo.componentStack)
},
})
}
/*
eslint
testing-library/prefer-explicit-assert: "off",
testing-library/no-wait-for-empty-callback: "off",
testing-library/prefer-screen-queries: "off"
*/
// https://stackoverflow.com/questions/53807517/how-to-test-if-two-types-are-exactly-the-same
type IfEquals = (() => G extends T
? 1
: 2) extends () => G extends U ? 1 : 2
? Yes
: No
/**
* Issues a type error if `Expected` is not identical to `Actual`.
*
* `Expected` should be declared when invoking `expectType`.
* `Actual` should almost always we be a `typeof value` statement.
*
* Source: https://github.com/mui-org/material-ui/blob/6221876a4b468a3330ffaafa8472de7613933b87/packages/material-ui-types/index.d.ts#L73-L84
*
* @example `expectType(value)`
* TypeScript issues a type error since `value is not assignable to never`.
* This means `typeof value` is not identical to `number | string`
* @param actual
*/
declare function expectType(
actual: IfEquals,
): void