SET IFEQ command implemented in node + tests (#2909)

* IFEQ command implemented in node Signed-off-by: Maayan Shani <[email protected]> Signed-off-by: Maayan Shani <[email protected]> * lint Signed-off-by: Maayan Shani <[email protected]> Signed-off-by: Maayan Shani <[email protected]> * add checking for 8.1 version in tests Signed-off-by: Maayan Shani <[email protected]> * change variable name comparisonValue + fix docstring Signed-off-by: Maayan Shani <[email protected]> * changed setOptions to better type + docstring fixes Signed-off-by: Maayan Shani <[email protected]> * Add changelog Signed-off-by: Maayan Shani <[email protected]> * docstring + add test Signed-off-by: Maayan Shani <[email protected]> --------- Signed-off-by: Maayan Shani <[email protected]> Signed-off-by: Maayan Shani <[email protected]> Co-authored-by: Maayan Shani <[email protected]>
valkey-io · Jan 14, 2025 · 798dbef · 798dbef
1 parent 15c4636
commit 798dbef
Show file tree

Hide file tree

Showing 4 changed files with 152 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@
 * Java, Node, Python: Update documentation for CONFIG SET and CONFIG GET ([#2919](https://github.com/valkey-io/valkey-glide/pull/2919))
 * Go: Add `BZPopMin` ([#2849](https://github.com/valkey-io/valkey-glide/pull/2849))
 * Java: Add `RESP2` support ([#2383](https://github.com/valkey-io/valkey-glide/pull/2383))
+* Node: Add `IFEQ` option ([#2909](https://github.com/valkey-io/valkey-glide/pull/2909))
 
 #### Breaking Changes
 

diff --git a/node/src/BaseClient.ts b/node/src/BaseClient.ts
@@ -1473,7 +1473,8 @@ export class BaseClient {
      * @param value - The value to store with the given key.
      * @param options - (Optional) See {@link SetOptions} and {@link DecoderOption}.
      * @returns - If the value is successfully set, return OK.
-     * If value isn't set because of `onlyIfExists` or `onlyIfDoesNotExist` conditions, return null.
+     * If `conditional` in `options` is not set, the value will be set regardless of prior value existence.
+     * If value isn't set because of `onlyIfExists` or `onlyIfDoesNotExist` or `onlyIfEqual` conditions, return `null`.
      * If `returnOldValue` is set, return the old value as a string.
      *
      * @example
@@ -1493,6 +1494,13 @@ export class BaseClient {
      * // Example usage of get method to retrieve the value of a key
      * const result4 = await client.get("key");
      * console.log(result4); // Output: 'new_value' - Value wasn't modified back to being "value" because of "NX" flag.
+     *
+     * // Example usage of set method with conditional option IFEQ
+     * await client.set("key", "value we will compare to");
+     * const result5 = await client.set("key", "new_value", {conditionalSet: "onlyIfEqual", comparisonValue: "value we will compare to"});
+     * console.log(result5); // Output: 'OK' - Set "new_value" to "key" only if comparisonValue is equal to the current value of "key".
+     * const result6 = await client.set("key", "another_new_value", {conditionalSet: "onlyIfEqual", comparisonValue: "value we will compare to"});
+     * console.log(result6); // Output: `null` - Value wasn't set because the comparisonValue is not equal to the current value of "key". Value of "key" remains "new_value".
      * ```
      */
     public async set(

diff --git a/node/src/Commands.ts b/node/src/Commands.ts
@@ -124,15 +124,29 @@ export function createGetRange(
     ]);
 }
 
-export interface SetOptions {
-    /**
-     *  `onlyIfDoesNotExist` - Only set the key if it does not already exist.
-     * Equivalent to `NX` in the Valkey API. `onlyIfExists` - Only set the key if
-     * it already exist. Equivalent to `EX` in the Valkey API. if `conditional` is
-     * not set the value will be set regardless of prior value existence. If value
-     * isn't set because of the condition, return null.
-     */
-    conditionalSet?: "onlyIfExists" | "onlyIfDoesNotExist";
+export type SetOptions = (
+    | {
+          /**
+           * `onlyIfDoesNotExist` - Only set the key if it does not already exist.
+           * `NX` in the Valkey API.
+           *
+           * `onlyIfExists` - Only set the key if it already exists.
+           * `EX` in the Valkey API.
+           */
+          conditionalSet?: "onlyIfExists" | "onlyIfDoesNotExist";
+      }
+    | {
+          /**
+           * `onlyIfEqual` - Only set the key if the comparison value equals the current value of key.
+           * `IFEQ` in the Valkey API.
+           */
+          conditionalSet: "onlyIfEqual";
+          /**
+           * The value to compare the existing value with.
+           */
+          comparisonValue: GlideString;
+      }
+) & {
     /**
      * Return the old string stored at key, or nil if key did not exist. An error
      * is returned and SET aborted if the value stored at key is not a string.
@@ -151,7 +165,7 @@ export interface SetOptions {
               type: TimeUnit;
               count: number;
           };
-}
+};
 
 /**
  * @internal
@@ -168,6 +182,8 @@ export function createSet(
             args.push("XX");
         } else if (options.conditionalSet === "onlyIfDoesNotExist") {
             args.push("NX");
+        } else if (options.conditionalSet === "onlyIfEqual") {
+            args.push("IFEQ", options.comparisonValue);
         }
 
         if (options.returnOldValue) {

diff --git a/node/tests/SharedTests.ts b/node/tests/SharedTests.ts
@@ -8166,6 +8166,34 @@ export function runBaseTests(config: {
         expect(getNotExistingKey).toEqual(null);
     }
 
+    async function setWithOnlyIfEquals(client: BaseClient) {
+        const key = uuidv4();
+        const initialValue = uuidv4();
+        const newValue = uuidv4();
+        const setKey = await client.set(key, initialValue);
+        expect(setKey).toEqual("OK");
+        const getRes = await client.get(key);
+        expect(getRes).toEqual(initialValue);
+
+        // Attempt to set with a non-matching value (should fail -> return null)
+        const conditionalSetFailResponse = await client.set(key, newValue, {
+            conditionalSet: "onlyIfEqual",
+            comparisonValue: newValue,
+        });
+        expect(conditionalSetFailResponse).toEqual(null);
+
+        // Attempt to set with a matching value (should succeed -> return OK)
+        const conditionalSetSuccessResponse = await client.set(key, newValue, {
+            conditionalSet: "onlyIfEqual",
+            comparisonValue: initialValue,
+        });
+        expect(conditionalSetSuccessResponse).toEqual("OK");
+
+        // Retrieve the updated value of the key
+        const updatedGetResponse = await client.get(key);
+        expect(updatedGetResponse).toEqual(newValue);
+    }
+
     async function setWithOnlyIfNotExistOptions(client: BaseClient) {
         const key = uuidv4();
         const value = uuidv4();
@@ -8233,9 +8261,54 @@ export function runBaseTests(config: {
         expect(await client.get(key)).toEqual(null);
     }
 
-    async function testSetWithAllCombination(client: BaseClient) {
+    async function setIfeqWithAllOptions(client: BaseClient) {
         const key = uuidv4();
-        const value = uuidv4();
+        const initialValue = uuidv4();
+        const newValue = uuidv4();
+
+        await client.set(key, initialValue);
+        // set with multiple options:
+        // * only apply SET if the provided value equals oldValue
+        // * expires after 1 second
+        // * returns the old value
+        const setResWithAllOptions = await client.set(key, newValue, {
+            expiry: {
+                type: TimeUnit.UnixSeconds,
+                count: Math.floor(Date.now() / 1000) + 1,
+            },
+            conditionalSet: "onlyIfEqual",
+            comparisonValue: initialValue,
+            returnOldValue: true,
+        });
+        // initialValue should be get from the key
+        expect(setResWithAllOptions).toEqual(initialValue);
+        // newValue should be set as the key value
+        expect(await client.get(key)).toEqual(newValue);
+
+        // fail command
+        const wrongValue = "wrong value";
+        const setResFailedWithAllOptions = await client.set(key, wrongValue, {
+            expiry: {
+                type: TimeUnit.UnixSeconds,
+                count: Math.floor(Date.now() / 1000) + 1,
+            },
+            conditionalSet: "onlyIfEqual",
+            comparisonValue: wrongValue,
+            returnOldValue: true,
+        });
+        // current value of key should be newValue
+        expect(setResFailedWithAllOptions).toEqual(newValue);
+        // key should not be set. it remains the same
+        expect(await client.get(key)).toEqual(newValue);
+    }
+
+    async function testSetWithAllCombination(
+        client: BaseClient,
+        cluster: ValkeyCluster,
+    ) {
+        const key = uuidv4();
+        const value = uuidv4(); // Initial value
+        const value2 = uuidv4(); // New value for IFEQ testing
         const count = 2;
         const expiryCombination = [
             { type: TimeUnit.Seconds, count },
@@ -8246,6 +8319,7 @@ export function runBaseTests(config: {
         ];
         let exist = false;
 
+        // onlyIfDoesNotExist tests
         for (const expiryVal of expiryCombination) {
             const setRes = await client.set(key, value, {
                 expiry: expiryVal as
@@ -8272,6 +8346,7 @@ export function runBaseTests(config: {
             expect(getRes).toEqual(value);
         }
 
+        // OnlyIfExist tests
         for (const expiryVal of expiryCombination) {
             const setRes = await client.set(key, value, {
                 expiry: expiryVal as
@@ -8291,18 +8366,55 @@ export function runBaseTests(config: {
 
             expect(setRes).toBeDefined();
         }
+
+        //  onlyIfEqual tests
+        if (!cluster.checkIfServerVersionLessThan("8.1.0")) {
+            for (const expiryVal of expiryCombination) {
+                // Set the key with the initial value
+                await client.set(key, value);
+
+                const setRes = await client.set(key, value2, {
+                    expiry: expiryVal as
+                        | "keepExisting"
+                        | {
+                              type:
+                                  | TimeUnit.Seconds
+                                  | TimeUnit.Milliseconds
+                                  | TimeUnit.UnixSeconds
+                                  | TimeUnit.UnixMilliseconds;
+                              count: number;
+                          },
+                    conditionalSet: "onlyIfEqual",
+                    comparisonValue: value, // Ensure it matches the current key's value
+                });
+
+                if (setRes) {
+                    expect(setRes).toEqual("OK"); // Should return 'OK' if the condition is met
+                } else {
+                    // If condition fails, ensure value remains unchanged
+                    const getRes = await client.get(key);
+                    expect(getRes).toEqual(value);
+                }
+            }
+        }
     }
 
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
         "Set commands with options test_%p",
         async (protocol) => {
-            await runTest(async (client: BaseClient) => {
+            await runTest(async (client: BaseClient, cluster) => {
                 await setWithExpiryOptions(client);
                 await setWithOnlyIfExistOptions(client);
                 await setWithOnlyIfNotExistOptions(client);
                 await setWithGetOldOptions(client);
                 await setWithAllOptions(client);
-                await testSetWithAllCombination(client);
+
+                if (!cluster.checkIfServerVersionLessThan("8.1.0")) {
+                    await setWithOnlyIfEquals(client);
+                    await setIfeqWithAllOptions(client);
+                }
+
+                await testSetWithAllCombination(client, cluster);
             }, protocol);
         },
         config.timeout,