Cherry Pick HttpAgent and Bump 0.21.2 (#1083)

* Add http Agent support with Keep Aiive configs (#1082)

- cherry pick Add http Agent support with Keep Aiive configs #1082
- bump 0.21.2

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

Author: Nana-EC

docker-compose.yml

@@ -2,7 +2,7 @@ version: "3.7"
 services:
   relay:
     container_name:  hedera-jspn-rpc-relay
-    image: "ghcr.io/hashgraph/hedera-json-rpc-relay:0.21.1"
+    image: "ghcr.io/hashgraph/hedera-json-rpc-relay:0.21.2"
     restart: "unless-stopped"
     ports:
       - 7546:7546

docs/openrpc.json

@@ -3,7 +3,7 @@
     "info": {
         "title": "Hedera JSON-RPC Specification",
         "description": "A specification of the implemented Ethereum JSON RPC APIs interface for Hedera clients and adheres to the Ethereum execution APIs schema.",
-        "version": "0.21.1"
+        "version": "0.21.2"
     },
     "methods": [
         {

helm-chart/Chart.yaml

@@ -2,6 +2,6 @@ apiVersion: v2
 name: hedera-json-rpc-relay
 description: Helm chart deployment of the hashgraph/hedera-json-rpc-relay
 type: application
-version: 0.21.1
-appVersion: "0.21.1"
+version: 0.21.2
+appVersion: "0.21.2"
 home: https://github.com/hashgraph/hedera-json-rpc-relay

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@hashgraph/json-rpc-relay",
-    "version": "0.21.1",
+    "version": "0.21.2",
     "description": "Hedera Hashgraph implementation of Ethereum JSON RPC APIs. Utilises both the Hedera Consensus Nodes and the Mirror Nodes for transaction management and information retrieval",
     "types": "dist/index.d.ts",
     "main": "dist/index.js",

packages/relay/package.json

@@ -18,14 +18,16 @@
  *
  */
 
-import Axios, { AxiosInstance } from 'axios';
+import Axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
 import { MirrorNodeClientError } from './../errors/MirrorNodeClientError';
 import { Logger } from "pino";
 import constants from './../constants';
 import { Histogram, Registry } from 'prom-client';
 import { formatRequestIdMessage, formatTransactionId } from '../../formatters';
 import axiosRetry from 'axios-retry';
 import { predefined } from "../errors/JsonRpcError";
+const http = require('http');
+const https = require('https');
 const LRU = require('lru-cache');
 
 type REQUEST_METHODS = 'GET' | 'POST';
@@ -113,23 +115,53 @@ export class MirrorNodeClient {
     protected createAxiosClient(
         baseUrl: string
     ): AxiosInstance {
+        // defualt values for axios clients to mirror node
+        const mirrorNodeTimeout = parseInt(process.env.MIRROR_NODE_TIMEOUT || '10000');
+        const mirrorNodeMaxRedirects = parseInt(process.env.MIRROR_NODE_MAX_REDIRECTS || '5');
+        const mirrorNodeHttpKeepAlive = process.env.MIRROR_NODE_HTTP_KEEP_ALIVE === 'true' ? true : false;
+        const mirrorNodeHttpKeepAliveMsecs = parseInt(process.env.MIRROR_NODE_HTTP_KEEP_ALIVE_MSECS || '1000');
+        const mirrorNodeHttpMaxSockets = parseInt(process.env.MIRROR_NODE_HTTP_MAX_SOCKETS || '100');
+        const mirrorNodeHttpMaxTotalSockets = parseInt(process.env.MIRROR_NODE_HTTP_MAX_TOTAL_SOCKETS || '100');
+        const mirrorNodeHttpSocketTimeout = parseInt(process.env.MIRROR_NODE_HTTP_SOCKET_TIMEOUT || '60000');
+        const isDevMode = process.env.DEV_MODE && process.env.DEV_MODE === 'true';
+        const mirrorNodeRetries = parseInt(process.env.MIRROR_NODE_RETRIES!) || 3;
+        const mirrorNodeRetriesDevMode = parseInt(process.env.MIRROR_NODE_RETRIES_DEVMODE!) || 5;
+        const mirrorNodeRetryDelay = parseInt(process.env.MIRROR_NODE_RETRY_DELAY!) || 250;
+        const mirrorNodeRetryDelayDevMode = parseInt(process.env.MIRROR_NODE_RETRY_DELAY_DEVMODE!) || 200;
+
         const axiosClient: AxiosInstance = Axios.create({
             baseURL: baseUrl,
             responseType: 'json' as const,
             headers: {
                 'Content-Type': 'application/json'
             },
-            timeout: parseInt(process.env.MIRROR_NODE_TIMEOUT || '10000')
+            timeout: mirrorNodeTimeout,
+            maxRedirects: mirrorNodeMaxRedirects,
+            // set http agent options to optimize performance - https://nodejs.org/api/http.html#new-agentoptions
+            httpAgent: new http.Agent({ 
+                keepAlive: mirrorNodeHttpKeepAlive,
+                keepAliveMsecs: mirrorNodeHttpKeepAliveMsecs,
+                maxSockets: mirrorNodeHttpMaxSockets,
+                maxTotalSockets: mirrorNodeHttpMaxTotalSockets,
+                timeout: mirrorNodeHttpSocketTimeout,
+            }),
+            httpsAgent: new https.Agent({ 
+                keepAlive: mirrorNodeHttpKeepAlive,
+                keepAliveMsecs: mirrorNodeHttpKeepAliveMsecs,
+                maxSockets: mirrorNodeHttpMaxSockets,
+                maxTotalSockets: mirrorNodeHttpMaxTotalSockets,
+                timeout: mirrorNodeHttpSocketTimeout,
+            }),
         });
         //@ts-ignore
         axiosRetry(axiosClient, {
-            retries: parseInt(process.env.MIRROR_NODE_RETRIES!) || 3,
+            retries: isDevMode ? mirrorNodeRetriesDevMode : mirrorNodeRetries,
             retryDelay: (retryCount, error) => {
                 const request = error?.request?._header;
                 const requestId = request ? request.split('\n')[3].substring(11,47) : '';
                 const requestIdPrefix = formatRequestIdMessage(requestId);
-                const delay = (parseInt(process.env.MIRROR_NODE_RETRY_DELAY!) || 250) * retryCount;
-                this.logger.trace(`${requestIdPrefix} Retry delay ${delay} ms`);
+                const delay = isDevMode ? mirrorNodeRetryDelayDevMode : mirrorNodeRetryDelay * retryCount;
+                this.logger.trace(`${requestIdPrefix} Retry delay ${delay} ms`);                
                 return delay;
             },
             retryCondition: (error) => {
@@ -198,7 +230,7 @@ export class MirrorNodeClient {
         try {
             let response;
 
-            const axiosRequestConfig = {
+            const axiosRequestConfig: AxiosRequestConfig = {
                 headers:{
                     'requestId': requestId || ''
                 },
@@ -220,8 +252,13 @@ export class MirrorNodeClient {
             ms = Date.now() - start;
             const effectiveStatusCode = error.response?.status || MirrorNodeClientError.ErrorCodes[error.code] || MirrorNodeClient.unknownServerErrorHttpStatusCode;
             this.mirrorResponseHistogram.labels(pathLabel, effectiveStatusCode).observe(ms);
-            this.handleError(error, path, effectiveStatusCode, method, controller, allowedErrorStatuses, requestId);
+
+            // always abort the request on failure as the axios call can hang until the parent code/stack times out (might be a few minutes in a server-side applications)
+            controller.abort();
+
+            this.handleError(error, path, effectiveStatusCode, method, allowedErrorStatuses, requestId);
         }
+
         return null;
     }
 
@@ -234,12 +271,8 @@ export class MirrorNodeClient {
         return this.request(path, pathLabel, 'POST', data, allowedErrorStatuses, requestId);
     }
 
-    handleError(error: any, path: string, effectiveStatusCode: number, method: REQUEST_METHODS, controller: AbortController, allowedErrorStatuses?: number[], requestId?: string) {
-        const mirrorError = new MirrorNodeClientError(error, effectiveStatusCode);
-        if(mirrorError.isTimeout()){
-            controller.abort();
-        }
-
+    handleError(error: any, path: string, effectiveStatusCode: number, method: REQUEST_METHODS, allowedErrorStatuses?: number[], requestId?: string) {     
+        const mirrorError = new MirrorNodeClientError(error, effectiveStatusCode);   
         const requestIdPrefix = formatRequestIdMessage(requestId);
         if (allowedErrorStatuses && allowedErrorStatuses.length) {
             if (error.response && allowedErrorStatuses.indexOf(effectiveStatusCode) !== -1) {

packages/relay/src/lib/clients/mirrorNodeClient.ts

@@ -1,6 +1,6 @@
 {
     "name": "@hashgraph/json-rpc-server",
-    "version": "0.21.1",
+    "version": "0.21.2",
     "description": "Hedera Hashgraph Ethereum JSON RPC server. Accepts requests for Ethereum JSON RPC 2.0 APIs",
     "main": "dist/index.js",
     "keywords": [],

packages/server/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hashgraph/json-rpc-ws-server",
-    "version": "0.21.1",
+    "version": "0.21.2",
     "description": "Hedera Hashgraph Ethereum JSON RPC socket server. Accepts socket connections for the purpose of subscribing to real-time data.",
     "main": "dist/index.js",
     "keywords": [],