feat(request-node): Add Request Node version and Request Client version to requests header

packages/request-node/src/requestNode.ts

@@ -15,11 +15,15 @@ import ipfsAdd from './request/ipfsAdd';
 import PersistTransaction from './request/persistTransaction';
 import { getEthereumStorage } from './storageUtils';
 
+const packageJson = require('../package.json');
+
 const NOT_FOUND_MESSAGE =
   'Not found\nAvailable endpoints:\n/POST persistTransaction\n/GET getTransactionsByChannelId\n/GET getChannelsByTopic\n/POST /ipfsAdd\nGET getConfirmedTransaction';
 
 const NOT_INITIALIZED_MESSAGE = 'The node is not initialized';
 
+const REQUEST_NODE_VERSION_HEADER = 'Request-Node-Version';
+
 /**
  * Main class for request node express server
  * This class defines routes to handle requests from client
@@ -37,6 +41,7 @@ class RequestNode {
   private logger: LogTypes.ILogger;
   private persistTransaction: PersistTransaction;
   private confirmedTransactionStore: ConfirmedTransactionStore;
+  private requestNodeVersion: string;
   /**
    * Request Node constructor
    *
@@ -73,6 +78,9 @@ class RequestNode {
 
     this.express = express();
     this.mountRoutes();
+
+    // Get the version of the Request Node for the request's response header
+    this.requestNodeVersion = packageJson.version;
   }
 
   /**
@@ -141,6 +149,12 @@ class RequestNode {
       });
     }
 
+    // Set the Request Node version to the header
+    this.express.use((_: any, res: any, next: any) => {
+      res.header(REQUEST_NODE_VERSION_HEADER, this.requestNodeVersion),
+      next();
+    });
+
     // Supported encodings
     this.express.use(express.json());
     this.express.use(express.urlencoded({ extended: true }));

packages/request-node/test/requestNode.test.ts

@@ -10,6 +10,9 @@ import requestNode from '../src/requestNode';
 chai.use(chaiAsPromised);
 const expect = chai.expect;
 
+const packageJson = require('../package.json');
+const requestNodeVersion = packageJson.version;
+
 const dataAccessInitializeFailureMock = async (): Promise<never> => {
   throw Error('This mock function always fails');
 };
@@ -99,6 +102,16 @@ describe('requestNode server', () => {
       .expect('x-custom-test-header', 'test-passed');
   });
 
+  it('the response header contains the Request Node version', async () => {
+    // Import directly requestNode to create a server
+    requestNodeInstance = new requestNode();
+    server = requestNodeInstance.listen(3002, () => 0);
+
+    await request(server)
+      .post('/')
+      .expect('Request-Node-Version', requestNodeVersion);
+  });
+
   it('must throw if no mnemonic given with rinkeby', async () => {
     process.env.ETHEREUM_NETWORK_ID = '4';