enable images local mode by default

Author: edmundhung

.changeset/wild-paws-occur.md

@@ -2,6 +2,6 @@
 "@cloudflare/vite-plugin": patch
 ---
 
-fix: add experimental local mode support for image bindings
+fix: enable image local mode by default with the images binding
 
-You can now enable experimental local image binding support in the Vite plugin by setting the `experimental.imagesLocalMode` option to `true`. This provides the same functionality as running `wrangler dev --experimental-images-local-mode`.
+Previously, image local mode was not enabled by default when using the images binding and would use a remote setup even when the remote option was not enabled. This enables local mode by default for image bindings.

packages/vite-plugin-cloudflare/playground/bindings/__tests__/worker.spec.ts

@@ -6,9 +6,9 @@ test("kv_namspaces support", async () => {
 	expect(response).toBe("KV binding works");
 });
 
-test("experimental images local mode support", async () => {
-	const response = await getTextResponse("/images-local-mode");
-	expect(response).toBe("Local images binding works");
+test("images support", async () => {
+	const response = await getTextResponse("/images");
+	expect(response).toBe("Images binding works");
 });
 
 test("unsafe_hello_world support", async () => {

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

@@ -20,28 +20,23 @@ export default {
 					status: 200,
 				});
 			}
-			case "/images-local-mode": {
+			case "/images": {
 				const request = await fetch(image);
 
 				if (!request.body) {
 					return new Response("Failed to fetch image", { status: 500 });
 				}
 
-				try {
-					await env.IMAGES.input(request.body).output({ format: "image/gif" });
-				} catch (e) {
-					if (
-						e instanceof Error &&
-						e.message.includes("GIF output is not supported in local mode")
-					) {
-						return new Response("Local images binding works", {
-							status: 200,
-						});
-					}
+				const info = await env.IMAGES.info(request.body);
+
+				if (info.format !== "image/png") {
+					return new Response("Images binding returns an incorrect format", {
+						status: 500,
+					});
 				}
 
-				return new Response("Local images binding is not configured properly", {
-					status: 500,
+				return new Response("Images binding works", {
+					status: 200,
 				});
 			}
 			case "/ae": {

packages/vite-plugin-cloudflare/playground/bindings/vite.config.ts

@@ -6,7 +6,6 @@ export default defineConfig({
 		cloudflare({
 			inspectorPort: false,
 			persistState: false,
-			experimental: { imagesLocalMode: true },
 		}),
 	],
 });

packages/vite-plugin-cloudflare/src/miniflare-options.ts

@@ -421,8 +421,7 @@ export async function getDevMiniflareOptions(config: {
 								},
 								resolvedPluginConfig.cloudflareEnv,
 								{
-									imagesLocalMode:
-										resolvedPluginConfig.experimental.imagesLocalMode,
+									imagesLocalMode: true,
 									remoteProxyConnectionString:
 										remoteProxySessionData?.session
 											?.remoteProxyConnectionString,

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

@@ -37,8 +37,6 @@ interface Experimental {
 	headersAndRedirectsDevModeSupport?: boolean;
 	/** Experimental support for remote bindings (where bindings configured with `remote: true` access remote resources). */
 	remoteBindings?: boolean;
-	/** Experimental support for local images bindings */
-	imagesLocalMode?: boolean;
 }
 
 export interface PluginConfig extends EntryWorkerConfig {