Merge branch 'fix-pipeline-wizard-step-persistence' into 'master'

Fix Pipeline Wizard losing state when returning to a step

See merge request gitlab-org/gitlab!84075

app/assets/javascripts/pipeline_wizard/components/input.vue

@@ -92,6 +92,7 @@ export default {
       ref="widget"
       :validate="validate"
       v-bind="$attrs"
+      :data-input-target="target"
       @input="onModelChange"
       @update:valid="onValidationStateChange"
     />

app/assets/javascripts/pipeline_wizard/components/wrapper.vue

 <script>
 import { GlProgressBar } from '@gitlab/ui';
 import { Document } from 'yaml';
+import { uniqueId } from 'lodash';
 import { merge } from '~/lib/utils/yaml';
 import { __ } from '~/locale';
 import { isValidStepSeq } from '~/pipeline_wizard/validators';
@@ -57,15 +58,6 @@ export default {
     };
   },
   computed: {
-    currentStepConfig() {
-      return this.steps.get(this.currentStepIndex);
-    },
-    currentStepInputs() {
-      return this.currentStepConfig.get('inputs').toJSON();
-    },
-    currentStepTemplate() {
-      return this.currentStepConfig.get('template', true);
-    },
     currentStep() {
       return this.currentStepIndex + 1;
     },
@@ -78,6 +70,13 @@ export default {
     isLastStep() {
       return this.currentStep === this.stepCount;
     },
+    stepList() {
+      return this.steps.items.map((_, i) => ({
+        id: uniqueId(),
+        inputs: this.steps.get(i).get('inputs').toJSON(),
+        template: this.steps.get(i).get('template', true),
+      }));
+    },
   },
   watch: {
     isLastStep(value) {
@@ -85,6 +84,9 @@ export default {
     },
   },
   methods: {
+    getStep(index) {
+      return this.steps.get(index);
+    },
     resetHighlight() {
       this.highlightPath = null;
     },
@@ -119,8 +121,8 @@ export default {
       </header>
       <section class="gl-mb-4">
         <commit-step
-          v-if="isLastStep"
-          ref="step"
+          v-show="isLastStep"
+          data-testid="step"
           :default-branch="defaultBranch"
           :file-content="pipelineBlob"
           :filename="filename"
@@ -128,15 +130,16 @@ export default {
           @back="currentStepIndex--"
         />
         <wizard-step
-          v-else
-          :key="currentStepIndex"
-          ref="step"
+          v-for="(step, i) in stepList"
+          v-show="i === currentStepIndex"
+          :key="step.id"
+          data-testid="step"
           :compiled.sync="compiled"
-          :has-next-step="currentStepIndex < steps.items.length"
-          :has-previous-step="currentStepIndex > 0"
+          :has-next-step="i < steps.items.length"
+          :has-previous-step="i > 0"
           :highlight.sync="highlightPath"
-          :inputs="currentStepInputs"
-          :template="currentStepTemplate"
+          :inputs="step.inputs"
+          :template="step.template"
           @back="currentStepIndex--"
           @next="currentStepIndex++"
           @update:compiled="onUpdate"

spec/frontend/pipeline_wizard/components/wrapper_spec.js

 import { Document, parseDocument } from 'yaml';
 import { GlProgressBar } from '@gitlab/ui';
 import { nextTick } from 'vue';
-import { shallowMountExtended } from 'helpers/vue_test_utils_helper';
+import { shallowMountExtended, mountExtended } from 'helpers/vue_test_utils_helper';
 import PipelineWizardWrapper, { i18n } from '~/pipeline_wizard/components/wrapper.vue';
 import WizardStep from '~/pipeline_wizard/components/step.vue';
 import CommitStep from '~/pipeline_wizard/components/commit.vue';
 import YamlEditor from '~/pipeline_wizard/components/editor.vue';
 import { sprintf } from '~/locale';
-import { steps as stepsYaml } from '../mock/yaml';
+import {
+  steps as stepsYaml,
+  compiledScenario1,
+  compiledScenario2,
+  compiledScenario3,
+} from '../mock/yaml';
 
 describe('Pipeline Wizard - wrapper.vue', () => {
   let wrapper;
   const steps = parseDocument(stepsYaml).toJS();
 
   const getAsYamlNode = (value) => new Document(value).contents;
-  const createComponent = (props = {}) => {
-    wrapper = shallowMountExtended(PipelineWizardWrapper, {
+  const createComponent = (props = {}, mountFn = shallowMountExtended) => {
+    wrapper = mountFn(PipelineWizardWrapper, {
       propsData: {
         projectPath: '/user/repo',
         defaultBranch: 'main',
@@ -23,13 +28,21 @@ describe('Pipeline Wizard - wrapper.vue', () => {
         steps: getAsYamlNode(steps),
         ...props,
       },
+      stubs: {
+        CommitStep: true,
+      },
     });
   };
   const getEditorContent = () => {
-    return wrapper.getComponent(YamlEditor).attributes().doc.toString();
+    return wrapper.getComponent(YamlEditor).props().doc.toString();
   };
-  const getStepWrapper = () => wrapper.getComponent(WizardStep);
+  const getStepWrapper = () =>
+    wrapper.findAllComponents(WizardStep).wrappers.find((w) => w.isVisible());
   const getGlProgressBarWrapper = () => wrapper.getComponent(GlProgressBar);
+  const findFirstVisibleStep = () =>
+    wrapper.findAllComponents('[data-testid="step"]').wrappers.find((w) => w.isVisible());
+  const findFirstInputFieldForTarget = (target) =>
+    wrapper.find(`[data-input-target="${target}"]`).find('input');
 
   describe('display', () => {
     afterEach(() => {
@@ -118,8 +131,9 @@ describe('Pipeline Wizard - wrapper.vue', () => {
       }) => {
         beforeAll(async () => {
           createComponent();
+
           for (const emittedValue of navigationEventChain) {
-            wrapper.findComponent({ ref: 'step' }).vm.$emit(emittedValue);
+            findFirstVisibleStep().vm.$emit(emittedValue);
             // We have to wait for the next step to be mounted
             // before we can emit the next event, so we have to await
             // inside the loop.
@@ -134,11 +148,11 @@ describe('Pipeline Wizard - wrapper.vue', () => {
 
         if (expectCommitStepShown) {
           it('does not show the step wrapper', async () => {
-            expect(wrapper.findComponent(WizardStep).exists()).toBe(false);
+            expect(wrapper.findComponent(WizardStep).isVisible()).toBe(false);
           });
 
           it('shows the commit step page', () => {
-            expect(wrapper.findComponent(CommitStep).exists()).toBe(true);
+            expect(wrapper.findComponent(CommitStep).isVisible()).toBe(true);
           });
         } else {
           it('passes the correct step config to the step component', async () => {
@@ -146,7 +160,7 @@ describe('Pipeline Wizard - wrapper.vue', () => {
           });
 
           it('does not show the commit step page', () => {
-            expect(wrapper.findComponent(CommitStep).exists()).toBe(false);
+            expect(wrapper.findComponent(CommitStep).isVisible()).toBe(false);
           });
         }
 
@@ -247,4 +261,54 @@ describe('Pipeline Wizard - wrapper.vue', () => {
       expect(wrapper.getComponent(YamlEditor).props('highlight')).toBe(null);
     });
   });
+
+  describe('integration test', () => {
+    beforeAll(async () => {
+      createComponent({}, mountExtended);
+    });
+
+    it('updates the editor content after input on step 1', async () => {
+      findFirstInputFieldForTarget('$FOO').setValue('fooVal');
+      await nextTick();
+
+      expect(getEditorContent()).toBe(compiledScenario1);
+    });
+
+    it('updates the editor content after input on step 2', async () => {
+      findFirstVisibleStep().vm.$emit('next');
+      await nextTick();
+
+      findFirstInputFieldForTarget('$BAR').setValue('barVal');
+      await nextTick();
+
+      expect(getEditorContent()).toBe(compiledScenario2);
+    });
+
+    describe('navigating back', () => {
+      let inputField;
+
+      beforeAll(async () => {
+        findFirstVisibleStep().vm.$emit('back');
+        await nextTick();
+
+        inputField = findFirstInputFieldForTarget('$FOO');
+      });
+
+      afterAll(() => {
+        wrapper.destroy();
+        inputField = undefined;
+      });
+
+      it('still shows the input values from the former visit', () => {
+        expect(inputField.element.value).toBe('fooVal');
+      });
+
+      it('updates the editor content without modifying input that came from a later step', async () => {
+        inputField.setValue('newFooVal');
+        await nextTick();
+
+        expect(getEditorContent()).toBe(compiledScenario3);
+      });
+    });
+  });
 });

spec/frontend/pipeline_wizard/mock/yaml.js

@@ -59,6 +59,17 @@ export const steps = `
     bar: $BAR
 `;
 
+export const compiledScenario1 = `foo: fooVal
+`;
+
+export const compiledScenario2 = `foo: fooVal
+bar: barVal
+`;
+
+export const compiledScenario3 = `foo: newFooVal
+bar: barVal
+`;
+
 export const fullTemplate = `
 title: some title
 description: some description