Refactor callsite revalidation optout to use defaultShouldRevalidate

Author: dadamssg

packages/react-router/__tests__/router/fetchers-test.ts

@@ -2436,7 +2436,7 @@ describe("fetchers", () => {
       let C = await t.fetch("/tasks", actionKey, {
         formMethod: "post",
         formData: createFormData({}),
-        shouldRevalidate: false,
+        defaultShouldRevalidate: false,
       });
 
       expect(t.fetchers[actionKey]).toMatchObject({ state: "submitting" });

packages/react-router/lib/dom/dom.ts

@@ -196,7 +196,7 @@ interface SharedSubmitOptions {
   /**
    * Determine if revalidation should occur post-submission.
    */
-  shouldRevalidate?: boolean | (() => boolean);
+  defaultShouldRevalidate?: boolean;
 }
 
 /**

packages/react-router/lib/dom/lib.tsx

@@ -1792,7 +1792,7 @@ interface SharedFormProps extends React.FormHTMLAttributes<HTMLFormElement> {
   /**
    * Determine if revalidation should occur post-submission.
    */
-  shouldRevalidate?: boolean | (() => boolean);
+  defaultShouldRevalidate?: boolean;
 }
 
 /**
@@ -1916,7 +1916,7 @@ type HTMLFormSubmitter = HTMLButtonElement | HTMLInputElement;
  * @param {FormProps.replace} replace n/a
  * @param {FormProps.state} state n/a
  * @param {FormProps.viewTransition} viewTransition n/a
- * @param {FormProps.shouldRevalidate} shouldRevalidate n/a
+ * @param {FormProps.defaultShouldRevalidate} defaultShouldRevalidate n/a
  * @returns A progressively enhanced [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) component
  */
 export const Form = React.forwardRef<HTMLFormElement, FormProps>(
@@ -1934,7 +1934,7 @@ export const Form = React.forwardRef<HTMLFormElement, FormProps>(
       relative,
       preventScrollReset,
       viewTransition,
-      shouldRevalidate,
+      defaultShouldRevalidate,
       ...props
     },
     forwardedRef,
@@ -1967,7 +1967,7 @@ export const Form = React.forwardRef<HTMLFormElement, FormProps>(
         relative,
         preventScrollReset,
         viewTransition,
-        shouldRevalidate,
+        defaultShouldRevalidate,
       });
     };
 
@@ -2549,6 +2549,8 @@ export function useSubmit(): SubmitFunction {
 
   return React.useCallback<SubmitFunction>(
     async (target, options = {}) => {
+      debugger;
+      console.log("useSubmit", target, options);
       let { action, method, encType, formData, body } = getFormSubmissionInfo(
         target,
         basename,
@@ -2557,7 +2559,7 @@ export function useSubmit(): SubmitFunction {
       if (options.navigate === false) {
         let key = options.fetcherKey || getUniqueFetcherId();
         await router.fetch(key, currentRouteId, options.action || action, {
-          shouldRevalidate: options.shouldRevalidate,
+          defaultShouldRevalidate: options.defaultShouldRevalidate,
           preventScrollReset: options.preventScrollReset,
           formData,
           body,
@@ -2567,7 +2569,7 @@ export function useSubmit(): SubmitFunction {
         });
       } else {
         await router.navigate(options.action || action, {
-          shouldRevalidate: options.shouldRevalidate,
+          defaultShouldRevalidate: options.defaultShouldRevalidate,
           preventScrollReset: options.preventScrollReset,
           formData,
           body,

packages/react-router/lib/dom/ssr/single-fetch.tsx

@@ -385,9 +385,10 @@ async function singleFetchLoaderNavigationStrategy(
           getRouteInfo(m);
 
         let defaultShouldRevalidate =
-          !m.unstable_shouldRevalidateArgs ||
-          m.unstable_shouldRevalidateArgs.actionStatus == null ||
-          m.unstable_shouldRevalidateArgs.actionStatus < 400;
+          m.unstable_shouldRevalidateArgs?.defaultShouldRevalidate !== false &&
+          (!m.unstable_shouldRevalidateArgs ||
+            m.unstable_shouldRevalidateArgs.actionStatus == null ||
+            m.unstable_shouldRevalidateArgs.actionStatus < 400);
         let shouldCall = m.unstable_shouldCallHandler(defaultShouldRevalidate);
 
         if (!shouldCall) {

packages/react-router/lib/router/router.ts

@@ -524,7 +524,7 @@ type BaseNavigateOrFetchOptions = {
   preventScrollReset?: boolean;
   relative?: RelativeRoutingType;
   flushSync?: boolean;
-  shouldRevalidate?: boolean | (() => boolean);
+  defaultShouldRevalidate?: boolean;
 };
 
 // Only allowed for navigations
@@ -2366,13 +2366,8 @@ export function createRouter(init: RouterInit): Router {
     let preventScrollReset = (opts && opts.preventScrollReset) === true;
 
     if (submission && isMutationMethod(submission.formMethod)) {
-      let shouldRevalidate =
-        opts && "shouldRevalidate" in opts
-          ? typeof opts.shouldRevalidate === "function"
-            ? opts.shouldRevalidate()
-            : // undefined should eval to true
-              opts.shouldRevalidate !== false
-          : true;
+      let callSiteDefaultShouldRevalidate =
+        opts?.defaultShouldRevalidate !== false;
       await handleFetcherAction(
         key,
         routeId,
@@ -2383,7 +2378,7 @@ export function createRouter(init: RouterInit): Router {
         flushSync,
         preventScrollReset,
         submission,
-        shouldRevalidate,
+        callSiteDefaultShouldRevalidate,
       );
       return;
     }
@@ -2401,6 +2396,7 @@ export function createRouter(init: RouterInit): Router {
       flushSync,
       preventScrollReset,
       submission,
+      // defaultShouldRevalidate, // todo
     );
   }
 
@@ -2416,7 +2412,7 @@ export function createRouter(init: RouterInit): Router {
     flushSync: boolean,
     preventScrollReset: boolean,
     submission: Submission,
-    shouldRevalidate: boolean,
+    callSiteDefaultShouldRevalidate: boolean,
   ) {
     interruptActiveLoads();
     fetchLoadMatches.delete(key);
@@ -2592,7 +2588,7 @@ export function createRouter(init: RouterInit): Router {
       basename,
       init.patchRoutesOnNavigation != null,
       [match.route.id, actionResult],
-      shouldRevalidate,
+      callSiteDefaultShouldRevalidate,
     );
 
     // Put all revalidating fetchers into the loading state, except for the
@@ -2624,15 +2620,6 @@ export function createRouter(init: RouterInit): Router {
       abortPendingFetchRevalidations,
     );
 
-    if (!shouldRevalidate) {
-      if (state.fetchers.has(key)) {
-        let doneFetcher = getDoneFetcher(actionResult.data);
-        state.fetchers.set(key, doneFetcher);
-      }
-      fetchControllers.delete(key);
-      return;
-    }
-
     let { loaderResults, fetcherResults } =
       await callLoadersAndMaybeResolveData(
         dsMatches,
@@ -4859,7 +4846,7 @@ function getMatchesToLoad(
   basename: string | undefined,
   hasPatchRoutesOnNavigation: boolean,
   pendingActionResult?: PendingActionResult,
-  shouldRevalidate?: boolean,
+  callSiteDefaultShouldRevalidate?: boolean,
 ): {
   dsMatches: DataStrategyMatch[];
   revalidatingFetchers: RevalidatingFetcher[];
@@ -4896,7 +4883,8 @@ function getMatchesToLoad(
     ? pendingActionResult[1].statusCode
     : undefined;
   let shouldSkipRevalidation =
-    (actionStatus && actionStatus >= 400) || shouldRevalidate === false;
+    (actionStatus && actionStatus >= 400) ||
+    callSiteDefaultShouldRevalidate === false;
 
   let baseShouldRevalidateArgs = {
     currentUrl,
@@ -4949,7 +4937,6 @@ function getMatchesToLoad(
         forceShouldLoad,
       );
     }
-
     // This is the default implementation for when we revalidate.  If the route
     // provides it's own implementation, then we give them full control but
     // provide this value so they can leverage it if needed after they check