Render base path error based on report status

Use 'not_found' status to decide whether to render error message
"Base pipeline codequality artifact not found"
instead of using the presence of the path used to download the artifact

Changelog: changed

app/assets/javascripts/reports/codequality_report/store/actions.js

@@ -7,11 +7,11 @@ export const setPaths = ({ commit }, paths) => commit(types.SET_PATHS, paths);
 export const fetchReports = ({ state, dispatch, commit }) => {
   commit(types.REQUEST_REPORTS);
 
-  if (!state.basePath) {
-    return dispatch('receiveReportsError');
-  }
   return pollUntilComplete(state.reportsPath)
     .then(({ data }) => {
+      if (data.status === 'not_found') {
+        return dispatch('receiveReportsError', data);
+      }
       return dispatch('receiveReportsSuccess', {
         newIssues: parseCodeclimateMetrics(data.new_errors, state.headBlobPath),
         resolvedIssues: parseCodeclimateMetrics(data.resolved_errors, state.baseBlobPath),

app/assets/javascripts/reports/codequality_report/store/getters.js

 import { spriteIcon } from '~/lib/utils/common_utils';
 import { sprintf, __, s__, n__ } from '~/locale';
-import { LOADING, ERROR, SUCCESS } from '../../constants';
+import { LOADING, ERROR, SUCCESS, STATUS_NOT_FOUND } from '../../constants';
 
 export const hasCodequalityIssues = (state) =>
   Boolean(state.newIssues?.length || state.resolvedIssues?.length);
@@ -42,7 +42,7 @@ export const codequalityText = (state) => {
 };
 
 export const codequalityPopover = (state) => {
-  if (state.headPath && !state.basePath) {
+  if (state.status === STATUS_NOT_FOUND) {
     return {
       title: s__('ciReport|Base pipeline codequality artifact not found'),
       content: sprintf(

app/assets/javascripts/reports/codequality_report/store/mutations.js

@@ -14,6 +14,7 @@ export default {
   },
   [types.RECEIVE_REPORTS_SUCCESS](state, data) {
     state.hasError = false;
+    state.status = '';
     state.statusReason = '';
     state.isLoading = false;
     state.newIssues = data.newIssues;
@@ -22,6 +23,7 @@ export default {
   [types.RECEIVE_REPORTS_ERROR](state, error) {
     state.isLoading = false;
     state.hasError = true;
+    state.status = error?.status || '';
     state.statusReason = error?.response?.data?.status_reason;
   },
 };

app/assets/javascripts/reports/codequality_report/store/state.js

@@ -8,6 +8,7 @@ export default () => ({
 
   isLoading: false,
   hasError: false,
+  status: '',
   statusReason: '',
 
   newIssues: [],

app/assets/javascripts/reports/constants.js

@@ -12,6 +12,7 @@ export const SUCCESS = 'SUCCESS';
 export const STATUS_FAILED = 'failed';
 export const STATUS_SUCCESS = 'success';
 export const STATUS_NEUTRAL = 'neutral';
+export const STATUS_NOT_FOUND = 'not_found';
 
 export const ICON_WARNING = 'warning';
 export const ICON_SUCCESS = 'success';

spec/frontend/reports/codequality_report/grouped_codequality_reports_app_spec.js

@@ -127,21 +127,6 @@ describe('Grouped code quality reports app', () => {
     });
   });
 
-  describe('when there is a head report but no base report', () => {
-    beforeEach(() => {
-      mockStore.state.basePath = null;
-      mockStore.state.hasError = true;
-    });
-
-    it('renders error text', () => {
-      expect(findWidget().text()).toContain('Failed to load codeclimate report');
-    });
-
-    it('renders a help icon with more information', () => {
-      expect(findWidget().find('[data-testid="question-icon"]').exists()).toBe(true);
-    });
-  });
-
   describe('on error', () => {
     beforeEach(() => {
       mockStore.state.hasError = true;
@@ -154,5 +139,15 @@ describe('Grouped code quality reports app', () => {
     it('does not render a help icon', () => {
       expect(findWidget().find('[data-testid="question-icon"]').exists()).toBe(false);
     });
+
+    describe('when base report was not found', () => {
+      beforeEach(() => {
+        mockStore.state.status = 'not_found';
+      });
+
+      it('renders a help icon with more information', () => {
+        expect(findWidget().find('[data-testid="question-icon"]').exists()).toBe(true);
+      });
+    });
   });
 });

spec/frontend/reports/codequality_report/store/actions_spec.js

@@ -92,16 +92,17 @@ describe('Codequality Reports actions', () => {
       });
     });
 
-    describe('with no base path', () => {
+    describe('when base report is not found', () => {
       it('commits REQUEST_REPORTS and dispatches receiveReportsError', (done) => {
-        localState.basePath = null;
+        const data = { status: 'not_found' };
+        mock.onGet(`${TEST_HOST}/codequality_reports.json`).reply(200, data);
 
         testAction(
           actions.fetchReports,
           null,
           localState,
           [{ type: types.REQUEST_REPORTS }],
-          [{ type: 'receiveReportsError' }],
+          [{ type: 'receiveReportsError', payload: data }],
           done,
         );
       });

spec/frontend/reports/codequality_report/store/getters_spec.js

@@ -76,10 +76,9 @@ describe('Codequality reports store getters', () => {
   });
 
   describe('codequalityPopover', () => {
-    describe('when head report is available but base report is not', () => {
+    describe('when base report is not available', () => {
       it('returns a popover with a documentation link', () => {
-        localState.headPath = 'head.json';
-        localState.basePath = undefined;
+        localState.status = 'not_found';
         localState.helpPath = 'codequality_help.html';
 
         expect(getters.codequalityPopover(localState).title).toEqual(

spec/frontend/reports/codequality_report/store/mutations_spec.js

@@ -58,9 +58,10 @@ describe('Codequality Reports mutations', () => {
       expect(localState.hasError).toEqual(false);
     });
 
-    it('clears statusReason', () => {
+    it('clears status and statusReason', () => {
       mutations.RECEIVE_REPORTS_SUCCESS(localState, {});
 
+      expect(localState.status).toEqual('');
       expect(localState.statusReason).toEqual('');
     });
 
@@ -86,6 +87,13 @@ describe('Codequality Reports mutations', () => {
       expect(localState.hasError).toEqual(true);
     });
 
+    it('sets status based on error object', () => {
+      const error = { status: 'not_found' };
+      mutations.RECEIVE_REPORTS_ERROR(localState, error);
+
+      expect(localState.status).toEqual(error.status);
+    });
+
     it('sets statusReason to string from error response data', () => {
       const data = { status_reason: 'This merge request does not have codequality reports' };
       const error = { response: { data } };