Remove configId (#10155)

Author: jamesopstad

packages/vite-plugin-cloudflare/src/cloudflare-environment.ts

@@ -1,5 +1,5 @@
 import assert from "node:assert";
-import util from "node:util";
+import * as util from "node:util";
 import * as vite from "vite";
 import { isNodeCompat } from "./node-js-compat";
 import { INIT_PATH, UNKNOWN_HOST, VITE_DEV_METADATA_HEADER } from "./shared";
@@ -90,9 +90,7 @@ export class CloudflareDevEnvironment extends vite.DevEnvironment {
 
 	async initRunner(
 		worker: ReplaceWorkersTypes<Fetcher>,
-		workerConfig: WorkerConfig,
-		/** A unique identifier used for debugging errors when config updates. */
-		configId: string
+		workerConfig: WorkerConfig
 	) {
 		this.#worker = worker;
 
@@ -102,7 +100,6 @@ export class CloudflareDevEnvironment extends vite.DevEnvironment {
 				headers: {
 					[VITE_DEV_METADATA_HEADER]: JSON.stringify({
 						entryPath: workerConfig.main,
-						configId,
 					}),
 					upgrade: "websocket",
 				},
@@ -201,21 +198,19 @@ export function createCloudflareEnvironmentOptions(
 export function initRunners(
 	resolvedPluginConfig: WorkersResolvedConfig,
 	viteDevServer: vite.ViteDevServer,
-	miniflare: Miniflare,
-	/** A unique identifier used for debugging errors when config updates. */
-	configId: string
+	miniflare: Miniflare
 ): Promise<void[]> | undefined {
 	return Promise.all(
 		Object.entries(resolvedPluginConfig.workers).map(
 			async ([environmentName, workerConfig]) => {
-				debuglog(configId, "Initializing worker:", workerConfig.name);
+				debuglog("Initializing worker:", workerConfig.name);
 				const worker = await miniflare.getWorker(workerConfig.name);
 
 				return (
 					viteDevServer.environments[
 						environmentName
 					] as CloudflareDevEnvironment
-				).initRunner(worker, workerConfig, configId);
+				).initRunner(worker, workerConfig);
 			}
 		)
 	);

packages/vite-plugin-cloudflare/src/index.ts

@@ -1,8 +1,7 @@
 import assert from "node:assert";
-import { randomUUID } from "node:crypto";
 import * as fsp from "node:fs/promises";
 import * as path from "node:path";
-import util from "node:util";
+import * as util from "node:util";
 import {
 	generateContainerBuildId,
 	getContainerIdsByImageTags,
@@ -349,22 +348,16 @@ if (import.meta.hot) {
 				viteDevServer.restart = async () => {
 					try {
 						restartingServer = true;
-						debuglog(configId, "From server.restart(): Restarting server...");
+						debuglog("From server.restart(): Restarting server...");
 						await restartServer();
-						debuglog(configId, "From server.restart(): Restarted server...");
+						debuglog("From server.restart(): Restarted server...");
 					} finally {
 						restartingServer = false;
 					}
 				};
 
 				assertIsNotPreview(resolvedPluginConfig);
 
-				// It is possible to get into a situation where the dev server is restarted by a config file change
-				// right in the middle of the Vite server and the supporting Workers being initialized.
-				// We use an abort controller to signal to the initialization code that it should stop if the config has changed.
-				// We use a `configId` to help debug how the config changes are triggering the restarts.
-				const configId = randomUUID();
-
 				const inputInspectorPort = await getInputInspectorPortOption(
 					resolvedPluginConfig,
 					viteDevServer,
@@ -383,12 +376,9 @@ if (import.meta.hot) {
 							changedFilePath
 						)
 					) {
-						debuglog(configId, "Config changed: " + changedFilePath);
+						debuglog("Config changed: " + changedFilePath);
 						viteDevServer.watcher.off("change", configChangedHandler);
-						debuglog(
-							configId,
-							"Restarting dev server and aborting previous setup"
-						);
+						debuglog("Restarting dev server and aborting previous setup");
 						await viteDevServer.restart();
 					}
 				};
@@ -415,26 +405,21 @@ if (import.meta.hot) {
 				});
 
 				if (!miniflare) {
-					debuglog(configId, "Creating new Miniflare instance");
+					debuglog("Creating new Miniflare instance");
 					miniflare = new Miniflare(miniflareDevOptions);
 				} else {
-					debuglog(configId, "Updating the Miniflare instance");
+					debuglog("Updating the existing Miniflare instance");
 					await miniflare.setOptions(miniflareDevOptions);
-					debuglog(configId, "Miniflare is ready");
+					debuglog("Miniflare is ready");
 				}
 
 				let preMiddleware: vite.Connect.NextHandleFunction | undefined;
 
 				if (resolvedPluginConfig.type === "workers") {
 					assert(entryWorkerConfig, `No entry Worker config`);
 
-					debuglog(configId, "Initializing the Vite module runners");
-					await initRunners(
-						resolvedPluginConfig,
-						viteDevServer,
-						miniflare,
-						configId
-					);
+					debuglog("Initializing the Vite module runners");
+					await initRunners(resolvedPluginConfig, viteDevServer, miniflare);
 
 					const entryWorkerName = entryWorkerConfig.name;
 

packages/vite-plugin-cloudflare/src/runner-worker/index.ts

@@ -132,8 +132,6 @@ export function createWorkerEntrypointWrapper(
 	entrypoint: string
 ): WorkerEntrypointConstructor<WrapperEnv> {
 	class Wrapper extends WorkerEntrypoint<WrapperEnv> {
-		/** A unique identifier used for debugging errors when config updates. */
-		configId?: string;
 		constructor(ctx: ExecutionContext, env: WrapperEnv) {
 			super(ctx, env);
 
@@ -178,11 +176,7 @@ export function createWorkerEntrypointWrapper(
 						entryPath = viteDevMetadata.entryPath;
 						const { 0: client, 1: server } = new WebSocketPair();
 						webSocket = client;
-						await createModuleRunner(
-							this.env,
-							server,
-							viteDevMetadata.configId
-						);
+						await createModuleRunner(this.env, server);
 					} catch (e) {
 						return new Response(
 							e instanceof Error ? e.message : JSON.stringify(e),
@@ -412,13 +406,13 @@ function getViteDevMetadata(request: Request) {
 		);
 	}
 
-	const { entryPath, configId } = parsedViteDevMetadataHeader;
+	const { entryPath } = parsedViteDevMetadataHeader;
 
 	if (entryPath === undefined) {
 		throw new Error(
 			"Unexpected internal error, vite dev metadata header doesn't contain an entryPath value"
 		);
 	}
 
-	return { entryPath, configId };
+	return { entryPath };
 }

packages/vite-plugin-cloudflare/src/runner-worker/module-runner.ts

@@ -7,21 +7,13 @@ import { stripInternalEnv } from "./env";
 import type { WrapperEnv } from "./env";
 
 let moduleRunner: ModuleRunner;
-let oldConfigId: string | undefined;
 
 export async function createModuleRunner(
 	env: WrapperEnv,
-	webSocket: WebSocket,
-	/** A unique identifier used for debugging errors when config updates. */
-	configId?: string
+	webSocket: WebSocket
 ) {
 	if (moduleRunner) {
-		throw new Error(
-			"Runner already initialized; old configId: " +
-				oldConfigId +
-				", new configId: " +
-				configId
-		);
+		throw new Error("Runner already initialized");
 	}
 
 	const transport = createWebSocketModuleRunnerTransport({
@@ -32,7 +24,6 @@ export async function createModuleRunner(
 		},
 	});
 
-	oldConfigId = configId;
 	moduleRunner = new ModuleRunner(
 		{
 			sourcemapInterceptor: "prepareStackTrace",