Drop support for Node 18 and installGlobals (#12171)

remix-run · Oct 22, 2024 · 813497a · 813497a
1 parent f294df8
commit 813497a
Show file tree

Hide file tree

Showing 47 changed files with 100 additions and 213 deletions.
diff --git a/.changeset/tidy-pens-help.md b/.changeset/tidy-pens-help.md
@@ -0,0 +1,10 @@
+---
+"@react-router/express": major
+"@react-router/node": major
+"@react-router/dev": major
+"react-router": major
+---
+
+Drop support for Node 18, update minimum Node vestion to 20
+
+- Remove `installGlobals()` as this should no longer be necessary
diff --git a/.github/workflows/integration-full.yml b/.github/workflows/integration-full.yml
@@ -34,7 +34,7 @@ jobs:
     uses: ./.github/workflows/shared-integration.yml
     with:
       os: "ubuntu-latest"
-      node_version: "[18, 20]"
+      node_version: "[20, 22]"
       browser: '["chromium", "firefox"]'
 
   integration-windows:
@@ -43,7 +43,7 @@ jobs:
     uses: ./.github/workflows/shared-integration.yml
     with:
       os: "windows-latest"
-      node_version: "[18, 20]"
+      node_version: "[20, 22]"
       browser: '["msedge"]'
 
   integration-macos:
@@ -52,5 +52,5 @@ jobs:
     uses: ./.github/workflows/shared-integration.yml
     with:
       os: "macos-latest"
-      node_version: "[18, 20]"
+      node_version: "[20, 22]"
       browser: '["webkit"]'
diff --git a/.github/workflows/integration-pr-ubuntu.yml b/.github/workflows/integration-pr-ubuntu.yml
@@ -31,5 +31,5 @@ jobs:
     uses: ./.github/workflows/shared-integration.yml
     with:
       os: "ubuntu-latest"
-      node_version: "[20]"
+      node_version: "[22]"
       browser: '["chromium"]'
diff --git a/.github/workflows/integration-pr-windows-macos.yml b/.github/workflows/integration-pr-windows-macos.yml
@@ -21,7 +21,7 @@ jobs:
     uses: ./.github/workflows/shared-integration.yml
     with:
       os: "ubuntu-latest"
-      node_version: "[20]"
+      node_version: "[22]"
       browser: '["firefox"]'
 
   integration-msedge:
@@ -30,7 +30,7 @@ jobs:
     uses: ./.github/workflows/shared-integration.yml
     with:
       os: "windows-latest"
-      node_version: "[20]"
+      node_version: "[22]"
       browser: '["msedge"]'
 
   integration-webkit:
@@ -39,5 +39,5 @@ jobs:
     uses: ./.github/workflows/shared-integration.yml
     with:
       os: "macos-latest"
-      node_version: "[20]"
+      node_version: "[22]"
       browser: '["webkit"]'
diff --git a/.github/workflows/shared-integration.yml b/.github/workflows/shared-integration.yml
@@ -9,7 +9,7 @@ on:
       node_version:
         required: true
         # this is limited to string | boolean | number (https://github.community/t/can-action-inputs-be-arrays/16457)
-        # but we want to pass an array (node_version: "[18, 20]"),
+        # but we want to pass an array (node_version: "[20, 22]"),
         # so we'll need to manually stringify it for now
         type: string
       browser:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -26,8 +26,8 @@ jobs:
       fail-fast: false
       matrix:
         node:
-          - 18
           - 20
+          - 22
 
     runs-on: ubuntu-latest
 

diff --git a/docs/deploying/custom-node.md b/docs/deploying/custom-node.md
@@ -7,3 +7,41 @@ title: Custom Node.js
 <docs-warning>
   This document is a work in progress. There's not much to see here (yet).
 </docs-warning>
+
+## Polyfilling `fetch`
+
+React Router officially supports Active and Maintenance[^1] [Node LTS veleases][node-releases] at any given point in time. Dropping support for End of Life Node versions may be done in a React Router Minor release.
+
+[^1]: Based on timing, React Router may drop support for a Node Maintenance LTS version shortly before it goes end-of-life if it better aligns with a React Router Major SemVer release.
+
+At the time React Router v7 was released, all versions had a usable `fetch` implementation so there is generally no need to polyfill any `fetch` APIs so long as you're on Node 22 or one of the later Node 20 releases.
+
+- Node 22 (Active LTS) has a stable [`fetch`][node-22-fetch] implementation
+- Node 20 (Maintenance LTS) has an experimental (but suitable from our testing) [`fetch`][node-20-fetch] implementation
+
+If you do find that you need to polyfill anything, you can do so directly from the [undici] package which node uses internally.
+
+```ts
+import {
+  fetch as nodeFetch,
+  File as NodeFile,
+  FormData as NodeFormData,
+  Headers as NodeHeaders,
+  Request as NodeRequest,
+  Response as NodeResponse,
+} from "undici";
+
+export function polyfillFetch() {
+  global.File = NodeFile;
+  global.Headers = NodeHeaders;
+  global.Request = NodeRequest;
+  global.Response = NodeResponse;
+  global.fetch = nodeFetch;
+  global.FormData = NodeFormData;
+}
+```
+
+[node-releases]: https://nodejs.org/en/about/previous-releases
+[node-20-fetch]: https://nodejs.org/docs/latest-v20.x/api/globals.html#fetch
+[node-22-fetch]: https://nodejs.org/docs/latest-v22.x/api/globals.html#fetch
+[undici]: https://github.com/nodejs/undici
diff --git a/integration/helpers/create-fixture.ts b/integration/helpers/create-fixture.ts
@@ -15,7 +15,6 @@ import {
   UNSAFE_decodeViaTurboStream as decodeViaTurboStream,
 } from "react-router";
 import { createRequestHandler as createExpressHandler } from "@react-router/express";
-import { installGlobals } from "@react-router/node";
 
 import { viteConfig } from "./vite.js";
 
@@ -43,8 +42,6 @@ export function json(value: JsonObject) {
 }
 
 export async function createFixture(init: FixtureInit, mode?: ServerMode) {
-  installGlobals();
-
   let projectDir = await createFixtureProject(init, mode);
   let buildPath = url.pathToFileURL(
     path.join(projectDir, "build/server/index.js")

diff --git a/integration/helpers/node-template/package.json b/integration/helpers/node-template/package.json
@@ -34,6 +34,6 @@
     "typescript": "^5.1.0"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   }
 }
diff --git a/integration/helpers/vite-cloudflare-template/package.json b/integration/helpers/vite-cloudflare-template/package.json
@@ -30,6 +30,6 @@
     "wrangler": "^3.28.2"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   }
 }
diff --git a/integration/helpers/vite-template/package.json b/integration/helpers/vite-template/package.json
@@ -36,6 +36,6 @@
     "vite-tsconfig-paths": "^4.2.1"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   }
 }
diff --git a/integration/helpers/vite.ts b/integration/helpers/vite.ts
@@ -69,11 +69,8 @@ export const EXPRESS_SERVER = (args: {
 }) =>
   String.raw`
     import { createRequestHandler } from "@react-router/express";
-    import { installGlobals } from "@react-router/node";
     import express from "express";
 
-    installGlobals();
-
     let viteDevServer =
       process.env.NODE_ENV === "production"
         ? undefined

diff --git a/integration/vite-basename-test.ts b/integration/vite-basename-test.ts
@@ -95,9 +95,7 @@ const customServerFile = ({
 
   return js`
     import { createRequestHandler } from "@react-router/express";
-    import { installGlobals } from "@react-router/node";
     import express from "express";
-    installGlobals();
 
     const viteDevServer =
       process.env.NODE_ENV === "production"
@@ -488,9 +486,7 @@ test.describe("Vite base / React Router basename / express build", async () => {
       // Slim server that only serves basename (route) requests from the React Router handler
       "server.mjs": String.raw`
         import { createRequestHandler } from "@react-router/express";
-        import { installGlobals } from "@react-router/node";
         import express from "express";
-        installGlobals();
 
         const app = express();
         app.all(

diff --git a/jest/jest.config.shared.js b/jest/jest.config.shared.js
@@ -19,7 +19,6 @@ module.exports = {
     ),
   },
   modulePathIgnorePatterns: ignorePatterns,
-  setupFiles: ["<rootDir>/__tests__/setup.ts"],
   testMatch: ["<rootDir>/**/*-test.[jt]s?(x)"],
   transform: {
     "\\.[jt]sx?$": require.resolve("./transform"),

diff --git a/package.json b/package.json
@@ -78,7 +78,6 @@
     "@types/wait-on": "^5.3.2",
     "@typescript-eslint/eslint-plugin": "^7.5.0",
     "@typescript-eslint/parser": "^7.5.0",
-    "abort-controller": "^3.0.0",
     "babel-jest": "^29.7.0",
     "babel-plugin-dev-expression": "^0.2.3",
     "babel-plugin-transform-remove-console": "^6.9.4",
@@ -122,7 +121,7 @@
     "vite-tsconfig-paths": "^4.2.2"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "pnpm": {
     "patchedDependencies": {

diff --git a/packages/react-router-architect/__tests__/setup.ts b/packages/react-router-architect/__tests__/setup.ts
diff --git a/packages/react-router-architect/package.json b/packages/react-router-architect/package.json
@@ -48,7 +48,7 @@
     }
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "files": [
     "dist/",

diff --git a/packages/react-router-cloudflare/package.json b/packages/react-router-cloudflare/package.json
@@ -40,7 +40,7 @@
     }
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "files": [
     "dist/",

diff --git a/packages/react-router-dev/__tests__/fixtures/node/package.json b/packages/react-router-dev/__tests__/fixtures/node/package.json
@@ -24,6 +24,6 @@
     "typescript": "^5.1.6"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   }
 }
diff --git a/packages/react-router-dev/cli/run.ts b/packages/react-router-dev/cli/run.ts
@@ -81,9 +81,15 @@ ${colors.logoBlue("react-router")}
 export async function run(argv: string[] = process.argv.slice(2)) {
   // Check the node version
   let versions = process.versions;
-  if (versions && versions.node && semver.major(versions.node) < 18) {
+  let MINIMUM_NODE_VERSION = 20;
+  if (
+    versions &&
+    versions.node &&
+    semver.major(versions.node) < MINIMUM_NODE_VERSION
+  ) {
     throw new Error(
-      `️🚨 Oops, Node v${versions.node} detected. react-router requires a Node version greater than 18.`
+      `️🚨 Oops, Node v${versions.node} detected. react-router requires ` +
+        `a Node version greater than ${MINIMUM_NODE_VERSION}.`
     );
   }
 

diff --git a/packages/react-router-dev/package.json b/packages/react-router-dev/package.json
@@ -112,7 +112,7 @@
     }
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "files": [
     "dist/",

diff --git a/packages/react-router-dom/package.json b/packages/react-router-dom/package.json
@@ -47,6 +47,6 @@
     "README.md"
   ],
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   }
 }
diff --git a/packages/react-router-express/__tests__/setup.ts b/packages/react-router-express/__tests__/setup.ts
diff --git a/packages/react-router-express/package.json b/packages/react-router-express/package.json
@@ -46,7 +46,7 @@
     }
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "files": [
     "dist/",

diff --git a/packages/react-router-fs-routes/package.json b/packages/react-router-fs-routes/package.json
@@ -40,7 +40,7 @@
     }
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "files": [
     "dist/",

diff --git a/packages/react-router-node/__tests__/setup.ts b/packages/react-router-node/__tests__/setup.ts
diff --git a/packages/react-router-node/globals.ts b/packages/react-router-node/globals.ts
diff --git a/packages/react-router-node/index.ts b/packages/react-router-node/index.ts
@@ -1,5 +1,3 @@
-export { installGlobals } from "./globals";
-
 export { createFileSessionStorage } from "./sessions/fileStorage";
 
 export {

diff --git a/packages/react-router-node/install.ts b/packages/react-router-node/install.ts