From: Wouter Admiraal <wouter.admiraal@sonarsource.com>
Date: Mon, 6 Jul 2020 12:20:32 +0000 (+0200)
Subject: SONAR-13575 Component page doesn't always refresh after background task is completed
X-Git-Tag: 8.5.0.37579~196
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=240fbd41e6be19711c02d991d1aae3d169cfc0a9;p=sonarqube.git

SONAR-13575 Component page doesn't always refresh after background task is completed
---

diff --git a/server/sonar-web/src/main/js/app/components/ComponentContainer.tsx b/server/sonar-web/src/main/js/app/components/ComponentContainer.tsx
index ecab0962600..f00a0568426 100644
--- a/server/sonar-web/src/main/js/app/components/ComponentContainer.tsx
+++ b/server/sonar-web/src/main/js/app/components/ComponentContainer.tsx
@@ -193,7 +193,8 @@ export class ComponentContainer extends React.PureComponent<Props, State> {
               );
 
               const currentTaskChanged =
-                currentTask && newCurrentTask && currentTask.id !== newCurrentTask.id;
+                (!currentTask && newCurrentTask) ||
+                (currentTask && newCurrentTask && currentTask.id !== newCurrentTask.id);
               const progressChanged =
                 tasksInProgress &&
                 (newTasksInProgress.length !== tasksInProgress.length ||
diff --git a/server/sonar-web/src/main/js/app/components/__tests__/ComponentContainer-test.tsx b/server/sonar-web/src/main/js/app/components/__tests__/ComponentContainer-test.tsx
index 6d12970fe6b..118cb162e87 100644
--- a/server/sonar-web/src/main/js/app/components/__tests__/ComponentContainer-test.tsx
+++ b/server/sonar-web/src/main/js/app/components/__tests__/ComponentContainer-test.tsx
@@ -161,22 +161,73 @@ it('filters correctly the pending tasks for a main branch', () => {
 
 it('reload component after task progress finished', async () => {
   jest.useFakeTimers();
-  const inProgressTask = { id: 'foo', status: STATUSES.IN_PROGRESS } as T.Task;
-  (getTasksForComponent as jest.Mock<any>).mockResolvedValueOnce({ queue: [inProgressTask] });
+  (getTasksForComponent as jest.Mock<any>)
+    .mockResolvedValueOnce({
+      queue: [{ id: 'foo', status: STATUSES.IN_PROGRESS }]
+    })
+    .mockResolvedValueOnce({
+      queue: []
+    });
   const wrapper = shallowRender();
+
+  // First round, there's something in the queue, and component navigation was
+  // not called again (it's called once at mount, hence the 1 times assertion
+  // here).
   await waitAndUpdate(wrapper);
   expect(getComponentNavigation).toHaveBeenCalledTimes(1);
   expect(getTasksForComponent).toHaveBeenCalledTimes(1);
 
-  jest.runAllTimers();
+  jest.runOnlyPendingTimers();
+
+  // Second round, the queue is now empty, hence we assume the previous task
+  // was done. We immediately load the component again.
   expect(getTasksForComponent).toHaveBeenCalledTimes(2);
+
+  // Trigger the update.
   await waitAndUpdate(wrapper);
+  // The component was correctly re-loaded.
   expect(getComponentNavigation).toHaveBeenCalledTimes(2);
+  // The status API call will be called 1 final time after the component is
+  // fully loaded, so the total will be 3.
   expect(getTasksForComponent).toHaveBeenCalledTimes(3);
 
+  // Make sure the timeout was cleared. It should not be called again.
   jest.runAllTimers();
   await waitAndUpdate(wrapper);
+  // The number of calls haven't changed.
+  expect(getComponentNavigation).toHaveBeenCalledTimes(2);
+  expect(getTasksForComponent).toHaveBeenCalledTimes(3);
+});
+
+it('reloads component after task progress finished, and moves straight to current', async () => {
+  jest.useFakeTimers();
+  (getComponentData as jest.Mock<any>).mockResolvedValueOnce({
+    component: { key: 'bar' }
+  });
+  (getTasksForComponent as jest.Mock<any>)
+    .mockResolvedValueOnce({ queue: [] })
+    .mockResolvedValueOnce({ queue: [], current: { id: 'foo', status: STATUSES.SUCCESS } });
+  const wrapper = shallowRender();
+
+  // First round, nothing in the queue, and component navigation was not called
+  // again (it's called once at mount, hence the 1 times assertion here).
+  await waitAndUpdate(wrapper);
+  expect(getComponentNavigation).toHaveBeenCalledTimes(1);
+  expect(getTasksForComponent).toHaveBeenCalledTimes(1);
+
+  jest.runOnlyPendingTimers();
+
+  // Second round, nothing in the queue, BUT a success task is current. This
+  // means the queue was processed too quick for us to see, and we didn't see
+  // any pending tasks in the queue. So we immediately load the component again.
+  expect(getTasksForComponent).toHaveBeenCalledTimes(2);
+
+  // Trigger the update.
+  await waitAndUpdate(wrapper);
+  // The component was correctly re-loaded.
   expect(getComponentNavigation).toHaveBeenCalledTimes(2);
+  // The status API call will be called 1 final time after the component is
+  // fully loaded, so the total will be 3.
   expect(getTasksForComponent).toHaveBeenCalledTimes(3);
 });