reown-com / appkit

The full stack toolkit to build onchain app UX
https://reown.com/appkit
Apache License 2.0
4.95k stars 1.42k forks source link

[bug]: Vite big size, no treeshakable #2159

Closed reslear closed 7 months ago

reslear commented 7 months ago

Link to minimal reproducible example

https://stackblitz.com/edit/vitejs-vite-zxnq49?file=src%2FApp.vue

Summary

A simple template, for playback

  1. build the project and open the demo in a new tab
  2. inspect the code - you will see a message about react devtools (which tells you to enable metamask sdk) and click on chunk.

Screenshot 2024-04-16 at 08 01 32

we get chunk chunk-22BZIRQV.js?v=998e5bee:39559 - 2,5mb :(

and more, so this is @wagmi/connectors:

Screenshot 2024-04-16 at 08 05 52

So i found solution use ESM:

fork https://stackblitz.com/edit/vitejs-vite-bngsgj?file=vite.config.ts

  optimizeDeps: {
    exclude: ['@web3modal/wagmi'],
  },

but we got error:

Uncaught SyntaxError: The requested module '/node_modules/.pnpm/@walletconnect+time@1.0.2/node_modules/@walletconnect/time/dist/cjs/index.js?v=c28150ba' does not provide an export named 'fromMiliseconds' 

same https://github.com/WalletConnect/walletconnect-utils/issues/134

so we need to prepare or customize vite so that it doesn't bandwidth huge files.

List of related npm package versions

"@wagmi/connectors": "^4.1.26",
"@wagmi/core": "^2.6.17",
"@web3modal/wagmi": "^4.1.8",
"viem": "^2.9.19",
"vue": "^3.4.21"
linear[bot] commented 7 months ago

W3M-247 [bug]: Vite big size, no treeshakable

glitch-txs commented 7 months ago

mmm, we do tree shaking.

We also don't use the MM SDK internally, so that shouldn't be bundled unless you're using the Wagmi's MetaMask connector.

Adding the package as external will break the app as you're not bundling it.

reslear commented 7 months ago

It is interesting that this happens only during development, as for the build it does not happen, maybe it is a vite problem.

reslear commented 7 months ago

I found similar issues:

uses https://github.com/MilanKovacic/vite-plugin-externalize-dependencies

exclude specific dependencies from the Vite bundle during development.

// vite.config.ts
import externalize from 'vite-plugin-externalize-dependencies'
// ...
    externalize({
      externals: ['@wagmi/connectors'],
    }),
// ...

Also, on the Web3Modal side, we need to:

glitch-txs commented 7 months ago

I don't recommend that, you can however try

externals: ['@web3modal/siwe', '@walletconnect/modal', '@metamask/sdk']

glitch-txs commented 7 months ago

tree shaking is not the same as dynamic import. We use package imports to tree shake unused hooks for other frameworks, but the rest we use pretty much everything.

Also, we use dynamic imports for the SIWE package, but this is still bundled, you will see it generates a chunk, but this won't be shipped to the browser because it's splitted.

You can also check for the JS size sent to the browser from the Network tab.

reslear commented 7 months ago

And better:

import { defineConfig } from 'vite'
import externalize from 'vite-plugin-externalize-dependencies'

// https://vitejs.dev/config/
export default defineConfig({
    // https://github.com/WalletConnect/web3modal/issues/2159
    // https://github.com/reslear/metakeep-wagmi-connector/blob/main/playground/vite.config.mts#L20 
    externalize({
      externals: [
        '@web3modal/siwe',
        '@walletconnect/modal',
        '@metamask/sdk',
        '@coinbase/wallet-sdk',
      ],
    }),
  ],
})

or add from wagmi/connectors:

https://github.com/wevm/wagmi/blob/de17905c91436703cd42c45475e8e7e26a631c0e/packages/connectors/package.json#L47-L53

@glitch-txs This solves my problem, I can close it. Also maybe needs add it to the FAQ.

glitch-txs commented 7 months ago

Coinbase one is used by Web3Modal, if you remove it the coinbase wallet won't work on mobile. Of course it's up to you if you'd like to support it on mobile.

reslear commented 7 months ago

@glitch-txs

Yes, but it's solution just ONLY for local development - vite esbuild pre-bundling.

for build vite use rollup, and it's needs modify:

  build: {
    rollupOptions: {
      output: {
        manualChunks: {