Add custom headers form to streaming audit events

What does this MR do and why?

This MR adds the custom headers form to the audit events streaming UI. It does not add the ability to save or delete the custom headers, which will be done in future MRs.

This MR follows the constraints from the issue:

1. Behind the :custom_headers_streaming_audit_events_ui feature flag
2. Form should be able to add and remove rows
   • Limited to 20 rows and shows a message when the limit is reached
   • Automatically shows a new blank row when the previous row gets filled in with a header and value
   • active checkbox is disabled for now
3. documentation updated explaining how to use the new UI and the row limit
4. Specs added for the new UI

Screenshots or screen recordings

Empty	With values	Video of use (checkbox is now marked as checked, not shown in video)
		Screen_Recording_2022-06-21_at_15.15.19

How to set up and validate locally

1. Visit a group's audit events page e.g. http://gdk.test:3000/groups/gitlab-org/-/audit_events and look at the Streams tab.
2. Check that the custom headers table isn't shown and that you can add new destination URLs, edit existing URLs, and delete URLs.
3. Enable the feature flag :custom_headers_streaming_audit_events_ui: echo "Feature.enable(:custom_headers_streaming_audit_events_ui)" | rails c.
4. Check that the custom headers table is shown and that you can add new destination URLs, edit existing URLs, and delete URLs.
   • The custom headers data will not be saved.
5. Check that you can fill in the header name and value inputs and a new row is automatically added when you do.
6. Check that you get a warning if the same header name is used twice.
7. Check that you can delete a header from the table.
8. Fill in 20 headers and check that no more can be added and a message is shown at 20 headers.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

• I have evaluated the MR acceptance checklist for this MR.

MR reviews

• backend review
• backend maintainer
• UX review
• documentation review
• frontend review
• frontend maintainer

Related to #361630 (closed)

ee/app/assets/javascripts/audit_events/components/stream/stream_destination_editor.vue

@@ -6,13 +6,22 @@ import {
   GlFormCheckbox,
   GlFormGroup,
   GlFormInput,
+  GlSprintf,
   GlTableLite,
 } from '@gitlab/ui';
 import createFlash from '~/flash';
+import { thWidthPercent } from '~/lib/utils/table_utility';
 import externalAuditEventDestinationCreate from '../../graphql/create_external_destination.mutation.graphql';
-import { ADD_STREAM_EDITOR_I18N, AUDIT_STREAMS_NETWORK_ERRORS } from '../../constants';
+import {
+  ADD_STREAM_EDITOR_I18N,
+  AUDIT_STREAMS_NETWORK_ERRORS,
+  BLANK_CUSTOM_HEADER_OBJECT,
+  CUSTOM_HEADER_INPUT_TYPE,
+  MAX_CUSTOM_HEADERS,
+} from '../../constants';
 
 const { CREATING_ERROR } = AUDIT_STREAMS_NETWORK_ERRORS;
+
 export default {
   components: {
     GlAlert,
@@ -21,6 +30,7 @@ export default {
     GlFormCheckbox,
     GlFormGroup,
     GlFormInput,
+    GlSprintf,
     GlTableLite,
   },
   inject: ['groupPath', 'showStreamsCustomHeaders'],
@@ -28,9 +38,14 @@ export default {
     return {
       destinationUrl: '',
       loading: false,
-      customHeaders: [{ name: '', value: '', active: false }],
+      customHeaders: [{ ...BLANK_CUSTOM_HEADER_OBJECT }],
     };
   },
+  computed: {
+    hasMaxCustomHeaders() {
+      return this.customHeaders.length === MAX_CUSTOM_HEADERS;
+    },
+  },
   methods: {
     async addDestinationUrl() {
       this.loading = true;
@@ -45,7 +60,9 @@ export default {
             isSingleRequest: true,
           },
         });
+
         const { errors } = data.externalAuditEventDestinationCreate;
+
         if (errors.length > 0) {
           createFlash({
             message: errors[0],
@@ -61,13 +78,75 @@ export default {
         this.loading = false;
       }
     },
+    isRowFilled(index) {
+      return this.customHeaders[index].name !== '' && this.customHeaders[index].value !== '';
+    },
+    addBlankCustomHeader() {
+      this.customHeaders.push({ ...BLANK_CUSTOM_HEADER_OBJECT });
+    },
+    updateCustomHeader(index, type, value) {
+      switch (type) {
+        case CUSTOM_HEADER_INPUT_TYPE.HEADER:
+          this.customHeaders[index].name = value;
+
+          break;
+        case CUSTOM_HEADER_INPUT_TYPE.VALUE:
+          this.customHeaders[index].value = value;
+
+          break;
+        case CUSTOM_HEADER_INPUT_TYPE.ACTIVE:
+          this.customHeaders[index].active = value;
+
+          break;
+        default:
+          break;
+      }
+
+      // If the maximum custom headers hasn't been reached,
+      // the previous row is filled out
+      // and we're updating the last row in the table
+      // then add a new blank row to the bottom of the table
+      if (
+        !this.hasMaxCustomHeaders &&
+        this.isRowFilled(index) &&
+        this.customHeaders.length === index + 1
+      ) {
+        this.addBlankCustomHeader();
+      }
+    },
+    removeCustomHeader(index) {
+      this.customHeaders.splice(index, 1);
+      const headersCount = this.customHeaders.length;
+
+      // Add a new blank row if headers is now empty or the last row is filled out
+      if (headersCount === 0 || this.isRowFilled(headersCount - 1)) {
+        this.addBlankCustomHeader();
+      }
+    },
   },
   i18n: { ...ADD_STREAM_EDITOR_I18N, CREATING_ERROR },
+  CUSTOM_HEADER_INPUT_TYPE,
+  MAX_CUSTOM_HEADERS,
   fields: [
-    { key: 'name', label: ADD_STREAM_EDITOR_I18N.TABLE_COLUMN_NAME_LABEL },
-    { key: 'value', label: ADD_STREAM_EDITOR_I18N.TABLE_COLUMN_VALUE_LABEL },
-    { key: 'active', label: ADD_STREAM_EDITOR_I18N.TABLE_COLUMN_ACTIVE_LABEL },
-    { key: 'actions', label: '' },
+    {
+      key: 'name',
+      label: ADD_STREAM_EDITOR_I18N.TABLE_COLUMN_NAME_LABEL,
+      thClass: ['gl-p-3!', thWidthPercent(40)],
+      tdClass: ['gl-p-3!'],
+    },
+    {
+      key: 'value',
+      label: ADD_STREAM_EDITOR_I18N.TABLE_COLUMN_VALUE_LABEL,
+      thClass: ['gl-p-3!', thWidthPercent(50)],
+      tdClass: ['gl-p-3!'],
+    },
+    {
+      key: 'active',
+      label: ADD_STREAM_EDITOR_I18N.TABLE_COLUMN_ACTIVE_LABEL,
+      thClass: ['gl-p-3!', thWidthPercent(5)],
+      tdClass: ['gl-p-3!'],
+    },
+    { key: 'actions', label: '', thClass: ['gl-p-3!'], tdClass: ['gl-p-3! gl-text-right'] },
   ],
 };
 </script>
@@ -85,24 +164,49 @@ export default {
 
     <gl-form @submit.prevent="addDestinationUrl">
       <gl-form-group :label="$options.i18n.DESTINATION_URL_LABEL">
-        <gl-form-input v-model="destinationUrl" :placeholder="$options.i18n.PLACEHOLDER" />
+        <gl-form-input
+          v-model="destinationUrl"
+          :placeholder="$options.i18n.DESTINATION_URL_PLACEHOLDER"
+        />
       </gl-form-group>
 
       <gl-form-group v-if="showStreamsCustomHeaders" :label="$options.i18n.CUSTOM_HEADERS_LABEL">
-        <gl-table-lite :items="customHeaders" :fields="$options.fields">
-          <template #cell(name)>
-            <gl-form-input value="" />
+        <gl-table-lite :items="customHeaders" :fields="$options.fields" primary-key="name">
+          <template #cell(name)="{ index, item: { disabled = false } }">
+            <gl-form-input
+              value=""
+              :placeholder="$options.i18n.HEADER_INPUT_PLACEHOLDER"
+              :disabled="disabled"
+              @input="updateCustomHeader(index, $options.CUSTOM_HEADER_INPUT_TYPE.HEADER, $event)"
+            />
           </template>
-          <template #cell(value)>
-            <gl-form-input value="" />
+          <template #cell(value)="{ index, item: { disabled = false } }">
+            <gl-form-input
+              value=""
+              :placeholder="$options.i18n.VALUE_INPUT_PLACEHOLDER"
+              :disabled="disabled"
+              @input="updateCustomHeader(index, $options.CUSTOM_HEADER_INPUT_TYPE.VALUE, $event)"
+            />
           </template>
-          <template #cell(active)>
-            <gl-form-checkbox :checked="false" />
+          <template #cell(active)="{ index }">
+            <gl-form-checkbox
+              class="gl-mt-3"
+              :checked="false"
+              :disabled="true"
+              @input="updateCustomHeader(index, $options.CUSTOM_HEADER_INPUT_TYPE.ACTIVE, $event)"
+            />
           </template>
-          <template #cell(actions)>
-            <gl-button category="tertiary" icon="remove" />
+          <template #cell(actions)="{ index }">
+            <gl-button category="tertiary" icon="remove" @click="removeCustomHeader(index)" />
           </template>
         </gl-table-lite>
+        <p v-if="hasMaxCustomHeaders" class="gl-mt-5 gl-mb-0 gl-text-gray-500">
+          <gl-sprintf :message="$options.i18n.MAXIMUM_HEADERS_TEXT">
+            <template #number>
+              {{ $options.MAX_CUSTOM_HEADERS }}
+            </template>
+          </gl-sprintf>
+        </p>
       </gl-form-group>
 
       <div class="gl-display-flex">