add trace id to error response messages (#473)

* add trace id to error response messages

Signed-off-by: lukelee-sl <[email protected]>

* add newline

Signed-off-by: lukelee-sl <[email protected]>

* fix assertions to account for error message

Signed-off-by: lukelee-sl <[email protected]>

* address review comments

Signed-off-by: lukelee-sl <[email protected]>

* update JsonRpcError to use requestId if passed into the constructor

Signed-off-by: lukelee-sl <[email protected]>

Signed-off-by: lukelee-sl <[email protected]>

Author: lukelee-sl

packages/relay/src/lib/errors/JsonRpcError.ts

@@ -18,15 +18,16 @@
  *
  */
 
+const REQUEST_ID_STRING = `Request ID: `;
 export class JsonRpcError {
   public code: number;
   public message: string;
   public name: string;
 
-  constructor(args: { name: string, code: number, message: string }) {
+  constructor(args: { name: string, code: number, message: string }, requestId?: string) {
     this.code = args.code;
     this.name = args.name;
-    this.message = args.message;
+    this.message = requestId ? `[${REQUEST_ID_STRING}${requestId}] ` + args.message : args.message;
   }
 }
 

packages/server/src/server.ts

@@ -146,22 +146,28 @@ const logAndHandleResponse = async (methodName, methodFunction) => {
     ms = Date.now() - start;
     methodResponseHistogram.labels(methodName, status).observe(ms);
     logger.info(`${messagePrefix} ${status} ${ms} ms `);
+    if (response instanceof JsonRpcError) {
+      logger.error(`returning error to sender: ${requestIdPrefix} ${response.message}`)
+      return new JsonRpcError({name: response.name, code: response.code, message: response.message}, requestId);
+    } 
     return response;
   } catch (e: any) {
     ms = Date.now() - start;
     methodResponseHistogram.labels(methodName, responseInternalErrorCode).observe(ms);
     logger.error(e, `${messagePrefix} ${responseInternalErrorCode} ${ms} ms`);
 
+    let error = predefined.INTERNAL_ERROR;
     if (e instanceof MirrorNodeClientError) {
       if (e.isTimeout()) {
-        return predefined.REQUEST_TIMEOUT;
+        error = predefined.REQUEST_TIMEOUT;
       }
     }
     else if (e instanceof JsonRpcError) {
-      return e;
+      error = e;
     }
 
-    return predefined.INTERNAL_ERROR;
+    logger.error(`returning error to sender: ${requestIdPrefix} ${error.message}`)
+    return new JsonRpcError({name: error.name, code: error.code, message:error.message}, requestId);
   }
 };
 

packages/server/tests/helpers/assertions.ts

@@ -44,7 +44,7 @@ export default class Assertions {
 
     static unsupportedResponse = (resp: any) => {
         expect(resp.error.code).to.eq(-32601);
-        expect(resp.error.message).to.eq('Unsupported JSON-RPC method');
+        expect(resp.error.message.endsWith('Unsupported JSON-RPC method')).to.be.true;
     };
 
     static expectedError = () => {
@@ -201,7 +201,7 @@ export default class Assertions {
         expect(err).to.have.property('body');
 
         const parsedError = JSON.parse(err.body);
-        expect(parsedError.error.message).to.be.equal(expectedError.message);
+        expect(parsedError.error.message.endsWith(expectedError.message)).to.be.true;
         expect(parsedError.error.code).to.be.equal(expectedError.code);
     }
 

packages/server/tests/integration/server.spec.ts

@@ -350,7 +350,7 @@ class BaseTest {
     expect(response.data.error).to.have.property('code');
     expect(response.data.error.code).to.be.equal(code);
     expect(response.data.error).to.have.property('message');
-    expect(response.data.error.message).to.be.equal(message);
+    expect(response.data.error.message.endsWith(message)).to.be.true;
     if (name) {
       expect(response.data.error).to.have.property('name');
       expect(response.data.error.name).to.be.equal(name);

packages/server/tests/postman.json

@@ -604,7 +604,7 @@
 							"    var response = pm.response.json();",
 							"    pm.expect(response.error.code).to.equal(-32601);",
 							"    pm.expect(response.error.name).to.equal(\"Method not found\");",
-							"    pm.expect(response.error.message).to.equal(\"Unsupported JSON-RPC method\");",
+							"    pm.expect(response.error.message.endsWith(\"Unsupported JSON-RPC method\")).to.be.true;",
 							"    pm.expect(response.id).to.equal(\"test_id\");",
 							"    pm.expect(response.jsonrpc).to.equal(\"2.0\");",
 							"});",