feat: remove webapi in favor of a smaller polyfill (#7840)

* feat: remove webapi in favor of a smaller polyfill * test: remove old test * test: 🤦‍♀️ * chore: changeset
withastro · Aug 8, 2023 · 148e61d · 148e61d
1 parent 7d2f311
commit 148e61d
Show file tree

Hide file tree

Showing 84 changed files with 37 additions and 3,775 deletions.
diff --git a/.changeset/spicy-eels-rush.md b/.changeset/spicy-eels-rush.md
@@ -0,0 +1,8 @@
+---
+'astro': major
+'@astrojs/netlify': major
+'@astrojs/vercel': major
+'@astrojs/node': major
+---
+
+Reduced the amount of polyfills provided by Astro. Astro will no longer provide (no-op) polyfills for several web apis such as HTMLElement, Image or Document. If you need access to those APIs on the server, we recommend using more proper polyfills available on npm.
diff --git a/.eslintignore b/.eslintignore
@@ -2,7 +2,6 @@
 packages/**/*.min.js
 packages/**/dist/**/*
 packages/**/fixtures/**/*
-packages/webapi/**/*
 packages/astro/vendor/vite/**/*
 examples/**/*
 scripts/**/*

diff --git a/.prettierignore b/.prettierignore
@@ -22,5 +22,4 @@ benchmark/results/
 .changeset
 
 # Files
-packages/webapi/mod.d.ts
 pnpm-lock.yaml
diff --git a/benchmark/packages/timer/package.json b/benchmark/packages/timer/package.json
@@ -23,7 +23,6 @@
     "dev": "astro-scripts dev \"src/**/*.ts\""
   },
   "dependencies": {
-    "@astrojs/webapi": "workspace:*",
     "server-destroy": "^1.0.1"
   },
   "peerDependencies": {

diff --git a/benchmark/packages/timer/src/server.ts b/benchmark/packages/timer/src/server.ts
@@ -1,11 +1,8 @@
-import { polyfill } from '@astrojs/webapi';
 import type { SSRManifest } from 'astro';
-import { NodeApp } from 'astro/app/node';
+import { NodeApp, applyPolyfills } from 'astro/app/node';
 import type { IncomingMessage, ServerResponse } from 'node:http';
 
-polyfill(globalThis, {
-	exclude: 'window document',
-});
+applyPolyfills();
 
 export function createExports(manifest: SSRManifest) {
 	const app = new NodeApp(manifest);

diff --git a/package.json b/package.json
@@ -73,7 +73,6 @@
     }
   },
   "dependencies": {
-    "@astrojs/webapi": "workspace:*",
     "astro-benchmark": "workspace:*"
   },
   "devDependencies": {

diff --git a/packages/astro/package.json b/packages/astro/package.json
@@ -120,7 +120,6 @@
     "@astrojs/language-server": "^1.0.0",
     "@astrojs/markdown-remark": "^2.2.1",
     "@astrojs/telemetry": "^2.1.1",
-    "@astrojs/webapi": "^2.2.0",
     "@babel/core": "^7.22.5",
     "@babel/generator": "^7.22.5",
     "@babel/parser": "^7.22.5",

diff --git a/packages/astro/src/core/app/node.ts b/packages/astro/src/core/app/node.ts
@@ -6,6 +6,7 @@ import { IncomingMessage } from 'node:http';
 import { TLSSocket } from 'node:tls';
 import { deserializeManifest } from './common.js';
 import { App, type MatchOptions } from './index.js';
+export { apply as applyPolyfills } from '../polyfill.js';
 
 const clientAddressSymbol = Symbol.for('astro.clientAddress');
 

diff --git a/packages/astro/src/core/polyfill.ts b/packages/astro/src/core/polyfill.ts
@@ -1,8 +1,21 @@
-import { polyfill } from '@astrojs/webapi';
+import { File } from 'node:buffer';
+import crypto from 'node:crypto';
+
+// NOTE: This file does not intend to polyfill everything that exists, its main goal is to make life easier
+// for users deploying to runtime that do support these features. In the future, we hope for this file to disappear.
 
 export function apply() {
-	// polyfill WebAPIs for Node.js runtime
-	polyfill(globalThis, {
-		exclude: 'window document',
-	});
+	// Remove when Node 18 is dropped for Node 20
+	if (!globalThis.crypto) {
+		Object.defineProperty(globalThis, 'crypto', {
+			value: crypto.webcrypto,
+		});
+	}
+
+	// Remove when Node 18 is dropped for Node 20
+	if (!globalThis.File) {
+		Object.defineProperty(globalThis, 'File', {
+			value: File,
+		});
+	}
 }
diff --git a/packages/astro/test/custom-elements.test.js b/packages/astro/test/custom-elements.test.js
diff --git a/packages/astro/test/fixtures/custom-elements/astro.config.mjs b/packages/astro/test/fixtures/custom-elements/astro.config.mjs
diff --git a/packages/astro/test/fixtures/custom-elements/my-component-lib/hydration-polyfill.js b/packages/astro/test/fixtures/custom-elements/my-component-lib/hydration-polyfill.js
diff --git a/packages/astro/test/fixtures/custom-elements/my-component-lib/index.js b/packages/astro/test/fixtures/custom-elements/my-component-lib/index.js
diff --git a/packages/astro/test/fixtures/custom-elements/my-component-lib/package.json b/packages/astro/test/fixtures/custom-elements/my-component-lib/package.json
diff --git a/packages/astro/test/fixtures/custom-elements/my-component-lib/polyfill.js b/packages/astro/test/fixtures/custom-elements/my-component-lib/polyfill.js
diff --git a/packages/astro/test/fixtures/custom-elements/my-component-lib/server.js b/packages/astro/test/fixtures/custom-elements/my-component-lib/server.js
diff --git a/packages/astro/test/fixtures/custom-elements/my-component-lib/shim.js b/packages/astro/test/fixtures/custom-elements/my-component-lib/shim.js
diff --git a/packages/astro/test/fixtures/custom-elements/package.json b/packages/astro/test/fixtures/custom-elements/package.json
diff --git a/packages/astro/test/fixtures/custom-elements/src/components/my-element.js b/packages/astro/test/fixtures/custom-elements/src/components/my-element.js
diff --git a/packages/astro/test/fixtures/custom-elements/src/pages/ctr.astro b/packages/astro/test/fixtures/custom-elements/src/pages/ctr.astro
diff --git a/packages/astro/test/fixtures/custom-elements/src/pages/index.astro b/packages/astro/test/fixtures/custom-elements/src/pages/index.astro
diff --git a/packages/astro/test/fixtures/custom-elements/src/pages/nested.astro b/packages/astro/test/fixtures/custom-elements/src/pages/nested.astro
diff --git a/packages/astro/test/fixtures/custom-elements/src/pages/nossr.astro b/packages/astro/test/fixtures/custom-elements/src/pages/nossr.astro
diff --git a/packages/astro/test/test-utils.js b/packages/astro/test/test-utils.js
@@ -1,4 +1,3 @@
-import { polyfill } from '@astrojs/webapi';
 import { execa } from 'execa';
 import fastGlob from 'fast-glob';
 import fs from 'node:fs';
@@ -17,11 +16,6 @@ import { nodeLogDestination } from '../dist/core/logger/node.js';
 import preview from '../dist/core/preview/index.js';
 import { sync } from '../dist/core/sync/index.js';
 
-// polyfill WebAPIs to globalThis for Node v12, Node v14, and Node v16
-polyfill(globalThis, {
-	exclude: 'window document',
-});
-
 // Disable telemetry when running tests
 process.env.ASTRO_TELEMETRY_DISABLED = true;
 

diff --git a/packages/integrations/netlify/package.json b/packages/integrations/netlify/package.json
@@ -39,7 +39,6 @@
   },
   "dependencies": {
     "@astrojs/underscore-redirects": "^0.2.0",
-    "@astrojs/webapi": "^2.2.0",
     "@netlify/functions": "^1.6.0",
     "esbuild": "^0.18.16"
   },