diff --git a/src/react-query/hooks/__tests__/useQueryData.refetch.test.ts b/src/react-query/hooks/__tests__/useQueryData.refetch.test.ts deleted file mode 100644 index 2e9c9eb..0000000 --- a/src/react-query/hooks/__tests__/useQueryData.refetch.test.ts +++ /dev/null @@ -1,180 +0,0 @@ -import {QueryClient, useInfiniteQuery, useQuery} from '@tanstack/react-query'; -import {renderHook} from '@testing-library/react'; - -import {idle} from '../../../core'; -import type {AnyInfiniteQueryDataSource} from '../../impl/infinite/types'; -import type {AnyPlainQueryDataSource} from '../../impl/plain/types'; -import {warnDisabledRefetch} from '../../utils/warnDisabledRefetch'; -import {useQueryContext} from '../useQueryContext'; -import {useQueryData} from '../useQueryData'; - -jest.mock('@tanstack/react-query', () => ({ - ...jest.requireActual('@tanstack/react-query'), - useQuery: jest.fn(), - useInfiniteQuery: jest.fn(), -})); - -jest.mock('../useQueryContext'); -jest.mock('../../utils/warnDisabledRefetch'); - -const mockUseQuery = useQuery as jest.MockedFunction; -const mockUseInfiniteQuery = useInfiniteQuery as jest.MockedFunction; -const mockWarnDisabledRefetch = warnDisabledRefetch as jest.MockedFunction< - typeof warnDisabledRefetch ->; - -describe('useQueryData refetch behavior', () => { - const mockQueryClient = new QueryClient(); - const mockContext = {queryClient: mockQueryClient}; - - beforeEach(() => { - jest.clearAllMocks(); - (useQueryContext as jest.Mock).mockReturnValue(mockContext); - }); - - const createMockQueryResult = (refetch = jest.fn()) => ({ - data: 'test-data', - error: null, - status: 'success' as const, - fetchStatus: 'idle' as const, - isLoading: false, - isError: false, - isSuccess: true, - isPending: false, - refetch, - dataUpdatedAt: Date.now(), - errorUpdatedAt: 0, - failureCount: 0, - failureReason: null, - isFetched: true, - isFetchedAfterMount: true, - isFetching: false, - isInitialLoading: false, - isLoadingError: false, - isPaused: false, - isPlaceholderData: false, - isPreviousData: false, - isRefetchError: false, - isRefetching: false, - isStale: false, - promise: Promise.resolve('test-data'), - }); - - const createMockInfiniteResult = (refetch = jest.fn()) => ({ - data: {pages: [['item1'], ['item2']], pageParams: [undefined, 'next-page']}, - error: null, - status: 'success' as const, - fetchStatus: 'idle' as const, - isLoading: false, - isError: false, - isSuccess: true, - isPending: false, - refetch, - hasNextPage: false, - hasPreviousPage: false, - fetchNextPage: jest.fn(), - fetchPreviousPage: jest.fn(), - isFetchingNextPage: false, - isFetchingPreviousPage: false, - dataUpdatedAt: Date.now(), - errorUpdatedAt: 0, - failureCount: 0, - failureReason: null, - isFetched: true, - isFetchedAfterMount: true, - isFetching: false, - isInitialLoading: false, - isLoadingError: false, - isPaused: false, - isPlaceholderData: false, - isPreviousData: false, - isRefetchError: false, - isRefetching: false, - isStale: false, - promise: Promise.resolve({ - pages: [['item1'], ['item2']], - pageParams: [undefined, 'next-page'], - }), - }); - - describe('plain data source', () => { - const plainDataSource: AnyPlainQueryDataSource = { - type: 'plain', - name: 'test-plain', - fetch: jest.fn().mockResolvedValue({data: 'test-data'}), - }; - - it('should use original refetch when no enabled option', () => { - const originalRefetch = jest.fn(); - mockUseQuery.mockReturnValue(createMockQueryResult(originalRefetch) as any); - - const {result} = renderHook(() => useQueryData(plainDataSource, {id: 1})); - - expect(result.current.refetch).toBe(originalRefetch); - expect(result.current.refetch).not.toBe(mockWarnDisabledRefetch); - }); - - it('should use warnDisabledRefetch when enabled: false', () => { - const originalRefetch = jest.fn(); - mockUseQuery.mockReturnValue(createMockQueryResult(originalRefetch) as any); - - const {result} = renderHook(() => - useQueryData(plainDataSource, {id: 1}, {enabled: false}), - ); - - expect(result.current.refetch).toBe(mockWarnDisabledRefetch); - expect(result.current.refetch).not.toBe(originalRefetch); - }); - - it('should use warnDisabledRefetch when params is idle', () => { - const originalRefetch = jest.fn(); - mockUseQuery.mockReturnValue(createMockQueryResult(originalRefetch) as any); - - const {result} = renderHook(() => useQueryData(plainDataSource, idle)); - - expect(result.current.refetch).toBe(mockWarnDisabledRefetch); - expect(result.current.refetch).not.toBe(originalRefetch); - }); - }); - - describe('infinite data source', () => { - const infiniteDataSource: AnyInfiniteQueryDataSource = { - type: 'infinite', - name: 'test-infinite', - fetch: jest.fn().mockResolvedValue({data: ['item1', 'item2']}), - next: jest.fn(), - }; - - it('should use original refetch when no enabled option', () => { - const originalRefetch = jest.fn(); - mockUseInfiniteQuery.mockReturnValue(createMockInfiniteResult(originalRefetch) as any); - - const {result} = renderHook(() => useQueryData(infiniteDataSource, {id: 1})); - - expect(result.current.refetch).toBe(originalRefetch); - expect(result.current.refetch).not.toBe(mockWarnDisabledRefetch); - }); - - it('should use warnDisabledRefetch when enabled: false', () => { - const originalRefetch = jest.fn(); - mockUseInfiniteQuery.mockReturnValue(createMockInfiniteResult(originalRefetch) as any); - - const {result} = renderHook(() => - useQueryData(infiniteDataSource, {id: 1}, {enabled: false}), - ); - - expect(result.current.refetch).toBe(mockWarnDisabledRefetch); - expect(result.current.refetch).not.toBe(originalRefetch); - }); - - it('should use warnDisabledRefetch when params is idle', () => { - const originalRefetch = jest.fn(); - mockUseInfiniteQuery.mockReturnValue(createMockInfiniteResult(originalRefetch) as any); - - const {result} = renderHook(() => useQueryData(infiniteDataSource, idle)); - - expect(result.current.refetch).toBe(mockWarnDisabledRefetch); - expect(result.current.refetch).not.toBe(originalRefetch); - }); - }); -}); diff --git a/src/react-query/impl/infinite/hooks.ts b/src/react-query/impl/infinite/hooks.ts index 36300c9..6f30a1b 100644 --- a/src/react-query/impl/infinite/hooks.ts +++ b/src/react-query/impl/infinite/hooks.ts @@ -1,6 +1,6 @@ import {useMemo} from 'react'; -import {skipToken, useInfiniteQuery} from '@tanstack/react-query'; +import {useInfiniteQuery} from '@tanstack/react-query'; import type {InfiniteData, InfiniteQueryObserverOptions} from '@tanstack/react-query'; import type { @@ -16,7 +16,6 @@ import type { } from '../../../core'; import {useRefetchInterval} from '../../hooks/useRefetchInterval'; import {normalizeStatus} from '../../utils/normalizeStatus'; -import {warnDisabledRefetch} from '../../utils/warnDisabledRefetch'; import type {AnyInfiniteQueryDataSource, InfiniteQueryObserverExtendedOptions} from './types'; import {composeOptions} from './utils'; @@ -64,14 +63,11 @@ export const useInfiniteQueryData = ; }; diff --git a/src/react-query/impl/plain/hooks.ts b/src/react-query/impl/plain/hooks.ts index 3346970..b6c4063 100644 --- a/src/react-query/impl/plain/hooks.ts +++ b/src/react-query/impl/plain/hooks.ts @@ -1,4 +1,4 @@ -import {type QueryObserverOptions, skipToken, useQuery} from '@tanstack/react-query'; +import {type QueryObserverOptions, useQuery} from '@tanstack/react-query'; import type { DataSourceContext, @@ -12,7 +12,6 @@ import type { } from '../../../core'; import {useRefetchInterval} from '../../hooks/useRefetchInterval'; import {normalizeStatus} from '../../utils/normalizeStatus'; -import {warnDisabledRefetch} from '../../utils/warnDisabledRefetch'; import type {AnyPlainQueryDataSource, QueryObserverExtendedOptions} from './types'; import {composeOptions} from './utils'; @@ -53,12 +52,9 @@ export const usePlainQueryData = ( const composedOptions = usePlainQueryDataOptions(extendedOptions); const state = useQuery(composedOptions); - const isDisabled = composedOptions.enabled === false || composedOptions.queryFn === skipToken; - return { ...state, status: normalizeStatus(state.status, state.fetchStatus), originalStatus: state.status, - refetch: isDisabled ? warnDisabledRefetch : state.refetch, } as DataSourceState; }; diff --git a/src/react-query/types/options.ts b/src/react-query/types/options.ts index f04eebe..27b6839 100644 --- a/src/react-query/types/options.ts +++ b/src/react-query/types/options.ts @@ -11,11 +11,6 @@ export interface QueryDataAdditionalOptions< TQueryKey extends QueryKey = QueryKey, > { refetchInterval?: RefetchInterval; - /** - * @deprecated The use of the enabled option is deprecated. - * It is recommended to use idle as query parameters to control query state. - */ - enabled?: boolean; /** Normalization configuration (enable/disable) */ normalize?: boolean; /** Optimistic data update configuration */ diff --git a/src/react-query/utils/warn.ts b/src/react-query/utils/warn.ts deleted file mode 100644 index 061762f..0000000 --- a/src/react-query/utils/warn.ts +++ /dev/null @@ -1,8 +0,0 @@ -export function warn(msg: string) { - if (!msg || process.env.NODE_ENV === 'production') { - return; - } - - // eslint-disable-next-line no-console - console.warn(msg); -} diff --git a/src/react-query/utils/warnDisabledRefetch.ts b/src/react-query/utils/warnDisabledRefetch.ts deleted file mode 100644 index 1eaceef..0000000 --- a/src/react-query/utils/warnDisabledRefetch.ts +++ /dev/null @@ -1,5 +0,0 @@ -import {warn} from './warn'; - -export const warnDisabledRefetch = () => { - warn('Disabled refetch is called'); -};