feat: handle method errors

Author: antongolub

packages/expressjs/src/main/ts/index.ts

@@ -13,8 +13,13 @@ import {
   parseJsonRpcObject,
   IParsedObjectRequest,
   RequestObject,
+  error,
+  success,
+  JsonRpcError,
 } from '@qiwi/json-rpc-common'
 
+export * from '@qiwi/json-rpc-common'
+
 export const enum JsonRpcDecoratorType {
   REQUEST = 'request',
   ID = 'id',
@@ -36,14 +41,36 @@ export function JsonRpcMiddleware(): ClassDecorator {
 
           if (jsonRpc.type === 'request') {
             const {params, handler} = (this.constructor as any).resolveHandler(this, jsonRpc)
-            const result = handler
-              ? handler.apply(this, params)
-              : {}
+            const {payload: {id, method}} = jsonRpc
+
+            if (!handler) {
+              res.status(200).send(error(id, JsonRpcError.methodNotFound(method)))
+
+              return
+            }
 
-            res.status(200).send(result)
+            const result = (this.constructor as any).handleResult(handler.apply(this, params))
+            const jsonRpcResponse = result instanceof JsonRpcError
+              ? error(id, result)
+              : success(id, result)
+
+            res.status(200).send(jsonRpcResponse)
           }
 
         }
+
+        static handleResult(result: any): any {
+          if (result instanceof JsonRpcError) {
+            return result
+          }
+
+          if (result instanceof Error) {
+            return new JsonRpcError(result.message || '', 0)
+          }
+
+          return result
+        }
+
         static resolveHandler(instance: Extended, jsonRpc: IParsedObjectRequest): {handler: Function, params: any[]} | {[key: string]: any} {
 
           const _method = jsonRpc.payload.method

packages/expressjs/src/test/ts/index.ts

@@ -3,6 +3,7 @@ import {
   JsonRpcMiddleware,
   RpcId,
   JsonRpcParams,
+  JsonRpcError,
 } from '../../main/ts'
 
 import reqresnext from 'reqresnext'
@@ -34,6 +35,11 @@ describe('expressjs-json-rpc', () => {
         return {foo: 'quxr', id, a, b}
       }
 
+      @JsonRpcMethod('get-some-error')
+      getSomeError() {
+        return new JsonRpcError('Some error', -100000)
+      }
+
     }
 
     const controller = new SomeJsonRpcController()
@@ -55,7 +61,11 @@ describe('expressjs-json-rpc', () => {
       mware(req, res)
 
       expect(res.statusCode).toBe(200)
-      expect(res.body).toBe(JSON.stringify({foo: 'quxr', id: '123', a: 'a', b: 2}))
+      expect(res.body).toBe(JSON.stringify({
+        jsonrpc: '2.0',
+        id: '123',
+        result: {foo: 'quxr', id: '123', a: 'a', b: 2},
+      }))
     })
 
     it('finds proper method', () => {
@@ -74,7 +84,58 @@ describe('expressjs-json-rpc', () => {
       mware(req, res)
 
       expect(res.statusCode).toBe(200)
-      expect(res.body).toBe(JSON.stringify({foo: 'bar', id: '123'}))
+      expect(res.body).toBe(JSON.stringify({
+        jsonrpc: '2.0',
+        id: '123',
+        result: {foo: 'bar', id: '123'},
+      }))
+    })
+
+    it('returns error if method does not exist', () => {
+      const {req, res} = reqresnext({
+        body: {
+          jsonrpc: '2.0',
+          method: 'foobar',
+          id: '111',
+          params: {},
+        },
+      })
+
+      mware(req, res)
+
+      expect(res.statusCode).toBe(200)
+      expect(res.body).toBe(JSON.stringify({
+        jsonrpc: '2.0',
+        id: '111',
+        error: {
+          message: 'Method not found',
+          code: -32601,
+          data: 'foobar',
+        },
+      }))
+    })
+
+    it('returns error if method returns JsonRpcError', () => {
+      const {req, res} = reqresnext({
+        body: {
+          jsonrpc: '2.0',
+          method: 'get-some-error',
+          id: '111',
+          params: {},
+        },
+      })
+
+      mware(req, res)
+
+      expect(res.statusCode).toBe(200)
+      expect(res.body).toBe(JSON.stringify({
+        jsonrpc: '2.0',
+        id: '111',
+        error: {
+          message: 'Some error',
+          code: -100000,
+        },
+      }))
     })
   })
 })

packages/nestjs/src/test/ts/decorators.ts

@@ -75,7 +75,11 @@ describe('decorators', () => {
           },
         })
         .expect(HttpStatus.OK)
-        .expect({foo: 'quxr', id: '123', a: 'a', b: 2})
+        .expect({
+          jsonrpc: '2.0',
+          id: '123',
+          result: {foo: 'quxr', id: '123', a: 'a', b: 2},
+        })
     })
 
     it('finds proper method', () => {
@@ -85,10 +89,14 @@ describe('decorators', () => {
           jsonrpc: '2.0',
           method: 'test1',
           id: '123',
-          params: null
+          params: {},
         })
         .expect(HttpStatus.OK)
-        .expect({foo: 'bar', id: '123'})
+        .expect({
+          jsonrpc: '2.0',
+          id: '123',
+          result: {foo: 'bar', id: '123'},
+        })
     })
   })
 })