feat: more helpful errors when using incompatible node modules (#11673)

* feat: more helpful errors when using incompatible node modules * don't bother prefixing the id --------- Co-authored-by: Rich Harris <rich.harris@vercel.com>
sveltejs · Jan 18, 2024 · 568bb83 · 568bb83
1 parent 288f731
commit 568bb83
Show file tree

Hide file tree

Showing 3 changed files with 112 additions and 30 deletions.
diff --git a/.changeset/light-tips-hang.md b/.changeset/light-tips-hang.md
@@ -0,0 +1,6 @@
+---
+'@sveltejs/adapter-cloudflare-workers': minor
+'@sveltejs/adapter-cloudflare': minor
+---
+
+feat: more helpful errors when using incompatible Node modules
diff --git a/packages/adapter-cloudflare-workers/index.js b/packages/adapter-cloudflare-workers/index.js
@@ -82,21 +82,59 @@ export default function ({ config = 'wrangler.toml' } = {}) {
 				external.push(...compatible_node_modules.map((id) => `node:${id}`));
 			}
 
-			await esbuild.build({
-				platform: 'browser',
-				conditions: ['worker', 'browser'],
-				sourcemap: 'linked',
-				target: 'es2022',
-				entryPoints: [`${tmp}/entry.js`],
-				outfile: main,
-				bundle: true,
-				external,
-				alias: Object.fromEntries(compatible_node_modules.map((id) => [id, `node:${id}`])),
-				format: 'esm',
-				loader: {
-					'.wasm': 'copy'
+			try {
+				const result = await esbuild.build({
+					platform: 'browser',
+					conditions: ['worker', 'browser'],
+					sourcemap: 'linked',
+					target: 'es2022',
+					entryPoints: [`${tmp}/entry.js`],
+					outfile: main,
+					bundle: true,
+					external,
+					alias: Object.fromEntries(compatible_node_modules.map((id) => [id, `node:${id}`])),
+					format: 'esm',
+					loader: {
+						'.wasm': 'copy'
+					},
+					logLevel: 'silent'
+				});
+
+				if (result.warnings.length > 0) {
+					const formatted = await esbuild.formatMessages(result.warnings, {
+						kind: 'warning',
+						color: true
+					});
+
+					console.error(formatted.join('\n'));
 				}
-			});
+			} catch (error) {
+				for (const e of error.errors) {
+					for (const node of e.notes) {
+						const match =
+							/The package "(.+)" wasn't found on the file system but is built into node/.exec(
+								node.text
+							);
+
+						if (match) {
+							node.text = `Cannot use "${match[1]}" when deploying to Cloudflare.`;
+						}
+					}
+				}
+
+				const formatted = await esbuild.formatMessages(error.errors, {
+					kind: 'error',
+					color: true
+				});
+
+				console.error(formatted.join('\n'));
+
+				throw new Error(
+					`Bundling with esbuild failed with ${error.errors.length} ${
+						error.errors.length === 1 ? 'error' : 'errors'
+					}`
+				);
+			}
 
 			builder.log.minor('Copying assets...');
 			const bucket_dir = `${site.bucket}${builder.config.kit.paths.base}`;

diff --git a/packages/adapter-cloudflare/index.js b/packages/adapter-cloudflare/index.js
@@ -70,22 +70,60 @@ export default function (options = {}) {
 
 			const external = ['cloudflare:*', ...compatible_node_modules.map((id) => `node:${id}`)];
 
-			await esbuild.build({
-				platform: 'browser',
-				conditions: ['worker', 'browser'],
-				sourcemap: 'linked',
-				target: 'es2022',
-				entryPoints: [`${tmp}/_worker.js`],
-				outfile: `${dest}/_worker.js`,
-				allowOverwrite: true,
-				format: 'esm',
-				bundle: true,
-				loader: {
-					'.wasm': 'copy'
-				},
-				external,
-				alias: Object.fromEntries(compatible_node_modules.map((id) => [id, `node:${id}`]))
-			});
+			try {
+				const result = await esbuild.build({
+					platform: 'browser',
+					conditions: ['worker', 'browser'],
+					sourcemap: 'linked',
+					target: 'es2022',
+					entryPoints: [`${tmp}/_worker.js`],
+					outfile: `${dest}/_worker.js`,
+					allowOverwrite: true,
+					format: 'esm',
+					bundle: true,
+					loader: {
+						'.wasm': 'copy'
+					},
+					external,
+					alias: Object.fromEntries(compatible_node_modules.map((id) => [id, `node:${id}`])),
+					logLevel: 'silent'
+				});
+
+				if (result.warnings.length > 0) {
+					const formatted = await esbuild.formatMessages(result.warnings, {
+						kind: 'warning',
+						color: true
+					});
+
+					console.error(formatted.join('\n'));
+				}
+			} catch (error) {
+				for (const e of error.errors) {
+					for (const node of e.notes) {
+						const match =
+							/The package "(.+)" wasn't found on the file system but is built into node/.exec(
+								node.text
+							);
+
+						if (match) {
+							node.text = `Cannot use "${match[1]}" when deploying to Cloudflare.`;
+						}
+					}
+				}
+
+				const formatted = await esbuild.formatMessages(error.errors, {
+					kind: 'error',
+					color: true
+				});
+
+				console.error(formatted.join('\n'));
+
+				throw new Error(
+					`Bundling with esbuild failed with ${error.errors.length} ${
+						error.errors.length === 1 ? 'error' : 'errors'
+					}`
+				);
+			}
 		}
 	};
 }