🎨 Remove unused config values and refactor

Author: priojeetpriyom

docker-compose.yml

@@ -151,8 +151,6 @@ services:
       - ENABLE_TESTING_MODE=${ENABLE_TESTING_MODE}
       - ENABLE_BLOCK_CACHING=${ENABLE_BLOCK_CACHING}
       - EXPIRY_IN_HOURS=${EXPIRY_IN_HOURS}
-      - CLIENT_INSTANTIATION_MAX_WAIT_TIME=${CLIENT_INSTANTIATION_MAX_WAIT_TIME}
-      - CLIENT_INSTANTIATION_RETRY_INTERVAL=${CLIENT_INSTANTIATION_RETRY_INTERVAL}
       - CLIENT_ALIVE_ASSUMPTION_TIME=${CLIENT_ALIVE_ASSUMPTION_TIME}
       - HEARTBEAT_ACK_MAX_WAIT_TIME=${HEARTBEAT_ACK_MAX_WAIT_TIME}
       - ENDPOINT_INVOKE_MAX_RETRIES=${ENDPOINT_INVOKE_MAX_RETRIES}

docker/example.env

@@ -28,8 +28,6 @@
 ## Lisk Service Blockchain Connector
 
 # GENESIS_BLOCK_URL='https://downloads.lisk.com/lisk/mainnet/genesis_block.json.tar.gz'
-# CLIENT_INSTANTIATION_MAX_WAIT_TIME=5000
-# CLIENT_INSTANTIATION_RETRY_INTERVAL=1
 # CLIENT_ALIVE_ASSUMPTION_TIME=5000
 # HEARTBEAT_ACK_MAX_WAIT_TIME=1000
 # ENDPOINT_INVOKE_MAX_RETRIES=3

docs/antora/modules/ROOT/pages/configuration/index.adoc

@@ -401,18 +401,6 @@ To disable it, set it to `false`.
 By default, it is set to `12` hours.
 | 12
 
-| `CLIENT_INSTANTIATION_MAX_WAIT_TIME`
-| number
-| Maximum wait time (in milliseconds) for the API client instantiation before forcefully instantiating a new client when getApiClient is invoked.
-By default, it is set to `5000`.
-| 5000
-
-| `CLIENT_INSTANTIATION_RETRY_INTERVAL`
-| number
-| Retry interval (in milliseconds) to invoke instantiate API client when getApiClient is invoked.
-By default, it is set to `1`.
-| 1
-
 | `CLIENT_ALIVE_ASSUMPTION_TIME`
 | number
 | Interval (in milliseconds) for which the WS API Client is assumed to be alive since the last ping/pong success check.

ecosystem.config.js

@@ -127,8 +127,6 @@ module.exports = {
 				// SERVICE_LOG_FILE: false,
 				// DOCKER_HOST: 'local',
 				// GENESIS_BLOCK_URL: 'https://downloads.lisk.com/lisk/mainnet/genesis_block.json.tar.gz',
-				// CLIENT_INSTANTIATION_MAX_WAIT_TIME: 5000,
-				// CLIENT_INSTANTIATION_RETRY_INTERVAL: 1,
 				// CLIENT_ALIVE_ASSUMPTION_TIME: 5 * 1000,
 				// HEARTBEAT_ACK_MAX_WAIT_TIME: 1000,
 				// ENDPOINT_INVOKE_MAX_RETRIES: 3,

jenkins/docker-compose.nightly.yml

@@ -153,8 +153,6 @@ services:
       - ENABLE_TESTING_MODE=${ENABLE_TESTING_MODE}
       - ENABLE_BLOCK_CACHING=${ENABLE_BLOCK_CACHING}
       - EXPIRY_IN_HOURS=${EXPIRY_IN_HOURS}
-      - CLIENT_INSTANTIATION_MAX_WAIT_TIME=${CLIENT_INSTANTIATION_MAX_WAIT_TIME}
-      - CLIENT_INSTANTIATION_RETRY_INTERVAL=${CLIENT_INSTANTIATION_RETRY_INTERVAL}
       - CLIENT_ALIVE_ASSUMPTION_TIME=${CLIENT_ALIVE_ASSUMPTION_TIME}
       - ENDPOINT_INVOKE_MAX_RETRIES=${ENDPOINT_INVOKE_MAX_RETRIES}
       - ENDPOINT_INVOKE_RETRY_DELAY=${ENDPOINT_INVOKE_RETRY_DELAY}

services/blockchain-connector/README.md

@@ -34,8 +34,6 @@ A list of the most commonly used environment variables is presented below:
 - `GEOIP_JSON`: URL of GeoIP server.
 - `ENABLE_BLOCK_CACHING`: Boolean flag to enable the block caching. Enabled by default. To disable, set it to `false`.
 - `EXPIRY_IN_HOURS`: Expiry time (in hours) for block cache. By default, it is set to 12.
-- `CLIENT_INSTANTIATION_MAX_WAIT_TIME`: Maximum wait time (in milliseconds) for the API client instantiation before forcefully instantiating a new client when getApiClient is invoked. By default, it is set to 5000.
-- `CLIENT_INSTANTIATION_RETRY_INTERVAL`: Retry interval (in milliseconds) to invoke instantiate API client when getApiClient is invoked. By default, it is set to 5.
 - `CLIENT_ALIVE_ASSUMPTION_TIME`: Interval (in milliseconds) for which the WS API Client is assumed to be alive since the last ping/pong success check. By default, it is set to 5000.
 - `HEARTBEAT_ACK_MAX_WAIT_TIME`: Maximum time (in milliseconds) within which the checkIsClientAlive's algorithm expects a corresponding `pong` for the `ping` sent to the WS server. By default, it is set to 1000.
 - `ENDPOINT_INVOKE_MAX_RETRIES`: Maximum number of endpoint invocation request retries to the node. By default, it is set to 3.

services/blockchain-connector/config.js

@@ -115,12 +115,7 @@ config.job = {
 config.apiClient = {
 	heartbeatAckMaxWaitTime: Number(process.env.HEARTBEAT_ACK_MAX_WAIT_TIME) || 1000, // in millisecs
 	aliveAssumptionTime: Number(process.env.CLIENT_ALIVE_ASSUMPTION_TIME) || 5 * 1000, // in millisecs
-	aliveAssumptionTimeBeforeGenesis: 30 * 1000,
-	wsConnectionLimit: 10,
-	instantiation: {
-		maxWaitTime: Number(process.env.CLIENT_INSTANTIATION_MAX_WAIT_TIME) || 5 * 1000, // in millisecs
-		retryInterval: Number(process.env.CLIENT_INSTANTIATION_RETRY_INTERVAL) || 1, // in millisecs
-	},
+	connectionLimit: 5,
 	request: {
 		maxRetries: Number(process.env.ENDPOINT_INVOKE_MAX_RETRIES) || 3,
 		retryDelay: Number(process.env.ENDPOINT_INVOKE_RETRY_DELAY) || 10, // in millisecs

services/blockchain-connector/shared/sdk/client.js

@@ -28,7 +28,7 @@ const NUM_REQUEST_RETRIES = config.apiClient.request.maxRetries;
 const ENDPOINT_INVOKE_RETRY_DELAY = config.apiClient.request.retryDelay;
 const CLIENT_ALIVE_ASSUMPTION_TIME = config.apiClient.aliveAssumptionTime;
 const HEARTBEAT_ACK_MAX_WAIT_TIME = config.apiClient.heartbeatAckMaxWaitTime;
-const CACHED_CLIENT_COUNT = 5;
+const CONNECTION_LIMIT = config.apiClient.connectionLimit;
 
 // Pool of cached api clients
 const cachedApiClients = [];
@@ -80,10 +80,10 @@ const checkIsClientAlive = async clientCache =>
 	}).catch(() => false);
 
 const instantiateAndCacheClient = async () => {
-	if (cachedApiClients.length > CACHED_CLIENT_COUNT) {
+	if (cachedApiClients.length > CONNECTION_LIMIT) {
 		// TODO: Down level log to debug
 		logger.info(
-			`Skipping API client instantiation as cached API client count(${cachedApiClients.length}) is greater than CACHED_CLIENT_COUNT(${CACHED_CLIENT_COUNT}).`,
+			`Skipping API client instantiation as cached API client count(${cachedApiClients.length}) is greater than CONNECTION_LIMIT(${CONNECTION_LIMIT}).`,
 		);
 		return;
 	}
@@ -171,7 +171,7 @@ const refreshClientsCache = async () => {
 	}
 
 	// Initiate new clients if necessary
-	let missingClientCount = CACHED_CLIENT_COUNT - cachedApiClients.length;
+	let missingClientCount = CONNECTION_LIMIT - cachedApiClients.length;
 
 	while (missingClientCount-- > 0) {
 		try {