[vite-plugin] add validation for configPaths (#8572)

dario-piotrowicz · jamesopstad · web-flow · commit e6fea13186f2 · 2025-03-31T11:31:59.000+02:00
* [vite-plugin] add validation for `configPath`s

* Apply suggestions from code review

Co-authored-by: James Opstad &lt;13586373+jamesopstad@users.noreply.github.com&gt;

* remove extra describe block

* rename `configPath` to `entryWorkerConfigPath`

* add `allowedWranglerConfigExtensions` const

* add missing arguments

* update tests

---------

Co-authored-by: James Opstad &lt;13586373+jamesopstad@users.noreply.github.com&gt;
diff --git a/.changeset/sharp-dogs-love.md b/.changeset/sharp-dogs-love.md
@@ -0,0 +1,5 @@
+---
+"@cloudflare/vite-plugin": patch
+---
+
+Add validation for the `configPath` option in the plugin config that clearly indicates any issues.
diff --git a/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config-for-auxiliary-worker/index.ts b/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config-for-auxiliary-worker/index.ts
@@ -0,0 +1,5 @@
+export default {
+	fetch() {
+		return new Response("Hello world");
+	},
+};
diff --git a/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config-for-auxiliary-worker/package.json b/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config-for-auxiliary-worker/package.json
@@ -0,0 +1,13 @@
+{
+	"name": "@vite-plugin-cloudflare-e2e/no-wrangler-config-for-auxiliary-worker",
+	"version": "0.0.0",
+	"private": true,
+	"type": "module",
+	"scripts": {
+		"dev": "vite"
+	},
+	"devDependencies": {
+		"@cloudflare/vite-plugin": "*",
+		"vite": "^6.1.0"
+	}
+}
diff --git a/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config-for-auxiliary-worker/vite.config.ts b/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config-for-auxiliary-worker/vite.config.ts
@@ -0,0 +1,10 @@
+import { cloudflare } from "@cloudflare/vite-plugin";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+	plugins: [
+		cloudflare({
+			auxiliaryWorkers: [{ configPath: "./aux-worker/wrangler.toml" }],
+		}),
+	],
+});
diff --git a/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config-for-auxiliary-worker/wrangler.toml b/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config-for-auxiliary-worker/wrangler.toml
@@ -0,0 +1,3 @@
+name = "no-wrangler-config-for-auxiliary-worker"
+compatibility_date = "2024-12-30"
+main = "index.ts"
diff --git a/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config/package.json b/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config/package.json
@@ -0,0 +1,13 @@
+{
+	"name": "@vite-plugin-cloudflare-e2e/no-wrangler-config",
+	"version": "0.0.0",
+	"private": true,
+	"type": "module",
+	"scripts": {
+		"dev": "vite"
+	},
+	"devDependencies": {
+		"@cloudflare/vite-plugin": "*",
+		"vite": "^6.1.0"
+	}
+}
diff --git a/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config/vite.config.ts b/packages/vite-plugin-cloudflare/e2e/fixtures/no-wrangler-config/vite.config.ts
@@ -0,0 +1,6 @@
+import { cloudflare } from "@cloudflare/vite-plugin";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+	plugins: [cloudflare()],
+});
diff --git a/packages/vite-plugin-cloudflare/e2e/wrangler-configs-validation.test.ts b/packages/vite-plugin-cloudflare/e2e/wrangler-configs-validation.test.ts
@@ -0,0 +1,31 @@
+import { describe } from "vitest";
+import { runCommand, test } from "./helpers.js";
+
+// Note: the tests here just make sure that the validation does take place, for more fine grained
+//       testing regarding the validation there are unit tests in src/__tests__/get-validated-wrangler-config-path.spec.ts
+
+describe("during development wrangler config files are validated", () => {
+	test("for the entry worker", async ({ expect, seed, viteCommand }) => {
+		const projectPath = await seed("no-wrangler-config");
+		runCommand(`pnpm install`, projectPath);
+
+		const proc = await viteCommand("pnpm", "dev", projectPath);
+
+		expect(await proc.exitCode).not.toBe(0);
+		expect(proc.stderr).toMatch(
+			/Error: No config file found in the .*? directory/
+		);
+	});
+
+	test("for auxiliary workers", async ({ expect, seed, viteCommand }) => {
+		const projectPath = await seed("no-wrangler-config-for-auxiliary-worker");
+		runCommand(`pnpm install`, projectPath);
+
+		const proc = await viteCommand("pnpm", "dev", projectPath);
+
+		expect(await proc.exitCode).not.toBe(0);
+		expect(proc.stderr).toMatch(
+			/The provided configPath .*? requested for one of your auxiliary workers doesn't point to an existing file/
+		);
+	});
+});
diff --git a/packages/vite-plugin-cloudflare/src/__tests__/fixtures/empty-dir.toml/.gitkeep b/packages/vite-plugin-cloudflare/src/__tests__/fixtures/empty-dir.toml/.gitkeep
diff --git a/packages/vite-plugin-cloudflare/src/__tests__/fixtures/empty-dir/.gitkeep b/packages/vite-plugin-cloudflare/src/__tests__/fixtures/empty-dir/.gitkeep
diff --git a/packages/vite-plugin-cloudflare/src/__tests__/fixtures/wrangler.toml b/packages/vite-plugin-cloudflare/src/__tests__/fixtures/wrangler.toml
@@ -0,0 +1,3 @@
+name = "my-worker"
+main = "./index.ts"
+compatibility_date = "2024-12-30"
diff --git a/packages/vite-plugin-cloudflare/src/__tests__/get-validated-wrangler-config-path.spec.ts b/packages/vite-plugin-cloudflare/src/__tests__/get-validated-wrangler-config-path.spec.ts
@@ -0,0 +1,105 @@
+import { join, normalize } from "node:path";
+import { fileURLToPath } from "node:url";
+import { describe, expect, test } from "vitest";
+import { getValidatedWranglerConfigPath } from "../workers-configs";
+
+const fixturesPath = fileURLToPath(new URL("fixtures", import.meta.url));
+
+const isWindows = process.platform === "win32";
+
+describe("valid cases", () => {
+	test("should return the value of a found wrangler config", () => {
+		const path = getValidatedWranglerConfigPath(fixturesPath, undefined);
+		expect(normalize(path)).toMatch(
+			isWindows
+				? /\\__tests__\\fixtures\\wrangler\.toml/
+				: /\/__tests__\/fixtures\/wrangler\.toml/
+		);
+	});
+
+	test("should return the value of a requested wrangler config", () => {
+		const path = getValidatedWranglerConfigPath(
+			fixturesPath,
+			join(fixturesPath, "simple-wrangler.toml")
+		);
+		expect(normalize(path)).toMatch(
+			isWindows
+				? /\\__tests__\\fixtures\\simple-wrangler\.toml/
+				: /\/__tests__\/fixtures\/simple-wrangler\.toml/
+		);
+	});
+});
+
+describe("invalid cases", () => {
+	test("should error with an helpful message if a wrangler config could not be found", () => {
+		expect(() => {
+			getValidatedWranglerConfigPath(
+				join(fixturesPath, "empty-dir"),
+				undefined
+			);
+		}).toThrowError(
+			/No config file found in the .*?empty-dir directory\. Please add a wrangler.\(jsonc\|json\|toml\) file\./
+		);
+	});
+
+	[false, true].forEach((forAuxiliaryWorker) => {
+		const testPrefix = forAuxiliaryWorker
+			? "[auxiliary worker]"
+			: "[main worker]";
+		test(`${testPrefix} should error if a requested path points to a file without an extension`, () => {
+			expect(() => {
+				getValidatedWranglerConfigPath(
+					fixturesPath,
+					join(fixturesPath, "simple-wrangler"),
+					forAuxiliaryWorker
+				);
+			}).toThrowError(
+				forAuxiliaryWorker
+					? /The provided configPath \(.*?simple-wrangler\) requested for one of your auxiliary workers doesn't point to a file with the correct file extension. It should point to a jsonc, json or toml file \(no extension found instead\)/
+					: /The provided configPath \(.*?simple-wrangler\) doesn't point to a file with the correct file extension. It should point to a jsonc, json or toml file \(no extension found instead\)/
+			);
+		});
+
+		test(`${testPrefix} should error if a requested path points to a file with an incorrect extension`, () => {
+			expect(() => {
+				getValidatedWranglerConfigPath(
+					fixturesPath,
+					join(fixturesPath, "simple-wrangler.txt"),
+					forAuxiliaryWorker
+				);
+			}).toThrowError(
+				forAuxiliaryWorker
+					? /The provided configPath \(.*?simple-wrangler\.txt\) requested for one of your auxiliary workers doesn't point to a file with the correct file extension. It should point to a jsonc, json or toml file \(\"txt\" found instead\)/
+					: /The provided configPath \(.*?simple-wrangler\.txt\) doesn't point to a file with the correct file extension. It should point to a jsonc, json or toml file \(\"txt\" found instead\)/
+			);
+		});
+
+		test(`${testPrefix} should error if a requested path points to a directory`, () => {
+			expect(() => {
+				getValidatedWranglerConfigPath(
+					fixturesPath,
+					join(fixturesPath, "empty-dir.toml"),
+					forAuxiliaryWorker
+				);
+			}).toThrowError(
+				forAuxiliaryWorker
+					? /The provided configPath \(.*?empty-dir.toml\) requested for one of your auxiliary workers points to a directory\. It should point to a file\./
+					: /The provided configPath \(.*?empty-dir.toml\) points to a directory\. It should point to a file\./
+			);
+		});
+
+		test(`${testPrefix} should error if a requested path points to a non-existent file`, () => {
+			expect(() => {
+				getValidatedWranglerConfigPath(
+					fixturesPath,
+					join(fixturesPath, "empty-dir/wrangler.toml"),
+					forAuxiliaryWorker
+				);
+			}).toThrowError(
+				forAuxiliaryWorker
+					? /The provided configPath \(.*?wrangler.toml\) requested for one of your auxiliary workers doesn't point to an existing file/
+					: /The provided configPath \(.*?wrangler.toml\) doesn't point to an existing file/
+			);
+		});
+	});
+});
diff --git a/packages/vite-plugin-cloudflare/src/plugin-config.ts b/packages/vite-plugin-cloudflare/src/plugin-config.ts
@@ -2,7 +2,10 @@ import assert from "node:assert";
 import * as path from "node:path";
 import * as vite from "vite";
 import { DEFAULT_INSPECTOR_PORT } from "./constants";
-import { findWranglerConfig, getWorkerConfig } from "./workers-configs";
+import {
+	getValidatedWranglerConfigPath,
+	getWorkerConfig,
+} from "./workers-configs";
 import type {
 	AssetsOnlyWorkerResolvedConfig,
 	SanitizedWorkerConfig,
@@ -98,20 +101,19 @@ export function resolvePluginConfig(
 		/* prefixes */ ""
 	);
 
-	const configPath = pluginConfig.configPath
-		? path.resolve(root, pluginConfig.configPath)
-		: findWranglerConfig(root);
-
-	if (!configPath) {
-		throw new Error(
-			`Config not found. Have you created a wrangler.json(c) or wrangler.toml file?`
-		);
-	}
+	const entryWorkerConfigPath = getValidatedWranglerConfigPath(
+		root,
+		pluginConfig.configPath
+	);
 
-	const entryWorkerResolvedConfig = getWorkerConfig(configPath, cloudflareEnv, {
-		visitedConfigPaths: configPaths,
-		isEntryWorker: true,
-	});
+	const entryWorkerResolvedConfig = getWorkerConfig(
+		entryWorkerConfigPath,
+		cloudflareEnv,
+		{
+			visitedConfigPaths: configPaths,
+			isEntryWorker: true,
+		}
+	);
 
 	if (entryWorkerResolvedConfig.type === "assets-only") {
 		return {
@@ -141,8 +143,13 @@ export function resolvePluginConfig(
 	const auxiliaryWorkersResolvedConfigs: WorkerResolvedConfig[] = [];
 
 	for (const auxiliaryWorker of pluginConfig.auxiliaryWorkers ?? []) {
+		const workerConfigPath = getValidatedWranglerConfigPath(
+			root,
+			auxiliaryWorker.configPath,
+			true
+		);
 		const workerResolvedConfig = getWorkerConfig(
-			path.resolve(root, auxiliaryWorker.configPath),
+			workerConfigPath,
 			cloudflareEnv,
 			{
 				visitedConfigPaths: configPaths,
diff --git a/packages/vite-plugin-cloudflare/src/workers-configs.ts b/packages/vite-plugin-cloudflare/src/workers-configs.ts
@@ -1,3 +1,4 @@
+import assert from "node:assert";
 import * as fs from "node:fs";
 import * as path from "node:path";
 import { unstable_readConfig } from "wrangler";
@@ -351,13 +352,81 @@ export function getWorkerConfig(
 	};
 }
 
+/**
+ * Returns the path to a wrangler config for a worker after having it validated
+ * (throws appropriate errors in case the validation fails)
+ *
+ * @param root the root of the vite project
+ * @param requestedConfigPath the requested config path, if any
+ * @param isForAuxiliaryWorker whether the config path is being requested for an auxiliary worker
+ * @returns a valid path to a config file
+ */
+export function getValidatedWranglerConfigPath(
+	root: string,
+	requestedConfigPath: string | undefined,
+	isForAuxiliaryWorker = false
+) {
+	if (requestedConfigPath) {
+		const configPath = path.resolve(root, requestedConfigPath);
+
+		const forAuxiliaryWorkerErrorMessage = isForAuxiliaryWorker
+			? " requested for one of your auxiliary workers"
+			: "";
+
+		const errorMessagePrefix = `The provided configPath (${configPath})${forAuxiliaryWorkerErrorMessage}`;
+
+		const fileExtension = path.extname(configPath).slice(1);
+
+		if (!allowedWranglerConfigExtensions.includes(fileExtension)) {
+			const foundExtensionMessage = !fileExtension
+				? "no extension found"
+				: `"${fileExtension}" found`;
+			throw new Error(
+				`${errorMessagePrefix} doesn't point to a file with the correct file extension. It should point to a jsonc, json or toml file (${foundExtensionMessage} instead)`
+			);
+		}
+
+		const mainStat = fs.statSync(configPath, { throwIfNoEntry: false });
+		if (!mainStat) {
+			throw new Error(
+				`${errorMessagePrefix} doesn't point to an existing file`
+			);
+		}
+		if (mainStat.isDirectory()) {
+			throw new Error(
+				`${errorMessagePrefix} points to a directory. It should point to a file.`
+			);
+		}
+
+		return configPath;
+	}
+
+	// the plugin's API requires auxiliary workers to always specify their config paths
+	assert(
+		isForAuxiliaryWorker === false,
+		"Unexpected Error: trying to find the wrangler config for an auxiliary worker"
+	);
+
+	const configPath = findWranglerConfig(root);
+
+	if (!configPath) {
+		throw new Error(
+			`No config file found in the ${root} directory. Please add a wrangler.(jsonc|json|toml) file.`
+		);
+	}
+
+	return configPath;
+}
+
 // We can't rely on `readConfig` from Wrangler to find the config as it may be relative to a different root that's set by the user.
-export function findWranglerConfig(root: string): string | undefined {
-	for (const extension of ["json", "jsonc", "toml"]) {
+function findWranglerConfig(root: string): string | undefined {
+	for (const extension of allowedWranglerConfigExtensions) {
 		const configPath = path.join(root, `wrangler.${extension}`);
 
 		if (fs.existsSync(configPath)) {
 			return configPath;
 		}
 	}
 }
+
+const allowedWranglerConfigExtensions = ["jsonc", "json", "toml"];

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@cloudflare/vite-plugin": patch
 +---
++
 +Add validation for the `configPath` option in the plugin config that clearly indicates any issues.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+name = "no-wrangler-config-for-auxiliary-worker"`
	`2`	`+compatibility_date = "2024-12-30"`
	`3`	`+main = "index.ts"`