Add button/link to the retransmission from view documentation, shown …

…in the retransmission popup
allegro · Oct 18, 2024 · ec1d3e4 · ec1d3e4
1 parent 7aa1890
commit ec1d3e4
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 5 deletions.
diff --git a/hermes-console/json-server/db.json b/hermes-console/json-server/db.json
@@ -662,7 +662,8 @@
         }
       ],
       "offlineRetransmissionEnabled": true,
-      "offlineRetransmissionDescription": "Offline retransmission"
+      "offlineRetransmissionDescription": "Offline retransmission",
+      "offlineRetransmissionFromViewDocsUrl": "https://hermes-pubsub.rtfd.org"
     },
     "subscription": {
       "endpointAddressResolverMetadata": {

diff --git a/hermes-console/src/api/app-configuration.ts b/hermes-console/src/api/app-configuration.ts
@@ -84,6 +84,7 @@ export interface TopicViewConfiguration {
   retentionUnits: RetentionUnit[];
   offlineRetransmissionEnabled: boolean;
   offlineRetransmissionDescription: string;
+  offlineRetransmissionFromViewDocsUrl: string;
 }
 
 export interface DefaultTopicViewConfiguration {

diff --git a/hermes-console/src/dummy/app-config.ts b/hermes-console/src/dummy/app-config.ts
@@ -88,6 +88,7 @@ export const dummyAppConfig: AppConfiguration = {
     offlineRetransmissionEnabled: true,
     offlineRetransmissionDescription:
       'Offline retransmission allows retransmitting events from GCP (BigQuery) to Hermes.',
+    offlineRetransmissionFromViewDocsUrl: 'https://hermes-pubsub.rtfd.org',
   },
   subscription: {
     endpointAddressResolverMetadata: {

diff --git a/hermes-console/src/i18n/en-US/index.ts b/hermes-console/src/i18n/en-US/index.ts
@@ -645,6 +645,7 @@ const en_US = {
   },
   offlineRetransmission: {
     title: 'Offline retransmission',
+    titleRetransmissionFromView: 'Docs for retransmission from View',
     subtitle:
       'Offline retransmission allows retransmitting events from GCP (BigQuery) to Hermes.',
     targetTopic: 'Target topic',

diff --git a/hermes-console/src/views/topic/offline-retransmission/OfflineRetransmissionForm.spec.ts b/hermes-console/src/views/topic/offline-retransmission/OfflineRetransmissionForm.spec.ts
@@ -1,12 +1,17 @@
+import { createTestingPinia } from '@pinia/testing';
 import { describe } from 'vitest';
+import { dummyAppConfig } from '@/dummy/app-config';
 import { renderWithEmits } from '@/utils/test-utils';
 import { waitFor } from '@testing-library/vue';
 import OfflineRetransmissionForm from '@/views/topic/offline-retransmission/OfflineRetransmissionForm.vue';
 
 describe('OfflineRetransmissionForm', () => {
   it('should emit a cancel event when user clicks cancel button', async () => {
     // given
-    const wrapper = renderWithEmits(OfflineRetransmissionForm, {});
+    const wrapper = renderWithEmits(
+      OfflineRetransmissionForm,
+      createInitialState(),
+    );
 
     // when
     await wrapper
@@ -22,7 +27,10 @@ describe('OfflineRetransmissionForm', () => {
 
   it('should emit a retransmit event when user clicks retransmit button', async () => {
     // given
-    const wrapper = renderWithEmits(OfflineRetransmissionForm, {});
+    const wrapper = renderWithEmits(
+      OfflineRetransmissionForm,
+      createInitialState(),
+    );
 
     // when
     await wrapper
@@ -55,3 +63,21 @@ describe('OfflineRetransmissionForm', () => {
     });
   });
 });
+
+function createInitialState() {
+  return {
+    testPinia: createTestingPinia({
+      initialState: {
+        appConfig: {
+          appConfig: {
+            ...dummyAppConfig,
+          },
+          loading: false,
+          error: {
+            loadConfig: null,
+          },
+        },
+      },
+    }),
+  };
+}
diff --git a/hermes-console/src/views/topic/offline-retransmission/OfflineRetransmissionForm.vue b/hermes-console/src/views/topic/offline-retransmission/OfflineRetransmissionForm.vue
@@ -1,11 +1,13 @@
 <script setup lang="ts">
   import { ref } from 'vue';
+  import { useAppConfigStore } from '@/store/app-config/useAppConfigStore';
 
   const emit = defineEmits<{
     retransmit: [targetTopic: string, from: string, to: string];
     cancel: [];
   }>();
 
+  const configStore = useAppConfigStore();
   const targetTopic = ref('');
   const startTimestamp = ref(new Date().toISOString().slice(0, -5));
   const endTimestamp = ref(new Date().toISOString().slice(0, -5));
@@ -23,7 +25,21 @@
 <template>
   <v-form @submit.prevent>
     <v-card>
-      <v-card-title> {{ $t('offlineRetransmission.title') }}</v-card-title>
+      <v-card-title>
+        {{ $t('offlineRetransmission.title') }}
+        <v-btn
+          density="compact"
+          variant="outlined"
+          prepend-icon="mdi-open-in-new"
+          target="_blank"
+          :href="
+            configStore.loadedConfig.topic.offlineRetransmissionFromViewDocsUrl
+          "
+        >
+          <v-icon></v-icon>
+          {{ $t('offlineRetransmission.titleRetransmissionFromView') }}</v-btn
+        >
+      </v-card-title>
       <v-card-subtitle>{{
         $t('offlineRetransmission.subtitle')
       }}</v-card-subtitle>

diff --git a/...ent/src/main/java/pl/allegro/tech/hermes/management/config/console/ConsoleProperties.java b/...ent/src/main/java/pl/allegro/tech/hermes/management/config/console/ConsoleProperties.java
@@ -348,8 +348,10 @@ public static final class TopicView {
     private Set<String> allowedTopicLabels = Collections.emptySet();
     private List<RetentionUnit> retentionUnits =
         Lists.newArrayList(new RetentionUnit("DAYS", "DAYS"));
-    private boolean offlineRetransmissionEnabled = false;
+    private boolean offlineRetransmissionEnabled = true;
     private String offlineRetransmissionDescription = "Offline retransmission";
+    private String offlineRetransmissionFromViewDocsUrl =
+        "https://appengine.allegrogroup.com/en/latest/communication_messaging/hermes/offline_retransmission/";
 
     public boolean isMessagePreviewEnabled() {
       return messagePreviewEnabled;
@@ -462,6 +464,15 @@ public String getOfflineRetransmissionDescription() {
     public void setOfflineRetransmissionDescription(String offlineRetransmissionDescription) {
       this.offlineRetransmissionDescription = offlineRetransmissionDescription;
     }
+
+    public String getOfflineRetransmissionFromViewDocsUrl() {
+      return offlineRetransmissionFromViewDocsUrl;
+    }
+
+    public void setOfflineRetransmissionFromViewDocsUrl(
+        String offlineRetransmissionFromViewDocsUrl) {
+      this.offlineRetransmissionFromViewDocsUrl = offlineRetransmissionFromViewDocsUrl;
+    }
   }
 
   public static final class DefaultTopicView {