Add request-id as part of all response headers (#1683)

* Add request-id as part of all response headers

Signed-off-by: Alfredo Gutierrez <[email protected]>

* changed `request-id` header key name for `X-Request-Id` to better comply with standard conventions, also, moved it to a const so changed in future is easier.

Signed-off-by: Alfredo Gutierrez <[email protected]>

* fix tests

Signed-off-by: Alfredo Gutierrez <[email protected]>

* fix tests

Signed-off-by: Alfredo Gutierrez <[email protected]>

---------

Signed-off-by: Alfredo Gutierrez <[email protected]>

Author: AlfredoG87

packages/server/src/koaJsonRpc/index.ts

@@ -48,8 +48,9 @@ const INTERNAL_ERROR = "INTERNAL ERROR";
 const INVALID_PARAMS_ERROR = "INVALID PARAMS ERROR";
 const INVALID_REQUEST = "INVALID REQUEST";
 const IP_RATE_LIMIT_EXCEEDED = "IP RATE LIMIT EXCEEDED";
-const JSON_RPC_ERROR = "JSON RPC ERROR"
+const JSON_RPC_ERROR = "JSON RPC ERROR";
 const METHOD_NOT_FOUND = "METHOD NOT FOUND";
+const REQUEST_ID_HEADER_NAME = "X-Request-Id";
 
 const responseSuccessStatusCode = '200';
 
@@ -97,6 +98,7 @@ export default class KoaJsonRpc {
       let body, result;
 
       this.requestId = ctx.state.reqId;
+      ctx.set(REQUEST_ID_HEADER_NAME, this.requestId);
 
       if (this.token) {
         const headerToken = ctx.get('authorization').split(' ').pop();

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

@@ -1799,6 +1799,13 @@ class BaseTest {
     });
   }
 
+  static validRequestIdCheck(response) {
+    const requestIdHeaderName = "X-Request-Id".toLowerCase();
+    expect(response.headers, `Default response: headers should have '${requestIdHeaderName}' property`).to.have.property(requestIdHeaderName);
+    expect(response.headers[requestIdHeaderName], `Default response: 'headers[${requestIdHeaderName}]' should not be null`).not.to.be.null;
+    expect(response.headers[requestIdHeaderName], `Default response: 'headers[${requestIdHeaderName}]' should not be undefined`).not.to.be.undefined;
+  }
+
   static validResponseCheck(response, options:any = {status: 200, statusText: 'OK'}) {
     expect(response.status).to.eq(options.status);
     expect(response.statusText).to.eq(options.statusText);
@@ -1815,6 +1822,7 @@ class BaseTest {
   static defaultResponseChecks(response) {
     BaseTest.validResponseCheck(response);
     BaseTest.validCorsCheck(response);
+    BaseTest.validRequestIdCheck(response);
     expect(response, "Default response: Should have 'data' property").to.have.property('data');
     expect(response.data, "Default response: 'data' should have 'id' property").to.have.property('id');
     expect(response.data, "Default response: 'data' should have 'jsonrpc' property").to.have.property('jsonrpc');
@@ -1825,6 +1833,7 @@ class BaseTest {
   }
 
   static errorResponseChecks(response, code, message, name?) {
+    BaseTest.validRequestIdCheck(response);
     expect(response, "Error response: should have 'data' property").to.have.property('data');
     expect(response.data, "Error response: 'data' should have 'id' property").to.have.property('id');
     expect(response.data, "Error response: 'data' should have 'jsonrpc' property").to.have.property('jsonrpc');
@@ -1860,6 +1869,7 @@ class BaseTest {
   }
 
   static invalidRequestSpecError(response: any, code: number, message: string) {
+    BaseTest.validRequestIdCheck(response);
     expect(response.status).to.eq(400);
     expect(response.statusText).to.eq('Bad Request');
     expect(response, "Default response: Should have 'data' property").to.have.property('data');