Add support for Redis SINTERCARD command.

This commit adds support for Redis 7.0+ SINTERCARD command in Spring Data Redis.

The `sInterCard` API has been added to SetCommands and ClusterSetCommands for both Jedis and Lettuce.

The high-level `intersectSize` API has been added to SetOperations implementations as well.

Original Pull Request: #3210
Resolves: #2906

Signed-off-by: Kiminni <[email protected]>

Author: Kiminni

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

@@ -82,6 +82,7 @@
  * @author Dennis Neufeld
  * @author Shyngys Sapraliyev
  * @author Jeonggyu Choi
+ * @author Mingi Lee
  */
 @NullUnmarked
 @SuppressWarnings({ "ConstantConditions", "deprecation" })
@@ -832,6 +833,11 @@ public Long sInterStore(byte[] destKey, byte[]... keys) {
 		return convertAndReturn(delegate.sInterStore(destKey, keys), Converters.identityConverter());
 	}
 
+	@Override
+	public Long sInterCard(byte[]... keys) {
+		return convertAndReturn(delegate.sInterCard(keys), Converters.identityConverter());
+	}
+
 	@Override
 	public Boolean sIsMember(byte[] key, byte[] value) {
 		return convertAndReturn(delegate.sIsMember(key, value), Converters.identityConverter());
@@ -1824,6 +1830,11 @@ public Long sInterStore(String destKey, String... keys) {
 		return sInterStore(serialize(destKey), serializeMulti(keys));
 	}
 
+	@Override
+	public Long sInterCard(String... keys) {
+		return sInterCard(serializeMulti(keys));
+	}
+
 	@Override
 	public Boolean sIsMember(String key, String value) {
 		return sIsMember(serialize(key), serialize(value));

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

@@ -67,6 +67,7 @@
  * @author Dennis Neufeld
  * @author Shyngys Sapraliyev
  * @author Tihomir Mateev
+ * @author Mingi Lee
  * @since 2.0
  */
 @Deprecated
@@ -890,6 +891,13 @@ default Long sInterStore(byte[] destKey, byte[]... keys) {
 		return setCommands().sInterStore(destKey, keys);
 	}
 
+	/** @deprecated in favor of {@link RedisConnection#setCommands()}}. */
+	@Override
+	@Deprecated
+	default Long sInterCard(byte[]... keys) {
+		return setCommands().sInterCard(keys);
+	}
+
 	/** @deprecated in favor of {@link RedisConnection#setCommands()}}. */
 	@Override
 	@Deprecated

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

@@ -43,6 +43,7 @@
  *
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author Mingi Lee
  * @since 2.0
  */
 public interface ReactiveSetCommands {
@@ -775,6 +776,73 @@ default Mono<Long> sInterStore(ByteBuffer destinationKey, Collection<ByteBuffer>
 	 */
 	Flux<NumericResponse<SInterStoreCommand, Long>> sInterStore(Publisher<SInterStoreCommand> commands);
 
+	/**
+	 * {@code SINTERCARD} command parameters.
+	 *
+	 * @author Mingi Lee
+	 * @since 4.0
+	 * @see <a href="https://redis.io/commands/sintercard">Redis Documentation: SINTERCARD</a>
+	 */
+	class SInterCardCommand implements Command {
+
+		private final List<ByteBuffer> keys;
+
+		private SInterCardCommand(List<ByteBuffer> keys) {
+			this.keys = keys;
+		}
+
+		/**
+		 * Creates a new {@link SInterCardCommand} given a {@link Collection} of keys.
+		 *
+		 * @param keys must not be {@literal null}.
+		 * @return a new {@link SInterCardCommand} for a {@link Collection} of keys.
+		 */
+		public static SInterCardCommand keys(Collection<ByteBuffer> keys) {
+
+			Assert.notNull(keys, "Keys must not be null");
+
+			return new SInterCardCommand(new ArrayList<>(keys));
+		}
+
+		@Override
+		public @Nullable ByteBuffer getKey() {
+			return null;
+		}
+
+		/**
+		 * @return never {@literal null}.
+		 */
+		public List<ByteBuffer> getKeys() {
+			return keys;
+		}
+	}
+
+	/**
+	 * Returns the cardinality of the set which would result from the intersection of all given sets at {@literal keys}.
+	 *
+	 * @param keys must not be {@literal null}.
+	 * @return
+	 * @see <a href="https://redis.io/commands/sintercard">Redis Documentation: SINTERCARD</a>
+	 * @since 4.0
+	 */
+	default Mono<Long> sInterCard(Collection<ByteBuffer> keys) {
+
+		Assert.notNull(keys, "Keys must not be null");
+
+		return sInterCard(Mono.just(SInterCardCommand.keys(keys))).next().map(NumericResponse::getOutput);
+	}
+
+	/**
+	 * Returns the cardinality of the set which would result from the intersection of all given sets at
+	 * {@link SInterCardCommand#getKeys()}.
+	 *
+	 * @param commands must not be {@literal null}.
+	 * @return
+	 * @see <a href="https://redis.io/commands/sintercard">Redis Documentation: SINTERCARD</a>
+	 * @since 4.0
+	 */
+	Flux<NumericResponse<SInterCardCommand, Long>> sInterCard(Publisher<SInterCardCommand> commands);
+
 	/**
 	 * {@code SUNION} command parameters.
 	 *

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

@@ -29,6 +29,7 @@
  * @author Costin Leau
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author Mingi Lee
  * @see RedisCommands
  */
 @NullUnmarked
@@ -153,6 +154,16 @@ public interface RedisSetCommands {
 	 */
 	Long sInterStore(byte @NonNull [] destKey, byte @NonNull [] @NonNull... keys);
 
+	/**
+	 * Returns the cardinality of the set which would result from the intersection of all the given sets.
+	 *
+	 * @param keys must not be {@literal null}.
+	 * @return {@literal null} when used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/sintercard">Redis Documentation: SINTERCARD</a>
+	 * @since 4.0
+	 */
+	Long sInterCard(byte @NonNull [] @NonNull... keys);
+
 	/**
 	 * Union all sets at given {@code keys}.
 	 *

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

@@ -74,6 +74,7 @@
  * @author ihaohong
  * @author Shyngys Sapraliyev
  * @author Jeonggyu Choi
+ * @author Mingi Lee
  * @see RedisCallback
  * @see RedisSerializer
  * @see StringRedisTemplate
@@ -1169,6 +1170,17 @@ String bLMove(@NonNull String sourceKey, @NonNull String destinationKey, @NonNul
 	 */
 	Long sInterStore(@NonNull String destKey, @NonNull String @NonNull... keys);
 
+	/**
+	 * Returns the cardinality of the set which would result from the intersection of all the given sets.
+	 *
+	 * @param keys must not be {@literal null}.
+	 * @return
+	 * @see <a href="https://redis.io/commands/sintercard">Redis Documentation: SINTERCARD</a>
+	 * @see RedisSetCommands#sInterCard(byte[]...)
+	 * @since 4.0
+	 */
+	Long sInterCard(@NonNull String @NonNull... keys);
+
 	/**
 	 * Union all sets at given {@code keys}.
 	 *

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

@@ -40,6 +40,7 @@
 /**
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author Mingi Lee
  * @since 2.0
  */
 class JedisClusterSetCommands implements RedisSetCommands {
@@ -230,6 +231,25 @@ public Long sInterStore(byte[] destKey, byte[]... keys) {
 		return sAdd(destKey, result.toArray(new byte[result.size()][]));
 	}
 
+	@Override
+	public Long sInterCard(byte[]... keys) {
+
+		Assert.notNull(keys, "Keys must not be null");
+		Assert.noNullElements(keys, "Keys must not contain null elements");
+
+		if (ClusterSlotHashUtil.isSameSlotForAllKeys(keys)) {
+			try {
+				return connection.getCluster().sintercard(keys);
+			} catch (Exception ex) {
+				throw convertJedisAccessException(ex);
+			}
+		}
+
+		// For multi-slot clusters, calculate intersection cardinality by performing intersection
+		Set<byte[]> result = sInter(keys);
+		return (long) result.size();
+	}
+
 	@Override
 	public Set<byte[]> sUnion(byte[]... keys) {
 

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

@@ -38,6 +38,7 @@
 /**
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author Mingi Lee
  * @since 2.0
  */
 @NullUnmarked
@@ -105,6 +106,15 @@ public Long sInterStore(byte @NonNull [] destKey, byte @NonNull [] @NonNull... k
 		return connection.invoke().just(Jedis::sinterstore, PipelineBinaryCommands::sinterstore, destKey, keys);
 	}
 
+	@Override
+	public Long sInterCard(byte @NonNull [] @NonNull... keys) {
+
+		Assert.notNull(keys, "Keys must not be null");
+		Assert.noNullElements(keys, "Keys must not contain null elements");
+
+		return connection.invoke().just(Jedis::sintercard, PipelineBinaryCommands::sintercard, keys);
+	}
+
 	@Override
 	public Boolean sIsMember(byte @NonNull [] key, byte @NonNull [] value) {
 

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceClusterSetCommands.java

@@ -31,6 +31,7 @@
 /**
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author Mingi Lee
  * @since 2.0
  */
 class LettuceClusterSetCommands extends LettuceSetCommands {
@@ -118,6 +119,21 @@ public Long sInterStore(byte[] destKey, byte[]... keys) {
 		return sAdd(destKey, result.toArray(new byte[result.size()][]));
 	}
 
+	@Override
+	public Long sInterCard(byte[]... keys) {
+
+		Assert.notNull(keys, "Keys must not be null");
+		Assert.noNullElements(keys, "Keys must not contain null elements");
+
+		if (ClusterSlotHashUtil.isSameSlotForAllKeys(keys)) {
+			return super.sInterCard(keys);
+		}
+
+		// For multi-slot clusters, calculate intersection cardinality by performing intersection
+		Set<byte[]> result = sInter(keys);
+		return (long) result.size();
+	}
+
 	@Override
 	public Set<byte[]> sUnion(byte[]... keys) {
 

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveSetCommands.java

@@ -36,6 +36,7 @@
 /**
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author Mingi Lee
  * @since 2.0
  */
 class LettuceReactiveSetCommands implements ReactiveSetCommands {
@@ -175,6 +176,18 @@ public Flux<NumericResponse<SInterStoreCommand, Long>> sInterStore(Publisher<SIn
 		}));
 	}
 
+	@Override
+	public Flux<NumericResponse<SInterCardCommand, Long>> sInterCard(Publisher<SInterCardCommand> commands) {
+
+		return connection.execute(cmd -> Flux.from(commands).concatMap(command -> {
+
+			Assert.notNull(command.getKeys(), "Keys must not be null");
+
+			return cmd.sintercard(command.getKeys().toArray(new ByteBuffer[0]))
+					.map(value -> new NumericResponse<>(command, value));
+		}));
+	}
+
 	@Override
 	public Flux<CommandResponse<SUnionCommand, Flux<ByteBuffer>>> sUnion(Publisher<SUnionCommand> commands) {
 

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceSetCommands.java

@@ -39,6 +39,7 @@
 /**
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author Mingi Lee
  * @since 2.0
  */
 @NullUnmarked
@@ -106,6 +107,15 @@ public Long sInterStore(byte @NonNull [] destKey, byte @NonNull [] @NonNull... k
 		return connection.invoke().just(RedisSetAsyncCommands::sinterstore, destKey, keys);
 	}
 
+	@Override
+	public Long sInterCard(byte @NonNull [] @NonNull... keys) {
+
+		Assert.notNull(keys, "Keys must not be null");
+		Assert.noNullElements(keys, "Keys must not contain null elements");
+
+		return connection.invoke().just(RedisSetAsyncCommands::sintercard, keys);
+	}
+
 	@Override
 	public Boolean sIsMember(byte @NonNull [] key, byte @NonNull [] value) {