Use local shims for globals (and update buffer polyfill)

Author: davidmyersdev

package.json

@@ -13,6 +13,7 @@
   "keywords": [
     "node",
     "node-core-modules",
+    "node-polyfills",
     "node-stdlib",
     "polyfills",
     "vite",
@@ -27,10 +28,14 @@
       "require": "./dist/index.cjs",
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
-    }
+    },
+    "./shims": "./shims/dist/index.js"
   },
   "scripts": {
-    "build": "vite build && tsc",
+    "build": "run-s build:core build:shims build:types",
+    "build:core": "vite build",
+    "build:shims": "vite build ./shims",
+    "build:types": "tsc",
     "test": "run-s test:build test:dev",
     "test:build": "vite -c test/vite.config.ts build",
     "test:dev": "vite -c test/vite.config.ts"
@@ -55,7 +60,9 @@
   },
   "dependencies": {
     "@rollup/plugin-inject": "^5.0.3",
-    "node-stdlib-browser": "^1.2.0"
+    "buffer-polyfill": "npm:buffer@^6.0.3",
+    "node-stdlib-browser": "^1.2.0",
+    "process-polyfill": "npm:process@^0.11.10"
   },
   "peerDependencies": {
     "vite": "^2.0.0 || ^3.0.0 || ^4.0.0"

pnpm-lock.yaml

@@ -0,0 +1,5 @@
+const global = globalThis || this || self
+
+export { Buffer } from 'buffer-polyfill'
+export { default as process } from 'process-polyfill'
+export { global }

shims/index.ts

@@ -0,0 +1,9 @@
+{
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js"
+}

shims/package.json

@@ -0,0 +1,27 @@
+import { defineConfig } from 'vite'
+import { externalizeDeps } from 'vite-plugin-externalize-deps'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  build: {
+    lib: {
+      entry: './index.ts',
+      fileName: 'index',
+    },
+    rollupOptions: {
+      external: [/^node:.*$/],
+      output: [
+        {
+          esModule: true,
+          exports: 'named',
+          format: 'es',
+        },
+      ],
+    },
+    sourcemap: true,
+    target: 'esnext',
+  },
+  plugins: [
+    externalizeDeps(),
+  ],
+})

shims/vite.config.ts

@@ -57,6 +57,8 @@ export type PolyfillOptionsResolved = {
   protocolImports: boolean,
 }
 
+const globals = ['buffer', 'global', 'process'].flatMap(name => [name, `node:${name}`])
+
 const isBuildEnabled = (value: BooleanOrBuildTarget) => {
   if (!value) return false
   if (value === true) return true
@@ -105,7 +107,7 @@ const isProtocolImport = (name: string) => {
  */
 export const nodePolyfills = (options: PolyfillOptions = {}): Plugin => {
   const require = createRequire(import.meta.url)
-  const globalShimsPath = require.resolve('node-stdlib-browser/helpers/esbuild/shim')
+  const globalShimsPath = require.resolve('vite-plugin-node-polyfills/shims')
   const optionsResolved: PolyfillOptionsResolved = {
     exclude: [],
     protocolImports: true,
@@ -135,7 +137,7 @@ export const nodePolyfills = (options: PolyfillOptions = {}): Plugin => {
         }
 
         if (!isExcluded(name)) {
-          included[name] = value
+          included[name] = globals.includes(name) ? globalShimsPath : value
         }
 
         return included
@@ -179,10 +181,10 @@ export const nodePolyfills = (options: PolyfillOptions = {}): Plugin => {
                 setup(build) {
                   // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
                   const escapedGlobalShimsPath = globalShimsPath.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
-                  const filter = new RegExp(`^${escapedGlobalShimsPath}$`)
+                  const globalShimsFilter = new RegExp(`^${escapedGlobalShimsPath}$`)
 
                   // https://esbuild.github.io/plugins/#on-resolve
-                  build.onResolve({ filter }, () => {
+                  build.onResolve({ filter: globalShimsFilter }, () => {
                     return {
                       // https://github.com/evanw/esbuild/blob/edede3c49ad6adddc6ea5b3c78c6ea7507e03020/internal/bundler/bundler.go#L1468
                       external: false,

src/index.ts

@@ -12,6 +12,7 @@ console.log(resolve('.'))
 console.log(process)
 console.log(process.env)
 console.log(globalThis.Array)
+console.log(Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]).readBigUInt64BE(0))
 console.log(Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]))
 console.log(Array)
 console.log(fs)