BREAKING: Bump minimum Node.js version to ^18.16.0 (#1741)

This drops support for Node.js 16 (EOL), bumps the minimum Node.js version to `^18.16.0`, and adds support for Node.js 20. --------- Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
MetaMask · Oct 4, 2023 · 4342a50 · 4342a50
1 parent 5db6015
commit 4342a50
Show file tree

Hide file tree

Showing 66 changed files with 178 additions and 145 deletions.
diff --git a/.github/workflows/build-lint-test.yml b/.github/workflows/build-lint-test.yml
@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [18.x, 20.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
@@ -254,7 +254,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [18.x, 20.x]
         package-name: ${{ fromJson(needs.prepare.outputs.test-workspace-package-names) }}
     steps:
       - uses: actions/checkout@v3
@@ -281,7 +281,7 @@ jobs:
           echo "coverage-folder=$(yarn workspaces list --json | grep ${{ matrix.package-name }} | jq -r '.location')/coverage" >> "$GITHUB_OUTPUT"
         shell: bash
       - name: Upload coverage artifact
-        if: ${{ matrix.node-version == '16.x' }}
+        if: ${{ matrix.node-version == '18.x' }}
         uses: actions/upload-artifact@v3
         with:
           name: coverage
@@ -324,7 +324,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [18.x, 20.x]
         package-name: ${{ fromJson(needs.prepare.outputs.e2e-workspace-package-names) }}
     steps:
       - uses: actions/checkout@v3

diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-v18
+v20
diff --git a/constraints.pro b/constraints.pro
@@ -198,6 +198,9 @@ gen_enforced_field(WorkspaceCwd, 'scripts.lint:changelog', ChangelogValidationSc
 gen_enforced_field(WorkspaceCwd, 'scripts.lint:dependencies', 'depcheck') :-
   WorkspaceCwd \= '.'.
 
+% The "engines.node" field must be the same for all packages.
+gen_enforced_field(WorkspaceCwd, 'engines.node', '^18.16 || >=20').
+
 % Ensure all examples have the same scripts.
 gen_enforced_field(WorkspaceCwd, 'scripts.build', 'mm-snap build') :-
   is_example(WorkspaceCwd),

diff --git a/package.json b/package.json
@@ -105,7 +105,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "lavamoat": {
     "allowScripts": {

diff --git a/packages/create-snap/package.json b/packages/create-snap/package.json
@@ -85,7 +85,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/create-snap/src/main.test.ts b/packages/create-snap/src/main.test.ts
@@ -14,5 +14,8 @@ describe('main', () => {
     expect(cli).toHaveBeenCalledTimes(1);
     expect(cli).toHaveBeenCalledWith(process.argv);
     expect(process.exitCode).toBe(1);
+
+    // Reset the exit code so that the test doesn't fail.
+    process.exitCode = 0;
   });
 });
diff --git a/packages/examples/package.json b/packages/examples/package.json
@@ -51,6 +51,6 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   }
 }
diff --git a/packages/examples/packages/bip32/package.json b/packages/examples/packages/bip32/package.json
@@ -71,7 +71,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/bip44/package.json b/packages/examples/packages/bip44/package.json
@@ -71,7 +71,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/browserify-plugin/package.json b/packages/examples/packages/browserify-plugin/package.json
@@ -67,7 +67,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/browserify/package.json b/packages/examples/packages/browserify/package.json
@@ -67,7 +67,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/cronjobs/package.json b/packages/examples/packages/cronjobs/package.json
@@ -68,7 +68,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/dialogs/package.json b/packages/examples/packages/dialogs/package.json
@@ -68,7 +68,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/errors/package.json b/packages/examples/packages/errors/package.json
@@ -65,7 +65,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/ethereum-provider/package.json b/packages/examples/packages/ethereum-provider/package.json
@@ -67,7 +67,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/ethers-js/package.json b/packages/examples/packages/ethers-js/package.json
@@ -70,7 +70,7 @@
     "webpack": "^5.88.0"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/get-entropy/package.json b/packages/examples/packages/get-entropy/package.json
@@ -69,7 +69,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/get-locale/package.json b/packages/examples/packages/get-locale/package.json
@@ -68,7 +68,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/invoke-snap/package.json b/packages/examples/packages/invoke-snap/package.json
@@ -49,7 +49,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/invoke-snap/packages/consumer-signer/package.json b/packages/examples/packages/invoke-snap/packages/consumer-signer/package.json
@@ -69,7 +69,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/invoke-snap/packages/core-signer/package.json b/packages/examples/packages/invoke-snap/packages/core-signer/package.json
@@ -72,7 +72,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/json-rpc/package.json b/packages/examples/packages/json-rpc/package.json
@@ -66,7 +66,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/lifecycle-hooks/package.json b/packages/examples/packages/lifecycle-hooks/package.json
@@ -66,7 +66,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/manage-state/package.json b/packages/examples/packages/manage-state/package.json
@@ -66,7 +66,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/name-lookup/package.json b/packages/examples/packages/name-lookup/package.json
@@ -66,7 +66,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/network-access/package.json b/packages/examples/packages/network-access/package.json
@@ -67,7 +67,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/notifications/package.json b/packages/examples/packages/notifications/package.json
@@ -66,7 +66,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/rollup-plugin/package.json b/packages/examples/packages/rollup-plugin/package.json
@@ -74,7 +74,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/transaction-insights/package.json b/packages/examples/packages/transaction-insights/package.json
@@ -67,7 +67,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/wasm/package.json b/packages/examples/packages/wasm/package.json
@@ -68,7 +68,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/examples/packages/webpack-plugin/package.json b/packages/examples/packages/webpack-plugin/package.json
@@ -71,7 +71,7 @@
     "webpack-cli": "^5.1.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/rpc-methods/package.json b/packages/rpc-methods/package.json
@@ -81,7 +81,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/rpc-methods/src/restricted/manageState.test.ts b/packages/rpc-methods/src/restricted/manageState.test.ts
@@ -5,6 +5,7 @@ import {
   MOCK_SNAP_ID,
   TEST_SECRET_RECOVERY_PHRASE_BYTES,
 } from '@metamask/snaps-utils/test-utils';
+import { webcrypto } from 'crypto';
 import { ethErrors } from 'eth-rpc-errors';
 
 import {
@@ -14,15 +15,16 @@ import {
   specificationBuilder,
 } from './manageState';
 
-Object.defineProperty(global, 'crypto', {
-  value: {
-    /* eslint-disable @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires */
-    ...require('crypto').webcrypto,
-    subtle: require('crypto').webcrypto.subtle,
-    /* eslint-enable @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires */
-    getRandomValues: (input: Uint8Array) => input.fill(0),
-  },
-});
+globalThis.crypto ??= webcrypto as typeof globalThis.crypto;
+globalThis.crypto.getRandomValues = <Type extends ArrayBufferView | null>(
+  array: Type,
+) => {
+  if (array === null) {
+    return null as Type;
+  }
+
+  return new Uint8Array(array.buffer).fill(0) as unknown as Type;
+};
 
 // Encryption key for `MOCK_SNAP_ID`.
 const ENCRYPTION_KEY =

diff --git a/packages/snaps-browserify-plugin/package.json b/packages/snaps-browserify-plugin/package.json
@@ -78,7 +78,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/snaps-cli/jest.config.js b/packages/snaps-cli/jest.config.js
@@ -16,4 +16,5 @@ module.exports = deepmerge(baseConfig, {
   clearMocks: true,
   resetMocks: false,
   restoreMocks: false,
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
 });
diff --git a/packages/snaps-cli/jest.setup.ts b/packages/snaps-cli/jest.setup.ts
@@ -0,0 +1,10 @@
+// Node.js v20 changes the behaviour of `process.exit`, which causes the actual
+// test process to exit with a non-zero exit code. To avoid CI failures, we
+// reset the exit code before and after each test.
+beforeEach(() => {
+  process.exitCode = 0;
+});
+
+afterEach(() => {
+  process.exitCode = 0;
+});
diff --git a/packages/snaps-cli/package.json b/packages/snaps-cli/package.json
@@ -136,7 +136,7 @@
     "typescript": "~4.8.4"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": "^18.16 || >=20"
   },
   "publishConfig": {
     "access": "public",

diff --git a/packages/snaps-cli/tsconfig.json b/packages/snaps-cli/tsconfig.json
@@ -3,7 +3,7 @@
   "compilerOptions": {
     "baseUrl": "./"
   },
-  "include": ["./src", "./src/**/*.json", "test"],
+  "include": ["./src", "./src/**/*.json", "jest.setup.ts"],
   "references": [
     { "path": "../snaps-utils" },
     { "path": "../snaps-browserify-plugin" },