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

chore(remix-node): put native fetch behind config option #9198

Merged
merged 2 commits into from
Apr 4, 2024
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/good-buses-divide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
"@remix-run/node": patch
"@remix-run/serve": patch
---

- Put `undici` fetch polyfill behind a new `installGlobals({ nativeFetch: true })` parameter
- `remix-serve` will default to using `undici` for the fetch polyfill if `future._unstable_singleFetch` is enabled because the single fetch implementation relies on the `undici` polyfill
- Any users opting into Single Fetch and managing their own polfill will need to pass the flag to `installGlobals` on their own to avoid runtime errors with Single Fetch

4 changes: 1 addition & 3 deletions integration/error-data-request-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -327,9 +327,7 @@ test.describe("single fetch", () => {
fixture.requestSingleFetchData("/loader-return-json.data", {
method: "TRACE",
})
).rejects.toThrowError(
`Failed to construct 'Request': 'TRACE' HTTP method is unsupported.`
);
).rejects.toThrow(/'TRACE' HTTP method is unsupported\./);
});

test("returns a 404 on a data fetch to a path with no matches", async () => {
Expand Down
3 changes: 2 additions & 1 deletion integration/helpers/create-fixture.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ export function json(value: JsonObject) {
}

export async function createFixture(init: FixtureInit, mode?: ServerMode) {
installGlobals();
installGlobals({ nativeFetch: true });
let compiler = init.compiler ?? "remix";

let projectDir = await createFixtureProject(init, mode);
let buildPath = url.pathToFileURL(
path.join(
Expand Down
2 changes: 1 addition & 1 deletion integration/helpers/vite.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export const EXPRESS_SERVER = (args: {
import { installGlobals } from "@remix-run/node";
import express from "express";

installGlobals();
installGlobals({ nativeFetch: true });

let viteDevServer =
process.env.NODE_ENV === "production"
Expand Down
2 changes: 1 addition & 1 deletion integration/hmr-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ let customServer = (options: { appPort: number; devReady: string }) => {
import { createRequestHandler } from "@remix-run/express";
import { ${options.devReady}, installGlobals } from "@remix-run/node";

installGlobals();
installGlobals({ nativeFetch: true });

const app = express();
app.use(express.static("public", { immutable: true, maxAge: "1y" }));
Expand Down
4 changes: 2 additions & 2 deletions integration/vite-basename-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ const customServerFile = ({
import { createRequestHandler } from "@remix-run/express";
import { installGlobals } from "@remix-run/node";
import express from "express";
installGlobals();
installGlobals({ nativeFetch: true });

const viteDevServer =
process.env.NODE_ENV === "production"
Expand Down Expand Up @@ -416,7 +416,7 @@ test.describe("Vite base / Remix basename / express build", async () => {
import { createRequestHandler } from "@remix-run/express";
import { installGlobals } from "@remix-run/node";
import express from "express";
installGlobals();
installGlobals({ nativeFetch: true });

const app = express();
app.all(
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
"@remix-run/react": "workspace:*",
"@remix-run/testing": "workspace:*",
"@rollup/plugin-babel": "^5.2.2",
"@rollup/plugin-commonjs": "^21.1.0",
"@rollup/plugin-json": "^5.0.0",
"@rollup/plugin-node-resolve": "^11.0.1",
"@rollup/plugin-replace": "^5.0.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/remix-architect/__tests__/setup.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
import { installGlobals } from "@remix-run/node";
installGlobals();
installGlobals({ nativeFetch: true });
2 changes: 1 addition & 1 deletion packages/remix-express/__tests__/setup.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
import { installGlobals } from "@remix-run/node";
installGlobals();
installGlobals({ nativeFetch: true });
2 changes: 1 addition & 1 deletion packages/remix-node/__tests__/setup.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
import { installGlobals } from "@remix-run/node";
installGlobals();
installGlobals({ nativeFetch: true });
56 changes: 34 additions & 22 deletions packages/remix-node/globals.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
import {
File as NodeFile,
fetch as nodeFetch,
FormData as NodeFormData,
Headers as NodeHeaders,
Request as NodeRequest,
Response as NodeResponse,
} from "undici";

declare global {
namespace NodeJS {
interface ProcessEnv {
Expand All @@ -32,17 +23,38 @@ declare global {
}
}

export function installGlobals() {
global.File = NodeFile as unknown as typeof File;

// @ts-expect-error - overriding globals
global.Headers = NodeHeaders;
// @ts-expect-error - overriding globals
global.Request = NodeRequest;
// @ts-expect-error - overriding globals
global.Response = NodeResponse;
// @ts-expect-error - overriding globals
global.fetch = nodeFetch;
// @ts-expect-error - overriding globals
global.FormData = NodeFormData;
export function installGlobals({
nativeFetch,
}: { nativeFetch?: boolean } = {}) {
if (nativeFetch) {
let {
File: UndiciFile,
fetch: undiciFetch,
FormData: UndiciFormData,
Headers: UndiciHeaders,
Request: UndiciRequest,
Response: UndiciResponse,
} = require("undici");
global.File = UndiciFile as unknown as typeof File;
global.Headers = UndiciHeaders;
global.Request = UndiciRequest;
global.Response = UndiciResponse;
global.fetch = undiciFetch;
global.FormData = UndiciFormData;
} else {
let {
File: RemixFile,
fetch: RemixFetch,
FormData: RemixFormData,
Headers: RemixHeaders,
Request: RemixRequest,
Response: RemixResponse,
} = require("@remix-run/web-fetch");
global.File = RemixFile;
global.Headers = RemixHeaders;
global.Request = RemixRequest;
global.Response = RemixResponse;
global.fetch = RemixFetch;
global.FormData = RemixFormData;
}
}
1 change: 1 addition & 0 deletions packages/remix-node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
},
"dependencies": {
"@remix-run/server-runtime": "workspace:*",
"@remix-run/web-fetch": "^4.4.2",
"@web3-storage/multipart-parser": "^1.0.0",
"cookie-signature": "^1.1.0",
"source-map-support": "^0.5.21",
Expand Down
2 changes: 2 additions & 0 deletions packages/remix-node/rollup.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const path = require("node:path");
const babel = require("@rollup/plugin-babel").default;
const commonjs = require("@rollup/plugin-commonjs");
const nodeResolve = require("@rollup/plugin-node-resolve").default;
const copy = require("rollup-plugin-copy");

Expand Down Expand Up @@ -37,6 +38,7 @@ module.exports = function rollup() {
extensions: [".ts", ".tsx"],
}),
nodeResolve({ extensions: [".ts", ".tsx"] }),
commonjs({ ignoreDynamicRequires: true }),
Copy link
Member Author

@jacob-ebey jacob-ebey Apr 4, 2024

Choose a reason for hiding this comment

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

Don't hoist dynamic require's to to the module scope to avoid loading two polyfills at startup.

copy({
targets: [
{ src: "LICENSE.md", dest: [outputDir, sourceDir] },
Expand Down
2 changes: 1 addition & 1 deletion packages/remix-react/__tests__/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ global.TextEncoder = require("util").TextEncoder;
global.ReadableStream = require("stream/web").ReadableStream;
global.WritableStream = require("stream/web").WritableStream;

require("@remix-run/node").installGlobals();
require("@remix-run/node").installGlobals({ nativeFetch: true });
global.FormData = JSDOMFormData;
3 changes: 2 additions & 1 deletion packages/remix-serve/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ sourceMapSupport.install({
return null;
},
});
installGlobals();

run();

Expand Down Expand Up @@ -101,6 +100,8 @@ async function run() {

let build: ServerBuild = await reimportServer();

installGlobals({ nativeFetch: build.future.unstable_singleFetch });

let onListen = () => {
let address =
process.env.HOST ||
Expand Down
2 changes: 1 addition & 1 deletion packages/remix-server-runtime/__tests__/setup.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import { installGlobals } from "@remix-run/node";

installGlobals();
installGlobals({ nativeFetch: true });
2 changes: 1 addition & 1 deletion packages/remix-testing/jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ module.exports = {
displayName: "testing",
setupFiles: [],
testEnvironment: "jsdom",
setupFilesAfterEnv: ["@testing-library/jest-dom", "./jest.setup.js"],
setupFilesAfterEnv: ["./jest.setup.js", "@testing-library/jest-dom"],
Copy link
Member Author

Choose a reason for hiding this comment

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

The order here matters due to testing-library setting up globals badly if they don't exist.

};
2 changes: 1 addition & 1 deletion packages/remix-testing/jest.setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ global.TextEncoder = require("util").TextEncoder;
global.ReadableStream = require("stream/web").ReadableStream;
global.WritableStream = require("stream/web").WritableStream;

require("@remix-run/node").installGlobals();
require("@remix-run/node").installGlobals({ nativeFetch: true });
global.FormData = JSDOMFormData;
32 changes: 32 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion templates/classic-remix-compiler/arc/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ import { installGlobals } from "@remix-run/node";
import sourceMapSupport from "source-map-support";

sourceMapSupport.install();
installGlobals();
installGlobals({ nativeFetch: true });

export const handler = createRequestHandler({ build });