Add support for basePath (#574)

vicb · web-flow · commit d310919aed46 · 2025-04-14T16:53:37.000+02:00
diff --git a/.changeset/blue-beds-crash.md b/.changeset/blue-beds-crash.md
@@ -0,0 +1,5 @@
+---
+"@opennextjs/cloudflare": patch
+---
+
+Add support for basePath
diff --git a/.changeset/silly-icons-battle.md b/.changeset/silly-icons-battle.md
@@ -0,0 +1,5 @@
+---
+"@opennextjs/cloudflare": patch
+---
+
+bump @opennextjs/aws to 3.5.7
diff --git a/examples/bugs/gh-219/package.json b/examples/bugs/gh-219/package.json
@@ -16,7 +16,6 @@
   "dependencies": {
     "@hookform/resolvers": "^3.9.1",
     "@libsql/client": "^0.14.0",
-    "@opennextjs/aws": "^3.3.1",
     "@t3-oss/env-nextjs": "^0.11.1",
     "@tanstack/react-table": "^8.20.6",
     "better-sqlite3": "^11.7.0",
diff --git a/packages/cloudflare/package.json b/packages/cloudflare/package.json
@@ -53,7 +53,7 @@
   "homepage": "https://github.com/opennextjs/opennextjs-cloudflare",
   "dependencies": {
     "@dotenvx/dotenvx": "catalog:",
-    "@opennextjs/aws": "3.5.6",
+    "@opennextjs/aws": "3.5.7",
     "enquirer": "^2.4.1",
     "glob": "catalog:",
     "ts-tqdm": "^0.8.6"
diff --git a/packages/cloudflare/src/api/overrides/incremental-cache/kv-incremental-cache.ts b/packages/cloudflare/src/api/overrides/incremental-cache/kv-incremental-cache.ts
@@ -56,8 +56,7 @@ class KVIncrementalCache implements IncrementalCache {
       // if there is no lastModified property, the file was stored during build-time cache population.
       return {
         value: entry,
-        // __BUILD_TIMESTAMP_MS__ is injected by ESBuild.
-        lastModified: (globalThis as { __BUILD_TIMESTAMP_MS__?: number }).__BUILD_TIMESTAMP_MS__,
+        lastModified: globalThis.__BUILD_TIMESTAMP_MS__,
       };
     } catch (e) {
       error("Failed to get from cache", e);
diff --git a/packages/cloudflare/src/api/overrides/incremental-cache/static-assets-incremental-cache.ts b/packages/cloudflare/src/api/overrides/incremental-cache/static-assets-incremental-cache.ts
@@ -33,8 +33,7 @@ class StaticAssetsIncrementalCache implements IncrementalCache {
 
       return {
         value: await response.json(),
-        // __BUILD_TIMESTAMP_MS__ is injected by ESBuild.
-        lastModified: (globalThis as { __BUILD_TIMESTAMP_MS__?: number }).__BUILD_TIMESTAMP_MS__,
+        lastModified: globalThis.__BUILD_TIMESTAMP_MS__,
       };
     } catch (e) {
       error("Failed to get from cache", e);
diff --git a/packages/cloudflare/src/cli/build/build.ts b/packages/cloudflare/src/cli/build/build.ts
@@ -70,7 +70,7 @@ export async function build(
   // Compile middleware
   await createMiddleware(options, { forceOnlyBuildOnce: true });
 
-  createStaticAssets(options);
+  createStaticAssets(options, { useBasePath: true });
 
   if (config.dangerous?.disableIncrementalCache !== true) {
     const { useTagCache, metaFiles } = createCacheAssets(options);
diff --git a/packages/cloudflare/src/cli/build/bundle-server.ts b/packages/cloudflare/src/cli/build/bundle-server.ts
@@ -176,6 +176,7 @@ export async function updateWorkerBundledCode(
     [
       "'require(this.middlewareManifestPath)'",
       (code) => patches.inlineMiddlewareManifestRequire(code, buildOpts),
+      { isOptional: true },
     ],
     [
       "`require.resolve` call",
diff --git a/packages/cloudflare/src/cli/build/open-next/compile-init.ts b/packages/cloudflare/src/cli/build/open-next/compile-init.ts
@@ -1,7 +1,8 @@
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 
-import type { BuildOptions } from "@opennextjs/aws/build/helper";
+import { loadConfig } from "@opennextjs/aws/adapters/config/util.js";
+import type { BuildOptions } from "@opennextjs/aws/build/helper.js";
 import { build } from "esbuild";
 
 /**
@@ -12,6 +13,9 @@ export async function compileInit(options: BuildOptions) {
   const templatesDir = path.join(currentDir, "../../templates");
   const initPath = path.join(templatesDir, "init.js");
 
+  const nextConfig = loadConfig(path.join(options.appBuildOutputPath, ".next"));
+  const basePath = nextConfig.basePath ?? "";
+
   await build({
     entryPoints: [initPath],
     outdir: path.join(options.outputDir, "cloudflare"),
@@ -22,6 +26,7 @@ export async function compileInit(options: BuildOptions) {
     platform: "node",
     define: {
       __BUILD_TIMESTAMP_MS__: JSON.stringify(Date.now()),
+      __NEXT_BASE_PATH__: JSON.stringify(basePath),
     },
   });
 }
diff --git a/packages/cloudflare/src/cli/build/open-next/createServerBundle.ts b/packages/cloudflare/src/cli/build/open-next/createServerBundle.ts
@@ -14,10 +14,14 @@ import { installDependencies } from "@opennextjs/aws/build/installDeps.js";
 import type { CodePatcher } from "@opennextjs/aws/build/patch/codePatcher.js";
 import { applyCodePatches } from "@opennextjs/aws/build/patch/codePatcher.js";
 import {
+  patchEnvVars,
   patchFetchCacheForISR,
   patchFetchCacheSetMissingWaitUntil,
+  patchNextServer,
   patchUnstableCacheForISR,
 } from "@opennextjs/aws/build/patch/patches/index.js";
+// TODO: import from patches/index.js when https://github.com/opennextjs/opennextjs-aws/pull/827 is released
+import { patchBackgroundRevalidation } from "@opennextjs/aws/build/patch/patches/patchBackgroundRevalidation.js";
 import logger from "@opennextjs/aws/logger.js";
 import { minifyAll } from "@opennextjs/aws/minimize-js.js";
 import type { ContentUpdater } from "@opennextjs/aws/plugins/content-updater.js";
@@ -190,6 +194,9 @@ async function generateBundle(
     patchFetchCacheSetMissingWaitUntil,
     patchFetchCacheForISR,
     patchUnstableCacheForISR,
+    patchNextServer,
+    patchEnvVars,
+    patchBackgroundRevalidation,
     // Cloudflare specific patches
     patchResRevalidate,
     ...additionalCodePatches,
@@ -220,6 +227,7 @@ async function generateBundle(
         ...(disableNextPrebundledReact ? ["applyNextjsPrebundledReact"] : []),
         ...(disableRouting ? ["withRouting"] : []),
         ...(isAfter142 ? ["patchAsyncStorage"] : []),
+        ...(isAfter141 ? ["appendPrefetch"] : []),
       ],
     }),
     openNextReplacementPlugin({
diff --git a/packages/cloudflare/src/cli/templates/init.ts b/packages/cloudflare/src/cli/templates/init.ts
@@ -91,8 +91,8 @@ function initRuntime() {
 
   Object.assign(globalThis, {
     Request: CustomRequest,
-    //@ts-expect-error Inline at build time by ESBuild
     __BUILD_TIMESTAMP_MS__: __BUILD_TIMESTAMP_MS__,
+    __NEXT_BASE_PATH__: __NEXT_BASE_PATH__,
   });
 }
 
@@ -126,3 +126,12 @@ function populateProcessEnv(url: URL, env: CloudflareEnv) {
     },
   });
 }
+
+/* eslint-disable no-var */
+declare global {
+  // Build timestamp
+  var __BUILD_TIMESTAMP_MS__: number;
+  // Next basePath
+  var __NEXT_BASE_PATH__: string;
+}
+/* eslint-enable no-var */
diff --git a/packages/cloudflare/src/cli/templates/worker.ts b/packages/cloudflare/src/cli/templates/worker.ts
@@ -25,10 +25,10 @@ export default {
       }
 
       // Fallback for the Next default image loader.
-      if (url.pathname === "/_next/image") {
+      if (url.pathname === `${globalThis.__NEXT_BASE_PATH__}/_next/image`) {
         const imageUrl = url.searchParams.get("url") ?? "";
         return imageUrl.startsWith("/")
-          ? env.ASSETS?.fetch(new URL(imageUrl, request.url))
+          ? env.ASSETS?.fetch(`http://assets.local${imageUrl}`)
           : fetch(imageUrl, { cf: { cacheEverything: true } });
       }
 
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@opennextjs/cloudflare": patch
 +---
++
 +Add support for basePath
Original file line number	Diff line number	Diff line change
`@@ -176,6 +176,7 @@ export async function updateWorkerBundledCode(`
`176`	`176`	`[`
`177`	`177`	`"'require(this.middlewareManifestPath)'",`
`178`	`178`	`(code) => patches.inlineMiddlewareManifestRequire(code, buildOpts),`
	`179`	`+ { isOptional: true },`
`179`	`180`	`],`
`180`	`181`	`[`
`181`	`182`	"`require.resolve` call",