Merge branch '26944-prometheus-memory-sparkline' into 'master'

Add Prometheus memory sparkline to MR widget

Closes #26944

See merge request !11209

4 files changed, 400 insertions, 0 deletions

diff --git a/spec/javascripts/vue_mr_widget/components/mr_widget_deployment_spec.js b/spec/javascripts/vue_mr_widget/components/mr_widget_deployment_spec.js
index 3d5f71babfb..2f971b39d16 100644
--- a/spec/javascripts/vue_mr_widget/components/mr_widget_deployment_spec.js
+++ b/spec/javascripts/vue_mr_widget/components/mr_widget_deployment_spec.js
@@ -9,6 +9,7 @@ const deploymentMockData = [
     name: 'review/diplo',
     url: '/root/acets-review-apps/environments/15',
     stop_url: '/root/acets-review-apps/environments/15/stop',
+    metrics_url: '/root/acets-review-apps/environments/15/deployments/1/metrics',
     external_url: 'http://diplo.',
     external_url_formatted: 'diplo.',
     deployed_at: '2017-03-22T22:44:42.258Z',
@@ -156,6 +157,7 @@ describe('MRWidgetDeployment', () => {
       expect(el.querySelector('.js-deploy-url').getAttribute('href')).toEqual(deployment.external_url);
       expect(el.querySelector('.js-deploy-url').innerText).toContain(deployment.external_url_formatted);
       expect(el.querySelector('.js-deploy-time').innerText).toContain(vm.formatDate(deployment.deployed_at));
+      expect(el.querySelector('.js-mr-memory-usage')).toBeDefined();
       expect(el.querySelector('button')).toBeDefined();
     });
 
@@ -165,6 +167,7 @@ describe('MRWidgetDeployment', () => {
 
       Vue.nextTick(() => {
         expect(el.querySelectorAll('.ci-widget').length).toEqual(3);
+        expect(el.querySelectorAll('.js-mr-memory-usage').length).toEqual(3);
         done();
       });
     });
@@ -176,6 +179,7 @@ describe('MRWidgetDeployment', () => {
         expect(el.querySelectorAll('.js-deploy-meta').length).toEqual(0);
         expect(el.querySelectorAll('.js-deploy-url').length).toEqual(0);
         expect(el.querySelectorAll('.js-deploy-time').length).toEqual(0);
+        expect(el.querySelectorAll('.js-mr-memory-usage').length).toEqual(0);
         expect(el.querySelectorAll('.button').length).toEqual(0);
         done();
       });
diff --git a/spec/javascripts/vue_mr_widget/components/mr_widget_memory_usage_spec.js b/spec/javascripts/vue_mr_widget/components/mr_widget_memory_usage_spec.js
new file mode 100644
index 00000000000..da9dff18ada
--- /dev/null
+++ b/spec/javascripts/vue_mr_widget/components/mr_widget_memory_usage_spec.js
@@ -0,0 +1,184 @@
+import Vue from 'vue';
+import memoryUsageComponent from '~/vue_merge_request_widget/components/mr_widget_memory_usage';
+import MRWidgetService from '~/vue_merge_request_widget/services/mr_widget_service';
+
+const url = '/root/acets-review-apps/environments/15/deployments/1/metrics';
+
+const metricsMockData = {
+  success: true,
+  metrics: {
+    memory_values: [
+      {
+        metric: {},
+        values: [
+          [1493716685, '4.30859375'],
+        ],
+      },
+    ],
+  },
+  last_update: '2017-05-02T12:34:49.628Z',
+  deployment_time: 1493718485,
+};
+
+const createComponent = () => {
+  const Component = Vue.extend(memoryUsageComponent);
+
+  return new Component({
+    el: document.createElement('div'),
+    propsData: {
+      metricsUrl: url,
+      memoryMetrics: [],
+      deploymentTime: 0,
+      hasMetrics: false,
+      loadFailed: false,
+      loadingMetrics: true,
+      backOffRequestCounter: 0,
+    },
+  });
+};
+
+const messages = {
+  loadingMetrics: 'Loading deployment statistics.',
+  hasMetrics: 'Deployment memory usage:',
+  loadFailed: 'Failed to load deployment statistics.',
+  metricsUnavailable: 'Deployment statistics are not available currently.',
+};
+
+describe('MemoryUsage', () => {
+  let vm;
+  let el;
+
+  beforeEach(() => {
+    vm = createComponent();
+    el = vm.$el;
+  });
+
+  describe('props', () => {
+    it('should have props with defaults', () => {
+      const { metricsUrl } = memoryUsageComponent.props;
+      const MetricsUrlTypeClass = metricsUrl.type;
+
+      Vue.nextTick(() => {
+        expect(new MetricsUrlTypeClass() instanceof String).toBeTruthy();
+        expect(metricsUrl.required).toBeTruthy();
+      });
+    });
+  });
+
+  describe('data', () => {
+    it('should have default data', () => {
+      const data = memoryUsageComponent.data();
+
+      expect(Array.isArray(data.memoryMetrics)).toBeTruthy();
+      expect(data.memoryMetrics.length).toBe(0);
+
+      expect(typeof data.deploymentTime).toBe('number');
+      expect(data.deploymentTime).toBe(0);
+
+      expect(typeof data.hasMetrics).toBe('boolean');
+      expect(data.hasMetrics).toBeFalsy();
+
+      expect(typeof data.loadFailed).toBe('boolean');
+      expect(data.loadFailed).toBeFalsy();
+
+      expect(typeof data.loadingMetrics).toBe('boolean');
+      expect(data.loadingMetrics).toBeTruthy();
+
+      expect(typeof data.backOffRequestCounter).toBe('number');
+      expect(data.backOffRequestCounter).toBe(0);
+    });
+  });
+
+  describe('methods', () => {
+    const { metrics, deployment_time } = metricsMockData;
+
+    describe('computeGraphData', () => {
+      it('should populate sparkline graph', () => {
+        vm.computeGraphData(metrics, deployment_time);
+        const { hasMetrics, memoryMetrics, deploymentTime } = vm;
+
+        expect(hasMetrics).toBeTruthy();
+        expect(memoryMetrics.length > 0).toBeTruthy();
+        expect(deploymentTime).toEqual(deployment_time);
+      });
+    });
+
+    describe('loadMetrics', () => {
+      const returnServicePromise = () => new Promise((resolve) => {
+        resolve({
+          json() {
+            return metricsMockData;
+          },
+        });
+      });
+
+      it('should load metrics data using MRWidgetService', (done) => {
+        spyOn(MRWidgetService, 'fetchMetrics').and.returnValue(returnServicePromise(true));
+        spyOn(vm, 'computeGraphData');
+
+        vm.loadMetrics();
+        setTimeout(() => {
+          expect(MRWidgetService.fetchMetrics).toHaveBeenCalledWith(url);
+          expect(vm.computeGraphData).toHaveBeenCalledWith(metrics, deployment_time);
+          done();
+        }, 333);
+      });
+    });
+  });
+
+  describe('template', () => {
+    it('should render template elements correctly', () => {
+      expect(el.classList.contains('mr-memory-usage')).toBeTruthy();
+      expect(el.querySelector('.js-usage-info')).toBeDefined();
+    });
+
+    it('should show loading metrics message while metrics are being loaded', (done) => {
+      vm.loadingMetrics = true;
+      vm.hasMetrics = false;
+      vm.loadFailed = false;
+
+      Vue.nextTick(() => {
+        expect(el.querySelector('.js-usage-info.usage-info-loading')).toBeDefined();
+        expect(el.querySelector('.js-usage-info .usage-info-load-spinner')).toBeDefined();
+        expect(el.querySelector('.js-usage-info').innerText).toContain(messages.loadingMetrics);
+        done();
+      });
+    });
+
+    it('should show deployment memory usage when metrics are loaded', (done) => {
+      vm.loadingMetrics = false;
+      vm.hasMetrics = true;
+      vm.loadFailed = false;
+
+      Vue.nextTick(() => {
+        expect(el.querySelector('.memory-graph-container')).toBeDefined();
+        expect(el.querySelector('.js-usage-info').innerText).toContain(messages.hasMetrics);
+        done();
+      });
+    });
+
+    it('should show failure message when metrics loading failed', (done) => {
+      vm.loadingMetrics = false;
+      vm.hasMetrics = false;
+      vm.loadFailed = true;
+
+      Vue.nextTick(() => {
+        expect(el.querySelector('.js-usage-info.usage-info-failed')).toBeDefined();
+        expect(el.querySelector('.js-usage-info').innerText).toContain(messages.loadFailed);
+        done();
+      });
+    });
+
+    it('should show metrics unavailable message when metrics loading failed', (done) => {
+      vm.loadingMetrics = false;
+      vm.hasMetrics = false;
+      vm.loadFailed = false;
+
+      Vue.nextTick(() => {
+        expect(el.querySelector('.js-usage-info.usage-info-unavailable')).toBeDefined();
+        expect(el.querySelector('.js-usage-info').innerText).toContain(messages.metricsUnavailable);
+        done();
+      });
+    });
+  });
+});
diff --git a/spec/javascripts/vue_shared/components/memory_graph_spec.js b/spec/javascripts/vue_shared/components/memory_graph_spec.js
new file mode 100644
index 00000000000..d46a3f2328e
--- /dev/null
+++ b/spec/javascripts/vue_shared/components/memory_graph_spec.js
@@ -0,0 +1,143 @@
+import Vue from 'vue';
+import memoryGraphComponent from '~/vue_shared/components/memory_graph';
+import { mockMetrics, mockMedian, mockMedianIndex } from './mock_data';
+
+const defaultHeight = '25';
+const defaultWidth = '100';
+
+const createComponent = () => {
+  const Component = Vue.extend(memoryGraphComponent);
+
+  return new Component({
+    el: document.createElement('div'),
+    propsData: {
+      metrics: [],
+      deploymentTime: 0,
+      width: '',
+      height: '',
+      pathD: '',
+      pathViewBox: '',
+      dotX: '',
+      dotY: '',
+    },
+  });
+};
+
+describe('MemoryGraph', () => {
+  let vm;
+  let el;
+
+  beforeEach(() => {
+    vm = createComponent();
+    el = vm.$el;
+  });
+
+  describe('props', () => {
+    it('should have props with defaults', (done) => {
+      const { metrics, deploymentTime, width, height } = memoryGraphComponent.props;
+
+      Vue.nextTick(() => {
+        const typeClassMatcher = (propItem, expectedType) => {
+          const PropItemTypeClass = propItem.type;
+          expect(new PropItemTypeClass() instanceof expectedType).toBeTruthy();
+          expect(propItem.required).toBeTruthy();
+        };
+
+        typeClassMatcher(metrics, Array);
+        typeClassMatcher(deploymentTime, Number);
+        typeClassMatcher(width, String);
+        typeClassMatcher(height, String);
+        done();
+      });
+    });
+  });
+
+  describe('data', () => {
+    it('should have default data', () => {
+      const data = memoryGraphComponent.data();
+      const dataValidator = (dataItem, expectedType, defaultVal) => {
+        expect(typeof dataItem).toBe(expectedType);
+        expect(dataItem).toBe(defaultVal);
+      };
+
+      dataValidator(data.pathD, 'string', '');
+      dataValidator(data.pathViewBox, 'string', '');
+      dataValidator(data.dotX, 'string', '');
+      dataValidator(data.dotY, 'string', '');
+    });
+  });
+
+  describe('computed', () => {
+    describe('getFormattedMedian', () => {
+      it('should show human readable median value based on provided median timestamp', () => {
+        vm.deploymentTime = mockMedian;
+        const formattedMedian = vm.getFormattedMedian;
+        expect(formattedMedian.indexOf('Deployed') > -1).toBeTruthy();
+        expect(formattedMedian.indexOf('ago') > -1).toBeTruthy();
+      });
+    });
+  });
+
+  describe('methods', () => {
+    describe('getMedianMetricIndex', () => {
+      it('should return index of closest metric timestamp to that of median', () => {
+        const matchingIndex = vm.getMedianMetricIndex(mockMedian, mockMetrics);
+        expect(matchingIndex).toBe(mockMedianIndex);
+      });
+    });
+
+    describe('getGraphPlotValues', () => {
+      it('should return Object containing values to plot graph', () => {
+        const plotValues = vm.getGraphPlotValues(mockMedian, mockMetrics);
+        expect(plotValues.pathD).toBeDefined();
+        expect(Array.isArray(plotValues.pathD)).toBeTruthy();
+
+        expect(plotValues.pathViewBox).toBeDefined();
+        expect(typeof plotValues.pathViewBox).toBe('object');
+
+        expect(plotValues.dotX).toBeDefined();
+        expect(typeof plotValues.dotX).toBe('number');
+
+        expect(plotValues.dotY).toBeDefined();
+        expect(typeof plotValues.dotY).toBe('number');
+      });
+    });
+  });
+
+  describe('template', () => {
+    it('should render template elements correctly', () => {
+      expect(el.classList.contains('memory-graph-container')).toBeTruthy();
+      expect(el.querySelector('svg')).toBeDefined();
+    });
+
+    it('should render graph when renderGraph is called internally', (done) => {
+      const { pathD, pathViewBox, dotX, dotY } = vm.getGraphPlotValues(mockMedian, mockMetrics);
+      vm.height = defaultHeight;
+      vm.width = defaultWidth;
+      vm.pathD = `M ${pathD}`;
+      vm.pathViewBox = `0 0 ${pathViewBox.lineWidth} ${pathViewBox.diff}`;
+      vm.dotX = dotX;
+      vm.dotY = dotY;
+
+      Vue.nextTick(() => {
+        const svgEl = el.querySelector('svg');
+        expect(svgEl).toBeDefined();
+        expect(svgEl.getAttribute('height')).toBe(defaultHeight);
+        expect(svgEl.getAttribute('width')).toBe(defaultWidth);
+
+        const pathEl = el.querySelector('path');
+        expect(pathEl).toBeDefined();
+        expect(pathEl.getAttribute('d')).toBe(`M ${pathD}`);
+        expect(pathEl.getAttribute('viewBox')).toBe(`0 0 ${pathViewBox.lineWidth} ${pathViewBox.diff}`);
+
+        const circleEl = el.querySelector('circle');
+        expect(circleEl).toBeDefined();
+        expect(circleEl.getAttribute('r')).toBe('1.5');
+        expect(circleEl.getAttribute('tranform')).toBe('translate(0 -1)');
+        expect(circleEl.getAttribute('cx')).toBe(`${dotX}`);
+        expect(circleEl.getAttribute('cy')).toBe(`${dotY}`);
+        done();
+      });
+    });
+  });
+});
diff --git a/spec/javascripts/vue_shared/components/mock_data.js b/spec/javascripts/vue_shared/components/mock_data.js
new file mode 100644
index 00000000000..0d781bdca74
--- /dev/null
+++ b/spec/javascripts/vue_shared/components/mock_data.js
@@ -0,0 +1,69 @@
+/* eslint-disable */
+
+export const mockMetrics = [
+  [1493716685, '4.30859375'],
+  [1493716745, '4.30859375'],
+  [1493716805, '4.30859375'],
+  [1493716865, '4.30859375'],
+  [1493716925, '4.30859375'],
+  [1493716985, '4.30859375'],
+  [1493717045, '4.30859375'],
+  [1493717105, '4.30859375'],
+  [1493717165, '4.30859375'],
+  [1493717225, '4.30859375'],
+  [1493717285, '4.30859375'],
+  [1493717345, '4.30859375'],
+  [1493717405, '4.30859375'],
+  [1493717465, '4.30859375'],
+  [1493717525, '4.30859375'],
+  [1493717585, '4.30859375'],
+  [1493717645, '4.30859375'],
+  [1493717705, '4.30859375'],
+  [1493717765, '4.30859375'],
+  [1493717825, '4.30859375'],
+  [1493717885, '4.30859375'],
+  [1493717945, '4.30859375'],
+  [1493718005, '4.30859375'],
+  [1493718065, '4.30859375'],
+  [1493718125, '4.30859375'],
+  [1493718185, '4.30859375'],
+  [1493718245, '4.30859375'],
+  [1493718305, '4.234375'],
+  [1493718365, '4.234375'],
+  [1493718425, '4.234375'],
+  [1493718485, '4.234375'],
+  [1493718545, '4.243489583333333'],
+  [1493718605, '4.2109375'],
+  [1493718665, '4.2109375'],
+  [1493718725, '4.2109375'],
+  [1493718785, '4.26171875'],
+  [1493718845, '4.26171875'],
+  [1493718905, '4.26171875'],
+  [1493718965, '4.26171875'],
+  [1493719025, '4.26171875'],
+  [1493719085, '4.26171875'],
+  [1493719145, '4.26171875'],
+  [1493719205, '4.26171875'],
+  [1493719265, '4.26171875'],
+  [1493719325, '4.26171875'],
+  [1493719385, '4.26171875'],
+  [1493719445, '4.26171875'],
+  [1493719505, '4.26171875'],
+  [1493719565, '4.26171875'],
+  [1493719625, '4.26171875'],
+  [1493719685, '4.26171875'],
+  [1493719745, '4.26171875'],
+  [1493719805, '4.26171875'],
+  [1493719865, '4.26171875'],
+  [1493719925, '4.26171875'],
+  [1493719985, '4.26171875'],
+  [1493720045, '4.26171875'],
+  [1493720105, '4.26171875'],
+  [1493720165, '4.26171875'],
+  [1493720225, '4.26171875'],
+  [1493720285, '4.26171875'],
+];
+
+export const mockMedian = 1493718485;
+
+export const mockMedianIndex = 30;