Skip to content

ci(react-query): update vitest/expect-expect rule as error #9110

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.

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
merged 2 commits into from
May 6, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
ci(react-query): update vitest/expect-expect rule as error
  • Loading branch information
manudeli committed May 6, 2025
commit 051f1044c13bc958562157ca9779d73f0bf800e2
8 changes: 0 additions & 8 deletions packages/react-query-devtools/eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// @ts-check

import vitest from '@vitest/eslint-plugin'
import pluginReact from '@eslint-react/eslint-plugin'
import pluginReactHooks from 'eslint-plugin-react-hooks'
import rootConfig from './root.eslint.config.js'
Expand All @@ -20,11 +19,4 @@ export default [
'react-hooks/rules-of-hooks': 'error',
},
},
{
plugins: { vitest },
rules: {
...vitest.configs.recommended.rules,
'vitest/expect-expect': 'warn',
},
},
]
8 changes: 0 additions & 8 deletions packages/react-query-next-experimental/eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// @ts-check

import vitest from '@vitest/eslint-plugin'
import pluginReact from '@eslint-react/eslint-plugin'
import pluginReactHooks from 'eslint-plugin-react-hooks'
import rootConfig from './root.eslint.config.js'
Expand All @@ -21,11 +20,4 @@ export default [
'react-hooks/rules-of-hooks': 'error',
},
},
{
plugins: { vitest },
rules: {
...vitest.configs.recommended.rules,
'vitest/expect-expect': 'warn',
},
},
]
8 changes: 0 additions & 8 deletions packages/react-query-persist-client/eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// @ts-check

import vitest from '@vitest/eslint-plugin'
import pluginReact from '@eslint-react/eslint-plugin'
import pluginReactHooks from 'eslint-plugin-react-hooks'
import rootConfig from './root.eslint.config.js'
Expand All @@ -20,11 +19,4 @@ export default [
'react-hooks/rules-of-hooks': 'error',
},
},
{
plugins: { vitest },
rules: {
...vitest.configs.recommended.rules,
'vitest/expect-expect': 'warn',
},
},
]
8 changes: 0 additions & 8 deletions packages/react-query/eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// @ts-check

import vitest from '@vitest/eslint-plugin'
import pluginReact from '@eslint-react/eslint-plugin'
// @ts-expect-error
import pluginReactCompiler from 'eslint-plugin-react-compiler'
Expand Down Expand Up @@ -32,11 +31,4 @@ export default [
'react-compiler/react-compiler': 'off',
},
},
{
plugins: { vitest },
rules: {
...vitest.configs.recommended.rules,
'vitest/expect-expect': 'warn',
},
},
]
116 changes: 87 additions & 29 deletions packages/react-query/src/__tests__/QueryResetErrorBoundary.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,17 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('data'))
await waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})

Expand Down Expand Up @@ -132,11 +138,17 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('status: error'))
await waitFor(() =>
expect(rendered.getByText('status: error')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})

Expand Down Expand Up @@ -198,11 +210,17 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('data'))
await waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})

Expand Down Expand Up @@ -259,10 +277,14 @@ describe('QueryErrorResetBoundary', () => {
)

await waitFor(() =>
rendered.getByText('status: pending, fetchStatus: idle'),
expect(
rendered.getByText('status: pending, fetchStatus: idle'),
).toBeInTheDocument(),
)
fireEvent.click(rendered.getByRole('button', { name: /refetch/i }))
await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})

Expand Down Expand Up @@ -316,11 +338,17 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})

Expand Down Expand Up @@ -376,11 +404,17 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('data'))
await waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})

Expand Down Expand Up @@ -440,11 +474,17 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
shouldReset = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
succeed = true
shouldReset = false
fireEvent.click(rendered.getByText('retry'))
Expand Down Expand Up @@ -651,11 +691,17 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('data'))
await waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})
})
Expand Down Expand Up @@ -715,11 +761,17 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('data'))
await waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})

Expand Down Expand Up @@ -779,11 +831,17 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('data'))
await waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})
})
Expand Down
44 changes: 27 additions & 17 deletions packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, expectTypeOf, it, test } from 'vitest'
import { assertType, describe, expectTypeOf, it, test } from 'vitest'
import { QueryClient, dataTagSymbol, skipToken } from '@tanstack/query-core'
import { infiniteQueryOptions } from '../infiniteQueryOptions'
import { useInfiniteQuery } from '../useInfiniteQuery'
Expand All @@ -12,14 +12,16 @@ import type {

describe('infiniteQueryOptions', () => {
it('should not allow excess properties', () => {
infiniteQueryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve('data'),
getNextPageParam: () => 1,
initialPageParam: 1,
// @ts-expect-error this is a good error, because stallTime does not exist!
stallTime: 1000,
})
assertType(
infiniteQueryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve('data'),
getNextPageParam: () => 1,
initialPageParam: 1,
// @ts-expect-error this is a good error, because stallTime does not exist!
stallTime: 1000,
}),
)
})
it('should infer types for callbacks', () => {
infiniteQueryOptions({
Expand Down Expand Up @@ -159,14 +161,22 @@ describe('infiniteQueryOptions', () => {
getNextPageParam: () => 1,
initialPageParam: 1,
})
// @ts-expect-error cannot pass infinite options to non-infinite query functions
useQuery(options)
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.ensureQueryData(options)
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.fetchQuery(options)
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.prefetchQuery(options)
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
useQuery(options),
)
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.ensureQueryData(options),
)
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.fetchQuery(options),
)
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.prefetchQuery(options),
)
})

test('allow optional initialData function', () => {
Expand Down
23 changes: 13 additions & 10 deletions packages/react-query/src/__tests__/queryOptions.test-d.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, expectTypeOf, it } from 'vitest'
import { assertType, describe, expectTypeOf, it } from 'vitest'
import {
QueriesObserver,
QueryClient,
Expand All @@ -18,12 +18,14 @@ import type {

describe('queryOptions', () => {
it('should not allow excess properties', () => {
queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// @ts-expect-error this is a good error, because stallTime does not exist!
stallTime: 1000,
})
assertType(
queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// @ts-expect-error this is a good error, because stallTime does not exist!
stallTime: 1000,
}),
)
})
it('should infer types for callbacks', () => {
queryOptions({
Expand Down Expand Up @@ -203,7 +205,7 @@ describe('queryOptions', () => {
})

it('should allow undefined response in initialData', () => {
return (id: string | null) =>
assertType((id: string | null) =>
queryOptions({
queryKey: ['todo', id],
queryFn: () =>
Expand All @@ -218,7 +220,8 @@ describe('queryOptions', () => {
id,
title: 'Initial Data',
},
})
}),
)
})

it('should allow optional initialData object', () => {
Expand Down Expand Up @@ -248,7 +251,7 @@ describe('queryOptions', () => {
queryFn: () => Promise.resolve(1),
})

somethingWithQueryOptions(options)
assertType(somethingWithQueryOptions(options))
})

it('should return a custom query key type', () => {
Expand Down
Loading
Loading