Skip to content

Commit bd4c8d1

Browse files
authored
test(react-query): resolve ESLint typescript-eslint/require-await warnings (#8888)
1 parent 517c490 commit bd4c8d1

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

packages/react-query/src/__tests__/useQuery.test.tsx

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ describe('useQuery', () => {
6464
// it should provide the result type in the configuration
6565
useQuery({
6666
queryKey: [key],
67-
queryFn: async () => true,
67+
queryFn: () => Promise.resolve(true),
6868
})
6969

7070
// it should be possible to specify a union type as result type
@@ -109,22 +109,20 @@ describe('useQuery', () => {
109109
type MyData = number
110110
type MyQueryKey = readonly ['my-data', number]
111111

112-
const getMyDataArrayKey: QueryFunction<MyData, MyQueryKey> = async ({
112+
const getMyDataArrayKey: QueryFunction<MyData, MyQueryKey> = ({
113113
queryKey: [, n],
114114
}) => {
115-
return n + 42
115+
return Promise.resolve(n + 42)
116116
}
117117

118118
useQuery({
119119
queryKey: ['my-data', 100],
120120
queryFn: getMyDataArrayKey,
121121
})
122122

123-
const getMyDataStringKey: QueryFunction<MyData, ['1']> = async (
124-
context,
125-
) => {
123+
const getMyDataStringKey: QueryFunction<MyData, ['1']> = (context) => {
126124
expectTypeOf(context.queryKey).toEqualTypeOf<['1']>()
127-
return Number(context.queryKey[0]) + 42
125+
return Promise.resolve(Number(context.queryKey[0]) + 42)
128126
}
129127

130128
useQuery({
@@ -161,7 +159,7 @@ describe('useQuery', () => {
161159
queryFn: () => fetcher(qk[1], 'token'),
162160
...options,
163161
})
164-
const testQuery = useWrappedQuery([''], async () => '1')
162+
const testQuery = useWrappedQuery([''], () => Promise.resolve('1'))
165163
expectTypeOf(testQuery.data).toEqualTypeOf<string | undefined>()
166164

167165
// handles wrapped queries with custom fetcher passed directly to useQuery
@@ -178,7 +176,9 @@ describe('useQuery', () => {
178176
'queryKey' | 'queryFn' | 'initialData'
179177
>,
180178
) => useQuery({ queryKey: qk, queryFn: fetcher, ...options })
181-
const testFuncStyle = useWrappedFuncStyleQuery([''], async () => true)
179+
const testFuncStyle = useWrappedFuncStyleQuery([''], () =>
180+
Promise.resolve(true),
181+
)
182182
expectTypeOf(testFuncStyle.data).toEqualTypeOf<boolean | undefined>()
183183
}
184184
})
@@ -2487,7 +2487,7 @@ describe('useQuery', () => {
24872487
})
24882488

24892489
// See https://github.com/tannerlinsley/react-query/issues/137
2490-
it('should not override initial data in dependent queries', async () => {
2490+
it('should not override initial data in dependent queries', () => {
24912491
const key1 = queryKey()
24922492
const key2 = queryKey()
24932493

@@ -2524,7 +2524,7 @@ describe('useQuery', () => {
25242524
rendered.getByText('Second Status: success')
25252525
})
25262526

2527-
it('should update query options', async () => {
2527+
it('should update query options', () => {
25282528
const key = queryKey()
25292529

25302530
const queryFn = async () => {
@@ -3777,12 +3777,12 @@ describe('useQuery', () => {
37773777
function Page() {
37783778
const query = useQuery({
37793779
queryKey: key,
3780-
queryFn: async () => {
3780+
queryFn: () => {
37813781
if (counter < 2) {
37823782
counter++
3783-
throw new Error('error')
3783+
return Promise.reject(new Error('error'))
37843784
} else {
3785-
return 'data'
3785+
return Promise.resolve('data')
37863786
}
37873787
},
37883788
retryDelay: 10,
@@ -3955,9 +3955,11 @@ describe('useQuery', () => {
39553955
const [filter, setFilter] = React.useState('')
39563956
const { data: todos } = useQuery({
39573957
queryKey: [...key, filter],
3958-
queryFn: async () => {
3959-
return ALL_TODOS.filter((todo) =>
3960-
filter ? todo.priority === filter : true,
3958+
queryFn: () => {
3959+
return Promise.resolve(
3960+
ALL_TODOS.filter((todo) =>
3961+
filter ? todo.priority === filter : true,
3962+
),
39613963
)
39623964
},
39633965
initialData() {
@@ -4047,7 +4049,7 @@ describe('useQuery', () => {
40474049
expect(results[2]).toMatchObject({ data: 'fetched data', isStale: false })
40484050
})
40494051

4050-
it('should support enabled:false in query object syntax', async () => {
4052+
it('should support enabled:false in query object syntax', () => {
40514053
const key = queryKey()
40524054
const queryFn = vi.fn<(...args: Array<unknown>) => string>()
40534055
queryFn.mockImplementation(() => 'data')
@@ -6025,7 +6027,7 @@ describe('useQuery', () => {
60256027
describe('subscribed', () => {
60266028
it('should be able to toggle subscribed', async () => {
60276029
const key = queryKey()
6028-
const queryFn = vi.fn(async () => 'data')
6030+
const queryFn = vi.fn(() => Promise.resolve('data'))
60296031
function Page() {
60306032
const [subscribed, setSubscribed] = React.useState(true)
60316033
const { data } = useQuery({
@@ -6067,7 +6069,7 @@ describe('useQuery', () => {
60676069

60686070
it('should not be attached to the query when subscribed is false', async () => {
60696071
const key = queryKey()
6070-
const queryFn = vi.fn(async () => 'data')
6072+
const queryFn = vi.fn(() => Promise.resolve('data'))
60716073
function Page() {
60726074
const { data } = useQuery({
60736075
queryKey: key,
@@ -6097,7 +6099,7 @@ describe('useQuery', () => {
60976099
function Page() {
60986100
const { data } = useQuery({
60996101
queryKey: key,
6100-
queryFn: async () => 'data',
6102+
queryFn: () => Promise.resolve('data'),
61016103
subscribed: false,
61026104
})
61036105
renders++
@@ -6131,8 +6133,8 @@ describe('useQuery', () => {
61316133
const states: Array<UseQueryResult<unknown>> = []
61326134
const error = new Error('oops')
61336135

6134-
const queryFn = async (): Promise<unknown> => {
6135-
throw error
6136+
const queryFn = (): Promise<unknown> => {
6137+
return Promise.reject(error)
61366138
}
61376139

61386140
function Page() {
@@ -6198,8 +6200,8 @@ describe('useQuery', () => {
61986200
function Page() {
61996201
const { refetch, errorUpdateCount } = useQuery({
62006202
queryKey: key,
6201-
queryFn: async (): Promise<unknown> => {
6202-
throw error
6203+
queryFn: (): Promise<unknown> => {
6204+
return Promise.reject(error)
62036205
},
62046206
retry: false,
62056207
})
@@ -6517,7 +6519,7 @@ describe('useQuery', () => {
65176519
})
65186520

65196521
// For Project without TS, when migrating from v4 to v5, make sure invalid calls due to bad parameters are tracked.
6520-
it('should throw in case of bad arguments to enhance DevX', async () => {
6522+
it('should throw in case of bad arguments to enhance DevX', () => {
65216523
// Mock console error to avoid noise when test is run
65226524
const consoleMock = vi
65236525
.spyOn(console, 'error')

0 commit comments

Comments
 (0)