@netlify/vite-plugin-react-router 2.1.0 → 2.1.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.1.1](https://github.com/netlify/remix-compute/compare/vite-plugin-react-router-v2.1.0...vite-plugin-react-router-v2.1.1) (2025-11-06)
+
+
+### Bug Fixes
+
+* **@netlify/vite-plugin-react-router:** fix local dev with `edge: true` ([#572](https://github.com/netlify/remix-compute/issues/572)) ([dfb27c1](https://github.com/netlify/remix-compute/commit/dfb27c1cb52d253063b2c19dd52b05fb5ec8f4ce))
+
 ## [2.1.0](https://github.com/netlify/remix-compute/compare/vite-plugin-react-router-v2.0.1...vite-plugin-react-router-v2.1.0) (2025-11-05)
 
 

package/README.md

@@ -58,59 +58,23 @@ export default defineConfig({
 })
 ```
 
-Second, you **must** provide an `app/entry.server.tsx` (or `.jsx`) file that uses web-standard APIs compatible with the
-Deno runtime. Create a file with the following content:
-
-> [!IMPORTANT]
->
-> This file uses `renderToReadableStream` (Web Streams API) instead of `renderToPipeableStream` (Node.js API), which is
-> required for the Deno runtime. You may customize your server entry file, but see below for important edge runtime
-> constraints.
+Second, you **must** provide an `app/entry.server.tsx` (or `.jsx`) file. Create a file with the following content:
 
 ```tsx
-import type { AppLoadContext, EntryContext } from 'react-router'
-import { ServerRouter } from 'react-router'
-import { isbot } from 'isbot'
-import { renderToReadableStream } from 'react-dom/server'
-
-export default async function handleRequest(
-  request: Request,
-  responseStatusCode: number,
-  responseHeaders: Headers,
-  routerContext: EntryContext,
-  _loadContext: AppLoadContext,
-) {
-  let shellRendered = false
-  const userAgent = request.headers.get('user-agent')
-
-  const body = await renderToReadableStream(<ServerRouter context={routerContext} url={request.url} />, {
-    onError(error: unknown) {
-      responseStatusCode = 500
-      // Log streaming rendering errors from inside the shell.  Don't log
-      // errors encountered during initial shell rendering since they'll
-      // reject and get logged in handleDocumentRequest.
-      if (shellRendered) {
-        console.error(error)
-      }
-    },
-  })
-  shellRendered = true
-
-  // Ensure requests from bots and SPA Mode renders wait for all content to load before responding
-  // https://react.dev/reference/react-dom/server/renderToPipeableStream#waiting-for-all-content-to-load-for-crawlers-and-static-generation
-  if ((userAgent && isbot(userAgent)) || routerContext.isSpaMode) {
-    await body.allReady
-  }
-
-  responseHeaders.set('Content-Type', 'text/html')
-  return new Response(body, {
-    headers: responseHeaders,
-    status: responseStatusCode,
-  })
-}
+export { default } from 'virtual:netlify-server-entry'
 ```
 
-You may need to `npm install isbot` if you do not have this dependency.
+> [!TIP]
+>
+> If you prefer to avoid a `@ts-ignore` here, add this to `vite-env.d.ts` in your project root (or anywhere you prefer):
+>
+> ```typescript
+> declare module 'virtual:netlify-server-entry' {
+>   import type { ServerEntryModule } from 'react-router'
+>   const entry: ServerEntryModule
+>   export default entry
+> }
+> ```
 
 Finally, if you have your own Netlify Functions (typically in `netlify/functions`) for which you've configured a `path`,
 you must exclude those paths to avoid conflicts with the generated React Router SSR handler:

package/dist/entry.server.edge.d.mts

@@ -0,0 +1,20 @@
+import { EntryContext, AppLoadContext } from 'react-router';
+
+/**
+ * Edge-compatible server entry using Web Streams instead of Node.js Streams.
+ * @see {@link https://reactrouter.com/api/framework-conventions/entry.server.tsx}
+ *
+ * This file was copied as-is from the React Router repository.
+ * @see {@link
+ * https://github.com/remix-run/react-router/blob/cb9a090316003988ff367bb2f2d1ef5bd03bd3af/integration/helpers/vite-plugin-cloudflare-template/app/entry.server.tsx}
+ *
+ *
+ * @example Export this from your `app/entry.server.tsx` when using `edge: true`:
+ *
+ * ```tsx
+ * export { default } from 'virtual:netlify-server-entry'
+ * ```
+ */
+declare function handleRequest(request: Request, responseStatusCode: number, responseHeaders: Headers, routerContext: EntryContext, _loadContext: AppLoadContext): Promise<Response>;
+
+export { handleRequest as default };

package/dist/entry.server.edge.mjs

@@ -0,0 +1,29 @@
+// src/entry.server.edge.tsx
+import { ServerRouter } from "react-router";
+import { isbot } from "isbot";
+import { renderToReadableStream } from "react-dom/server";
+import { jsx } from "react/jsx-runtime";
+async function handleRequest(request, responseStatusCode, responseHeaders, routerContext, _loadContext) {
+  let shellRendered = false;
+  const userAgent = request.headers.get("user-agent");
+  const body = await renderToReadableStream(/* @__PURE__ */ jsx(ServerRouter, { context: routerContext, url: request.url }), {
+    onError(error) {
+      responseStatusCode = 500;
+      if (shellRendered) {
+        console.error(error);
+      }
+    }
+  });
+  shellRendered = true;
+  if (userAgent && isbot(userAgent) || routerContext.isSpaMode) {
+    await body.allReady;
+  }
+  responseHeaders.set("Content-Type", "text/html");
+  return new Response(body, {
+    headers: responseHeaders,
+    status: responseStatusCode
+  });
+}
+export {
+  handleRequest as default
+};

package/dist/index.js

@@ -112,7 +112,7 @@ var import_posix = require("path/posix");
 
 // package.json
 var name = "@netlify/vite-plugin-react-router";
-var version = "2.1.0";
+var version = "2.1.1";
 
 // src/plugin.ts
 var NETLIFY_FUNCTIONS_DIR = ".netlify/v1/functions";
@@ -121,6 +121,7 @@ var FUNCTION_FILENAME = "react-router-server.mjs";
 var FUNCTION_HANDLER_CHUNK = "server";
 var FUNCTION_HANDLER_MODULE_ID = "virtual:netlify-server";
 var RESOLVED_FUNCTION_HANDLER_MODULE_ID = `\0${FUNCTION_HANDLER_MODULE_ID}`;
+var SERVER_ENTRY_MODULE_ID = "virtual:netlify-server-entry";
 var toPosixPath = (path) => path.split(import_node_path.sep).join(import_posix.sep);
 var FUNCTION_HANDLER = (
   /* js */
@@ -179,9 +180,11 @@ function netlifyPlugin(options = {}) {
   const additionalExcludedPaths = options.excludedPaths ?? [];
   let resolvedConfig;
   let isProductionSsrBuild = false;
+  let currentCommand;
   return {
     name: "vite-plugin-netlify-react-router",
     config(config, { command, isSsrBuild }) {
+      currentCommand = command;
       isProductionSsrBuild = isSsrBuild === true && command === "build";
       if (isProductionSsrBuild) {
         config.build ??= {};
@@ -212,10 +215,20 @@ function netlifyPlugin(options = {}) {
         }
       }
     },
-    async resolveId(source) {
+    async resolveId(source, importer, options2) {
       if (source === FUNCTION_HANDLER_MODULE_ID) {
         return RESOLVED_FUNCTION_HANDLER_MODULE_ID;
       }
+      if (source === SERVER_ENTRY_MODULE_ID && edge) {
+        if (currentCommand === "serve") {
+          const reactRouterDev = await this.resolve("@react-router/dev/config", importer, options2);
+          if (!reactRouterDev) {
+            throw new Error("The @react-router/dev package is required for local development. Please install it.");
+          }
+          return (0, import_node_path.resolve)((0, import_node_path.dirname)(reactRouterDev.id), "config/defaults/entry.server.node.tsx");
+        }
+        return this.resolve("@netlify/vite-plugin-react-router/entry.server.edge", importer, options2);
+      }
     },
     // See https://vitejs.dev/guide/api-plugin#virtual-modules-convention.
     load(id) {

package/dist/index.mjs

@@ -6,12 +6,12 @@ import "./chunk-J5PMA2AP.mjs";
 
 // src/plugin.ts
 import { mkdir, writeFile, readdir } from "node:fs/promises";
-import { join, relative, sep } from "node:path";
+import { dirname, join, relative, resolve, sep } from "node:path";
 import { sep as posixSep } from "node:path/posix";
 
 // package.json
 var name = "@netlify/vite-plugin-react-router";
-var version = "2.1.0";
+var version = "2.1.1";
 
 // src/plugin.ts
 var NETLIFY_FUNCTIONS_DIR = ".netlify/v1/functions";
@@ -20,6 +20,7 @@ var FUNCTION_FILENAME = "react-router-server.mjs";
 var FUNCTION_HANDLER_CHUNK = "server";
 var FUNCTION_HANDLER_MODULE_ID = "virtual:netlify-server";
 var RESOLVED_FUNCTION_HANDLER_MODULE_ID = `\0${FUNCTION_HANDLER_MODULE_ID}`;
+var SERVER_ENTRY_MODULE_ID = "virtual:netlify-server-entry";
 var toPosixPath = (path) => path.split(sep).join(posixSep);
 var FUNCTION_HANDLER = (
   /* js */
@@ -78,9 +79,11 @@ function netlifyPlugin(options = {}) {
   const additionalExcludedPaths = options.excludedPaths ?? [];
   let resolvedConfig;
   let isProductionSsrBuild = false;
+  let currentCommand;
   return {
     name: "vite-plugin-netlify-react-router",
     config(config, { command, isSsrBuild }) {
+      currentCommand = command;
       isProductionSsrBuild = isSsrBuild === true && command === "build";
       if (isProductionSsrBuild) {
         config.build ??= {};
@@ -111,10 +114,20 @@ function netlifyPlugin(options = {}) {
         }
       }
     },
-    async resolveId(source) {
+    async resolveId(source, importer, options2) {
       if (source === FUNCTION_HANDLER_MODULE_ID) {
         return RESOLVED_FUNCTION_HANDLER_MODULE_ID;
       }
+      if (source === SERVER_ENTRY_MODULE_ID && edge) {
+        if (currentCommand === "serve") {
+          const reactRouterDev = await this.resolve("@react-router/dev/config", importer, options2);
+          if (!reactRouterDev) {
+            throw new Error("The @react-router/dev package is required for local development. Please install it.");
+          }
+          return resolve(dirname(reactRouterDev.id), "config/defaults/entry.server.node.tsx");
+        }
+        return this.resolve("@netlify/vite-plugin-react-router/entry.server.edge", importer, options2);
+      }
     },
     // See https://vitejs.dev/guide/api-plugin#virtual-modules-convention.
     load(id) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/vite-plugin-react-router",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "React Router 7+ Vite plugin for Netlify",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -24,6 +24,10 @@
     "./edge": {
       "types": "./dist/edge.d.mts",
       "default": "./dist/edge.mjs"
+    },
+    "./entry.server.edge": {
+      "types": "./dist/entry.server.edge.d.mts",
+      "default": "./dist/entry.server.edge.mjs"
     }
   },
   "files": [
@@ -48,11 +52,11 @@
   },
   "homepage": "https://github.com/netlify/remix-compute#readme",
   "dependencies": {
-    "isbot": "^5.0.0"
+    "@netlify/edge-functions": "^3.0.2",
+    "@netlify/functions": "^5.1.0",
+    "isbot": "^5.1.25"
   },
   "devDependencies": {
-    "@netlify/edge-functions": "^2.11.0",
-    "@netlify/functions": "^3.1.10",
     "@types/react": "^18.0.27",
     "@types/react-dom": "^18.0.10",
     "react": "^18.2.0",