Simplify and upgrade expected RpcService type

`createFetchMiddleware` needs to declare that it takes an `RpcService`,
but it cannot get a type from `@metamask/network-controller` or else
this would create a circular dependency. Currently this package contains
a copy of `AbstractRpcService` from `@metamask/network-controller`
22.2.0, but there are a couple of problems: 1) this type is not
compatible with the latest version of the package, and 2) we want to
avoid further incompatibilities in the future.

This PR changes the signature for `createFetchMiddleware` so that it
requires a simplified version of `RpcService` — one that only contains a
`request` method. It also upgrades the dev dependency on
`@metamask/network-controller` to 24.1.0.

Author: mcmire

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **BREAKING:** `createFetchMiddleware` no longer takes `fetch`, `btoa`, `rpcUrl`, and `originHttpHeaderKey` ([#402](https://github.com/MetaMask/eth-json-rpc-middleware/pull/402))
   - The existing signature (`rpcService` and `options`) is now the only way to use this function; please use that instead.
+- **BREAKING:** `createFetchMiddleware` now takes an RPC service object that must be compatible with `@metamask/network-controller` 24.x and `@metamask/utils` 11.x ([#403](https://github.com/MetaMask/eth-json-rpc-middleware/pull/403))
+  - On the other hand, the only required property for this object now is `request`; all other properties will be ignored.
 - Bump `@metamask/utils` to `^11.7.0` ([#404](https://github.com/MetaMask/eth-json-rpc-middleware/pull/404))
 
 ### Removed

package.json

@@ -46,11 +46,12 @@
     "@jest/globals": "^27.5.1",
     "@lavamoat/allow-scripts": "^3.0.4",
     "@metamask/auto-changelog": "^3.1.0",
+    "@metamask/error-reporting-service": "^2.0.0",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",
     "@metamask/eslint-config-typescript": "^12.1.0",
-    "@metamask/network-controller": "22.2.0",
+    "@metamask/network-controller": "^24.1.0",
     "@types/btoa": "^1.2.3",
     "@types/jest": "^27.4.1",
     "@types/node": "^18.16",

src/fetch.test.ts

@@ -2,7 +2,7 @@ import { JsonRpcEngine } from '@metamask/json-rpc-engine';
 import type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';
 
 import { createFetchMiddleware } from './fetch';
-import type { AbstractRpcService } from './types';
+import type { AbstractRpcServiceRequestMethod } from './types';
 
 describe('createFetchMiddleware', () => {
   it('calls the RPC service with the correct request headers and body when no `originHttpHeaderKey` option given', async () => {
@@ -236,7 +236,7 @@ describe('createFetchMiddleware', () => {
  *
  * @returns The fake failover service.
  */
-function buildRpcService(): AbstractRpcService {
+function buildRpcService(): { request: AbstractRpcServiceRequestMethod } {
   return {
     async request<Params extends JsonRpcParams, Result extends Json>(
       jsonRpcRequest: JsonRpcRequest<Params>,
@@ -248,26 +248,5 @@ function buildRpcService(): AbstractRpcService {
         result: 'ok' as Result,
       };
     },
-    onRetry() {
-      return {
-        dispose() {
-          // do nothing
-        },
-      };
-    },
-    onBreak() {
-      return {
-        dispose() {
-          // do nothing
-        },
-      };
-    },
-    onDegraded() {
-      return {
-        dispose() {
-          // do nothing
-        },
-      };
-    },
   };
 }

src/fetch.ts

@@ -3,7 +3,7 @@ import { createAsyncMiddleware } from '@metamask/json-rpc-engine';
 import { rpcErrors } from '@metamask/rpc-errors';
 import type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';
 
-import type { AbstractRpcService } from './types';
+import type { AbstractRpcServiceRequestMethod } from './types';
 
 /**
  * Like a JSON-RPC request, but includes an optional `origin` property.
@@ -20,6 +20,7 @@ type JsonRpcRequestWithOrigin<Params extends JsonRpcParams> =
  *
  * @param args - The arguments to this function.
  * @param args.rpcService - The RPC service to use.
+ * @param args.rpcService.request - The `request` method of the RPC service.
  * @param args.options - Options.
  * @param args.options.originHttpHeaderKey - If provided, the origin field for
  * each JSON-RPC request will be attached to each outgoing fetch request under
@@ -30,7 +31,7 @@ export function createFetchMiddleware({
   rpcService,
   options = {},
 }: {
-  rpcService: AbstractRpcService;
+  rpcService: { request: AbstractRpcServiceRequestMethod };
   options?: {
     originHttpHeaderKey?: string;
   };

src/types.test-d.ts

@@ -1,9 +1,11 @@
 import type { AbstractRpcService as NetworkControllerAbstractRpcService } from '@metamask/network-controller';
 import { expectAssignable } from 'tsd';
 
-import type { AbstractRpcService as LocalAbstractRpcService } from './types';
+import type { AbstractRpcServiceRequestMethod } from './types';
 
 // Confirm that the AbstractRpcService in this repo is compatible with the same
 // one in `@metamask/network-controller` (from where it was copied)
-declare const rpcService: LocalAbstractRpcService;
-expectAssignable<NetworkControllerAbstractRpcService>(rpcService);
+declare const rpcServiceMethod: AbstractRpcServiceRequestMethod;
+expectAssignable<NetworkControllerAbstractRpcService['request']>(
+  rpcServiceMethod,
+);

src/types.ts

@@ -30,61 +30,19 @@ export type BlockCache = Record<string, Block>;
 export type Cache = Record<number, BlockCache>;
 
 /**
- * The interface for a service class responsible for making a request to an RPC
- * endpoint.
+ * A copy of the type for the `request` method from `AbstractRpcService` in
+ *`@metamask/network-controller`.
+ *
+ * We cannot get this directly from `@metamask/network-controller` because
+ * relying on this package would create a circular dependency.
+ *
+ * This type should be accurate as of `@metamask/network-controller` 24.x and
+ * `@metamask/utils` 11.x.
  */
-export type AbstractRpcService = {
-  /**
-   * Listens for when the RPC service retries the request.
-   *
-   * @param listener - The callback to be called when the retry occurs.
-   * @returns A disposable.
-   */
-  onRetry: (
-    listener: (
-      data: ({ error: Error } | { value: unknown }) & {
-        delay: number;
-        attempt: number;
-        endpointUrl: string;
-      },
-    ) => void,
-  ) => {
-    dispose(): void;
-  };
-
-  /**
-   * Listens for when the RPC service retries the request too many times in a
-   * row.
-   *
-   * @param listener - The callback to be called when the circuit is broken.
-   * @returns A disposable.
-   */
-  onBreak: (
-    listener: (
-      data: ({ error: Error } | { value: unknown } | { isolated: true }) & {
-        endpointUrl: string;
-      },
-    ) => void,
-  ) => {
-    dispose(): void;
-  };
-
-  /**
-   * Listens for when the policy underlying this RPC service detects a slow
-   * request.
-   *
-   * @param listener - The callback to be called when the request is slow.
-   * @returns A disposable.
-   */
-  onDegraded: (listener: (data: { endpointUrl: string }) => void) => {
-    dispose(): void;
-  };
-
-  /**
-   * Makes a request to the RPC endpoint.
-   */
-  request<Params extends JsonRpcParams, Result extends Json>(
-    jsonRpcRequest: JsonRpcRequest<Params>,
-    fetchOptions?: RequestInit,
-  ): Promise<JsonRpcResponse<Result | null>>;
-};
+export type AbstractRpcServiceRequestMethod = <
+  Params extends JsonRpcParams,
+  Result extends Json,
+>(
+  jsonRpcRequest: JsonRpcRequest<Params>,
+  fetchOptions?: RequestInit,
+) => Promise<JsonRpcResponse<Result | null>>;