feat: Add Pipeline Set (#2222)

* feat: add pipeline set

Signed-off-by: georgi-l95 <[email protected]>

* test: add unit tests

Signed-off-by: georgi-l95 <[email protected]>

* feat: add changes to readme and helm charts

Signed-off-by: georgi-l95 <[email protected]>

* feat: fix chart lint

Signed-off-by: georgi-l95 <[email protected]>

---------

Signed-off-by: georgi-l95 <[email protected]>

Author: georgi-l95

charts/hedera-json-rpc-relay-websocket/templates/configmap.yaml

@@ -25,3 +25,4 @@ data:
   REDIS_ENABLED: {{ .Values.config.REDIS_ENABLED | quote }}
   REDIS_URL: {{ .Values.config.REDIS_URL | quote }}
   REDIS_RECONNECT_DELAY_MS: {{ .Values.config.REDIS_RECONNECT_DELAY_MS | quote }}
+  MULTI_SET: {{ .Values.config.MULTI_SET | quote }}

charts/hedera-json-rpc-relay-websocket/values.yaml

@@ -32,7 +32,7 @@ config:
   REDIS_ENABLED: false
   REDIS_URL: ''
   REDIS_RECONNECT_DELAY_MS: 1000
-
+  MULTI_SET: true
 # -- Extra environment variables from existing secrets or configmaps
 extraEnvFrom: []
 # - secretRef:

charts/hedera-json-rpc-relay/templates/configmap.yaml

@@ -38,3 +38,4 @@ data:
   REDIS_RECONNECT_DELAY_MS: {{ .Values.config.REDIS_RECONNECT_DELAY_MS | quote }}
   DEBUG_API_ENABLED: {{ .Values.config.DEBUG_API_ENABLED | quote }}
   FILTER_API_ENABLED: {{ .Values.config.FILTER_API_ENABLED | quote }}
+  MULTI_SET: {{ .Values.config.MULTI_SET | quote }}

charts/hedera-json-rpc-relay/value-test.yaml

@@ -134,6 +134,7 @@ config:
   REDIS_RECONNECT_DELAY_MS: 1000
   DEBUG_API_ENABLED: false
   FILTER_API_ENABLED: true
+  MULTI_SET: true
 
 # Enable rolling_restarts if SDK calls fail this is usually due to stale connections that get cycled on restart
 rolling_restart:

charts/hedera-json-rpc-relay/values.yaml

@@ -52,6 +52,7 @@ config:
   REDIS_RECONNECT_DELAY_MS: 1000
   DEBUG_API_ENABLED: false
   FILTER_API_ENABLED: true
+  MULTI_SET: true
 
 # -- Extra environment variables from existing secrets or configmaps
 extraEnvFrom: []

docs/configuration.md

@@ -94,6 +94,7 @@ Unless you need to set a non-default value, it is recommended to only populate o
 | `DEBUG_API_ENABLED`                     | "false"                  | Enables all debug related methods: `debug_traceTransaction`                                                                                                                                                                                                                                            
 | `REDIS_ENABLED`                         | "true"                   | Enable usage of Redis as shared cache                                                                                                                                                                                                                                                                  |
 | `REDIS_URL`                             | "redis://127.0.0.1:6379" | Sets the url for the Redis shared cache                                                                                                                                                                                                                                                                |
+| `MULTI_SET`                             | "true"                   | Switch between different implementation of setting multiple K/V pairs in the shared cache. True is mSet, false is pipeline                                                                                                                                                                             |
 | `REDIS_RECONNECT_DELAY_MS`              | "1000"                   | Sets the delay between reconnect retries from the Redis client in ms                                                                                                                                                                                                                                   |
 | `SEND_RAW_TRANSACTION_SIZE_LIMIT`       | "131072"                 | Sets the limit of the transaction size the relay accepts on eth_sendRawTransaction                                                                                                                                                                                                                     
 ## WS-Server

packages/relay/src/lib/clients/cache/ICacheClient.ts

@@ -24,4 +24,10 @@ export interface ICacheClient {
   delete(key: string, callingMethod: string, requestIdPrefix?: string): void;
   clear(): void;
   multiSet(keyValuePairs: Record<string, any>, callingMethod: string, requestIdPrefix?: string): void;
+  pipelineSet(
+    keyValuePairs: Record<string, any>,
+    callingMethod: string,
+    ttl?: number | undefined,
+    requestIdPrefix?: string,
+  ): void;
 }

packages/relay/src/lib/clients/cache/localLRUCache.ts

@@ -144,6 +144,27 @@ export class LocalLRUCache implements ICacheClient {
     }
   }
 
+  /**
+   * Stores multiple key-value pairs in the cache.
+   *
+   * @param keyValuePairs - An object where each property is a key and its value is the value to be cached.
+   * @param callingMethod - The name of the calling method.
+   * @param ttl - Time to live on the set values
+   * @param requestIdPrefix - Optional request ID prefix for logging.
+   * @returns {void} A Promise that resolves when the values are cached.
+   */
+  public pipelineSet(
+    keyValuePairs: Record<string, any>,
+    callingMethod: string,
+    ttl?: number,
+    requestIdPrefix?: string,
+  ): void {
+    // Iterate over each entry in the keyValuePairs object
+    for (const [key, value] of Object.entries(keyValuePairs)) {
+      this.set(key, value, callingMethod, ttl, requestIdPrefix);
+    }
+  }
+
   /**
    * Deletes a cached value associated with the given key.
    * Logs the deletion of the cache entry.

packages/relay/src/lib/clients/cache/redisCache.ts

@@ -160,6 +160,38 @@ export class RedisCache implements ICacheClient {
     this.logger.trace(`${requestIdPrefix} caching multiple keys via ${callingMethod}, total keys: ${entriesLength}`);
   }
 
+  /**
+   * Stores multiple key-value pairs in the cache using pipelining.
+   *
+   * @param keyValuePairs - An object where each property is a key and its value is the value to be cached.
+   * @param callingMethod - The name of the calling method.
+   * @param {number} [ttl] - The time-to-live (expiration) of the cache item in milliseconds.
+   * @param requestIdPrefix - Optional request ID prefix for logging.
+   * @returns {Promise<void>} A Promise that resolves when the values are cached.
+   */
+  async pipelineSet(
+    keyValuePairs: Record<string, any>,
+    callingMethod: string,
+    ttl?: number | undefined,
+    requestIdPrefix?: string,
+  ): Promise<void> {
+    const resolvedTtl = (ttl ?? this.options.ttl) / 1000; // convert to seconds
+
+    const pipeline = this.client.multi();
+
+    for (const [key, value] of Object.entries(keyValuePairs)) {
+      const serializedValue = JSON.stringify(value);
+      pipeline.setEx(key, resolvedTtl, serializedValue);
+    }
+
+    // Execute pipeline operation
+    await pipeline.execAsPipeline();
+
+    // Log the operation
+    const entriesLength = Object.keys(keyValuePairs).length;
+    this.logger.trace(`${requestIdPrefix} caching multiple keys via ${callingMethod}, total keys: ${entriesLength}`);
+  }
+
   /**
    * Deletes a value from the cache.
    *

packages/relay/src/lib/eth.ts

@@ -2137,7 +2137,13 @@ export class EthImpl implements Eth {
     }
     // cache the whole array using mSet
     if (Object.keys(keyValuePairs).length > 0) {
-      this.cacheService.multiSet(keyValuePairs, EthImpl.ethGetBlockByHash, requestIdPrefix, true);
+      this.cacheService.multiSet(
+        keyValuePairs,
+        EthImpl.ethGetBlockByHash,
+        this.syntheticLogCacheTtl,
+        requestIdPrefix,
+        true,
+      );
     }
   }