Hermes console vue stats (#1703)

hermes-api/src/main/java/pl/allegro/tech/hermes/api/Stats.java

@@ -0,0 +1,46 @@
+package pl.allegro.tech.hermes.api;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.Objects;
+
+public class Stats {
+    private final TopicStats topicStats;
+    private final SubscriptionStats subscriptionStats;
+
+    @JsonCreator
+    public Stats(@JsonProperty("topicStats") TopicStats topicStats, @JsonProperty("subscriptionStats") SubscriptionStats subscriptionStats) {
+        this.topicStats = topicStats;
+        this.subscriptionStats = subscriptionStats;
+    }
+
+    public TopicStats getTopicStats() {
+        return topicStats;
+    }
+
+    public SubscriptionStats getSubscriptionStats() {
+        return subscriptionStats;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        Stats stats = (Stats) o;
+        return Objects.equals(topicStats, stats.topicStats) && Objects.equals(subscriptionStats, stats.subscriptionStats);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(topicStats, subscriptionStats);
+    }
+
+    @Override
+    public String toString() {
+        return "Stats{" +
+                "topicStats=" + topicStats +
+                ", subscriptionStats=" + subscriptionStats +
+                '}';
+    }
+}

hermes-api/src/main/java/pl/allegro/tech/hermes/api/SubscriptionStats.java

@@ -0,0 +1,57 @@
+package pl.allegro.tech.hermes.api;
+
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.Objects;
+
+public class SubscriptionStats {
+    private final long subscriptionCount;
+    private final long trackingEnabledSubscriptionCount;
+    private final long avroSubscriptionCount;
+
+    @JsonCreator
+    public SubscriptionStats(
+            @JsonProperty("subscriptionCount") long  subscriptionCount,
+            @JsonProperty("trackingEnabledSubscriptionCount") long  trackingEnabledSubscriptionCount,
+            @JsonProperty("avroSubscriptionCount") long  avroSubscriptionCount) {
+        this.subscriptionCount = subscriptionCount;
+        this.trackingEnabledSubscriptionCount = trackingEnabledSubscriptionCount;
+        this.avroSubscriptionCount = avroSubscriptionCount;
+    }
+
+    public long getSubscriptionCount() {
+        return subscriptionCount;
+    }
+
+    public long getTrackingEnabledSubscriptionCount() {
+        return trackingEnabledSubscriptionCount;
+    }
+
+    public long getAvroSubscriptionCount() {
+        return avroSubscriptionCount;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        SubscriptionStats that = (SubscriptionStats) o;
+        return subscriptionCount == that.subscriptionCount && trackingEnabledSubscriptionCount == that.trackingEnabledSubscriptionCount && avroSubscriptionCount == that.avroSubscriptionCount;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(subscriptionCount, trackingEnabledSubscriptionCount, avroSubscriptionCount);
+    }
+
+    @Override
+    public String toString() {
+        return "SubscriptionStats{" +
+                "subscriptionCount=" + subscriptionCount +
+                ", trackingEnabledSubscriptionCount=" + trackingEnabledSubscriptionCount +
+                ", avroSubscriptionCount=" + avroSubscriptionCount +
+                '}';
+    }
+}

hermes-api/src/main/java/pl/allegro/tech/hermes/api/TopicStats.java

@@ -0,0 +1,63 @@
+package pl.allegro.tech.hermes.api;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.Objects;
+
+public class TopicStats {
+    private final long topicCount;
+    private final long ackAllTopicCount;
+    private final long trackingEnabledTopicCount;
+    private final long avroTopicCount;
+
+    @JsonCreator
+    public TopicStats(@JsonProperty("topicCount") long topicCount,
+                      @JsonProperty("ackAllTopicCount") long ackAllTopicCount,
+                      @JsonProperty("trackingEnabledTopicCount") long trackingEnabledTopicCount,
+                      @JsonProperty("avroTopicCount") long avroTopicCount) {
+        this.topicCount = topicCount;
+        this.ackAllTopicCount = ackAllTopicCount;
+        this.trackingEnabledTopicCount = trackingEnabledTopicCount;
+        this.avroTopicCount = avroTopicCount;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        TopicStats that = (TopicStats) o;
+        return topicCount == that.topicCount && ackAllTopicCount == that.ackAllTopicCount && trackingEnabledTopicCount == that.trackingEnabledTopicCount && avroTopicCount == that.avroTopicCount;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(topicCount, ackAllTopicCount, trackingEnabledTopicCount, avroTopicCount);
+    }
+
+    @Override
+    public String toString() {
+        return "TopicStats{" +
+                "topicCount=" + topicCount +
+                ", ackAllTopicCount=" + ackAllTopicCount +
+                ", trackingEnabledTopicCount=" + trackingEnabledTopicCount +
+                ", avroTopicCount=" + avroTopicCount +
+                '}';
+    }
+
+    public long getTopicCount() {
+        return topicCount;
+    }
+
+    public long getAckAllTopicCount() {
+        return ackAllTopicCount;
+    }
+
+    public long getTrackingEnabledTopicCount() {
+        return trackingEnabledTopicCount;
+    }
+
+    public long getAvroTopicCount() {
+        return avroTopicCount;
+    }
+}

hermes-api/src/main/java/pl/allegro/tech/hermes/api/endpoints/StatsEndpoint.java

@@ -0,0 +1,15 @@
+package pl.allegro.tech.hermes.api.endpoints;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.Produces;
+import pl.allegro.tech.hermes.api.Stats;
+
+import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON;
+
+@Path("stats")
+public interface StatsEndpoint {
+    @GET
+    @Produces(APPLICATION_JSON)
+    Stats getStats();
+}

hermes-console-vue/json-server/db.json

@@ -552,5 +552,18 @@
     "group": {
       "nonAdminCreationEnabled": false
     }
+  },
+  "stats": {
+    "topicStats": {
+      "topicCount": 111,
+      "ackAllTopicCount": 33,
+      "trackingEnabledTopicCount": 12,
+      "avroTopicCount": 95
+    },
+    "subscriptionStats": {
+      "subscriptionCount": 527,
+      "trackingEnabledSubscriptionCount": 67,
+      "avroSubscriptionCount": 100
+    }
   }
 }

hermes-console-vue/json-server/routes.json

@@ -14,5 +14,6 @@
   "/topics/:topicName/subscriptions/:id/metrics": "/subscriptionsMetrics/:id",
   "/topics/:topicName/subscriptions/:id/undelivered": "/subscriptionUndeliveredMessages",
   "/topics/:topicName/subscriptions/:id/undelivered/last": "/subscriptionUndeliveredMessages/:id",
-  "/workload-constraints": "/constraints"
+  "/workload-constraints": "/constraints",
+  "/stats": "/stats"
 }

hermes-console-vue/src/api/hermes-client/index.ts

@@ -11,6 +11,7 @@ import type {
 import type { OfflineClientsSource } from '@/api/offline-clients-source';
 import type { Owner } from '@/api/owner';
 import type { ResponsePromise } from '@/utils/axios-utils';
+import type { Stats } from '@/api/stats';
 import type { Subscription } from '@/api/subscription';
 
 export function fetchTopic(
@@ -91,3 +92,7 @@ export function fetchTopicNames(): ResponsePromise<string[]> {
 export function fetchGroupNames(): ResponsePromise<string[]> {
   return axios.get<string[]>('/groups');
 }
+
+export function fetchStats(): ResponsePromise<Stats> {
+  return axios.get<Stats>(`/stats`);
+}

hermes-console-vue/src/api/stats.ts

@@ -0,0 +1,17 @@
+export interface Stats {
+  topicStats: TopicStats;
+  subscriptionStats: SubscriptionStats;
+}
+
+export interface TopicStats {
+  topicCount: number;
+  ackAllTopicCount: number;
+  trackingEnabledTopicCount: number;
+  avroTopicCount: number;
+}
+
+export interface SubscriptionStats {
+  subscriptionCount: number;
+  trackingEnabledSubscriptionCount: number;
+  avroSubscriptionCount: number;
+}

hermes-console-vue/src/composables/use-stats/useStats.spec.ts

@@ -0,0 +1,116 @@
+import { afterEach } from 'vitest';
+import { fetchStatsErrorHandler, fetchStatsHandler } from '@/mocks/handlers';
+import { setupServer } from 'msw/node';
+import { statsResponse } from '@/dummy/stats';
+import { useStats } from '@/composables/use-stats/useStats';
+import { waitFor } from '@testing-library/vue';
+
+describe('useStats', () => {
+  const server = setupServer(fetchStatsHandler({ stats: statsResponse }));
+
+  afterEach(() => {
+    server.resetHandlers();
+  });
+
+  it('should fetch stats details from Hermes API', async () => {
+    // given
+    server.listen();
+
+    // when
+    const { stats, loading, error } = useStats();
+
+    // then
+    expect(loading.value).toBeTruthy();
+
+    await waitFor(() => {
+      expect(loading.value).toBeFalsy();
+      expect(error.value.fetchError).toBeNull();
+      const {
+        topicCount,
+        ackAllTopicCount,
+        ackAllTopicShare,
+        trackingEnabledTopicCount,
+        trackingEnabledTopicShare,
+        avroTopicCount,
+        avroTopicShare,
+        subscriptionCount,
+        trackingEnabledSubscriptionCount,
+        trackingEnabledSubscriptionShare,
+        avroSubscriptionCount,
+        avroSubscriptionShare,
+      } = stats.value!!;
+
+      expect(topicCount).toEqual(statsResponse.topicStats.topicCount);
+      expect(ackAllTopicCount).toEqual(
+        statsResponse.topicStats.ackAllTopicCount,
+      );
+      expect(ackAllTopicShare).toBeCloseTo(
+        share(
+          statsResponse.topicStats.ackAllTopicCount,
+          statsResponse.topicStats.topicCount,
+        ),
+        0.001,
+      );
+      expect(avroTopicCount).toEqual(statsResponse.topicStats.avroTopicCount);
+      expect(avroTopicShare).toBeCloseTo(
+        share(
+          statsResponse.topicStats.avroTopicCount,
+          statsResponse.topicStats.topicCount,
+        ),
+        0.001,
+      );
+      expect(trackingEnabledTopicCount).toEqual(
+        statsResponse.topicStats.trackingEnabledTopicCount,
+      );
+      expect(trackingEnabledTopicShare).toBeCloseTo(
+        share(
+          statsResponse.topicStats.trackingEnabledTopicCount,
+          statsResponse.topicStats.topicCount,
+        ),
+        0.001,
+      );
+      expect(subscriptionCount).toEqual(
+        statsResponse.subscriptionStats.subscriptionCount,
+      );
+      expect(avroSubscriptionCount).toEqual(
+        statsResponse.subscriptionStats.avroSubscriptionCount,
+      );
+      expect(avroSubscriptionShare).toBeCloseTo(
+        share(
+          statsResponse.subscriptionStats.avroSubscriptionCount,
+          statsResponse.subscriptionStats.subscriptionCount,
+        ),
+        0.001,
+      );
+      expect(trackingEnabledSubscriptionCount).toEqual(
+        statsResponse.subscriptionStats.trackingEnabledSubscriptionCount,
+      );
+      expect(trackingEnabledSubscriptionShare).toBeCloseTo(
+        share(
+          statsResponse.subscriptionStats.trackingEnabledSubscriptionCount,
+          statsResponse.subscriptionStats.subscriptionCount,
+        ),
+        0.001,
+      );
+    });
+  });
+
+  it('should set error to true on stats endpoint failure', async () => {
+    // given
+    server.use(fetchStatsErrorHandler({ errorCode: 500 }));
+    server.listen();
+
+    // when
+    const { loading, error } = useStats();
+
+    // then
+    await waitFor(() => {
+      expect(loading.value).toBe(false);
+      expect(error.value.fetchError).not.toBeNull();
+    });
+  });
+});
+
+function share(numerator: number, denominator: number): number {
+  return (numerator / denominator) * 100;
+}