Handle isbot v4 in a backwards-compatible manner (#8415)

Co-authored-by: Filip Bel <[email protected]>

Author: brophdawg11

integration/defer-test.ts

@@ -985,7 +985,7 @@ test.describe("aborted", () => {
           import type { AppLoadContext, EntryContext } from "@remix-run/node";
           import { createReadableStreamFromReadable } from "@remix-run/node";
           import { RemixServer } from "@remix-run/react";
-          import isbot from "isbot";
+          import { isbot } from "isbot";
           import { renderToPipeableStream } from "react-dom/server";
 
           const ABORT_DELAY = 1;
@@ -997,7 +997,7 @@ test.describe("aborted", () => {
             remixContext: EntryContext,
             loadContext: AppLoadContext
           ) {
-            return isbot(request.headers.get("user-agent"))
+            return isbot(request.headers.get("user-agent") || "")
               ? handleBotRequest(
                   request,
                   responseStatusCode,

integration/helpers/vite-template/package.json

@@ -12,7 +12,7 @@
     "@remix-run/node": "*",
     "@remix-run/react": "*",
     "@remix-run/serve": "*",
-    "isbot": "^3.6.8",
+    "isbot": "^4.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

integration/package.json

@@ -21,7 +21,7 @@
     "get-port": "^5.1.1",
     "glob": "8.0.3",
     "globby": "^11.1.0",
-    "isbot": "^3.6.8",
+    "isbot": "^4.1.0",
     "npm-run-all": "^4.1.5",
     "pidtree": "^0.6.0",
     "postcss": "^8.4.19",

packages/remix-dev/__tests__/fixtures/cloudflare/package.json

@@ -13,7 +13,7 @@
     "@remix-run/cloudflare-pages": "*",
     "@remix-run/css-bundle": "*",
     "@remix-run/react": "*",
-    "isbot": "^3.6.8",
+    "isbot": "^4.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

packages/remix-dev/__tests__/fixtures/deno/.vscode/resolve_npm_imports.json

@@ -13,7 +13,7 @@
     "@remix-run/dev/server-build": "https://esm.sh/@remix-run/[email protected]/server-build",
     "@remix-run/react": "https://esm.sh/@remix-run/[email protected]",
     "@remix-run/server-runtime": "https://esm.sh/@remix-run/[email protected]",
-    "isbot": "https://esm.sh/isbot@^3.6.8",
+    "isbot": "https://esm.sh/isbot@^4.1.0",
     "react": "https://esm.sh/react@^18.2.0",
     "react-dom": "https://esm.sh/react-dom@^18.2.0",
     "react-dom/client": "https://esm.sh/react-dom@^18.2.0/client",

packages/remix-dev/__tests__/fixtures/deno/package.json

@@ -16,7 +16,7 @@
     "@remix-run/css-bundle": "*",
     "@remix-run/deno": "*",
     "@remix-run/react": "*",
-    "isbot": "^3.6.8",
+    "isbot": "^4.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

packages/remix-dev/__tests__/fixtures/node/package.json

@@ -13,7 +13,7 @@
     "@remix-run/node": "*",
     "@remix-run/react": "*",
     "@remix-run/serve": "*",
-    "isbot": "^3.6.8",
+    "isbot": "^4.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

packages/remix-dev/config.ts

@@ -493,7 +493,7 @@ export async function resolveConfig(
       pkgJson.update({
         dependencies: {
           ...pkgJson.content.dependencies,
-          isbot: "latest",
+          isbot: "^4",
         },
       });
 

packages/remix-dev/config/defaults/entry.server.cloudflare.tsx

@@ -1,6 +1,6 @@
 import type { AppLoadContext, EntryContext } from "@remix-run/cloudflare";
 import { RemixServer } from "@remix-run/react";
-import isbot from "isbot";
+import * as isbotModule from "isbot";
 import { renderToReadableStream } from "react-dom/server";
 
 export default async function handleRequest(
@@ -22,7 +22,7 @@ export default async function handleRequest(
     }
   );
 
-  if (isbot(request.headers.get("user-agent"))) {
+  if (isBotRequest(request.headers.get("user-agent"))) {
     await body.allReady;
   }
 
@@ -32,3 +32,24 @@ export default async function handleRequest(
     status: responseStatusCode,
   });
 }
+
+// We have some Remix apps in the wild already running with isbot@3 so we need
+// to maintain backwards compatibility even though we want new apps to use
+// isbot@4.  That way, we can ship this as a minor Semver update to @remix-run/dev.
+function isBotRequest(userAgent: string | null) {
+  if (!userAgent) {
+    return false;
+  }
+
+  // isbot >= 3.8.0, >4
+  if ("isbot" in isbotModule && typeof isbotModule.isbot === "function") {
+    return isbotModule.isbot(userAgent);
+  }
+
+  // isbot < 3.8.0
+  if ("default" in isbotModule && typeof isbotModule.default === "function") {
+    return isbotModule.default(userAgent);
+  }
+
+  return false;
+}

packages/remix-dev/config/defaults/entry.server.deno.tsx

@@ -1,6 +1,6 @@
 import type { AppLoadContext, EntryContext } from "@remix-run/deno";
 import { RemixServer } from "@remix-run/react";
-import isbot from "isbot";
+import * as isbotModule from "isbot";
 import { renderToReadableStream } from "react-dom/server";
 
 export default async function handleRequest(
@@ -22,7 +22,7 @@ export default async function handleRequest(
     }
   );
 
-  if (isbot(request.headers.get("user-agent"))) {
+  if (isBotRequest(request.headers.get("user-agent"))) {
     await body.allReady;
   }
 
@@ -32,3 +32,24 @@ export default async function handleRequest(
     status: responseStatusCode,
   });
 }
+
+// We have some Remix apps in the wild already running with isbot@3 so we need
+// to maintain backwards compatibility even though we want new apps to use
+// isbot@4.  That way, we can ship this as a minor Semver update to @remix-run/dev.
+function isBotRequest(userAgent: string | null) {
+  if (!userAgent) {
+    return false;
+  }
+
+  // isbot >= 3.8.0, >4
+  if ("isbot" in isbotModule && typeof isbotModule.isbot === "function") {
+    return isbotModule.isbot(userAgent);
+  }
+
+  // isbot < 3.8.0
+  if ("default" in isbotModule && typeof isbotModule.default === "function") {
+    return isbotModule.default(userAgent);
+  }
+
+  return false;
+}

packages/remix-dev/config/defaults/entry.server.node.tsx

@@ -3,7 +3,7 @@ import { PassThrough } from "node:stream";
 import type { AppLoadContext, EntryContext } from "@remix-run/node";
 import { createReadableStreamFromReadable } from "@remix-run/node";
 import { RemixServer } from "@remix-run/react";
-import isbot from "isbot";
+import * as isbotModule from "isbot";
 import { renderToPipeableStream } from "react-dom/server";
 
 const ABORT_DELAY = 5_000;
@@ -15,7 +15,7 @@ export default function handleRequest(
   remixContext: EntryContext,
   loadContext: AppLoadContext
 ) {
-  return isbot(request.headers.get("user-agent"))
+  return isBotRequest(request.headers.get("user-agent"))
     ? handleBotRequest(
         request,
         responseStatusCode,
@@ -30,6 +30,27 @@ export default function handleRequest(
       );
 }
 
+// We have some Remix apps in the wild already running with isbot@3 so we need
+// to maintain backwards compatibility even though we want new apps to use
+// isbot@4.  That way, we can ship this as a minor Semver update to @remix-run/dev.
+function isBotRequest(userAgent: string | null) {
+  if (!userAgent) {
+    return false;
+  }
+
+  // isbot >= 3.8.0, >4
+  if ("isbot" in isbotModule && typeof isbotModule.isbot === "function") {
+    return isbotModule.isbot(userAgent);
+  }
+
+  // isbot < 3.8.0
+  if ("default" in isbotModule && typeof isbotModule.default === "function") {
+    return isbotModule.default(userAgent);
+  }
+
+  return false;
+}
+
 function handleBotRequest(
   request: Request,
   responseStatusCode: number,