deps: Switch from json-rpc-engine to @metamask/json-rpc-engine (#16)

* deps: @metamask/safe-event-emitter@^2.0.0->^3.0.0 * deps: migrate from json-rpc-engine to @metamask/json-rpc-engine
MetaMask · Jul 20, 2023 · b6d1502 · b6d1502
1 parent 3fa7c4f
commit b6d1502
Show file tree

Hide file tree

Showing 8 changed files with 245 additions and 977 deletions.
diff --git a/package.json b/package.json
@@ -25,8 +25,9 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/safe-event-emitter": "^2.0.0",
-    "json-rpc-engine": "^6.1.0"
+    "@metamask/json-rpc-engine": "^7.0.0",
+    "@metamask/safe-event-emitter": "^3.0.0",
+    "@metamask/utils": "^5.0.1"
   },
   "devDependencies": {
     "@lavamoat/allow-scripts": "^2.0.3",

diff --git a/src/provider-from-engine.test.ts b/src/provider-from-engine.test.ts
@@ -1,4 +1,4 @@
-import { JsonRpcEngine } from 'json-rpc-engine';
+import { JsonRpcEngine } from '@metamask/json-rpc-engine';
 import { promisify } from 'util';
 
 import { providerFromEngine } from './provider-from-engine';

diff --git a/src/provider-from-engine.ts b/src/provider-from-engine.ts
@@ -1,4 +1,4 @@
-import type { JsonRpcEngine } from 'json-rpc-engine';
+import type { JsonRpcEngine } from '@metamask/json-rpc-engine';
 
 import { SafeEventEmitterProvider } from './safe-event-emitter-provider';
 

diff --git a/src/provider-from-middleware.test.ts b/src/provider-from-middleware.test.ts
@@ -1,16 +1,11 @@
-import { JsonRpcMiddleware } from 'json-rpc-engine';
+import { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
 import { promisify } from 'util';
 
 import { providerFromMiddleware } from './provider-from-middleware';
 
 describe('providerFromMiddleware', () => {
   it('handle a successful request', async () => {
-    const middleware: JsonRpcMiddleware<unknown, unknown> = (
-      _req,
-      res,
-      _next,
-      end,
-    ) => {
+    const middleware: JsonRpcMiddleware<any, any> = (_req, res, _next, end) => {
       res.result = 42;
       end();
     };

diff --git a/src/provider-from-middleware.ts b/src/provider-from-middleware.ts
@@ -1,5 +1,6 @@
-import { JsonRpcEngine } from 'json-rpc-engine';
-import type { JsonRpcMiddleware } from 'json-rpc-engine';
+import { JsonRpcEngine } from '@metamask/json-rpc-engine';
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
+import type { Json, JsonRpcParams } from '@metamask/utils';
 
 import { providerFromEngine } from './provider-from-engine';
 import type { SafeEventEmitterProvider } from './safe-event-emitter-provider';
@@ -10,9 +11,10 @@ import type { SafeEventEmitterProvider } from './safe-event-emitter-provider';
  * @param middleware - The middleware to construct a provider from.
  * @returns An Ethereum provider.
  */
-export function providerFromMiddleware(
-  middleware: JsonRpcMiddleware<unknown, unknown>,
-): SafeEventEmitterProvider {
+export function providerFromMiddleware<
+  Params extends JsonRpcParams,
+  Result extends Json,
+>(middleware: JsonRpcMiddleware<Params, Result>): SafeEventEmitterProvider {
   const engine: JsonRpcEngine = new JsonRpcEngine();
   engine.push(middleware);
   const provider: SafeEventEmitterProvider = providerFromEngine(engine);

diff --git a/src/safe-event-emitter-provider.test.ts b/src/safe-event-emitter-provider.test.ts
@@ -1,4 +1,4 @@
-import { JsonRpcEngine } from 'json-rpc-engine';
+import { JsonRpcEngine } from '@metamask/json-rpc-engine';
 import { promisify } from 'util';
 
 import { SafeEventEmitterProvider } from './safe-event-emitter-provider';
@@ -14,6 +14,7 @@ describe('SafeEventEmitterProvider', () => {
       // `json-rpc-engine` v6 does not support JSON-RPC notifications directly,
       // so this is the best way to emulate this behavior.
       // We should replace this with `await engine.handle(notification)` when we update to v7
+      // TODO: v7 is now integrated; fix this
       engine.emit('notification', 'test');
 
       expect(notificationListener).toHaveBeenCalledWith(null, 'test');

diff --git a/src/safe-event-emitter-provider.ts b/src/safe-event-emitter-provider.ts
@@ -1,5 +1,6 @@
+import type { JsonRpcEngine } from '@metamask/json-rpc-engine';
 import SafeEventEmitter from '@metamask/safe-event-emitter';
-import type { JsonRpcEngine, JsonRpcRequest } from 'json-rpc-engine';
+import type { JsonRpcRequest } from '@metamask/utils';
 
 /**
  * An Ethereum provider.
@@ -34,7 +35,7 @@ export class SafeEventEmitterProvider extends SafeEventEmitter {
    * @param callback - A function that is called upon the success or failure of the request.
    */
   sendAsync = (
-    req: JsonRpcRequest<unknown>,
+    req: JsonRpcRequest,
     callback: (error: unknown, providerRes?: any) => void,
   ) => {
     this.#engine.handle(req, callback);
@@ -51,7 +52,7 @@ export class SafeEventEmitterProvider extends SafeEventEmitter {
    * @param callback - A function that is called upon the success or failure of the request.
    */
   send = (
-    req: JsonRpcRequest<unknown>,
+    req: JsonRpcRequest,
     callback: (error: unknown, providerRes?: any) => void,
   ) => {
     if (typeof callback !== 'function') {