chore!: Build Snaps execution environments with Webpack (#3322)

This updates the Snaps execution environments build to use Webpack
instead of Browserify. The existing Browserify script was updated to
build with Webpack. In the future we may be able to use Webpack from the
CLI directly, but right now for compatibility with LavaMoat Node we need
to use a custom script.

I've added a new script `build:lavamoat:test` which builds the execution
environments for testing locally or in CI. The main difference with this
script is that it uses `tsconfig` paths, which are now disabled for the
production build. Doing so results in much better tree shaking, so a
smaller bundle.

## Breaking changes

- The `node-process` and `node-thread` bundles are now exported as
`@metamask/snaps-execution-environments/node-process` and
`@metamask/snaps-execution-environments/node-thread` respectively.

Author: Mrtenz

.github/workflows/build-lint-test.yml

@@ -26,7 +26,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache-node-modules: ${{ matrix.node-version == '20.x' }}
       - name: Prepare "@metamask/snaps-execution-environments" build
-        run: yarn workspace @metamask/snaps-execution-environments run build:lavamoat
+        run: yarn workspace @metamask/snaps-execution-environments run build:lavamoat:test
       - name: Save "@metamask/snaps-execution-environments" build
         id: cache-snaps-execution-environments-build
         uses: actions/upload-artifact@v4
@@ -35,7 +35,7 @@ jobs:
           retention-days: 1
           path: |
             .nvmrc
-            packages/snaps-execution-environments/dist/browserify
+            packages/snaps-execution-environments/dist/webpack
       - name: Fetch workspace package names
         id: workspace-package-names
         run: |
@@ -95,12 +95,16 @@ jobs:
   policy:
     name: Generate LavaMoat policy
     runs-on: ubuntu-latest
-    needs: prepare
+    needs: build
     steps:
       - name: Checkout and setup environment
         uses: MetaMask/action-checkout-and-setup@v1
         with:
           is-high-risk-environment: false
+      - name: Restore build files
+        uses: actions/download-artifact@v4
+        with:
+          name: build-source-${{ runner.os }}-${{ github.sha }}
       - name: Generate LavaMoat policy
         run: yarn workspace @metamask/snaps-execution-environments build:lavamoat:policy
       - name: Require clean working directory

.github/workflows/publish-environment.yml

@@ -32,5 +32,5 @@ jobs:
           aws-region: ${{ vars.AWS_REGION }}
       - name: Deploy to `${{ inputs.destination_dir }}` directory of remote storage
         run: |
-          aws s3 cp ./packages/snaps-execution-environments/dist/browserify/iframe s3://${{ vars.AWS_BUCKET_NAME }}/iframe/${{ inputs.destination_dir }} --recursive --acl private
-          aws s3 cp ./packages/snaps-execution-environments/dist/browserify/webview s3://${{ vars.AWS_BUCKET_NAME }}/webview/${{ inputs.destination_dir }} --recursive --acl private
+          aws s3 cp ./packages/snaps-execution-environments/dist/webpack/iframe s3://${{ vars.AWS_BUCKET_NAME }}/iframe/${{ inputs.destination_dir }} --recursive --acl private
+          aws s3 cp ./packages/snaps-execution-environments/dist/webpack/webview s3://${{ vars.AWS_BUCKET_NAME }}/webview/${{ inputs.destination_dir }} --recursive --acl private

.yarn/patches/@lavamoat-lavapack-npm-6.1.1-b81af21193.patch

@@ -96,10 +96,19 @@ module.exports = {
 
   // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
   moduleNameMapper: {
+    '^@metamask/snaps-execution-environments/node-thread': [
+      '<rootDir>/../snaps-execution-environments/dist/webpack/node-thread/bundle.js',
+    ],
+    '^@metamask/snaps-execution-environments/node-process': [
+      '<rootDir>/../snaps-execution-environments/dist/webpack/node-process/bundle.js',
+    ],
     '^@metamask/(.+)/production/jsx-runtime': [
       '<rootDir>/../$1/src/jsx/production',
     ],
     '^@metamask/(.+)/test-utils$': ['<rootDir>/../$1/src/test-utils'],
+    '^@metamask/post-message-stream/node$': [
+      '@metamask/post-message-stream/node',
+    ],
     '^@metamask/(.+)/node$': ['<rootDir>/../$1/src/node'],
     '^@metamask/(.+)/jsx': ['<rootDir>/../$1/src/jsx'],
     '^@metamask/(.+)$': [

.yarn/patches/lavamoat-browserify-npm-17.0.5-16c00e9ef9.patch

@@ -60,7 +60,6 @@
   "resolutions": {
     "@babel/core": "patch:@babel/core@npm%3A7.23.2#./.yarn/patches/@babel-core-npm-7.23.2-b93f586907.patch",
     "@esbuild-plugins/node-modules-polyfill@^0.2.2": "patch:@esbuild-plugins/node-modules-polyfill@npm%3A0.2.2#./.yarn/patches/@esbuild-plugins-node-modules-polyfill-npm-0.2.2-f612681798.patch",
-    "@lavamoat/lavapack@^6.1.1": "patch:@lavamoat/lavapack@npm%3A6.1.1#./.yarn/patches/@lavamoat-lavapack-npm-6.1.1-b81af21193.patch",
     "@puppeteer/[email protected]": "patch:@puppeteer/browsers@npm%3A1.7.0#./.yarn/patches/@puppeteer-browsers-npm-1.7.0-203cb4f44b.patch",
     "@puppeteer/browsers@^1.6.0": "patch:@puppeteer/browsers@npm%3A1.7.0#./.yarn/patches/@puppeteer-browsers-npm-1.7.0-203cb4f44b.patch",
     "@types/glob@*": "patch:@types/glob@npm%3A7.1.4#./.yarn/patches/@types-glob-npm-7.1.4-d45247eaa2.patch",
@@ -72,7 +71,6 @@
     "jest-fetch-mock@^3.0.3": "patch:jest-fetch-mock@npm:3.0.3#.yarn/patches/jest-fetch-mock-npm-3.0.3-ac072ca8af.patch",
     "jest-util@^29.5.0": "patch:jest-util@npm%3A29.6.3#./.yarn/patches/jest-util-npm-29.6.3-6ffdea2c1c.patch",
     "jest-util@^29.6.3": "patch:jest-util@npm%3A29.6.3#./.yarn/patches/jest-util-npm-29.6.3-6ffdea2c1c.patch",
-    "lavamoat-browserify@^17.0.5": "patch:lavamoat-browserify@npm%3A17.0.5#./.yarn/patches/lavamoat-browserify-npm-17.0.5-16c00e9ef9.patch",
     "luxon@^3.2.1": "patch:luxon@npm%3A3.3.0#./.yarn/patches/luxon-npm-3.3.0-bdbae9bfd5.patch",
     "tsconfig-paths@^3.11.0": "patch:tsconfig-paths@npm%3A3.14.2#./.yarn/patches/tsconfig-paths-npm-3.14.2-90ce75420d.patch",
     "tsconfig-paths@^3.14.1": "patch:tsconfig-paths@npm%3A3.14.2#./.yarn/patches/tsconfig-paths-npm-3.14.2-90ce75420d.patch",

jest.config.base.js

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "k2lRqMHzUAsSfYAQvfHaotZ+GjevHXfCYq31N6rLbpI=",
+    "shasum": "S8JJzZaDPhHp16nyJVCPY++KVgOpYSCUrEVp/dmbsRE=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "OKsspaf6yslVwkh3t0EEkgLe2ZXVUeOSuARHBYh5QO8=",
+    "shasum": "S9Rxcf90yagtJcBEV2lPs4eSASBPP+KkiACJjkye7ho=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/examples/packages/bip32/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "JuqQZZ60QV9h7WNpCeNCNoomvPVzkoAGMqF+wXMi7vM=",
+    "shasum": "zip0FTlGFS2oV/Hm6lLWzBAhw/UtphSCFG4kecgojAg=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/examples/packages/bip44/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "5WnCGlClRMxrjPXzuSZybJuEBDfo+oIjkfCRhcvFzzw=",
+    "shasum": "KaI5if/V5l02632+bVHOa6UtSbmWO+NR/kr8q8Ck1zs=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",