Node.js: Add serverAssisted to ClientSideCache for Phase 2 server-assisted caching

Signed-off-by: affonsov <67347924+affonsov@users.noreply.github.com>

Author: affonsov

java/client/src/test/java/glide/api/models/configuration/BaseClientConfigurationTest.java

@@ -2,8 +2,10 @@
 package glide.api.models.configuration;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -150,4 +152,14 @@ public void testNodeDiscoveryModeDiscoverAll() {
                         .build();
         assertEquals(NodeDiscoveryMode.DISCOVER_ALL, config.getNodeDiscoveryMode());
     }
+
+    @Test
+    void testServerAssistedCacheConfig() {
+        ClientSideCache cache =
+                ClientSideCache.builder().maxCacheKb(1024).entryTtlMs(0).serverAssisted(true).build();
+        assertTrue(cache.isServerAssisted());
+
+        ClientSideCache cacheDefault = ClientSideCache.builder().maxCacheKb(1024).entryTtlMs(0).build();
+        assertFalse(cacheDefault.isServerAssisted());
+    }
 }

node/src/BaseClient.ts

@@ -96,6 +96,7 @@ import {
     createBitField,
     createBitOp,
     createBitPos,
+    createClientTrackingInfo,
     createCopy,
     createDecr,
     createDecrBy,
@@ -9246,6 +9247,17 @@ export class BaseClient {
         return this.createWritePromise(createSort(key, options, destination));
     }
 
+    /**
+     * Returns information about the current client connection's tracking state.
+     *
+     * @see {@link https://valkey.io/commands/client-trackinginfo/|valkey.io} for details.
+     *
+     * @returns A map of tracking info.
+     */
+    public async clientTrackingInfo(): Promise<Record<string, unknown>> {
+        return this.createWritePromise(createClientTrackingInfo());
+    }
+
     /**
      * @internal
      */
@@ -9329,6 +9341,7 @@ export class BaseClient {
                 entryTtlMs: cache.entryTtlMs,
                 evictionPolicy: cache.evictionPolicy,
                 enableMetrics: cache.enableMetrics,
+                serverAssisted: cache.serverAssisted,
             });
         }
 

node/src/Batch.ts

@@ -88,6 +88,7 @@ import {
     createBitPos,
     createClientGetName,
     createClientId,
+    createClientTrackingInfo,
     createConfigGet,
     createConfigResetStat,
     createConfigRewrite,
@@ -530,6 +531,15 @@ export class BaseBatch<T extends BaseBatch<T>> {
         return this.addAndReturn(createClientGetName());
     }
 
+    /** Returns information about the current client connection's tracking state.
+     * @see {@link https://valkey.io/commands/client-trackinginfo/|valkey.io} for details.
+     *
+     * Command Response - A map of tracking info.
+     */
+    public clientTrackingInfo(): T {
+        return this.addAndReturn(createClientTrackingInfo());
+    }
+
     /**
      * Rewrites the configuration file with the current configuration.
      *

node/src/ClientSideCache.ts

@@ -33,6 +33,12 @@ export interface ClientSideCacheConfig {
      * Defaults to false if not specified.
      */
     enableMetrics?: boolean;
+
+    /**
+     * Whether to use server-assisted (invalidation-based) caching mode.
+     * Defaults to false if not specified.
+     */
+    serverAssisted?: boolean;
 }
 
 /**
@@ -48,6 +54,11 @@ export interface ClientSideCacheOptions {
      * Whether to enable metrics collection for this cache.
      */
     enableMetrics?: boolean;
+
+    /**
+     * Whether to use server-assisted (invalidation-based) caching mode.
+     */
+    serverAssisted?: boolean;
 }
 
 /**
@@ -99,6 +110,11 @@ export class ClientSideCache {
      */
     readonly enableMetrics: boolean;
 
+    /**
+     * Whether server-assisted caching mode is enabled.
+     */
+    readonly serverAssisted: boolean;
+
     /**
      * Creates a new ClientSideCache instance.
      *
@@ -122,6 +138,7 @@ export class ClientSideCache {
         this.entryTtlMs = config.entryTtlMs;
         this.evictionPolicy = config.evictionPolicy;
         this.enableMetrics = config.enableMetrics ?? false;
+        this.serverAssisted = config.serverAssisted ?? false;
     }
 
     /**
@@ -156,6 +173,7 @@ export class ClientSideCache {
             entryTtlMs,
             evictionPolicy: options?.evictionPolicy,
             enableMetrics: options?.enableMetrics,
+            serverAssisted: options?.serverAssisted,
         });
     }
 }

node/src/Commands.ts

@@ -428,6 +428,13 @@ export function createClientId(): command_request.Command {
     return createCommand(RequestType.ClientId, []);
 }
 
+/**
+ * @internal
+ */
+export function createClientTrackingInfo(): command_request.Command {
+    return createCommand(RequestType.ClientTrackingInfo, []);
+}
+
 /**
  * @internal
  */

node/src/GlideClusterClient.ts

@@ -34,6 +34,7 @@ import {
     LolwutOptions,
     createClientGetName,
     createClientId,
+    createClientTrackingInfo,
     createConfigGet,
     createConfigResetStat,
     createConfigRewrite,
@@ -1063,6 +1064,26 @@ export class GlideClusterClient extends BaseClient {
         ).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
 
+    /**
+     * Returns information about the current client connection's tracking state.
+     *
+     * @see {@link https://valkey.io/commands/client-trackinginfo/|valkey.io} for details.
+     *
+     * @param options - (Optional) See {@link RouteOption}.
+     *
+     * @returns A map of tracking info. When specifying a route other than a single node,
+     *     it returns a dictionary where each address is the key and its corresponding node response is the value.
+     */
+    public async clientTrackingInfo(
+        options?: RouteOption,
+    ): Promise<ClusterResponse<Record<string, unknown>>> {
+        return this.createWritePromise<
+            ClusterGlideRecord<Record<string, unknown>>
+        >(createClientTrackingInfo(), options).then((res) =>
+            convertClusterGlideRecord(res, true, options?.route),
+        );
+    }
+
     /**
      * Rewrites the configuration file with the current configuration.
      *

node/tests/ClientSideCache.test.ts

@@ -29,6 +29,21 @@ const TIMEOUT = 50000;
 const CLEANUP_TIMEOUT = 10000;
 
 describe("ClientSideCache", () => {
+    it("ClientSideCache with serverAssisted", () => {
+        const cache = new ClientSideCache({
+            maxCacheKb: 1024,
+            entryTtlMs: 0,
+            serverAssisted: true,
+        });
+        expect(cache.serverAssisted).toBe(true);
+
+        const cacheDefault = new ClientSideCache({
+            maxCacheKb: 1024,
+            entryTtlMs: 0,
+        });
+        expect(cacheDefault.serverAssisted).toBe(false);
+    });
+
     let standaloneCluster: ValkeyCluster;
     let clusterCluster: ValkeyCluster;
 

python/tests/sync_tests/test_sync_client_side_cache.py

@@ -569,3 +569,15 @@ def test_sync_cache_entry_ttl_ms_validation(self):
         # Negative should raise
         with pytest.raises(ValueError, match="entry_ttl_ms must be non-negative"):
             ClientSideCache.create(max_cache_kb=1, entry_ttl_ms=-1)
+
+    def test_server_assisted_cache_config(self):
+        """Verify ClientSideCache server_assisted field is correctly set."""
+        cache = ClientSideCache(
+            cache_id="test", max_cache_kb=1, entry_ttl_ms=0, server_assisted=True
+        )
+        assert cache.server_assisted is True
+
+        cache_default = ClientSideCache(
+            cache_id="test2", max_cache_kb=1, entry_ttl_ms=0
+        )
+        assert cache_default.server_assisted is False