Add support for future.v3_throwAbortReason flag (#8251)

remix-run · Jan 26, 2024 · 4c627af · 4c627af
1 parent deaedf5
commit 4c627af
Show file tree

Hide file tree

Showing 14 changed files with 349 additions and 28 deletions.
diff --git a/.changeset/throw-abort-reason.md b/.changeset/throw-abort-reason.md
@@ -0,0 +1,6 @@
+---
+"@remix-run/dev": minor
+"@remix-run/server-runtime": minor
+---
+
+Add `future.v3_throwAbortReason` flag to throw `request.signal.reason` when a request is aborted instead of an `Error` such as `new Error("query() call aborted: GET /path")`
diff --git a/docs/file-conventions/remix-config.md b/docs/file-conventions/remix-config.md
@@ -73,6 +73,8 @@ The `future` config lets you opt-into future breaking changes via [Future Flags]
 - **`v3_fetcherPersist`**: Change fetcher persistence/cleanup behavior in 2 ways ([RFC][fetcherpersist-rfc]):
   - Fetchers are no longer removed on unmount, and remain exposed via [`useFetchers`][use-fetchers] until they return to an `idle` state
   - Fetchers that complete while still mounted no longer persist in [`useFetchers`][use-fetchers] since you can access those fetchers via [`useFetcher`][use-fetcher]
+- **`v3_relativeSplatPath`**: Fixes buggy relative path resolution in splat routes. Please see the [React Router docs][relativesplatpath] for more information.
+- **`v3_throwAbortReason`**: When a server-side request is aborted, Remix will throw the `request.signal.reason` instead of an error such as `new Error("query() call aborted...")`
 
 ## ignoredRouteFiles
 
@@ -276,3 +278,4 @@ There are a few conventions that Remix uses you should be aware of.
 [fetcherpersist-rfc]: https://github.com/remix-run/remix/discussions/7698
 [use-fetchers]: ../hooks/use-fetchers
 [use-fetcher]: ../hooks/use-fetcher
+[relativesplatpath]: https://reactrouter.com/en/main/hooks/use-resolved-path#splat-paths
diff --git a/docs/future/vite.md b/docs/future/vite.md
@@ -49,6 +49,7 @@ All other bundling-related options are now [configured with Vite][vite-config].
 The following subset of Remix config options are supported:
 
 - [appDirectory][app-directory]
+- [future][future]
 - [ignoredRouteFiles][ignored-route-files]
 - [publicPath][public-path]
 - [routes][routes]
@@ -1069,11 +1070,10 @@ Finally, we were inspired by how other frameworks implemented Vite support:
 We're definitely late to the Vite party, but we're excited to be here now!
 
 [vite]: https://vitejs.dev
-[supported-with-some-deprecations]: #add-mdx-plugin
 [template-vite-cloudflare]: https://github.com/remix-run/remix/tree/main/templates/unstable-vite-cloudflare
 [remix-config]: ../file-conventions/remix-config
 [app-directory]: ../file-conventions/remix-config#appdirectory
-[assets-build-directory]: ../file-conventions/remix-config#assetsbuilddirectory
+[future]: ../file-conventions/remix-config#future
 [ignored-route-files]: ../file-conventions/remix-config#ignoredroutefiles
 [public-path]: ../file-conventions/remix-config#publicpath
 [routes]: ../file-conventions/remix-config#routes

diff --git a/packages/remix-dev/__tests__/readConfig-test.ts b/packages/remix-dev/__tests__/readConfig-test.ts
@@ -38,6 +38,7 @@ describe("readConfig", () => {
         "future": {
           "v3_fetcherPersist": false,
           "v3_relativeSplatPath": false,
+          "v3_throwAbortReason": false,
         },
         "mdx": undefined,
         "postcss": true,

diff --git a/packages/remix-dev/config.ts b/packages/remix-dev/config.ts
@@ -36,6 +36,7 @@ type Dev = {
 interface FutureConfig {
   v3_fetcherPersist: boolean;
   v3_relativeSplatPath: boolean;
+  v3_throwAbortReason: boolean;
 }
 
 type NodeBuiltinsPolyfillOptions = Pick<
@@ -596,6 +597,7 @@ export async function resolveConfig(
   let future: FutureConfig = {
     v3_fetcherPersist: appConfig.future?.v3_fetcherPersist === true,
     v3_relativeSplatPath: appConfig.future?.v3_relativeSplatPath === true,
+    v3_throwAbortReason: appConfig.future?.v3_throwAbortReason === true,
   };
 
   if (appConfig.future) {

diff --git a/packages/remix-dev/package.json b/packages/remix-dev/package.json
@@ -29,7 +29,7 @@
     "@mdx-js/mdx": "^2.3.0",
     "@npmcli/package-json": "^4.0.1",
     "@remix-run/node": "2.5.1",
-    "@remix-run/router": "1.14.2",
+    "@remix-run/router": "0.0.0-experimental-c9f8a7b2",
     "@remix-run/server-runtime": "2.5.1",
     "@types/mdx": "^2.0.5",
     "@vanilla-extract/integration": "^6.2.0",

diff --git a/packages/remix-react/package.json b/packages/remix-react/package.json
@@ -16,10 +16,10 @@
   "typings": "dist/index.d.ts",
   "module": "dist/esm/index.js",
   "dependencies": {
-    "@remix-run/router": "1.14.2",
+    "@remix-run/router": "0.0.0-experimental-c9f8a7b2",
     "@remix-run/server-runtime": "2.5.1",
-    "react-router": "6.21.3",
-    "react-router-dom": "6.21.3"
+    "react-router": "0.0.0-experimental-c9f8a7b2",
+    "react-router-dom": "0.0.0-experimental-c9f8a7b2"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^5.17.0",