Merge branch 'auto-scroll-pipeline-editor-on-commit' into 'master'

Auto-scroll to top of page upon committing in pipeline editor

See merge request gitlab-org/gitlab!54657

app/assets/javascripts/pipeline_editor/pipeline_editor_app.vue

@@ -186,11 +186,13 @@ export default {
       this.showSuccessAlert = false;
     },
     reportFailure(type, reasons = []) {
+      window.scrollTo({ top: 0, behavior: 'smooth' });
       this.showFailureAlert = true;
       this.failureType = type;
       this.failureReasons = reasons;
     },
     reportSuccess(type) {
+      window.scrollTo({ top: 0, behavior: 'smooth' });
       this.showSuccessAlert = true;
       this.successType = type;
     },

changelogs/unreleased/auto-scroll-pipeline-editor-on-commit.yml

+---
+title: Auto-scroll to top of page upon committing in pipeline editor
+merge_request: 54657
+author:
+type: changed

spec/frontend/pipeline_editor/pipeline_editor_app_spec.js

@@ -193,6 +193,7 @@ describe('Pipeline editor app component', () => {
 
       describe('and the commit mutation succeeds', () => {
         beforeEach(() => {
+          window.scrollTo = jest.fn();
           createComponent();
 
           findEditorHome().vm.$emit('commit', { type: COMMIT_SUCCESS });
@@ -201,11 +202,16 @@ describe('Pipeline editor app component', () => {
         it('shows a confirmation message', () => {
           expect(findAlert().text()).toBe(wrapper.vm.$options.successTexts[COMMIT_SUCCESS]);
         });
+
+        it('scrolls to the top of the page to bring attention to the confirmation message', () => {
+          expect(window.scrollTo).toHaveBeenCalledWith({ top: 0, behavior: 'smooth' });
+        });
       });
       describe('and the commit mutation fails', () => {
         const commitFailedReasons = ['Commit failed'];
 
         beforeEach(() => {
+          window.scrollTo = jest.fn();
           createComponent();
 
           findEditorHome().vm.$emit('showError', {
@@ -219,11 +225,17 @@ describe('Pipeline editor app component', () => {
             `${updateFailureMessage} ${commitFailedReasons[0]}`,
           );
         });
+
+        it('scrolls to the top of the page to bring attention to the error message', () => {
+          expect(window.scrollTo).toHaveBeenCalledWith({ top: 0, behavior: 'smooth' });
+        });
       });
+
       describe('when an unknown error occurs', () => {
         const unknownReasons = ['Commit failed'];
 
         beforeEach(() => {
+          window.scrollTo = jest.fn();
           createComponent();
 
           findEditorHome().vm.$emit('showError', {
@@ -237,6 +249,10 @@ describe('Pipeline editor app component', () => {
             `${updateFailureMessage} ${unknownReasons[0]}`,
           );
         });
+
+        it('scrolls to the top of the page to bring attention to the error message', () => {
+          expect(window.scrollTo).toHaveBeenCalledWith({ top: 0, behavior: 'smooth' });
+        });
       });
     });
   });