/** * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ import { getNumberFormatter, NumberFormats, TRUNCATION_MAX_CHARS, } from '@superset-ui/core'; import { SeriesOption } from 'echarts'; import { collapseForecastKeys, extractForecastSeriesContext, extractForecastValuesFromTooltipParams, formatForecastTooltipSeries, rebaseForecastDatum, reorderForecastSeries, } from '../../src/utils/forecast'; import { ForecastSeriesEnum } from '../../src/types'; describe('extractForecastSeriesContext', () => { test('should extract the correct series name and type', () => { expect(extractForecastSeriesContext('abcd')).toEqual({ name: 'abcd', type: ForecastSeriesEnum.Observation, }); expect(extractForecastSeriesContext('qwerty__yhat')).toEqual({ name: 'qwerty', type: ForecastSeriesEnum.ForecastTrend, }); expect(extractForecastSeriesContext('X Y Z___yhat_upper')).toEqual({ name: 'X Y Z_', type: ForecastSeriesEnum.ForecastUpper, }); expect(extractForecastSeriesContext('1 2 3__yhat_lower')).toEqual({ name: '1 2 3', type: ForecastSeriesEnum.ForecastLower, }); }); }); describe('reorderForecastSeries', () => { test('should reorder the forecast series and preserve values', () => { const input: SeriesOption[] = [ { id: `series${ForecastSeriesEnum.Observation}`, data: [10, 20, 30] }, { id: `series${ForecastSeriesEnum.ForecastTrend}`, data: [15, 25, 35] }, { id: `series${ForecastSeriesEnum.ForecastLower}`, data: [5, 15, 25] }, { id: `series${ForecastSeriesEnum.ForecastUpper}`, data: [25, 35, 45] }, ]; const expectedOutput: SeriesOption[] = [ { id: `series${ForecastSeriesEnum.ForecastLower}`, data: [5, 15, 25] }, { id: `series${ForecastSeriesEnum.ForecastUpper}`, data: [25, 35, 45] }, { id: `series${ForecastSeriesEnum.ForecastTrend}`, data: [15, 25, 35] }, { id: `series${ForecastSeriesEnum.Observation}`, data: [10, 20, 30] }, ]; expect(reorderForecastSeries(input)).toEqual(expectedOutput); }); test('should handle an empty array', () => { expect(reorderForecastSeries([])).toEqual([]); }); test('should not reorder if no relevant series are present', () => { const input: SeriesOption[] = [{ id: 'some-other-series' }]; expect(reorderForecastSeries(input)).toEqual(input); }); test('should handle undefined ids', () => { const input: SeriesOption[] = [ { id: `series${ForecastSeriesEnum.ForecastLower}` }, { id: undefined }, { id: `series${ForecastSeriesEnum.ForecastTrend}` }, ]; const expectedOutput: SeriesOption[] = [ { id: `series${ForecastSeriesEnum.ForecastLower}` }, { id: `series${ForecastSeriesEnum.ForecastTrend}` }, { id: undefined }, ]; expect(reorderForecastSeries(input)).toEqual(expectedOutput); }); }); describe('rebaseForecastDatum', () => { test('should subtract lower confidence level from upper value', () => { expect( rebaseForecastDatum([ { __timestamp: new Date('2001-01-01'), abc: 10, abc__yhat_lower: 1, abc__yhat_upper: 20, }, { __timestamp: new Date('2001-01-01'), abc: 10, abc__yhat_lower: -10, abc__yhat_upper: 20, }, { __timestamp: new Date('2002-01-01'), abc: 10, abc__yhat_lower: null, abc__yhat_upper: 20, }, { __timestamp: new Date('2003-01-01'), abc: 10, abc__yhat_lower: 1, abc__yhat_upper: null, }, ]), ).toEqual([ { __timestamp: new Date('2001-01-01'), abc: 10, abc__yhat_lower: 1, abc__yhat_upper: 19, }, { __timestamp: new Date('2001-01-01'), abc: 10, abc__yhat_lower: -10, abc__yhat_upper: 30, }, { __timestamp: new Date('2002-01-01'), abc: 10, abc__yhat_lower: null, abc__yhat_upper: 20, }, { __timestamp: new Date('2003-01-01'), abc: 10, abc__yhat_lower: 1, abc__yhat_upper: null, }, ]); }); test('should rename all series based on verboseMap but leave __timestamp alone', () => { expect( rebaseForecastDatum( [ { __timestamp: new Date('2001-01-01'), abc: 10, abc__yhat_lower: 1, abc__yhat_upper: 20, }, { __timestamp: new Date('2002-01-01'), abc: 10, abc__yhat_lower: null, abc__yhat_upper: 20, }, { __timestamp: new Date('2003-01-01'), abc: 10, abc__yhat_lower: 1, abc__yhat_upper: null, }, ], { abc: 'Abracadabra', __timestamp: 'Time', }, ), ).toEqual([ { __timestamp: new Date('2001-01-01'), Abracadabra: 10, Abracadabra__yhat_lower: 1, Abracadabra__yhat_upper: 19, }, { __timestamp: new Date('2002-01-01'), Abracadabra: 10, Abracadabra__yhat_lower: null, Abracadabra__yhat_upper: 20, }, { __timestamp: new Date('2003-01-01'), Abracadabra: 10, Abracadabra__yhat_lower: 1, Abracadabra__yhat_upper: null, }, ]); }); }); test('extractForecastValuesFromTooltipParams should extract the proper data from tooltip params', () => { expect( extractForecastValuesFromTooltipParams([ { marker: '', seriesId: 'abc', value: [new Date(0), 10], }, { marker: '', seriesId: 'abc__yhat', value: [new Date(0), 1], }, { marker: '', seriesId: 'abc__yhat_lower', value: [new Date(0), 5], }, { marker: '', seriesId: 'abc__yhat_upper', value: [new Date(0), 6], }, { marker: '', seriesId: 'qwerty', value: [new Date(0), 2], }, ]), ).toEqual({ abc: { marker: '', observation: 10, forecastTrend: 1, forecastLower: 5, forecastUpper: 6, }, qwerty: { marker: '', observation: 2, }, }); }); test('extractForecastValuesFromTooltipParams should extract valid values', () => { expect( extractForecastValuesFromTooltipParams([ { marker: '', seriesId: 'foo', value: [0, 10], }, { marker: '', seriesId: 'bar', value: [100, 0], }, ]), ).toEqual({ foo: { marker: '', observation: 10, }, bar: { marker: '', observation: 0, }, }); }); const formatter = getNumberFormatter(NumberFormats.INTEGER); test('formatForecastTooltipSeries should apply format to value', () => { expect( formatForecastTooltipSeries({ seriesName: 'abc', marker: '', observation: 10.1, formatter, }), ).toEqual(['abc', '10']); }); test('formatForecastTooltipSeries should show falsy value', () => { expect( formatForecastTooltipSeries({ seriesName: 'abc', marker: '', observation: 0, formatter, }), ).toEqual(['abc', '0']); }); test('formatForecastTooltipSeries should format full forecast', () => { expect( formatForecastTooltipSeries({ seriesName: 'qwerty', marker: '', observation: 10.1, forecastTrend: 20.1, forecastLower: 5.1, forecastUpper: 7.1, formatter, }), ).toEqual(['qwerty', '10, ŷ = 20 (5, 12)']); }); test('formatForecastTooltipSeries should format forecast without observation', () => { expect( formatForecastTooltipSeries({ seriesName: 'qwerty', marker: '', forecastTrend: 20, forecastLower: 5, forecastUpper: 7, formatter, }), ).toEqual(['qwerty', 'ŷ = 20 (5, 12)']); }); test('formatForecastTooltipSeries should format forecast without point estimate', () => { expect( formatForecastTooltipSeries({ seriesName: 'qwerty', marker: '', observation: 10.1, forecastLower: 6, forecastUpper: 7, formatter, }), ).toEqual(['qwerty', '10 (6, 13)']); }); test('formatForecastTooltipSeries should format forecast with only confidence band', () => { expect( formatForecastTooltipSeries({ seriesName: 'qwerty', marker: '', forecastLower: 7, forecastUpper: 8, formatter, }), ).toEqual(['qwerty', '(7, 15)']); }); test('formatForecastTooltipSeries should show forecast trend equal to zero', () => { expect( formatForecastTooltipSeries({ seriesName: 'qwerty', marker: '', observation: 10, forecastTrend: 0, forecastLower: 5, forecastUpper: 7, formatter, }), ).toEqual(['qwerty', '10, ŷ = 0 (5, 12)']); }); test('formatForecastTooltipSeries should show confidence band when lower bound is zero', () => { expect( formatForecastTooltipSeries({ seriesName: 'qwerty', marker: '', observation: 10, forecastTrend: 5, forecastLower: 0, forecastUpper: 7, formatter, }), ).toEqual(['qwerty', '10, ŷ = 5 (0, 7)']); }); test('formatForecastTooltipSeries should show confidence band when band height is zero', () => { expect( formatForecastTooltipSeries({ seriesName: 'qwerty', marker: '', observation: 10, forecastTrend: 5, forecastLower: 4, forecastUpper: 0, formatter, }), ).toEqual(['qwerty', '10, ŷ = 5 (4, 4)']); }); test('formatForecastTooltipSeries should show forecast trend and band all at zero', () => { expect( formatForecastTooltipSeries({ seriesName: 'qwerty', marker: '', forecastTrend: 0, forecastLower: 0, forecastUpper: 0, formatter, }), ).toEqual(['qwerty', 'ŷ = 0 (0, 0)']); }); test('formatForecastTooltipSeries should skip non-finite forecast values', () => { expect( formatForecastTooltipSeries({ seriesName: 'qwerty', marker: '', observation: 10, forecastTrend: NaN, forecastLower: Infinity, forecastUpper: -Infinity, formatter, }), ).toEqual(['qwerty', '10']); }); describe('formatForecastTooltipSeries truncation', () => { const marker = ''; const longName = 'prod-us-east-1-service-checkout-latency-p99'; // 43 chars const intFormatter = getNumberFormatter(NumberFormats.INTEGER); const format = (truncation?: 'off' | 'end' | 'start' | 'middle') => formatForecastTooltipSeries({ seriesName: longName, observation: 1, marker, formatter: intFormatter, ...(truncation ? { truncation } : {}), })[0]; test('leaves the name intact by default and for off/end', () => { expect(format()).toContain(longName); expect(format('off')).toContain(longName); expect(format('end')).toContain(longName); }); test('slices the start of the name without harming the marker', () => { const cell = format('start'); expect(cell).toContain(marker); expect(cell).toContain('…-us-east-1-service-checkout-latency-p99'); expect(cell).not.toContain('prod-us-east'); }); test('slices the middle of the name without harming the marker', () => { const cell = format('middle'); expect(cell).toContain(marker); expect(cell).toContain('prod-us-east-1-servi…heckout-latency-p99'); }); test('measures the budget against the name, not the marker markup', () => { // The marker alone is far longer than the budget. If truncation were // applied to the concatenated cell, a short name would be mangled. expect(marker.length).toBeGreaterThan(TRUNCATION_MAX_CHARS); const [cell] = formatForecastTooltipSeries({ seriesName: 'cpu', observation: 1, marker, formatter: intFormatter, truncation: 'start', }); expect(cell).toBe(`${marker}cpu`); }); }); describe('collapseForecastKeys', () => { test('leaves plain observation series untouched and in order', () => { expect(collapseForecastKeys(['foo', 'bar'])).toEqual(['foo', 'bar']); }); test('folds a forecast bundle down to a single key', () => { expect( collapseForecastKeys([ 'foo', 'foo__yhat', 'foo__yhat_lower', 'foo__yhat_upper', ]), ).toEqual(['foo']); }); test('keeps a key for metrics whose labels are entirely forecast suffixes', () => { // Charts can carry metrics literally labelled `ci__yhat*` with no plain // observation series. Callers match these against forecast-stripped keys, // so an uncollapsed id here would match nothing and drop every row. expect( collapseForecastKeys(['ci__yhat', 'ci__yhat_lower', 'ci__yhat_upper']), ).toEqual(['ci']); }); test('preserves the incoming order of distinct series', () => { expect( collapseForecastKeys(['b__yhat_lower', 'a__yhat', 'b__yhat']), ).toEqual(['b', 'a']); }); });