Update the migrate command to attempt to create an R2 bucket for caching as part of the migration process

.changeset/bright-colts-march.md

@@ -0,0 +1,5 @@
+---
+"@opennextjs/cloudflare": minor
+---
+
+Update the `migrate` command to attempt to create an R2 bucket for caching as part of the migration process, if that is not possible an application without caching enabled will be generated instead.

packages/cloudflare/src/cli/build/utils/create-config-files.ts

@@ -52,7 +52,7 @@ export async function createOpenNextConfigIfNotExistent(sourceDir: string): Prom
 			throw new Error("The `open-next.config.ts` file is required, aborting!");
 		}
 
-		return createOpenNextConfigFile(sourceDir);
+		return createOpenNextConfigFile(sourceDir, false);
 	}
 
 	return openNextConfigPath;

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

@@ -1,3 +1,4 @@
+import logger from "@opennextjs/aws/logger.js";
 import type yargs from "yargs";
 
 import { DEPLOYMENT_MAPPING_ENV_NAME } from "../templates/skew-protection.js";
@@ -45,7 +46,7 @@ export async function deployCommand(args: WithWranglerArgs<{ cacheChunkSize?: nu
 
 	const deploymentMapping = await getDeploymentMapping(buildOpts, config, envVars);
 
-	runWrangler(
+	const result = runWrangler(
 		buildOpts,
 		[
 			"deploy",
@@ -65,6 +66,11 @@ export async function deployCommand(args: WithWranglerArgs<{ cacheChunkSize?: nu
 			},
 		}
 	);
+
+	if (!result.success) {
+		logger.error("Wrangler command failed");
+		process.exit(1);
+	}
 }
 
 /**

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

@@ -78,10 +78,17 @@ async function migrateCommand(args: { forceInstall: boolean }): Promise<void> {
 	}
 
 	printStepTitle("Creating wrangler.jsonc");
-	await createWranglerConfigFile("./");
+	const { cachingEnabled } = await createWranglerConfigFile("./");
+
+	if (!cachingEnabled) {
+		logger.warn(
+			`Failed to set up a caching solution for your project.\n` +
+				`After the migration completes, please manually create add a caching solution to your wrangler.jsonc and open-next.config.ts files (for more details see: https://opennext.js.org/cloudflare/caching).\n`
+		);
+	}
 
 	printStepTitle("Creating open-next.config.ts");
-	await createOpenNextConfigFile("./");
+	await createOpenNextConfigFile("./", !cachingEnabled);
 
 	const devVarsExists = fs.existsSync(".dev.vars");
 	printStepTitle(`${devVarsExists ? "Updating" : "Creating"} .dev.vars file`);
@@ -197,7 +204,10 @@ async function migrateCommand(args: { forceInstall: boolean }): Promise<void> {
 		"🎉 OpenNext Cloudflare adapter complete!\n" +
 			"\nNext steps:\n" +
 			`- Run: "${packageManager.run} preview" to build and preview your Cloudflare application locally\n` +
-			`- Run: "${packageManager.run} deploy" to deploy your application to Cloudflare Workers\n`
+			`- Run: "${packageManager.run} deploy" to deploy your application to Cloudflare Workers\n` +
+			(cachingEnabled
+				? ""
+				: `- ⚠️  Add caching solution, see https://opennext.js.org/cloudflare/caching for more details\n`)
 	);
 }
 
@@ -209,7 +219,7 @@ interface PackageManager {
 }
 
 const packageManagers = {
-	pnpm: { name: "pnpm", install: "pnpm add", installDev: "pnpm add -D", run: "pnpm" },
+	pnpm: { name: "pnpm", install: "pnpm add", installDev: "pnpm add -D", run: "pnpm run" },
 	npm: { name: "npm", install: "npm install", installDev: "npm install --save-dev", run: "npm run" },
 	bun: { name: "bun", install: "bun add", installDev: "bun add -D", run: "bun" },
 	yarn: { name: "yarn", install: "yarn add", installDev: "yarn add -D", run: "yarn" },

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

@@ -70,7 +70,7 @@ describe("getCacheAssets", () => {
 });
 
 vi.mock("../utils/run-wrangler.js", () => ({
-	runWrangler: vi.fn(),
+	runWrangler: vi.fn(() => ({ success: true, stdout: "", stderr: "" })),
 }));
 
 vi.mock("./helpers.js", () => ({

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

@@ -247,7 +247,7 @@ async function populateR2IncrementalCache(
 	const concurrency = Math.max(1, populateCacheOptions.cacheChunkSize ?? 50);
 	const jurisdiction = binding.jurisdiction ? `--jurisdiction ${binding.jurisdiction}` : "";
 
-	runWrangler(
+	const result = runWrangler(
 		buildOpts,
 		[
 			"r2 bulk put",
@@ -268,6 +268,11 @@ async function populateR2IncrementalCache(
 
 	fs.rmSync(listFile, { force: true });
 
+	if (!result.success) {
+		logger.error("Wrangler command failed");
+		process.exit(1);
+	}
+
 	logger.info(`Successfully populated cache with ${assets.length} assets`);
 }
 
@@ -313,7 +318,7 @@ async function populateKVIncrementalCache(
 
 		fs.writeFileSync(chunkPath, JSON.stringify(kvMapping));
 
-		runWrangler(
+		const result = runWrangler(
 			buildOpts,
 			[
 				"kv bulk put",
@@ -330,6 +335,11 @@ async function populateKVIncrementalCache(
 		);
 
 		fs.rmSync(chunkPath, { force: true });
+
+		if (!result.success) {
+			logger.error("Wrangler command failed");
+			process.exit(1);
+		}
 	}
 
 	logger.info(`Successfully populated cache with ${assets.length} assets`);
@@ -349,7 +359,7 @@ function populateD1TagCache(
 		throw new Error(`No D1 binding ${JSON.stringify(D1_TAG_BINDING_NAME)} found!`);
 	}
 
-	runWrangler(
+	const result = runWrangler(
 		buildOpts,
 		[
 			"d1 execute",
@@ -365,6 +375,11 @@ function populateD1TagCache(
 		}
 	);
 
+	if (!result.success) {
+		logger.error("Wrangler command failed");
+		process.exit(1);
+	}
+
 	logger.info("\nSuccessfully created D1 table");
 }
 

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

@@ -1,3 +1,4 @@
+import logger from "@opennextjs/aws/logger.js";
 import type yargs from "yargs";
 
 import { runWrangler } from "../utils/run-wrangler.js";
@@ -42,7 +43,12 @@ export async function previewCommand(
 		envVars
 	);
 
-	runWrangler(buildOpts, ["dev", ...args.wranglerArgs], { logging: "all" });
+	const result = runWrangler(buildOpts, ["dev", ...args.wranglerArgs], { logging: "all" });
+
+	if (!result.success) {
+		logger.error("Wrangler command failed");
+		process.exit(1);
+	}
 }
 
 /**

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

@@ -1,3 +1,4 @@
+import logger from "@opennextjs/aws/logger.js";
 import type yargs from "yargs";
 
 import { DEPLOYMENT_MAPPING_ENV_NAME } from "../templates/skew-protection.js";
@@ -51,7 +52,7 @@ export async function uploadCommand(args: WithWranglerArgs<{ cacheChunkSize?: nu
 		envVars
 	);
 
-	runWrangler(
+	const result = runWrangler(
 		buildOpts,
 		[
 			"versions upload",
@@ -62,6 +63,11 @@ export async function uploadCommand(args: WithWranglerArgs<{ cacheChunkSize?: nu
 		],
 		{ logging: "all" }
 	);
+
+	if (!result.success) {
+		logger.error("Wrangler command failed");
+		process.exit(1);
+	}
 }
 
 /**

packages/cloudflare/src/cli/utils/open-next-config.ts

@@ -20,15 +20,19 @@ export function findOpenNextConfig(appDir: string): string | undefined {
 }
 
 /**
- * Creates a `open-next.config.ts` file in the target directory for the project.
+ * Creates an `open-next.config.ts` file in the target directory by copying
+ * the appropriate template file from the package templates.
  *
- * @param appDir The Next application root
- * @return The path to the created source file
+ * @param appDir The Next.js application root directory
+ * @param noCache Flag indicating whether to not to set up caching
+ * @returns The full path to the created configuration file
  */
-export async function createOpenNextConfigFile(appDir: string): Promise<string> {
+export async function createOpenNextConfigFile(appDir: string, noCache: boolean): Promise<string> {
 	const openNextConfigPath = join(appDir, "open-next.config.ts");
 
-	cpSync(join(getPackageTemplatesDirPath(), "open-next.config.ts"), openNextConfigPath);
+	const templateFileToUse = noCache ? "open-next.config.no-cache.ts" : "open-next.config.ts";
+
+	cpSync(join(getPackageTemplatesDirPath(), templateFileToUse), openNextConfigPath);
 
 	return openNextConfigPath;
 }

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

@@ -4,15 +4,20 @@ import path from "node:path";
 
 import type { BuildOptions } from "@opennextjs/aws/build/helper.js";
 import { compareSemver } from "@opennextjs/aws/build/helper.js";
-import logger from "@opennextjs/aws/logger.js";
 
 export type WranglerTarget = "local" | "remote";
 
+export type WranglerCommandResult = {
+	success: boolean;
+	stdout: string;
+	stderr: string;
+};
+
 type WranglerOptions = {
 	target?: WranglerTarget;
 	environment?: string;
 	configPath?: string;
-	logging?: "all" | "error";
+	logging?: "all" | "error" | "none";
 	env?: Record<string, string>;
 };
 
@@ -22,7 +27,7 @@ type WranglerOptions = {
  * @param options Build options.
  * @returns Whether yarn modern is used.
  */
-function isYarnModern(options: BuildOptions) {
+function isYarnModern(options: Pick<BuildOptions, "monorepoRoot">) {
 	const packageJson: { packageManager?: string } = JSON.parse(
 		readFileSync(path.join(options.monorepoRoot, "package.json"), "utf-8")
 	);
@@ -43,7 +48,10 @@ function isYarnModern(options: BuildOptions) {
  * @param args CLI args.
  * @returns Arguments with a passthrough flag injected when needed.
  */
-function injectPassthroughFlagForArgs(options: BuildOptions, args: string[]) {
+function injectPassthroughFlagForArgs(
+	options: Pick<BuildOptions, "packager" | "monorepoRoot">,
+	args: string[]
+) {
 	if (options.packager !== "npm" && (options.packager !== "yarn" || isYarnModern(options))) {
 		return args;
 	}
@@ -56,7 +64,12 @@ function injectPassthroughFlagForArgs(options: BuildOptions, args: string[]) {
 	return args;
 }
 
-export function runWrangler(options: BuildOptions, args: string[], wranglerOpts: WranglerOptions = {}) {
+export function runWrangler(
+	options: Pick<BuildOptions, "packager" | "monorepoRoot">,
+	args: string[],
+	wranglerOpts: WranglerOptions = {}
+): WranglerCommandResult {
+	const noLogs = wranglerOpts.logging === "none";
 	const shouldPipeLogs = wranglerOpts.logging === "error";
 
 	const result = spawnSync(
@@ -77,7 +90,10 @@ export function runWrangler(options: BuildOptions, args: string[], wranglerOpts:
 		],
 		{
 			shell: true,
-			stdio: shouldPipeLogs ? ["ignore", "pipe", "pipe"] : "inherit",
+			// Always pipe stderr so that we can capture it for inspection.
+			// Keep stdin and stdout as "inherit" when not piping logs to maintain TTY detection
+			// (wrangler checks `process.stdin.isTTY && process.stdout.isTTY` for interactive mode).
+			stdio: shouldPipeLogs || noLogs ? ["ignore", "pipe", "pipe"] : ["inherit", "inherit", "pipe"],
 			env: {
 				...process.env,
 				...wranglerOpts.env,
@@ -89,15 +105,27 @@ export function runWrangler(options: BuildOptions, args: string[], wranglerOpts:
 		}
 	);
 
-	if (result.status !== 0) {
-		if (shouldPipeLogs) {
-			process.stdout.write(result.stdout.toString());
-			process.stderr.write(result.stderr.toString());
+	const success = result.status === 0;
+	const stdout = result.stdout?.toString() ?? "";
+	const stderr = result.stderr?.toString() ?? "";
+
+	if (!noLogs) {
+		// When not piping logs, stderr is captured but should still be visible to the user
+		if (!shouldPipeLogs && stderr) {
+			process.stderr.write(stderr);
 		}
 
-		logger.error("Wrangler command failed");
-		process.exit(1);
+		if (!success && shouldPipeLogs) {
+			process.stdout.write(stdout);
+			process.stderr.write(stderr);
+		}
 	}
+
+	return {
+		success,
+		stdout,
+		stderr,
+	};
 }
 
 export function isWranglerTarget(v: string | undefined): v is WranglerTarget {