Added option includeStats to DescribeTopicSettings

Author: alex268

topic/src/main/java/tech/ydb/topic/description/TopicStats.java

@@ -6,6 +6,9 @@
 
 import javax.annotation.Nullable;
 
+import tech.ydb.core.utils.ProtobufUtils;
+import tech.ydb.proto.topic.YdbTopic;
+
 /**
  * @author Nikolay Perfilov
  */
@@ -16,6 +19,18 @@ public class TopicStats {
     private final Duration maxWriteTimeLag;
     private final MultipleWindowsStat bytesWritten;
 
+    public TopicStats(YdbTopic.DescribeTopicResult.TopicStats stats) {
+        this.storeSizeBytes = stats.getStoreSizeBytes();
+        this.minLastWriteTime = ProtobufUtils.protoToInstant(stats.getMinLastWriteTime());
+        this.maxWriteTimeLag = ProtobufUtils.protoToDuration(stats.getMaxWriteTimeLag());
+        this.bytesWritten = new MultipleWindowsStat(
+                stats.getBytesWritten().getPerMinute(),
+                stats.getBytesWritten().getPerHour(),
+                stats.getBytesWritten().getPerDay()
+        );
+    }
+
+    @Deprecated
     private TopicStats(Builder builder) {
         this.storeSizeBytes = builder.storeSizeBytes;
         this.minLastWriteTime = builder.minLastWriteTime;
@@ -40,13 +55,15 @@ public MultipleWindowsStat getBytesWritten() {
         return bytesWritten;
     }
 
+    @Deprecated
     public static TopicDescription.Builder newBuilder() {
         return new TopicDescription.Builder();
     }
 
     /**
      * BUILDER
      */
+    @Deprecated
     public static class Builder {
         private long storeSizeBytes;
         private Instant minLastWriteTime;

topic/src/main/java/tech/ydb/topic/impl/TopicClientImpl.java

@@ -31,6 +31,7 @@
 import tech.ydb.topic.description.PartitionStats;
 import tech.ydb.topic.description.SupportedCodecs;
 import tech.ydb.topic.description.TopicDescription;
+import tech.ydb.topic.description.TopicStats;
 import tech.ydb.topic.read.AsyncReader;
 import tech.ydb.topic.read.SyncReader;
 import tech.ydb.topic.read.impl.AsyncReaderImpl;
@@ -284,11 +285,13 @@ public CompletableFuture<Status> dropTopic(String path, DropTopicSettings settin
     public CompletableFuture<Result<TopicDescription>> describeTopic(String path, DescribeTopicSettings settings) {
         YdbTopic.DescribeTopicRequest request = YdbTopic.DescribeTopicRequest.newBuilder()
                 .setOperationParams(Operation.buildParams(settings))
+                .setIncludeStats(settings.isIncludeStats())
                 .setPath(path)
                 .build();
+
         final GrpcRequestSettings grpcRequestSettings = makeGrpcRequestSettings(settings);
         return topicRpc.describeTopic(request, grpcRequestSettings)
-                .thenApply(result -> result.map(this::mapDescribeTopic));
+                .thenApply(result -> result.map(desc -> mapDescribeTopic(desc, settings.isIncludeStats())));
     }
 
     @Override
@@ -308,7 +311,7 @@ public CompletableFuture<Result<ConsumerDescription>> describeConsumer(
     }
 
     @SuppressWarnings("deprecation")
-    private TopicDescription mapDescribeTopic(YdbTopic.DescribeTopicResult result) {
+    private TopicDescription mapDescribeTopic(YdbTopic.DescribeTopicResult result, boolean includeStats) {
         if (logger.isTraceEnabled()) {
             logger.trace("Received topic describe response:\n{}", result);
         }
@@ -351,6 +354,10 @@ private TopicDescription mapDescribeTopic(YdbTopic.DescribeTopicResult result) {
                     .setParentPartitionIds(partition.getParentPartitionIdsList())
                     .setPartitionStats(new PartitionStats(partition.getPartitionStats()));
 
+            if (includeStats) {
+                partitionBuilder.setPartitionStats(new PartitionStats(partition.getPartitionStats()));
+            }
+
             partitions.add(partitionBuilder.build());
         }
         description.setPartitions(partitions);
@@ -364,6 +371,10 @@ private TopicDescription mapDescribeTopic(YdbTopic.DescribeTopicResult result) {
         description.setConsumers(result.getConsumersList().stream()
                 .map(Consumer::new).collect(Collectors.toList()));
 
+        if (includeStats) {
+            description.setTopicStats(new TopicStats(result.getTopicStats()));
+        }
+
         return description.build();
     }
 

topic/src/main/java/tech/ydb/topic/settings/DescribeTopicSettings.java

@@ -6,30 +6,29 @@
  * @author Nikolay Perfilov
  */
 public class DescribeTopicSettings extends OperationSettings {
-    /* TODO: renew api and add stats
-    private boolean includeStats = false;
+    private final boolean includeStats;
 
-    public DescribeTopicSettings(boolean includeStats) {
-        this.includeStats = includeStats;
-    }
-
-    public void setIncludeStats(boolean includeStats) {
-        this.includeStats = includeStats;
+    private DescribeTopicSettings(Builder builder) {
+        super(builder);
+        this.includeStats = builder.includeStats;
     }
 
-    public boolean getIncludeStats() {
+    public boolean isIncludeStats() {
         return includeStats;
-    }*/
-
-    private DescribeTopicSettings(Builder builder) {
-        super(builder);
     }
 
     public static Builder newBuilder() {
         return new Builder();
     }
 
     public static class Builder extends OperationBuilder<Builder> {
+        private boolean includeStats = false;
+
+        public Builder withIncludeStats(boolean includeStats) {
+            this.includeStats = includeStats;
+            return this;
+        }
+
         @Override
         public DescribeTopicSettings build() {
             return new DescribeTopicSettings(this);

topic/src/test/java/tech/ydb/topic/impl/YdbTopicsIntegrationTest.java

@@ -22,6 +22,7 @@
 import tech.ydb.test.junit4.GrpcTransportRule;
 import tech.ydb.topic.TopicClient;
 import tech.ydb.topic.description.Consumer;
+import tech.ydb.topic.description.PartitionInfo;
 import tech.ydb.topic.description.TopicDescription;
 import tech.ydb.topic.read.AsyncReader;
 import tech.ydb.topic.read.DeferredCommitter;
@@ -34,6 +35,7 @@
 import tech.ydb.topic.settings.AutoPartitioningStrategy;
 import tech.ydb.topic.settings.AutoPartitioningWriteStrategySettings;
 import tech.ydb.topic.settings.CreateTopicSettings;
+import tech.ydb.topic.settings.DescribeTopicSettings;
 import tech.ydb.topic.settings.PartitioningSettings;
 import tech.ydb.topic.settings.ReadEventHandlersSettings;
 import tech.ydb.topic.settings.ReaderSettings;
@@ -299,4 +301,32 @@ public void step08_createTopicWithAutoPartitioning() {
 
         Assert.assertEquals(expectedPartitioningSettings, description.getPartitioningSettings());
     }
+
+    @Test
+    public void step09_describeTopicStats() {
+        DescribeTopicSettings on = DescribeTopicSettings.newBuilder().withIncludeStats(true).build();
+        DescribeTopicSettings off = DescribeTopicSettings.newBuilder().withIncludeStats(false).build();
+
+        TopicDescription withStats = client.describeTopic(TEST_TOPIC, on).join().getValue();
+        TopicDescription withoutStats = client.describeTopic(TEST_TOPIC, off).join().getValue();
+
+        Assert.assertNull(withoutStats.getTopicStats());
+        Assert.assertNotNull(withStats.getTopicStats());
+
+        for (Consumer consumer: withoutStats.getConsumers()) {
+            // TODO: fix it, must be null
+            Assert.assertNotNull(consumer.getStats());
+        }
+        for (Consumer consumer: withStats.getConsumers()) {
+            Assert.assertNotNull(consumer.getStats());
+        }
+
+        for (PartitionInfo partition: withoutStats.getPartitions()) {
+            // TODO: fix it, must be null
+            Assert.assertNotNull(partition.getPartitionStats());
+        }
+        for (PartitionInfo partition: withStats.getPartitions()) {
+            Assert.assertNotNull(partition.getPartitionStats());
+        }
+   }
 }