diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/advanced_options.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/advanced_options.tsx
index ea5eb14d9c20e..c8676faad0eea 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/advanced_options.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/advanced_options.tsx
@@ -20,9 +20,7 @@ export function AdvancedOptions(props: {
}) {
const [popoverOpen, setPopoverOpen] = useState(false);
const popoverOptions = props.options.filter((option) => option.showInPopover);
- const inlineOptions = props.options
- .filter((option) => option.inlineElement)
- .map((option) => React.cloneElement(option.inlineElement!, { key: option.dataTestSubj }));
+ const inlineOptions = props.options.filter((option) => option.inlineElement);
return (
<>
@@ -74,7 +72,12 @@ export function AdvancedOptions(props: {
{inlineOptions.length > 0 && (
<>
- {inlineOptions}
+ {inlineOptions.map((option, index) => (
+ <>
+ {React.cloneElement(option.inlineElement!, { key: option.dataTestSubj })}
+ {index !== inlineOptions.length - 1 &&
}
+
+ ))}
)}
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.tsx
index 7732b53db62fb..2ae7b9403a46d 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.tsx
@@ -43,6 +43,7 @@ import { ReferenceEditor } from './reference_editor';
import { setTimeScaling, TimeScaling } from './time_scaling';
import { defaultFilter, Filtering, setFilter } from './filtering';
import { AdvancedOptions } from './advanced_options';
+import { setTimeShift, TimeShift } from './time_shift';
import { useDebouncedValue } from '../../shared_components';
const operationPanels = getOperationDisplay();
@@ -142,6 +143,7 @@ export function DimensionEditor(props: DimensionEditorProps) {
}, [fieldByOperation, operationWithoutField]);
const [filterByOpenInitially, setFilterByOpenInitally] = useState(false);
+ const [timeShiftedFocused, setTimeShiftFocused] = useState(false);
// Operations are compatible if they match inputs. They are always compatible in
// the empty state. Field-based operations are not compatible with field-less operations.
@@ -506,6 +508,38 @@ export function DimensionEditor(props: DimensionEditorProps) {
/>
) : null,
},
+ {
+ title: i18n.translate('xpack.lens.indexPattern.timeShift.label', {
+ defaultMessage: 'Time shift',
+ }),
+ dataTestSubj: 'indexPattern-time-shift-enable',
+ onClick: () => {
+ setTimeShiftFocused(true);
+ setStateWrapper(setTimeShift(columnId, state.layers[layerId], ''));
+ },
+ showInPopover: Boolean(
+ operationDefinitionMap[selectedColumn.operationType].shiftable &&
+ selectedColumn.timeShift === undefined &&
+ (currentIndexPattern.timeFieldName ||
+ Object.values(state.layers[layerId].columns).some(
+ (col) => col.operationType === 'date_histogram'
+ ))
+ ),
+ inlineElement:
+ operationDefinitionMap[selectedColumn.operationType].shiftable &&
+ selectedColumn.timeShift !== undefined ? (
+
+ ) : null,
+ },
]}
/>
)}
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx
index 25cf20e304daf..03db6141b917f 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx
@@ -33,6 +33,9 @@ import { OperationMetadata } from '../../types';
import { DateHistogramIndexPatternColumn } from '../operations/definitions/date_histogram';
import { getFieldByNameFactory } from '../pure_helpers';
import { Filtering } from './filtering';
+import { TimeShift } from './time_shift';
+import { DimensionEditor } from './dimension_editor';
+import { AdvancedOptions } from './advanced_options';
jest.mock('../loader');
jest.mock('../query_input', () => ({
@@ -1319,6 +1322,196 @@ describe('IndexPatternDimensionEditorPanel', () => {
});
});
+ describe('time shift', () => {
+ function getProps(colOverrides: Partial
) {
+ return {
+ ...defaultProps,
+ state: getStateWithColumns({
+ datecolumn: {
+ dataType: 'date',
+ isBucketed: true,
+ label: '',
+ customLabel: true,
+ operationType: 'date_histogram',
+ sourceField: 'ts',
+ params: {
+ interval: '1d',
+ },
+ },
+ col2: {
+ dataType: 'number',
+ isBucketed: false,
+ label: 'Count of records',
+ operationType: 'count',
+ sourceField: 'Records',
+ ...colOverrides,
+ } as IndexPatternColumn,
+ }),
+ columnId: 'col2',
+ };
+ }
+
+ it('should not show custom options if time shift is not available', () => {
+ const props = {
+ ...defaultProps,
+ state: getStateWithColumns({
+ col2: {
+ dataType: 'number',
+ isBucketed: false,
+ label: 'Count of records',
+ operationType: 'count',
+ sourceField: 'Records',
+ } as IndexPatternColumn,
+ }),
+ columnId: 'col2',
+ };
+ wrapper = shallow(
+
+ );
+ expect(
+ wrapper
+ .find(DimensionEditor)
+ .dive()
+ .find(AdvancedOptions)
+ .dive()
+ .find('[data-test-subj="indexPattern-time-shift-enable"]')
+ ).toHaveLength(0);
+ });
+
+ it('should show custom options if time shift is available', () => {
+ wrapper = shallow();
+ expect(
+ wrapper
+ .find(DimensionEditor)
+ .dive()
+ .find(AdvancedOptions)
+ .dive()
+ .find('[data-test-subj="indexPattern-time-shift-enable"]')
+ ).toHaveLength(1);
+ });
+
+ it('should show current time shift if set', () => {
+ wrapper = mount();
+ expect(wrapper.find(TimeShift).find(EuiComboBox).prop('selectedOptions')[0].value).toEqual(
+ '1d'
+ );
+ });
+
+ it('should allow to set time shift initially', () => {
+ const props = getProps({});
+ wrapper = shallow();
+ wrapper
+ .find(DimensionEditor)
+ .dive()
+ .find(AdvancedOptions)
+ .dive()
+ .find('[data-test-subj="indexPattern-time-shift-enable"]')
+ .prop('onClick')!({} as MouseEvent);
+ expect((props.setState as jest.Mock).mock.calls[0][0](props.state)).toEqual({
+ ...props.state,
+ layers: {
+ first: {
+ ...props.state.layers.first,
+ columns: {
+ ...props.state.layers.first.columns,
+ col2: expect.objectContaining({
+ timeShift: '',
+ }),
+ },
+ },
+ },
+ });
+ });
+
+ it('should carry over time shift to other operation if possible', () => {
+ const props = getProps({
+ timeShift: '1d',
+ sourceField: 'bytes',
+ operationType: 'sum',
+ label: 'Sum of bytes per hour',
+ });
+ wrapper = mount();
+ wrapper
+ .find('button[data-test-subj="lns-indexPatternDimension-count incompatible"]')
+ .simulate('click');
+ expect((props.setState as jest.Mock).mock.calls[0][0](props.state)).toEqual({
+ ...props.state,
+ layers: {
+ first: {
+ ...props.state.layers.first,
+ columns: {
+ ...props.state.layers.first.columns,
+ col2: expect.objectContaining({
+ timeShift: '1d',
+ }),
+ },
+ },
+ },
+ });
+ });
+
+ it('should allow to change time shift', () => {
+ const props = getProps({
+ timeShift: '1d',
+ });
+ wrapper = mount();
+ wrapper.find(TimeShift).find(EuiComboBox).prop('onCreateOption')!('1h', []);
+ expect((props.setState as jest.Mock).mock.calls[0][0](props.state)).toEqual({
+ ...props.state,
+ layers: {
+ first: {
+ ...props.state.layers.first,
+ columns: {
+ ...props.state.layers.first.columns,
+ col2: expect.objectContaining({
+ timeShift: '1h',
+ }),
+ },
+ },
+ },
+ });
+ });
+
+ it('should allow to time shift', () => {
+ const props = getProps({
+ timeShift: '1h',
+ });
+ wrapper = mount();
+ wrapper
+ .find('[data-test-subj="indexPattern-time-shift-remove"]')
+ .find(EuiButtonIcon)
+ .prop('onClick')!(
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ {} as any
+ );
+ expect((props.setState as jest.Mock).mock.calls[0][0](props.state)).toEqual({
+ ...props.state,
+ layers: {
+ first: {
+ ...props.state.layers.first,
+ columns: {
+ ...props.state.layers.first.columns,
+ col2: expect.objectContaining({
+ timeShift: undefined,
+ }),
+ },
+ },
+ },
+ });
+ });
+ });
+
describe('filtering', () => {
function getProps(colOverrides: Partial) {
return {
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_scaling.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_scaling.tsx
index bf5b64bf3d615..61e5da5931e88 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_scaling.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_scaling.tsx
@@ -27,7 +27,13 @@ export function setTimeScaling(
const currentColumn = layer.columns[columnId];
const label = currentColumn.customLabel
? currentColumn.label
- : adjustTimeScaleLabelSuffix(currentColumn.label, currentColumn.timeScale, timeScale);
+ : adjustTimeScaleLabelSuffix(
+ currentColumn.label,
+ currentColumn.timeScale,
+ timeScale,
+ currentColumn.timeShift,
+ currentColumn.timeShift
+ );
return {
...layer,
columns: {
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_shift.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_shift.tsx
new file mode 100644
index 0000000000000..0ac02c15b34a5
--- /dev/null
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/time_shift.tsx
@@ -0,0 +1,394 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { EuiButtonIcon } from '@elastic/eui';
+import { EuiFormRow, EuiFlexItem, EuiFlexGroup } from '@elastic/eui';
+import { EuiComboBox } from '@elastic/eui';
+import { FormattedMessage } from '@kbn/i18n/react';
+import { uniq } from 'lodash';
+import { i18n } from '@kbn/i18n';
+import React, { useEffect, useRef, useState } from 'react';
+import { Query } from 'src/plugins/data/public';
+import { search } from '../../../../../../src/plugins/data/public';
+import { parseTimeShift } from '../../../../../../src/plugins/data/common';
+import {
+ adjustTimeScaleLabelSuffix,
+ IndexPatternColumn,
+ operationDefinitionMap,
+} from '../operations';
+import { IndexPattern, IndexPatternLayer, IndexPatternPrivateState } from '../types';
+import { IndexPatternDimensionEditorProps } from './dimension_panel';
+import { FramePublicAPI } from '../../types';
+
+// to do: get the language from uiSettings
+export const defaultFilter: Query = {
+ query: '',
+ language: 'kuery',
+};
+
+export function setTimeShift(
+ columnId: string,
+ layer: IndexPatternLayer,
+ timeShift: string | undefined
+) {
+ const trimmedTimeShift = timeShift?.trim();
+ const currentColumn = layer.columns[columnId];
+ const label = currentColumn.customLabel
+ ? currentColumn.label
+ : adjustTimeScaleLabelSuffix(
+ currentColumn.label,
+ currentColumn.timeScale,
+ currentColumn.timeScale,
+ currentColumn.timeShift,
+ trimmedTimeShift
+ );
+ return {
+ ...layer,
+ columns: {
+ ...layer.columns,
+ [columnId]: {
+ ...layer.columns[columnId],
+ label,
+ timeShift: trimmedTimeShift,
+ },
+ },
+ };
+}
+
+const timeShiftOptions = [
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.hour', {
+ defaultMessage: '1 hour (1h)',
+ }),
+ value: '1h',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.3hours', {
+ defaultMessage: '3 hours (3h)',
+ }),
+ value: '3h',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.6hours', {
+ defaultMessage: '6 hours (6h)',
+ }),
+ value: '6h',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.12hours', {
+ defaultMessage: '12 hours (12h)',
+ }),
+ value: '12h',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.day', {
+ defaultMessage: '1 day (1d)',
+ }),
+ value: '1d',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.week', {
+ defaultMessage: '1 week (1w)',
+ }),
+ value: '1w',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.month', {
+ defaultMessage: '1 month (1M)',
+ }),
+ value: '1M',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.3months', {
+ defaultMessage: '3 months (3M)',
+ }),
+ value: '3M',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.6months', {
+ defaultMessage: '6 months (6M)',
+ }),
+ value: '6M',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.year', {
+ defaultMessage: '1 year (1y)',
+ }),
+ value: '1y',
+ },
+ {
+ label: i18n.translate('xpack.lens.indexPattern.timeShift.previous', {
+ defaultMessage: 'Previous',
+ }),
+ value: 'previous',
+ },
+];
+
+export function TimeShift({
+ selectedColumn,
+ columnId,
+ layer,
+ updateLayer,
+ indexPattern,
+ isFocused,
+ activeData,
+ layerId,
+}: {
+ selectedColumn: IndexPatternColumn;
+ indexPattern: IndexPattern;
+ columnId: string;
+ layer: IndexPatternLayer;
+ updateLayer: (newLayer: IndexPatternLayer) => void;
+ isFocused: boolean;
+ activeData: IndexPatternDimensionEditorProps['activeData'];
+ layerId: string;
+}) {
+ const focusSetRef = useRef(false);
+ const [localValue, setLocalValue] = useState(selectedColumn.timeShift);
+ useEffect(() => {
+ setLocalValue(selectedColumn.timeShift);
+ }, [selectedColumn.timeShift]);
+ const selectedOperation = operationDefinitionMap[selectedColumn.operationType];
+ if (!selectedOperation.shiftable || selectedColumn.timeShift === undefined) {
+ return null;
+ }
+
+ let dateHistogramInterval: null | moment.Duration = null;
+ const dateHistogramColumn = layer.columnOrder.find(
+ (colId) => layer.columns[colId].operationType === 'date_histogram'
+ );
+ if (!dateHistogramColumn && !indexPattern.timeFieldName) {
+ return null;
+ }
+ if (dateHistogramColumn && activeData && activeData[layerId] && activeData[layerId]) {
+ const column = activeData[layerId].columns.find((col) => col.id === dateHistogramColumn);
+ if (column) {
+ dateHistogramInterval = search.aggs.parseInterval(
+ search.aggs.getDateHistogramMetaDataByDatatableColumn(column)?.interval || ''
+ );
+ }
+ }
+
+ function isValueTooSmall(parsedValue: ReturnType) {
+ return (
+ dateHistogramInterval &&
+ parsedValue &&
+ typeof parsedValue === 'object' &&
+ parsedValue.asMilliseconds() < dateHistogramInterval.asMilliseconds()
+ );
+ }
+
+ function isValueNotMultiple(parsedValue: ReturnType) {
+ return (
+ dateHistogramInterval &&
+ parsedValue &&
+ typeof parsedValue === 'object' &&
+ !Number.isInteger(parsedValue.asMilliseconds() / dateHistogramInterval.asMilliseconds())
+ );
+ }
+
+ const parsedLocalValue = localValue && parseTimeShift(localValue);
+ const isLocalValueInvalid = Boolean(parsedLocalValue === 'invalid');
+ const localValueTooSmall = parsedLocalValue && isValueTooSmall(parsedLocalValue);
+ const localValueNotMultiple = parsedLocalValue && isValueNotMultiple(parsedLocalValue);
+
+ function getSelectedOption() {
+ if (!localValue) return [];
+ const goodPick = timeShiftOptions.filter(({ value }) => value === localValue);
+ if (goodPick.length > 0) return goodPick;
+ return [
+ {
+ value: localValue,
+ label: localValue,
+ },
+ ];
+ }
+
+ return (
+ {
+ if (r && isFocused) {
+ const timeShiftInput = r.querySelector('[data-test-subj="comboBoxSearchInput"]');
+ if (!focusSetRef.current && timeShiftInput instanceof HTMLInputElement) {
+ focusSetRef.current = true;
+ timeShiftInput.focus();
+ }
+ }
+ }}
+ >
+
+
+
+ {
+ const parsedValue = parseTimeShift(value);
+ return (
+ parsedValue && !isValueTooSmall(parsedValue) && !isValueNotMultiple(parsedValue)
+ );
+ })}
+ selectedOptions={getSelectedOption()}
+ singleSelection={{ asPlainText: true }}
+ isInvalid={isLocalValueInvalid}
+ onCreateOption={(val) => {
+ const parsedVal = parseTimeShift(val);
+ if (parsedVal !== 'invalid') {
+ updateLayer(setTimeShift(columnId, layer, val));
+ } else {
+ setLocalValue(val);
+ }
+ }}
+ onChange={(choices) => {
+ if (choices.length === 0) {
+ updateLayer(setTimeShift(columnId, layer, ''));
+ setLocalValue('');
+ return;
+ }
+
+ const choice = choices[0].value as string;
+ const parsedVal = parseTimeShift(choice);
+ if (parsedVal !== 'invalid') {
+ updateLayer(setTimeShift(columnId, layer, choice));
+ } else {
+ setLocalValue(choice);
+ }
+ }}
+ />
+
+
+ {
+ updateLayer(setTimeShift(columnId, layer, undefined));
+ }}
+ iconType="cross"
+ />
+
+
+
+
+ );
+}
+
+export function getTimeShiftWarningMessages(
+ state: IndexPatternPrivateState,
+ { activeData }: FramePublicAPI
+) {
+ if (!state) return;
+ const warningMessages: React.ReactNode[] = [];
+ Object.entries(state.layers).forEach(([layerId, layer]) => {
+ let dateHistogramInterval: null | string = null;
+ const dateHistogramColumn = layer.columnOrder.find(
+ (colId) => layer.columns[colId].operationType === 'date_histogram'
+ );
+ if (!dateHistogramColumn) {
+ return;
+ }
+ if (dateHistogramColumn && activeData && activeData[layerId]) {
+ const column = activeData[layerId].columns.find((col) => col.id === dateHistogramColumn);
+ if (column) {
+ dateHistogramInterval =
+ search.aggs.getDateHistogramMetaDataByDatatableColumn(column)?.interval || null;
+ }
+ }
+ if (dateHistogramInterval === null) {
+ return;
+ }
+ const shiftInterval = search.aggs.parseInterval(dateHistogramInterval)!.asMilliseconds();
+ let timeShifts: number[] = [];
+ const timeShiftMap: Record = {};
+ Object.entries(layer.columns).forEach(([columnId, column]) => {
+ if (column.isBucketed) return;
+ let duration: number = 0;
+ if (column.timeShift) {
+ const parsedTimeShift = parseTimeShift(column.timeShift);
+ if (parsedTimeShift === 'previous' || parsedTimeShift === 'invalid') {
+ return;
+ }
+ duration = parsedTimeShift.asMilliseconds();
+ }
+ timeShifts.push(duration);
+ if (!timeShiftMap[duration]) {
+ timeShiftMap[duration] = [];
+ }
+ timeShiftMap[duration].push(columnId);
+ });
+ timeShifts = uniq(timeShifts);
+
+ if (timeShifts.length < 2) {
+ return;
+ }
+
+ timeShifts.forEach((timeShift) => {
+ if (timeShift === 0) return;
+ if (timeShift < shiftInterval) {
+ timeShiftMap[timeShift].forEach((columnId) => {
+ warningMessages.push(
+ {layer.columns[columnId].label},
+ interval: {dateHistogramInterval},
+ columnTimeShift: {layer.columns[columnId].timeShift},
+ }}
+ />
+ );
+ });
+ } else if (!Number.isInteger(timeShift / shiftInterval)) {
+ timeShiftMap[timeShift].forEach((columnId) => {
+ warningMessages.push(
+ {layer.columns[columnId].label},
+ interval: dateHistogramInterval,
+ columnTimeShift: layer.columns[columnId].timeShift!,
+ }}
+ />
+ );
+ });
+ }
+ });
+ });
+ return warningMessages;
+}
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts
index 81dff1da57809..64b0bdd7ca2a6 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts
@@ -7,7 +7,7 @@
import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
import { getIndexPatternDatasource, IndexPatternColumn } from './indexpattern';
-import { DatasourcePublicAPI, Operation, Datasource } from '../types';
+import { DatasourcePublicAPI, Operation, Datasource, FramePublicAPI } from '../types';
import { coreMock } from 'src/core/public/mocks';
import { IndexPatternPersistedState, IndexPatternPrivateState } from './types';
import { dataPluginMock } from '../../../../../src/plugins/data/public/mocks';
@@ -18,6 +18,7 @@ import { operationDefinitionMap, getErrorMessages } from './operations';
import { createMockedFullReference } from './operations/mocks';
import { indexPatternFieldEditorPluginMock } from 'src/plugins/index_pattern_field_editor/public/mocks';
import { uiActionsPluginMock } from '../../../../../src/plugins/ui_actions/public/mocks';
+import React from 'react';
jest.mock('./loader');
jest.mock('../id_generator');
@@ -500,6 +501,43 @@ describe('IndexPattern Data Source', () => {
expect(ast.chain[0].arguments.timeFields).toEqual(['timestamp', 'another_datefield']);
});
+ it('should pass time shift parameter to metric agg functions', async () => {
+ const queryBaseState: IndexPatternBaseState = {
+ currentIndexPatternId: '1',
+ layers: {
+ first: {
+ indexPatternId: '1',
+ columnOrder: ['col2', 'col1'],
+ columns: {
+ col1: {
+ label: 'Count of records',
+ dataType: 'number',
+ isBucketed: false,
+ sourceField: 'Records',
+ operationType: 'count',
+ timeShift: '1d',
+ },
+ col2: {
+ label: 'Date',
+ dataType: 'date',
+ isBucketed: true,
+ operationType: 'date_histogram',
+ sourceField: 'timestamp',
+ params: {
+ interval: 'auto',
+ },
+ },
+ },
+ },
+ },
+ };
+
+ const state = enrichBaseState(queryBaseState);
+
+ const ast = indexPatternDatasource.toExpression(state, 'first') as Ast;
+ expect((ast.chain[0].arguments.aggs[1] as Ast).chain[0].arguments.timeShift).toEqual(['1d']);
+ });
+
it('should wrap filtered metrics in filtered metric aggregation', async () => {
const queryBaseState: IndexPatternBaseState = {
currentIndexPatternId: '1',
@@ -1267,6 +1305,135 @@ describe('IndexPattern Data Source', () => {
});
});
+ describe('#getWarningMessages', () => {
+ it('should return mismatched time shifts', () => {
+ const state: IndexPatternPrivateState = {
+ indexPatternRefs: [],
+ existingFields: {},
+ isFirstExistenceFetch: false,
+ indexPatterns: expectedIndexPatterns,
+ layers: {
+ first: {
+ indexPatternId: '1',
+ columnOrder: ['col1', 'col2', 'col3', 'col4', 'col5', 'col6'],
+ columns: {
+ col1: {
+ operationType: 'date_histogram',
+ params: {
+ interval: '12h',
+ },
+ label: '',
+ dataType: 'date',
+ isBucketed: true,
+ sourceField: 'timestamp',
+ },
+ col2: {
+ operationType: 'count',
+ label: '',
+ dataType: 'number',
+ isBucketed: false,
+ sourceField: 'records',
+ },
+ col3: {
+ operationType: 'count',
+ timeShift: '1h',
+ label: '',
+ dataType: 'number',
+ isBucketed: false,
+ sourceField: 'records',
+ },
+ col4: {
+ operationType: 'count',
+ timeShift: '13h',
+ label: '',
+ dataType: 'number',
+ isBucketed: false,
+ sourceField: 'records',
+ },
+ col5: {
+ operationType: 'count',
+ timeShift: '1w',
+ label: '',
+ dataType: 'number',
+ isBucketed: false,
+ sourceField: 'records',
+ },
+ col6: {
+ operationType: 'count',
+ timeShift: 'previous',
+ label: '',
+ dataType: 'number',
+ isBucketed: false,
+ sourceField: 'records',
+ },
+ },
+ },
+ },
+ currentIndexPatternId: '1',
+ };
+ const warnings = indexPatternDatasource.getWarningMessages!(state, ({
+ activeData: {
+ first: {
+ type: 'datatable',
+ rows: [],
+ columns: [
+ {
+ id: 'col1',
+ name: 'col1',
+ meta: {
+ type: 'date',
+ source: 'esaggs',
+ sourceParams: {
+ type: 'date_histogram',
+ params: {
+ used_interval: '12h',
+ },
+ },
+ },
+ },
+ ],
+ },
+ },
+ } as unknown) as FramePublicAPI);
+ expect(warnings!.length).toBe(2);
+ expect((warnings![0] as React.ReactElement).props.id).toEqual(
+ 'xpack.lens.indexPattern.timeShiftSmallWarning'
+ );
+ expect((warnings![1] as React.ReactElement).props.id).toEqual(
+ 'xpack.lens.indexPattern.timeShiftMultipleWarning'
+ );
+ });
+
+ it('should prepend each error with its layer number on multi-layer chart', () => {
+ (getErrorMessages as jest.Mock).mockClear();
+ (getErrorMessages as jest.Mock).mockReturnValueOnce(['error 1', 'error 2']);
+ const state: IndexPatternPrivateState = {
+ indexPatternRefs: [],
+ existingFields: {},
+ isFirstExistenceFetch: false,
+ indexPatterns: expectedIndexPatterns,
+ layers: {
+ first: {
+ indexPatternId: '1',
+ columnOrder: [],
+ columns: {},
+ },
+ second: {
+ indexPatternId: '1',
+ columnOrder: [],
+ columns: {},
+ },
+ },
+ currentIndexPatternId: '1',
+ };
+ expect(indexPatternDatasource.getErrorMessages(state)).toEqual([
+ { longMessage: 'Layer 1 error: error 1', shortMessage: '' },
+ { longMessage: 'Layer 1 error: error 2', shortMessage: '' },
+ ]);
+ expect(getErrorMessages).toHaveBeenCalledTimes(2);
+ });
+ });
+
describe('#updateStateOnCloseDimension', () => {
it('should not update when there are no incomplete columns', () => {
expect(
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx
index 8b60cf134fe6f..7cb49de15c066 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx
@@ -55,6 +55,7 @@ import { deleteColumn, isReferenced } from './operations';
import { UiActionsStart } from '../../../../../src/plugins/ui_actions/public';
import { GeoFieldWorkspacePanel } from '../editor_frame_service/editor_frame/workspace_panel/geo_field_workspace_panel';
import { DraggingIdentifier } from '../drag_drop';
+import { getTimeShiftWarningMessages } from './dimension_panel/time_shift';
export { OperationType, IndexPatternColumn, deleteColumn } from './operations';
@@ -407,13 +408,20 @@ export function getIndexPatternDatasource({
}
// Forward the indexpattern as well, as it is required by some operationType checks
- const layerErrors = Object.values(state.layers).map((layer) =>
- (getErrorMessages(layer, state.indexPatterns[layer.indexPatternId]) ?? []).map(
- (message) => ({
- shortMessage: '', // Not displayed currently
- longMessage: message,
- })
- )
+ const layerErrors = Object.entries(state.layers).map(([layerId, layer]) =>
+ (
+ getErrorMessages(
+ layer,
+ state.indexPatterns[layer.indexPatternId],
+ state,
+ layerId,
+ core
+ ) ?? []
+ ).map((message) => ({
+ shortMessage: '', // Not displayed currently
+ longMessage: typeof message === 'string' ? message : message.message,
+ fixAction: typeof message === 'object' ? message.fixAction : undefined,
+ }))
);
// Single layer case, no need to explain more
@@ -449,6 +457,7 @@ export function getIndexPatternDatasource({
});
return messages.length ? messages : undefined;
},
+ getWarningMessages: getTimeShiftWarningMessages,
checkIntegrity: (state) => {
const ids = Object.values(state.layers || {}).map(({ indexPatternId }) => indexPatternId);
return ids.filter((id) => !state.indexPatterns[id]);
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx
index fc9504f003198..823ec3eb58a92 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx
@@ -70,7 +70,8 @@ export const counterRateOperation: OperationDefinition<
ref && 'sourceField' in ref
? indexPattern.getFieldByName(ref.sourceField)?.displayName
: undefined,
- column.timeScale
+ column.timeScale,
+ column.timeShift
);
},
toExpression: (layer, columnId) => {
@@ -84,7 +85,8 @@ export const counterRateOperation: OperationDefinition<
metric && 'sourceField' in metric
? indexPattern.getFieldByName(metric.sourceField)?.displayName
: undefined,
- timeScale
+ timeScale,
+ previousColumn?.timeShift
),
dataType: 'number',
operationType: 'counter_rate',
@@ -92,6 +94,7 @@ export const counterRateOperation: OperationDefinition<
scale: 'ratio',
references: referenceIds,
timeScale,
+ timeShift: previousColumn?.timeShift,
filter: getFilter(previousColumn, columnParams),
params: getFormatFromPreviousColumn(previousColumn),
};
@@ -118,4 +121,5 @@ export const counterRateOperation: OperationDefinition<
},
timeScalingMode: 'mandatory',
filterable: true,
+ shiftable: true,
};
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx
index 2adb9a1376f60..c4f01e27be886 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx
@@ -13,11 +13,12 @@ import {
getErrorsForDateReference,
dateBasedOperationToExpression,
hasDateField,
+ buildLabelFunction,
} from './utils';
import { OperationDefinition } from '..';
import { getFormatFromPreviousColumn, getFilter } from '../helpers';
-const ofName = (name?: string) => {
+const ofName = buildLabelFunction((name?: string) => {
return i18n.translate('xpack.lens.indexPattern.cumulativeSumOf', {
defaultMessage: 'Cumulative sum of {name}',
values: {
@@ -28,7 +29,7 @@ const ofName = (name?: string) => {
}),
},
});
-};
+});
export type CumulativeSumIndexPatternColumn = FormattedIndexPatternColumn &
ReferenceBasedIndexPatternColumn & {
@@ -67,7 +68,9 @@ export const cumulativeSumOperation: OperationDefinition<
return ofName(
ref && 'sourceField' in ref
? indexPattern.getFieldByName(ref.sourceField)?.displayName
- : undefined
+ : undefined,
+ undefined,
+ column.timeShift
);
},
toExpression: (layer, columnId) => {
@@ -79,12 +82,15 @@ export const cumulativeSumOperation: OperationDefinition<
label: ofName(
ref && 'sourceField' in ref
? indexPattern.getFieldByName(ref.sourceField)?.displayName
- : undefined
+ : undefined,
+ undefined,
+ previousColumn?.timeShift
),
dataType: 'number',
operationType: 'cumulative_sum',
isBucketed: false,
scale: 'ratio',
+ timeShift: previousColumn?.timeShift,
filter: getFilter(previousColumn, columnParams),
references: referenceIds,
params: getFormatFromPreviousColumn(previousColumn),
@@ -111,4 +117,5 @@ export const cumulativeSumOperation: OperationDefinition<
)?.join(', ');
},
filterable: true,
+ shiftable: true,
};
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx
index 06555a9b41c2f..7c48b5742b8db 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx
@@ -66,7 +66,7 @@ export const derivativeOperation: OperationDefinition<
}
},
getDefaultLabel: (column, indexPattern, columns) => {
- return ofName(columns[column.references[0]]?.label, column.timeScale);
+ return ofName(columns[column.references[0]]?.label, column.timeScale, column.timeShift);
},
toExpression: (layer, columnId) => {
return dateBasedOperationToExpression(layer, columnId, 'derivative');
@@ -74,7 +74,7 @@ export const derivativeOperation: OperationDefinition<
buildColumn: ({ referenceIds, previousColumn, layer }, columnParams) => {
const ref = layer.columns[referenceIds[0]];
return {
- label: ofName(ref?.label, previousColumn?.timeScale),
+ label: ofName(ref?.label, previousColumn?.timeScale, previousColumn?.timeShift),
dataType: 'number',
operationType: OPERATION_NAME,
isBucketed: false,
@@ -82,6 +82,7 @@ export const derivativeOperation: OperationDefinition<
references: referenceIds,
timeScale: previousColumn?.timeScale,
filter: getFilter(previousColumn, columnParams),
+ timeShift: previousColumn?.timeShift,
params: getFormatFromPreviousColumn(previousColumn),
};
},
@@ -108,4 +109,5 @@ export const derivativeOperation: OperationDefinition<
},
timeScalingMode: 'optional',
filterable: true,
+ shiftable: true,
};
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx
index 0e74ef6b85c80..a3d0241d4887e 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx
@@ -76,7 +76,7 @@ export const movingAverageOperation: OperationDefinition<
}
},
getDefaultLabel: (column, indexPattern, columns) => {
- return ofName(columns[column.references[0]]?.label, column.timeScale);
+ return ofName(columns[column.references[0]]?.label, column.timeScale, column.timeShift);
},
toExpression: (layer, columnId) => {
return dateBasedOperationToExpression(layer, columnId, 'moving_average', {
@@ -90,7 +90,7 @@ export const movingAverageOperation: OperationDefinition<
const metric = layer.columns[referenceIds[0]];
const { window = WINDOW_DEFAULT_VALUE } = columnParams;
return {
- label: ofName(metric?.label, previousColumn?.timeScale),
+ label: ofName(metric?.label, previousColumn?.timeScale, previousColumn?.timeShift),
dataType: 'number',
operationType: 'moving_average',
isBucketed: false,
@@ -98,6 +98,7 @@ export const movingAverageOperation: OperationDefinition<
references: referenceIds,
timeScale: previousColumn?.timeScale,
filter: getFilter(previousColumn, columnParams),
+ timeShift: previousColumn?.timeShift,
params: {
window,
...getFormatFromPreviousColumn(previousColumn),
@@ -129,6 +130,7 @@ export const movingAverageOperation: OperationDefinition<
},
timeScalingMode: 'optional',
filterable: true,
+ shiftable: true,
};
function MovingAverageParamEditor({
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/utils.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/utils.ts
index 59dbf74c11480..1f4f097c6a7fb 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/utils.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/utils.ts
@@ -16,10 +16,11 @@ import { operationDefinitionMap } from '..';
export const buildLabelFunction = (ofName: (name?: string) => string) => (
name?: string,
- timeScale?: TimeScaleUnit
+ timeScale?: TimeScaleUnit,
+ timeShift?: string
) => {
const rawLabel = ofName(name);
- return adjustTimeScaleLabelSuffix(rawLabel, undefined, timeScale);
+ return adjustTimeScaleLabelSuffix(rawLabel, undefined, timeScale, undefined, timeShift);
};
/**
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx
index e77357a6f441a..1911af0a6f679 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx
@@ -17,6 +17,7 @@ import {
getSafeName,
getFilter,
} from './helpers';
+import { adjustTimeScaleLabelSuffix } from '../time_scale_utils';
const supportedTypes = new Set([
'string',
@@ -33,13 +34,19 @@ const SCALE = 'ratio';
const OPERATION_TYPE = 'unique_count';
const IS_BUCKETED = false;
-function ofName(name: string) {
- return i18n.translate('xpack.lens.indexPattern.cardinalityOf', {
- defaultMessage: 'Unique count of {name}',
- values: {
- name,
- },
- });
+function ofName(name: string, timeShift: string | undefined) {
+ return adjustTimeScaleLabelSuffix(
+ i18n.translate('xpack.lens.indexPattern.cardinalityOf', {
+ defaultMessage: 'Unique count of {name}',
+ values: {
+ name,
+ },
+ }),
+ undefined,
+ undefined,
+ undefined,
+ timeShift
+ );
}
export interface CardinalityIndexPatternColumn
@@ -76,21 +83,19 @@ export const cardinalityOperation: OperationDefinition ofName(getSafeName(column.sourceField, indexPattern)),
+ shiftable: true,
+ getDefaultLabel: (column, indexPattern) =>
+ ofName(getSafeName(column.sourceField, indexPattern), column.timeShift),
buildColumn({ field, previousColumn }, columnParams) {
return {
- label: ofName(field.displayName),
+ label: ofName(field.displayName, previousColumn?.timeShift),
dataType: 'number',
operationType: OPERATION_TYPE,
scale: SCALE,
sourceField: field.name,
isBucketed: IS_BUCKETED,
filter: getFilter(previousColumn, columnParams),
+ timeShift: previousColumn?.timeShift,
params: getFormatFromPreviousColumn(previousColumn),
};
},
@@ -100,12 +105,14 @@ export const cardinalityOperation: OperationDefinition {
return {
...oldColumn,
- label: ofName(field.displayName),
+ label: ofName(field.displayName, oldColumn.timeShift),
sourceField: field.name,
};
},
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts
index aa6b8675333c5..ae606a5851665 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts
@@ -16,6 +16,7 @@ export interface BaseIndexPatternColumn extends Operation {
customLabel?: boolean;
timeScale?: TimeScaleUnit;
filter?: Query;
+ timeShift?: string;
}
// Formatting can optionally be added to any column
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx
index fd474ea04a165..7bf463a2095ad 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx
@@ -38,7 +38,13 @@ export const countOperation: OperationDefinition {
return {
...oldColumn,
- label: adjustTimeScaleLabelSuffix(field.displayName, undefined, oldColumn.timeScale),
+ label: adjustTimeScaleLabelSuffix(
+ field.displayName,
+ undefined,
+ oldColumn.timeScale,
+ undefined,
+ oldColumn.timeShift
+ ),
sourceField: field.name,
};
},
@@ -51,10 +57,23 @@ export const countOperation: OperationDefinition adjustTimeScaleLabelSuffix(countLabel, undefined, column.timeScale),
+ getDefaultLabel: (column) =>
+ adjustTimeScaleLabelSuffix(
+ countLabel,
+ undefined,
+ column.timeScale,
+ undefined,
+ column.timeShift
+ ),
buildColumn({ field, previousColumn }, columnParams) {
return {
- label: adjustTimeScaleLabelSuffix(countLabel, undefined, previousColumn?.timeScale),
+ label: adjustTimeScaleLabelSuffix(
+ countLabel,
+ undefined,
+ previousColumn?.timeScale,
+ undefined,
+ previousColumn?.timeShift
+ ),
dataType: 'number',
operationType: 'count',
isBucketed: false,
@@ -62,6 +81,7 @@ export const countOperation: OperationDefinition {
@@ -89,4 +111,5 @@ export const countOperation: OperationDefinition col.timeShift && col.timeShift !== ''
+ );
+ if (!usesTimeShift) {
+ return undefined;
+ }
+ const dateHistograms = layer.columnOrder.filter(
+ (colId) => layer.columns[colId].operationType === 'date_histogram'
+ );
+ if (dateHistograms.length < 2) {
+ return undefined;
+ }
+ return i18n.translate('xpack.lens.indexPattern.multipleDateHistogramsError', {
+ defaultMessage:
+ '"{dimensionLabel}" is not the only date histogram. When using time shifts, make sure to only use one date histogram.',
+ values: {
+ dimensionLabel: layer.columns[columnId].label,
+ },
+ });
+}
+
export const dateHistogramOperation: OperationDefinition<
DateHistogramIndexPatternColumn,
'field'
@@ -60,7 +83,13 @@ export const dateHistogramOperation: OperationDefinition<
priority: 5, // Highest priority level used
operationParams: [{ name: 'interval', type: 'string', required: false }],
getErrorMessage: (layer, columnId, indexPattern) =>
- getInvalidFieldMessage(layer.columns[columnId] as FieldBasedIndexPatternColumn, indexPattern),
+ [
+ ...(getInvalidFieldMessage(
+ layer.columns[columnId] as FieldBasedIndexPatternColumn,
+ indexPattern
+ ) || []),
+ getMultipleDateHistogramsErrorMessage(layer, columnId) || '',
+ ].filter(Boolean),
getHelpMessage: (props) => ,
getPossibleOperationForField: ({ aggregationRestrictions, aggregatable, type }) => {
if (
@@ -150,7 +179,15 @@ export const dateHistogramOperation: OperationDefinition<
extended_bounds: JSON.stringify({}),
}).toAst();
},
- paramEditor: ({ layer, columnId, currentColumn, updateLayer, dateRange, data, indexPattern }) => {
+ paramEditor: function ParamEditor({
+ layer,
+ columnId,
+ currentColumn,
+ updateLayer,
+ dateRange,
+ data,
+ indexPattern,
+ }: ParamEditorProps) {
const field = currentColumn && indexPattern.getFieldByName(currentColumn.sourceField);
const intervalIsRestricted =
field!.aggregationRestrictions && field!.aggregationRestrictions.date_histogram;
@@ -225,10 +262,11 @@ export const dateHistogramOperation: OperationDefinition<
disabled={calendarOnlyIntervals.has(interval.unit)}
isInvalid={!isValid}
onChange={(e) => {
- setInterval({
+ const newInterval = {
...interval,
value: e.target.value,
- });
+ };
+ setInterval(newInterval);
}}
/>
@@ -238,10 +276,11 @@ export const dateHistogramOperation: OperationDefinition<
data-test-subj="lensDateHistogramUnit"
value={interval.unit}
onChange={(e) => {
- setInterval({
+ const newInterval = {
...interval,
unit: e.target.value,
- });
+ };
+ setInterval(newInterval);
}}
isInvalid={!isValid}
options={[
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts
index cbc83db7e5f37..164415c1a1f6f 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts
@@ -5,7 +5,7 @@
* 2.0.
*/
-import { IUiSettingsClient, SavedObjectsClientContract, HttpSetup } from 'kibana/public';
+import { IUiSettingsClient, SavedObjectsClientContract, HttpSetup, CoreStart } from 'kibana/public';
import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
import { termsOperation, TermsIndexPatternColumn } from './terms';
import { filtersOperation, FiltersIndexPatternColumn } from './filters';
@@ -42,13 +42,14 @@ import {
FormulaIndexPatternColumn,
} from './formula';
import { lastValueOperation, LastValueIndexPatternColumn } from './last_value';
-import { OperationMetadata } from '../../../types';
+import { FramePublicAPI, OperationMetadata } from '../../../types';
import type { BaseIndexPatternColumn, ReferenceBasedIndexPatternColumn } from './column_types';
import { IndexPattern, IndexPatternField, IndexPatternLayer } from '../../types';
import { DateRange } from '../../../../common';
import { ExpressionAstFunction } from '../../../../../../../src/plugins/expressions/public';
import { DataPublicPluginStart } from '../../../../../../../src/plugins/data/public';
import { RangeIndexPatternColumn, rangeOperation } from './ranges';
+import { IndexPatternDimensionEditorProps } from '../../dimension_panel';
/**
* A union type of all available column types. If a column is of an unknown type somewhere
@@ -160,6 +161,7 @@ export interface ParamEditorProps {
http: HttpSetup;
dateRange: DateRange;
data: DataPublicPluginStart;
+ activeData?: IndexPatternDimensionEditorProps['activeData'];
operationDefinitionMap: Record;
}
@@ -240,7 +242,22 @@ interface BaseOperationDefinitionProps {
columnId: string,
indexPattern: IndexPattern,
operationDefinitionMap?: Record
- ) => string[] | undefined;
+ ) =>
+ | Array<
+ | string
+ | {
+ message: string;
+ fixAction?: {
+ label: string;
+ newState: (
+ core: CoreStart,
+ frame: FramePublicAPI,
+ layerId: string
+ ) => Promise;
+ };
+ }
+ >
+ | undefined;
/*
* Flag whether this operation can be scaled by time unit if a date histogram is available.
@@ -255,6 +272,7 @@ interface BaseOperationDefinitionProps {
* autocomplete.
*/
filterable?: boolean;
+ shiftable?: boolean;
getHelpMessage?: (props: HelpProps) => React.ReactNode;
/*
@@ -366,12 +384,27 @@ interface FieldBasedOperationDefinition {
* - Requires a date histogram operation somewhere before it in order
* - Missing references
*/
- getErrorMessage: (
+ getErrorMessage?: (
layer: IndexPatternLayer,
columnId: string,
indexPattern: IndexPattern,
operationDefinitionMap?: Record
- ) => string[] | undefined;
+ ) =>
+ | Array<
+ | string
+ | {
+ message: string;
+ fixAction?: {
+ label: string;
+ newState: (
+ core: CoreStart,
+ frame: FramePublicAPI,
+ layerId: string
+ ) => Promise;
+ };
+ }
+ >
+ | undefined;
}
export interface RequiredReference {
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx
index 4632d262c441d..bde80accfbc67 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx
@@ -21,14 +21,21 @@ import {
getSafeName,
getFilter,
} from './helpers';
+import { adjustTimeScaleLabelSuffix } from '../time_scale_utils';
-function ofName(name: string) {
- return i18n.translate('xpack.lens.indexPattern.lastValueOf', {
- defaultMessage: 'Last value of {name}',
- values: {
- name,
- },
- });
+function ofName(name: string, timeShift: string | undefined) {
+ return adjustTimeScaleLabelSuffix(
+ i18n.translate('xpack.lens.indexPattern.lastValueOf', {
+ defaultMessage: 'Last value of {name}',
+ values: {
+ name,
+ },
+ }),
+ undefined,
+ undefined,
+ undefined,
+ timeShift
+ );
}
const supportedTypes = new Set(['string', 'boolean', 'number', 'ip']);
@@ -96,7 +103,8 @@ export const lastValueOperation: OperationDefinition ofName(getSafeName(column.sourceField, indexPattern)),
+ getDefaultLabel: (column, indexPattern) =>
+ ofName(getSafeName(column.sourceField, indexPattern), column.timeShift),
input: 'field',
onFieldChange: (oldColumn, field) => {
const newParams = { ...oldColumn.params };
@@ -107,7 +115,7 @@ export const lastValueOperation: OperationDefinition {
return buildExpressionFunction('aggTopHit', {
id: columnId,
@@ -184,6 +194,8 @@ export const lastValueOperation: OperationDefinition>({
}) {
const labelLookup = (name: string, column?: BaseIndexPatternColumn) => {
const label = ofName(name);
- if (!optionalTimeScaling) {
- return label;
- }
- return adjustTimeScaleLabelSuffix(label, undefined, column?.timeScale);
+ return adjustTimeScaleLabelSuffix(
+ label,
+ undefined,
+ optionalTimeScaling ? column?.timeScale : undefined,
+ undefined,
+ column?.timeShift
+ );
};
return {
@@ -104,6 +107,7 @@ function buildMetricOperation>({
scale: 'ratio',
timeScale: optionalTimeScaling ? previousColumn?.timeScale : undefined,
filter: getFilter(previousColumn, columnParams),
+ timeShift: previousColumn?.timeShift,
params: getFormatFromPreviousColumn(previousColumn),
} as T;
},
@@ -120,11 +124,14 @@ function buildMetricOperation>({
enabled: true,
schema: 'metric',
field: column.sourceField,
+ // time shift is added to wrapping aggFilteredMetric if filter is set
+ timeShift: column.filter ? undefined : column.timeShift,
}).toAst();
},
getErrorMessage: (layer, columnId, indexPattern) =>
getInvalidFieldMessage(layer.columns[columnId] as FieldBasedIndexPatternColumn, indexPattern),
filterable: true,
+ shiftable: true,
} as OperationDefinition;
}
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx
index 4c09ae4ed8c47..aa8f951d46b4f 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx
@@ -19,6 +19,7 @@ import {
getFilter,
} from './helpers';
import { FieldBasedIndexPatternColumn } from './column_types';
+import { adjustTimeScaleLabelSuffix } from '../time_scale_utils';
import { useDebounceWithOptions } from '../../../shared_components';
export interface PercentileIndexPatternColumn extends FieldBasedIndexPatternColumn {
@@ -34,12 +35,18 @@ export interface PercentileIndexPatternColumn extends FieldBasedIndexPatternColu
};
}
-function ofName(name: string, percentile: number) {
- return i18n.translate('xpack.lens.indexPattern.percentileOf', {
- defaultMessage:
- '{percentile, selectordinal, one {#st} two {#nd} few {#rd} other {#th}} percentile of {name}',
- values: { name, percentile },
- });
+function ofName(name: string, percentile: number, timeShift: string | undefined) {
+ return adjustTimeScaleLabelSuffix(
+ i18n.translate('xpack.lens.indexPattern.percentileOf', {
+ defaultMessage:
+ '{percentile, selectordinal, one {#st} two {#nd} few {#rd} other {#th}} percentile of {name}',
+ values: { name, percentile },
+ }),
+ undefined,
+ undefined,
+ undefined,
+ timeShift
+ );
}
const DEFAULT_PERCENTILE_VALUE = 95;
@@ -54,6 +61,7 @@ export const percentileOperation: OperationDefinition {
if (supportedFieldTypes.includes(fieldType) && aggregatable && !aggregationRestrictions) {
return {
@@ -74,7 +82,11 @@ export const percentileOperation: OperationDefinition
- ofName(getSafeName(column.sourceField, indexPattern), column.params.percentile),
+ ofName(
+ getSafeName(column.sourceField, indexPattern),
+ column.params.percentile,
+ column.timeShift
+ ),
buildColumn: ({ field, previousColumn, indexPattern }, columnParams) => {
const existingPercentileParam =
previousColumn?.operationType === 'percentile' &&
@@ -84,13 +96,18 @@ export const percentileOperation: OperationDefinition {
return {
...oldColumn,
- label: ofName(field.displayName, oldColumn.params.percentile),
+ label: ofName(field.displayName, oldColumn.params.percentile, oldColumn.timeShift),
sourceField: field.name,
};
},
@@ -113,6 +130,8 @@ export const percentileOperation: OperationDefinition operationDefinitionMap[col.operationType].shiftable)
+ .map((col) => col.timeShift || '')
+ ).length > 1;
+ if (!hasMultipleShifts) {
+ return undefined;
+ }
+ return {
+ message: i18n.translate('xpack.lens.indexPattern.termsWithMultipleShifts', {
+ defaultMessage:
+ 'In a single layer, you are unable to combine metrics with different time shifts and dynamic top values. Use the same time shift value for all metrics, or use filters instead of top values.',
+ }),
+ fixAction: {
+ label: i18n.translate('xpack.lens.indexPattern.termsWithMultipleShiftsFixActionLabel', {
+ defaultMessage: 'Use filters',
+ }),
+ newState: async (core: CoreStart, frame: FramePublicAPI, layerId: string) => {
+ const currentColumn = layer.columns[columnId] as TermsIndexPatternColumn;
+ const fieldName = currentColumn.sourceField;
+ const activeDataFieldNameMatch =
+ frame.activeData?.[layerId].columns.find(({ id }) => id === columnId)?.meta.field ===
+ fieldName;
+ let currentTerms = uniq(
+ frame.activeData?.[layerId].rows
+ .map((row) => row[columnId] as string)
+ .filter((term) => typeof term === 'string' && term !== '__other__') || []
+ );
+ if (!activeDataFieldNameMatch || currentTerms.length === 0) {
+ const response: FieldStatsResponse = await core.http.post(
+ `/api/lens/index_stats/${indexPattern.id}/field`,
+ {
+ body: JSON.stringify({
+ fieldName,
+ dslQuery: esQuery.buildEsQuery(
+ indexPattern as IIndexPattern,
+ frame.query,
+ frame.filters,
+ esQuery.getEsQueryConfig(core.uiSettings)
+ ),
+ fromDate: frame.dateRange.fromDate,
+ toDate: frame.dateRange.toDate,
+ size: currentColumn.params.size,
+ }),
+ }
+ );
+ currentTerms = response.topValues?.buckets.map(({ key }) => String(key)) || [];
+ }
+ return {
+ ...layer,
+ columns: {
+ ...layer.columns,
+ [columnId]: {
+ label: i18n.translate('xpack.lens.indexPattern.pinnedTopValuesLabel', {
+ defaultMessage: 'Filters of {field}',
+ values: {
+ field: fieldName,
+ },
+ }),
+ customLabel: true,
+ isBucketed: layer.columns[columnId].isBucketed,
+ dataType: 'string',
+ operationType: 'filters',
+ params: {
+ filters:
+ currentTerms.length > 0
+ ? currentTerms.map((term) => ({
+ input: {
+ query: `${fieldName}: "${term}"`,
+ language: 'kuery',
+ },
+ label: term,
+ }))
+ : [
+ {
+ input: {
+ query: '*',
+ language: 'kuery',
+ },
+ label: defaultLabel,
+ },
+ ],
+ },
+ } as FiltersIndexPatternColumn,
+ },
+ };
+ },
+ },
+ };
+}
+
const DEFAULT_SIZE = 3;
const supportedTypes = new Set(['string', 'boolean', 'number', 'ip']);
@@ -90,7 +195,13 @@ export const termsOperation: OperationDefinition
- getInvalidFieldMessage(layer.columns[columnId] as FieldBasedIndexPatternColumn, indexPattern),
+ [
+ ...(getInvalidFieldMessage(
+ layer.columns[columnId] as FieldBasedIndexPatternColumn,
+ indexPattern
+ ) || []),
+ getDisallowedTermsMessage(layer, columnId, indexPattern) || '',
+ ].filter(Boolean),
isTransferable: (column, newIndexPattern) => {
const newField = newIndexPattern.getFieldByName(column.sourceField);
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/terms.test.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/terms.test.tsx
index aab957c8ecebe..b272d1703377c 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/terms.test.tsx
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/terms.test.tsx
@@ -9,7 +9,12 @@ import React from 'react';
import { act } from 'react-dom/test-utils';
import { shallow, mount } from 'enzyme';
import { EuiFieldNumber, EuiSelect, EuiSwitch, EuiSwitchEvent } from '@elastic/eui';
-import type { IUiSettingsClient, SavedObjectsClientContract, HttpSetup } from 'kibana/public';
+import type {
+ IUiSettingsClient,
+ SavedObjectsClientContract,
+ HttpSetup,
+ CoreStart,
+} from 'kibana/public';
import type { IStorageWrapper } from 'src/plugins/kibana_utils/public';
import { dataPluginMock } from '../../../../../../../../src/plugins/data/public/mocks';
import { createMockedIndexPattern } from '../../../mocks';
@@ -17,6 +22,7 @@ import { ValuesInput } from './values_input';
import type { TermsIndexPatternColumn } from '.';
import { termsOperation } from '../index';
import { IndexPattern, IndexPatternLayer } from '../../../types';
+import { FramePublicAPI } from '../../../../types';
const uiSettingsMock = {} as IUiSettingsClient;
@@ -986,8 +992,8 @@ describe('terms', () => {
indexPatternId: '',
};
});
- it('returns undefined if sourceField exists in index pattern', () => {
- expect(termsOperation.getErrorMessage!(layer, 'col1', indexPattern)).toEqual(undefined);
+ it('returns empty array', () => {
+ expect(termsOperation.getErrorMessage!(layer, 'col1', indexPattern)).toEqual([]);
});
it('returns error message if the sourceField does not exist in index pattern', () => {
layer = {
@@ -1003,5 +1009,102 @@ describe('terms', () => {
'Field notExisting was not found',
]);
});
+
+ describe('time shift error', () => {
+ beforeEach(() => {
+ layer = {
+ ...layer,
+ columnOrder: ['col1', 'col2', 'col3'],
+ columns: {
+ ...layer.columns,
+ col2: {
+ dataType: 'number',
+ isBucketed: false,
+ operationType: 'count',
+ label: 'Count',
+ sourceField: 'document',
+ },
+ col3: {
+ dataType: 'number',
+ isBucketed: false,
+ operationType: 'count',
+ label: 'Count',
+ sourceField: 'document',
+ timeShift: '1d',
+ },
+ },
+ };
+ });
+ it('returns error message if two time shifts are used together with terms', () => {
+ expect(termsOperation.getErrorMessage!(layer, 'col1', indexPattern)).toEqual([
+ expect.objectContaining({
+ message:
+ 'In a single layer, you are unable to combine metrics with different time shifts and dynamic top values. Use the same time shift value for all metrics, or use filters instead of top values.',
+ }),
+ ]);
+ });
+ it('returns fix action which calls field information endpoint and creates a pinned top values', async () => {
+ const errorMessage = termsOperation.getErrorMessage!(layer, 'col1', indexPattern)![0];
+ const fixAction = (typeof errorMessage === 'object'
+ ? errorMessage.fixAction!.newState
+ : undefined)!;
+ const coreMock = ({
+ uiSettings: {
+ get: () => undefined,
+ },
+ http: {
+ post: jest.fn(() =>
+ Promise.resolve({
+ topValues: {
+ buckets: [
+ {
+ key: 'A',
+ },
+ {
+ key: 'B',
+ },
+ ],
+ },
+ })
+ ),
+ },
+ } as unknown) as CoreStart;
+ const newLayer = await fixAction(
+ coreMock,
+ ({
+ query: { language: 'kuery', query: 'a: b' },
+ filters: [],
+ dateRange: {
+ fromDate: '2020',
+ toDate: '2021',
+ },
+ } as unknown) as FramePublicAPI,
+ 'first'
+ );
+ expect(newLayer.columns.col1).toEqual(
+ expect.objectContaining({
+ operationType: 'filters',
+ params: {
+ filters: [
+ {
+ input: {
+ language: 'kuery',
+ query: 'bytes: "A"',
+ },
+ label: 'A',
+ },
+ {
+ input: {
+ language: 'kuery',
+ query: 'bytes: "B"',
+ },
+ label: 'B',
+ },
+ ],
+ },
+ })
+ );
+ });
+ });
});
});
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.test.ts
index 4dd56d2de1144..a53a6e00810b8 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.test.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.test.ts
@@ -2589,7 +2589,10 @@ describe('state_helpers', () => {
col1: { operationType: 'average' },
},
},
- indexPattern
+ indexPattern,
+ {},
+ '1',
+ {}
);
expect(mock).toHaveBeenCalled();
expect(errors).toHaveLength(1);
@@ -2608,7 +2611,10 @@ describe('state_helpers', () => {
{ operationType: 'testReference', references: [] },
},
},
- indexPattern
+ indexPattern,
+ {},
+ '1',
+ {}
);
expect(mock).toHaveBeenCalled();
expect(errors).toHaveLength(1);
@@ -2637,7 +2643,10 @@ describe('state_helpers', () => {
col1: { operationType: 'testIncompleteReference' },
},
},
- indexPattern
+ indexPattern,
+ {},
+ '1',
+ {}
);
expect(savedRef).toHaveBeenCalled();
expect(incompleteRef).not.toHaveBeenCalled();
@@ -2659,7 +2668,10 @@ describe('state_helpers', () => {
{ operationType: 'testReference', references: [] },
},
},
- indexPattern
+ indexPattern,
+ {},
+ '1',
+ {}
);
expect(mock).toHaveBeenCalledWith(
{
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts
index 92452a11e94c1..b42cdbd24e656 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts
@@ -6,8 +6,12 @@
*/
import { partition, mapValues, pickBy } from 'lodash';
-import { getSortScoreByPriority } from './operations';
-import type { OperationMetadata, VisualizationDimensionGroupConfig } from '../../types';
+import { CoreStart } from 'kibana/public';
+import type {
+ FramePublicAPI,
+ OperationMetadata,
+ VisualizationDimensionGroupConfig,
+} from '../../types';
import {
operationDefinitionMap,
operationDefinitions,
@@ -15,7 +19,13 @@ import {
IndexPatternColumn,
RequiredReference,
} from './definitions';
-import type { IndexPattern, IndexPatternField, IndexPatternLayer } from '../types';
+import type {
+ IndexPattern,
+ IndexPatternField,
+ IndexPatternLayer,
+ IndexPatternPrivateState,
+} from '../types';
+import { getSortScoreByPriority } from './operations';
import { generateId } from '../../id_generator';
import { ReferenceBasedIndexPatternColumn } from './definitions/column_types';
import { FormulaIndexPatternColumn, regenerateLayerFromAst } from './definitions/formula';
@@ -674,6 +684,7 @@ function applyReferenceTransition({
// drop the filter for the referenced column because the wrapping operation
// is filterable as well and will handle it one level higher.
filter: operationDefinition.filterable ? undefined : previousColumn.filter,
+ timeShift: operationDefinition.shiftable ? undefined : previousColumn.timeShift,
},
},
};
@@ -1135,20 +1146,65 @@ export function updateLayerIndexPattern(
* - All columns have complete references
* - All column references are valid
* - All prerequisites are met
+ * - If timeshift is used, terms go before date histogram
+ * - If timeshift is used, only a single date histogram can be used
*/
export function getErrorMessages(
layer: IndexPatternLayer,
- indexPattern: IndexPattern
-): string[] | undefined {
- const errors: string[] = Object.entries(layer.columns)
+ indexPattern: IndexPattern,
+ state: IndexPatternPrivateState,
+ layerId: string,
+ core: CoreStart
+):
+ | Array<
+ | string
+ | {
+ message: string;
+ fixAction?: {
+ label: string;
+ newState: (frame: FramePublicAPI) => Promise;
+ };
+ }
+ >
+ | undefined {
+ const errors = Object.entries(layer.columns)
.flatMap(([columnId, column]) => {
const def = operationDefinitionMap[column.operationType];
if (def.getErrorMessage) {
return def.getErrorMessage(layer, columnId, indexPattern, operationDefinitionMap);
}
})
+ .map((errorMessage) => {
+ if (typeof errorMessage !== 'object') {
+ return errorMessage;
+ }
+ return {
+ ...errorMessage,
+ fixAction: errorMessage.fixAction
+ ? {
+ ...errorMessage.fixAction,
+ newState: async (frame: FramePublicAPI) => ({
+ ...state,
+ layers: {
+ ...state.layers,
+ [layerId]: await errorMessage.fixAction!.newState(core, frame, layerId),
+ },
+ }),
+ }
+ : undefined,
+ };
+ })
// remove the undefined values
- .filter((v: string | undefined): v is string => v != null);
+ .filter((v) => v != null) as Array<
+ | string
+ | {
+ message: string;
+ fixAction?: {
+ label: string;
+ newState: (framePublicAPI: FramePublicAPI) => Promise;
+ };
+ }
+ >;
return errors.length ? errors : undefined;
}
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.test.ts
index d53940aa585fd..152fcaa457c3b 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.test.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.test.ts
@@ -15,29 +15,84 @@ export const DEFAULT_TIME_SCALE = 's' as TimeScaleUnit;
describe('time scale utils', () => {
describe('adjustTimeScaleLabelSuffix', () => {
it('should should remove existing suffix', () => {
- expect(adjustTimeScaleLabelSuffix('abc per second', 's', undefined)).toEqual('abc');
- expect(adjustTimeScaleLabelSuffix('abc per hour', 'h', undefined)).toEqual('abc');
+ expect(
+ adjustTimeScaleLabelSuffix('abc per second', 's', undefined, undefined, undefined)
+ ).toEqual('abc');
+ expect(
+ adjustTimeScaleLabelSuffix('abc per hour', 'h', undefined, undefined, undefined)
+ ).toEqual('abc');
+ expect(adjustTimeScaleLabelSuffix('abc -3d', undefined, undefined, '3d', undefined)).toEqual(
+ 'abc'
+ );
+ expect(
+ adjustTimeScaleLabelSuffix('abc per hour -3d', 'h', undefined, '3d', undefined)
+ ).toEqual('abc');
});
it('should add suffix', () => {
- expect(adjustTimeScaleLabelSuffix('abc', undefined, 's')).toEqual('abc per second');
- expect(adjustTimeScaleLabelSuffix('abc', undefined, 'd')).toEqual('abc per day');
+ expect(adjustTimeScaleLabelSuffix('abc', undefined, 's', undefined, undefined)).toEqual(
+ 'abc per second'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc', undefined, 'd', undefined, undefined)).toEqual(
+ 'abc per day'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc', undefined, undefined, undefined, '12h')).toEqual(
+ 'abc -12h'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc', undefined, 'h', undefined, '12h')).toEqual(
+ 'abc per hour -12h'
+ );
+ });
+
+ it('should add and remove at the same time', () => {
+ expect(adjustTimeScaleLabelSuffix('abc per hour', 'h', undefined, undefined, '1d')).toEqual(
+ 'abc -1d'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc -1d', undefined, 'h', '1d', undefined)).toEqual(
+ 'abc per hour'
+ );
});
it('should change suffix', () => {
- expect(adjustTimeScaleLabelSuffix('abc per second', 's', 'd')).toEqual('abc per day');
- expect(adjustTimeScaleLabelSuffix('abc per day', 'd', 's')).toEqual('abc per second');
+ expect(adjustTimeScaleLabelSuffix('abc per second', 's', 'd', undefined, undefined)).toEqual(
+ 'abc per day'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc per day', 'd', 's', undefined, undefined)).toEqual(
+ 'abc per second'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc per day -3h', 'd', 's', '3h', '3h')).toEqual(
+ 'abc per second -3h'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc per day -3h', 'd', 'd', '3h', '4h')).toEqual(
+ 'abc per day -4h'
+ );
});
it('should keep current state', () => {
- expect(adjustTimeScaleLabelSuffix('abc', undefined, undefined)).toEqual('abc');
- expect(adjustTimeScaleLabelSuffix('abc per day', 'd', 'd')).toEqual('abc per day');
+ expect(adjustTimeScaleLabelSuffix('abc', undefined, undefined, undefined, undefined)).toEqual(
+ 'abc'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc per day', 'd', 'd', undefined, undefined)).toEqual(
+ 'abc per day'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc -1h', undefined, undefined, '1h', '1h')).toEqual(
+ 'abc -1h'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc per day -1h', 'd', 'd', '1h', '1h')).toEqual(
+ 'abc per day -1h'
+ );
});
it('should not fail on inconsistent input', () => {
- expect(adjustTimeScaleLabelSuffix('abc', 's', undefined)).toEqual('abc');
- expect(adjustTimeScaleLabelSuffix('abc', 's', 'd')).toEqual('abc per day');
- expect(adjustTimeScaleLabelSuffix('abc per day', 's', undefined)).toEqual('abc per day');
+ expect(adjustTimeScaleLabelSuffix('abc', 's', undefined, undefined, undefined)).toEqual(
+ 'abc'
+ );
+ expect(adjustTimeScaleLabelSuffix('abc', 's', 'd', undefined, undefined)).toEqual(
+ 'abc per day'
+ );
+ expect(
+ adjustTimeScaleLabelSuffix('abc per day', 's', undefined, undefined, undefined)
+ ).toEqual('abc per day');
});
});
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.ts
index 07806a32665dd..a0b61060b9f3a 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.ts
@@ -12,24 +12,36 @@ import type { IndexPatternColumn } from './definitions';
export const DEFAULT_TIME_SCALE = 's' as TimeScaleUnit;
+function getSuffix(scale: TimeScaleUnit | undefined, shift: string | undefined) {
+ return (
+ (shift || scale ? ' ' : '') +
+ (scale ? unitSuffixesLong[scale] : '') +
+ (shift && scale ? ' ' : '') +
+ (shift ? `-${shift}` : '')
+ );
+}
+
export function adjustTimeScaleLabelSuffix(
oldLabel: string,
previousTimeScale: TimeScaleUnit | undefined,
- newTimeScale: TimeScaleUnit | undefined
+ newTimeScale: TimeScaleUnit | undefined,
+ previousShift: string | undefined,
+ newShift: string | undefined
) {
let cleanedLabel = oldLabel;
// remove added suffix if column had a time scale previously
- if (previousTimeScale) {
- const suffixPosition = oldLabel.lastIndexOf(` ${unitSuffixesLong[previousTimeScale]}`);
+ if (previousTimeScale || previousShift) {
+ const suffix = getSuffix(previousTimeScale, previousShift);
+ const suffixPosition = oldLabel.lastIndexOf(suffix);
if (suffixPosition !== -1) {
cleanedLabel = oldLabel.substring(0, suffixPosition);
}
}
- if (!newTimeScale) {
+ if (!newTimeScale && !newShift) {
return cleanedLabel;
}
// add new suffix if column has a time scale now
- return `${cleanedLabel} ${unitSuffixesLong[newTimeScale]}`;
+ return `${cleanedLabel}${getSuffix(newTimeScale, newShift)}`;
}
export function adjustTimeScaleOnOtherColumnChange(
@@ -54,6 +66,12 @@ export function adjustTimeScaleOnOtherColumnChange
return {
...column,
timeScale: undefined,
- label: adjustTimeScaleLabelSuffix(column.label, column.timeScale, undefined),
+ label: adjustTimeScaleLabelSuffix(
+ column.label,
+ column.timeScale,
+ undefined,
+ column.timeShift,
+ column.timeShift
+ ),
};
}
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts b/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts
index 430e139a85cca..49bec5f58c29c 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts
@@ -54,6 +54,22 @@ function getExpressionForLayer(
}
});
}
+
+ if (
+ 'references' in column &&
+ rootDef.shiftable &&
+ rootDef.input === 'fullReference' &&
+ column.timeShift
+ ) {
+ // inherit time shift to all referenced operations
+ column.references.forEach((referenceColumnId) => {
+ const referencedColumn = columns[referenceColumnId];
+ const referenceDef = operationDefinitionMap[column.operationType];
+ if (referenceDef.shiftable) {
+ columns[referenceColumnId] = { ...referencedColumn, timeShift: column.timeShift };
+ }
+ });
+ }
});
const columnEntries = columnOrder.map((colId) => [colId, columns[colId]] as const);
@@ -106,6 +122,7 @@ function getExpressionForLayer(
}),
]),
customMetric: buildExpression({ type: 'expression', chain: [aggAst] }),
+ timeShift: col.timeShift,
}
).toAst();
}
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/utils.ts b/x-pack/plugins/lens/public/indexpattern_datasource/utils.ts
index 23c7adb86d34f..a9e24c70ab8ac 100644
--- a/x-pack/plugins/lens/public/indexpattern_datasource/utils.ts
+++ b/x-pack/plugins/lens/public/indexpattern_datasource/utils.ts
@@ -61,14 +61,14 @@ export function isColumnInvalid(
'references' in column &&
Boolean(getReferencesErrors(layer, column, indexPattern).filter(Boolean).length);
- return (
- !!operationDefinition.getErrorMessage?.(
- layer,
- columnId,
- indexPattern,
- operationDefinitionMap
- ) || referencesHaveErrors
+ const operationErrorMessages = operationDefinition.getErrorMessage?.(
+ layer,
+ columnId,
+ indexPattern,
+ operationDefinitionMap
);
+
+ return (operationErrorMessages && operationErrorMessages.length > 0) || referencesHaveErrors;
}
function getReferencesErrors(
diff --git a/x-pack/plugins/lens/public/types.ts b/x-pack/plugins/lens/public/types.ts
index 984fbf5555949..854466956ceed 100644
--- a/x-pack/plugins/lens/public/types.ts
+++ b/x-pack/plugins/lens/public/types.ts
@@ -224,8 +224,18 @@ export interface Datasource {
getPublicAPI: (props: PublicAPIProps) => DatasourcePublicAPI;
getErrorMessages: (
state: T,
- layersGroups?: Record
- ) => Array<{ shortMessage: string; longMessage: string }> | undefined;
+ layersGroups?: Record,
+ dateRange?: {
+ fromDate: string;
+ toDate: string;
+ }
+ ) =>
+ | Array<{
+ shortMessage: string;
+ longMessage: string;
+ fixAction?: { label: string; newState: () => Promise };
+ }>
+ | undefined;
/**
* uniqueLabels of dimensions exposed for aria-labels of dragged dimensions
*/
@@ -234,6 +244,10 @@ export interface Datasource {
* Check the internal state integrity and returns a list of missing references
*/
checkIntegrity: (state: T) => string[];
+ /**
+ * The frame calls this function to display warnings about visualization
+ */
+ getWarningMessages?: (state: T, frame: FramePublicAPI) => React.ReactNode[] | undefined;
}
/**
@@ -673,7 +687,12 @@ export interface Visualization {
getErrorMessages: (
state: T,
datasourceLayers?: Record
- ) => Array<{ shortMessage: string; longMessage: string }> | undefined;
+ ) =>
+ | Array<{
+ shortMessage: string;
+ longMessage: string;
+ }>
+ | undefined;
/**
* The frame calls this function to display warnings about visualization
diff --git a/x-pack/plugins/lens/server/routes/field_stats.ts b/x-pack/plugins/lens/server/routes/field_stats.ts
index 6cddd2c60f416..6b7e197a4d561 100644
--- a/x-pack/plugins/lens/server/routes/field_stats.ts
+++ b/x-pack/plugins/lens/server/routes/field_stats.ts
@@ -31,6 +31,7 @@ export async function initFieldsRoute(setup: CoreSetup) {
fromDate: schema.string(),
toDate: schema.string(),
fieldName: schema.string(),
+ size: schema.maybe(schema.number()),
},
{ unknowns: 'allow' }
),
@@ -38,7 +39,7 @@ export async function initFieldsRoute(setup: CoreSetup) {
},
async (context, req, res) => {
const requestClient = context.core.elasticsearch.client.asCurrentUser;
- const { fromDate, toDate, fieldName, dslQuery } = req.body;
+ const { fromDate, toDate, fieldName, dslQuery, size } = req.body;
const [{ savedObjects, elasticsearch }, { data }] = await setup.getStartServices();
const savedObjectsClient = savedObjects.getScopedClient(req);
@@ -112,7 +113,7 @@ export async function initFieldsRoute(setup: CoreSetup) {
}
return res.ok({
- body: await getStringSamples(search, field),
+ body: await getStringSamples(search, field, size),
});
} catch (e) {
if (e instanceof SavedObjectNotFound) {
@@ -245,7 +246,8 @@ export async function getNumberHistogram(
export async function getStringSamples(
aggSearchWithBody: (aggs: Record) => unknown,
- field: IFieldType
+ field: IFieldType,
+ size = 10
): Promise {
const fieldRef = getFieldRef(field);
@@ -257,7 +259,7 @@ export async function getStringSamples(
top_values: {
terms: {
...fieldRef,
- size: 10,
+ size,
},
},
},
diff --git a/x-pack/test/functional/apps/lens/index.ts b/x-pack/test/functional/apps/lens/index.ts
index d0466b8814fec..bff0b590a8e68 100644
--- a/x-pack/test/functional/apps/lens/index.ts
+++ b/x-pack/test/functional/apps/lens/index.ts
@@ -36,6 +36,7 @@ export default function ({ getService, loadTestFile }: FtrProviderContext) {
loadTestFile(require.resolve('./persistent_context'));
loadTestFile(require.resolve('./colors'));
loadTestFile(require.resolve('./chart_data'));
+ loadTestFile(require.resolve('./time_shift'));
loadTestFile(require.resolve('./drag_and_drop'));
loadTestFile(require.resolve('./geo_field'));
loadTestFile(require.resolve('./lens_reporting'));
diff --git a/x-pack/test/functional/apps/lens/time_shift.ts b/x-pack/test/functional/apps/lens/time_shift.ts
new file mode 100644
index 0000000000000..57c2fc194d0c0
--- /dev/null
+++ b/x-pack/test/functional/apps/lens/time_shift.ts
@@ -0,0 +1,68 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import expect from '@kbn/expect';
+import { FtrProviderContext } from '../../ftr_provider_context';
+
+export default function ({ getService, getPageObjects }: FtrProviderContext) {
+ const PageObjects = getPageObjects(['visualize', 'lens', 'common', 'header']);
+
+ describe('time shift', () => {
+ it('should able to configure a shifted metric', async () => {
+ await PageObjects.visualize.navigateToNewVisualization();
+ await PageObjects.visualize.clickVisType('lens');
+ await PageObjects.lens.goToTimeRange();
+ await PageObjects.lens.switchToVisualization('lnsDatatable');
+ await PageObjects.lens.configureDimension({
+ dimension: 'lnsDatatable_rows > lns-empty-dimension',
+ operation: 'date_histogram',
+ field: '@timestamp',
+ });
+ await PageObjects.lens.configureDimension({
+ dimension: 'lnsDatatable_metrics > lns-empty-dimension',
+ operation: 'median',
+ field: 'bytes',
+ });
+ await PageObjects.lens.openDimensionEditor('lnsDatatable_metrics > lns-dimensionTrigger');
+ await PageObjects.lens.enableTimeShift();
+ await PageObjects.lens.setTimeShift('6h');
+
+ await PageObjects.lens.waitForVisualization();
+ expect(await PageObjects.lens.getDatatableCellText(0, 1)).to.eql('5,994');
+ });
+
+ it('should able to configure a regular metric next to a shifted metric', async () => {
+ await PageObjects.lens.closeDimensionEditor();
+ await PageObjects.lens.configureDimension({
+ dimension: 'lnsDatatable_metrics > lns-empty-dimension',
+ operation: 'average',
+ field: 'bytes',
+ });
+
+ await PageObjects.lens.waitForVisualization();
+
+ expect(await PageObjects.lens.getDatatableCellText(2, 1)).to.eql('5,994');
+ expect(await PageObjects.lens.getDatatableCellText(2, 2)).to.eql('5,722.622');
+ });
+
+ it('should show an error if terms is used and provide a fix action', async () => {
+ await PageObjects.lens.configureDimension({
+ dimension: 'lnsDatatable_rows > lns-empty-dimension',
+ operation: 'terms',
+ field: 'ip',
+ });
+
+ expect(await PageObjects.lens.hasFixAction()).to.be(true);
+ await PageObjects.lens.useFixAction();
+
+ expect(await PageObjects.lens.getDatatableCellText(2, 2)).to.eql('5,541.5');
+ expect(await PageObjects.lens.getDatatableCellText(2, 3)).to.eql('3,628');
+
+ expect(await PageObjects.lens.getDatatableHeaderText(0)).to.eql('Filters of ip');
+ });
+ });
+}
diff --git a/x-pack/test/functional/page_objects/lens_page.ts b/x-pack/test/functional/page_objects/lens_page.ts
index b16944cd73060..0b88ecca247c5 100644
--- a/x-pack/test/functional/page_objects/lens_page.ts
+++ b/x-pack/test/functional/page_objects/lens_page.ts
@@ -362,6 +362,25 @@ export function LensPageProvider({ getService, getPageObjects }: FtrProviderCont
});
},
+ async enableTimeShift() {
+ await testSubjects.click('indexPattern-advanced-popover');
+ await retry.try(async () => {
+ await testSubjects.click('indexPattern-time-shift-enable');
+ });
+ },
+
+ async setTimeShift(shift: string) {
+ await comboBox.setCustom('indexPattern-dimension-time-shift', shift);
+ },
+
+ async hasFixAction() {
+ return await testSubjects.exists('errorFixAction');
+ },
+
+ async useFixAction() {
+ await testSubjects.click('errorFixAction');
+ },
+
// closes the dimension editor flyout
async closeDimensionEditor() {
await retry.try(async () => {