chore(devex): Add thresholds to coverage script and log coverage for merged report (#3460)

This has several small improvements for local developer experience:

- The coverage script used by `snaps-controllers`,
`snaps-execution-environments`, and `snaps-utils` now has two
thresholds: one for increases (e.g., only increase the coverage if the
increase in coverage is more the threshold), and one for decreases
(e.g., only fail if the decrease in coverage is less than the
threshold).
- The coverage script is now reused rather than duplicated.
- There's some additional messaging to make it clear that the coverage
percentages didn't change.
- The coverage script now prints the merged coverage report, instead of
Jest and Vitest printing their individual reports.
- The NPM package used for some `snaps-controllers` tests is now
included in the repo, since it never changes anyway.

---------

Co-authored-by: MetaMask Bot <[email protected]>

Author: Mrtenz

.gitignore

@@ -62,6 +62,7 @@ typings/
 
 # Output of 'npm pack'
 *.tgz
+!**/test/fixtures/*.tgz
 
 # Yarn Integrity file
 .yarn-integrity

package.json

@@ -100,6 +100,9 @@
     "eslint-plugin-promise": "^7.1.0",
     "execa": "^5.1.1",
     "favicons": "^7.1.2",
+    "istanbul-lib-coverage": "^3.2.2",
+    "istanbul-lib-report": "^3.0.1",
+    "istanbul-reports": "^3.1.7",
     "jest": "^29.0.2",
     "jest-silent-reporter": "^0.6.0",
     "lint-staged": "^12.4.1",

packages/snaps-controllers/jest.config.js

@@ -3,9 +3,12 @@ const deepmerge = require('deepmerge');
 const baseConfig = require('../../jest.config.base');
 
 delete baseConfig.coverageThreshold;
+delete baseConfig.coverageReporters;
 
 module.exports = deepmerge(baseConfig, {
   coverageDirectory: './coverage/jest',
+  coverageReporters: ['html', 'json-summary', 'json'],
+
   testTimeout: 10000,
 
   // This is required for `jest-fetch-mock` to work.

packages/snaps-controllers/package.json

@@ -74,8 +74,7 @@
     "test:browser": "vitest",
     "test:browser:firefox": "vitest --config ./vitest.config.firefox.mts",
     "test:clean": "jest --clearCache",
-    "test:post": "ts-node scripts/coverage.ts && rimraf coverage/jest coverage/vite",
-    "test:pre": "yarn mkdirp test/fixtures && ./scripts/generate-fixtures.sh",
+    "test:post": "tsx ../../scripts/update-coverage.mts && rimraf coverage/jest coverage/vite",
     "test:verbose": "jest --verbose",
     "test:watch": "jest --watch"
   },
@@ -132,16 +131,13 @@
     "deepmerge": "^4.2.2",
     "depcheck": "^1.4.7",
     "eslint": "^9.11.0",
-    "istanbul-lib-coverage": "^3.2.0",
-    "istanbul-lib-report": "^3.0.0",
-    "istanbul-reports": "^3.1.5",
     "jest": "^29.0.2",
     "jest-fetch-mock": "^3.0.3",
     "jest-silent-reporter": "^0.6.0",
-    "mkdirp": "^1.0.4",
     "prettier": "^3.3.3",
     "rimraf": "^4.1.2",
     "ts-node": "^10.9.1",
+    "tsx": "^4.19.1",
     "typescript": "~5.3.3",
     "vite": "^6.2.7",
     "vite-plugin-node-polyfills": "^0.23.0",

packages/snaps-controllers/scripts/generate-fixtures.sh

@@ -60,6 +60,7 @@ export default defineConfig({
       enabled: true,
 
       reportsDirectory: 'coverage/vite',
+      reporter: ['json', 'json-summary', 'html'],
 
       // Configure the coverage provider. We use `istanbul` instead of `v8`
       // because it seems to be more reliable.

packages/snaps-controllers/test/fixtures/metamask-template-snap-0.7.0.tgz

@@ -3,8 +3,11 @@ const deepmerge = require('deepmerge');
 const baseConfig = require('../../jest.config.base');
 
 delete baseConfig.coverageThreshold;
+delete baseConfig.coverageReporters;
 
 module.exports = deepmerge(baseConfig, {
+  coverageDirectory: './coverage/jest',
+  coverageReporters: ['html', 'json-summary', 'json'],
   coveragePathIgnorePatterns: [
     './src/index.ts',
     './src/iframe/index.ts',
@@ -13,7 +16,7 @@ module.exports = deepmerge(baseConfig, {
     './src/webworker/pool/index.ts',
     './src/common/test-utils',
   ],
-  coverageDirectory: './coverage/jest',
+
   testTimeout: 10000,
   testEnvironment: '<rootDir>/jest.environment.js',
   testEnvironmentOptions: {

packages/snaps-controllers/vitest.config.mts

@@ -330,7 +330,7 @@
     "eslint>chalk": {
       "packages": {
         "eslint>chalk>ansi-styles": true,
-        "istanbul-lib-report>supports-color": true
+        "eslint>chalk>supports-color": true
       }
     },
     "webpack>chrome-trace-event": {
@@ -416,7 +416,7 @@
       },
       "packages": {
         "eslint>debug>ms": true,
-        "istanbul-lib-report>supports-color": true
+        "eslint>chalk>supports-color": true
       }
     },
     "@lavamoat/webpack>json-stable-stringify>call-bind>set-function-length>define-data-property": {
@@ -488,7 +488,7 @@
         "atob": true
       }
     },
-    "@esbuild-plugins/node-globals-polyfill>esbuild": {
+    "tsx>esbuild": {
       "builtin": {
         "child_process.execFileSync": true,
         "child_process.spawn": true,
@@ -600,7 +600,7 @@
         "setTimeout": true
       }
     },
-    "istanbul-lib-report>supports-color>has-flag": {
+    "eslint>chalk>supports-color>has-flag": {
       "globals": {
         "process.argv": true
       }
@@ -1032,7 +1032,7 @@
         "@types/jest>pretty-format>ansi-regex": true
       }
     },
-    "istanbul-lib-report>supports-color": {
+    "eslint>chalk>supports-color": {
       "builtin": {
         "os.release": true,
         "tty.isatty": true
@@ -1042,7 +1042,7 @@
         "process.platform": true
       },
       "packages": {
-        "istanbul-lib-report>supports-color>has-flag": true
+        "eslint>chalk>supports-color>has-flag": true
       }
     },
     "webpack>terser-webpack-plugin>jest-worker>supports-color": {
@@ -1055,7 +1055,7 @@
         "process.platform": true
       },
       "packages": {
-        "istanbul-lib-report>supports-color>has-flag": true
+        "eslint>chalk>supports-color>has-flag": true
       }
     },
     "webpack>tapable": {
@@ -1095,7 +1095,7 @@
       "packages": {
         "terser>@jridgewell/source-map>@jridgewell/trace-mapping": true,
         "@swc/core": true,
-        "@esbuild-plugins/node-globals-polyfill>esbuild": true,
+        "tsx>esbuild": true,
         "webpack>terser-webpack-plugin>jest-worker": true,
         "webpack>schema-utils": true,
         "webpack>terser-webpack-plugin>serialize-javascript": true,

packages/snaps-execution-environments/jest.config.js

@@ -126,10 +126,10 @@
       "packages": {
         "eslint>debug>ms": true,
         "@metamask/providers>extension-port-stream>readable-stream>process": true,
-        "istanbul-lib-report>supports-color": true
+        "eslint>chalk>supports-color": true
       }
     },
-    "istanbul-lib-report>supports-color>has-flag": {
+    "eslint>chalk>supports-color>has-flag": {
       "globals": {
         "process.argv": true
       },
@@ -192,7 +192,7 @@
         "readable-stream>string_decoder>safe-buffer": true
       }
     },
-    "istanbul-lib-report>supports-color": {
+    "eslint>chalk>supports-color": {
       "builtin": {
         "os.release": true,
         "tty.isatty": true
@@ -202,7 +202,7 @@
         "process.platform": true
       },
       "packages": {
-        "istanbul-lib-report>supports-color>has-flag": true,
+        "eslint>chalk>supports-color>has-flag": true,
         "@metamask/providers>extension-port-stream>readable-stream>process": true
       }
     },