Make ponyfill only export the explicitly typed values (#124)

.changeset/tall-lies-invite.md

@@ -0,0 +1,5 @@
+---
+'@edge-runtime/ponyfill': patch
+---
+
+Only export the specific values from the global scope as we define in our types

.changeset/thick-pets-brush.md

@@ -0,0 +1,5 @@
+---
+'@edge-runtime/primitives': patch
+---
+
+Mark the createCaches export as nullable as it does not exist in Edge Runtime

packages/ponyfill/package.json

@@ -27,15 +27,19 @@
   ],
   "devDependencies": {
     "@edge-runtime/jest-environment": "workspace:1.1.0-beta.32",
-    "@edge-runtime/primitives": "workspace:1.1.0-beta.32"
+    "@edge-runtime/primitives": "workspace:1.1.0-beta.32",
+    "@edge-runtime/vm": "workspace:^1.1.0-beta.32",
+    "acorn": "8.8.0",
+    "acorn-loose": "8.3.0",
+    "acorn-walk": "8.2.0"
   },
   "files": [
     "src"
   ],
   "scripts": {
     "clean": "rm -rf node_modules",
     "test": "pnpm test:edge && pnpm test:node",
-    "test:edge": "EDGE_RUNTIME_EXISTS=true jest --env=@edge-runtime/jest-environment",
+    "test:edge": "EDGE_RUNTIME_EXISTS=true jest --env=@edge-runtime/jest-environment --testPathIgnorePatterns='.node.test.ts$'",
     "test:node": "jest --env=node"
   },
   "license": "MPLv2",

packages/ponyfill/src/index.js

@@ -1,2 +1,42 @@
 module.exports =
-  typeof EdgeRuntime === 'string' ? self : require('@edge-runtime/primitives')
+  typeof EdgeRuntime === 'string' ? edge() : require('@edge-runtime/primitives')
+
+function edge() {
+  return {
+    AbortController,
+    AbortSignal,
+    Blob,
+    Cache,
+    CacheStorage,
+    Crypto,
+    CryptoKey,
+    Event,
+    EventTarget,
+    FetchEvent,
+    File,
+    FormData,
+    Headers,
+    PromiseRejectionEvent,
+    ReadableStream,
+    ReadableStreamBYOBReader,
+    ReadableStreamDefaultReader,
+    Request,
+    Response,
+    SubtleCrypto,
+    TextDecoder,
+    TextEncoder,
+    TransformStream,
+    URL,
+    URLPattern,
+    URLSearchParams,
+    WritableStream,
+    WritableStreamDefaultWriter,
+    atob,
+    btoa,
+    caches,
+    console,
+    crypto,
+    fetch,
+    structuredClone,
+  }
+}

packages/ponyfill/test/acorn.d.ts

@@ -0,0 +1,4 @@
+declare module 'acorn-loose' {
+  const exported: typeof import('acorn')
+  export = exported
+}

packages/ponyfill/test/compliance-with-primitives.node.test.ts

@@ -0,0 +1,73 @@
+import { parse } from 'acorn-loose'
+import { promises as fs } from 'fs'
+import { simple } from 'acorn-walk'
+import { EdgeVM } from '@edge-runtime/vm'
+
+test('exports all primitives in Edge Runtime', async () => {
+  const exportedNames = await getExportedNames()
+
+  const anyObject = exportedNames.reduce(
+    (acc: Record<string, any>, name: string) => {
+      acc[name] = expect.anything()
+      return acc
+    },
+    {}
+  )
+
+  const runtime = new EdgeVM({
+    codeGeneration: { strings: false, wasm: false },
+  })
+  const result = runtime.require(require.resolve('..'))
+
+  for (const key of LIMBO_STATE) {
+    delete anyObject[key]
+    delete result[key]
+  }
+
+  expect(result).toEqual(anyObject)
+})
+
+test('exports all primitives in Node.js', async () => {
+  const exportedNames = await getExportedNames()
+
+  const anyObject = exportedNames.reduce(
+    (acc: Record<string, any>, name: string) => {
+      acc[name] = expect.anything()
+      return acc
+    },
+    {}
+  )
+
+  const result = { ...require('..') }
+
+  for (const key of LIMBO_STATE) {
+    delete anyObject[key]
+    delete result[key]
+  }
+
+  expect(result).toEqual(anyObject)
+})
+
+async function getExportedNames() {
+  const typesPath = require.resolve('@edge-runtime/primitives/types/index.d.ts')
+  const typesContents = await fs.readFile(typesPath, 'utf8')
+  const ast = parse(typesContents, { ecmaVersion: 'latest' })
+  const exportedNames: string[] = []
+  simple(ast, {
+    ExportNamedDeclaration(node: any) {
+      for (const specifier of node.specifiers) {
+        if (specifier.exported?.name) {
+          exportedNames.push(specifier.exported.name)
+        }
+      }
+    },
+  })
+  return exportedNames
+}
+
+export const LIMBO_STATE = [
+  'createCaches',
+  'DOMException',
+  'setGlobalDispatcher',
+  'getGlobalDispatcher',
+]

packages/primitives/type-definitions/cache.d.ts

@@ -1,8 +1,10 @@
-export function createCaches(): {
-  cacheStorage: () => CacheStorage
-  Cache: typeof Cache
-  CacheStorage: typeof CacheStorage
-}
+export function createCaches():
+  | undefined
+  | {
+      cacheStorage: () => CacheStorage
+      Cache: typeof Cache
+      CacheStorage: typeof CacheStorage
+    }
 
 export const caches: CacheStorage