From 5ed3139d5abbe12009c1ba4b892e1b08e5759f3c Mon Sep 17 00:00:00 2001 From: Sofia Papagiannaki Date: Sat, 9 Mar 2019 13:35:13 +0200 Subject: [PATCH] Fix histogram x-axis min/max This commit: *fixes histogram computation when zero x-axis min/max are set (they used to be ignored). *validates the user defined x-axis min/max values and ignores them if they result in invalid bucket sizes. --- public/app/plugins/panel/graph/graph.ts | 12 +- .../plugins/panel/graph/specs/graph.test.ts | 362 +++++++++++++++++- 2 files changed, 361 insertions(+), 13 deletions(-) diff --git a/public/app/plugins/panel/graph/graph.ts b/public/app/plugins/panel/graph/graph.ts index 98330196ca2..e3eed6fc382 100755 --- a/public/app/plugins/panel/graph/graph.ts +++ b/public/app/plugins/panel/graph/graph.ts @@ -337,9 +337,17 @@ class GraphElement { let bucketSize: number; if (this.data.length) { - const histMin = panel.xaxis.min ? panel.xaxis.min : _.min(_.map(this.data, s => s.stats.min)); - const histMax = panel.xaxis.max ? panel.xaxis.max : _.max(_.map(this.data, s => s.stats.max)); + let histMin = _.min(_.map(this.data, s => s.stats.min)); + let histMax = _.max(_.map(this.data, s => s.stats.max)); const ticks = panel.xaxis.buckets || this.panelWidth / 50; + if (panel.xaxis.min != null) { + const isInvalidXaxisMin = tickStep(panel.xaxis.min, histMax, ticks) <= 0; + histMin = isInvalidXaxisMin ? histMin : panel.xaxis.min; + } + if (panel.xaxis.max != null) { + const isInvalidXaxisMax = tickStep(histMin, panel.xaxis.max, ticks) <= 0; + histMax = isInvalidXaxisMax ? histMax : panel.xaxis.max; + } bucketSize = tickStep(histMin, histMax, ticks); options.series.bars.barWidth = bucketSize * 0.8; this.data = convertToHistogramData(this.data, bucketSize, this.ctrl.hiddenSeries, histMin, histMax); diff --git a/public/app/plugins/panel/graph/specs/graph.test.ts b/public/app/plugins/panel/graph/specs/graph.test.ts index 6ffc0ed7fc3..ff81a8ae6eb 100644 --- a/public/app/plugins/panel/graph/specs/graph.test.ts +++ b/public/app/plugins/panel/graph/specs/graph.test.ts @@ -532,9 +532,72 @@ describe('grafanaGraph', () => { }); it('should not contain values lower than min', () => { - const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); - expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(200); - expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(200); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis min is zero', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = 0; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[-100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('should not contain values lower than zero', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis min is null', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = null; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[-100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis min should not affect the histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(-100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis min is undefined', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = undefined; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[-100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis min should not affect the histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(-100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); }); }); @@ -552,10 +615,73 @@ describe('grafanaGraph', () => { }); }); - it('should not contain values lower than min', () => { - const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); - expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); - expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(200); + it('should not contain values greater than max', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(200); + }); + }); + + describe('when graph is histogram, and xaxis max is zero', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.max = 0; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[-100, 1], [100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('should not contain values greater than zero', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(-100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(-100); + }); + }); + + describe('when graph is histogram, and xaxis max is null', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.max = null; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[-100, 1], [100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis max should not affect the histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(-100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis max is undefined', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.max = undefined; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[-100, 1], [100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis max should not should node affect the histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(-100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); }); }); @@ -574,10 +700,224 @@ describe('grafanaGraph', () => { }); }); - it('should not contain values lower than min', () => { - const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); - expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(200); - expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(200); + it('should not contain values lower than min and greater than max', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(200); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(200); + }); + }); + + describe('when graph is histogram, and xaxis min and max are zero', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = 0; + ctrl.panel.xaxis.max = 0; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[-100, 1], [100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis max should be ignored otherwise the bucketSize is zero', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis min and max are null', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = null; + ctrl.panel.xaxis.max = null; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis min and max should not affect the histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis min and max are undefined', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = undefined; + ctrl.panel.xaxis.max = undefined; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis min and max should not affect the histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis min is greater than xaxis max', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = 150; + ctrl.panel.xaxis.max = 100; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis max should be ignored otherwise the bucketSize is negative', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(200); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + // aaa + describe('when graph is histogram, and xaxis min is greater than the maximum value', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = 301; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis min should be ignored otherwise the bucketSize is negative', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis min is equal to the maximum value', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = 300; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis min should be ignored otherwise the bucketSize is zero', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis min is lower than the minimum value', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.min = 99; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('xaxis min should not affect the histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); + }); + }); + + describe('when graph is histogram, and xaxis max is equal to the minimum value', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.max = 100; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('should calculate correct histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(100); + }); + }); + + describe('when graph is histogram, and xaxis max is a lower than the minimum value', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.max = 99; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('should calculate empty histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(nonZero.length).toBe(0); + }); + }); + + describe('when graph is histogram, and xaxis max is greater than the maximum value', () => { + beforeEach(() => { + setupCtx(() => { + ctrl.panel.xaxis.mode = 'histogram'; + ctrl.panel.xaxis.max = 301; + ctrl.panel.stack = false; + ctrl.hiddenSeries = {}; + ctx.data[0] = new TimeSeries({ + datapoints: [[100, 1], [100, 2], [200, 3], [300, 4]], + alias: 'series1', + }); + }); + }); + + it('should calculate correct histogram', () => { + const nonZero = ctx.plotData[0].data.filter(t => t[1] > 0); + expect(Math.min.apply(Math, nonZero.map(t => t[0]))).toBe(100); + expect(Math.max.apply(Math, nonZero.map(t => t[0]))).toBe(300); }); }); });