feat: add config flag support for deploy, preview, and upload commands

Author: 0ta-mjn

.changeset/fresh-hoops-relax.md

@@ -0,0 +1,7 @@
+---
+"@opennextjs/cloudflare": patch
+---
+
+feature: Add `config` options to `populateCache` command
+
+This change adds the `config` option to the `populateCache` command in the Cloudflare CLI. This allows users to specify a custom Wrangler configuration file when populating the cache, enhancing flexibility and usability.

packages/cloudflare/src/cli/commands/deploy.ts

@@ -1,7 +1,7 @@
 import { BuildOptions } from "@opennextjs/aws/build/helper.js";
 
 import type { OpenNextConfig } from "../../api/config.js";
-import { getWranglerEnvironmentFlag, runWrangler } from "../utils/run-wrangler.js";
+import { getWranglerConfigFlag, getWranglerEnvironmentFlag, runWrangler } from "../utils/run-wrangler.js";
 import { populateCache } from "./populate-cache.js";
 
 export async function deploy(
@@ -12,6 +12,7 @@ export async function deploy(
 	await populateCache(options, config, {
 		target: "remote",
 		environment: getWranglerEnvironmentFlag(deployOptions.passthroughArgs),
+		config: getWranglerConfigFlag(deployOptions.passthroughArgs),
 		cacheChunkSize: deployOptions.cacheChunkSize,
 	});
 

packages/cloudflare/src/cli/commands/populate-cache.ts

@@ -102,11 +102,14 @@ async function getPlatformProxyEnv<T extends keyof CloudflareEnv>(options: GetPl
 
 async function populateR2IncrementalCache(
 	options: BuildOptions,
-	populateCacheOptions: { target: WranglerTarget; environment?: string }
+	populateCacheOptions: { target: WranglerTarget; environment?: string; config?: string }
 ) {
 	logger.info("\nPopulating R2 incremental cache...");
 
-	const config = unstable_readConfig({ env: populateCacheOptions.environment });
+	const config = unstable_readConfig({
+		env: populateCacheOptions.environment,
+		config: populateCacheOptions.config,
+	});
 
 	const binding = config.r2_buckets.find(({ binding }) => binding === R2_CACHE_BINDING_NAME);
 	if (!binding) {
@@ -145,11 +148,19 @@ async function populateR2IncrementalCache(
 
 async function populateKVIncrementalCache(
 	options: BuildOptions,
-	populateCacheOptions: { target: WranglerTarget; environment?: string; cacheChunkSize?: number }
+	populateCacheOptions: {
+		target: WranglerTarget;
+		environment?: string;
+		config?: string;
+		cacheChunkSize?: number;
+	}
 ) {
 	logger.info("\nPopulating KV incremental cache...");
 
-	const config = unstable_readConfig({ env: populateCacheOptions.environment });
+	const config = unstable_readConfig({
+		env: populateCacheOptions.environment,
+		config: populateCacheOptions.config,
+	});
 
 	const binding = config.kv_namespaces.find(({ binding }) => binding === KV_CACHE_BINDING_NAME);
 	if (!binding) {
@@ -233,7 +244,12 @@ function populateStaticAssetsIncrementalCache(options: BuildOptions) {
 export async function populateCache(
 	options: BuildOptions,
 	config: OpenNextConfig,
-	populateCacheOptions: { target: WranglerTarget; environment?: string; cacheChunkSize?: number }
+	populateCacheOptions: {
+		target: WranglerTarget;
+		environment?: string;
+		config?: string;
+		cacheChunkSize?: number;
+	}
 ) {
 	const { incrementalCache, tagCache } = config.default.override ?? {};
 

packages/cloudflare/src/cli/commands/preview.ts

@@ -1,7 +1,7 @@
 import { BuildOptions } from "@opennextjs/aws/build/helper.js";
 
 import type { OpenNextConfig } from "../../api/config.js";
-import { getWranglerEnvironmentFlag, runWrangler } from "../utils/run-wrangler.js";
+import { getWranglerConfigFlag, getWranglerEnvironmentFlag, runWrangler } from "../utils/run-wrangler.js";
 import { populateCache } from "./populate-cache.js";
 
 export async function preview(
@@ -12,6 +12,7 @@ export async function preview(
 	await populateCache(options, config, {
 		target: "local",
 		environment: getWranglerEnvironmentFlag(previewOptions.passthroughArgs),
+		config: getWranglerConfigFlag(previewOptions.passthroughArgs),
 		cacheChunkSize: previewOptions.cacheChunkSize,
 	});
 

packages/cloudflare/src/cli/commands/upload.ts

@@ -1,7 +1,7 @@
 import { BuildOptions } from "@opennextjs/aws/build/helper.js";
 
 import type { OpenNextConfig } from "../../api/config.js";
-import { getWranglerEnvironmentFlag, runWrangler } from "../utils/run-wrangler.js";
+import { getWranglerConfigFlag, getWranglerEnvironmentFlag, runWrangler } from "../utils/run-wrangler.js";
 import { populateCache } from "./populate-cache.js";
 
 export async function upload(
@@ -12,6 +12,7 @@ export async function upload(
 	await populateCache(options, config, {
 		target: "remote",
 		environment: getWranglerEnvironmentFlag(uploadOptions.passthroughArgs),
+		config: getWranglerConfigFlag(uploadOptions.passthroughArgs),
 		cacheChunkSize: uploadOptions.cacheChunkSize,
 	});
 

packages/cloudflare/src/cli/utils/run-wrangler.ts

@@ -110,3 +110,24 @@ export function getWranglerEnvironmentFlag(args: string[]) {
 		}
 	}
 }
+
+/**
+ * Find the value of the config flag (`--config` / `-c`) used by Wrangler.
+ *
+ * @param args - CLI arguments.
+ * @returns Value of the config flag.
+ */
+export function getWranglerConfigFlag(args: string[]) {
+	for (let i = 0; i <= args.length; i++) {
+		const arg = args[i];
+		if (!arg) continue;
+
+		if (arg === "--config" || arg === "-c") {
+			return args[i + 1];
+		}
+
+		if (arg.startsWith("--config=") || arg.startsWith("-c=")) {
+			return arg.split("=")[1];
+		}
+	}
+}