Always emit a .assetsignore file in the client output directory (#12358)

Author: jamesopstad

.changeset/grumpy-nails-care.md

@@ -0,0 +1,8 @@
+---
+"@cloudflare/vite-plugin": patch
+---
+
+Always emit a `.assetsignore` file in the client output directory.
+
+Previously, we would emit a `.assetsignore` file in the client output directory only if the client output included a `wrangler.json` file.
+We now always emit it, which prevents a `wrangler.json` file being deployed as an asset if it is copied into this directory by mistake.

packages/vite-plugin-cloudflare/playground/spa-with-api/__tests__/custom-output-directories/spa-with-api.spec.ts

@@ -5,20 +5,16 @@ import { isBuild, rootDir, WAIT_FOR_OPTIONS } from "../../../__test-utils__";
 import "../base-tests";
 
 describe.runIf(isBuild)("output directories", () => {
-	test(
-		"creates the correct output directories",
-		async () => {
-			await vi.waitFor(() => {
-				expect(
-					fs.existsSync(
-						path.join(rootDir, "custom-root-output-directory", "worker")
-					)
-				).toBe(true);
-				expect(
-					fs.existsSync(path.join(rootDir, "custom-client-output-directory"))
-				).toBe(true);
-			});
-		},
-		WAIT_FOR_OPTIONS
-	);
+	test("creates the correct output directories", async () => {
+		await vi.waitFor(() => {
+			expect(
+				fs.existsSync(
+					path.join(rootDir, "custom-root-output-directory", "worker")
+				)
+			).toBe(true);
+			expect(
+				fs.existsSync(path.join(rootDir, "custom-client-output-directory"))
+			).toBe(true);
+		}, WAIT_FOR_OPTIONS);
+	});
 });

packages/vite-plugin-cloudflare/playground/spa-with-api/__tests__/spa-with-api.spec.ts

@@ -1,9 +1,12 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
 import { expect, test } from "vitest";
 import {
 	getResponse,
 	getTextResponse,
 	isBuild,
 	page,
+	rootDir,
 	viteTestUrl,
 } from "../../__test-utils__";
 import "./base-tests";
@@ -41,3 +44,15 @@ test.runIf(!isBuild)(
 		expect(text).toBe(`Some file content.\n`);
 	}
 );
+
+test.runIf(isBuild)(
+	"emits .assetsignore file in client output directory",
+	() => {
+		expect(
+			fs.readFileSync(
+				path.join(rootDir, "dist", "client", ".assetsignore"),
+				"utf-8"
+			)
+		).toBe(`wrangler.json\n.dev.vars\n`);
+	}
+);

packages/vite-plugin-cloudflare/playground/static-mpa/__tests__/static-mpa.spec.ts

@@ -1,8 +1,11 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
 import { describe, expect, test } from "vitest";
 import {
 	getResponse,
 	isBuild,
 	page,
+	rootDir,
 	serverLogs,
 	viteTestUrl,
 } from "../../__test-utils__";
@@ -93,3 +96,12 @@ describe.runIf(isBuild)("_redirects", () => {
 		expect(content).toBe("Home");
 	});
 });
+
+test.runIf(isBuild)(
+	"emits .assetsignore file in client output directory",
+	() => {
+		expect(
+			fs.readFileSync(path.join(rootDir, "dist", ".assetsignore"), "utf-8")
+		).toBe(`wrangler.json\n.dev.vars\n`);
+	}
+);

packages/vite-plugin-cloudflare/src/plugins/output-config.ts

@@ -77,27 +77,27 @@ export const outputConfigPlugin = createPlugin("output-config", (ctx) => {
 						});
 					}
 				}
-			} else if (
-				ctx.resolvedPluginConfig.type === "assets-only" &&
-				this.environment.name === "client"
-			) {
-				const inputAssetsOnlyConfig = ctx.resolvedPluginConfig.config;
-
-				outputConfig = {
-					...inputAssetsOnlyConfig,
-					assets: {
-						...inputAssetsOnlyConfig.assets,
-						directory: ".",
-					},
-				};
-
+			} else if (this.environment.name === "client") {
 				const filesToAssetsIgnore = ["wrangler.json", ".dev.vars"];
 
 				this.emitFile({
 					type: "asset",
 					fileName: ".assetsignore",
 					source: `${filesToAssetsIgnore.join("\n")}\n`,
 				});
+
+				// For assets only projects the `wrangler.json` file is emitted in the client output directory
+				if (ctx.resolvedPluginConfig.type === "assets-only") {
+					const inputAssetsOnlyConfig = ctx.resolvedPluginConfig.config;
+
+					outputConfig = {
+						...inputAssetsOnlyConfig,
+						assets: {
+							...inputAssetsOnlyConfig.assets,
+							directory: ".",
+						},
+					};
+				}
 			}
 
 			if (!outputConfig) {