Support `SET` CAS operations `IFEQ` and `IFNE` by Dgramada · Pull Request #3304 · spring-projects/spring-data-redis

Dgramada · 2026-01-26T15:50:46Z

This PR introduces support for the Redis SET command's IFEQ and IFNE options, which were added in Redis 8.4 to enable atomic compare-and-swap (CAS) operations.

Summary

Introduces a new SetCondition class in RedisStringCommands that provides factory methods for conditional SET operations:

upsert() - Always set the value (default behavior)
ifAbsent() - Set only if key does not exist (NX)
ifPresent() - Set only if key exists (XX)
ifValueEqual(byte[]) - Set only if current value equals the specified value (IFEQ)
ifValueNotEqual(byte[]) - Set only if current value does not equal the specified value (IFNE)

Changes

Core API:

Added SetCondition class with immutable, cached instances for stateless conditions
Extended set() and setGet() method overloads in RedisStringCommands to accept SetCondition
Added support in StringRedisConnection and DefaultStringRedisConnection

Driver Implementations:

Implemented Jedis support (JedisStringCommands, JedisClusterStringCommands, JedisConverters)
Implemented Lettuce support (LettuceStringCommands, LettuceConverters)
Implemented reactive support (LettuceReactiveStringCommands, ReactiveStringCommands)

Template Operations:

Extended ValueOperations and BoundValueOperations with new set() and setGet() methods
Extended ReactiveValueOperations with reactive equivalents
Added Kotlin extensions for ReactiveValueOperations

Tests:

Added comprehensive unit tests for converters
Added integration tests for both standalone and cluster configurations
Added reactive integration tests

Compatibility

Requires Redis 8.4+ for IFEQ/IFNE functionality
Maintains backward compatibility with existing SetOption API
All existing tests continue to pass

Introduce SetCondition class to RedisStringCommands with ifValueEqual() method that enables conditional SET operations based on current value comparison. This extends existing set() method overloads to accept SetCondition parameters alongside Expiration, supporting the IFEQ option introduced in Redis 8.4 for atomic compare-and-swap operations. The SetCondition class provides factory methods for upsert(), ifAbsent(), ifPresent(), and ifValueEqual() conditions, maintaining backward compatibility while enabling new CAS functionality. Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

…eactive and non-reactive abstractions. Extended testing to include IFNE logic. Added setGet logic for sync APIs. Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

The refactoring: - Converts SetOption from an enum to a class with cached instances for stateless conditions - Removes the separate SetCondition class and its duplicate API methods - Unifies the API surface by having a single SetOption type for all SET command variations - Maintains backward compatibility with existing SetOption.upsert(), ifAbsent(), and ifPresent() factory methods - Adds ifValueEqual() and ifValueNotEqual() factory methods for CAS operations Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

mp911de

Did a first review pass. The comments regarding version numbers and template API design apply also to ValueOperations and their reactive counterpart.

mp911de · 2026-01-30T08:04:24Z

src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java

+	class SetOption {
+
+		// Cached instances for stateless conditions
+		private static final SetOption UPSERT_INSTANCE = new SetOption(Type.UPSERT, null);


Let's keep these constants public to retain compile compatibility. No need to add _INSTANCE to the name.

mp911de · 2026-01-30T08:06:16Z

src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java

+		private static final SetOption IF_ABSENT_INSTANCE = new SetOption(Type.SET_IF_ABSENT, null);
+		private static final SetOption IF_PRESENT_INSTANCE = new SetOption(Type.SET_IF_PRESENT, null);
+
+		private final @NonNull Type type;


Please avoid adding @NonNull. Instead, please annotate the class with @NullMarked to opt in for non-null by default.

mp911de · 2026-01-30T08:08:34Z

src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java

 		 */
-		public static SetOption upsert() {
-			return UPSERT;
+		public static SetOption ifValueEqual(byte @NonNull [] value) {


Maybe ifEqual(…) to shorten the name, maybe good for consideration.

mp911de · 2026-01-30T08:11:09Z

src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java

+			if (this.compareValue == null) {
+				return null;
+			}
+			return Arrays.copyOf(this.compareValue, this.compareValue.length);


We typicall do not use copied instances. Depending on our Template API design, this property might be an internal piece anyway.

Also, looking at the calling code of this method, the method should be really non-nullable and throw an IllegalStateException if the value is null and the condition is not one of if-equal/if-not-equal for a clearer usage.

mp911de · 2026-01-30T08:11:30Z

src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java

+		 * {@code SET} command options for {@code NX}, {@code XX}, {@code IFEQ}.
+		 *
+		 * @author Yordan Tsintsov
+		 * @since 4.1.0


Nit: For .0 versions, we would just use 4.1. Less noise.

mp911de · 2026-01-30T08:12:02Z

src/main/java/org/springframework/data/redis/core/BoundValueOperations.java

+	 * @since 4.1.0
+	 * @see <a href="https://redis.io/commands/setnx">Redis Documentation: SET</a>
+	 */
+	Boolean setIfEqual(@NonNull V newValue, @NonNull V compareValue);


I wonder whether we should call these compareAndSet

Wouldn't it be better to keep setIfNotEqual because it:

is consistent with existing Spring Data Redis naming: setIfAbsent, setIfPresent

directly maps to Redis command options: IFEQ, IFNE

mp911de · 2026-01-30T08:18:34Z

src/main/java/org/springframework/data/redis/core/BoundValueOperations.java

+	 * @since 4.1.0
+	 * @see <a href="https://redis.io/commands/set">Redis Documentation: SET</a>
+	 */
+	Boolean setIfEqual(@NonNull V newValue, @NonNull V compareValue, long timeout, @NonNull TimeUnit unit);


Let's use Expiration in new API to avoid repetitive overloads simplifying the overall usage experience.

As follow-up, it would make sense to retrofit existing methods accepting any durations/TimeUnit argument variants to evolve the API into a better model.

Since we have to do some cleanup, the Expiration revision would have to deprecate the other methods so that we evolve towards a more concise interface.

mp911de · 2026-01-30T08:18:49Z

src/main/java/org/springframework/data/redis/core/BoundValueOperations.java

+	 * @since 4.1.0
+	 * @see <a href="https://redis.io/commands/setnx">Redis Documentation: SET</a>
+	 */
+	Boolean setIfNotEqual(@NonNull V newValue, @NonNull V compareValue);


Suggestion: compareAndSetIfNot

Wouldn't it be better to keep setIfNotEqual because it:

is consistent with existing Spring Data Redis naming: setIfAbsent, setIfPresent

directly maps to Redis command options: IFEQ, IFNE

mp911de · 2026-01-30T08:20:20Z

src/main/java/org/springframework/data/redis/cache/DefaultRedisCacheWriter.java

 		byte[] cacheLockKey = createCacheLockKey(name);

-		while (!ObjectUtils.nullSafeEquals(commands.set(cacheLockKey, new byte[0], expiration, SetOption.SET_IF_ABSENT),
+		while (!ObjectUtils.nullSafeEquals(commands.set(cacheLockKey, new byte[0], expiration, SetOption.ifAbsent()),


These changes illustrate that preserving the enum constants in the refactored class is a good idea.

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

…tive function parameter names. Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

viktoriya-kutsarova

To complete the Redis version update, also update Jenkinsfile and pipeline.properties, and move the Dockerfile to ci/openjdk25-redis-8.4/

viktoriya-kutsarova · 2026-02-03T09:29:40Z

src/main/java/org/springframework/data/redis/connection/jedis/JedisConverters.java

+	 * @param condition must not be {@literal null}.
+	 * @since 4.1
 	 */
-	public static SetParams toSetCommandNxXxArgument(SetOption option) {


As this is a public method, we should probably first deprecate it and just add the new one.

viktoriya-kutsarova · 2026-02-03T09:30:16Z

src/main/java/org/springframework/data/redis/connection/jedis/JedisConverters.java

+	 * @param condition must not be {@literal null}.
+	 * @since 4.1
 	 */
-	public static SetParams toSetCommandNxXxArgument(SetOption option, SetParams params) {


Leave this method, just deprecate it.

viktoriya-kutsarova · 2026-02-03T11:47:01Z

src/main/java/org/springframework/data/redis/connection/ReactiveStringCommands.java


-		private SetCommand(@Nullable ByteBuffer key, @Nullable ByteBuffer value, @Nullable Expiration expiration,
-				@Nullable SetOption option) {
+		private SetCommand(@Nullable ByteBuffer key,


nit: No need to put each parameter on a separate line.

viktoriya-kutsarova · 2026-02-03T11:49:55Z

src/main/java/org/springframework/data/redis/connection/jedis/JedisConverters.java

+	 * @param condition must not be {@literal null}.
+	 * @since 4.1
 	 */
-	public static SetParams toSetCommandNxXxArgument(SetOption option, SetParams params) {


Please deprecate this method instead of deleting it to maintain backward compatibility.

viktoriya-kutsarova · 2026-02-03T11:50:15Z

src/main/java/org/springframework/data/redis/connection/jedis/JedisConverters.java

+	 * @param condition must not be {@literal null}.
+	 * @since 4.1
 	 */
-	public static SetParams toSetCommandNxXxArgument(SetOption option) {


Please deprecate this method instead of deleting it to maintain backward compatibility.

viktoriya-kutsarova · 2026-02-03T12:01:14Z

src/test/java/org/springframework/data/redis/connection/AbstractConnectionIntegrationTests.java

+		assertThat(result.get(3)).isEqualTo("foo");
+	}
+
+	@Test // GH-3254


Remove the unrelated GH-3254 reference.

viktoriya-kutsarova · 2026-02-03T12:16:57Z

src/test/java/org/springframework/data/redis/connection/AbstractConnectionIntegrationTests.java

+		assertThat(result.get(3)).isEqualTo("bar-bar");
+	}
+
+	@Test // GH-3254


nit: Remove the unrelated GH-3254 reference.

viktoriya-kutsarova · 2026-02-03T12:23:07Z

src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java

+
+		@Override
+		public String toString() {
+			return "%s{type=%s, compareValue=%s}".formatted(getClass().getSimpleName(), type, compareValue != null ? "*****" : "<none>");


Is compareValue sensitive here? If not, the ***** masking seems unnecessary - consider removing it from the output.

viktoriya-kutsarova · 2026-02-03T12:23:40Z

src/main/java/org/springframework/data/redis/connection/ReactiveStringCommands.java


-		private SetCommand(@Nullable ByteBuffer key, @Nullable ByteBuffer value, @Nullable Expiration expiration,
-				@Nullable SetOption option) {
+		private SetCommand(@Nullable ByteBuffer key,


nit: The parameters can stay on two lines.

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

…perations.java methods Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

…hods in LettuceReactiveStringCommands. Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Signed-off-by: Yordan Tsintsov <82151074+Dgramada@users.noreply.github.com>

…g. Polished. Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

mp911de · 2026-02-09T14:29:33Z

Postponing to M2 (March milestone)

…c/extend-set-command-options # Conflicts: # Jenkinsfile # ci/openjdk25-redis-8.4/Dockerfile # ci/pipeline.properties

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Dgramada added 4 commits January 26, 2026 17:18

Extended SetCondition IFEQ logic for the reactive logic of the project.

d659a05

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Extended SetCondition logic to include IFNE command option for both r…

edb18cc

…eactive and non-reactive abstractions. Extended testing to include IFNE logic. Added setGet logic for sync APIs. Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Updated SetCondition javadoc.

e33d10d

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 26, 2026

mp911de changed the title ~~Yordan tsintsovtopic/extend set command options~~ Support SET CAS operations IFEQ and IFNE Jan 27, 2026

mp911de requested changes Jan 30, 2026

View reviewed changes

Dgramada added 2 commits January 30, 2026 16:01

Addressed comments

290d5cc

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Renamed extension function parameters to match naming pattern of reac…

c932cc9

…tive function parameter names. Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

viktoriya-kutsarova reviewed Feb 3, 2026

View reviewed changes

Dgramada and others added 5 commits February 3, 2026 18:35

Addressed comments.

e90674c

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Added duration overloads for new ValueOperations.java and BoundValueO…

71c6507

…perations.java methods Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Extracted duplicate logic in a separate method for setGet and set met…

99ee3d6

…hods in LettuceReactiveStringCommands. Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Merge branch 'main' into yordan-tsintsovtopic/extend-set-command-options

0e2c0c0

Signed-off-by: Yordan Tsintsov <82151074+Dgramada@users.noreply.github.com>

Updated static cached instances of SetOption to follow old enum namin…

b01db69

…g. Polished. Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

mp911de added type: enhancement A general enhancement and removed status: waiting-for-triage An issue we've not yet triaged labels Feb 9, 2026

Dgramada mentioned this pull request Feb 11, 2026

Refactor RedisLockRegistry to leverage Redis 8.4 native CAS/CAD commands spring-projects/spring-integration#10782

Open

Dgramada added 2 commits February 23, 2026 13:25

Merge remote-tracking branch 'upstream/main' into yordan-tsintsovtopi…

e6d07d0

…c/extend-set-command-options # Conflicts: # Jenkinsfile # ci/openjdk25-redis-8.4/Dockerfile # ci/pipeline.properties

Fixed conflicts

ddf9192

Signed-off-by: Yordan Tsintsov <yordan.tsintsov@redis.com>

Comments

Conversation

Dgramada commented Jan 26, 2026

Summary

Changes

Compatibility

Uh oh!

mp911de left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Dgramada Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

viktoriya-kutsarova left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mp911de commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Dgramada Jan 30, 2026 •

edited

Loading

mp911de commented Feb 9, 2026 •

edited

Loading