Add ProducerBuilder#superStream(String)

acogoluegnes · acogoluegnes · commit 04d82030f897 · 2022-08-10T15:27:25.000+02:00
Not mandatory, but for consistency with
ConsumerBuilder#superStream(String).
diff --git a/src/docs/asciidoc/super-streams.adoc b/src/docs/asciidoc/super-streams.adoc
@@ -57,7 +57,7 @@ When the topology of a super stream like the one described above has been set, c
 --------
 include::{test-examples}/SuperStreamUsage.java[tag=producer-simple]
 --------
-<1> Use the super stream name
+<1> Set the super stream name
 <2> Provide the logic to get the routing key from a message
 <3> Create the producer instance
 <4> Close the producer when it's no longer necessary
diff --git a/src/main/java/com/rabbitmq/stream/ProducerBuilder.java b/src/main/java/com/rabbitmq/stream/ProducerBuilder.java
@@ -39,6 +39,17 @@ public interface ProducerBuilder {
    */
   ProducerBuilder stream(String stream);
 
+  /**
+   * The super stream to send messages to.
+   *
+   * <p>This is an experimental API, subject to change.
+   *
+   * @param superStream
+   * @return this builder instance
+   * @see #routing(Function)
+   */
+  ProducerBuilder superStream(String superStream);
+
   /**
    * The number of messages to put in a sub-entry of a publish frame.
    *
diff --git a/src/main/java/com/rabbitmq/stream/impl/StreamProducerBuilder.java b/src/main/java/com/rabbitmq/stream/impl/StreamProducerBuilder.java
@@ -30,7 +30,7 @@ class StreamProducerBuilder implements ProducerBuilder {
 
   private String name;
 
-  private String stream;
+  private String stream, superStream;
 
   private int subEntrySize = 1;
 
@@ -63,6 +63,12 @@ public ProducerBuilder name(String name) {
     return this;
   }
 
+  @Override
+  public ProducerBuilder superStream(String superStream) {
+    this.superStream = superStream;
+    return this;
+  }
+
   public StreamProducerBuilder batchSize(int batchSize) {
     if (batchSize <= 0) {
       throw new IllegalArgumentException("the batch size must be greater than 0");
@@ -134,6 +140,12 @@ void resetRouting() {
   }
 
   public Producer build() {
+    if (this.stream == null && this.superStream == null) {
+      throw new IllegalArgumentException("A stream must be specified");
+    }
+    if (this.stream != null && this.superStream != null) {
+      throw new IllegalArgumentException("Stream and superStream cannot be set at the same time");
+    }
     if (subEntrySize == 1 && compression != null) {
       throw new IllegalArgumentException(
           "Sub-entry batching must be enabled to enable compression");
@@ -143,7 +155,23 @@ public Producer build() {
     }
     this.environment.maybeInitializeLocator();
     Producer producer;
-    if (this.routingConfiguration == null) {
+
+    if (this.stream != null && this.routingConfiguration != null) {
+      throw new IllegalArgumentException(
+          "A super stream must be specified when a routing configuration is set");
+    }
+
+    if (this.routingConfiguration != null && this.superStream == null) {
+      throw new IllegalArgumentException(
+          "A super stream must be specified when a routing configuration is set");
+    }
+
+    if (this.routingConfiguration == null && this.superStream != null) {
+      throw new IllegalArgumentException(
+          "A routing configuration must specified when a super stream is set");
+    }
+
+    if (this.stream != null) {
       producer =
           new StreamProducer(
               name,
@@ -170,7 +198,8 @@ public Producer build() {
         }
       }
       producer =
-          new SuperStreamProducer(this, this.name, this.stream, routingStrategy, this.environment);
+          new SuperStreamProducer(
+              this, this.name, this.superStream, routingStrategy, this.environment);
     }
     return producer;
   }
diff --git a/src/main/java/com/rabbitmq/stream/impl/SuperStreamProducer.java b/src/main/java/com/rabbitmq/stream/impl/SuperStreamProducer.java
@@ -101,7 +101,8 @@ public void send(Message message, ConfirmationHandler confirmationHandler) {
             producers.computeIfAbsent(
                 stream,
                 stream1 -> {
-                  Producer p = producerBuilder.duplicate().stream(stream1).build();
+                  Producer p =
+                      producerBuilder.duplicate().superStream(null).stream(stream1).build();
                   return p;
                 });
         producer.send(message, confirmationHandler);
diff --git a/src/main/java/com/rabbitmq/stream/perf/StreamPerfTest.java b/src/main/java/com/rabbitmq/stream/perf/StreamPerfTest.java
@@ -735,12 +735,15 @@ public Integer call() throws Exception {
 
                     java.util.function.Consumer<MessageBuilder> messageBuilderConsumer;
                     if (this.superStreams) {
-                      producerBuilder.routing(msg -> msg.getProperties().getMessageIdAsString());
+                      producerBuilder
+                          .superStream(stream)
+                          .routing(msg -> msg.getProperties().getMessageIdAsString());
                       AtomicLong messageIdSequence = new AtomicLong(0);
                       messageBuilderConsumer =
                           mg -> mg.properties().messageId(messageIdSequence.getAndIncrement());
                     } else {
                       messageBuilderConsumer = mg -> {};
+                      producerBuilder.stream(stream);
                     }
 
                     Producer producer =
@@ -750,7 +753,6 @@ public Integer call() throws Exception {
                             .compression(
                                 this.compression == Compression.NONE ? null : this.compression)
                             .maxUnconfirmedMessages(this.confirms)
-                            .stream(stream)
                             .build();
 
                     AtomicLong messageCount = new AtomicLong(0);
diff --git a/src/test/java/com/rabbitmq/stream/docs/SuperStreamUsage.java b/src/test/java/com/rabbitmq/stream/docs/SuperStreamUsage.java
@@ -30,7 +30,7 @@ void producerSimple() {
         Environment environment = Environment.builder().build();
         // tag::producer-simple[]
         Producer producer = environment.producerBuilder()
-                .stream("invoices")  // <1>
+                .superStream("invoices")  // <1>
                 .routing(message -> message.getProperties().getMessageIdAsString()) // <2>
                 .producerBuilder()
                 .build();  // <3>
@@ -43,7 +43,7 @@ void producerCustomHashFunction() {
         Environment environment = Environment.builder().build();
         // tag::producer-custom-hash-function[]
         Producer producer = environment.producerBuilder()
-            .stream("invoices")
+            .superStream("invoices")
             .routing(message -> message.getProperties().getMessageIdAsString())
             .hash(rk -> rk.hashCode())  // <1>
             .producerBuilder()
@@ -55,7 +55,7 @@ void producerKeyRoutingStrategy() {
         Environment environment = Environment.builder().build();
         // tag::producer-key-routing-strategy[]
         Producer producer = environment.producerBuilder()
-            .stream("invoices")
+            .superStream("invoices")
             .routing(msg -> msg.getApplicationProperties().get("region").toString())  // <1>
             .key()  // <2>
             .producerBuilder()
@@ -75,7 +75,7 @@ void producerCustomRoutingStrategy() {
            return Collections.singletonList(stream);
        };
        Producer producer = environment.producerBuilder()
-           .stream("invoices")
+           .superStream("invoices")
            .routing(null)  // <1>
            .strategy(routingStrategy)  // <2>
            .producerBuilder()
diff --git a/src/test/java/com/rabbitmq/stream/impl/SuperStreamProducerTest.java b/src/test/java/com/rabbitmq/stream/impl/SuperStreamProducerTest.java
@@ -19,6 +19,7 @@
 import static com.rabbitmq.stream.impl.TestUtils.localhost;
 import static com.rabbitmq.stream.impl.TestUtils.waitAtMost;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 import com.rabbitmq.client.Connection;
 import com.rabbitmq.client.ConnectionFactory;
@@ -75,12 +76,20 @@ void tearDown() throws Exception {
     connection.close();
   }
 
+  @Test
+  void exceptionShouldBeThrownWhenSuperStreamIsSetAndRoutingIsNotConfigured() {
+    assertThatThrownBy(() -> environment.producerBuilder().superStream(superStream).build())
+        .isInstanceOf(IllegalArgumentException.class);
+  }
+
   @Test
   void allMessagesSentToSuperStreamWithHashRoutingShouldBeThenConsumed() throws Exception {
     int messageCount = 10_000;
     declareSuperStreamTopology(connection, superStream, partitions);
     Producer producer =
-        environment.producerBuilder().stream(superStream)
+        environment
+            .producerBuilder()
+            .superStream(superStream)
             .routing(message -> message.getProperties().getMessageIdAsString())
             .producerBuilder()
             .build();
@@ -133,7 +142,9 @@ void allMessagesSentToSuperStreamWithRoutingKeyRoutingShouldBeThenConsumed() thr
     routingKeys = new String[] {"amer", "emea", "apac"};
     declareSuperStreamTopology(connection, superStream, routingKeys);
     Producer producer =
-        environment.producerBuilder().stream(superStream)
+        environment
+            .producerBuilder()
+            .superStream(superStream)
             .routing(message -> message.getApplicationProperties().get("region").toString())
             .key()
             .producerBuilder()
@@ -183,7 +194,9 @@ void messageIsNackedIfNoRouteFound() throws Exception {
     routingKeys = new String[] {"amer", "emea", "apac"};
     declareSuperStreamTopology(connection, superStream, routingKeys);
     Producer producer =
-        environment.producerBuilder().stream(superStream)
+        environment
+            .producerBuilder()
+            .superStream(superStream)
             .routing(message -> message.getApplicationProperties().get("region").toString())
             .key()
             .producerBuilder()
@@ -216,7 +229,10 @@ void getLastPublishingIdShouldReturnLowestValue() throws Exception {
     declareSuperStreamTopology(connection, superStream, partitions);
     String producerName = "super-stream-application";
     Producer producer =
-        environment.producerBuilder().name(producerName).stream(superStream)
+        environment
+            .producerBuilder()
+            .name(producerName)
+            .superStream(superStream)
             .routing(message -> message.getProperties().getMessageIdAsString())
             .producerBuilder()
             .build();
diff --git a/src/test/java/com/rabbitmq/stream/impl/SuperStreamTest.java b/src/test/java/com/rabbitmq/stream/impl/SuperStreamTest.java
@@ -82,7 +82,9 @@ void allMessagesSentWithHashRoutingShouldBeThenConsumed() throws Exception {
     int messageCount = 10_000 * partitions;
     declareSuperStreamTopology(connection, superStream, partitions);
     Producer producer =
-        environment.producerBuilder().stream(superStream)
+        environment
+            .producerBuilder()
+            .superStream(superStream)
             .routing(message -> message.getProperties().getMessageIdAsString())
             .producerBuilder()
             .build();
@@ -125,7 +127,9 @@ void allMessagesSentWithRoutingKeyRoutingShouldBeThenConsumed() throws Exception
     routingKeys = new String[] {"amer", "emea", "apac"};
     declareSuperStreamTopology(connection, superStream, routingKeys);
     Producer producer =
-        environment.producerBuilder().stream(superStream)
+        environment
+            .producerBuilder()
+            .superStream(superStream)
             .routing(message -> message.getApplicationProperties().get("region").toString())
             .key()
             .producerBuilder()
@@ -208,7 +212,9 @@ void allMessagesForSameUserShouldEndUpInSamePartition() throws Exception {
     assertThat(latchAssert(consumersReadyLatch)).completes();
 
     Producer producer =
-        environment.producerBuilder().stream(superStream)
+        environment
+            .producerBuilder()
+            .superStream(superStream)
             .routing(
                 message -> new String(message.getProperties().getUserId(), StandardCharsets.UTF_8))
             .producerBuilder()
