Skip to content

test(react-query-devtools): extract shared test setup into 'beforeEach' #11026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sukvvon merged 1 commit into from
Jul 4, 2026
+54 −154
Merged

test(react-query-devtools): extract shared test setup into 'beforeEach' #11026

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 29 additions & 80 deletions packages/react-query-devtools/src/__tests__/ReactQueryDevtools.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest'
import { render } from '@testing-library/react'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { TanstackQueryDevtools } from '@tanstack/query-devtools'
import type { ReactQueryDevtools as ReactQueryDevtoolsComponent } from '../ReactQueryDevtools'

const mountMock = vi.fn()
const unmountMock = vi.fn()
Expand All @@ -26,22 +27,22 @@ vi.mock('@tanstack/query-devtools', () => ({
}))

describe('ReactQueryDevtools', () => {
beforeEach(() => {
let ReactQueryDevtools: typeof ReactQueryDevtoolsComponent
let queryClient: QueryClient

beforeEach(async () => {
vi.clearAllMocks()
;({ ReactQueryDevtools } = await import('../ReactQueryDevtools'))
queryClient = new QueryClient()
})

it('should throw an error if no query client has been set', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')

it('should throw an error if no query client has been set', () => {
expect(() => render(<ReactQueryDevtools />)).toThrow(
'No QueryClient set, use QueryClientProvider to set one',
)
})

it('should not throw an error if query client is provided via context', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should not throw an error if query client is provided via context', () => {
expect(() =>
render(
<QueryClientProvider client={queryClient}>
Expand All @@ -52,57 +53,40 @@ describe('ReactQueryDevtools', () => {
expect(mountMock).toHaveBeenCalled()
})

it('should not throw an error if query client is provided via props', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should not throw an error if query client is provided via props', () => {
expect(() =>
render(<ReactQueryDevtools client={queryClient} />),
).not.toThrow()
expect(mountMock).toHaveBeenCalled()
})

it('should forward "buttonPosition" to the devtools instance', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward "buttonPosition" to the devtools instance', () => {
render(
<ReactQueryDevtools client={queryClient} buttonPosition="top-left" />,
)

expect(setButtonPositionMock).toHaveBeenCalledWith('top-left')
})

it('should forward "position" to the devtools instance', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward "position" to the devtools instance', () => {
render(<ReactQueryDevtools client={queryClient} position="left" />)

expect(setPositionMock).toHaveBeenCalledWith('left')
})

it('should forward "initialIsOpen" to the devtools instance', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward "initialIsOpen" to the devtools instance', () => {
render(<ReactQueryDevtools client={queryClient} initialIsOpen={true} />)

expect(setInitialIsOpenMock).toHaveBeenCalledWith(true)
})

it('should default "initialIsOpen" to "false" when the prop is omitted', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should default "initialIsOpen" to "false" when the prop is omitted', () => {
render(<ReactQueryDevtools client={queryClient} />)

expect(setInitialIsOpenMock).toHaveBeenCalledWith(false)
})

it('should forward "errorTypes" to the devtools instance', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()
it('should forward "errorTypes" to the devtools instance', () => {
const errorTypes = [
{ name: 'Network', initializer: () => new Error('Network') },
]
Expand All @@ -112,47 +96,33 @@ describe('ReactQueryDevtools', () => {
expect(setErrorTypesMock).toHaveBeenCalledWith(errorTypes)
})

it('should default "errorTypes" to an empty array when the prop is omitted', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should default "errorTypes" to an empty array when the prop is omitted', () => {
render(<ReactQueryDevtools client={queryClient} />)

expect(setErrorTypesMock).toHaveBeenCalledWith([])
})

it('should forward "theme" to the devtools instance', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward "theme" to the devtools instance', () => {
render(<ReactQueryDevtools client={queryClient} theme="dark" />)

expect(setThemeMock).toHaveBeenCalledWith('dark')
})

it('should forward the resolved "QueryClient" via "setClient"', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward the resolved "QueryClient" via "setClient"', () => {
render(<ReactQueryDevtools client={queryClient} />)

expect(setClientMock).toHaveBeenCalledWith(queryClient)
})

it('should forward "styleNonce" to the devtools constructor', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward "styleNonce" to the devtools constructor', () => {
render(<ReactQueryDevtools client={queryClient} styleNonce="abc" />)

expect(TanstackQueryDevtools).toHaveBeenCalledWith(
expect.objectContaining({ styleNonce: 'abc' }),
)
})

it('should forward "shadowDOMTarget" to the devtools constructor', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()
it('should forward "shadowDOMTarget" to the devtools constructor', () => {
const shadowDOMTarget = document
.createElement('div')
.attachShadow({ mode: 'open' })
Expand All @@ -169,10 +139,7 @@ describe('ReactQueryDevtools', () => {
)
})

it('should forward "hideDisabledQueries" to the devtools constructor', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward "hideDisabledQueries" to the devtools constructor', () => {
render(
<ReactQueryDevtools client={queryClient} hideDisabledQueries={true} />,
)
Expand All @@ -182,10 +149,7 @@ describe('ReactQueryDevtools', () => {
)
})

it('should forward a "buttonPosition" change to the devtools instance after mount', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward a "buttonPosition" change to the devtools instance after mount', () => {
const { rerender } = render(
<ReactQueryDevtools client={queryClient} buttonPosition="bottom-right" />,
)
Expand All @@ -198,10 +162,7 @@ describe('ReactQueryDevtools', () => {
expect(setButtonPositionMock).toHaveBeenCalledWith('top-left')
})

it('should forward a "position" change to the devtools instance after mount', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward a "position" change to the devtools instance after mount', () => {
const { rerender } = render(
<ReactQueryDevtools client={queryClient} position="bottom" />,
)
Expand All @@ -212,10 +173,7 @@ describe('ReactQueryDevtools', () => {
expect(setPositionMock).toHaveBeenCalledWith('top')
})

it('should forward an "initialIsOpen" change to the devtools instance after mount', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward an "initialIsOpen" change to the devtools instance after mount', () => {
const { rerender } = render(
<ReactQueryDevtools client={queryClient} initialIsOpen={false} />,
)
Expand All @@ -226,10 +184,7 @@ describe('ReactQueryDevtools', () => {
expect(setInitialIsOpenMock).toHaveBeenCalledWith(true)
})

it('should forward an "errorTypes" change to the devtools instance after mount', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward an "errorTypes" change to the devtools instance after mount', () => {
const { rerender } = render(
<ReactQueryDevtools client={queryClient} errorTypes={[]} />,
)
Expand All @@ -245,10 +200,7 @@ describe('ReactQueryDevtools', () => {
expect(setErrorTypesMock).toHaveBeenCalledWith(errorTypes)
})

it('should forward a "theme" change to the devtools instance after mount', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should forward a "theme" change to the devtools instance after mount', () => {
const { rerender } = render(
<ReactQueryDevtools client={queryClient} theme="light" />,
)
Expand All @@ -259,10 +211,7 @@ describe('ReactQueryDevtools', () => {
expect(setThemeMock).toHaveBeenCalledWith('dark')
})

it('should call "unmount" on the devtools instance when the component unmounts', async () => {
const { ReactQueryDevtools } = await import('../ReactQueryDevtools')
const queryClient = new QueryClient()

it('should call "unmount" on the devtools instance when the component unmounts', () => {
const { unmount } = render(<ReactQueryDevtools client={queryClient} />)
unmount()

Expand All @@ -274,8 +223,8 @@ describe('ReactQueryDevtools', () => {
vi.resetModules()

try {
const { ReactQueryDevtools } = await import('..')
expect(ReactQueryDevtools({})).toBeNull()
const { ReactQueryDevtools: ProductionDevtools } = await import('..')
expect(ProductionDevtools({})).toBeNull()
} finally {
vi.unstubAllEnvs()
vi.resetModules()
Expand Down
Loading
Loading