Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove future.v7_partialHydration flag #11725

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Remove future.v7_partialHydration flag #11725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .changeset/tasty-penguins-live.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
"react-router-dom": major
"react-router": major
---

- Remove the `future.v7_partialHydration` flag
- This also removes the `<RouterProvider fallbackElement>` prop
- To migrate, move the `fallbackElement` to a `hydrateFallbackElement`/`HydrateFallback` on your root route
- Also worth nothing there is a related breaking changer with this future flag:
- Without `future.v7_partialHydration` (when using `fallbackElement`), `state.navigation` was populated during the initial load
- With `future.v7_partialHydration`, `state.navigation` remains in an `"idle"` state during the initial load
20 changes: 20 additions & 0 deletions packages/react-router/__tests__/createRoutesFromChildren-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@ describe("creating routes from JSX", () => {
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": undefined,
"caseSensitive": undefined,
"children": [
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": undefined,
"caseSensitive": undefined,
"element": <h1>
Expand All @@ -33,6 +35,7 @@ describe("creating routes from JSX", () => {
"errorElement": undefined,
"handle": undefined,
"hasErrorBoundary": false,
"hydrateFallbackElement": undefined,
"id": "0-0",
"index": undefined,
"lazy": undefined,
Expand All @@ -43,6 +46,7 @@ describe("creating routes from JSX", () => {
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": undefined,
"caseSensitive": undefined,
"element": <h1>
Expand All @@ -51,6 +55,7 @@ describe("creating routes from JSX", () => {
"errorElement": undefined,
"handle": undefined,
"hasErrorBoundary": false,
"hydrateFallbackElement": undefined,
"id": "0-1",
"index": undefined,
"lazy": undefined,
Expand All @@ -61,12 +66,14 @@ describe("creating routes from JSX", () => {
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": undefined,
"caseSensitive": undefined,
"children": [
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": undefined,
"caseSensitive": undefined,
"element": <h1>
Expand All @@ -75,6 +82,7 @@ describe("creating routes from JSX", () => {
"errorElement": undefined,
"handle": undefined,
"hasErrorBoundary": false,
"hydrateFallbackElement": undefined,
"id": "0-2-0",
"index": true,
"lazy": undefined,
Expand All @@ -85,6 +93,7 @@ describe("creating routes from JSX", () => {
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": undefined,
"caseSensitive": undefined,
"element": <h1>
Expand All @@ -93,6 +102,7 @@ describe("creating routes from JSX", () => {
"errorElement": undefined,
"handle": undefined,
"hasErrorBoundary": false,
"hydrateFallbackElement": undefined,
"id": "0-2-1",
"index": undefined,
"lazy": undefined,
Expand All @@ -105,6 +115,7 @@ describe("creating routes from JSX", () => {
"errorElement": undefined,
"handle": undefined,
"hasErrorBoundary": false,
"hydrateFallbackElement": undefined,
"id": "0-2",
"index": undefined,
"lazy": undefined,
Expand All @@ -117,6 +128,7 @@ describe("creating routes from JSX", () => {
"errorElement": undefined,
"handle": undefined,
"hasErrorBoundary": false,
"hydrateFallbackElement": undefined,
"id": "0",
"index": undefined,
"lazy": undefined,
Expand Down Expand Up @@ -153,12 +165,14 @@ describe("creating routes from JSX", () => {
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": undefined,
"caseSensitive": undefined,
"children": [
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": undefined,
"caseSensitive": undefined,
"element": <h1>
Expand All @@ -167,6 +181,7 @@ describe("creating routes from JSX", () => {
"errorElement": undefined,
"handle": undefined,
"hasErrorBoundary": false,
"hydrateFallbackElement": undefined,
"id": "0-0",
"index": undefined,
"lazy": undefined,
Expand All @@ -177,12 +192,14 @@ describe("creating routes from JSX", () => {
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": undefined,
"caseSensitive": undefined,
"children": [
{
"Component": undefined,
"ErrorBoundary": undefined,
"HydrateFallback": undefined,
"action": [Function],
"caseSensitive": undefined,
"element": <h1>
Expand All @@ -191,6 +208,7 @@ describe("creating routes from JSX", () => {
"errorElement": undefined,
"handle": undefined,
"hasErrorBoundary": false,
"hydrateFallbackElement": undefined,
"id": "0-1-0",
"index": true,
"lazy": undefined,
Expand All @@ -203,6 +221,7 @@ describe("creating routes from JSX", () => {
"errorElement": undefined,
"handle": undefined,
"hasErrorBoundary": false,
"hydrateFallbackElement": undefined,
"id": "0-1",
"index": undefined,
"lazy": undefined,
Expand All @@ -217,6 +236,7 @@ describe("creating routes from JSX", () => {
</h1>,
"handle": undefined,
"hasErrorBoundary": true,
"hydrateFallbackElement": undefined,
"id": "0",
"index": undefined,
"lazy": undefined,
Expand Down
38 changes: 22 additions & 16 deletions packages/react-router/__tests__/data-memory-router-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,11 +313,15 @@ describe("createMemoryRouter", () => {
`);
});

it("renders fallbackElement while first data fetch happens", async () => {
it("renders hydrateFallbackElement while first data fetch happens", async () => {
let fooDefer = createDeferred();
let router = createMemoryRouter(
createRoutesFromElements(
<Route path="/" element={<Outlet />}>
<Route
path="/"
element={<Outlet />}
hydrateFallbackElement={<FallbackElement />}
>
<Route path="foo" loader={() => fooDefer.promise} element={<Foo />} />
<Route path="bar" element={<Bar />} />
</Route>
Expand All @@ -326,9 +330,7 @@ describe("createMemoryRouter", () => {
initialEntries: ["/foo"],
}
);
let { container } = render(
<RouterProvider router={router} fallbackElement={<FallbackElement />} />
);
let { container } = render(<RouterProvider router={router} />);

function FallbackElement() {
return <p>Loading...</p>;
Expand Down Expand Up @@ -363,7 +365,7 @@ describe("createMemoryRouter", () => {
`);
});

it("renders a null fallbackElement if none is provided", async () => {
it("renders a null fallback if none is provided", async () => {
let fooDefer = createDeferred();
let router = createMemoryRouter(
createRoutesFromElements(
Expand Down Expand Up @@ -401,12 +403,16 @@ describe("createMemoryRouter", () => {
`);
});

it("does not render fallbackElement if no data fetch is required", async () => {
it("does not render hydrateFallbackElement if no data fetch is required", async () => {
let fooDefer = createDeferred();

let router = createMemoryRouter(
createRoutesFromElements(
<Route path="/" element={<Outlet />}>
<Route
path="/"
element={<Outlet />}
hydrateFallbackElement={<FallbackElement />}
>
<Route path="foo" loader={() => fooDefer.promise} element={<Foo />} />
<Route path="bar" element={<Bar />} />
</Route>
Expand All @@ -415,9 +421,7 @@ describe("createMemoryRouter", () => {
initialEntries: ["/bar"],
}
);
let { container } = render(
<RouterProvider router={router} fallbackElement={<FallbackElement />} />
);
let { container } = render(<RouterProvider router={router} />);

function FallbackElement() {
return <p>Loading...</p>;
Expand All @@ -441,19 +445,21 @@ describe("createMemoryRouter", () => {
`);
});

it("renders fallbackElement within router contexts", async () => {
it("renders hydrateFallbackElement within router contexts", async () => {
let fooDefer = createDeferred();
let router = createMemoryRouter(
createRoutesFromElements(
<Route path="/" element={<Outlet />}>
<Route
path="/"
element={<Outlet />}
hydrateFallbackElement={<FallbackElement />}
>
<Route path="foo" loader={() => fooDefer.promise} element={<Foo />} />
</Route>
),
{ initialEntries: ["/foo"] }
);
let { container } = render(
<RouterProvider router={router} fallbackElement={<FallbackElement />} />
);
let { container } = render(<RouterProvider router={router} />);

function FallbackElement() {
let location = useLocation();
Expand Down
36 changes: 21 additions & 15 deletions packages/react-router/__tests__/dom/data-browser-router-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,11 +371,15 @@ function testDomRouter(
`);
});

it("renders fallbackElement while first data fetch happens", async () => {
it("renders hydrateFallbackElement while first data fetch happens", async () => {
let fooDefer = createDeferred();
let router = createTestRouter(
createRoutesFromElements(
<Route path="/" element={<Outlet />}>
<Route
path="/"
element={<Outlet />}
hydrateFallbackElement={<FallbackElement />}
>
<Route
path="foo"
loader={() => fooDefer.promise}
Expand All @@ -388,9 +392,7 @@ function testDomRouter(
window: getWindow("/foo"),
}
);
let { container } = render(
<RouterProvider router={router} fallbackElement={<FallbackElement />} />
);
let { container } = render(<RouterProvider router={router} />);

function FallbackElement() {
return <p>Loading...</p>;
Expand Down Expand Up @@ -425,11 +427,15 @@ function testDomRouter(
`);
});

it("renders fallbackElement while first data fetch and lazy route load happens", async () => {
it("renders hydrateFallbackElement while first data fetch and lazy route load happens", async () => {
let fooDefer = createDeferred();
let router = createTestRouter(
createRoutesFromElements(
<Route path="/" element={<Outlet />}>
<Route
path="/"
element={<Outlet />}
hydrateFallbackElement={<FallbackElement />}
>
<Route
path="foo"
lazy={async () => {
Expand All @@ -446,9 +452,7 @@ function testDomRouter(
window: getWindow("/foo"),
}
);
let { container } = render(
<RouterProvider router={router} fallbackElement={<FallbackElement />} />
);
let { container } = render(<RouterProvider router={router} />);

function FallbackElement() {
return <p>Loading...</p>;
Expand Down Expand Up @@ -526,11 +530,15 @@ function testDomRouter(
`);
});

it("renders fallbackElement within router contexts", async () => {
it("renders hydrateFallbackElement within router contexts", async () => {
let fooDefer = createDeferred();
let router = createTestRouter(
createRoutesFromElements(
<Route path="/" element={<Outlet />}>
<Route
path="/"
element={<Outlet />}
hydrateFallbackElement={<FallbackElement />}
>
<Route
path="foo"
loader={() => fooDefer.promise}
Expand All @@ -540,9 +548,7 @@ function testDomRouter(
),
{ window: getWindow("/foo") }
);
let { container } = render(
<RouterProvider router={router} fallbackElement={<FallbackElement />} />
);
let { container } = render(<RouterProvider router={router} />);

function FallbackElement() {
let location = useLocation();
Expand Down
Loading