fix: improve the open-next detection that wrangler deploy performs to eliminate false positives for non open-next projects (#11694)

Author: dario-piotrowicz

.changeset/vast-regions-chew.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+fix: improve the open-next detection that `wrangler deploy` performs to eliminate false positives for non open-next projects

packages/wrangler/src/__tests__/deploy.test.ts

@@ -15953,6 +15953,14 @@ export default{
 				"./.open-next/worker.js",
 				"export default { fetch() { return new Response(''); } };"
 			);
+			fs.writeFileSync("./next.config.js", "export default {};");
+			fs.writeFileSync(
+				"./open-next.config.ts",
+				dedent`
+					import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+					export default defineCloudflareConfig();
+				`
+			);
 
 			await mockAUSRequest([]);
 
@@ -16059,6 +16067,70 @@ export default{
 			expect(std.err).toMatchInlineSnapshot(`""`);
 			expect(std.warn).toMatchInlineSnapshot(`""`);
 		});
+
+		it("should not delegate to open-next deploy when the Next.js config file is missing (to avoid false positives)", async () => {
+			const runCommandSpy = (await import("../autoconfig/c3-vendor/command"))
+				.runCommand;
+
+			await mockOpenNextLikeProject();
+
+			// Let's delete the next.config.js file
+			fs.rmSync("./next.config.js");
+
+			await runWrangler("deploy");
+
+			expect(runCommandSpy).not.toHaveBeenCalledOnce();
+
+			expect(std.out).toMatchInlineSnapshot(`
+				"
+				 ⛅️ wrangler x.x.x
+				──────────────────
+				Total Upload: xx KiB / gzip: xx KiB
+				Worker Startup Time: 100 ms
+				Your Worker has access to the following bindings:
+				Binding            Resource
+				env.ASSETS         Assets
+
+				Uploaded test-name (TIMINGS)
+				Deployed test-name triggers (TIMINGS)
+				  https://test-name.test-sub-domain.workers.dev
+				Current Version ID: Galaxy-Class"
+			`);
+			expect(std.err).toMatchInlineSnapshot(`""`);
+			expect(std.warn).toMatchInlineSnapshot(`""`);
+		});
+
+		it("should not delegate to open-next deploy when the open-next config file is missing (to avoid false positives)", async () => {
+			const runCommandSpy = (await import("../autoconfig/c3-vendor/command"))
+				.runCommand;
+
+			await mockOpenNextLikeProject();
+
+			// Let's delete the open-next.config.ts file
+			fs.rmSync("./open-next.config.ts");
+
+			await runWrangler("deploy");
+
+			expect(runCommandSpy).not.toHaveBeenCalledOnce();
+
+			expect(std.out).toMatchInlineSnapshot(`
+				"
+				 ⛅️ wrangler x.x.x
+				──────────────────
+				Total Upload: xx KiB / gzip: xx KiB
+				Worker Startup Time: 100 ms
+				Your Worker has access to the following bindings:
+				Binding            Resource
+				env.ASSETS         Assets
+
+				Uploaded test-name (TIMINGS)
+				Deployed test-name triggers (TIMINGS)
+				  https://test-name.test-sub-domain.workers.dev
+				Current Version ID: Galaxy-Class"
+			`);
+			expect(std.err).toMatchInlineSnapshot(`""`);
+			expect(std.warn).toMatchInlineSnapshot(`""`);
+		});
 	});
 });
 

packages/wrangler/src/autoconfig/frameworks/index.ts

@@ -41,13 +41,19 @@ export abstract class Framework {
 // Make a best-effort attempt to find the exact version of the installed package
 export function getInstalledPackageVersion(
 	packageName: string,
-	projectPath: string
+	projectPath: string,
+	opts: {
+		stopAtProjectPath?: boolean;
+	} = {}
 ): string | undefined {
 	try {
 		const packagePath = require.resolve(packageName, {
 			paths: [projectPath],
 		});
-		const packageJsonPath = findUpSync("package.json", { cwd: packagePath });
+		const packageJsonPath = findUpSync("package.json", {
+			cwd: packagePath,
+			stopAt: opts.stopAtProjectPath === true ? projectPath : undefined,
+		});
 		if (packageJsonPath) {
 			const packageJson = parsePackageJSON(
 				readFileSync(packageJsonPath),

packages/wrangler/src/deploy/open-next.ts

@@ -1,3 +1,4 @@
+import { readdir } from "node:fs/promises";
 import { getOpenNextDeployFromEnv } from "@cloudflare/workers-utils";
 import { runCommand } from "../autoconfig/c3-vendor/command";
 import { getInstalledPackageVersion } from "../autoconfig/frameworks";
@@ -12,15 +13,9 @@ import { getPackageManager } from "../package-manager";
  * @returns true is the deployment has been delegated to open-next, false otherwise
  */
 export async function maybeDelegateToOpenNextDeployCommand(
-	projectRoot: string | undefined
+	projectRoot: string
 ): Promise<boolean> {
-	const openNextVersion =
-		projectRoot &&
-		getInstalledPackageVersion("@opennextjs/cloudflare", projectRoot);
-
-	const isOpenNextProject = openNextVersion !== undefined;
-
-	if (isOpenNextProject) {
+	if (await isOpenNextProject(projectRoot)) {
 		const openNextDeploy = getOpenNextDeployFromEnv();
 		if (!openNextDeploy) {
 			logger.log(
@@ -41,3 +36,48 @@ export async function maybeDelegateToOpenNextDeployCommand(
 	}
 	return false;
 }
+
+/**
+ * Discerns if the project is an open-next one. This check is performed in an assertive way to ensure that
+ * no false positives happen.
+ *
+ * @param projectRoot The path to the project's root
+ * @returns true if the project is an open-next one, false otherwise
+ */
+async function isOpenNextProject(projectRoot: string) {
+	try {
+		const dirFiles = await readdir(projectRoot);
+
+		const nextConfigFile = dirFiles.find((file) =>
+			/^next\.config\.(m|c)?(ts|js)$/.test(file)
+		);
+
+		if (!nextConfigFile) {
+			// If there is no next config file then the project is not a Next.js one
+			return false;
+		}
+
+		const opeNextConfigFile = dirFiles.find((file) =>
+			/^open-next\.config\.(ts|js)$/.test(file)
+		);
+
+		if (!opeNextConfigFile) {
+			// If there is no open-next config file then the project is not an OpenNext one
+			return false;
+		}
+
+		const openNextVersion = getInstalledPackageVersion(
+			"@opennextjs/cloudflare",
+			projectRoot,
+			{
+				// We stop at the projectPath/root just to make extra sure we don't hit false positives
+				stopAtProjectPath: true,
+			}
+		);
+
+		return openNextVersion !== undefined;
+	} catch {
+		// If any error is thrown then we simply assume that we're not running in an OpenNext project
+		return false;
+	}
+}