Move old specs from EE and remove redundant tests

Move prepareTimeMetricsData specs to FOSS

Moves the util specs for prepareTimeMetricsData
to the FOSS specs directory.

Remove old api specs

With the time metrics api requests moved
to api/analytics_api, we can remove the old
tests

app/assets/javascripts/cycle_analytics/components/value_stream_metrics.vue

@@ -13,8 +13,8 @@ const requestData = ({ request, path, params, name }) => {
     .catch(() => {
       createFlash({
         message: sprintf(
-          s__('There was an error while fetching value stream analytics %{name} data.'),
-          { name },
+          s__('There was an error while fetching value stream analytics %{requestTypeName} data.'),
+          { requestTypeName: name },
         ),
       });
     });

ee/spec/frontend/analytics/cycle_analytics/components/value_stream_metrics_spec.js

-import { GlDeprecatedSkeletonLoading as GlSkeletonLoading } from '@gitlab/ui';
-import { GlSingleStat } from '@gitlab/ui/dist/charts';
-import { shallowMount } from '@vue/test-utils';
-import { nextTick } from 'vue';
-import Api from 'ee/api'; // TODO: fix this for FOSS
-import { group } from 'jest/cycle_analytics/mock_data';
-import ValueStreamMetrics from '~/cycle_analytics/components/value_stream_metrics.vue';
-import createFlash from '~/flash';
-import { timeMetricsData, recentActivityData } from '../mock_data';
-
-const allMetrics = [...timeMetricsData, ...recentActivityData];
-
-jest.mock('~/flash');
-
-describe('ValueStreamMetrics', () => {
-  const { full_path: requestPath } = group;
-  let wrapper;
-
-  const createComponent = ({ requestParams = {} } = {}) => {
-    return shallowMount(ValueStreamMetrics, {
-      propsData: {
-        requestPath,
-        requestParams,
-      },
-    });
-  };
-
-  const findAllMetrics = () => wrapper.findComponent(GlSingleStat).props('metrics');
-
-  afterEach(() => {
-    wrapper.destroy();
-    wrapper = null;
-  });
-
-  describe('with successful requests', () => {
-    beforeEach(async () => {
-      jest.spyOn(Api, 'cycleAnalyticsTimeSummaryData').mockResolvedValue({ data: timeMetricsData });
-      jest.spyOn(Api, 'cycleAnalyticsSummaryData').mockResolvedValue({ data: recentActivityData });
-      wrapper = createComponent();
-
-      await nextTick;
-    });
-
-    it.each(['cycleAnalyticsTimeSummaryData', 'cycleAnalyticsSummaryData'])(
-      'fetches data for the %s request',
-      (request) => {
-        expect(Api[request]).toHaveBeenCalledWith(requestPath, {});
-      },
-    );
-
-    it('will not display a loading icon', () => {
-      expect(wrapper.find(GlSkeletonLoading).exists()).toBe(false);
-    });
-
-    it('will display a loading icon if `true`', () => {
-      wrapper = createComponent({ isLoading: true });
-      expect(wrapper.find(GlSkeletonLoading).exists()).toBe(true);
-    });
-
-    describe('with additional params', () => {
-      beforeEach(async () => {
-        wrapper = createComponent({
-          requestParams: {
-            'project_ids[]': [1],
-            created_after: '2020-01-01',
-            created_before: '2020-02-01',
-          },
-        });
-
-        await nextTick;
-      });
-
-      it.each(['cycleAnalyticsTimeSummaryData', 'cycleAnalyticsSummaryData'])(
-        'sends additional parameters as query paremeters in %s request',
-        (request) => {
-          expect(Api[request]).toHaveBeenCalledWith(requestPath, {
-            'project_ids[]': [1],
-            created_after: '2020-01-01',
-            created_before: '2020-02-01',
-          });
-        },
-      );
-    });
-
-    describe('metrics', () => {
-      it.each`
-        index | value                          | title                          | unit
-        ${0}  | ${timeMetricsData[0].value}    | ${timeMetricsData[0].title}    | ${timeMetricsData[0].unit}
-        ${1}  | ${timeMetricsData[1].value}    | ${timeMetricsData[1].title}    | ${timeMetricsData[1].unit}
-        ${2}  | ${recentActivityData[0].value} | ${recentActivityData[0].title} | ${recentActivityData[0].unit}
-        ${3}  | ${recentActivityData[1].value} | ${recentActivityData[1].title} | ${recentActivityData[1].unit}
-        ${4}  | ${recentActivityData[2].value} | ${recentActivityData[2].title} | ${recentActivityData[2].unit}
-      `(
-        'renders a single stat component for the $title with value and unit',
-        ({ index, value, title, unit }) => {
-          const metric = findAllMetrics().at(index);
-          const expectedUnit = unit ?? '';
-
-          expect(metric.props('value')).toBe(value);
-          expect(metric.props('title')).toBe(title);
-          expect(metric.props('unit')).toBe(expectedUnit);
-        },
-      );
-    });
-  });
-
-  describe.each`
-    metric               | failedRequest                      | succesfulRequest
-    ${'time summary'}    | ${'cycleAnalyticsTimeSummaryData'} | ${'cycleAnalyticsSummaryData'}
-    ${'recent activity'} | ${'cycleAnalyticsSummaryData'}     | ${'cycleAnalyticsTimeSummaryData'}
-  `('with the $failedRequest request failing', ({ metric, failedRequest, succesfulRequest }) => {
-    beforeEach(async () => {
-      jest.spyOn(Api, failedRequest).mockRejectedValue();
-      jest.spyOn(Api, succesfulRequest).mockResolvedValue(Promise.resolve({}));
-      wrapper = createComponent();
-
-      await wrapper.vm.$nextTick();
-    });
-
-    it('it should render a error message', () => {
-      expect(createFlash).toHaveBeenCalledWith({
-        message: `There was an error while fetching value stream analytics ${metric} data.`,
-      });
-    });
-  });
-});

ee/spec/frontend/analytics/cycle_analytics/utils_spec.js

@@ -14,7 +14,6 @@ import {
   flattenTaskByTypeSeries,
   orderByDate,
   toggleSelectedLabel,
-  prepareTimeMetricsData,
   prepareStageErrors,
   formatMedianValuesWithOverview,
 } from 'ee/analytics/cycle_analytics/utils';
@@ -23,7 +22,6 @@ import { createdAfter, createdBefore, rawStageMedians } from 'jest/cycle_analyti
 import { OVERVIEW_STAGE_ID } from '~/cycle_analytics/constants';
 import { medianTimeToParsedSeconds } from '~/cycle_analytics/utils';
 import { getDatesInRange } from '~/lib/utils/datetime_utility';
-import { slugify } from '~/lib/utils/text_utility';
 import {
   customStageEvents as events,
   customStageLabelEvents as labelEvents,
@@ -35,7 +33,6 @@ import {
   issueStage,
   rawCustomStage,
   rawTasksByTypeData,
-  timeMetricsData,
 } from './mock_data';
 
 const labelEventIds = labelEvents.map((ev) => ev.identifier);
@@ -343,34 +340,6 @@ describe('Value Stream Analytics utils', () => {
     });
   });
 
-  describe('prepareTimeMetricsData', () => {
-    let prepared;
-    const [{ title: firstTitle }, { title: secondTitle }] = timeMetricsData;
-    const firstKey = slugify(firstTitle);
-    const secondKey = slugify(secondTitle);
-
-    beforeEach(() => {
-      prepared = prepareTimeMetricsData(timeMetricsData, {
-        [firstKey]: { description: 'Is a value that is good' },
-      });
-    });
-
-    it('will add a `key` based on the title', () => {
-      expect(prepared).toMatchObject([{ key: firstKey }, { key: secondKey }]);
-    });
-
-    it('will add a `label` key', () => {
-      expect(prepared).toMatchObject([{ label: 'Lead Time' }, { label: 'Cycle Time' }]);
-    });
-
-    it('will add a popover description using the key if it is provided', () => {
-      expect(prepared).toMatchObject([
-        { description: 'Is a value that is good' },
-        { description: '' },
-      ]);
-    });
-  });
-
   describe('formatMedianValuesWithOverview', () => {
     const calculatedMedians = formatMedianValuesWithOverview(rawStageMedians);
 

ee/spec/frontend/api_spec.js

@@ -291,53 +291,6 @@ describe('Api', () => {
       });
     });
 
-    describe('cycleAnalyticsSummaryData', () => {
-      it('fetches value stream analytics summary data', (done) => {
-        const response = [
-          { value: 0, title: 'New Issues' },
-          { value: 0, title: 'Deploys' },
-        ];
-        const params = { ...defaultParams };
-        const expectedUrl = `${dummyValueStreamAnalyticsUrlRoot}/summary`;
-        mock.onGet(expectedUrl).reply(httpStatus.OK, response);
-
-        Api.cycleAnalyticsSummaryData(groupId, params)
-          .then((responseObj) =>
-            expectRequestWithCorrectParameters(responseObj, {
-              response,
-              params,
-              expectedUrl,
-            }),
-          )
-          .then(done)
-          .catch(done.fail);
-      });
-    });
-
-    describe('cycleAnalyticsTimeSummaryData', () => {
-      it('fetches value stream analytics summary data', (done) => {
-        const response = [
-          { value: '10.0', title: 'Lead time', unit: 'per day' },
-          { value: '2.0', title: 'Cycle Time', unit: 'per day' },
-        ];
-        const params = { ...defaultParams };
-
-        const expectedUrl = `${dummyValueStreamAnalyticsUrlRoot}/time_summary`;
-        mock.onGet(expectedUrl).reply(httpStatus.OK, response);
-
-        Api.cycleAnalyticsTimeSummaryData(groupId, params)
-          .then((responseObj) =>
-            expectRequestWithCorrectParameters(responseObj, {
-              response,
-              params,
-              expectedUrl,
-            }),
-          )
-          .then(done)
-          .catch(done.fail);
-      });
-    });
-
     describe('cycleAnalyticsValueStreams', () => {
       it('fetches custom value streams', (done) => {
         const response = [{ name: 'value stream 1', id: 1 }];

spec/frontend/cycle_analytics/utils_spec.js

@@ -7,7 +7,9 @@ import {
   formatMedianValues,
   filterStagesByHiddenStatus,
   calculateFormattedDayInPast,
+  prepareTimeMetricsData,
 } from '~/cycle_analytics/utils';
+import { slugify } from '~/lib/utils/text_utility';
 import {
   selectedStage,
   rawData,
@@ -16,6 +18,7 @@ import {
   stageMedians,
   pathNavIssueMetric,
   rawStageMedians,
+  metricsData,
 } from './mock_data';
 
 describe('Value stream analytics utils', () => {
@@ -129,4 +132,32 @@ describe('Value stream analytics utils', () => {
       expect(calculateFormattedDayInPast(5)).toEqual({ now: '1815-12-10', past: '1815-12-05' });
     });
   });
+
+  describe('prepareTimeMetricsData', () => {
+    let prepared;
+    const [first, second] = metricsData;
+    const firstKey = slugify(first.title);
+    const secondKey = slugify(second.title);
+
+    beforeEach(() => {
+      prepared = prepareTimeMetricsData([first, second], {
+        [firstKey]: { description: 'Is a value that is good' },
+      });
+    });
+
+    it('will add a `key` based on the title', () => {
+      expect(prepared).toMatchObject([{ key: firstKey }, { key: secondKey }]);
+    });
+
+    it('will add a `label` key', () => {
+      expect(prepared).toMatchObject([{ label: 'New Issues' }, { label: 'Commits' }]);
+    });
+
+    it('will add a popover description using the key if it is provided', () => {
+      expect(prepared).toMatchObject([
+        { description: 'Is a value that is good' },
+        { description: '' },
+      ]);
+    });
+  });
 });