Merge branch 'ide-etag-polling' into 'master'

Fix IDE pipelines eTagPoll not stopping

Closes #47678

See merge request gitlab-org/gitlab-ce!19636

app/assets/javascripts/ide/stores/modules/merge_requests/actions.js

@@ -31,10 +31,15 @@ export const openMergeRequest = ({ commit, dispatch }, { projectPath, id }) => {
   commit(rootTypes.CLEAR_PROJECTS, null, { root: true });
   commit(rootTypes.SET_CURRENT_MERGE_REQUEST, `${id}`, { root: true });
   commit(rootTypes.RESET_OPEN_FILES, null, { root: true });
-  dispatch('pipelines/stopPipelinePolling', null, { root: true });
-  dispatch('pipelines/clearEtagPoll', null, { root: true });
   dispatch('pipelines/resetLatestPipeline', null, { root: true });
   dispatch('setCurrentBranchId', '', { root: true });
+  dispatch('pipelines/stopPipelinePolling', null, { root: true })
+    .then(() => {
+      dispatch('pipelines/clearEtagPoll', null, { root: true });
+    })
+    .catch(e => {
+      throw e;
+    });
 
   router.push(`/project/${projectPath}/merge_requests/${id}`);
 };

app/assets/javascripts/ide/stores/modules/pipelines/actions.js

@@ -12,8 +12,12 @@ let eTagPoll;
 export const clearEtagPoll = () => {
   eTagPoll = null;
 };
-export const stopPipelinePolling = () => eTagPoll && eTagPoll.stop();
-export const restartPipelinePolling = () => eTagPoll && eTagPoll.restart();
+export const stopPipelinePolling = () => {
+  if (eTagPoll) eTagPoll.stop();
+};
+export const restartPipelinePolling = () => {
+  if (eTagPoll) eTagPoll.restart();
+};
 
 export const requestLatestPipeline = ({ commit }) => commit(types.REQUEST_LATEST_PIPELINE);
 export const receiveLatestPipelineError = ({ commit, dispatch }) => {
@@ -51,9 +55,9 @@ export const fetchLatestPipeline = ({ dispatch, rootGetters }) => {
 
   Visibility.change(() => {
     if (!Visibility.hidden()) {
-      eTagPoll.restart();
+      dispatch('restartPipelinePolling');
     } else {
-      eTagPoll.stop();
+      dispatch('stopPipelinePolling');
     }
   });
 };

spec/javascripts/ide/components/pipelines/list_spec.js

@@ -45,12 +45,15 @@ describe('IDE pipelines list', () => {
     setTimeout(done);
   });
 
-  afterEach(() => {
-    vm.$store.dispatch('pipelines/stopPipelinePolling');
-    vm.$store.dispatch('pipelines/clearEtagPoll');
-
+  afterEach(done => {
     vm.$destroy();
     mock.restore();
+
+    vm.$store
+      .dispatch('pipelines/stopPipelinePolling')
+      .then(() => vm.$store.dispatch('pipelines/clearEtagPoll'))
+      .then(done)
+      .catch(done.fail);
   });
 
   it('renders pipeline data', () => {

spec/javascripts/ide/stores/modules/merge_requests/actions_spec.js

@@ -199,28 +199,39 @@ describe('IDE merge requests actions', () => {
     });
 
     it('commits reset mutations and actions', done => {
-      testAction(
-        openMergeRequest,
-        { projectPath: 'gitlab-org/gitlab-ce', id: '1' },
-        mockedState,
-        [
-          { type: 'CLEAR_PROJECTS' },
-          { type: 'SET_CURRENT_MERGE_REQUEST', payload: '1' },
-          { type: 'RESET_OPEN_FILES' },
-        ],
-        [
-          { type: 'pipelines/stopPipelinePolling' },
-          { type: 'pipelines/clearEtagPoll' },
-          { type: 'pipelines/resetLatestPipeline' },
-          { type: 'setCurrentBranchId', payload: '' },
-        ],
-        done,
-      );
+      const commit = jasmine.createSpy();
+      const dispatch = jasmine.createSpy().and.returnValue(Promise.resolve());
+      openMergeRequest({ commit, dispatch }, { projectPath: 'gitlab-org/gitlab-ce', id: '1' });
+
+      setTimeout(() => {
+        expect(commit.calls.argsFor(0)).toEqual(['CLEAR_PROJECTS', null, { root: true }]);
+        expect(commit.calls.argsFor(1)).toEqual(['SET_CURRENT_MERGE_REQUEST', '1', { root: true }]);
+        expect(commit.calls.argsFor(2)).toEqual(['RESET_OPEN_FILES', null, { root: true }]);
+
+        expect(dispatch.calls.argsFor(0)).toEqual([
+          'pipelines/resetLatestPipeline',
+          null,
+          { root: true },
+        ]);
+        expect(dispatch.calls.argsFor(1)).toEqual(['setCurrentBranchId', '', { root: true }]);
+        expect(dispatch.calls.argsFor(2)).toEqual([
+          'pipelines/stopPipelinePolling',
+          null,
+          { root: true },
+        ]);
+        expect(dispatch.calls.argsFor(3)).toEqual([
+          'pipelines/clearEtagPoll',
+          null,
+          { root: true },
+        ]);
+
+        done();
+      });
     });
 
     it('pushes new route', () => {
       openMergeRequest(
-        { commit() {}, dispatch() {} },
+        { commit() {}, dispatch: () => Promise.resolve() },
         { projectPath: 'gitlab-org/gitlab-ce', id: '1' },
       );