@opennextjs/cloudflare 1.7.1 → 1.8.1

package/dist/api/overrides/cache-purge/index.d.ts

@@ -9,4 +9,4 @@ export declare const purgeCache: ({ type }: PurgeOptions) => {
         resolvedRoutes: import("@opennextjs/aws/types/open-next.js").ResolvedRoute[];
     }[]): Promise<void>;
 };
-export {};
+export default purgeCache;

package/dist/api/overrides/cache-purge/index.js

@@ -25,3 +25,4 @@ export const purgeCache = ({ type = "direct" }) => {
         },
     };
 };
+export default purgeCache;

package/dist/api/overrides/incremental-cache/regional-cache.d.ts

@@ -20,13 +20,15 @@ type Options = {
      * Whether the regional cache entry should be updated in the background or not when it experiences
      * a cache hit.
      *
-     * @default `false` for the `short-lived` mode, and `true` for the `long-lived` mode.
+     * @default `true` in `long-lived` mode when cache purge is not used, `false` otherwise.
      */
     shouldLazilyUpdateOnCacheHit?: boolean;
     /**
      * Whether on cache hits the tagCache should be skipped or not. Skipping the tagCache allows requests to be
-     * handled faster, the downside of this is that you need to make sure that the cache gets correctly purged
-     * either by enabling the auto cache purging feature or doing that manually.
+     * handled faster,
+     *
+     * Note: When this is enabled, make sure that the cache gets purged
+     *       either by enabling the auto cache purging feature or manually.
      *
      * @default `true` if the auto cache purging is enabled, `false` otherwise.
      */
@@ -38,7 +40,16 @@ interface PutToCacheInput {
     entry: IncrementalCacheEntry<CacheEntryType>;
 }
 /**
- * Wrapper adding a regional cache on an `IncrementalCache` implementation
+ * Wrapper adding a regional cache on an `IncrementalCache` implementation.
+ *
+ * Using a the `RegionalCache` does not directly improves the performance much.
+ * However it allows bypassing the tag cache (see `bypassTagCacheOnCacheHit`) on hits.
+ * That's where bigger perf gain happens.
+ *
+ * We recommend using cache purge.
+ * When cache purge is not enabled, there is a possibility that the Cache API (local to a Data Center)
+ * is out of sync with the cache store (i.e. R2). That's why when cache purge is not enabled the Cache
+ * API is refreshed from the cache store on cache hits (for the long-lived mode).
  */
 declare class RegionalCache implements IncrementalCache {
     #private;

package/dist/api/overrides/incremental-cache/regional-cache.js

@@ -5,7 +5,16 @@ import { NAME as KV_CACHE_NAME } from "./kv-incremental-cache.js";
 const ONE_MINUTE_IN_SECONDS = 60;
 const THIRTY_MINUTES_IN_SECONDS = ONE_MINUTE_IN_SECONDS * 30;
 /**
- * Wrapper adding a regional cache on an `IncrementalCache` implementation
+ * Wrapper adding a regional cache on an `IncrementalCache` implementation.
+ *
+ * Using a the `RegionalCache` does not directly improves the performance much.
+ * However it allows bypassing the tag cache (see `bypassTagCacheOnCacheHit`) on hits.
+ * That's where bigger perf gain happens.
+ *
+ * We recommend using cache purge.
+ * When cache purge is not enabled, there is a possibility that the Cache API (local to a Data Center)
+ * is out of sync with the cache store (i.e. R2). That's why when cache purge is not enabled the Cache
+ * API is refreshed from the cache store on cache hits (for the long-lived mode).
  */
 class RegionalCache {
     store;
@@ -19,7 +28,8 @@ class RegionalCache {
             throw new Error("The KV incremental cache does not need a regional cache.");
         }
         this.name = this.store.name;
-        this.opts.shouldLazilyUpdateOnCacheHit ??= this.opts.mode === "long-lived";
+        this.opts.shouldLazilyUpdateOnCacheHit ??=
+            this.opts.mode === "long-lived" && !this.#hasAutomaticCachePurging;
     }
     get #bypassTagCacheOnCacheHit() {
         if (this.opts.bypassTagCacheOnCacheHit !== undefined) {
@@ -27,8 +37,11 @@ class RegionalCache {
             return this.opts.bypassTagCacheOnCacheHit;
         }
         // Otherwise we default to whether the automatic cache purging is enabled or not
-        const hasAutomaticCachePurging = !!getCloudflareContext().env.NEXT_CACHE_DO_PURGE;
-        return hasAutomaticCachePurging;
+        return this.#hasAutomaticCachePurging;
+    }
+    get #hasAutomaticCachePurging() {
+        const cdnInvalidation = globalThis.openNextConfig.default?.override?.cdnInvalidation;
+        return cdnInvalidation !== undefined && cdnInvalidation !== "dummy";
     }
     async get(key, cacheType) {
         try {
@@ -38,7 +51,8 @@ class RegionalCache {
             const cachedResponse = await cache.match(urlKey);
             if (cachedResponse) {
                 debugCache("Get - cached response");
-                // Re-fetch from the store and update the regional cache in the background
+                // Re-fetch from the store and update the regional cache in the background.
+                // Note: this is only useful when the Cache API is not purged automatically.
                 if (this.opts.shouldLazilyUpdateOnCacheHit) {
                     getCloudflareContext().ctx.waitUntil(this.store.get(key, cacheType).then(async (rawEntry) => {
                         const { value, lastModified } = rawEntry ?? {};

package/dist/api/overrides/internal.js

@@ -30,7 +30,7 @@ export async function purgeCacheByTags(tags) {
     }
 }
 export async function internalPurgeCacheByTags(env, tags) {
-    if (!env.CACHE_PURGE_ZONE_ID && !env.CACHE_PURGE_API_TOKEN) {
+    if (!env.CACHE_PURGE_ZONE_ID || !env.CACHE_PURGE_API_TOKEN) {
         // THIS IS A NO-OP
         error("No cache zone ID or API token provided. Skipping cache purge.");
         return "missing-credentials";

package/dist/cli/build/open-next/compile-init.js

@@ -12,6 +12,7 @@ export async function compileInit(options, wranglerConfig) {
     const nextConfig = loadConfig(path.join(options.appBuildOutputPath, ".next"));
     const basePath = nextConfig.basePath ?? "";
     const deploymentId = nextConfig.deploymentId ?? "";
+    const trailingSlash = nextConfig.trailingSlash ?? false;
     await build({
         entryPoints: [initPath],
         outdir: path.join(options.outputDir, "cloudflare"),
@@ -25,6 +26,7 @@ export async function compileInit(options, wranglerConfig) {
             __NEXT_BASE_PATH__: JSON.stringify(basePath),
             __ASSETS_RUN_WORKER_FIRST__: JSON.stringify(wranglerConfig.assets?.run_worker_first ?? false),
             __DEPLOYMENT_ID__: JSON.stringify(deploymentId),
+            __TRAILING_SLASH__: JSON.stringify(trailingSlash),
         },
     });
 }

package/dist/cli/build/utils/create-config-files.d.ts

@@ -15,5 +15,6 @@ export declare function getLatestCompatDate(): Promise<string | undefined>;
  * If the user refuses an error is thrown (since the file is mandatory).
  *
  * @param sourceDir The source directory for the project
+ * @return The path to the created source file
  */
-export declare function createOpenNextConfigIfNotExistent(sourceDir: string): Promise<void>;
+export declare function createOpenNextConfigIfNotExistent(sourceDir: string): Promise<string>;

package/dist/cli/build/utils/create-config-files.js

@@ -67,6 +67,7 @@ export async function getLatestCompatDate() {
  * If the user refuses an error is thrown (since the file is mandatory).
  *
  * @param sourceDir The source directory for the project
+ * @return The path to the created source file
  */
 export async function createOpenNextConfigIfNotExistent(sourceDir) {
     const openNextConfigPath = join(sourceDir, "open-next.config.ts");
@@ -77,4 +78,5 @@ export async function createOpenNextConfigIfNotExistent(sourceDir) {
         }
         cpSync(join(getPackageTemplatesDirPath(), "open-next.config.ts"), openNextConfigPath);
     }
+    return openNextConfigPath;
 }

package/dist/cli/commands/build.js

@@ -7,7 +7,7 @@ import { compileConfig, getNormalizedOptions, nextAppDir, printHeaders, readWran
  */
 async function buildCommand(args) {
     printHeaders("build");
-    const { config, buildDir } = await compileConfig();
+    const { config, buildDir } = await compileConfig(args.openNextConfigPath);
     const options = getNormalizedOptions(config, buildDir);
     const wranglerConfig = readWranglerConfig(args);
     await buildImpl(options, config, { ...args, minify: !args.noMinify, sourceDir: nextAppDir }, wranglerConfig);
@@ -34,5 +34,9 @@ export function addBuildCommand(y) {
         type: "boolean",
         default: ["1", "true", "yes"].includes(String(process.env.SKIP_WRANGLER_CONFIG_CHECK)),
         desc: "Skip checking for a Wrangler config",
+    })
+        .option("openNextConfigPath", {
+        type: "string",
+        desc: "Path to the OpenNext configuration file",
     }), (args) => buildCommand(withWranglerPassthroughArgs(args)));
 }

package/dist/cli/commands/deploy.js

@@ -15,14 +15,14 @@ export async function deployCommand(args) {
     const options = getNormalizedOptions(config);
     const wranglerConfig = readWranglerConfig(args);
     const envVars = await getEnvFromPlatformProxy({
-        configPath: args.configPath,
+        configPath: args.wranglerConfigPath,
         environment: args.env,
     });
     const deploymentMapping = await getDeploymentMapping(options, config, envVars);
     await populateCache(options, config, wranglerConfig, {
         target: "remote",
         environment: args.env,
-        configPath: args.configPath,
+        wranglerConfigPath: args.wranglerConfigPath,
         cacheChunkSize: args.cacheChunkSize,
     });
     runWrangler(options, [

package/dist/cli/commands/populate-cache.d.ts

@@ -13,7 +13,7 @@ export declare function getCacheAssets(opts: BuildOptions): CacheAsset[];
 type PopulateCacheOptions = {
     target: WranglerTarget;
     environment?: string;
-    configPath?: string;
+    wranglerConfigPath?: string;
     cacheChunkSize?: number;
 };
 export declare function populateCache(options: BuildOptions, config: OpenNextConfig, wranglerConfig: WranglerConfig, populateCacheOptions: PopulateCacheOptions): Promise<void>;
@@ -24,6 +24,8 @@ export declare function populateCache(options: BuildOptions, config: OpenNextCon
  */
 export declare function addPopulateCacheCommand<T extends yargs.Argv>(y: T): yargs.Argv<{}>;
 export declare function withPopulateCacheOptions<T extends yargs.Argv>(args: T): yargs.Argv<{
+    config: string | undefined;
+} & {
     configPath: string | undefined;
 } & {
     env: string | undefined;

package/dist/cli/commands/populate-cache.js

@@ -76,7 +76,7 @@ async function populateR2IncrementalCache(options, config, populateCacheOptions)
             `--file ${quoteShellMeta(fullPath)}`,
         ], {
             target: populateCacheOptions.target,
-            configPath: populateCacheOptions.configPath,
+            configPath: populateCacheOptions.wranglerConfigPath,
             // R2 does not support the environment flag and results in the following error:
             // Incorrect type for the 'cacheExpiry' field on 'HttpMetadata': the provided value is not of type 'date'.
             environment: undefined,
@@ -113,7 +113,7 @@ async function populateKVIncrementalCache(options, config, populateCacheOptions)
         runWrangler(options, ["kv bulk put", quoteShellMeta(chunkPath), `--binding ${KV_CACHE_BINDING_NAME}`], {
             target: populateCacheOptions.target,
             environment: populateCacheOptions.environment,
-            configPath: populateCacheOptions.configPath,
+            configPath: populateCacheOptions.wranglerConfigPath,
             logging: "error",
         });
         rmSync(chunkPath);
@@ -133,7 +133,7 @@ function populateD1TagCache(options, config, populateCacheOptions) {
     ], {
         target: populateCacheOptions.target,
         environment: populateCacheOptions.environment,
-        configPath: populateCacheOptions.configPath,
+        configPath: populateCacheOptions.wranglerConfigPath,
         logging: "error",
     });
     logger.info("\nSuccessfully created D1 table");
@@ -189,7 +189,7 @@ async function populateCacheCommand(target, args) {
     await populateCache(options, config, wranglerConfig, {
         target,
         environment: args.env,
-        configPath: args.configPath,
+        wranglerConfigPath: args.wranglerConfigPath,
         cacheChunkSize: args.cacheChunkSize,
     });
 }

package/dist/cli/commands/preview.js

@@ -14,7 +14,7 @@ export async function previewCommand(args) {
     await populateCache(options, config, wranglerConfig, {
         target: "local",
         environment: args.env,
-        configPath: args.configPath,
+        wranglerConfigPath: args.wranglerConfigPath,
         cacheChunkSize: args.cacheChunkSize,
     });
     runWrangler(options, ["dev", ...args.wranglerArgs], { logging: "all" });

package/dist/cli/commands/upload.js

@@ -15,14 +15,14 @@ export async function uploadCommand(args) {
     const options = getNormalizedOptions(config);
     const wranglerConfig = readWranglerConfig(args);
     const envVars = await getEnvFromPlatformProxy({
-        configPath: args.configPath,
+        configPath: args.wranglerConfigPath,
         environment: args.env,
     });
     const deploymentMapping = await getDeploymentMapping(options, config, envVars);
     await populateCache(options, config, wranglerConfig, {
         target: "remote",
         environment: args.env,
-        configPath: args.configPath,
+        wranglerConfigPath: args.wranglerConfigPath,
         cacheChunkSize: args.cacheChunkSize,
     });
     runWrangler(options, [

package/dist/cli/commands/utils.d.ts

@@ -2,7 +2,7 @@ import type yargs from "yargs";
 import type { OpenNextConfig } from "../../api/config.js";
 export type WithWranglerArgs<T = unknown> = T & {
     wranglerArgs: string[];
-    configPath: string | undefined;
+    wranglerConfigPath: string | undefined;
     env: string | undefined;
 };
 export declare const nextAppDir: string;
@@ -13,11 +13,17 @@ export declare const nextAppDir: string;
  */
 export declare function printHeaders(command: string): void;
 /**
- * Compile the OpenNext config, and ensure it is for Cloudflare.
+ * Compile the OpenNext config.
+ *
+ * When users do not specify a custom config file (using `--openNextConfigPath`),
+ * the CLI will offer to create one.
+ *
+ * When users specify a custom config file but it doesn't exist, we throw an Error.
  *
+ * @param configPath Optional path to the config file. Absolute or relative to cwd.
  * @returns OpenNext config.
  */
-export declare function compileConfig(): Promise<{
+export declare function compileConfig(configPath: string | undefined): Promise<{
     config: import("@opennextjs/aws/types/open-next.js").OpenNextConfig;
     buildDir: string;
 }>;
@@ -64,18 +70,21 @@ export declare function readWranglerConfig(args: WithWranglerArgs): import("wran
  * Adds flags for the wrangler config path and environment to the yargs configuration.
  */
 export declare function withWranglerOptions<T extends yargs.Argv>(args: T): yargs.Argv<{
+    config: string | undefined;
+} & {
     configPath: string | undefined;
 } & {
     env: string | undefined;
 }>;
+type WranglerInputArgs = {
+    configPath: string | undefined;
+    config: string | undefined;
+    env: string | undefined;
+};
 /**
  *
  * @param args
  * @returns The inputted args, and an array of arguments that can be given to wrangler commands, including the `--config` and `--env` args.
  */
-export declare function withWranglerPassthroughArgs<T extends yargs.ArgumentsCamelCase<{
-    configPath: string | undefined;
-    env: string | undefined;
-}>>(args: T): T & {
-    wranglerArgs: string[];
-};
+export declare function withWranglerPassthroughArgs<T extends yargs.ArgumentsCamelCase<WranglerInputArgs>>(args: T): WithWranglerArgs<T>;
+export {};

package/dist/cli/commands/utils.js

@@ -18,13 +18,25 @@ export function printHeaders(command) {
     showWarningOnWindows();
 }
 /**
- * Compile the OpenNext config, and ensure it is for Cloudflare.
+ * Compile the OpenNext config.
  *
+ * When users do not specify a custom config file (using `--openNextConfigPath`),
+ * the CLI will offer to create one.
+ *
+ * When users specify a custom config file but it doesn't exist, we throw an Error.
+ *
+ * @param configPath Optional path to the config file. Absolute or relative to cwd.
  * @returns OpenNext config.
  */
-export async function compileConfig() {
-    await createOpenNextConfigIfNotExistent(nextAppDir);
-    const { config, buildDir } = await compileOpenNextConfig(nextAppDir, undefined, { compileEdge: true });
+export async function compileConfig(configPath) {
+    if (configPath && !existsSync(configPath)) {
+        throw new Error(`Custom config file not found at ${configPath}`);
+    }
+    if (!configPath) {
+        configPath = await createOpenNextConfigIfNotExistent(nextAppDir);
+    }
+    // TODO: remove the hack passing the `configPath` as the `baseDir` when https://github.com/opennextjs/opennextjs-aws/pull/972 is merged
+    const { config, buildDir } = await compileOpenNextConfig(configPath, "", { compileEdge: true });
     ensureCloudflareConfig(config);
     return { config, buildDir };
 }
@@ -64,19 +76,24 @@ export function getNormalizedOptions(config, buildDir = nextAppDir) {
  * @returns Wrangler config.
  */
 export function readWranglerConfig(args) {
-    return unstable_readConfig({ env: args.env, config: args.configPath });
+    return unstable_readConfig({ env: args.env, config: args.wranglerConfigPath });
 }
 /**
  * Adds flags for the wrangler config path and environment to the yargs configuration.
  */
 export function withWranglerOptions(args) {
     return args
-        .options("configPath", {
+        .option("config", {
         type: "string",
-        alias: ["config", "c"],
+        alias: "c",
         desc: "Path to Wrangler configuration file",
     })
-        .options("env", {
+        .option("configPath", {
+        type: "string",
+        desc: "Path to Wrangler configuration file",
+        deprecated: true,
+    })
+        .option("env", {
         type: "string",
         alias: "e",
         desc: "Wrangler environment to use for operations",
@@ -88,8 +105,16 @@ export function withWranglerOptions(args) {
  * @returns An array of arguments that can be given to wrangler commands, including the `--config` and `--env` args.
  */
 function getWranglerArgs(args) {
+    if (args.configPath) {
+        logger.warn("The `--configPath` flag is deprecated, please use `--config` instead.");
+        if (args.config) {
+            logger.error("Multiple config flags found. Please use the `--config` flag for your Wrangler config path.");
+            process.exit(1);
+        }
+    }
     return [
         ...(args.configPath ? ["--config", args.configPath] : []),
+        ...(args.config ? ["--config", args.config] : []),
         ...(args.env ? ["--env", args.env] : []),
         // Note: the first args in `_` will be the commands.
         ...args._.slice(args._[0] === "populateCache" ? 2 : 1).map((a) => `${a}`),
@@ -101,5 +126,9 @@ function getWranglerArgs(args) {
  * @returns The inputted args, and an array of arguments that can be given to wrangler commands, including the `--config` and `--env` args.
  */
 export function withWranglerPassthroughArgs(args) {
-    return { ...args, wranglerArgs: getWranglerArgs(args) };
+    return {
+        ...args,
+        wranglerConfigPath: args.config ?? args.configPath,
+        wranglerArgs: getWranglerArgs(args),
+    };
 }

package/dist/cli/templates/init.d.ts

@@ -12,4 +12,5 @@ declare global {
     var __NEXT_BASE_PATH__: string;
     var __ASSETS_RUN_WORKER_FIRST__: boolean | string[] | undefined;
     var __DEPLOYMENT_ID__: string;
+    var __TRAILING_SLASH__: boolean;
 }

package/dist/cli/templates/init.js

@@ -76,6 +76,7 @@ function initRuntime() {
         __BUILD_TIMESTAMP_MS__,
         __NEXT_BASE_PATH__,
         __ASSETS_RUN_WORKER_FIRST__,
+        __TRAILING_SLASH__,
         // The external middleware will use the convertTo function of the `edge` converter
         // by default it will try to fetch the request, but since we are running everything in the same worker
         // we need to use the request as is.

package/dist/cli/templates/worker.js

@@ -33,7 +33,8 @@ export default {
                     : env.ASSETS?.fetch(new URL(`/${imageUrl}`, url));
             }
             // Fallback for the Next default image loader.
-            if (url.pathname === `${globalThis.__NEXT_BASE_PATH__}/_next/image`) {
+            if (url.pathname ===
+                `${globalThis.__NEXT_BASE_PATH__}/_next/image${globalThis.__TRAILING_SLASH__ ? "/" : ""}`) {
                 const imageUrl = url.searchParams.get("url") ?? "";
                 return await fetchImage(env.ASSETS, imageUrl, ctx);
             }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "1.7.1",
+  "version": "1.8.1",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"