DATAREDIS-1042 - Polishing.

Set MKSTREAM by default when calling createGroup on the operations API as that should be the default behavior in the first place. Reformat code. Add since tags.

Original pull request: #527.

Author: mp911de

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

@@ -1185,7 +1185,7 @@ public GroupCommand fromGroup(String groupName) {
 			return new GroupCommand(getKey(), action, groupName, consumerName, offset);
 		}
 
-		public boolean getMkStream() {
+		public boolean isMkStream() {
 			return this.mkStream;
 		}
 
@@ -1235,6 +1235,7 @@ default Mono<String> xGroupCreate(ByteBuffer key, String groupName, ReadOffset r
 	 * @param readOffset the offset to start at.
 	 * @param mkStream if true the group will create the stream if needed (MKSTREAM)
 	 * @return the {@link Mono} emitting {@literal ok} if successful.
+	 * @since 2.3
 	 */
 	default Mono<String> xGroupCreate(ByteBuffer key, String groupName, ReadOffset readOffset, boolean mkStream) {
 		return xGroup(Mono.just(GroupCommand.createGroup(groupName).forStream(key).at(readOffset).makeStream(mkStream))).next()

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

@@ -473,6 +473,7 @@ default Long xDel(byte[] key, String... recordIds) {
 	 * @param readOffset the offset to start at.
 	 * @param mkStream if true the group will create the stream if not already present (MKSTREAM)
 	 * @return {@literal ok} if successful. {@literal null} when used in pipeline / transaction.
+	 * @since 2.3
 	 */
 	@Nullable
 	String xGroupCreate(byte[] key, String groupName, ReadOffset readOffset, boolean mkStream);

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

@@ -2101,7 +2101,7 @@ default Long xDel(String key, String... entryIds) {
 	/**
 	 * Create a consumer group.
 	 *
-	 * @param key
+	 * @param key the stream key.
 	 * @param readOffset
 	 * @param group name of the consumer group.
 	 * @since 2.2
@@ -2113,12 +2113,13 @@ default Long xDel(String key, String... entryIds) {
 	/**
 	 * Create a consumer group.
 	 *
-	 * @param key
+	 * @param key the stream key.
 	 * @param readOffset
 	 * @param group name of the consumer group.
 	 * @param mkStream if true the group will create the stream if needed (MKSTREAM)
 	 * @since
 	 * @return {@literal true} if successful. {@literal null} when used in pipeline / transaction.
+	 * @since 2.3
 	 */
 	@Nullable
 	String xGroupCreate(String key, ReadOffset readOffset, String group, boolean mkStream);

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

@@ -192,7 +192,7 @@ public Flux<CommandResponse<GroupCommand, String>> xGroup(Publisher<GroupCommand
 
 				return cmd.xgroupCreate(offset,
 							ByteUtils.getByteBuffer(command.getGroupName()),
-							XGroupCreateArgs.Builder.mkstream( command.getMkStream()))
+						XGroupCreateArgs.Builder.mkstream(command.isMkStream()))
 						.map(it ->
 								new CommandResponse<>(command, it)
 						);

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

@@ -236,18 +236,17 @@ public String xGroupCreate(byte[] key, String groupName, ReadOffset readOffset,
 			XReadArgs.StreamOffset<byte[]> streamOffset = XReadArgs.StreamOffset.from(key, readOffset.getOffset());
 
 			if (isPipelined()) {
-				pipeline(connection
-						.newLettuceResult(getAsyncConnection().xgroupCreate(streamOffset, LettuceConverters.toBytes(groupName),
-								XGroupCreateArgs.Builder.mkstream(mkSteam))));
+				pipeline(connection.newLettuceResult(getAsyncConnection().xgroupCreate(streamOffset,
+						LettuceConverters.toBytes(groupName), XGroupCreateArgs.Builder.mkstream(mkSteam))));
 				return null;
 			}
 			if (isQueueing()) {
-				transaction(connection
-						.newLettuceResult(getAsyncConnection().xgroupCreate(streamOffset, LettuceConverters.toBytes(groupName),
-								XGroupCreateArgs.Builder.mkstream(mkSteam))));
+				transaction(connection.newLettuceResult(getAsyncConnection().xgroupCreate(streamOffset,
+						LettuceConverters.toBytes(groupName), XGroupCreateArgs.Builder.mkstream(mkSteam))));
 				return null;
 			}
-			return getConnection().xgroupCreate(streamOffset, LettuceConverters.toBytes(groupName), XGroupCreateArgs.Builder.mkstream(mkSteam));
+			return getConnection().xgroupCreate(streamOffset, LettuceConverters.toBytes(groupName),
+					XGroupCreateArgs.Builder.mkstream(mkSteam));
 		} catch (Exception ex) {
 			throw convertLettuceAccessException(ex);
 		}
@@ -712,7 +711,6 @@ private DataAccessException convertLettuceAccessException(Exception ex) {
 		return connection.convertLettuceAccessException(ex);
 	}
 
-
 	@SuppressWarnings("unchecked")
 	private static XReadArgs.StreamOffset<byte[]>[] toStreamOffsets(StreamOffset<byte[]>[] streams) {
 

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

@@ -55,7 +55,6 @@
  *
  * @author Mark Paluch
  * @author Christoph Strobl
- * @author Tugdual Grall
  * @since 2.2
  */
 class DefaultReactiveStreamOperations<K, HK, HV> implements ReactiveStreamOperations<K, HK, HV> {
@@ -163,17 +162,12 @@ public Mono<Long> delete(K key, RecordId... recordIds) {
 
 	@Override
 	public Mono<String> createGroup(K key, ReadOffset readOffset, String group) {
-		return createMono(connection -> connection.xGroupCreate(rawKey(key), group, readOffset, false));
-	}
-
-	@Override
-	public Mono<String> createGroup(K key, ReadOffset readOffset, String group, boolean mkStream) {
 
 		Assert.notNull(key, "Key must not be null!");
 		Assert.notNull(readOffset, "ReadOffset must not be null!");
 		Assert.notNull(group, "Group must not be null!");
 
-		return createMono(connection -> connection.xGroupCreate(rawKey(key), group, readOffset, mkStream));
+		return createMono(connection -> connection.xGroupCreate(rawKey(key), group, readOffset, true));
 	}
 
 	@Override

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

@@ -50,7 +50,6 @@
  *
  * @author Mark Paluch
  * @author Christoph Strobl
- * @autor Tugdual Grall
  * @since 2.2
  */
 class DefaultStreamOperations<K, HK, HV> extends AbstractOperations<K, Object> implements StreamOperations<K, HK, HV> {
@@ -160,21 +159,7 @@ public Long delete(K key, RecordId... recordIds) {
 	public String createGroup(K key, ReadOffset readOffset, String group) {
 
 		byte[] rawKey = rawKey(key);
-		return execute(connection -> connection.xGroupCreate(rawKey, group, readOffset), true);
-	}
-
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.data.redis.core.StreamOperations#createGroup(java.lang.Object, org.springframework.data.redis.connection.RedisStreamCommands.ReadOffset, java.lang.String, boolean)
-	 */
-	@Override
-	public String createGroup(K key, ReadOffset readOffset, String group, boolean mkStream) {
-		byte[] rawKey = rawKey(key);
-		if (!mkStream) {
-			return createGroup(key, readOffset, group);
-		} else {
-			return execute(connection -> connection.xGroupCreate(rawKey, group, readOffset, true), true);
-		}
+		return execute(connection -> connection.xGroupCreate(rawKey, group, readOffset, true), true);
 	}
 
 	/*

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

@@ -37,7 +37,6 @@
  *
  * @author Mark Paluch
  * @author Christoph Strobl
- * @author Tugdual Grall
  * @since 2.2
  */
 public interface ReactiveStreamOperations<K, HK, HV> extends HashMapperProvider<HK, HV> {
@@ -159,7 +158,8 @@ default Mono<Long> delete(Record<K, ?> record) {
 	Mono<Long> delete(K key, RecordId... recordIds);
 
 	/**
-	 * Create a consumer group at the {@link ReadOffset#latest() latest offset}.
+	 * Create a consumer group at the {@link ReadOffset#latest() latest offset}. This command creates the stream if it
+	 * does not already exist.
 	 *
 	 * @param key the {@literal key} the stream is stored at.
 	 * @param group name of the consumer group.
@@ -171,20 +171,7 @@ default Mono<String> createGroup(K key, String group) {
 	}
 
 	/**
-	 * Create a consumer group at the {@link ReadOffset#latest() latest offset}.
-	 *
-	 * @param key the {@literal key} the stream is stored at.
-	 * @param group name of the consumer group.
-	 * @param mkStream if true the group will create the stream if not already present (MKSTREAM)
-	 * @return the {@link Mono} emitting {@literal OK} if successful.. {@literal null} when used in pipeline /
-	 *         transaction.
-	 */
-	default Mono<String> createGroup(K key, String group, boolean mkStream) {
-		return createGroup(key, ReadOffset.latest(), group, mkStream);
-	}
-
-	/**
-	 * Create a consumer group.
+	 * Create a consumer group. This command creates the stream if it does not already exist.
 	 *
 	 * @param key the {@literal key} the stream is stored at.
 	 * @param readOffset the {@link ReadOffset} to apply.
@@ -193,16 +180,6 @@ default Mono<String> createGroup(K key, String group, boolean mkStream) {
 	 */
 	Mono<String> createGroup(K key, ReadOffset readOffset, String group);
 
-	/**
-	 * Create a consumer group.
-	 *
-	 * @param key the {@literal key} the stream is stored at.
-	 * @param readOffset the {@link ReadOffset} to apply.
-	 * @param group name of the consumer group.
-	 * @param mkStream if true the group will create the stream if needed (MKSTREAM)
-	 * @return the {@link Mono} emitting {@literal OK} if successful.
-	 */
-	Mono<String> createGroup(K key, ReadOffset readOffset, String group, boolean mkStream);
 	/**
 	 * Delete a consumer from a consumer group.
 	 *

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

@@ -36,7 +36,6 @@
  *
  * @author Mark Paluch
  * @author Christoph Strobl
- * @author Tugdual Grall
  * @since 2.2
  */
 public interface StreamOperations<K, HK, HV> extends HashMapperProvider<HK, HV> {
@@ -156,7 +155,8 @@ default Long delete(Record<K, ?> record) {
 	Long delete(K key, RecordId... recordIds);
 
 	/**
-	 * Create a consumer group at the {@link ReadOffset#latest() latest offset}.
+	 * Create a consumer group at the {@link ReadOffset#latest() latest offset}. This command creates the stream if it
+	 * does not already exist.
 	 *
 	 * @param key the {@literal key} the stream is stored at.
 	 * @param group name of the consumer group.
@@ -167,7 +167,7 @@ default String createGroup(K key, String group) {
 	}
 
 	/**
-	 * Create a consumer group.
+	 * Create a consumer group. This command creates the stream if it does not already exist.
 	 *
 	 * @param key the {@literal key} the stream is stored at.
 	 * @param readOffset the {@link ReadOffset} to apply.
@@ -177,18 +177,6 @@ default String createGroup(K key, String group) {
 	@Nullable
 	String createGroup(K key, ReadOffset readOffset, String group);
 
-	/**
-	 * Create a consumer group.
-	 *
-	 * @param key the {@literal key} the stream is stored at.
-	 * @param readOffset the {@link ReadOffset} to apply.
-	 * @param group name of the consumer group.
-	 * @param mkStream if true the group will create the stream if needed (MKSTREAM)
-	 * @return {@literal OK} if successful. {@literal null} when used in pipeline / transaction.
-	 */
-	@Nullable
-	String createGroup(K key, ReadOffset readOffset, String group, boolean mkStream);
-
 	/**
 	 * Delete a consumer from a consumer group.
 	 *

src/main/kotlin/org/springframework/data/redis/core/ReactiveStreamOperationsExtensions.kt

@@ -113,15 +113,6 @@ suspend fun <K : Any, HK : Any, HV : Any> ReactiveStreamOperations<K, HK, HV>.de
 suspend fun <K : Any, HK : Any, HV : Any> ReactiveStreamOperations<K, HK, HV>.createGroupAndAwait(key: K, group: String): String =
 		createGroup(key, group).awaitSingle()
 
-/**
- * Coroutines variant of [ReactiveStreamOperations.createGroup].
- *
- * @author Mark Paluch
- * @since 2.2
- */
-suspend fun <K : Any, HK : Any, HV : Any> ReactiveStreamOperations<K, HK, HV>.createGroupAndAwait(key: K, group: String, mkStream: Boolean): String =
-		createGroup(key, group, mkStream).awaitSingle()
-
 /**
  * Coroutines variant of [ReactiveStreamOperations.createGroup].
  *
@@ -131,15 +122,6 @@ suspend fun <K : Any, HK : Any, HV : Any> ReactiveStreamOperations<K, HK, HV>.cr
 suspend fun <K : Any, HK : Any, HV : Any> ReactiveStreamOperations<K, HK, HV>.createGroupAndAwait(key: K, readOffset: ReadOffset, group: String): String =
 		createGroup(key, readOffset, group).awaitSingle()
 
-/**
- * Coroutines variant of [ReactiveStreamOperations.createGroup].
- *
- * @author Tugdual Grall
- * @since
- */
-suspend fun <K : Any, HK : Any, HV : Any> ReactiveStreamOperations<K, HK, HV>.createGroupAndAwait(key: K, readOffset: ReadOffset, group: String, mkStream: Boolean): String =
-		createGroup(key, readOffset, group, mkStream).awaitSingle()
-
 /**
  * Coroutines variant of [ReactiveStreamOperations.deleteConsumer].
  *

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

@@ -3064,7 +3064,7 @@ public void xReadGroupShouldReadMessage() {
 	@WithRedisDriver({ RedisDriver.LETTUCE })
 	public void xGroupCreateShouldWorkWithAndWithoutExistingStream() {
 
-		actual.add(connection.xGroupCreate(KEY_1, ReadOffset.from("0"), "my-group",true));
+		actual.add(connection.xGroupCreate(KEY_1, ReadOffset.from("0"), "my-group", true));
 		actual.add(connection.xAdd(KEY_1, Collections.singletonMap(KEY_2, VALUE_2)));
 
 		actual.add(connection.xReadGroupAsString(Consumer.from("my-group", "my-consumer"),
@@ -3276,7 +3276,7 @@ public void xClaim() throws InterruptedException {
 	@WithRedisDriver({ RedisDriver.LETTUCE })
 	public void xinfo() {
 
-		actual.add(connection.xGroupCreate(KEY_1, ReadOffset.from("0"), "my-group-without-stream",true));
+		actual.add(connection.xGroupCreate(KEY_1, ReadOffset.from("0"), "my-group-without-stream", true));
 		actual.add(connection.xAdd(KEY_1, Collections.singletonMap(KEY_2, VALUE_2)));
 		actual.add(connection.xAdd(KEY_1, Collections.singletonMap(KEY_3, VALUE_3)));
 		actual.add(connection.xGroupCreate(KEY_1, ReadOffset.from("0"), "my-group"));

src/test/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveStreamCommandsTests.java

@@ -19,7 +19,6 @@
 import static org.junit.Assume.*;
 
 import io.lettuce.core.XReadArgs;
-import org.springframework.data.redis.RedisSystemException;
 import reactor.test.StepVerifier;
 
 import java.time.Duration;
@@ -29,7 +28,9 @@
 import org.junit.Before;
 import org.junit.Ignore;
 import org.junit.Test;
+
 import org.springframework.data.domain.Range;
+import org.springframework.data.redis.RedisSystemException;
 import org.springframework.data.redis.RedisTestProfileValueSource;
 import org.springframework.data.redis.connection.RedisStreamCommands.XClaimOptions;
 import org.springframework.data.redis.connection.RedisZSetCommands.Limit;

src/test/java/org/springframework/data/redis/stream/StreamReceiverIntegrationTests.java

@@ -55,7 +55,6 @@
  * Integration tests for {@link StreamReceiver}.
  *
  * @author Mark Paluch
- * @author Tugdual Grall
  */
 public class StreamReceiverIntegrationTests {
 
@@ -213,9 +212,8 @@ public void shouldReceiveAsConsumerGroupMessages() {
 		Flux<MapRecord<String, String, String>> messages = receiver.receive(Consumer.from("my-group", "my-consumer-id"),
 				StreamOffset.create("my-stream", ReadOffset.lastConsumed()));
 
-		// required to initialize stream
-		redisTemplate.opsForStream().add("my-stream", Collections.singletonMap("key", "value"));
 		redisTemplate.opsForStream().createGroup("my-stream", ReadOffset.from("0-0"), "my-group");
+		redisTemplate.opsForStream().add("my-stream", Collections.singletonMap("key", "value"));
 		redisTemplate.opsForStream().add("my-stream", Collections.singletonMap("key2", "value2"));
 
 		messages.as(StepVerifier::create) //
@@ -246,9 +244,8 @@ public void shouldStopReceivingOnError() {
 		Flux<MapRecord<String, String, String>> messages = receiver.receive(Consumer.from("my-group", "my-consumer-id"),
 				StreamOffset.create("my-stream", ReadOffset.lastConsumed()));
 
-		// required to initialize stream
-		redisTemplate.opsForStream().add("my-stream", Collections.singletonMap("key", "value"));
 		redisTemplate.opsForStream().createGroup("my-stream", ReadOffset.from("0-0"), "my-group");
+		redisTemplate.opsForStream().add("my-stream", Collections.singletonMap("key", "value"));
 
 		messages.as(StepVerifier::create) //
 				.expectNextCount(1) //
@@ -257,31 +254,6 @@ public void shouldStopReceivingOnError() {
 				.verify(Duration.ofSeconds(5));
 	}
 
-	@Test // DATAREDIS-864
-	public void shouldCreateGroupWithOrWithoutExistingStream() {
-		StreamReceiver<String, MapRecord<String, String, String>> receiver = StreamReceiver.create(connectionFactory);
-
-		Flux<MapRecord<String, String, String>> messages = receiver.receive(Consumer.from("my-group", "my-consumer-id"),
-				StreamOffset.create("my-stream", ReadOffset.lastConsumed()));
-
-		// required to initialize stream
-		redisTemplate.opsForStream().createGroup("my-stream", ReadOffset.from("0-0"), "my-group", true);
-		redisTemplate.opsForStream().add("my-stream", Collections.singletonMap("key", "value"));
-		redisTemplate.opsForStream().add("my-stream", Collections.singletonMap("key2", "value2"));
-
-		messages.as(StepVerifier::create) //
-				.consumeNextWith(it -> {
-					assertThat(it.getStream()).isEqualTo("my-stream");
-					assertThat(it.getValue()).containsValue("value");
-				}).consumeNextWith(it -> {
-
-			assertThat(it.getStream()).isEqualTo("my-stream");
-			assertThat(it.getValue()).containsValue("value2");
-		}) //
-				.thenCancel() //
-				.verify(Duration.ofSeconds(5));
-	}
-
 	@Data
 	@AllArgsConstructor
 	static class LoginEvent {

src/test/kotlin/org/springframework/data/redis/core/ReactiveStreamOperationsExtensionsUnitTests.kt

@@ -35,7 +35,6 @@ import reactor.core.publisher.Mono
  *
  * @author Mark Paluch
  * @author Sebastien Deleuze
- * @author Tugdual Grall
  */
 class ReactiveStreamOperationsExtensionsUnitTests {