refactor!: Migrate eth-json-rpc-middleware to JsonRpcEngineV2 (#7065)

Migrates `@metamask/eth-json-rpc-middleware` to the `JsonRpcEngineV2`
conventions in a total overhaul of the package. The semantics of each
middleware should be the same as before.

One potential behavioral difference is that request cloning within
middleware now occurs with `klona` instead of `klona/full`. This is
because `klona/full` copies property descriptors such that cloned
requests are immutable but not frozen in the `Object.isFrozen()` sense.
This is unlikely to make a difference in practice to us, since our
request objects have historically been "plain" objects.

As with all #6327-related work up to this point, `json-rpc-engine`
received minor refactors to facilitate the use of the new abstractions
_in situ_.

Incidentally, all lint rule exceptions have been removed and all lint
warnings and errors have been resolved for `eth-json-rpc-middleware`.

Several other packages are changed to support or in consequence of the
migration:
- `network-controller`
  - The `NetworkClient` is migrated to `JsonRpcEngineV2`.
- The `RpcService` now uses `Readonly<JsonRpcRequest>` internally for
request objects received via its `request()` method, since the "fetch"
middleware now passes it deeply frozen request objects directly.
- `message-manager` and `signature-controller`
- Minor changes to types in order to harmonize them with the new
conventions.

Author: rekmarks

eslint-warning-thresholds.json

@@ -115,84 +115,6 @@
   "packages/eth-block-tracker/tests/withBlockTracker.ts": {
     "@typescript-eslint/no-explicit-any": 1
   },
-  "packages/eth-json-rpc-middleware/src/block-cache.ts": {
-    "@typescript-eslint/no-explicit-any": 1,
-    "jsdoc/require-jsdoc": 1,
-    "no-restricted-syntax": 1
-  },
-  "packages/eth-json-rpc-middleware/src/block-ref-rewrite.test.ts": {
-    "@typescript-eslint/no-misused-promises": 3
-  },
-  "packages/eth-json-rpc-middleware/src/block-ref-rewrite.ts": {
-    "jsdoc/match-description": 1
-  },
-  "packages/eth-json-rpc-middleware/src/block-ref.test.ts": {
-    "jest/expect-expect": 2
-  },
-  "packages/eth-json-rpc-middleware/src/block-ref.ts": {
-    "jsdoc/require-jsdoc": 1
-  },
-  "packages/eth-json-rpc-middleware/src/block-tracker-inspector.ts": {
-    "jsdoc/match-description": 1,
-    "jsdoc/require-jsdoc": 1
-  },
-  "packages/eth-json-rpc-middleware/src/fetch.test.ts": {
-    "jsdoc/match-description": 1
-  },
-  "packages/eth-json-rpc-middleware/src/fetch.ts": {
-    "jsdoc/match-description": 1
-  },
-  "packages/eth-json-rpc-middleware/src/inflight-cache.ts": {
-    "@typescript-eslint/no-explicit-any": 1,
-    "jsdoc/require-jsdoc": 4
-  },
-  "packages/eth-json-rpc-middleware/src/methods/wallet-request-execution-permissions.ts": {
-    "jsdoc/require-jsdoc": 1
-  },
-  "packages/eth-json-rpc-middleware/src/methods/wallet-revoke-execution-permission.ts": {
-    "jsdoc/require-jsdoc": 1
-  },
-  "packages/eth-json-rpc-middleware/src/providerAsMiddleware.ts": {
-    "jsdoc/require-jsdoc": 1
-  },
-  "packages/eth-json-rpc-middleware/src/retryOnEmpty.test.ts": {
-    "jsdoc/match-description": 3
-  },
-  "packages/eth-json-rpc-middleware/src/retryOnEmpty.ts": {
-    "jsdoc/match-description": 2
-  },
-  "packages/eth-json-rpc-middleware/src/utils/cache.ts": {
-    "jsdoc/match-description": 6
-  },
-  "packages/eth-json-rpc-middleware/src/utils/common.ts": {
-    "jsdoc/match-description": 1
-  },
-  "packages/eth-json-rpc-middleware/src/utils/error.ts": {
-    "jsdoc/require-jsdoc": 1
-  },
-  "packages/eth-json-rpc-middleware/src/utils/normalize.ts": {
-    "jsdoc/match-description": 3
-  },
-  "packages/eth-json-rpc-middleware/src/utils/timeout.ts": {
-    "jsdoc/match-description": 1
-  },
-  "packages/eth-json-rpc-middleware/src/utils/validation.ts": {
-    "jsdoc/require-jsdoc": 4
-  },
-  "packages/eth-json-rpc-middleware/src/wallet.ts": {
-    "@typescript-eslint/no-explicit-any": 2,
-    "@typescript-eslint/prefer-nullish-coalescing": 5,
-    "jsdoc/match-description": 3,
-    "jsdoc/require-jsdoc": 12
-  },
-  "packages/eth-json-rpc-middleware/test/setupAfterEnv.ts": {
-    "@typescript-eslint/no-explicit-any": 3,
-    "jsdoc/match-description": 2
-  },
-  "packages/eth-json-rpc-middleware/test/util/helpers.ts": {
-    "@typescript-eslint/no-explicit-any": 5,
-    "jsdoc/match-description": 11
-  },
   "packages/gas-fee-controller/src/GasFeeController.test.ts": {
     "import-x/namespace": 2
   },
@@ -219,7 +141,7 @@
     "jsdoc/check-tag-names": 1
   },
   "packages/message-manager/src/AbstractMessageManager.ts": {
-    "jsdoc/check-tag-names": 25
+    "jsdoc/check-tag-names": 23
   },
   "packages/message-manager/src/DecryptMessageManager.ts": {
     "jsdoc/check-tag-names": 11
@@ -236,9 +158,6 @@
   "packages/name-controller/src/util.ts": {
     "jsdoc/require-returns": 1
   },
-  "packages/network-controller/src/NetworkController.ts": {
-    "@typescript-eslint/no-misused-promises": 1
-  },
   "packages/notification-services-controller/src/NotificationServicesController/NotificationServicesController.ts": {
     "@typescript-eslint/no-misused-promises": 1
   },

eslint.config.mjs

@@ -230,17 +230,6 @@ const config = createConfig([
       '@typescript-eslint/consistent-type-definitions': 'warn',
     },
   },
-  {
-    files: ['packages/eth-json-rpc-middleware/**/*.ts'],
-    rules: {
-      // TODO: Re-enable these rules or add inline ignores for warranted cases
-      '@typescript-eslint/no-explicit-any': 'warn',
-      '@typescript-eslint/prefer-nullish-coalescing': 'warn',
-      'jsdoc/match-description': 'warn',
-      'jsdoc/require-jsdoc': 'warn',
-      'no-restricted-syntax': 'warn',
-    },
-  },
   {
     files: ['packages/foundryup/**/*.{js,ts}'],
     rules: {

packages/eth-json-rpc-middleware/CHANGELOG.md

@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** Migrate to `JsonRpcEngineV2` ([#7065](https://github.com/MetaMask/core/pull/7065))
+  - Migrates all middleware from `JsonRpcEngine` to `JsonRpcEngineV2`.
+  - Signatures of various middleware dependencies, e.g. `processTransaction` of `createWalletMiddleware`, have changed
+    and must be updated by consumers.
+    - Be advised that request objects are now deeply frozen, and cannot be mutated.
+  - To continue using this package with the legacy `JsonRpcEngine`, use the `asLegacyMiddleware` backwards compatibility function.
 - **BREAKING:** Use `InternalProvider` instead of `SafeEventEmitterProvider` ([#6796](https://github.com/MetaMask/core/pull/6796))
   - Wherever a `SafeEventEmitterProvider` was expected, an `InternalProvider` is now expected instead.
 - **BREAKING:** Stop retrying `undefined` results for methods that include a block tag parameter ([#7001](https://github.com/MetaMask/core/pull/7001))

packages/eth-json-rpc-middleware/jest.config.js

@@ -20,7 +20,7 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 81.85,
+      branches: 81.49,
       functions: 90.66,
       lines: 89.13,
       statements: 89.2,

packages/eth-json-rpc-middleware/package.json

@@ -59,6 +59,7 @@
     "@metamask/eth-json-rpc-provider": "^5.0.1",
     "@metamask/eth-sig-util": "^8.2.0",
     "@metamask/json-rpc-engine": "^10.1.1",
+    "@metamask/message-manager": "^14.0.0",
     "@metamask/rpc-errors": "^7.0.2",
     "@metamask/superstruct": "^3.1.0",
     "@metamask/utils": "^11.8.1",
@@ -71,8 +72,10 @@
     "@metamask/error-reporting-service": "^3.0.0",
     "@metamask/network-controller": "^25.0.0",
     "@ts-bridge/cli": "^0.6.4",
+    "@types/deep-freeze-strict": "^1.1.0",
     "@types/jest": "^27.4.1",
     "@types/pify": "^5.0.2",
+    "deep-freeze-strict": "^1.1.1",
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
     "tsd": "^0.31.2",