Merge branch '235754-fe-instance-statistics-mvp-object-counts' into 'master'

Resolve "[FE] Instance Statistics MVP: object counts"

Closes #235754

See merge request gitlab-org/gitlab!41853

app/assets/javascripts/analytics/instance_statistics/components/app.vue

+<script>
+import InstanceCounts from './instance_counts.vue';
+
+export default {
+  name: 'InstanceStatisticsApp',
+  components: {
+    InstanceCounts,
+  },
+};
+</script>
+
+<template>
+  <instance-counts />
+</template>

app/assets/javascripts/analytics/instance_statistics/components/instance_counts.vue

+<script>
+import * as Sentry from '@sentry/browser';
+import { s__ } from '~/locale';
+import { deprecatedCreateFlash as createFlash } from '~/flash';
+import { SUPPORTED_FORMATS, getFormatter } from '~/lib/utils/unit_format';
+import MetricCard from '~/analytics/shared/components/metric_card.vue';
+import instanceStatisticsCountQuery from '../graphql/queries/instance_statistics_count.query.graphql';
+
+const defaultPrecision = 0;
+
+export default {
+  name: 'InstanceCounts',
+  components: {
+    MetricCard,
+  },
+  data() {
+    return {
+      counts: [],
+    };
+  },
+  apollo: {
+    counts: {
+      query: instanceStatisticsCountQuery,
+      update(data) {
+        return Object.entries(data).map(([key, obj]) => {
+          const label = this.$options.i18n.labels[key];
+          const formatter = getFormatter(SUPPORTED_FORMATS.number);
+          const value = obj.nodes?.length ? formatter(obj.nodes[0].count, defaultPrecision) : null;
+
+          return {
+            key,
+            value,
+            label,
+          };
+        });
+      },
+      error(error) {
+        createFlash(this.$options.i18n.loadCountsError);
+        Sentry.captureException(error);
+      },
+    },
+  },
+  i18n: {
+    labels: {
+      users: s__('InstanceStatistics|Users'),
+      projects: s__('InstanceStatistics|Projects'),
+      groups: s__('InstanceStatistics|Groups'),
+      issues: s__('InstanceStatistics|Issues'),
+      mergeRequests: s__('InstanceStatistics|Merge Requests'),
+      pipelines: s__('InstanceStatistics|Pipelines'),
+    },
+    loadCountsError: s__('Could not load instance counts. Please refresh the page to try again.'),
+  },
+};
+</script>
+
+<template>
+  <metric-card
+    :title="__('Instance Statistics')"
+    :metrics="counts"
+    :is-loading="$apollo.queries.counts.loading"
+    class="gl-mt-4"
+  />
+</template>

app/assets/javascripts/analytics/instance_statistics/graphql/queries/instance_statistics_count.query.graphql

+query getInstanceCounts {
+  projects: instanceStatisticsMeasurements(identifier: PROJECTS, first: 1) {
+    nodes {
+      count
+    }
+  }
+  groups: instanceStatisticsMeasurements(identifier: GROUPS, first: 1) {
+    nodes {
+      count
+    }
+  }
+  users: instanceStatisticsMeasurements(identifier: USERS, first: 1) {
+    nodes {
+      count
+    }
+  }
+  issues: instanceStatisticsMeasurements(identifier: ISSUES, first: 1) {
+    nodes {
+      count
+    }
+  }
+  mergeRequests: instanceStatisticsMeasurements(identifier: MERGE_REQUESTS, first: 1) {
+    nodes {
+      count
+    }
+  }
+  pipelines: instanceStatisticsMeasurements(identifier: PIPELINES, first: 1) {
+    nodes {
+      count
+    }
+  }
+}

app/assets/javascripts/analytics/instance_statistics/index.js

+import Vue from 'vue';
+import VueApollo from 'vue-apollo';
+import createDefaultClient from '~/lib/graphql';
+import InstanceStatisticsApp from './components/app.vue';
+
+Vue.use(VueApollo);
+
+const apolloProvider = new VueApollo({
+  defaultClient: createDefaultClient(),
+});
+
+export default () => {
+  const el = document.getElementById('js-instance-statistics-app');
+
+  if (!el) return false;
+
+  return new Vue({
+    el,
+    apolloProvider,
+    render(h) {
+      return h(InstanceStatisticsApp);
+    },
+  });
+};

app/assets/javascripts/pages/admin/instance_statistics/index.js

+import initInstanceStatisticsApp from '~/analytics/instance_statistics';
+
+document.addEventListener('DOMContentLoaded', () => initInstanceStatisticsApp());

ee/app/assets/javascripts/analytics/cycle_analytics/components/metrics.vue

 <script>
 import { OVERVIEW_METRICS } from '../constants';
 import TimeMetricsCard from './time_metrics_card.vue';
-import MetricCard from '../../shared/components/metric_card.vue';
+import MetricCard from '~/analytics/shared/components/metric_card.vue';
 
 export default {
   name: 'OverviewActivity',

ee/app/assets/javascripts/analytics/cycle_analytics/components/time_metrics_card.vue

@@ -2,7 +2,7 @@
 import Api from 'ee/api';
 import { sprintf, __, s__ } from '~/locale';
 import { deprecatedCreateFlash as createFlash } from '~/flash';
-import MetricCard from '../../shared/components/metric_card.vue';
+import MetricCard from '~/analytics/shared/components/metric_card.vue';
 import { removeFlash, prepareTimeMetricsData } from '../utils';
 import { OVERVIEW_METRICS } from '../constants';
 

ee/app/assets/javascripts/analytics/group_analytics/components/group_activity_card.vue

@@ -2,7 +2,7 @@
 import Api from 'ee/api';
 import { __, s__ } from '~/locale';
 import { deprecatedCreateFlash as createFlash } from '~/flash';
-import MetricCard from '../../shared/components/metric_card.vue';
+import MetricCard from '~/analytics/shared/components/metric_card.vue';
 
 export default {
   name: 'GroupActivityCard',

ee/spec/frontend/analytics/group_analytics/components/group_activity_card_spec.js

@@ -2,8 +2,8 @@ import { mount } from '@vue/test-utils';
 import MockAdapter from 'axios-mock-adapter';
 import Api from 'ee/api';
 import GroupActivityCard from 'ee/analytics/group_analytics/components/group_activity_card.vue';
-import MetricCard from 'ee/analytics/shared/components/metric_card.vue';
 import waitForPromises from 'helpers/wait_for_promises';
+import MetricCard from '~/analytics/shared/components/metric_card.vue';
 import axios from '~/lib/utils/axios_utils';
 
 const TEST_GROUP_ID = 'gitlab-org';

locale/gitlab.pot

@@ -8,8 +8,6 @@ msgid ""
 msgstr ""
 "Project-Id-Version: gitlab 1.0.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-09-17 11:26-0400\n"
-"PO-Revision-Date: 2020-09-17 11:26-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
@@ -7184,6 +7182,9 @@ msgstr ""
 msgid "Could not find iteration"
 msgstr ""
 
+msgid "Could not load instance counts. Please refresh the page to try again."
+msgstr ""
+
 msgid "Could not remove the trigger."
 msgstr ""
 
@@ -13586,6 +13587,24 @@ msgstr ""
 msgid "Instance administrators group already exists"
 msgstr ""
 
+msgid "InstanceStatistics|Groups"
+msgstr ""
+
+msgid "InstanceStatistics|Issues"
+msgstr ""
+
+msgid "InstanceStatistics|Merge Requests"
+msgstr ""
+
+msgid "InstanceStatistics|Pipelines"
+msgstr ""
+
+msgid "InstanceStatistics|Projects"
+msgstr ""
+
+msgid "InstanceStatistics|Users"
+msgstr ""
+
 msgid "Integration"
 msgstr ""
 

spec/frontend/analytics/instance_statistics/components/app_spec.js

+import { shallowMount } from '@vue/test-utils';
+import InstanceStatisticsApp from '~/analytics/instance_statistics/components/app.vue';
+import InstanceCounts from '~/analytics/instance_statistics/components//instance_counts.vue';
+
+describe('InstanceStatisticsApp', () => {
+  let wrapper;
+
+  const createComponent = () => {
+    wrapper = shallowMount(InstanceStatisticsApp);
+  };
+
+  beforeEach(() => {
+    createComponent();
+  });
+
+  afterEach(() => {
+    wrapper.destroy();
+    wrapper = null;
+  });
+
+  it('displays the instance counts component', () => {
+    expect(wrapper.find(InstanceCounts).exists()).toBe(true);
+  });
+});

spec/frontend/analytics/instance_statistics/components/instance_counts_spec.js

+import { shallowMount } from '@vue/test-utils';
+import InstanceCounts from '~/analytics/instance_statistics/components/instance_counts.vue';
+import MetricCard from '~/analytics/shared/components/metric_card.vue';
+import countsMockData from '../mock_data';
+
+describe('InstanceCounts', () => {
+  let wrapper;
+
+  const createComponent = ({ loading = false, data = {} } = {}) => {
+    const $apollo = {
+      queries: {
+        counts: {
+          loading,
+        },
+      },
+    };
+
+    wrapper = shallowMount(InstanceCounts, {
+      mocks: { $apollo },
+      data() {
+        return {
+          ...data,
+        };
+      },
+    });
+  };
+
+  afterEach(() => {
+    wrapper.destroy();
+    wrapper = null;
+  });
+
+  const findMetricCard = () => wrapper.find(MetricCard);
+
+  describe('while loading', () => {
+    beforeEach(() => {
+      createComponent({ loading: true });
+    });
+
+    it('displays the metric card with isLoading=true', () => {
+      expect(findMetricCard().props('isLoading')).toBe(true);
+    });
+  });
+
+  describe('with data', () => {
+    beforeEach(() => {
+      createComponent({ data: { counts: countsMockData } });
+    });
+
+    it('passes the counts data to the metric card', () => {
+      expect(findMetricCard().props('metrics')).toEqual(countsMockData);
+    });
+  });
+});

spec/frontend/analytics/instance_statistics/mock_data.js

+export default [
+  { key: 'projects', value: 10, label: 'Projects' },
+  { key: 'groups', value: 20, label: 'Group' },
+];

ee/spec/frontend/analytics/shared/components/metric_card_spec.js → spec/frontend/analytics/shared/components/metric_card_spec.js

 import { mount } from '@vue/test-utils';
 import { GlDeprecatedSkeletonLoading as GlSkeletonLoading } from '@gitlab/ui';
 import { createMockDirective, getBinding } from 'helpers/vue_mock_directive';
-import MetricCard from 'ee/analytics/shared/components/metric_card.vue';
+import MetricCard from '~/analytics/shared/components/metric_card.vue';
 
 const metrics = [
   { key: 'first_metric', value: 10, label: 'First metric', unit: 'days', link: 'some_link' },