bring back dev specific options type

emily-shen · emily-shen · commit 75817eba7522 · 2025-07-22T23:04:40.000+01:00
diff --git a/packages/containers-shared/src/build.ts b/packages/containers-shared/src/build.ts
@@ -1,6 +1,11 @@
 import { spawn } from "child_process";
 import { readFileSync } from "fs";
-import type { BuildArgs, DockerfileConfig, Logger } from "./types";
+import type {
+	BuildArgs,
+	ContainerDevOptions,
+	ImageURIConfig,
+	Logger,
+} from "./types";
 
 export async function constructBuildCommand(
 	options: BuildArgs,
@@ -88,11 +93,10 @@ export function dockerBuild(
 
 export async function buildImage(
 	dockerPath: string,
-	options: DockerfileConfig,
-	imageTag: string
+	options: Exclude<ContainerDevOptions, ImageURIConfig>
 ) {
 	const { buildCmd, dockerfile } = await constructBuildCommand({
-		tag: imageTag,
+		tag: options.image_tag,
 		pathToDockerfile: options.dockerfile,
 		buildContext: options.image_build_context,
 		args: options.image_vars,
diff --git a/packages/containers-shared/src/images.ts b/packages/containers-shared/src/images.ts
@@ -1,7 +1,6 @@
 import { buildImage } from "./build";
 import {
 	getCloudflareContainerRegistry,
-	getDevContainerImageName,
 	isCloudflareRegistryLink,
 } from "./knobs";
 import { dockerLoginManagedRegistry } from "./login";
@@ -10,12 +9,11 @@ import {
 	runDockerCmd,
 	verifyDockerInstalled,
 } from "./utils";
-import type { ContainerNormalizedConfig, RegistryLinkConfig } from "./types";
+import type { ContainerDevOptions, DockerfileConfig } from "./types";
 
 export async function pullImage(
 	dockerPath: string,
-	options: RegistryLinkConfig,
-	tag: string
+	options: Exclude<ContainerDevOptions, DockerfileConfig>
 ): Promise<{ abort: () => void; ready: Promise<void> }> {
 	await dockerLoginManagedRegistry(dockerPath);
 	const pull = runDockerCmd(dockerPath, [
@@ -28,7 +26,11 @@ export async function pullImage(
 	const ready = pull.ready.then(async ({ aborted }: { aborted: boolean }) => {
 		if (!aborted) {
 			// re-tag image with the expected dev-formatted image tag for consistency
-			await runDockerCmd(dockerPath, ["tag", options.image_uri, tag]);
+			await runDockerCmd(dockerPath, [
+				"tag",
+				options.image_uri,
+				options.image_tag,
+			]);
 		}
 	});
 
@@ -50,23 +52,23 @@ export async function pullImage(
  * such as checking if the Docker CLI is installed, and if the container images
  * expose any ports.
  */
-export async function prepareContainerImagesForDev(options: {
+export async function prepareContainerImagesForDev(args: {
 	dockerPath: string;
-	containerOptions: ContainerNormalizedConfig[];
+	containerOptions: ContainerDevOptions[];
 	onContainerImagePreparationStart: (args: {
-		containerOptions: ContainerNormalizedConfig;
+		containerOptions: ContainerDevOptions;
 		abort: () => void;
 	}) => void;
 	onContainerImagePreparationEnd: (args: {
-		containerOptions: ContainerNormalizedConfig[];
+		containerOptions: ContainerDevOptions;
 	}) => void;
 }) {
 	const {
 		dockerPath,
 		containerOptions,
 		onContainerImagePreparationStart,
 		onContainerImagePreparationEnd,
-	} = options;
+	} = args;
 	let aborted = false;
 	if (process.platform === "win32") {
 		throw new Error(
@@ -75,9 +77,8 @@ export async function prepareContainerImagesForDev(options: {
 	}
 	await verifyDockerInstalled(dockerPath);
 	for (const options of containerOptions) {
-		const tag = getDevContainerImageName(options.class_name, containerBuildId);
 		if ("dockerfile" in options) {
-			const build = await buildImage(dockerPath, options, tag);
+			const build = await buildImage(dockerPath, options);
 			onContainerImagePreparationStart({
 				containerOptions: options,
 				abort: () => {
@@ -96,7 +97,7 @@ export async function prepareContainerImagesForDev(options: {
 						`To use an existing image from another repository, see https://developers.cloudflare.com/containers/image-management/#using-existing-images`
 				);
 			}
-			const pull = await pullImage(dockerPath, options, tag);
+			const pull = await pullImage(dockerPath, options);
 			onContainerImagePreparationStart({
 				containerOptions: options,
 				abort: () => {
@@ -110,7 +111,7 @@ export async function prepareContainerImagesForDev(options: {
 			});
 		}
 		if (!aborted) {
-			await checkExposedPorts(dockerPath, options, tag);
+			await checkExposedPorts(dockerPath, options);
 		}
 	}
 }
diff --git a/packages/containers-shared/src/types.ts b/packages/containers-shared/src/types.ts
@@ -22,15 +22,16 @@ export type BuildArgs = {
 	setNetworkToHost?: boolean;
 };
 
-export type ContainerNormalizedConfig = RegistryLinkConfig | DockerfileConfig;
-export type DockerfileConfig = SharedContainerConfig & {
+export type ContainerNormalizedConfig = SharedContainerConfig &
+	(ImageURIConfig | DockerfileConfig);
+export type DockerfileConfig = {
 	/** absolute path, resolved relative to the wrangler config file */
 	dockerfile: string;
 	/** absolute path, resolved relative to the wrangler config file. defaults to the directory of the dockerfile */
 	image_build_context: string;
 	image_vars?: Record<string, string>;
 };
-export type RegistryLinkConfig = SharedContainerConfig & {
+export type ImageURIConfig = {
 	image_uri: string;
 };
 
@@ -70,3 +71,11 @@ export type SharedContainerConfig = {
 	};
 	observability: { logsEnabled: boolean };
 } & InstanceTypeOrLimits;
+
+/** build/pull agnostic container options */
+export type ContainerDevOptions = {
+	/** formatted as cloudflare-dev/workername-DOclassname:build-id */
+	image_tag: string;
+	/** container's DO class name */
+	class_name: string;
+} & (DockerfileConfig | ImageURIConfig);
diff --git a/packages/containers-shared/src/utils.ts b/packages/containers-shared/src/utils.ts
@@ -1,8 +1,9 @@
 import { execFile, spawn } from "child_process";
+import { randomUUID } from "crypto";
 import { existsSync, statSync } from "fs";
 import path from "path";
 import { dockerImageInspect } from "./inspect";
-import type { ContainerNormalizedConfig } from "./types";
+import type { ContainerDevOptions } from "./types";
 import type { StdioOptions } from "child_process";
 
 /** helper for simple docker command call that don't require any io handling */
@@ -229,11 +230,10 @@ export const getContainerIdsFromImage = async (
  */
 export async function checkExposedPorts(
 	dockerPath: string,
-	options: ContainerNormalizedConfig,
-	imageTag: string
+	options: ContainerDevOptions
 ) {
 	const output = await dockerImageInspect(dockerPath, {
-		imageTag: imageTag,
+		imageTag: options.image_tag,
 		formatString: "{{ len .Config.ExposedPorts }}",
 	});
 	if (output === "0") {
diff --git a/packages/containers-shared/tests/utils.test.ts b/packages/containers-shared/tests/utils.test.ts
@@ -1,7 +1,7 @@
 import { mkdirSync, writeFileSync } from "fs";
 import { checkExposedPorts, isDockerfile } from "./../src/utils";
 import { runInTempDir } from "./helpers/run-in-tmp-dir";
-import type { ContainerNormalizedConfig } from "../src/types";
+import type { ContainerDevOptions } from "../src/types";
 
 describe("isDockerfile", () => {
 	const dockerfile =
@@ -75,7 +75,7 @@ vi.mock("../src/inspect", async (importOriginal) => {
 const containerConfig = {
 	dockerfile: "",
 	class_name: "MyContainer",
-} as ContainerNormalizedConfig;
+} as ContainerDevOptions;
 describe("checkExposedPorts", () => {
 	beforeEach(() => {
 		docketImageInspectResult = "1";
@@ -84,14 +84,14 @@ describe("checkExposedPorts", () => {
 	it("should not error when some ports are exported", async () => {
 		docketImageInspectResult = "1";
 		await expect(
-			checkExposedPorts("docker", containerConfig, "image:tag")
+			checkExposedPorts("docker", containerConfig)
 		).resolves.toBeUndefined();
 	});
 
 	it("should error, with an appropriate message when no ports are exported", async () => {
 		docketImageInspectResult = "0";
-		await expect(checkExposedPorts("docker", containerConfig, "image:tag"))
-			.rejects.toThrowErrorMatchingInlineSnapshot(`
+		await expect(checkExposedPorts("docker", containerConfig)).rejects
+			.toThrowErrorMatchingInlineSnapshot(`
 				[Error: The container "MyContainer" does not expose any ports. In your Dockerfile, please expose any ports you intend to connect to.
 				For additional information please see: https://developers.cloudflare.com/containers/local-dev/#exposing-ports.
 				]
diff --git a/packages/vite-plugin-cloudflare/src/index.ts b/packages/vite-plugin-cloudflare/src/index.ts
@@ -75,6 +75,7 @@ import type {
 	ResolvedPluginConfig,
 	WorkerConfig,
 } from "./plugin-config";
+import type { ContainerDevOptions } from "@cloudflare/containers-shared";
 import type { StaticRouting } from "@cloudflare/workers-shared/utils/types";
 import type { Unstable_RawConfig } from "wrangler";
 
@@ -488,7 +489,7 @@ if (import.meta.hot) {
 							"Build ID should be set if containers are enabled and defined"
 						);
 						// Assemble container options and build if necessary
-						const containerOptions = await getContainerOptions(
+						const containerOptions = getContainerOptions(
 							entryWorkerConfig,
 							containerBuildId
 						);
@@ -497,12 +498,11 @@ if (import.meta.hot) {
 						if (containerOptions) {
 							// keep track of them so we can clean up later
 							for (const container of containerOptions) {
-								containerImageTagsSeen.add(container.imageTag);
+								containerImageTagsSeen.add(container.image_tag);
 							}
 
 							await prepareContainerImagesForDev({
 								dockerPath,
-								configPath: entryWorkerConfig.configPath,
 								containerOptions,
 								onContainerImagePreparationStart: () => {},
 								onContainerImagePreparationEnd: () => {},
@@ -1082,25 +1082,41 @@ if (import.meta.hot) {
 	 * with image tag set to well-known dev format, or undefined if
 	 * containers are not enabled or not configured.
 	 */
-	async function getContainerOptions(
+	function getContainerOptions(
 		config: WorkerConfig,
 		containerBuildId: string
-	) {
+	): ContainerDevOptions[] | undefined {
 		if (!config.containers?.length || config.dev.enable_containers === false) {
 			return undefined;
 		}
-
+		const baseDir = config.configPath
+			? path.dirname(config.configPath)
+			: resolvedViteConfig.root;
 		return config.containers.map((container) => {
-			return {
-				image: container.image ?? container.configuration?.image,
-				imageTag: getDevContainerImageName(
-					container.class_name,
-					containerBuildId
-				),
-				args: container.image_vars,
-				imageBuildContext: container.image_build_context,
-				class_name: container.class_name,
-			};
+			if (isDockerfile(container.image, config.configPath)) {
+				const absoluteDockerfilePath = path.resolve(baseDir, container.image);
+				return {
+					dockerfile: absoluteDockerfilePath,
+					image_build_context: container.image_build_context
+						? path.resolve(baseDir, container.image_build_context)
+						: path.dirname(absoluteDockerfilePath),
+					image_vars: container.image_vars,
+					class_name: container.class_name,
+					image_tag: getDevContainerImageName(
+						container.class_name,
+						containerBuildId
+					),
+				};
+			} else {
+				return {
+					image_uri: container.image,
+					class_name: container.class_name,
+					image_tag: getDevContainerImageName(
+						container.class_name,
+						containerBuildId
+					),
+				};
+			}
 		});
 	}
 }
diff --git a/packages/wrangler/src/__tests__/cloudchamber/build.test.ts b/packages/wrangler/src/__tests__/cloudchamber/build.test.ts
@@ -1,5 +1,4 @@
 import { mkdirSync, writeFileSync } from "fs";
-import path from "path";
 import {
 	dockerBuild,
 	dockerImageInspect,
@@ -62,7 +61,7 @@ describe("buildAndMaybePush", () => {
 				"--provenance=false",
 				"-f",
 				"-",
-				path.resolve(process.cwd(), "./container-context"),
+				"./container-context",
 			],
 			dockerfile,
 		});
@@ -95,7 +94,7 @@ describe("buildAndMaybePush", () => {
 				"-f",
 				"-",
 				// turn this into a relative path so that this works across different OSes
-				path.resolve(process.cwd(), "./container-context"),
+				"./container-context",
 			],
 			dockerfile,
 		});
@@ -146,7 +145,7 @@ describe("buildAndMaybePush", () => {
 				"--provenance=false",
 				"-f",
 				"-",
-				path.resolve(process.cwd(), "./container-context"),
+				"./container-context",
 			],
 			dockerfile,
 		});
@@ -188,7 +187,7 @@ describe("buildAndMaybePush", () => {
 				"--provenance=false",
 				"-f",
 				"-",
-				path.resolve(process.cwd(), "./container-context"),
+				"./container-context",
 			],
 			dockerfile,
 		});
@@ -212,7 +211,7 @@ describe("buildAndMaybePush", () => {
 				"host",
 				"-f",
 				"-",
-				path.resolve(process.cwd(), "./container-context"),
+				"./container-context",
 			],
 			dockerfile,
 		});
@@ -232,7 +231,7 @@ describe("buildAndMaybePush", () => {
 				"--provenance=false",
 				"-f",
 				"-",
-				path.resolve(process.cwd(), "./container-context"),
+				"./container-context",
 			],
 			dockerfile,
 		});
diff --git a/packages/wrangler/src/api/integrations/platform/index.ts b/packages/wrangler/src/api/integrations/platform/index.ts
@@ -219,7 +219,9 @@ async function getMiniflareOptionsFromConfig(args: {
 			migrations: config.migrations,
 			imagesLocalMode: true,
 			tails: [],
-			containers: undefined,
+			containerDOClassNames: new Set(
+				config.containers?.map((c) => c.class_name)
+			),
 			containerBuildId: undefined,
 		},
 		remoteProxyConnectionString,
@@ -369,6 +371,9 @@ export function unstable_getMiniflareWorkerOptions(
 			fallthrough: rule.fallthrough,
 		}));
 
+	const containerDOClassNames = new Set(
+		config.containers?.map((c) => c.class_name)
+	);
 	const bindings = getBindings(config, env, true, {}, true);
 	const { bindingOptions, externalWorkers } = buildMiniflareBindingOptions(
 		{
@@ -382,7 +387,7 @@ export function unstable_getMiniflareWorkerOptions(
 			migrations: config.migrations,
 			imagesLocalMode: !!options?.imagesLocalMode,
 			tails: config.tail_consumers,
-			containers: config.containers,
+			containerDOClassNames,
 			containerBuildId: options?.containerBuildId,
 		},
 		options?.remoteProxyConnectionString,
@@ -435,7 +440,7 @@ export function unstable_getMiniflareWorkerOptions(
 						useSQLite,
 						container: getImageNameFromDOClassName({
 							doClassName: binding.class_name,
-							containers: config.containers,
+							containerDOClassNames,
 							containerBuildId: options?.containerBuildId,
 						}),
 					} satisfies DurableObjectDefinition,
diff --git a/packages/wrangler/src/api/startDevWorker/LocalRuntimeController.ts b/packages/wrangler/src/api/startDevWorker/LocalRuntimeController.ts
diff --git a/packages/wrangler/src/dev/miniflare.ts b/packages/wrangler/src/dev/miniflare.ts
