Minor UI improvements (#1892)

* Make filtered message receiver always returning a message * Added inflight to subscription form * Added inflight to subscription form * Added inflight to subscription form * CR fix * CR fix
allegro · Oct 4, 2024 · 4d47803 · 4d47803
1 parent 9e31b1e
commit 4d47803
Show file tree

Hide file tree

Showing 18 changed files with 101 additions and 14 deletions.
diff --git a/hermes-console/src/api/subscription.ts b/hermes-console/src/api/subscription.ts
@@ -128,6 +128,7 @@ export interface SerialSubscriptionPolicyJson {
   backoffMultiplier: number;
   messageBackoff: number;
   messageTtl: number;
+  inflightSize: number;
   rate: number;
   requestTimeout: number;
   sendingDelay: number;

diff --git a/hermes-console/src/composables/subscription/use-create-subscription/useCreateSubscription.ts b/hermes-console/src/composables/subscription/use-create-subscription/useCreateSubscription.ts
@@ -126,6 +126,7 @@ function initializeForm(
       inflightMessageTTL:
         loadedConfig.value.subscription.defaults.subscriptionPolicy
           .messageTtl || 3600,
+      inflightMessagesCount: null,
       retryBackoff: 1000,
       retryBackoffMultiplier: 1.0,
       backoffMaxIntervalInSec: 600,

diff --git a/hermes-console/src/composables/subscription/use-form-subscription/form-mapper.ts b/hermes-console/src/composables/subscription/use-form-subscription/form-mapper.ts
@@ -76,6 +76,9 @@ function mapSerialSubscriptionPolicy(
     ),
     messageBackoff: parseFloat(String(form.subscriptionPolicy.retryBackoff)),
     messageTtl: parseFloat(String(form.subscriptionPolicy.inflightMessageTTL)),
+    inflightSize: parseFloat(
+      String(form.subscriptionPolicy.inflightMessagesCount),
+    ),
     rate: parseFloat(String(form.subscriptionPolicy.rateLimit!!)),
     requestTimeout: parseFloat(String(form.subscriptionPolicy.requestTimeout)),
     sendingDelay: parseFloat(String(form.subscriptionPolicy.sendingDelay)),

diff --git a/hermes-console/src/composables/subscription/use-form-subscription/types.ts b/hermes-console/src/composables/subscription/use-form-subscription/types.ts
@@ -38,6 +38,7 @@ export interface SubscriptionForm {
 export interface FormSubscriptionPolicy {
   rateLimit: number | null;
   inflightMessageTTL: number;
+  inflightMessagesCount: number | null;
   retryBackoff: number;
   sendingDelay: number;
   retryBackoffMultiplier: number;
@@ -69,6 +70,7 @@ export interface FormValidators {
   requestTimeout: FieldValidator<number>[];
   sendingDelay: FieldValidator<number>[];
   inflightMessageTTL: FieldValidator<number>[];
+  inflightMessagesCount: FieldValidator<number>[];
   retryBackoff: FieldValidator<number>[];
   retryBackoffMultiplier: FieldValidator<number>[];
   backoffMaxIntervalInSec: FieldValidator<number>[];

diff --git a/hermes-console/src/composables/subscription/use-form-subscription/useFormSubscription.ts b/hermes-console/src/composables/subscription/use-form-subscription/useFormSubscription.ts
@@ -68,6 +68,7 @@ function formValidators(form: Ref<SubscriptionForm>): FormValidators {
     ],
     sendingDelay: [required(), min(0), max(5000)],
     inflightMessageTTL: [required(), min(0), max(7200)],
+    inflightMessagesCount: [min(1)],
     retryBackoff: [required(), min(0), max(1000000)],
     retryBackoffMultiplier: [required(), min(1), max(10)],
     backoffMaxIntervalInSec: [required(), min(1), max(600)],
@@ -178,6 +179,7 @@ function createEmptyForm(): Ref<SubscriptionForm> {
     subscriptionPolicy: {
       rateLimit: null,
       inflightMessageTTL: 3600,
+      inflightMessagesCount: null,
       retryBackoff: 1000,
       retryBackoffMultiplier: 1.0,
       backoffMaxIntervalInSec: 600,
@@ -222,6 +224,7 @@ export function initializeFullyFilledForm(
           ? subscription.subscriptionPolicy.rate
           : null,
       inflightMessageTTL: subscription.subscriptionPolicy.messageTtl,
+      inflightMessagesCount: subscription.subscriptionPolicy.inflightSize,
       retryBackoff: subscription.subscriptionPolicy.messageBackoff,
       retryBackoffMultiplier:
         subscription.deliveryType === DeliveryType.SERIAL

diff --git a/hermes-console/src/composables/topic/use-form-topic/types.ts b/hermes-console/src/composables/topic/use-form-topic/types.ts
@@ -50,7 +50,8 @@ export interface FormValidators {
   ownerSource: FieldValidator<string>[];
   owner: FieldValidator<any>[];
   contentType: FieldValidator<string>[];
-  retentionTimeDuration: FieldValidator<number>[];
+  retentionTimeDurationHours: FieldValidator<number>[];
+  retentionTimeDurationDays: FieldValidator<number>[];
   maxMessageSize: FieldValidator<number>[];
   offlineRetentionTime: FieldValidator<number>[];
   ack: FieldValidator<string>[];

diff --git a/hermes-console/src/composables/topic/use-form-topic/useFormTopic.ts b/hermes-console/src/composables/topic/use-form-topic/useFormTopic.ts
@@ -38,9 +38,10 @@ function formValidators(): FormValidators {
     ownerSource: [required()],
     owner: [required()],
     contentType: [required()],
-    retentionTimeDuration: [required(), min(0), max(7)],
+    retentionTimeDurationDays: [required(), min(1), max(7)],
+    retentionTimeDurationHours: [required(), min(1), max(24)],
     maxMessageSize: [required(), min(0)],
-    offlineRetentionTime: [required(), min(0)],
+    offlineRetentionTime: [required(), min(1)],
     ack: [required()],
   };
 }

diff --git a/hermes-console/src/dummy/subscription-form.ts b/hermes-console/src/dummy/subscription-form.ts
@@ -18,6 +18,7 @@ export const dummySubscriptionForm = {
   subscriptionPolicy: {
     rateLimit: null,
     inflightMessageTTL: 3600,
+    inflightMessagesCount: null,
     retryBackoff: 1000,
     retryBackoffMultiplier: 1.0,
     backoffMaxIntervalInSec: 600,
@@ -59,6 +60,7 @@ export const dummySubscriptionFormValidator = {
   requestTimeout: [required(), min(0), max(10000)],
   sendingDelay: [required(), min(0), max(5000)],
   inflightMessageTTL: [required(), min(0), max(7200)],
+  inflightMessagesCount: [min(1)],
   retryBackoff: [required(), min(0), max(1000000)],
   retryBackoffMultiplier: [required(), min(1), max(10)],
   backoffMaxIntervalInSec: [required(), min(1), max(600)],
@@ -143,6 +145,7 @@ export const dummyInitializedSubscriptionForm = {
     inflightMessageTTL:
       dummyAppConfig.subscription.defaults.subscriptionPolicy.messageTtl ||
       3600,
+    inflightMessagesCount: null,
     retryBackoff: 1000,
     retryBackoffMultiplier: 1.0,
     backoffMaxIntervalInSec: 600,
@@ -183,6 +186,7 @@ export const dummyInitializedEditSubscriptionForm = {
   subscriptionPolicy: {
     rateLimit: dummySubscription.subscriptionPolicy.rate,
     inflightMessageTTL: dummySubscription.subscriptionPolicy.messageTtl,
+    inflightMessagesCount: dummySubscription.subscriptionPolicy.inflightSize,
     retryBackoff: dummySubscription.subscriptionPolicy.messageBackoff,
     retryBackoffMultiplier:
       dummySubscription.subscriptionPolicy.backoffMultiplier,

diff --git a/hermes-console/src/dummy/topic-form.ts b/hermes-console/src/dummy/topic-form.ts
@@ -43,7 +43,8 @@ export const dummyTopicFormValidator = {
   ownerSource: [required()],
   owner: [required()],
   contentType: [required()],
-  retentionTimeDuration: [required(), min(0), max(7)],
+  retentionTimeDurationDays: [required(), min(1), max(7)],
+  retentionTimeDurationHours: [required(), min(1), max(24)],
   maxMessageSize: [required(), min(0)],
   offlineRetentionTime: [required(), min(0)],
   ack: [required()],

diff --git a/hermes-console/src/i18n/en-US/subscription-form.ts b/hermes-console/src/i18n/en-US/subscription-form.ts
@@ -64,6 +64,11 @@ const messages = {
         'Time when message can be resent to endpoint after failed sending attempts',
       suffix: 'seconds',
     },
+    inflightMessagesCount: {
+      label: 'Inflight messages count',
+      placeholder:
+        'How many messages can be in inflight state at the same time',
+    },
     retryOn4xx: {
       label: 'Retry on http 4xx status',
     },
@@ -118,6 +123,10 @@ const messages = {
       title: 'Warning: Tracking all messages enabled',
       text: 'Please chose this option only when necessary. Mainly this is for debugging problems with subscription. Remember to disable this mode after the problem is solved.',
     },
+    adminForm: {
+      title: 'Warning: Admin form enabled.',
+      text: 'New fields in the form have been revealed (they are followed by a warning sign). The form will be submitted regardless of the validation of the fields.',
+    },
   },
   actions: {
     create: 'Create subscription',

diff --git a/hermes-console/src/i18n/en-US/topic-form.ts b/hermes-console/src/i18n/en-US/topic-form.ts
@@ -56,6 +56,10 @@ const messages = {
       title: 'Warning: Tracking all messages enabled',
       text: 'Please chose this option only when necessary. Mainly this is for debugging problems with subscription. Remember to disable this mode after the problem is solved.',
     },
+    adminForm: {
+      title: 'Warning: Admin form enabled.',
+      text: 'New fields in the form have been revealed (they are followed by a warning sign). The form will be submitted regardless of the validation of the fields.',
+    },
   },
   info: {
     avro: {

diff --git a/hermes-console/src/views/group-topics/GroupTopicsView.vue b/hermes-console/src/views/group-topics/GroupTopicsView.vue
@@ -143,6 +143,7 @@
                     operation="add"
                     :group="groupId"
                     :topic="null"
+                    :roles="roles"
                     @created="pushToTopic"
                     @cancel="hideTopicForm"
                   />

diff --git a/hermes-console/src/views/subscription/subscription-form/SubscriptionForm.vue b/hermes-console/src/views/subscription/subscription-form/SubscriptionForm.vue
@@ -1,5 +1,6 @@
 <script setup lang="ts">
   import { computed, ref } from 'vue';
+  import { isAdmin } from '@/utils/roles-util';
   import { useAppConfigStore } from '@/store/app-config/useAppConfigStore';
   import { useCreateSubscription } from '@/composables/subscription/use-create-subscription/useCreateSubscription';
   import { useEditSubscription } from '@/composables/subscription/use-edit-subscription/useEditSubscription';
@@ -13,12 +14,14 @@
   import SubscriptionPathFiltersDebug from '@/views/subscription/subscription-form/subscription-basic-filters/SubscriptionPathFiltersDebug.vue';
   import TextField from '@/components/text-field/TextField.vue';
   import TooltipIcon from '@/components/tooltip-icon/TooltipIcon.vue';
+  import type { Role } from '@/api/role';
   import type { Subscription } from '@/api/subscription';
 
   const props = defineProps<{
     topic: string;
     subscription: Subscription | null;
     operation: 'add' | 'edit';
+    roles: Role[] | undefined;
   }>();
   const emit = defineEmits<{
     created: [subscription: string];
@@ -69,7 +72,7 @@
   }
 
   async function submit() {
-    if (isFormValid.value) {
+    if (isFormValid.value || isAdmin(props.roles)) {
       const isOperationSucceeded = await createOrUpdateSubscription();
       if (isOperationSucceeded) {
         emit('created', form.value.name);
@@ -85,6 +88,13 @@
 </script>
 
 <template>
+  <console-alert
+    v-if="isAdmin(roles)"
+    :title="$t('subscriptionForm.warnings.adminForm.title')"
+    :text="$t('subscriptionForm.warnings.adminForm.text')"
+    type="warning"
+    class="mb-4"
+  />
   <v-file-input
     v-if="operation === 'add'"
     :label="$t('subscriptionForm.actions.import')"
@@ -253,6 +263,18 @@
       :suffix="$t('subscriptionForm.fields.inflightMessageTTL.suffix')"
     />
 
+    <text-field
+      v-if="isAdmin(roles)"
+      v-model="form.subscriptionPolicy.inflightMessagesCount"
+      :rules="validators.inflightMessagesCount"
+      prepend-icon="$warning"
+      type="number"
+      :label="$t('subscriptionForm.fields.inflightMessagesCount.label')"
+      :placeholder="
+        $t('subscriptionForm.fields.inflightMessagesCount.placeholder')
+      "
+    />
+
     <v-divider />
 
     <v-switch

diff --git a/hermes-console/src/views/subscription/subscription-metadata/SubscriptionMetadata.vue b/hermes-console/src/views/subscription/subscription-metadata/SubscriptionMetadata.vue
@@ -78,6 +78,7 @@
               operation="edit"
               :subscription="subscription"
               :topic="subscription.topicName"
+              :roles="roles"
               @created="refreshPage"
               @cancel="hideSubscriptionForm"
             />

diff --git a/hermes-console/src/views/topic/subscriptions-list/SubscriptionsList.vue b/hermes-console/src/views/topic/subscriptions-list/SubscriptionsList.vue
@@ -98,6 +98,7 @@
                   operation="add"
                   :subscription="null"
                   :topic="props.topicName"
+                  :roles="roles"
                   @created="pushToSubscription"
                   @cancel="hideSubscriptionForm"
                 />

diff --git a/hermes-console/src/views/topic/topic-form/TopicForm.vue b/hermes-console/src/views/topic/topic-form/TopicForm.vue
@@ -1,5 +1,6 @@
 <script setup lang="ts">
   import { computed, ref } from 'vue';
+  import { isAdmin } from '@/utils/roles-util';
   import { useAppConfigStore } from '@/store/app-config/useAppConfigStore';
   import { useCreateTopic } from '@/composables/topic/use-create-topic/useCreateTopic';
   import { useEditTopic } from '@/composables/topic/use-edit-topic/useEditTopic';
@@ -10,12 +11,15 @@
   import ConsoleAlert from '@/components/console-alert/ConsoleAlert.vue';
   import SelectField from '@/components/select-field/SelectField.vue';
   import TextField from '@/components/text-field/TextField.vue';
-  import type { TopicWithSchema } from '@/api/Topic';
+  import type { Role } from '@/api/role';
+  import type { SelectFieldOption } from '@/components/select-field/types';
+  import type { TopicWithSchema } from '@/api/topic';
 
   const props = defineProps<{
     topic: TopicWithSchema | null;
     group: string | null;
     operation: 'add' | 'edit';
+    roles: Role[] | undefined;
   }>();
   const emit = defineEmits<{
     created: [topic: string];
@@ -37,6 +41,17 @@
       : useEditTopic(props.topic!!);
   const { importFormData } = useImportTopic();
 
+  const adminContentTypes: SelectFieldOption[] = [
+    {
+      title: 'AVRO',
+      value: 'AVRO',
+    },
+    {
+      title: 'JSON',
+      value: 'JSON',
+    },
+  ];
+
   const ownerSelectorPlaceholder = computed(
     () =>
       configStore.loadedConfig.owner.sources.find(
@@ -54,6 +69,16 @@
 
   const isAuthorizationSelected = computed(() => form.value.auth.enabled);
 
+  const durationValidator = computed(() =>
+    form.value.retentionTime.retentionUnit === 'DAYS'
+      ? validators.retentionTimeDurationDays
+      : validators.retentionTimeDurationHours,
+  );
+
+  const allowedContentTypes = computed(() =>
+    isAdmin(props.roles) ? adminContentTypes : dataSources.contentTypes,
+  );
+
   const isAvroContentTypeSelected = computed(
     () => form.value.contentType === 'AVRO',
   );
@@ -71,7 +96,7 @@
   const showAvroAlert = computed(() => form.value.contentType === 'AVRO');
 
   async function submit() {
-    if (isFormValid.value) {
+    if (isFormValid.value || isAdmin(props.roles)) {
       const isOperationSucceeded = await createOrUpdateTopic();
       if (isOperationSucceeded) {
         emit('created', form.value.name);
@@ -87,6 +112,13 @@
 </script>
 
 <template>
+  <console-alert
+    v-if="isAdmin(roles)"
+    :title="$t('topicForm.warnings.adminForm.title')"
+    :text="$t('topicForm.warnings.adminForm.text')"
+    type="warning"
+    class="mb-4"
+  />
   <v-file-input
     v-if="operation === 'add'"
     :label="$t('topicForm.actions.import')"
@@ -213,7 +245,7 @@
 
     <text-field
       v-model.number="form.retentionTime.duration"
-      :rules="validators.retentionTimeDuration"
+      :rules="durationValidator"
       type="number"
       :label="$t('topicForm.fields.retentionTime.duration')"
     />
@@ -238,7 +270,7 @@
     <select-field
       v-model="form.contentType"
       :label="$t('topicForm.fields.contentType')"
-      :items="dataSources.contentTypes"
+      :items="allowedContentTypes"
     />
 
     <text-field
@@ -280,7 +312,6 @@
     />
 
     <v-divider />
-
     <!--      text not in i18n because of a problem with escaping characters-->
     <console-alert
       style="white-space: pre"

diff --git a/hermes-console/src/views/topic/topic-header/TopicHeader.vue b/hermes-console/src/views/topic/topic-header/TopicHeader.vue
@@ -91,6 +91,7 @@
               operation="edit"
               :topic="topic"
               :group="null"
+              :roles="roles"
               @created="refreshPage"
               @cancel="hideTopicForm"
             />

diff --git a/hermes-management/build.gradle b/hermes-management/build.gradle
@@ -1,7 +1,7 @@
 plugins {
     id 'java-library'
     id 'application'
-    id "com.github.node-gradle.node" version "2.2.4"
+    id "com.github.node-gradle.node" version "7.0.2"
 }
 
 mainClassName = 'pl.allegro.tech.hermes.management.HermesManagement'
@@ -51,9 +51,9 @@ node {
     version = '20.4.0'
     distBaseUrl = 'https://nodejs.org/dist'
     download = true
-    workDir = file("${project.buildDir}/nodejs")
-    npmWorkDir = file("${project.buildDir}/npm")
-    nodeModulesDir = file("${project.rootDir}/hermes-console")
+    workDir.set(file("${project.buildDir}/nodejs"))
+    npmWorkDir.set(file("${project.buildDir}/npm"))
+    nodeProjectDir.set(file("${project.rootDir}/hermes-console"))
 }
 
 yarnSetup.dependsOn(nodeSetup)