diff --git a/.changeset/olive-planets-think.md b/.changeset/olive-planets-think.md new file mode 100644 index 0000000000..f29fc4ef65 --- /dev/null +++ b/.changeset/olive-planets-think.md @@ -0,0 +1,28 @@ +--- +"react-router": patch +--- + +Add new `unstable_useTransitions` flag to routers to give users control over the usage of [`React.startTransition`](https://react.dev/reference/react/startTransition) and [`React.useOptimistic`](https://react.dev/reference/react/useOptimistic). + +- Framework Mode + Data Mode: + - ``/`` + - When left unset (current default behavior) + - Router state updates are wrapped in `React.startTransition` + - ⚠️ This can lead to buggy behaviors if you are wrapping your own navigations/fetchers in `React.startTransition` + - You should set the flag to `true` if you run into this scenario to get the enhanced `useOptimistic` behavior (requires React 19) + - When set to `true` + - Router state updates remain wrapped in `React.startTransition` (as they are without the flag) + - `Link`/`Form` navigations will be wrapped in `React.startTransition` + - A subset of router state info will be surfaced to the UI _during_ navigations via `React.useOptimistic` (i.e., `useNavigation()`, `useFetchers()`, etc.) + - ⚠️ This is a React 19 API so you must also be React 19 to opt into this flag for Framework/Data Mode + - When set to `false` + - The router will not leverage `React.startTransition` or `React.useOptimistic` on any navigations or state changes +- Declarative Mode + - `` + - When left unset + - Router state updates are wrapped in `React.startTransition` + - When set to `true` + - Router state updates remain wrapped in `React.startTransition` (as they are without the flag) + - `Link`/`Form` navigations will be wrapped in `React.startTransition` + - When set to `false` + - the router will not leverage `React.startTransition` on any navigations or state changes diff --git a/.changeset/real-chairs-exercise.md b/.changeset/real-chairs-exercise.md new file mode 100644 index 0000000000..63f2c55006 --- /dev/null +++ b/.changeset/real-chairs-exercise.md @@ -0,0 +1,5 @@ +--- +"react-router": patch +--- + +Fix the promise returned from `useNavigate` in Framework/Data Mode so that it properly tracks the duration of `popstate` navigations (i.e., `navigate(-1)`) diff --git a/docs/explanation/react-transitions.md b/docs/explanation/react-transitions.md new file mode 100644 index 0000000000..46d1a0624f --- /dev/null +++ b/docs/explanation/react-transitions.md @@ -0,0 +1,197 @@ +--- +title: React Transitions +unstable: true +--- + +# React Transitions + +[MODES: framework, data, declarative] + +
+
+ +[React 18][react-18] Introduced the concept of "transitions" which allow you differentiate urgent from non-urgent UI updates. We won't try to explain transitions or the underlying "concurrent rendering" concept in this doc, but you can read up on those concepts here: + +- [What is Concurrent React][concurrent] +- [Transitions][transitions] +- [`React.useTransition`][use-transition] +- [`React.startTransition`][start-transition] + +[React 19][react-19] continued enhancing the async/concurrent landscape and introduces [actions][actions] and support for using async functions in transitions. With the support for async transitions, a new [`React.useOptimistic][use-optimistic-blog] [hook][use-optimistic] was introduced that allows you to surface state updates during a transition to show users instant feedback. + +## Transitions in React Router + +The introduction of transitions in React makes the story of how React Router manages your navigations and router state a bit more complicated. These are powerful APIs but they don't come without some nuance and added complexity. We aim to make React Router work seamlessly with the new React features, but in some cases there may exist some tension between the new React ways to do things and some patterns you are already using in your React Router apps (i.e., pending states, optimistic UI). + +To ensure a smooth adoption story, we've introduced changes related to transitions behind an opt-in `unstable_useTransitions` flag so that you can upgrade in a non-breaking fashion. + +### Current Behavior + +Back in early 2023, Dan Abramov filed an [issue][dan-issue] for Remix v1 to use `React.startTransition` to "Remix router would be more Suspense-y". After a bit of clarification we [implemented][startTransition-pr] and shipped that in React Router [6.13.0][rr-6-13-0] via behind a `future.v7_startTransition` flag. In v7, that became the default behavior and all router state updates are currently wrapped in `React.startTransition`. + +This turns out to be potentially problematic behavior today for 2 reasons: + +- There are some valid use cases where you _don't_ want your updates wrapped in `startTransition` + - One specific issue is that `React.useSyncExternalStore` is incompatible with transitions ([^1][uses-transition-issue], [^2][uses-transition-tweet]) so if you are using that in your application, you can run into tearing issues when combined with `React.startTransition` + - React Router has a `flushSync` option on navigations to use [`React.flushSync`][flush-sync] for the state updates instead, but that's not always the proper solution +- React 19 has added a new `startTransition(() => Promise))` API as well as a new `useOptimistic` hook to surface updates during transitions + - Without some updates to React Router, `startTransition(() => navigate(path))` doesn't work as you might expect, because we are not using `useOptimistic` internally so router state updates don't surface during the navigation, which breaks hooks like `useNavigation` + +To provide a solution to both of the above issues, we're introducing a new `unstable_useTransitions` prop for the router components that will let you opt-out of using `startTransition` for router state upodates (solving the first issue), or opt-into a more enhanced usage of `startTransition` + `useOptimistic` (solving the second issue). Because the current behavior is a bit incomplete with the new React 19 APIs, we plan to make the opt-in behavior the default in React Router v8, but we will likely retain the opt-out flag for use cases such as `useSyncExternalStore`. + +### Opt-out via `unstable_useTransitions=false` + +If your application is not "transition-friendly" due to the usage of `useSyncExternalStore` (or other reasons), then you can opt-out via the prop: + +```tsx +// Framework Mode (entry.client.tsx) + + +// Data Mode + + +// Declarative Mode + +``` + +This will stop the router from wrapping internal state updates in `startTransition`. + +We do not recommend this as a long-term solution because opting out of transitions means that your application will not be fully compatible with the modern features of React, including `Suspense`, `use`, `startTransition`, `useOptimistic`, ``, etc. + +### Opt-in via `unstable_useTransitions=true` + +Opting into this feature in Framework or Data Mode requires that you are using React 19 because it needs access to [`React.useOptimistic`][use-optimistic] + +If you want to make your application play nicely with all of the new React 19 features that rely on concurrent mode and transitions, then you can opt-in via the new prop: + +```tsx +// Framework Mode (entry.client.tsx) + + +// Data Mode + + +// Declarative Mode + +``` + +With this flag enabled: + +- All internal state updates are wrapped in `React.startTransition` (current behavior without the flag) +- All ``/`
` navigations will be wrapped in `React.startTransition`, using the promise returned by `useNavigate`/`useSubmit` so that the transition lasts for the duration of the navigation + - `useNavigate`/`useSubmit` do not automatically wrap in `React.startTransition`, so you can opt-out of a transition-enabled navigation by using those directly +- In Framework/Data modes, a subset of the router state updates during a navigation will be surfaced to the UI via `useOptimistic` + - State related to the _ongoing_ navigation and all fetcher information will be surfaced: + - `state.navigation` for `useNavigation()` + - `state.revalidation` for `useRevalidator()` + - `state.actionData` for `useActionData()` + - `state.fetchers` for `useFetcher()` and `useFetchers()` + - State related to the _current_ location will not be surfaced: + - `state.location` for `useLocation` + - `state.matches` for `useMatches()`, + - `state.loaderData` for `useLoaderData()` + - `state.errors` for `useRouteError()` + - etc. + +Enabling this flag means that you can now have fully-transition-enabled navigations that play nicely with any other ongoing transition-enabled aspects of your application. + +The only APIs that are automatically wrapped in an async transition are `` and ``. For everything else, you need to wrap the operation in `startTransition` yourself. + +```tsx +// Automatically transition-enabled + + + +// Manually transition-enabled +startTransition(() => navigate("/path")); +startTransition(() => submit(data, { method: 'post', action: "/path" })); +startTransition(() => fetcher.load("/path")); +startTransition(() => fetcher.submit(data, { method: "post", action: "/path" })); + +// Not transition-enabled +navigate("/path"); +submit(data, { method: 'post', action: "/path" }); +fetcher.load("/path"); +fetcher.submit(data, { method: "post", action: "/path" }); +``` + +**Important:** You must always `return` or `await` the `navigate` promise inside `startTransition` so that the transition encompasses the full duration of the navigation. If you forget to `return` or `await` the promise, the transition will end prematurely and things won't work as expected. + +```tsx +// ✅ Returned promise +startTransition(() => navigate("/path")); +startTransition(() => { + setOptimistic(something); + return navigate("/path")); +}); + +// ✅ Awaited promise +startTransition(async () => { + setOptimistic(something); + await navigate("/path")); +}); + +// ❌ Non-returned promise +startTransition(() => { + setOptimistic(something); + navigate("/path")); +}); + +// ❌ Non-Awaited promise +startTransition(async () => { + setOptimistic(something); + navigate("/path")); +}); +``` + +#### `popstate` navigations + +Due to limitations in React itself, [`popstate`][popstate] navigations cannot be transition-enabled. Any state updates during a `popstate` event are [automatically][popstate-sync-pr] [flushed][bsky-ricky-popstate] synchronously so that the browser can properly restore scroll position and form data. + +However, the browser can only do this if the navigation is instant. If React Router needs to run loaders on a back navigation, the browser will not be able to restore scroll position or form data ([``][scroll-restoration] can handle scroll position for you). + +It is therefore not recommended to wrap `navigate(n)` navigations in `React.startTransition` +unless you can manage your pending UI with local transition state (`React.useTransition`). + +```tsx +// ❌ This won't work correctly +startTransition(() => navigate(-1)); +``` + +If you _need_ programmatic back-navigations to be transition-friendly in your app, you can introduce a small hack to prevent React from detecting the event and letting the transition work as expected. React checks `window.event` to determine if the state updates are part of a `popstate` event, so if you clear that out in your own listener you can trick React into treating it like any other state update: + +```tsx +// Add this to the top of your browser entry file +window.addEventListener( + "popstate", + () => { + window.event = null; + }, + { + capture: true, + }, +); +``` + +Please be aware this is a hack, has not been thoroughly tested, and may not continue to work if React changes their underlying implementation. We did get their [permission][ricky-bsky-event-hack] to mention it though 😉 + +[react-18]: https://react.dev/blog/2022/03/29/react-v18 +[concurrent]: https://react.dev/blog/2022/03/29/react-v18#what-is-concurrent-react +[transitions]: https://react.dev/blog/2022/03/29/react-v18#new-feature-transitions +[use-transition]: https://react.dev/reference/react/useTransition#reference +[start-transition]: https://react.dev/reference/react/startTransition +[react-19]: https://react.dev/blog/2024/12/05/react-19 +[actions]: https://react.dev/blog/2024/12/05/react-19#actions +[use-optimistic-blog]: https://react.dev/blog/2024/12/05/react-19#new-hook-optimistic-updates +[use-optimistic]: https://react.dev/reference/react/useOptimistic +[flush-sync]: https://react.dev/reference/react-dom/flushSync +[dan-issue]: https://github.com/remix-run/remix/issues/5763 +[startTransition-pr]: https://github.com/remix-run/react-router/pull/10438 +[rr-6-13-0]: https://github.com/remix-run/react-router/blob/main/CHANGELOG.md#v6130 +[uses-transition-issue]: https://github.com/facebook/react/issues/26382 +[uses-transition-tweet]: https://x.com/rickhanlonii/status/1683636856808775682 +[bsky-ricky-popstate]: https://bsky.app/profile/ricky.fm/post/3m5ujj6tuks2e +[popstate-sync-pr]: https://github.com/facebook/react/pull/26025 +[scroll-restoration]: ../api/components/ScrollRestoration +[ricky-bsky-event-hack]: https://bsky.app/profile/ricky.fm/post/3m5wgqw3swc26 +[popstate]: https://developer.mozilla.org/en-US/docs/Web/API/Window/popstate_event diff --git a/packages/react-router/__tests__/data-memory-router-test.tsx b/packages/react-router/__tests__/data-memory-router-test.tsx index 248536eee1..b46e5d6576 100644 --- a/packages/react-router/__tests__/data-memory-router-test.tsx +++ b/packages/react-router/__tests__/data-memory-router-test.tsx @@ -1067,6 +1067,62 @@ describe("createMemoryRouter", () => { ]); }); + it("exposes promise from useNavigate (popstate)", async () => { + let sequence: string[] = []; + let router = createMemoryRouter( + [ + { + path: "/", + async loader() { + sequence.push("loader start"); + await new Promise((r) => setTimeout(r, 100)); + sequence.push("loader end"); + return null; + }, + Component() { + sequence.push("render"); + return

Home

; + }, + }, + { + path: "/page", + Component: () => { + let navigate = useNavigate(); + return ( + <> +

Page

+ + + ); + }, + }, + ], + { initialEntries: ["/", "/page"] }, + ); + + let { container } = render(); + + expect(getHtml(container)).toContain("Page"); + fireEvent.click(screen.getByText("Back")); + await waitFor(() => screen.getByText("Home")); + + expect(sequence).toEqual([ + "call navigate", + "loader start", + "loader end", + "navigate resolved", + "render", + ]); + }); + it("exposes promise from useSubmit", async () => { let sequence: string[] = []; let router = createMemoryRouter([ diff --git a/packages/react-router/__tests__/dom/data-browser-router-test.tsx b/packages/react-router/__tests__/dom/data-browser-router-test.tsx index 6d05d6e883..9648e1f2aa 100644 --- a/packages/react-router/__tests__/dom/data-browser-router-test.tsx +++ b/packages/react-router/__tests__/dom/data-browser-router-test.tsx @@ -2527,6 +2527,75 @@ function testDomRouter( `); }); + it("exposes promise from useNavigate (popstate)", async () => { + let sequence: string[] = []; + let router = createTestRouter( + [ + { + id: "home", + path: "/", + async loader() { + sequence.push("loader start"); + await new Promise((r) => setTimeout(r, 100)); + sequence.push("loader end"); + return null; + }, + Component() { + sequence.push("render"); + return ( + <> +

Home

+ Go to page + + ); + }, + }, + { + path: "/page", + Component: () => { + let navigate = useNavigate(); + return ( + <> +

Page

+ + + ); + }, + }, + ], + { + hydrationData: { loaderData: { home: null } }, + window: getWindow("/"), + }, + ); + + let { container } = render(); + + expect(getHtml(container)).toContain("Home"); + fireEvent.click(screen.getByText("Go to page")); + await waitFor(() => screen.getByText("Page")); + sequence.splice(0); // clear sequence + + fireEvent.click(screen.getByText("Back")); + await waitFor(() => screen.getByText("Home")); + + expect(sequence).toEqual([ + "call navigate", + "loader start", + "loader end", + "navigate resolved", + "render", + ]); + }); + describe("", () => { function NoActionComponent() { return ( diff --git a/packages/react-router/__tests__/react-transitions-test.tsx b/packages/react-router/__tests__/react-transitions-test.tsx new file mode 100644 index 0000000000..e3d6a5e4b4 --- /dev/null +++ b/packages/react-router/__tests__/react-transitions-test.tsx @@ -0,0 +1,1368 @@ +import "@testing-library/jest-dom"; +import { + act, + fireEvent, + render, + screen, + waitFor, +} from "@testing-library/react"; +import * as React from "react"; +import { + Outlet, + RouterProvider, + createMemoryRouter, + useLoaderData, + useNavigation, + useRevalidator, +} from "react-router"; + +import { + Form, + Link, + createBrowserRouter, + useActionData, + useFetcher, + useNavigate, + useSubmit, +} from "../index"; +import { createDeferred, tick } from "./router/utils/utils"; +import getWindow from "./utils/getWindow"; + +describe("react transitions", () => { + describe("", () => { + it("normal navigations surface all updates", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let navigate = useNavigate(); + return ( + + ); + }, + }, + { + path: "page", + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render(); + + await waitFor(() => screen.getByText("Go to page")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#link")!); + // Without useOptimistic under the hood, our mid-navigation state updates don't surface + await waitFor(() => screen.getByText("Navigation:loading")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:1")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:loading")).toBeDefined(); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("normal submissions surface all updates", async () => { + let actionDfd = createDeferred(); + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let submit = useSubmit(); + return ( + + ); + }, + }, + { + path: "page", + action: () => actionDfd.promise, + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render(); + + await waitFor(() => screen.getByText("Submit")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#submit")!); + await waitFor(() => screen.getByText("Navigation:submitting")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:1")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:submitting")).toBeDefined(); + + actionDfd.resolve("Action"); + await waitFor(() => screen.getByText("Navigation:loading")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:3")); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:3")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("navigations can be manually wrapped in startTransition (buggy optimistic behavior)", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let navigate = useNavigate(); + return ( + + ); + }, + }, + { + path: "page", + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render(); + + await waitFor(() => screen.getByText("Go to page")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // Without useOptimistic under the hood, our mid-navigation state updates + // don't surface + await fireEvent.click(container.querySelector("#link")!); + await waitFor(() => screen.getByText("Navigation:idle")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("submissions can be manually wrapped in startTransition (buggy optimistic behavior)", async () => { + let actionDfd = createDeferred(); + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let submit = useSubmit(); + return ( + + ); + }, + }, + { + path: "page", + action: () => actionDfd.promise, + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render(); + + await waitFor(() => screen.getByText("Submit")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // Without useOptimistic under the hood, our mid-navigation state updates + // don't surface + await fireEvent.click(container.querySelector("#submit")!); + await waitFor(() => screen.getByText("Navigation:idle")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + + await act(() => { + actionDfd.resolve("Action"); + }); + await tick(); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:3")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + }); + + describe("", () => { + it("navigations are not transition-enabled", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let navigate = useNavigate(); + return ( + + ); + }, + }, + { + path: "page", + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Go to page")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // Without transitions enabled, all updates surface during navigation + await fireEvent.click(container.querySelector("#link")!); + await waitFor(() => screen.getByText("Navigation:loading")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:1")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:loading")).toBeDefined(); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("submissions are not transition-enabled", async () => { + let actionDfd = createDeferred(); + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let submit = useSubmit(); + return ( + + ); + }, + }, + { + path: "page", + action: () => actionDfd.promise, + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render(); + + await waitFor(() => screen.getByText("Submit")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // Without transitions enabled, all updates surface during navigation + await fireEvent.click(container.querySelector("#submit")!); + await waitFor(() => screen.getByText("Navigation:submitting")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:1")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:submitting")).toBeDefined(); + + actionDfd.resolve("Action"); + await waitFor(() => screen.getByText("Navigation:loading")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:3")); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:3")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + }); + + describe("", () => { + it("Link navigations are transition-enabled", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let navigate = useNavigate(); + return ( + + Go to page + + ); + }, + }, + { + path: "page", + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Go to page")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // With transitions enabled, our updates surface via useOptimistic, but + // other transition-enabled updates do not + await fireEvent.click(container.querySelector("#link")!); + await waitFor(() => screen.getByText("Navigation:loading")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + expect(screen.getByText("Navigation:loading")).toBeDefined(); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("useNavigate navigations are not transition-enabled", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let navigate = useNavigate(); + return ( + + ); + }, + }, + { + path: "page", + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Go to page")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // With transitions enabled, our updates surface via useOptimistic, but + // other transition-enabled updates do not + await fireEvent.click(container.querySelector("#link")!); + await waitFor(() => screen.getByText("Navigation:loading")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:1")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:loading")).toBeDefined(); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("useNavigate navigations can be transition-enabled", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let navigate = useNavigate(); + let [pending, startTransition] = React.useTransition(); + return ( + + ); + }, + }, + { + path: "page", + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Go to page")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // With transitions enabled, our updates surface via useOptimistic, but + // other transition-enabled updates do not + await fireEvent.click(container.querySelector("#link")!); + await waitFor(() => screen.getByText("Navigation:loading")); + expect(screen.getByText("Increment:0")).toBeDefined(); + expect(screen.getByText("Go to page (pending)")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + expect(screen.getByText("Navigation:loading")).toBeDefined(); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("Form submissions are transition-enabled", async () => { + let actionDfd = createDeferred(); + let loaderDfd = createDeferred(); + let router = createBrowserRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + return ( + + + + ); + }, + }, + { + path: "page", + action: () => actionDfd.promise, + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Submit")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // Without transitions enabled, all updates surface during navigation + await fireEvent.click(container.querySelector("#submit")!); + await waitFor(() => screen.getByText("Navigation:submitting")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + expect(screen.getByText("Navigation:submitting")).toBeDefined(); + + actionDfd.resolve("Action"); + await waitFor(() => screen.getByText("Navigation:loading")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:3")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("useSubmit submissions are not transition-enabled", async () => { + let actionDfd = createDeferred(); + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let submit = useSubmit(); + return ( + + ); + }, + }, + { + path: "page", + action: () => actionDfd.promise, + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Submit")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // Without transitions enabled, all updates surface during navigation + await fireEvent.click(container.querySelector("#submit")!); + await waitFor(() => screen.getByText("Navigation:submitting")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:1")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Navigation:submitting")).toBeDefined(); + + actionDfd.resolve("Action"); + await waitFor(() => screen.getByText("Navigation:loading")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:3")); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:3")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("useSubmit submissions can be transition-enabled", async () => { + let actionDfd = createDeferred(); + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + let submit = useSubmit(); + let [pending, startTransition] = React.useTransition(); + return ( + + ); + }, + }, + { + path: "page", + action: () => actionDfd.promise, + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + ], + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Submit")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // Without transitions enabled, all updates surface during navigation + await fireEvent.click(container.querySelector("#submit")!); + await waitFor(() => screen.getByText("Navigation:submitting")); + expect(screen.getByText("Increment:0")).toBeDefined(); + expect(screen.getByText("Submit (pending)")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + expect(screen.getByText("Navigation:submitting")).toBeDefined(); + + actionDfd.resolve("Action"); + await waitFor(() => screen.getByText("Navigation:loading")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + await waitFor(() => screen.getByText("Increment:3")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("actionData surfaces during the transition", async () => { + let actionDfd = createDeferred(); + let loaderDfd = createDeferred(); + let router = createBrowserRouter( + [ + { + id: "index", + path: "/", + action: () => actionDfd.promise, + loader: () => loaderDfd.promise, + Component() { + let loaderData = useLoaderData(); + let actionData = useActionData(); + let navigation = useNavigation(); + return ( + <> +

{`Loader:${loaderData}`}

+

{`Action:${actionData}`}

+

{`Navigation:${navigation.state}`}

+
+ +
+ + ); + }, + }, + ], + { + hydrationData: { + loaderData: { + index: "initial", + }, + }, + window: getWindow("/"), + }, + ); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Submit")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Loader:initial")).toBeDefined(); + expect(screen.getByText("Action:undefined")).toBeDefined(); + + await fireEvent.click(container.querySelector("#submit")!); + await waitFor(() => screen.getByText("Navigation:submitting")); + + actionDfd.resolve("action-data"); + await waitFor(() => screen.getByText("Navigation:loading")); + expect(screen.getByText("Loader:initial")).toBeDefined(); + expect(screen.getByText("Action:action-data")).toBeDefined(); + + loaderDfd.resolve("revalidated"); + await waitFor(() => screen.getByText("Navigation:idle")); + expect(screen.getByText("Loader:revalidated")).toBeDefined(); + expect(screen.getByText("Action:action-data")).toBeDefined(); + }); + + it("useFetcher is not transition-enabled", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let fetcher = useFetcher(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Fetcher:${fetcher.state}:${fetcher.data}`}

+ + + + + ); + }, + }, + { + path: "fetch", + loader: () => loaderDfd.promise, + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Fetch")); + expect(screen.getByText("Fetcher:idle:undefined")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // With transitions enabled, our updates surface via useOptimistic, but + // other transition-enabled updates do not + await fireEvent.click(container.querySelector("#fetch")!); + await waitFor(() => screen.getByText("Fetcher:loading:undefined")); + expect(screen.getByText("Increment:0")).toBeDefined(); + expect(screen.getByText("Fetch")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:1")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Fetcher:loading:undefined")).toBeDefined(); + + loaderDfd.resolve("data"); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Fetcher:idle:data")).toBeDefined(); + }); + + it("useFetcher can be transition-enabled", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let fetcher = useFetcher(); + let [count, setCount] = React.useState(0); + let [pending, startTransition] = React.useTransition(); + return ( + <> +

{`Fetcher:${fetcher.state}:${fetcher.data}`}

+ + + + + ); + }, + }, + { + path: "fetch", + loader: () => loaderDfd.promise, + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Fetch")); + expect(screen.getByText("Fetcher:idle:undefined")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + + // With transitions enabled, our updates surface via useOptimistic, but + // other transition-enabled updates do not + await fireEvent.click(container.querySelector("#fetch")!); + await waitFor(() => screen.getByText("Fetcher:loading:undefined")); + expect(screen.getByText("Increment:0")).toBeDefined(); + expect(screen.getByText("Fetch (pending)")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + expect(screen.getByText("Fetcher:loading:undefined")).toBeDefined(); + + loaderDfd.resolve("data"); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Fetcher:idle:data")).toBeDefined(); + }); + + it("fetcher updates surface mid-navigation", async () => { + let loaderDfd = createDeferred(); + let fetcherDfd = createDeferred(); + let router = createMemoryRouter([ + { + path: "/", + Component() { + let navigation = useNavigation(); + let fetcher = useFetcher(); + return ( + <> +

{`Navigation:${navigation.state}`}

+ + + + ); + }, + children: [ + { + index: true, + Component() { + return ( + + Go to page + + ); + }, + }, + { + path: "page", + loader: () => loaderDfd.promise, + Component() { + return

{useLoaderData()}

; + }, + }, + { + path: "fetch", + loader: () => fetcherDfd.promise, + }, + ], + }, + ]); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Go to page")); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + expect(screen.getByText("Fetcher idle:undefined")).toBeDefined(); + + // With transitions enabled, our updates surface via useOptimistic, but + // other transition-enabled updates do not + await fireEvent.click(container.querySelector("#link")!); + await waitFor(() => screen.getByText("Navigation:loading")); + expect(screen.getByText("Fetcher idle:undefined")).toBeDefined(); + + await fireEvent.click(container.querySelector("#fetch")!); + await waitFor(() => screen.getByText("Fetcher loading:undefined")); + expect(screen.getByText("Navigation:loading")).toBeDefined(); + + fetcherDfd.resolve("data"); + await waitFor(() => screen.getByText("Fetcher idle:data")); + expect(screen.getByText("Navigation:loading")).toBeDefined(); + + loaderDfd.resolve("Page"); + await waitFor(() => screen.getByText("Page")); + expect(screen.getByText("Fetcher idle:data")).toBeDefined(); + expect(screen.getByText("Navigation:idle")).toBeDefined(); + }); + + it("useRevalidator is not transition-enabled", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter( + [ + { + id: "index", + path: "/", + loader: () => loaderDfd.promise, + Component() { + let data = useLoaderData(); + let revalidator = useRevalidator(); + let [count, setCount] = React.useState(0); + return ( + <> +

{`Loader:${data}`}

+

{`Revalidator:${revalidator.state}`}

+ + + + ); + }, + }, + ], + { + hydrationData: { + loaderData: { + index: "initial", + }, + }, + }, + ); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Revalidate")); + expect(screen.getByText("Revalidator:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + expect(screen.getByText("Loader:initial")).toBeDefined(); + + // With transitions enabled, our updates surface via useOptimistic, but + // other transition-enabled updates do not + await fireEvent.click(container.querySelector("#revalidate")!); + await waitFor(() => screen.getByText("Revalidator:loading")); + expect(screen.getByText("Increment:0")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:1")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Revalidator:loading")).toBeDefined(); + + loaderDfd.resolve("revalidated"); + await waitFor(() => screen.getByText("Revalidator:idle")); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Loader:revalidated")).toBeDefined(); + }); + + it("useRevalidator can be transition-enabled", async () => { + let loaderDfd = createDeferred(); + let router = createMemoryRouter( + [ + { + id: "index", + path: "/", + loader: () => loaderDfd.promise, + Component() { + let data = useLoaderData(); + let revalidator = useRevalidator(); + let [count, setCount] = React.useState(0); + let [pending, startTransition] = React.useTransition(); + return ( + <> +

{`Loader:${data}`}

+

{`Revalidator:${revalidator.state}`}

+ + + + ); + }, + }, + ], + { + hydrationData: { + loaderData: { + index: "initial", + }, + }, + }, + ); + + let { container } = render( + , + ); + + await waitFor(() => screen.getByText("Revalidate")); + expect(screen.getByText("Revalidator:idle")).toBeDefined(); + expect(screen.getByText("Increment:0")).toBeDefined(); + expect(screen.getByText("Loader:initial")).toBeDefined(); + + // With transitions enabled, our updates surface via useOptimistic, but + // other transition-enabled updates do not + await fireEvent.click(container.querySelector("#revalidate")!); + await waitFor(() => screen.getByText("Revalidator:loading")); + expect(screen.getByText("Increment:0")).toBeDefined(); + expect(screen.getByText("Revalidate (pending)")).toBeDefined(); + + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + await fireEvent.click(container.querySelector("#increment")!); + await waitFor(() => screen.getByText("Increment:0")); + expect(screen.getByText("Revalidator:loading")).toBeDefined(); + + loaderDfd.resolve("revalidated"); + await waitFor(() => screen.getByText("Revalidator:idle")); + await waitFor(() => screen.getByText("Increment:2")); + expect(screen.getByText("Loader:revalidated")).toBeDefined(); + }); + }); +}); diff --git a/packages/react-router/__tests__/router/router-test.ts b/packages/react-router/__tests__/router/router-test.ts index b598f7cadd..c5f9bbee35 100644 --- a/packages/react-router/__tests__/router/router-test.ts +++ b/packages/react-router/__tests__/router/router-test.ts @@ -5,7 +5,7 @@ import type { AgnosticDataRouteObject, AgnosticRouteObject, } from "../../lib/router/utils"; -import { data, ErrorResponseImpl } from "../../lib/router/utils"; +import { data, ErrorResponseImpl, redirect } from "../../lib/router/utils"; import { urlMatch } from "./utils/custom-matchers"; import { @@ -883,6 +883,254 @@ describe("a router", () => { ), }); }); + + it("handles promises for navigations", async () => { + let aDfd = createDeferred(); + + let router = createRouter({ + history: createMemoryHistory(), + routes: [ + { + id: "index", + path: "/", + }, + { + id: "a", + path: "/a", + loader: () => aDfd.promise, + }, + ], + }); + + let sequence: string[] = []; + router.navigate("/a").then(() => sequence.push("/a complete")); + await tick(); + expect(sequence).toEqual([]); + aDfd.resolve("A DATA"); + await tick(); + expect(router.state.navigation).toBe(IDLE_NAVIGATION); + expect(sequence).toEqual(["/a complete"]); + }); + + it("handles promises for popstate navigations", async () => { + let indexDfd = createDeferred(); + + let router = createRouter({ + history: createMemoryHistory(), + routes: [ + { + id: "index", + path: "/", + loader: () => indexDfd.promise, + }, + { + id: "a", + path: "/a", + }, + ], + hydrationData: { + loaderData: { + index: "INDEX DATA", + }, + }, + }).initialize(); + + let sequence: string[] = []; + await router.navigate("/a"); + expect(router.state.location.pathname).toBe("/a"); + expect(router.state.navigation).toBe(IDLE_NAVIGATION); + + router.navigate(-1).then(() => sequence.push("back complete")); + await tick(); + expect(sequence).toEqual([]); + + indexDfd.resolve("INDEX DATA"); + await tick(); + expect(router.state.navigation).toBe(IDLE_NAVIGATION); + expect(sequence).toEqual(["back complete"]); + }); + + it("handles promises for interrupted navigations", async () => { + let indexDfd = createDeferred(); + let aDfd = createDeferred(); + let bDfd = createDeferred(); + let cDfd = createDeferred(); + + let router = createRouter({ + history: createMemoryHistory(), + routes: [ + { + id: "index", + path: "/", + loader: () => indexDfd.promise, + }, + { + id: "a", + path: "/a", + loader: () => aDfd.promise, + }, + { + id: "b", + path: "/b", + loader: () => bDfd.promise, + }, + { + id: "c", + path: "/c", + loader: () => cDfd.promise, + }, + ], + hydrationData: { + loaderData: { + index: "INDEX DATA", + }, + }, + }); + + let sequence: string[] = []; + router.navigate("/a").then(() => sequence.push("/a complete")); + aDfd.resolve("A DATA"); + await tick(); + expect(router.state.navigation).toBe(IDLE_NAVIGATION); + + router.navigate("/b").then(() => sequence.push("/b complete")); + await tick(); + expect(sequence).toEqual(["/a complete"]); + + router.navigate("/c").then(() => sequence.push("/c complete")); + await tick(); + expect(sequence).toEqual(["/a complete", "/b complete"]); + + bDfd.resolve("B DATA"); // no-op + await tick(); + expect(router.state.navigation.state).toBe("loading"); + expect(sequence).toEqual(["/a complete", "/b complete"]); + + cDfd.resolve("C DATA"); + await tick(); + expect(router.state.navigation).toBe(IDLE_NAVIGATION); + expect(sequence).toEqual(["/a complete", "/b complete", "/c complete"]); + }); + + it("handles promises for interrupted popstate navigations", async () => { + let indexDfd = createDeferred(); + let aDfd = createDeferred(); + let bDfd = createDeferred(); + + let router = createRouter({ + history: createMemoryHistory(), + routes: [ + { + id: "index", + path: "/", + loader: () => indexDfd.promise, + }, + { + id: "a", + path: "/a", + loader: () => aDfd.promise, + }, + { + id: "b", + path: "/b", + loader: () => bDfd.promise, + }, + ], + hydrationData: { + loaderData: { + index: "INDEX DATA", + }, + }, + }); + + let sequence: string[] = []; + router.navigate("/a").then(() => sequence.push("/a complete")); + aDfd.resolve("A DATA"); + await tick(); + expect(router.state.navigation).toBe(IDLE_NAVIGATION); + + router.navigate(-1).then(() => sequence.push("back complete")); + await tick(); + expect(sequence).toEqual(["/a complete"]); + + router.navigate("/b").then(() => sequence.push("/b complete")); + await tick(); + expect(sequence).toEqual(["/a complete", "back complete"]); + + indexDfd.resolve("A DATA"); + await tick(); + expect(router.state.navigation.state).toBe("loading"); + expect(sequence).toEqual(["/a complete", "back complete"]); + + bDfd.resolve("B DATA"); + await tick(); + expect(router.state.navigation).toBe(IDLE_NAVIGATION); + expect(sequence).toEqual(["/a complete", "back complete", "/b complete"]); + }); + + it("handles promises for fetcher redirect interrupted popstate navigations", async () => { + let indexDfd = createDeferred(); + let bDfd = createDeferred(); + + let router = createRouter({ + history: createMemoryHistory(), + routes: [ + { + id: "index", + path: "/", + loader: () => indexDfd.promise, + }, + { + id: "a", + path: "/a", + }, + { + id: "b", + path: "/b", + loader: () => bDfd.promise, + }, + { + id: "fetch", + path: "/fetch", + loader: () => redirect("/b"), + }, + ], + hydrationData: { + loaderData: { + index: "INDEX DATA", + }, + }, + }); + + let sequence: string[] = []; + router.navigate("/a").then(() => sequence.push("/a complete")); + await tick(); + expect(router.state.navigation).toBe(IDLE_NAVIGATION); + + router.navigate(-1).then(() => sequence.push("back complete")); + await tick(); + expect(sequence).toEqual(["/a complete"]); + + router + .fetch("key", "a", "/fetch") + .then(() => sequence.push("fetch redirect complete")); + await tick(); + expect(sequence).toEqual(["/a complete", "back complete"]); + + indexDfd.resolve("A DATA"); // no-op + await tick(); + expect(router.state.navigation.state).toBe("loading"); + expect(sequence).toEqual(["/a complete", "back complete"]); + + bDfd.resolve("B DATA"); + await tick(); + expect(router.state.navigation).toBe(IDLE_NAVIGATION); + expect(sequence).toEqual([ + "/a complete", + "back complete", + "fetch redirect complete", + ]); + }); }); describe("data loading (new)", () => { diff --git a/packages/react-router/lib/components.tsx b/packages/react-router/lib/components.tsx index e4ec6e080e..fa2d6b03e5 100644 --- a/packages/react-router/lib/components.tsx +++ b/packages/react-router/lib/components.tsx @@ -74,12 +74,33 @@ import { } from "./hooks"; import type { ViewTransition } from "./dom/global"; import { warnOnce } from "./server-runtime/warnings"; -import type { - unstable_ClientInstrumentation, - unstable_InstrumentRouteFunction, - unstable_InstrumentRouterFunction, -} from "./router/instrumentation"; -import { instrumentClientSideRouter } from "./router/instrumentation"; +import type { unstable_ClientInstrumentation } from "./router/instrumentation"; + +/** + * Webpack can fail to compile on against react versions without this export + * complains that `startTransition` doesn't exist in `React`. + * + * Using the string constant directly at runtime fixes the webpack build issue + * but can result in terser stripping the actual call at minification time. + * + * Grabbing an exported reference once up front resolves that issue. + * + * See https://github.com/remix-run/react-router/issues/10579 + */ +const USE_OPTIMISTIC = "useOptimistic"; +// @ts-expect-error Needs React 19 types but we develop against 18 +const useOptimisticImpl = React[USE_OPTIMISTIC]; + +function useOptimisticSafe( + val: T, +): [T, React.Dispatch>] { + if (useOptimisticImpl) { + // eslint-disable-next-line react-hooks/rules-of-hooks + return useOptimisticImpl(val); + } else { + return [val, () => undefined]; + } +} export function mapRouteProperties(route: RouteObject) { let updates: Partial & { hasErrorBoundary: boolean } = { @@ -360,143 +381,25 @@ export interface RouterProviderProps { * ``` */ unstable_onError?: unstable_ClientOnErrorFunction; -} - -function shallowDiff(a: any, b: any) { - if (a === b) { - return false; - } - let aKeys = Object.keys(a); - let bKeys = Object.keys(b); - if (aKeys.length !== bKeys.length) { - return true; - } - for (let key of aKeys) { - if (a[key] !== b[key]) { - return true; - } - } - return false; -} - -export function UNSTABLE_TransitionEnabledRouterProvider({ - router, - flushSync: reactDomFlushSyncImpl, - unstable_onError, -}: RouterProviderProps) { - let fetcherData = React.useRef>(new Map()); - let [revalidating, startRevalidation] = React.useTransition(); - let [state, setState] = React.useState(router.state); - - (router as any).__setPendingRerender = (promise: Promise<() => void>) => - startRevalidation( - // @ts-expect-error - need react 19 types for this to be async - async () => { - const rerender = await promise; - startRevalidation(() => { - rerender(); - }); - }, - ); - - let navigator = React.useMemo((): Navigator => { - return { - createHref: router.createHref, - encodeLocation: router.encodeLocation, - go: (n) => router.navigate(n), - push: (to, state, opts) => - router.navigate(to, { - state, - preventScrollReset: opts?.preventScrollReset, - }), - replace: (to, state, opts) => - router.navigate(to, { - replace: true, - state, - preventScrollReset: opts?.preventScrollReset, - }), - }; - }, [router]); - - let basename = router.basename || "/"; - - let dataRouterContext = React.useMemo( - () => ({ - router, - navigator, - static: false, - basename, - unstable_onError, - }), - [router, navigator, basename, unstable_onError], - ); - - React.useLayoutEffect(() => { - return router.subscribe( - (newState, { deletedFetchers, flushSync, viewTransitionOpts }) => { - newState.fetchers.forEach((fetcher, key) => { - if (fetcher.data !== undefined) { - fetcherData.current.set(key, fetcher.data); - } - }); - deletedFetchers.forEach((key) => fetcherData.current.delete(key)); - - const diff = shallowDiff(state, newState); - - if (!diff) return; - - if (flushSync) { - if (reactDomFlushSyncImpl) { - reactDomFlushSyncImpl(() => setState(newState)); - } else { - setState(newState); - } - } else { - React.startTransition(() => { - setState(newState); - }); - } - }, - ); - }, [router, reactDomFlushSyncImpl, state]); - - // The fragment and {null} here are important! We need them to keep React 18's - // useId happy when we are server-rendering since we may have a