allow cloudflare-specific js module (#2905)

Mark cloudflare-specific js module as external so that scripts can be published that reference it.
cloudflare · Mar 16, 2023 · 6fd0624 · 6fd0624
1 parent 9996ac4
commit 6fd0624
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/.changeset/afraid-readers-warn.md b/.changeset/afraid-readers-warn.md
@@ -0,0 +1,7 @@
+---
+"wrangler": minor
+---
+
+feat: support external imports from `cloudflare:...` prefixed modules
+
+Going forward Workers will be providing built-in modules (similar to `node:...`) that can be imported using the `cloudflare:...` prefix. This change adds support to the Wrangler bundler to mark these imports as external.
diff --git a/packages/wrangler/src/__tests__/publish.test.ts b/packages/wrangler/src/__tests__/publish.test.ts
@@ -1341,6 +1341,32 @@ export default{
 			expect(std.err).toMatchInlineSnapshot(`""`);
 		});
 
+		it("should allow cloudflare module import", async () => {
+			writeWranglerToml();
+			fs.writeFileSync(
+				"./index.js",
+				`
+import { EmailMessage } from "cloudflare:email";
+export default{
+  fetch(){
+    return new Response("all done");
+  }
+}
+`
+			);
+			mockUploadWorkerRequest();
+			mockSubDomainRequest();
+			await runWrangler("publish index.js");
+			expect(std.out).toMatchInlineSnapshot(`
+			"Total Upload: xx KiB / gzip: xx KiB
+			Uploaded test-name (TIMINGS)
+			Published test-name (TIMINGS)
+			  https://test-name.test-sub-domain.workers.dev
+			Current Deployment ID: Galaxy-Class"
+		`);
+			expect(std.err).toMatchInlineSnapshot(`""`);
+		});
+
 		it("should be able to transpile entry-points in sub-directories (esm)", async () => {
 			writeWranglerToml();
 			writeWorkerSource({ basePath: "./src" });

diff --git a/packages/wrangler/src/bundle.ts b/packages/wrangler/src/bundle.ts
@@ -94,6 +94,15 @@ const nodejsCompatPlugin: esbuild.Plugin = {
 	},
 };
 
+const cloudflareJsPlugin: esbuild.Plugin = {
+	name: "cloudflare javascript Plugin",
+	setup(pluginBuild) {
+		pluginBuild.onResolve({ filter: /^cloudflare:.*/ }, () => {
+			return { external: true };
+		});
+	},
+};
+
 /**
  * Generate a bundle for the worker identified by the arguments passed in.
  */
@@ -379,6 +388,7 @@ export async function bundleWorker(
 				? [NodeGlobalsPolyfills({ buffer: true }), NodeModulesPolyfills()]
 				: []),
 			...(nodejsCompat ? [nodejsCompatPlugin] : []),
+			...[cloudflareJsPlugin],
 			...(plugins || []),
 		],
 		...(jsxFactory && { jsxFactory }),