feat(QueryCache): Remove refetchOnMount option and refetching based on instance count

BREAKING CHANGE: Removes the refetchOnMount option

Author: GeospatialMax

docs/src/pages/docs/api.md

@@ -30,8 +30,6 @@ const {
   refetchInterval,
   refetchIntervalInBackground,
   queryFnParamsFilter,
-  refetchOnMount,
-  neverRefetchOnMount,
   isDataEqual,
   onError,
   onSuccess,
@@ -112,14 +110,6 @@ const queryInfo = useQuery({
   - Optional
   - If set, this will mark the `initialData` any `initialData` provided as stale and will likely cause it to be refetched on mount
   - If a function is passed, it will be called only when appropriate to resolve the `initialStale` value. This can be useful if your `initialStale` value is costly to calculate.
-- `refetchOnMount: Boolean`
-  - Optional
-  - Defaults to `true`
-  - If set to `false`, will disable additional instances of a query to trigger background refetches
-- `neverRefetchOnMount: Boolean`
-  - Optional
-  - Defaults to `false`
-  - Allows for disabling refetching on mount independent of the number of query instances. If `refetchOnMount` is set to false but only one query instance exists the query would refetch anyway. If `neverRefetchOnMount` is set to true though the query will not refetch independent of the number of query instances.
 - `queryFnParamsFilter: Function(args) => filteredArgs`
   - Optional
   - This function will filter the params that get passed to `queryFn`.
@@ -666,8 +656,6 @@ const queryConfig = {
     refetchOnWindowFocus: true,
     refetchInterval: false,
     queryFnParamsFilter: identity,
-    refetchOnMount: true,
-    neverRefetchOnMount: false,
     isDataEqual: deepEqual,
     onError: noop,
     onSuccess: noop,

src/core/config.js

@@ -16,8 +16,6 @@ export const DEFAULT_CONFIG = {
     refetchOnWindowFocus: true,
     refetchInterval: false,
     queryFnParamsFilter: identity,
-    refetchOnMount: true,
-    neverRefetchOnMount: false,
     isDataEqual: deepEqual,
     onError: noop,
     onSuccess: noop,

src/core/queryInstance.js

@@ -50,16 +50,10 @@ export function makeQueryInstance(query, onStateUpdate) {
 
   instance.run = async () => {
     try {
-
-      // Don't refetch on mount when 'neverRefetchOnMount' is set, otherwise only refetch if either only one instance of the query exists or 'refetchOnMount' is set
-      const shouldRefetchOnMount = query.config.neverRefetchOnMount ? false : (query.config.refetchOnMount || query.instances.length === 1);
-
       if(
-        (!query.state.isSuccess || shouldRefetchOnMount) && // Make sure first load happens, thereafter only if refetch on mount is requested
         query.config.enabled && // Don't auto refetch if disabled
         !query.wasSuspended && // Don't double refetch for suspense
         query.state.isStale // Only refetch if stale
-        
       ) {
         await query.fetch();
       }

src/react/tests/ReactQueryConfigProvider.js

@@ -54,7 +54,6 @@ describe('ReactQueryConfigProvider', () => {
     const config = {
       queries: {
         refetchOnWindowFocus: false,
-        refetchOnMount: false,
         retry: false,
       },
     }
@@ -100,7 +99,7 @@ describe('ReactQueryConfigProvider', () => {
     await waitFor(() => rendered.findByText('Data: data'))
 
     // tear down and unmount
-    // so we are NOT passing the config above (refetchOnMount should be `true` by default)
+    // so we are NOT passing the config above
     fireEvent.click(rendered.getByText('unmount'))
 
     act(() => {
@@ -118,15 +117,12 @@ describe('ReactQueryConfigProvider', () => {
 
     const parentConfig = {
       queries: {
-        refetchOnMount: false,
         onSuccess: parentOnSuccess,
       },
     }
 
     const childConfig = {
       queries: {
-        refetchOnMount: true,
-
         // Override onSuccess of parent, making it a no-op
         onSuccess: undefined,
       },

types/index.d.ts

@@ -236,8 +236,6 @@ export interface BaseQueryOptions<TResult = unknown, TError = Error> {
   refetchInterval?: false | number
   refetchIntervalInBackground?: boolean
   refetchOnWindowFocus?: boolean
-  refetchOnMount?: boolean
-  neverRefetchOnMount?: boolean
   onSuccess?: (data: TResult) => void
   onError?: (err: TError) => void
   onSettled?: (data: TResult | undefined, error: TError | null) => void