stop gpp crashing with internal DOs

Author: emily-shen

fixtures/get-platform-proxy/tests/get-platform-proxy.env.test.ts

@@ -1,6 +1,14 @@
 import path from "path";
 import { D1Database, R2Bucket } from "@cloudflare/workers-types";
-import { beforeEach, describe, expect, it, vi } from "vitest";
+import {
+	afterEach,
+	beforeEach,
+	describe,
+	expect,
+	it,
+	MockInstance,
+	vi,
+} from "vitest";
 import { getPlatformProxy } from "./shared";
 import type { Hyperdrive, KVNamespace } from "@cloudflare/workers-types";
 import type { Unstable_DevWorker } from "wrangler";
@@ -197,6 +205,55 @@ describe("getPlatformProxy - env", () => {
 		}
 	});
 
+	describe("DO warnings", () => {
+		let warn = {} as MockInstance<typeof console.warn>;
+		beforeEach(() => {
+			warn = vi.spyOn(console, "warn").mockImplementation(() => {});
+		});
+		afterEach(() => {
+			warn.mockRestore();
+		});
+
+		it("warns about internal DOs and doesn't crash", async () => {
+			await getPlatformProxy<Env>({
+				configPath: path.join(__dirname, "..", "wrangler_internal_do.jsonc"),
+			});
+			expect(warn).toMatchInlineSnapshot(`
+				[MockFunction warn] {
+				  "calls": [
+				    [
+				      "▲ [WARNING] 				You have defined bindings to the following internal Durable Objects:
+
+				  				- {"class_name":"MyDurableObject","name":"MY_DURABLE_OBJECT"}
+				  				These will not work in local development, but they should work in production.
+				  
+				  				If you want to develop these locally, you can define your DO "externally" in another worker.
+				  				To do this, create another Worker and Wrangler config file. Export your DO from there.
+				  				Then, set the \`script_name\` field in your original DO binding to equal the \`name\` field from your new external DO config.
+				  
+				  				You will be able to develop this locally by running:
+				  				npx wrangler dev -c path/to/original/wrangler.json -c path/to/external-do/wrangler.json
+
+				",
+				    ],
+				  ],
+				  "results": [
+				    {
+				      "type": "return",
+				      "value": undefined,
+				    },
+				  ],
+				}
+			`);
+		});
+		it("doesn't warn about external DOs and doesn't crash", async () => {
+			await getPlatformProxy<Env>({
+				configPath: path.join(__dirname, "..", "wrangler_external_do.jsonc"),
+			});
+			expect(warn).not.toHaveBeenCalled();
+		});
+	});
+
 	describe("with a target environment", () => {
 		it("should provide bindings targeting a specified environment and also inherit top-level ones", async () => {
 			const { env, dispose } = await getPlatformProxy<Env>({

fixtures/get-platform-proxy/wrangler_external_do.jsonc

@@ -0,0 +1,20 @@
+{
+	"name": "external_do",
+	"main": "src/index.ts",
+	// external durable object - has script name
+	"durable_objects": {
+		"bindings": [
+			{
+				"class_name": "MyDurableObject",
+				"name": "MY_DURABLE_OBJECT",
+				"script_name": "internal-do",
+			},
+		],
+	},
+	"migrations": [
+		{
+			"new_sqlite_classes": ["MyDurableObject"],
+			"tag": "v1",
+		},
+	],
+}

fixtures/get-platform-proxy/wrangler_internal_do.jsonc

@@ -0,0 +1,19 @@
+{
+	"name": "internal_do",
+	"main": "src/index.ts",
+	// internal durable object
+	"durable_objects": {
+		"bindings": [
+			{
+				"class_name": "MyDurableObject",
+				"name": "MY_DURABLE_OBJECT",
+			},
+		],
+	},
+	"migrations": [
+		{
+			"new_sqlite_classes": ["MyDurableObject"],
+			"tag": "v1",
+		},
+	],
+}

packages/wrangler/src/api/integrations/platform/index.ts

@@ -1,6 +1,7 @@
 import { kCurrentWorker, Miniflare } from "miniflare";
 import { getAssetsOptions } from "../../../assets";
-import { formatConfigSnippet, readConfig } from "../../../config";
+import { readConfig } from "../../../config";
+import { partitionDurableObjectBindings } from "../../../deployment-bundle/entry";
 import { DEFAULT_MODULE_RULES } from "../../../deployment-bundle/rules";
 import { getBindings } from "../../../dev";
 import { getBoundRegisteredWorkers } from "../../../dev-registry";
@@ -131,24 +132,30 @@ export async function getPlatformProxy<
 	};
 }
 
+// this is only used by getPlatformProxy
 async function getMiniflareOptionsFromConfig(
 	rawConfig: Config,
 	env: string | undefined,
 	options: GetPlatformProxyOptions
 ): Promise<Partial<MiniflareOptions>> {
 	const bindings = getBindings(rawConfig, env, true, {});
 
-	if (bindings.durable_objects) {
-		logger.warn(dedent`
-			You have defined an internal Durable Object (ie the binding does not have a script_name field).
-			You will not be able to develop it locally, but it should work in production.
-
-			Alternatively, you can define your DO "externally" in another worker.
-			To do this, create another Worker + Wrangler config file. Export your DO from there.
-			Then, set the script_name field in your original DO binding to equal the name field from your new external DO config.
-			You will be able to develop this locally by running:
-			npx wrangler dev -c path/to/original/wrangler.toml -c path/to/external-do/wrangler.toml
-			`);
+	if (rawConfig["durable_objects"]) {
+		const { localBindings } = partitionDurableObjectBindings(rawConfig);
+		if (localBindings.length > 0) {
+			logger.warn(dedent`
+				You have defined bindings to the following internal Durable Objects:
+				${localBindings.map((b) => `- ${JSON.stringify(b)}`).join("\n")}
+				These will not work in local development, but they should work in production.
+
+				If you want to develop these locally, you can define your DO "externally" in another worker.
+				To do this, create another Worker and Wrangler config file. Export your DO from there.
+				Then, set the \`script_name\` field in your original DO binding to equal the \`name\` field from your new external DO config.
+
+				You will be able to develop this locally by running:
+				npx wrangler dev -c path/to/original/wrangler.json -c path/to/external-do/wrangler.json
+				`);
+		}
 	}
 	const workerDefinitions = await getBoundRegisteredWorkers({
 		name: rawConfig.name,

packages/wrangler/src/deployment-bundle/entry.ts

@@ -2,7 +2,6 @@ import path from "node:path";
 import dedent from "ts-dedent";
 import { configFileName, formatConfigSnippet } from "../config";
 import { UserError } from "../errors";
-import { logger } from "../logger";
 import { sniffUserAgent } from "../package-manager";
 import guessWorkerFormat from "./guess-worker-format";
 import {
@@ -161,7 +160,7 @@ export async function getEntry(
  * Groups the durable object bindings into two lists:
  * those that are defined locally and those that refer to a durable object defined in another script.
  */
-function partitionDurableObjectBindings(config: Config): {
+export function partitionDurableObjectBindings(config: Config): {
 	localBindings: DurableObjectBindings;
 	remoteBindings: DurableObjectBindings;
 } {