feat(QueryCache): change logic, changed option to neverRefetchOnMount

Author: GeospatialMax

docs/src/pages/docs/api.md

@@ -32,7 +32,7 @@ const {
   refetchIntervalInBackground,
   queryFnParamsFilter,
   refetchOnMount,
-  alwaysRefetchOnMount,
+  neverRefetchOnMount,
   isDataEqual,
   onError,
   onSuccess,
@@ -117,10 +117,10 @@ const queryInfo = useQuery({
   - Optional
   - Defaults to `true`
   - If set to `false`, will disable additional instances of a query to trigger background refetches
-- `alwaysRefetchOnMount: Boolean`
+- `neverRefetchOnMount: Boolean`
   - Optional
   - Defaults to `false`
-  - Always refetch on mount sets refetching 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 `alwaysRefetchOnMount` is set to false though the query will not refetch independent of the number of instances
+  - 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`.
@@ -670,7 +670,7 @@ const queryConfig = {
     refetchInterval: false,
     queryFnParamsFilter: identity,
     refetchOnMount: true,
-    alwaysRefetchOnMount: false,
+    neverRefetchOnMount: false,
     isDataEqual: deepEqual,
     onError: noop,
     onSuccess: noop,

src/core/config.js

@@ -17,7 +17,7 @@ export const DEFAULT_CONFIG = {
     refetchInterval: false,
     queryFnParamsFilter: identity,
     refetchOnMount: true,
-    alwaysRefetchOnMount: false,
+    neverRefetchOnMount: false,
     isDataEqual: deepEqual,
     onError: noop,
     onSuccess: noop,

src/core/queryInstance.js

@@ -50,14 +50,18 @@ export function makeQueryInstance(query, onStateUpdate) {
 
   instance.run = async () => {
     try {
-      // Perform the refetch for this query if necessary
-      if (
+
+      // 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
-        ((query.config.refetchOnMount || query.instances.length === 1) || query.config.alwaysRefetchOnMount)
+        query.state.isStale // Only refetch if stale
+        
       ) {
-        await query.fetch()
+        await query.fetch();
       }
 
       query.wasSuspended = false

types/index.d.ts

@@ -237,7 +237,7 @@ export interface BaseQueryOptions<TResult = unknown, TError = Error> {
   refetchIntervalInBackground?: boolean
   refetchOnWindowFocus?: boolean
   refetchOnMount?: boolean
-  alwaysRefetchOnMount?: boolean
+  neverRefetchOnMount?: boolean
   onSuccess?: (data: TResult) => void
   onError?: (err: TError) => void
   onSettled?: (data: TResult | undefined, error: TError | null) => void