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.

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

refactor(remix-react): upgrade Remix to react-router-dom@6.4 (non-data-router) and drop history #4731

Merged
merged 2 commits into from Dec 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/early-camels-guess.md
@@ -0,0 +1,5 @@
---
"@remix-run/react": patch
---

Update `@remix-run/react` to use `Router` from `react-router-dom@6.4.4`
4 changes: 2 additions & 2 deletions packages/remix-react/__tests__/transition-test.tsx
@@ -1,5 +1,5 @@
import { Action, parsePath } from "history";
import type { Location, State } from "history";
import { NavigationType as Action, parsePath } from "react-router-dom";
import type { Location } from "react-router-dom";

import type { Submission, TransitionManagerInit } from "../transition";
import {
Expand Down
13 changes: 8 additions & 5 deletions packages/remix-react/browser.tsx
@@ -1,7 +1,5 @@
// TODO: We eventually might not want to import anything directly from `history`
// and leverage `react-router` here instead
import type { BrowserHistory, Update } from "history";
import { createBrowserHistory } from "history";
import type { BrowserHistory, Action, Location } from "@remix-run/router";
import { createBrowserHistory } from "@remix-run/router";
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Normally, @remix-run/react should be importing from react-router-dom. These are the only imports from @remix-run/router since history stuff isn't re-exported through react-router-dom since users aren't supposed to do manual history management in 6.4.

import type { ReactElement } from "react";
import * as React from "react";

Expand All @@ -19,6 +17,11 @@ declare global {

export interface RemixBrowserProps {}

interface Update {
action: Action;
location: Location;
}

/**
* The entry point for a Remix app when it is rendered in the browser (in
* `app/entry.client.js`). This component is used by React to hydrate the HTML
Expand All @@ -27,7 +30,7 @@ export interface RemixBrowserProps {}
export function RemixBrowser(_props: RemixBrowserProps): ReactElement {
let historyRef = React.useRef<BrowserHistory>();
if (historyRef.current == null) {
historyRef.current = createBrowserHistory({ window });
historyRef.current = createBrowserHistory({ window, v5Compat: true });
}

let history = historyRef.current;
Expand Down
18 changes: 13 additions & 5 deletions packages/remix-react/components.tsx
@@ -1,26 +1,28 @@
// TODO: We eventually might not want to import anything directly from `history`
// and leverage `react-router` here instead
import type { Action, Location } from "history";
import type {
FocusEventHandler,
FormHTMLAttributes,
MouseEventHandler,
TouchEventHandler,
} from "react";
import * as React from "react";
import type { Navigator, Params } from "react-router";
import type {
NavigationType as Action,
Location,
Navigator,
Params,
} from "react-router-dom";
import {
Router,
Link as RouterLink,
NavLink as RouterNavLink,
createPath,
useLocation,
useRoutes,
useNavigate,
useHref,
useResolvedPath,
} from "react-router-dom";
import type { LinkProps, NavLinkProps } from "react-router-dom";
import { createPath } from "history";
import type { SerializeFrom } from "@remix-run/server-runtime";

import type { AppData, FormEncType, FormMethod } from "./data";
Expand Down Expand Up @@ -239,6 +241,12 @@ function Routes() {
// need this component, we can just `renderMatches` from RemixEntry
let { clientRoutes } = useRemixEntryContext();
// fallback to the root if we don't have a match

// TODO: clientRoutes currently errors here since RR 6.4 dropped `signal` as a
// loader argument. But since we're just using <Router> we aren't using any
// loaders in RR so this isn't an issue. We'll get these typings straightened
// out as part of the rendering work.
// @ts-expect-error
let element = useRoutes(clientRoutes) || (clientRoutes[0].element as any);
return element;
}
Expand Down
4 changes: 1 addition & 3 deletions packages/remix-react/errorBoundaries.tsx
@@ -1,7 +1,5 @@
// TODO: We eventually might not want to import anything directly from `history`
// and leverage `react-router` here instead
import type { Location } from "history";
import React, { useContext } from "react";
import type { Location } from "react-router-dom";

import type {
CatchBoundaryComponent,
Expand Down
6 changes: 2 additions & 4 deletions packages/remix-react/links.ts
@@ -1,7 +1,5 @@
// TODO: We eventually might not want to import anything directly from `history`
// and leverage `react-router` here instead
import type { Location } from "history";
import { parsePath } from "history";
import type { Location } from "react-router-dom";
import { parsePath } from "react-router-dom";

import type { AssetsManifest } from "./entry";
import type { ClientRoute } from "./routes";
Expand Down
4 changes: 2 additions & 2 deletions packages/remix-react/package.json
Expand Up @@ -16,8 +16,8 @@
"typings": "dist/index.d.ts",
"module": "dist/esm/index.js",
"dependencies": {
"history": "^5.3.0",
"react-router-dom": "6.3.0"
"@remix-run/router": "1.0.4",
"react-router-dom": "6.4.4"
},
"devDependencies": {
"@remix-run/server-runtime": "1.8.0",
Expand Down
5 changes: 1 addition & 4 deletions packages/remix-react/routeMatching.ts
@@ -1,7 +1,4 @@
// TODO: We eventually might not want to import anything directly from `history`
// and leverage `react-router` here instead
import type { Location } from "history";
import type { Params, RouteObject } from "react-router"; // TODO: export/import from react-router-dom
import type { Location, Params, RouteObject } from "react-router-dom";
import { matchRoutes } from "react-router-dom";

import type { ClientRoute } from "./routes";
Expand Down
5 changes: 1 addition & 4 deletions packages/remix-react/routeModules.ts
@@ -1,8 +1,5 @@
// TODO: We eventually might not want to import anything directly from `history`
// and leverage `react-router` here instead
import type { Location } from "history";
import type { ComponentType } from "react";
import type { Params } from "react-router"; // TODO: import/export from react-router-dom
import type { Params, Location } from "react-router-dom";

import type { AppData } from "./data";
import type { LinkDescriptor } from "./links";
Expand Down
6 changes: 2 additions & 4 deletions packages/remix-react/server.tsx
@@ -1,9 +1,7 @@
// TODO: We eventually might not want to import anything directly from `history`
// and leverage `react-router` here instead
import type { Location, To } from "history";
import { Action, createPath } from "history";
import type { ReactElement } from "react";
import * as React from "react";
import type { Location, To } from "react-router-dom";
import { NavigationType as Action, createPath } from "react-router-dom";

import { RemixEntry } from "./components";
import type { EntryContext } from "./entry";
Expand Down
6 changes: 2 additions & 4 deletions packages/remix-react/transition.ts
@@ -1,7 +1,5 @@
// TODO: We eventually might not want to import anything directly from `history`
// and leverage `react-router` here instead
import { Action } from "history";
import type { Location } from "history";
import { NavigationType as Action } from "react-router-dom";
import type { Location } from "react-router-dom";

import type { RouteData } from "./routeData";
import type { RouteMatch } from "./routeMatching";
Expand Down
1 change: 0 additions & 1 deletion packages/remix-server-runtime/package.json
Expand Up @@ -20,7 +20,6 @@
"@types/cookie": "^0.4.0",
"@web3-storage/multipart-parser": "^1.0.0",
"cookie": "^0.4.1",
"react-router-dom": "6.3.0",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No longer needed in server-runtime, we can get everything we need from @remix-run/router

"set-cookie-parser": "^2.4.8",
"source-map": "^0.7.3"
},
Expand Down
9 changes: 6 additions & 3 deletions packages/remix-server-runtime/routeMatching.ts
@@ -1,5 +1,5 @@
import type { Params, RouteObject } from "react-router"; // TODO: export/import from react-router-dom
import { matchRoutes } from "react-router-dom";
import type { Params, AgnosticRouteObject } from "@remix-run/router";
import { matchRoutes } from "@remix-run/router";

import type { ServerRoute } from "./routes";

Expand All @@ -13,7 +13,10 @@ export function matchServerRoutes(
routes: ServerRoute[],
pathname: string
): RouteMatch<ServerRoute>[] | null {
let matches = matchRoutes(routes as unknown as RouteObject[], pathname);
let matches = matchRoutes(
routes as unknown as AgnosticRouteObject[],
pathname
);
if (!matches) return null;

return matches.map((match) => ({
Expand Down
3 changes: 1 addition & 2 deletions packages/remix-server-runtime/routeModules.ts
@@ -1,6 +1,5 @@
import type { Location } from "history";
import type { ComponentType } from "react";
import type { Params } from "react-router-dom";
import type { Location, Params } from "react-router-dom";

import type { AppLoadContext, AppData } from "./data";
import type { LinkDescriptor } from "./links";
Expand Down
31 changes: 12 additions & 19 deletions yarn.lock
Expand Up @@ -1186,7 +1186,7 @@
dependencies:
regenerator-runtime "^0.13.4"

"@babel/runtime@^7.10.4", "@babel/runtime@^7.5.5", "@babel/runtime@^7.7.6", "@babel/runtime@^7.8.4":
"@babel/runtime@^7.10.4", "@babel/runtime@^7.5.5", "@babel/runtime@^7.8.4":
version "7.18.3"
resolved "https://registry.npmjs.org/@babel/runtime/-/runtime-7.18.3.tgz"
integrity sha512-38Y8f7YUhce/K7RMwTp7m0uCumpv9hZkitCbBClqQIow1qSbCvGkcegKOXpEWCQLfWmevgRiWokZ1GkpfhbZug==
Expand Down Expand Up @@ -6996,13 +6996,6 @@ headers-polyfill@^3.0.4:
resolved "https://registry.npmjs.org/headers-polyfill/-/headers-polyfill-3.0.7.tgz"
integrity sha512-JoLCAdCEab58+2/yEmSnOlficyHFpIl0XJqwu3l+Unkm1gXpFUYsThz6Yha3D6tNhocWkCPfyW0YVIGWFqTi7w==

history@^5.2.0, history@^5.3.0:
version "5.3.0"
resolved "https://registry.npmjs.org/history/-/history-5.3.0.tgz"
integrity sha512-ZqaKwjjrAYUYfLG+htGaIIZ4nioX2L70ZUMIFysS3xvBsSG4x/n1V6TXV3N8ZYNuFGlDirFg32T7B6WOUPDYcQ==
dependencies:
"@babel/runtime" "^7.7.6"

hosted-git-info@^2.1.4:
version "2.8.9"
resolved "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz"
Expand Down Expand Up @@ -10737,20 +10730,20 @@ react-is@^17.0.1:
resolved "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz"
integrity sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==

react-router-dom@6.3.0:
version "6.3.0"
resolved "https://registry.npmjs.org/react-router-dom/-/react-router-dom-6.3.0.tgz"
integrity sha512-uaJj7LKytRxZNQV8+RbzJWnJ8K2nPsOOEuX7aQstlMZKQT0164C+X2w6bnkqU3sjtLvpd5ojrezAyfZ1+0sStw==
react-router-dom@6.4.4:
version "6.4.4"
resolved "https://registry.npmjs.org/react-router-dom/-/react-router-dom-6.4.4.tgz#4271ec66333c440d1754477e4e6a3a5acb5487f8"
integrity sha512-0Axverhw5d+4SBhLqLpzPhNkmv7gahUwlUVIOrRLGJ4/uwt30JVajVJXqv2Qr/LCwyvHhQc7YyK1Do8a9Jj7qA==
dependencies:
history "^5.2.0"
react-router "6.3.0"
"@remix-run/router" "1.0.4"
react-router "6.4.4"

react-router@6.3.0:
version "6.3.0"
resolved "https://registry.npmjs.org/react-router/-/react-router-6.3.0.tgz"
integrity sha512-7Wh1DzVQ+tlFjkeo+ujvjSqSJmkt1+8JO+T5xklPlgrh70y7ogx75ODRW0ThWhY7S+6yEDks8TYrtQe/aoboBQ==
react-router@6.4.4:
version "6.4.4"
resolved "https://registry.npmjs.org/react-router/-/react-router-6.4.4.tgz#8e7794f55ccc7050cb03937c87ff3720ce9f8b60"
integrity sha512-SA6tSrUCRfuLWeYsTJDuriRqfFIsrSvuH7SqAJHegx9ZgxadE119rU8oOX/rG5FYEthpdEaEljdjDlnBxvfr+Q==
dependencies:
history "^5.2.0"
"@remix-run/router" "1.0.4"

react@^18.2.0:
version "18.2.0"
Expand Down