Merge branch 'release-next'

remix-run · Jul 16, 2024 · d75eed5 · d75eed5
2 parents abfa786 + 13dfa13
commit d75eed5
Show file tree

Hide file tree

Showing 23 changed files with 437 additions and 138 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,163 +13,168 @@ We manage release notes in this file instead of the paginated Github Releases Pa
   <summary>Table of Contents</summary>
 
 - [React Router Releases](#react-router-releases)
-  - [v6.24.1](#v6241)
-    - [Patch Changes](#patch-changes)
-  - [v6.24.0](#v6240)
+  - [v6.25.0](#v6250)
     - [What's Changed](#whats-changed)
-      - [Lazy Route Discovery (a.k.a. "Fog of War")](#lazy-route-discovery-aka-fog-of-war)
+      - [Stabilized `v7_skipActionErrorRevalidation`](#stabilized-v7_skipactionerrorrevalidation)
     - [Minor Changes](#minor-changes)
+    - [Patch Changes](#patch-changes)
+  - [v6.24.1](#v6241)
     - [Patch Changes](#patch-changes-1)
-  - [v6.23.1](#v6231)
+  - [v6.24.0](#v6240)
+    - [What's Changed](#whats-changed-1)
+      - [Lazy Route Discovery (a.k.a. "Fog of War")](#lazy-route-discovery-aka-fog-of-war)
+    - [Minor Changes](#minor-changes-1)
     - [Patch Changes](#patch-changes-2)
+  - [v6.23.1](#v6231)
+    - [Patch Changes](#patch-changes-3)
   - [v6.23.0](#v6230)
-    - [What's Changed](#whats-changed-1)
+    - [What's Changed](#whats-changed-2)
       - [Data Strategy (unstable)](#data-strategy-unstable)
       - [Skip Action Error Revalidation (unstable)](#skip-action-error-revalidation-unstable)
-    - [Minor Changes](#minor-changes-1)
+    - [Minor Changes](#minor-changes-2)
   - [v6.22.3](#v6223)
-    - [Patch Changes](#patch-changes-3)
-  - [v6.22.2](#v6222)
     - [Patch Changes](#patch-changes-4)
-  - [v6.22.1](#v6221)
+  - [v6.22.2](#v6222)
     - [Patch Changes](#patch-changes-5)
+  - [v6.22.1](#v6221)
+    - [Patch Changes](#patch-changes-6)
   - [v6.22.0](#v6220)
-    - [What's Changed](#whats-changed-2)
+    - [What's Changed](#whats-changed-3)
       - [Core Web Vitals Technology Report Flag](#core-web-vitals-technology-report-flag)
-    - [Minor Changes](#minor-changes-2)
-    - [Patch Changes](#patch-changes-6)
-  - [v6.21.3](#v6213)
+    - [Minor Changes](#minor-changes-3)
     - [Patch Changes](#patch-changes-7)
-  - [v6.21.2](#v6212)
+  - [v6.21.3](#v6213)
     - [Patch Changes](#patch-changes-8)
-  - [v6.21.1](#v6211)
+  - [v6.21.2](#v6212)
     - [Patch Changes](#patch-changes-9)
+  - [v6.21.1](#v6211)
+    - [Patch Changes](#patch-changes-10)
   - [v6.21.0](#v6210)
-    - [What's Changed](#whats-changed-3)
+    - [What's Changed](#whats-changed-4)
       - [`future.v7_relativeSplatPath`](#futurev7_relativesplatpath)
       - [Partial Hydration](#partial-hydration)
-    - [Minor Changes](#minor-changes-3)
-    - [Patch Changes](#patch-changes-10)
-  - [v6.20.1](#v6201)
-    - [Patch Changes](#patch-changes-11)
-  - [v6.20.0](#v6200)
     - [Minor Changes](#minor-changes-4)
+    - [Patch Changes](#patch-changes-11)
+  - [v6.20.1](#v6201)
     - [Patch Changes](#patch-changes-12)
-  - [v6.19.0](#v6190)
-    - [What's Changed](#whats-changed-4)
-      - [`unstable_flushSync` API](#unstable_flushsync-api)
+  - [v6.20.0](#v6200)
     - [Minor Changes](#minor-changes-5)
     - [Patch Changes](#patch-changes-13)
-  - [v6.18.0](#v6180)
+  - [v6.19.0](#v6190)
     - [What's Changed](#whats-changed-5)
-      - [New Fetcher APIs](#new-fetcher-apis)
-      - [Persistence Future Flag (`future.v7_fetcherPersist`)](#persistence-future-flag-futurev7_fetcherpersist)
+      - [`unstable_flushSync` API](#unstable_flushsync-api)
     - [Minor Changes](#minor-changes-6)
     - [Patch Changes](#patch-changes-14)
-  - [v6.17.0](#v6170)
+  - [v6.18.0](#v6180)
     - [What's Changed](#whats-changed-6)
-      - [View Transitions 🚀](#view-transitions-)
+      - [New Fetcher APIs](#new-fetcher-apis)
+      - [Persistence Future Flag (`future.v7_fetcherPersist`)](#persistence-future-flag-futurev7_fetcherpersist)
     - [Minor Changes](#minor-changes-7)
     - [Patch Changes](#patch-changes-15)
-  - [v6.16.0](#v6160)
+  - [v6.17.0](#v6170)
+    - [What's Changed](#whats-changed-7)
+      - [View Transitions 🚀](#view-transitions-)
     - [Minor Changes](#minor-changes-8)
     - [Patch Changes](#patch-changes-16)
-  - [v6.15.0](#v6150)
+  - [v6.16.0](#v6160)
     - [Minor Changes](#minor-changes-9)
     - [Patch Changes](#patch-changes-17)
-  - [v6.14.2](#v6142)
+  - [v6.15.0](#v6150)
+    - [Minor Changes](#minor-changes-10)
     - [Patch Changes](#patch-changes-18)
-  - [v6.14.1](#v6141)
+  - [v6.14.2](#v6142)
     - [Patch Changes](#patch-changes-19)
-  - [v6.14.0](#v6140)
-    - [What's Changed](#whats-changed-7)
-      - [JSON/Text Submissions](#jsontext-submissions)
-    - [Minor Changes](#minor-changes-10)
+  - [v6.14.1](#v6141)
     - [Patch Changes](#patch-changes-20)
-  - [v6.13.0](#v6130)
+  - [v6.14.0](#v6140)
     - [What's Changed](#whats-changed-8)
-      - [`future.v7_startTransition`](#futurev7_starttransition)
+      - [JSON/Text Submissions](#jsontext-submissions)
     - [Minor Changes](#minor-changes-11)
     - [Patch Changes](#patch-changes-21)
-  - [v6.12.1](#v6121)
-    - [Patch Changes](#patch-changes-22)
-  - [v6.12.0](#v6120)
+  - [v6.13.0](#v6130)
     - [What's Changed](#whats-changed-9)
-      - [`React.startTransition` support](#reactstarttransition-support)
+      - [`future.v7_startTransition`](#futurev7_starttransition)
     - [Minor Changes](#minor-changes-12)
+    - [Patch Changes](#patch-changes-22)
+  - [v6.12.1](#v6121)
     - [Patch Changes](#patch-changes-23)
-  - [v6.11.2](#v6112)
+  - [v6.12.0](#v6120)
+    - [What's Changed](#whats-changed-10)
+      - [`React.startTransition` support](#reactstarttransition-support)
+    - [Minor Changes](#minor-changes-13)
     - [Patch Changes](#patch-changes-24)
-  - [v6.11.1](#v6111)
+  - [v6.11.2](#v6112)
     - [Patch Changes](#patch-changes-25)
-  - [v6.11.0](#v6110)
-    - [Minor Changes](#minor-changes-13)
+  - [v6.11.1](#v6111)
     - [Patch Changes](#patch-changes-26)
-  - [v6.10.0](#v6100)
-    - [What's Changed](#whats-changed-10)
+  - [v6.11.0](#v6110)
     - [Minor Changes](#minor-changes-14)
-      - [`future.v7_normalizeFormMethod`](#futurev7_normalizeformmethod)
     - [Patch Changes](#patch-changes-27)
-  - [v6.9.0](#v690)
+  - [v6.10.0](#v6100)
     - [What's Changed](#whats-changed-11)
-      - [`Component`/`ErrorBoundary` route properties](#componenterrorboundary-route-properties)
-      - [Introducing Lazy Route Modules](#introducing-lazy-route-modules)
     - [Minor Changes](#minor-changes-15)
+      - [`future.v7_normalizeFormMethod`](#futurev7_normalizeformmethod)
     - [Patch Changes](#patch-changes-28)
-  - [v6.8.2](#v682)
+  - [v6.9.0](#v690)
+    - [What's Changed](#whats-changed-12)
+      - [`Component`/`ErrorBoundary` route properties](#componenterrorboundary-route-properties)
+      - [Introducing Lazy Route Modules](#introducing-lazy-route-modules)
+    - [Minor Changes](#minor-changes-16)
     - [Patch Changes](#patch-changes-29)
-  - [v6.8.1](#v681)
+  - [v6.8.2](#v682)
     - [Patch Changes](#patch-changes-30)
-  - [v6.8.0](#v680)
-    - [Minor Changes](#minor-changes-16)
+  - [v6.8.1](#v681)
     - [Patch Changes](#patch-changes-31)
-  - [v6.7.0](#v670)
+  - [v6.8.0](#v680)
     - [Minor Changes](#minor-changes-17)
     - [Patch Changes](#patch-changes-32)
-  - [v6.6.2](#v662)
+  - [v6.7.0](#v670)
+    - [Minor Changes](#minor-changes-18)
     - [Patch Changes](#patch-changes-33)
-  - [v6.6.1](#v661)
+  - [v6.6.2](#v662)
     - [Patch Changes](#patch-changes-34)
-  - [v6.6.0](#v660)
-    - [What's Changed](#whats-changed-12)
-    - [Minor Changes](#minor-changes-18)
+  - [v6.6.1](#v661)
     - [Patch Changes](#patch-changes-35)
-  - [v6.5.0](#v650)
+  - [v6.6.0](#v660)
     - [What's Changed](#whats-changed-13)
     - [Minor Changes](#minor-changes-19)
     - [Patch Changes](#patch-changes-36)
-  - [v6.4.5](#v645)
+  - [v6.5.0](#v650)
+    - [What's Changed](#whats-changed-14)
+    - [Minor Changes](#minor-changes-20)
     - [Patch Changes](#patch-changes-37)
-  - [v6.4.4](#v644)
+  - [v6.4.5](#v645)
     - [Patch Changes](#patch-changes-38)
-  - [v6.4.3](#v643)
+  - [v6.4.4](#v644)
     - [Patch Changes](#patch-changes-39)
-  - [v6.4.2](#v642)
+  - [v6.4.3](#v643)
     - [Patch Changes](#patch-changes-40)
-  - [v6.4.1](#v641)
+  - [v6.4.2](#v642)
     - [Patch Changes](#patch-changes-41)
+  - [v6.4.1](#v641)
+    - [Patch Changes](#patch-changes-42)
   - [v6.4.0](#v640)
-    - [What's Changed](#whats-changed-14)
+    - [What's Changed](#whats-changed-15)
       - [Remix Data APIs](#remix-data-apis)
-    - [Patch Changes](#patch-changes-42)
+    - [Patch Changes](#patch-changes-43)
   - [v6.3.0](#v630)
-    - [Minor Changes](#minor-changes-20)
+    - [Minor Changes](#minor-changes-21)
   - [v6.2.2](#v622)
-    - [Patch Changes](#patch-changes-43)
-  - [v6.2.1](#v621)
     - [Patch Changes](#patch-changes-44)
-  - [v6.2.0](#v620)
-    - [Minor Changes](#minor-changes-21)
+  - [v6.2.1](#v621)
     - [Patch Changes](#patch-changes-45)
-  - [v6.1.1](#v611)
-    - [Patch Changes](#patch-changes-46)
-  - [v6.1.0](#v610)
+  - [v6.2.0](#v620)
     - [Minor Changes](#minor-changes-22)
+    - [Patch Changes](#patch-changes-46)
+  - [v6.1.1](#v611)
     - [Patch Changes](#patch-changes-47)
-  - [v6.0.2](#v602)
+  - [v6.1.0](#v610)
+    - [Minor Changes](#minor-changes-23)
     - [Patch Changes](#patch-changes-48)
-  - [v6.0.1](#v601)
+  - [v6.0.2](#v602)
     - [Patch Changes](#patch-changes-49)
+  - [v6.0.1](#v601)
+    - [Patch Changes](#patch-changes-50)
   - [v6.0.0](#v600)
 
 </details>
@@ -193,6 +198,31 @@ Date: YYYY-MM-DD
 **Full Changelog**: [`v6.X.Y...v6.X.Y`](https://github.com/remix-run/react-router/compare/react-router@6.X.Y...react-router@6.X.Y)
 -->
 
+## v6.25.0
+
+Date: 2024-07-16
+
+### What's Changed
+
+#### Stabilized `v7_skipActionErrorRevalidation`
+
+This release stabilizes the `future.unstable_skipActionErrorRevalidation` flag into [`future.v7_skipActionErrorRevalidation`](https://reactrouter.com/upgrading/future#v7_skipactionstatusrevalidation) in preparation for the upcoming React Router v7 release.
+
+- When this flag is enabled, actions that return/throw a `4xx/5xx` `Response` will not trigger a revalidation by default
+- This also stabilizes `shouldRevalidate`'s `unstable_actionStatus` parameter to `actionStatus`
+
+### Minor Changes
+
+- Stabilize `future.unstable_skipActionErrorRevalidation` as `future.v7_skipActionErrorRevalidation` ([#11769](https://github.com/remix-run/react-router/pull/11769))
+
+### Patch Changes
+
+- Fix regression and properly decode paths inside `useMatch` so matches/params reflect decoded params ([#11789](https://github.com/remix-run/react-router/pull/11789))
+- Fix bubbling of errors thrown from `unstable_patchRoutesOnMiss` ([#11786](https://github.com/remix-run/react-router/pull/11786))
+- Fix hydration in SSR apps using `unstable_patchRoutesOnMiss` that matched a splat route on the server ([#11790](https://github.com/remix-run/react-router/pull/11790))
+
+**Full Changelog**: [`v6.24.1...v6.25.0`](https://github.com/remix-run/react-router/compare/react-router@6.24.1...react-router@6.25.0)
+
 ## v6.24.1
 
 Date: 2024-07-03

diff --git a/docs/route/should-revalidate.md b/docs/route/should-revalidate.md
@@ -25,7 +25,7 @@ interface ShouldRevalidateFunctionArgs {
   formData?: Submission["formData"];
   json?: Submission["json"];
   actionResult?: any;
-  unstable_actionStatus?: number;
+  actionStatus?: number;
   defaultShouldRevalidate: boolean;
 }
 ```
@@ -40,8 +40,8 @@ There are several instances where data is revalidated, keeping your UI in sync w
 
 - After an [`action`][action] is called via:
   - [`<Form>`][form], [`<fetcher.Form>`][fetcher], [`useSubmit`][usesubmit], or [`fetcher.submit`][fetcher]
-  - When the `future.unstable_skipActionErrorRevalidation` flag is enabled, `loaders` will not revalidate by default if the `action` returns or throws a 4xx/5xx `Response`
-  - You can opt-into revalidation for these scenarios via `shouldRevalidate` and the `unstable_actionStatus` parameter
+  - When the `future.v7_skipActionErrorRevalidation` flag is enabled, `loaders` will not revalidate by default if the `action` returns or throws a 4xx/5xx `Response`
+  - You can opt-into revalidation for these scenarios via `shouldRevalidate` and the `actionStatus` parameter
 - When an explicit revalidation is triggered via [`useRevalidator`][userevalidator]
 - When the [URL params][params] change for an already rendered route
 - When the URL Search params change

diff --git a/docs/routers/create-browser-router.md b/docs/routers/create-browser-router.md
@@ -125,7 +125,7 @@ The following future flags are currently available:
 | `v7_partialHydration`                       | Support partial hydration for Server-rendered apps                      |
 | `v7_prependBasename`                        | Prepend the router basename to navigate/fetch paths                     |
 | [`v7_relativeSplatPath`][relativesplatpath] | Fix buggy relative path resolution in splat routes                      |
-| `unstable_skipActionErrorRevalidation`      | Do not revalidate by default if the action returns a 4xx/5xx `Response` |
+| `v7_skipActionErrorRevalidation`            | Do not revalidate by default if the action returns a 4xx/5xx `Response` |
 
 ## `opts.hydrationData`
 
@@ -246,7 +246,7 @@ interface HandlerResult {
     - If you are on `/parent/child/a` and you submit to `a`'s `action`, then only `a` will have `shouldLoad=true` for the action execution of `dataStrategy`
       - After the `action`, `dataStrategy` will be called again for the `loader` revalidation, and all matches will have `shouldLoad=true` (assuming no custom `shouldRevalidate` implementations)
 
-The `dataStrategy` function should return a parallel array of `HandlerResult` instances, which indicates if the handler was successful or not. If the returned `handlerResult.result` is a `Response`, React Router will unwrap it for you (via `res.json` or `res.text`). If you need to do custom decoding of a `Response` but preserve the status code, you can return the decoded value in `handlerResult.result` and send the status along via `handlerResult.status` (for example, when using the `future.unstable_skipActionRevalidation` flag). `match.resolve()` will return a `HandlerResult` if you are not passing it a handler override function. If you are, then you need to wrap the `handler` result in a `HandlerResult` (see examples below).
+The `dataStrategy` function should return a parallel array of `HandlerResult` instances, which indicates if the handler was successful or not. If the returned `handlerResult.result` is a `Response`, React Router will unwrap it for you (via `res.json` or `res.text`). If you need to do custom decoding of a `Response` but preserve the status code, you can return the decoded value in `handlerResult.result` and send the status along via `handlerResult.status` (for example, when using the `future.v7_skipActionRevalidation` flag). `match.resolve()` will return a `HandlerResult` if you are not passing it a handler override function. If you are, then you need to wrap the `handler` result in a `HandlerResult` (see examples below).
 
 ### Example Use Cases
 

diff --git a/docs/upgrading/future.md b/docs/upgrading/future.md
@@ -199,3 +199,70 @@ createBrowserRouter(routes, {
   },
 });
 ```
+
+## v7_skipActionStatusRevalidation
+
+<docs-warning>If you are not using a `createBrowserRouter` you can skip this</docs-warning>
+
+When this flag is enabled, loaders will no longer revalidate by default after an action throws/returns a `Response` with a `4xx`/`5xx` status code. You may opt-into revalidation in these scenarios via `shouldRevalidate` and the `actionStatus` parameter.
+
+👉 **Enable the Flag**
+
+```tsx
+createBrowserRouter(routes, {
+  future: {
+    v7_skipActionStatusRevalidation: true,
+  },
+});
+```
+
+**Update your Code**
+
+In most cases, you probably won't have to make changes to your app code. Usually, if an action errors, it's unlikely data was mutated and needs revalidation. If any of your code _does_ mutate data in action error scenarios you have 2 options:
+
+👉 **Option 1: Change the `action` to avoid mutations in error scenarios**
+
+```js
+// Before
+async function action() {
+  await mutateSomeData();
+  if (detectError()) {
+    throw new Response(error, { status: 400 });
+  }
+  await mutateOtherData();
+  // ...
+}
+
+// After
+async function action() {
+  if (detectError()) {
+    throw new Response(error, { status: 400 });
+  }
+  // All data is now mutated after validations
+  await mutateSomeData();
+  await mutateOtherData();
+  // ...
+}
+```
+
+👉 **Option 2: Opt-into revalidation via `shouldRevalidate` and `actionStatus`**
+
+```js
+async function action() {
+  await mutateSomeData();
+  if (detectError()) {
+    throw new Response(error, { status: 400 });
+  }
+  await mutateOtherData();
+}
+
+async function loader() { ... }
+
+function shouldRevalidate({ actionStatus, defaultShouldRevalidate }) {
+  if (actionStatus != null && actionStatus >= 400) {
+    // Revalidate this loader when actions return a 4xx/5xx status
+    return true;
+  }
+  return defaultShouldRevalidate;
+}
+```