Merge branch 'dast-site-profile-form-improve-errors-handling' into 'master'

Improve error handling in DAST site profile form

See merge request gitlab-org/gitlab!38306

ee/app/assets/javascripts/dast_site_profiles_form/components/dast_site_profile_form.vue

@@ -75,21 +75,23 @@ export default {
     },
     onSubmit() {
       this.loading = true;
-      this.showAlert = false;
+      this.hideErrors();
       this.$apollo
         .mutate({
           mutation: dastSiteProfileCreateMutation,
           variables: this.formData,
         })
-        .then(data => {
-          if (data.errors?.length > 0) {
-            throw new Error(data.errors);
+        .then(({ data: { dastSiteProfileCreate: { errors } } }) => {
+          if (errors?.length > 0) {
+            this.showErrors(errors);
+            this.loading = false;
+          } else {
+            redirectTo(this.profilesLibraryPath);
           }
-          redirectTo(this.profilesLibraryPath);
         })
         .catch(e => {
           Sentry.captureException(e);
-          this.showAlert = true;
+          this.showErrors();
           this.loading = false;
         });
     },
@@ -103,6 +105,14 @@ export default {
     discard() {
       redirectTo(this.profilesLibraryPath);
     },
+    showErrors(errors = []) {
+      this.errors = errors;
+      this.showAlert = true;
+    },
+    hideErrors() {
+      this.errors = [];
+      this.showAlert = false;
+    },
   },
   modalId: 'deleteDastProfileModal',
   i18n: {
@@ -115,13 +125,17 @@ export default {
 
 <template>
   <gl-form @submit.prevent="onSubmit">
-    <gl-alert v-if="showAlert" variant="danger" @dismiss="showAlert = false">
-      {{ s__('DastProfiles|Could not create the site profile. Please try again.') }}
-    </gl-alert>
     <h2 class="gl-mb-6">
       {{ s__('DastProfiles|New site profile') }}
     </h2>
 
+    <gl-alert v-if="showAlert" variant="danger" class="gl-mb-5" @dismiss="hideErrors">
+      {{ s__('DastProfiles|Could not create the site profile. Please try again.') }}
+      <ul v-if="errors.length" class="gl-mt-3 gl-mb-0">
+        <li v-for="error in errors" :key="error" v-text="error"></li>
+      </ul>
+    </gl-alert>
+
     <gl-form-group :label="s__('DastProfiles|Profile name')">
       <gl-form-input
         v-model="form.profileName.value"

ee/spec/frontend/dast_site_profiles_form/components/dast_site_profiles_form_spec.js

@@ -147,9 +147,13 @@ describe('OnDemandScansApp', () => {
       it('redirects to the profiles library', () => {
         expect(redirectTo).toHaveBeenCalledWith(profilesLibraryPath);
       });
+
+      it('does not show an alert', () => {
+        expect(findAlert().exists()).toBe(false);
+      });
     });
 
-    describe('on error', () => {
+    describe('on top-level error', () => {
       beforeEach(() => {
         createComponent();
         jest.spyOn(wrapper.vm.$apollo, 'mutate').mockRejectedValue();
@@ -166,6 +170,33 @@ describe('OnDemandScansApp', () => {
         expect(findAlert().exists()).toBe(true);
       });
     });
+
+    describe('on errors as data', () => {
+      const errors = ['error#1', 'error#2', 'error#3'];
+
+      beforeEach(() => {
+        createComponent();
+        jest
+          .spyOn(wrapper.vm.$apollo, 'mutate')
+          .mockResolvedValue({ data: { dastSiteProfileCreate: { pipelineUrl: null, errors } } });
+        const input = findTargetUrlInput();
+        input.vm.$emit('input', targetUrl);
+        submitForm();
+      });
+
+      it('resets loading state', () => {
+        expect(findSubmitButton().props('loading')).toBe(false);
+      });
+
+      it('shows an alert with the returned errors', () => {
+        const alert = findAlert();
+
+        expect(alert.exists()).toBe(true);
+        errors.forEach(error => {
+          expect(alert.text()).toContain(error);
+        });
+      });
+    });
   });
 
   describe('cancellation', () => {