Mark node: as external for Node.js compatibility (#10544)

* make `cloudflare:email` as external * make cloudflare:email as external * add changeset * format * fix changeset * add for adapter-cloudflare-worker, too * add changeset for adapter-cloudflare-worker * Update .changeset/eighty-fans-rescue.md Co-authored-by: Willow (GHOST) <ghostdevbusiness@gmail.com> * Update .changeset/friendly-dragons-hide.md Co-authored-by: Willow (GHOST) <ghostdevbusiness@gmail.com> * Update .changeset/eighty-fans-rescue.md * Update .changeset/friendly-dragons-hide.md * Update packages/adapter-cloudflare/index.js Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> * Update index.js * Update .changeset/friendly-dragons-hide.md * Update .changeset/eighty-fans-rescue.md * mark `node:` as external * remove old changesets * options.nodeCompat * add docs * Update documentation/docs/25-build-and-deploy/70-adapter-cloudflare-workers.md * switch it to just the list of APIs that Cloudflare supports with their node compatibility * read `nodejs_compat` flag from the wrangler.toml to avoid making the user specify it twice * changeset * remove `nodeCompat` option, always assume compatibility * Apply suggestions from code review * Update .changeset/pretty-geese-drum.md --------- Co-authored-by: Willow (GHOST) <ghostdevbusiness@gmail.com> Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> Co-authored-by: Rich Harris <hello@rich-harris.dev>
sveltejs · Jan 18, 2024 · 040f826 · 040f826
1 parent da1f2d1
commit 040f826
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 4 deletions.
diff --git a/.changeset/pretty-geese-drum.md b/.changeset/pretty-geese-drum.md
@@ -0,0 +1,6 @@
+---
+'@sveltejs/adapter-cloudflare-workers': minor
+'@sveltejs/adapter-cloudflare': minor
+---
+
+feat: Add Node.js compatibility
diff --git a/documentation/docs/25-build-and-deploy/70-adapter-cloudflare-workers.md b/documentation/docs/25-build-and-deploy/70-adapter-cloudflare-workers.md
@@ -77,6 +77,13 @@ export default {
 };
 ```
 
+If you would like to enable [Node.js compatibility](https://developers.cloudflare.com/workers/runtime-apis/nodejs/#enable-nodejs-from-the-cloudflare-dashboard), you can add "nodejs_compat" flag to `wrangler.toml`:
+
+```toml
+/// file: wrangler.toml
+compatibility_flags = [ "nodejs_compat" ]
+```
+
 ## Bindings
 
 The [`env`](https://developers.cloudflare.com/workers/runtime-apis/fetch-event#parameters) object contains your project's [bindings](https://developers.cloudflare.com/workers/platform/environment-variables/), which consist of KV/DO namespaces, etc. It is passed to SvelteKit via the `platform` property, along with `context` and `caches`, meaning that you can access it in hooks and endpoints:

diff --git a/packages/adapter-cloudflare-workers/index.d.ts b/packages/adapter-cloudflare-workers/index.d.ts
@@ -1,4 +1,8 @@
 import { Adapter } from '@sveltejs/kit';
 import './ambient.js';
 
-export default function plugin(options?: { config?: string }): Adapter;
+export default function plugin(options?: AdapterOptions): Adapter;
+
+export interface AdapterOptions {
+	config?: string;
+}
diff --git a/packages/adapter-cloudflare-workers/index.js b/packages/adapter-cloudflare-workers/index.js
@@ -11,6 +11,7 @@ import { fileURLToPath } from 'node:url';
  *   site: {
  *     bucket: string;
  *   }
+ *   compatibility_flags?: string[];
  * }} WranglerConfig
  */
 
@@ -20,7 +21,7 @@ export default function ({ config = 'wrangler.toml' } = {}) {
 		name: '@sveltejs/adapter-cloudflare-workers',
 
 		async adapt(builder) {
-			const { main, site } = validate_config(builder, config);
+			const { main, site, compatibility_flags } = validate_config(builder, config);
 
 			const files = fileURLToPath(new URL('./files', import.meta.url).href);
 			const tmp = builder.getBuildDirectory('cloudflare-workers-tmp');
@@ -61,6 +62,23 @@ export default function ({ config = 'wrangler.toml' } = {}) {
 				})};\n\nexport const prerendered = new Map(${JSON.stringify(prerendered_entries)});\n`
 			);
 
+			const external = ['__STATIC_CONTENT_MANIFEST', 'cloudflare:*'];
+			if (compatibility_flags && compatibility_flags.includes('nodejs_compat')) {
+				external.push(
+					'node:assert',
+					'node:async_hooks',
+					'node:buffer',
+					'node:crypto',
+					'node:diagnostics_channel',
+					'node:events',
+					'node:path',
+					'node:process',
+					'node:stream',
+					'node:string_decoder',
+					'node:util'
+				);
+			}
+
 			await esbuild.build({
 				platform: 'browser',
 				conditions: ['worker', 'browser'],
@@ -69,7 +87,7 @@ export default function ({ config = 'wrangler.toml' } = {}) {
 				entryPoints: [`${tmp}/entry.js`],
 				outfile: main,
 				bundle: true,
-				external: ['__STATIC_CONTENT_MANIFEST', 'cloudflare:*'],
+				external,
 				format: 'esm',
 				loader: {
 					'.wasm': 'copy'

diff --git a/packages/adapter-cloudflare/index.js b/packages/adapter-cloudflare/index.js
@@ -53,6 +53,21 @@ export default function (options = {}) {
 				}
 			});
 
+			const external = [
+				'cloudflare:*',
+				'node:assert',
+				'node:async_hooks',
+				'node:buffer',
+				'node:crypto',
+				'node:diagnostics_channel',
+				'node:events',
+				'node:path',
+				'node:process',
+				'node:stream',
+				'node:string_decoder',
+				'node:util'
+			];
+
 			await esbuild.build({
 				platform: 'browser',
 				conditions: ['worker', 'browser'],
@@ -66,7 +81,7 @@ export default function (options = {}) {
 				loader: {
 					'.wasm': 'copy'
 				},
-				external: ['cloudflare:*']
+				external
 			});
 		}
 	};