Publish preview builds to public NPM registry (#1873)

This changes the publish preview workflow to deploy to the public NPM
registry, instead of the private GitHub registry.

.github/workflows/publish-preview.yml

@@ -40,13 +40,11 @@ jobs:
         with:
           node-version-file: '.nvmrc'
           cache: yarn
-          registry-url: 'https://npm.pkg.github.com'
-          scope: '@MetaMask'
       - run: yarn --immutable
       - name: Get commit SHA
         id: commit-sha
         run: echo "COMMIT_SHA=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
-      - run: yarn prepare-preview-builds ${{ steps.commit-sha.outputs.COMMIT_SHA }}
+      - run: yarn prepare-preview-builds @metamask-previews ${{ steps.commit-sha.outputs.COMMIT_SHA }}
       - run: yarn build
       - name: Publish preview build
         run: yarn publish-previews

constraints.pro

@@ -171,10 +171,6 @@ gen_enforced_field(WorkspaceCwd, 'module', './dist/esm/index.js') :-
   WorkspaceCwd \= '.'.
 
 % Dependencies must have preview scripts.
-gen_enforced_field(WorkspaceCwd, 'scripts.prepare-manifest:preview', PrepareManifestScript) :-
-  \+ workspace_field(WorkspaceCwd, 'private', true),
-  relative_path(WorkspaceCwd, 'scripts/prepare-preview-manifest.sh', PrepareManifestScript),
-  WorkspaceCwd \= '.'.
 gen_enforced_field(WorkspaceCwd, 'scripts.publish:preview', 'yarn npm publish --tag preview') :-
   \+ workspace_field(WorkspaceCwd, 'private', true),
   WorkspaceCwd \= '.'.

package.json

@@ -31,8 +31,8 @@
     "test": "yarn workspaces foreach --parallel --verbose run test",
     "test:browser": "yarn workspaces foreach --verbose run test:browser",
     "child-workspace-package-names-as-json": "ts-node scripts/child-workspace-package-names-as-json.ts",
-    "prepare-preview-builds": "yarn workspaces foreach --parallel run prepare-manifest:preview",
-    "publish-previews": "yarn workspaces foreach --parallel run publish:preview",
+    "prepare-preview-builds": "./scripts/prepare-preview-builds.sh",
+    "publish-previews": "yarn workspaces foreach --parallel --verbose run publish:preview",
     "install-chrome": "./scripts/install-chrome.sh",
     "get-release-tag": "ts-node --swc scripts/get-release-tag.ts",
     "test:e2e": "yarn workspaces foreach --verbose --exclude root run test:e2e"

packages/create-snap/package.json

@@ -39,7 +39,6 @@
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "publish:package": "../../scripts/publish-package.sh",
     "lint:ci": "yarn lint",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/bip32/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/bip44/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/browserify-plugin/package.json

@@ -26,7 +26,6 @@
     "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" \"!snap.manifest.json\" --ignore-path ../../../../.gitignore",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/browserify/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/cronjobs/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/dialogs/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/errors/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/ethereum-provider/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/ethers-js/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/get-entropy/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/get-file/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/get-locale/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/invoke-snap/packages/consumer-signer/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/invoke-snap/packages/core-signer/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/json-rpc/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/lifecycle-hooks/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/manage-state/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/name-lookup/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/network-access/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/notifications/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/rollup-plugin/package.json

@@ -27,7 +27,6 @@
     "test": "yarn test:e2e",
     "test:e2e": "jest",
     "start": "yarn build --watch",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/transaction-insights/package.json

@@ -27,7 +27,6 @@
     "start": "mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/wasm/package.json

@@ -28,7 +28,6 @@
     "start": "yarn build:wasm && mm-snap watch",
     "test": "yarn test:e2e",
     "test:e2e": "jest",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/examples/packages/webpack-plugin/package.json

@@ -27,7 +27,6 @@
     "test": "yarn test:e2e",
     "test:e2e": "jest",
     "start": "webpack watch",
-    "prepare-manifest:preview": "../../../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/snaps-browserify-plugin/package.json

@@ -33,7 +33,6 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"

packages/snaps-cli/package.json

@@ -41,7 +41,6 @@
     "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" --ignore-path ../../.gitignore",
     "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog && yarn lint:dependencies",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"

packages/snaps-controllers/package.json

@@ -37,7 +37,6 @@
     "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog && yarn lint:dependencies",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:changelog": "../../scripts/validate-changelog.sh @metamask/snaps-controllers",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"

packages/snaps-execution-environments/package.json

@@ -38,7 +38,6 @@
     "build:lavamoat": "lavamoat scripts/build.js --policy lavamoat/build-system/policy.json  --policyOverride lavamoat/build-system/policy-override.json",
     "build:lavamoat:policy": "yarn build:lavamoat --writeAutoPolicy && node scripts/build.js --writeAutoPolicy",
     "auto-changelog-init": "auto-changelog init",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "start": "node scripts/start.js",

packages/snaps-jest/package.json

@@ -29,7 +29,6 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/snaps-rollup-plugin/package.json

@@ -34,7 +34,6 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"

packages/snaps-rpc-methods/package.json

@@ -31,7 +31,6 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"

packages/snaps-simulator/package.json

@@ -42,7 +42,6 @@
     "test:watch": "jest --watch",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
     "lint:ci": "yarn lint",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:dependencies": "depcheck"
   },

packages/snaps-types/package.json

@@ -30,7 +30,6 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"

packages/snaps-ui/package.json

@@ -30,7 +30,6 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"

packages/snaps-utils/package.json

@@ -60,7 +60,6 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"

packages/snaps-webpack-plugin/package.json

@@ -34,7 +34,6 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"

scripts/prepare-preview-builds.jq

@@ -0,0 +1,52 @@
+# The name is overwritten, causing the package to get published under a
+# different NPM scope than non-preview builds.
+.name |= sub("@metamask/"; "\($npm_scope)/") |
+
+# The prerelease version is overwritten, preserving the non-prerelease portion
+# of the version. Technically we'd want to bump the non-prerelease portion as
+# well if we wanted this to be SemVer-compliant, but it was simpler not to.
+# This is just for testing, it doesn't need to strictly follow SemVer.
+.version |= split("-")[0] + "-preview.\($hash)" |
+
+# The workspace dependencies are updated to point to the exact preview build
+# version, so that Yarn does not try to resolve a different version from the
+# registry.
+
+if has("devDependencies") then
+  .devDependencies |= with_entries(
+    if .value | startswith("workspace:") then
+      .key |= sub("@metamask/"; "@metamask-previews/") |
+      .value |= sub("workspace:\\^"; "workspace:*")
+    else
+      .
+    end
+  )
+else
+  .
+end |
+
+if has("peerDependencies") then
+  .peerDependencies |= with_entries(
+    if .value | startswith("workspace:") then
+      .key |= sub("@metamask/"; "@metamask-previews/") |
+      .value |= sub("workspace:\\^"; "workspace:*")
+    else
+      .
+    end
+  )
+else
+  .
+end |
+
+if has("dependencies") then
+  .dependencies |= with_entries(
+    if .value | startswith("workspace:") then
+      .key |= sub("@metamask/"; "@metamask-previews/") |
+      .value |= sub("workspace:\\^"; "workspace:*")
+    else
+      .
+    end
+  )
+else
+  .
+end