Search code examples
node.jsvue.jsrollupjsvite

Polyfill node os module with vite/rollup.js


I'm working on a Vite project which uses the opensea-js package. This package depends on xhr2-cookies. which imports os, http, https and some other internal node modules.

I'm getting this error when trying to call any of the opensea methods:

Uncaught (in promise) TypeError: os.type is not a function
    XMLHttpRequest2 xml-http-request.ts:102
    prepareRequest httpprovider.js:61
    sendAsync httpprovider.js:116
    node_modules opensea-js.js:24209

Tracing this error it comes from constructing the useragent string.

I tried installing rollup-plugin-polyfill-node and adding it to vite.config.js but still getting the same error:

import path from 'path'
import vue from '@vitejs/plugin-vue'
import nodePolyfills from 'rollup-plugin-polyfill-node'
import { defineConfig } from 'vite'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [vue()],
  resolve: {
    alias: {
      '@': path.resolve(__dirname, 'src'),
    },
  },
  server: {
    port: 8080,
  },
  define: {
    'process.env': {},
  },
  build: {
    rollupOptions: {
      plugins: [
        nodePolyfills(),
      ],
    },
  },
})

I've also tried patching the file manually with patch-package, which fixes the os error however then fails when trying to sending the request (which uses http/https modules which also need to be polyfilled).


Solution

  • In my project I solved with a configuration like this. I have described the solution in a short article.

    // yarn add --dev @esbuild-plugins/node-globals-polyfill
    import { NodeGlobalsPolyfillPlugin } from '@esbuild-plugins/node-globals-polyfill'
    // yarn add --dev @esbuild-plugins/node-modules-polyfill
    import { NodeModulesPolyfillPlugin } from '@esbuild-plugins/node-modules-polyfill'
    // You don't need to add this to deps, it's included by @esbuild-plugins/node-modules-polyfill
    import rollupNodePolyFill from 'rollup-plugin-node-polyfills'
    
    export default {
            resolve: {
                alias: {
                    // This Rollup aliases are extracted from @esbuild-plugins/node-modules-polyfill, 
                    // see https://github.com/remorses/esbuild-plugins/blob/master/node-modules-polyfill/src/polyfills.ts
                    // process and buffer are excluded because already managed
                    // by node-globals-polyfill
                    util: 'rollup-plugin-node-polyfills/polyfills/util',
                    sys: 'util',
                    events: 'rollup-plugin-node-polyfills/polyfills/events',
                    stream: 'rollup-plugin-node-polyfills/polyfills/stream',
                    path: 'rollup-plugin-node-polyfills/polyfills/path',
                    querystring: 'rollup-plugin-node-polyfills/polyfills/qs',
                    punycode: 'rollup-plugin-node-polyfills/polyfills/punycode',
                    url: 'rollup-plugin-node-polyfills/polyfills/url',
                    string_decoder:
                        'rollup-plugin-node-polyfills/polyfills/string-decoder',
                    http: 'rollup-plugin-node-polyfills/polyfills/http',
                    https: 'rollup-plugin-node-polyfills/polyfills/http',
                    os: 'rollup-plugin-node-polyfills/polyfills/os',
                    assert: 'rollup-plugin-node-polyfills/polyfills/assert',
                    constants: 'rollup-plugin-node-polyfills/polyfills/constants',
                    _stream_duplex:
                        'rollup-plugin-node-polyfills/polyfills/readable-stream/duplex',
                    _stream_passthrough:
                        'rollup-plugin-node-polyfills/polyfills/readable-stream/passthrough',
                    _stream_readable:
                        'rollup-plugin-node-polyfills/polyfills/readable-stream/readable',
                    _stream_writable:
                        'rollup-plugin-node-polyfills/polyfills/readable-stream/writable',
                    _stream_transform:
                        'rollup-plugin-node-polyfills/polyfills/readable-stream/transform',
                    timers: 'rollup-plugin-node-polyfills/polyfills/timers',
                    console: 'rollup-plugin-node-polyfills/polyfills/console',
                    vm: 'rollup-plugin-node-polyfills/polyfills/vm',
                    zlib: 'rollup-plugin-node-polyfills/polyfills/zlib',
                    tty: 'rollup-plugin-node-polyfills/polyfills/tty',
                    domain: 'rollup-plugin-node-polyfills/polyfills/domain'
                }
            },
            optimizeDeps: {
                esbuildOptions: {
                    // Node.js global to browser globalThis
                    define: {
                        global: 'globalThis'
                    },
                    // Enable esbuild polyfill plugins
                    plugins: [
                        NodeGlobalsPolyfillPlugin({
                            process: true,
                            buffer: true
                        }),
                        NodeModulesPolyfillPlugin()
                    ]
                }
            },
            build: {
                rollupOptions: {
                    plugins: [
                        // Enable rollup polyfills plugin
                        // used during production bundling
                        rollupNodePolyFill()
                    ]
                }
            }
    }