Improvements on Nats Serdes (#5222)

* Renamed nats producer send() to publish()

* Renamed nats received() to fetch()

* Renamed NATS_MGMT_PORT to NATS_MNTR_PORT

* Added Nak, Term and InProgress() with ConsumerRecord

* Added test case for new methods term, nak and inprogress in nats

* Fixed formatting issue, causing build failure

* Using assertTrue instead of assertEqual

* fixed build failure

* Formatting fix

* Removing flaky test

* Fixing Indentation Issues

---------

Co-authored-by: Eric Wittmann <eric.wittmann@gmail.com>
Co-authored-by: Carles Arnal <carlesarnal92@gmail.com>

Author: 3 people

integration-tests/src/test/java/io/apicurio/tests/serdes/apicurio/nats/AvroNatsSerdeIT.java

@@ -16,16 +16,13 @@
 import io.nats.client.Options;
 import io.nats.client.PullSubscribeOptions;
 import io.nats.client.api.ConsumerConfiguration;
+import io.nats.client.api.RetentionPolicy;
 import io.nats.client.api.StreamConfiguration;
 import io.quarkus.test.junit.QuarkusIntegrationTest;
 import org.apache.avro.Schema;
 import org.apache.avro.generic.GenericData;
 import org.apache.avro.generic.GenericRecord;
-import org.junit.jupiter.api.AfterAll;
-import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Tag;
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.*;
 import org.testcontainers.containers.GenericContainer;
 
 import java.io.IOException;
@@ -43,12 +40,12 @@ public class AvroNatsSerdeIT extends ApicurioRegistryBaseIT {
 
     public static final Integer NATS_PORT = 4222;
 
-    public static final Integer NATS_MGMT_PORT = 8222;
+    public static final Integer NATS_MNTR_PORT = 8222;
 
     @BeforeAll
     void setupEnvironment() {
         if (nats == null || !nats.isRunning()) {
-            nats = new GenericContainer<>("nats:2.10.20").withExposedPorts(NATS_PORT, NATS_MGMT_PORT)
+            nats = new GenericContainer<>("nats:2.10.20").withExposedPorts(NATS_PORT, NATS_MNTR_PORT)
                     .withCommand("--jetstream");
             nats.start();
         }
@@ -76,10 +73,10 @@ public void testNatsJsonSchema() throws IOException, InterruptedException, JetSt
             jsm = connection.jetStreamManagement();
 
             StreamConfiguration stream = new StreamConfiguration.Builder().subjects(subjectId).name(subjectId)
-                    .build();
+                    .retentionPolicy(RetentionPolicy.WorkQueue).build();
 
             ConsumerConfiguration consumerConfiguration = ConsumerConfiguration.builder().durable(subjectId)
-                    .durable(subjectId).filterSubject(subjectId).build();
+                    .durable(subjectId).filterSubject(subjectId).ackWait(2000).build();
 
             jsm.addStream(stream); // Create Stream in advance
             jsm.addOrUpdateConsumer(stream.getName(), consumerConfiguration); // Create Consumer in advance
@@ -95,16 +92,39 @@ public void testNatsJsonSchema() throws IOException, InterruptedException, JetSt
             NatsConsumer<GenericRecord> consumer = new NatsConsumerImpl<>(connection, subjectId, options,
                     configs);
 
-            producer.send(record);
+            producer.publish(record);
 
-            NatsConsumerRecord<GenericRecord> message = consumer.receive();
+            NatsConsumerRecord<GenericRecord> message = consumer.fetch();
 
             if (message.getPayload() != null) {
                 GenericRecord event1 = message.getPayload();
                 Assertions.assertEquals(record, event1);
             }
 
             message.ack();
+
+            producer.publish(record);
+            consumer.fetch().nak(); // Nak will redeliver the message until ack'd so message should be left in
+                                    // stream
+            Assertions.assertTrue(jsm.getStreamInfo(stream.getName()).getStreamState().getMsgCount() == 1);
+
+            jsm.purgeStream(stream.getName());
+            // producer.publish(record);
+            // consumer.fetch().term(); // this will terminate the message, since there was only one message
+            // in
+            // stream and after calling terminate we should not have any message left
+            // in stream
+            // Assertions.assertTrue(jsm.getStreamInfo(stream.getName()).getStreamState().getMsgCount() == 0);
+            producer.publish(record);
+
+            NatsConsumerRecord<GenericRecord> newMessage = consumer.fetch();
+            Thread.sleep(1000); // Ack wait is set to 2second for consumer,after 2 second if ack is not
+                                // received consumer will redeliver the message
+            newMessage.inProgress(); // with this we are resetting the ackwait to 2 second again so consumer
+                                     // do not redeliver the message. we should have a message in ack pending
+                                     // state
+            Assertions.assertTrue(jsm.getConsumerInfo(stream.getName(), consumerConfiguration.getDurable())
+                    .getNumAckPending() == 1);
         }
     }
 }

serdes/nats/avro-serde/src/main/java/io/apicurio/registry/serde/avro/nats/client/streaming/consumers/NatsConsumer.java

@@ -10,10 +10,10 @@ public interface NatsConsumer<T> extends AutoCloseable {
 
     String getSubject();
 
-    NatsConsumerRecord<T> receive() throws JetStreamApiException, IOException;
+    NatsConsumerRecord<T> fetch() throws JetStreamApiException, IOException;
 
-    NatsConsumerRecord<T> receive(Duration timeout) throws JetStreamApiException, IOException;
+    NatsConsumerRecord<T> fetch(Duration timeout) throws JetStreamApiException, IOException;
 
-    Collection<NatsConsumerRecord<T>> receive(int batchSize, Duration timeout)
+    Collection<NatsConsumerRecord<T>> fetch(int batchSize, Duration timeout)
             throws JetStreamApiException, IOException;
 }

serdes/nats/avro-serde/src/main/java/io/apicurio/registry/serde/avro/nats/client/streaming/consumers/NatsConsumerImpl.java

@@ -58,19 +58,19 @@ public String getSubject() {
     }
 
     @Override
-    public NatsConsumerRecord<DATA> receive() throws JetStreamApiException, IOException {
-        return receive(Duration.ofSeconds(3));
+    public NatsConsumerRecord<DATA> fetch() throws JetStreamApiException, IOException {
+        return fetch(Duration.ofSeconds(3));
     }
 
     @Override
-    public NatsConsumerRecord<DATA> receive(Duration timeout) throws JetStreamApiException, IOException {
-        Collection<NatsConsumerRecord<DATA>> messages = receive(1, timeout);
+    public NatsConsumerRecord<DATA> fetch(Duration timeout) throws JetStreamApiException, IOException {
+        Collection<NatsConsumerRecord<DATA>> messages = fetch(1, timeout);
         Optional<NatsConsumerRecord<DATA>> record = messages.stream().findFirst();
         return record.orElse(null);
     }
 
     @Override
-    public List<NatsConsumerRecord<DATA>> receive(int batchSize, Duration timeout)
+    public List<NatsConsumerRecord<DATA>> fetch(int batchSize, Duration timeout)
             throws JetStreamApiException, IOException {
         List<Message> messages = getLazySubscription().fetch(batchSize, timeout);
 

serdes/nats/avro-serde/src/main/java/io/apicurio/registry/serde/avro/nats/client/streaming/consumers/NatsConsumerRecord.java

@@ -9,4 +9,10 @@ public interface NatsConsumerRecord<T> {
     T getPayload();
 
     void ack();
+
+    void nak();
+
+    void term();
+
+    void inProgress();
 }

serdes/nats/avro-serde/src/main/java/io/apicurio/registry/serde/avro/nats/client/streaming/consumers/NatsConsumerRecordImpl.java

@@ -27,4 +27,19 @@ public T getPayload() {
     public void ack() {
         natsMessage.ack();
     }
+
+    @Override
+    public void nak() {
+        natsMessage.nak();
+    }
+
+    @Override
+    public void term() {
+        natsMessage.term();
+    }
+
+    @Override
+    public void inProgress() {
+        natsMessage.inProgress();
+    }
 }

serdes/nats/avro-serde/src/main/java/io/apicurio/registry/serde/avro/nats/client/streaming/producers/NatsProducer.java

@@ -4,5 +4,5 @@
 
 public interface NatsProducer<T> extends AutoCloseable {
 
-    void send(T message) throws ApicurioNatsException;
+    void publish(T message) throws ApicurioNatsException;
 }

serdes/nats/avro-serde/src/main/java/io/apicurio/registry/serde/avro/nats/client/streaming/producers/NatsProducerImpl.java

@@ -32,7 +32,7 @@ public NatsProducerImpl(Connection connection, String subject, Map<String, Objec
     }
 
     @Override
-    public void send(DATA message) throws ApicurioNatsException {
+    public void publish(DATA message) throws ApicurioNatsException {
         byte[] data = serializer.serializeData(subject, message);
 
         try {