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..38bc84ae9af35 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
@@ -965,6 +965,41 @@ describe('state_helpers', () => {
);
});
+ it('should not carry over label when operation and field change at the same time', () => {
+ expect(
+ replaceColumn({
+ layer: {
+ indexPatternId: '1',
+ columnOrder: ['col1'],
+ columns: {
+ col1: {
+ label: 'My custom label',
+ customLabel: true,
+ dataType: 'date',
+ isBucketed: true,
+
+ // Private
+ operationType: 'date_histogram',
+ sourceField: 'timestamp',
+ params: {
+ interval: 'h',
+ },
+ },
+ },
+ },
+ indexPattern,
+ columnId: 'col1',
+ op: 'terms',
+ field: indexPattern.fields[4],
+ visualizationGroups: [],
+ }).columns.col1
+ ).toEqual(
+ expect.objectContaining({
+ label: 'Top values of source',
+ })
+ );
+ });
+
it('should carry over label on operation switch when customLabel flag on previousColumn is set', () => {
expect(
replaceColumn({
@@ -2589,7 +2624,10 @@ describe('state_helpers', () => {
col1: { operationType: 'average' },
},
},
- indexPattern
+ indexPattern,
+ {},
+ '1',
+ {}
);
expect(mock).toHaveBeenCalled();
expect(errors).toHaveLength(1);
@@ -2608,7 +2646,10 @@ describe('state_helpers', () => {
{ operationType: 'testReference', references: [] },
},
},
- indexPattern
+ indexPattern,
+ {},
+ '1',
+ {}
);
expect(mock).toHaveBeenCalled();
expect(errors).toHaveLength(1);
@@ -2637,7 +2678,10 @@ describe('state_helpers', () => {
col1: { operationType: 'testIncompleteReference' },
},
},
- indexPattern
+ indexPattern,
+ {},
+ '1',
+ {}
);
expect(savedRef).toHaveBeenCalled();
expect(incompleteRef).not.toHaveBeenCalled();
@@ -2659,7 +2703,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..56fbb8edef5b4 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,
},
},
};
@@ -827,12 +838,14 @@ function applyReferenceTransition({
);
}
-function copyCustomLabel(
- newColumn: IndexPatternColumn,
- previousOptions: { customLabel?: boolean; label: string }
-) {
+function copyCustomLabel(newColumn: IndexPatternColumn, previousOptions: IndexPatternColumn) {
const adjustedColumn = { ...newColumn };
- if (previousOptions.customLabel) {
+ const operationChanged = newColumn.operationType !== previousOptions.operationType;
+ const fieldChanged =
+ ('sourceField' in newColumn && newColumn.sourceField) !==
+ ('sourceField' in previousOptions && previousOptions.sourceField);
+ // only copy custom label if either used operation or used field stayed the same
+ if (previousOptions.customLabel && (!operationChanged || !fieldChanged)) {
adjustedColumn.customLabel = true;
adjustedColumn.label = previousOptions.label;
}
@@ -1135,20 +1148,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 5a520438ec9e7..3394616618672 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;
}
/**
@@ -677,7 +691,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/plugins/monitoring/public/alerts/alert_form.test.tsx b/x-pack/plugins/monitoring/public/alerts/alert_form.test.tsx
index 11642f4083d39..3eda13f5bcb38 100644
--- a/x-pack/plugins/monitoring/public/alerts/alert_form.test.tsx
+++ b/x-pack/plugins/monitoring/public/alerts/alert_form.test.tsx
@@ -94,12 +94,12 @@ describe('alert_form', () => {
id: 'alert-action-type',
iconClass: '',
selectMessage: '',
- validateConnector: (): ConnectorValidationResult => {
- return {};
+ validateConnector: (): Promise> => {
+ return Promise.resolve({});
},
- validateParams: (): GenericValidationResult => {
+ validateParams: (): Promise> => {
const validationResult = { errors: {} };
- return validationResult;
+ return Promise.resolve(validationResult);
},
actionConnectorFields: null,
actionParamsFields: mockedActionParamsFields,
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts
index 0d79f76be341c..fc60800bc4403 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts
@@ -5,7 +5,7 @@
* 2.0.
*/
import rison, { RisonValue } from 'rison-node';
-import type { AllSeries, AllShortSeries } from '../hooks/use_url_storage';
+import type { AllSeries, AllShortSeries } from '../hooks/use_series_storage';
import type { SeriesUrl } from '../types';
import { IIndexPattern } from '../../../../../../../../src/plugins/data/common/index_patterns';
import { esFilters } from '../../../../../../../../src/plugins/data/public';
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx
index cf51c4614e543..fc0062694e0a3 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx
@@ -7,7 +7,7 @@
import React from 'react';
import { screen, waitFor } from '@testing-library/dom';
-import { render, mockUrlStorage, mockCore, mockAppIndexPattern } from './rtl_helpers';
+import { render, mockCore, mockAppIndexPattern } from './rtl_helpers';
import { ExploratoryView } from './exploratory_view';
import { getStubIndexPattern } from '../../../../../../../src/plugins/data/public/test_utils';
import * as obsvInd from './utils/observability_index_patterns';
@@ -41,26 +41,26 @@ describe('ExploratoryView', () => {
it('renders exploratory view', async () => {
render();
- await waitFor(() => {
- screen.getByText(/open in lens/i);
- screen.getByRole('heading', { name: /analyze data/i });
- });
+ expect(await screen.findByText(/open in lens/i)).toBeInTheDocument();
+ expect(
+ await screen.findByRole('heading', { name: /Performance Distribution/i })
+ ).toBeInTheDocument();
});
it('renders lens component when there is series', async () => {
- mockUrlStorage({
+ const initSeries = {
data: {
'ux-series': {
- dataType: 'ux',
- reportType: 'pld',
- breakdown: 'user_agent.name',
+ dataType: 'ux' as const,
+ reportType: 'pld' as const,
+ breakdown: 'user_agent .name',
reportDefinitions: { 'service.name': ['elastic-co'] },
time: { from: 'now-15m', to: 'now' },
},
},
- });
+ };
- render();
+ render(, { initSeries });
expect(await screen.findByText(/open in lens/i)).toBeInTheDocument();
expect(await screen.findByText('Performance Distribution')).toBeInTheDocument();
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx
index 19136cda6387c..7958dca6e396e 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx
@@ -11,7 +11,7 @@ import styled from 'styled-components';
import { useKibana } from '../../../../../../../src/plugins/kibana_react/public';
import { ObservabilityPublicPluginsStart } from '../../../plugin';
import { ExploratoryViewHeader } from './header/header';
-import { useUrlStorage } from './hooks/use_url_storage';
+import { useSeriesStorage } from './hooks/use_series_storage';
import { useLensAttributes } from './hooks/use_lens_attributes';
import { EmptyView } from './components/empty_view';
import { TypedLensByValueInput } from '../../../../../lens/public';
@@ -19,7 +19,11 @@ import { useAppIndexPatternContext } from './hooks/use_app_index_pattern';
import { ReportToDataTypeMap } from './configurations/constants';
import { SeriesBuilder } from './series_builder/series_builder';
-export function ExploratoryView() {
+export function ExploratoryView({
+ saveAttributes,
+}: {
+ saveAttributes?: (attr: TypedLensByValueInput['attributes'] | null) => void;
+}) {
const {
services: { lens, notifications },
} = useKibana();
@@ -28,6 +32,7 @@ export function ExploratoryView() {
const wrapperRef = useRef(null);
const [height, setHeight] = useState('100vh');
+ const [seriesId, setSeriesId] = useState('');
const [lensAttributes, setLensAttributes] = useState(
null
@@ -37,7 +42,11 @@ export function ExploratoryView() {
const LensComponent = lens?.EmbeddableComponent;
- const { firstSeriesId: seriesId, firstSeries: series, setSeries } = useUrlStorage();
+ const { firstSeriesId, firstSeries: series, setSeries, allSeries } = useSeriesStorage();
+
+ useEffect(() => {
+ setSeriesId(firstSeriesId);
+ }, [allSeries, firstSeriesId]);
const lensAttributesT = useLensAttributes({
seriesId,
@@ -59,6 +68,10 @@ export function ExploratoryView() {
useEffect(() => {
setLensAttributes(lensAttributesT);
+ if (saveAttributes) {
+ saveAttributes(lensAttributesT);
+ }
+
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [JSON.stringify(lensAttributesT ?? {}), series?.reportType, series?.time?.from]);
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.test.tsx
index dec69dc0a7b33..ca9f2c9e73eb8 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.test.tsx
@@ -6,7 +6,7 @@
*/
import React from 'react';
-import { mockUrlStorage, render } from '../rtl_helpers';
+import { render } from '../rtl_helpers';
import { ExploratoryViewHeader } from './header';
import { fireEvent } from '@testing-library/dom';
@@ -22,22 +22,23 @@ describe('ExploratoryViewHeader', function () {
});
it('should be able to click open in lens', function () {
- mockUrlStorage({
+ const initSeries = {
data: {
'uptime-pings-histogram': {
- dataType: 'synthetics',
- reportType: 'upp',
+ dataType: 'synthetics' as const,
+ reportType: 'upp' as const,
breakdown: 'monitor.status',
time: { from: 'now-15m', to: 'now' },
},
},
- });
+ };
const { getByText, core } = render(
+ />,
+ { initSeries }
);
fireEvent.click(getByText('Open in Lens'));
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.tsx
index 8f2f30185d37f..3265287a7f915 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/header/header.tsx
@@ -12,7 +12,7 @@ import { TypedLensByValueInput } from '../../../../../../lens/public';
import { useKibana } from '../../../../../../../../src/plugins/kibana_react/public';
import { ObservabilityPublicPluginsStart } from '../../../../plugin';
import { DataViewLabels } from '../configurations/constants';
-import { useUrlStorage } from '../hooks/use_url_storage';
+import { useSeriesStorage } from '../hooks/use_series_storage';
interface Props {
seriesId: string;
@@ -24,7 +24,9 @@ export function ExploratoryViewHeader({ seriesId, lensAttributes }: Props) {
services: { lens },
} = useKibana();
- const { series } = useUrlStorage(seriesId);
+ const { getSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
return (
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_lens_attributes.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_lens_attributes.ts
index ea6f435460401..4e9c360745b6b 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_lens_attributes.ts
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_lens_attributes.ts
@@ -9,7 +9,7 @@ import { useMemo } from 'react';
import { isEmpty } from 'lodash';
import { TypedLensByValueInput } from '../../../../../../lens/public';
import { LensAttributes } from '../configurations/lens_attributes';
-import { useUrlStorage } from './use_url_storage';
+import { useSeriesStorage } from './use_series_storage';
import { getDefaultConfigs } from '../configurations/default_configs';
import { DataSeries, SeriesUrl, UrlFilter } from '../types';
@@ -40,8 +40,8 @@ export const getFiltersFromDefs = (
export const useLensAttributes = ({
seriesId,
}: Props): TypedLensByValueInput['attributes'] | null => {
- const { series } = useUrlStorage(seriesId);
-
+ const { getSeries } = useSeriesStorage();
+ const series = getSeries(seriesId);
const { breakdown, seriesType, operationType, reportType, reportDefinitions = {} } = series ?? {};
const { indexPattern } = useAppIndexPatternContext();
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_series_filters.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_series_filters.ts
index 2605818ed7846..2d2618bc46152 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_series_filters.ts
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_series_filters.ts
@@ -5,7 +5,7 @@
* 2.0.
*/
-import { useUrlStorage } from './use_url_storage';
+import { useSeriesStorage } from './use_series_storage';
import { UrlFilter } from '../types';
export interface UpdateFilter {
@@ -15,7 +15,9 @@ export interface UpdateFilter {
}
export const useSeriesFilters = ({ seriesId }: { seriesId: string }) => {
- const { series, setSeries } = useUrlStorage(seriesId);
+ const { getSeries, setSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const filters = series.filters ?? [];
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_url_storage.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_series_storage.tsx
similarity index 51%
rename from x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_url_storage.tsx
rename to x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_series_storage.tsx
index 498886cc94410..fac75f910a93f 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_url_storage.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/hooks/use_series_storage.tsx
@@ -5,8 +5,11 @@
* 2.0.
*/
-import React, { createContext, useContext, Context } from 'react';
-import { IKbnUrlStateStorage } from '../../../../../../../../src/plugins/kibana_utils/public';
+import React, { createContext, useContext, useState, useEffect, useCallback } from 'react';
+import {
+ IKbnUrlStateStorage,
+ ISessionStorageStateStorage,
+} from '../../../../../../../../src/plugins/kibana_utils/public';
import type {
AppDataType,
ReportViewTypeId,
@@ -18,17 +21,81 @@ import { convertToShortUrl } from '../configurations/utils';
import { OperationType, SeriesType } from '../../../../../../lens/public';
import { URL_KEYS } from '../configurations/constants/url_constants';
-export const UrlStorageContext = createContext(null);
+export interface SeriesContextValue {
+ firstSeries: SeriesUrl;
+ firstSeriesId: string;
+ allSeriesIds: string[];
+ allSeries: AllSeries;
+ setSeries: (seriesIdN: string, newValue: SeriesUrl) => void;
+ getSeries: (seriesId: string) => SeriesUrl;
+ removeSeries: (seriesId: string) => void;
+}
+export const UrlStorageContext = createContext({} as SeriesContextValue);
interface ProviderProps {
- storage: IKbnUrlStateStorage;
+ storage: IKbnUrlStateStorage | ISessionStorageStateStorage;
}
export function UrlStorageContextProvider({
children,
storage,
}: ProviderProps & { children: JSX.Element }) {
- return {children};
+ const allSeriesKey = 'sr';
+
+ const [allShortSeries, setAllShortSeries] = useState(
+ () => storage.get(allSeriesKey) ?? {}
+ );
+ const [allSeries, setAllSeries] = useState({});
+ const [firstSeriesId, setFirstSeriesId] = useState('');
+
+ useEffect(() => {
+ const allSeriesIds = Object.keys(allShortSeries);
+ const allSeriesN: AllSeries = {};
+ allSeriesIds.forEach((seriesKey) => {
+ allSeriesN[seriesKey] = convertFromShortUrl(allShortSeries[seriesKey]);
+ });
+
+ setAllSeries(allSeriesN);
+ setFirstSeriesId(allSeriesIds?.[0]);
+ (storage as IKbnUrlStateStorage).set(allSeriesKey, allShortSeries);
+ }, [allShortSeries, storage]);
+
+ const setSeries = (seriesIdN: string, newValue: SeriesUrl) => {
+ setAllShortSeries((prevState) => {
+ prevState[seriesIdN] = convertToShortUrl(newValue);
+ return { ...prevState };
+ });
+ };
+
+ const removeSeries = (seriesIdN: string) => {
+ delete allShortSeries[seriesIdN];
+ delete allSeries[seriesIdN];
+ };
+
+ const allSeriesIds = Object.keys(allShortSeries);
+
+ const getSeries = useCallback(
+ (seriesId?: string) => {
+ return seriesId ? allSeries?.[seriesId] ?? {} : ({} as SeriesUrl);
+ },
+ [allSeries]
+ );
+
+ const value = {
+ storage,
+ getSeries,
+ setSeries,
+ removeSeries,
+ firstSeriesId,
+ allSeries,
+ allSeriesIds,
+ firstSeries: allSeries?.[firstSeriesId],
+ };
+ return {children};
+}
+
+export function useSeriesStorage() {
+ return useContext(UrlStorageContext);
}
function convertFromShortUrl(newValue: ShortUrlSeries): SeriesUrl {
@@ -64,47 +131,3 @@ export type AllShortSeries = Record;
export type AllSeries = Record;
export const NEW_SERIES_KEY = 'new-series-key';
-
-export function useUrlStorage(seriesId?: string) {
- const allSeriesKey = 'sr';
- const storage = useContext((UrlStorageContext as unknown) as Context);
- let series: SeriesUrl = {} as SeriesUrl;
- const allShortSeries = storage.get(allSeriesKey) ?? {};
-
- const allSeriesIds = Object.keys(allShortSeries);
-
- const allSeries: AllSeries = {};
-
- allSeriesIds.forEach((seriesKey) => {
- allSeries[seriesKey] = convertFromShortUrl(allShortSeries[seriesKey]);
- });
-
- if (seriesId) {
- series = allSeries?.[seriesId] ?? ({} as SeriesUrl);
- }
-
- const setSeries = async (seriesIdN: string, newValue: SeriesUrl) => {
- allShortSeries[seriesIdN] = convertToShortUrl(newValue);
- allSeries[seriesIdN] = newValue;
- return storage.set(allSeriesKey, allShortSeries);
- };
-
- const removeSeries = (seriesIdN: string) => {
- delete allShortSeries[seriesIdN];
- delete allSeries[seriesIdN];
- storage.set(allSeriesKey, allShortSeries);
- };
-
- const firstSeriesId = allSeriesIds?.[0];
-
- return {
- storage,
- setSeries,
- removeSeries,
- series,
- firstSeriesId,
- allSeries,
- allSeriesIds,
- firstSeries: allSeries?.[firstSeriesId],
- };
-}
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/index.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/index.tsx
index 80b6b29f88303..3de29b02853e8 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/index.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/index.tsx
@@ -17,11 +17,19 @@ import { IndexPatternContextProvider } from './hooks/use_app_index_pattern';
import {
createKbnUrlStateStorage,
withNotifyOnErrors,
+ createSessionStorageStateStorage,
} from '../../../../../../../src/plugins/kibana_utils/public/';
-import { UrlStorageContextProvider } from './hooks/use_url_storage';
+import { UrlStorageContextProvider } from './hooks/use_series_storage';
import { useTrackPageview } from '../../..';
+import { TypedLensByValueInput } from '../../../../../lens/public';
-export function ExploratoryViewPage() {
+export function ExploratoryViewPage({
+ saveAttributes,
+ useSessionStorage = false,
+}: {
+ useSessionStorage?: boolean;
+ saveAttributes?: (attr: TypedLensByValueInput['attributes'] | null) => void;
+}) {
useTrackPageview({ app: 'observability-overview', path: 'exploratory-view' });
useTrackPageview({ app: 'observability-overview', path: 'exploratory-view', delay: 15000 });
@@ -39,17 +47,19 @@ export function ExploratoryViewPage() {
const history = useHistory();
- const kbnUrlStateStorage = createKbnUrlStateStorage({
- history,
- useHash: uiSettings!.get('state:storeInSessionStorage'),
- ...withNotifyOnErrors(notifications!.toasts),
- });
+ const kbnUrlStateStorage = useSessionStorage
+ ? createSessionStorageStateStorage()
+ : createKbnUrlStateStorage({
+ history,
+ useHash: uiSettings!.get('state:storeInSessionStorage'),
+ ...withNotifyOnErrors(notifications!.toasts),
+ });
return (
-
+
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/rtl_helpers.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/rtl_helpers.tsx
index beb1daafbd55f..9118e49a42dfb 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/rtl_helpers.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/rtl_helpers.tsx
@@ -16,29 +16,23 @@ import { CoreStart } from 'kibana/public';
import { I18nProvider } from '@kbn/i18n/react';
import { coreMock } from 'src/core/public/mocks';
import {
- KibanaServices,
KibanaContextProvider,
+ KibanaServices,
} from '../../../../../../../src/plugins/kibana_react/public';
import { ObservabilityPublicPluginsStart } from '../../../plugin';
import { EuiThemeProvider } from '../../../../../../../src/plugins/kibana_react/common';
import { lensPluginMock } from '../../../../../lens/public/mocks';
+import * as useAppIndexPatternHook from './hooks/use_app_index_pattern';
import { IndexPatternContextProvider } from './hooks/use_app_index_pattern';
-import { AllSeries, UrlStorageContextProvider } from './hooks/use_url_storage';
-import {
- withNotifyOnErrors,
- createKbnUrlStateStorage,
-} from '../../../../../../../src/plugins/kibana_utils/public';
+import { AllSeries, UrlStorageContext } from './hooks/use_series_storage';
+
import * as fetcherHook from '../../../hooks/use_fetcher';
-import * as useUrlHook from './hooks/use_url_storage';
import * as useSeriesFilterHook from './hooks/use_series_filters';
import * as useHasDataHook from '../../../hooks/use_has_data';
import * as useValuesListHook from '../../../hooks/use_values_list';
-import * as useAppIndexPatternHook from './hooks/use_app_index_pattern';
-
// eslint-disable-next-line @kbn/eslint/no-restricted-paths
import { getStubIndexPattern } from '../../../../../../../src/plugins/data/public/index_patterns/index_pattern.stub';
import indexPatternData from './configurations/test_data/test_index_pattern.json';
-
// eslint-disable-next-line @kbn/eslint/no-restricted-paths
import { setIndexPatterns } from '../../../../../../../src/plugins/data/public/services';
import { IndexPatternsContract } from '../../../../../../../src/plugins/data/common/index_patterns/index_patterns';
@@ -73,6 +67,11 @@ interface RenderRouterOptions extends KibanaProviderOptions;
url?: Url;
+ initSeries?: {
+ data?: AllSeries;
+ filters?: UrlFilter[];
+ breakdown?: string;
+ };
}
function getSetting(key: string): T {
@@ -127,17 +126,8 @@ export const mockCore: () => Partial>({
children,
core,
- history,
kibanaProps,
}: MockKibanaProviderProps) {
- const { notifications } = core!;
-
- const kbnUrlStateStorage = createKbnUrlStateStorage({
- history,
- useHash: false,
- ...withNotifyOnErrors(notifications!.toasts),
- });
-
const indexPattern = mockIndexPattern;
setIndexPatterns(({
@@ -149,11 +139,7 @@ export function MockKibanaProvider>({
-
-
- {children}
-
-
+ {children}
@@ -184,6 +170,7 @@ export function render(
kibanaProps,
renderOptions,
url,
+ initSeries = {},
}: RenderRouterOptions = {}
) {
if (url) {
@@ -195,15 +182,20 @@ export function render(
...customCore,
};
+ const seriesContextValue = mockSeriesStorageContext(initSeries);
+
return {
...reactTestLibRender(
- {ui}
+
+ {ui}
+
,
renderOptions
),
history,
core,
+ ...seriesContextValue,
};
}
@@ -256,7 +248,7 @@ export const mockUseValuesList = (values?: string[]) => {
return { spy, onRefreshTimeRange };
};
-export const mockUrlStorage = ({
+function mockSeriesStorageContext({
data,
filters,
breakdown,
@@ -264,7 +256,7 @@ export const mockUrlStorage = ({
data?: AllSeries;
filters?: UrlFilter[];
breakdown?: string;
-}) => {
+}) {
const mockDataSeries = data || {
'performance-distribution': {
reportType: 'pld',
@@ -282,18 +274,18 @@ export const mockUrlStorage = ({
const removeSeries = jest.fn();
const setSeries = jest.fn();
- const spy = jest.spyOn(useUrlHook, 'useUrlStorage').mockReturnValue({
+ const getSeries = jest.fn().mockReturnValue(series);
+
+ return {
firstSeriesId,
allSeriesIds,
removeSeries,
setSeries,
- series,
+ getSeries,
firstSeries: mockDataSeries[firstSeriesId],
allSeries: mockDataSeries,
- } as any);
-
- return { spy, removeSeries, setSeries };
-};
+ };
+}
export function mockUseSeriesFilter() {
const removeFilter = jest.fn();
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.test.tsx
index bac935dbecbe7..c054853d9c877 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.test.tsx
@@ -7,13 +7,11 @@
import React from 'react';
import { fireEvent, screen, waitFor } from '@testing-library/react';
-import { mockUrlStorage, render } from '../../rtl_helpers';
+import { render } from '../../rtl_helpers';
import { SeriesChartTypesSelect, XYChartTypesSelect } from './chart_types';
describe.skip('SeriesChartTypesSelect', function () {
it('should render properly', async function () {
- mockUrlStorage({});
-
render();
await waitFor(() => {
@@ -22,9 +20,9 @@ describe.skip('SeriesChartTypesSelect', function () {
});
it('should call set series on change', async function () {
- const { setSeries } = mockUrlStorage({});
-
- render();
+ const { setSeries } = render(
+
+ );
await waitFor(() => {
screen.getByText(/chart type/i);
@@ -44,8 +42,6 @@ describe.skip('SeriesChartTypesSelect', function () {
describe('XYChartTypesSelect', function () {
it('should render properly', async function () {
- mockUrlStorage({});
-
render();
await waitFor(() => {
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.tsx
index a296d2520db34..9ae8b68bf3e8c 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/chart_types.tsx
@@ -11,7 +11,7 @@ import { i18n } from '@kbn/i18n';
import { useKibana } from '../../../../../../../../../src/plugins/kibana_react/public';
import { ObservabilityPublicPluginsStart } from '../../../../../plugin';
import { useFetcher } from '../../../../..';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
import { SeriesType } from '../../../../../../../lens/public';
const CHART_TYPE_LABEL = i18n.translate('xpack.observability.expView.chartTypes.label', {
@@ -27,7 +27,9 @@ export function SeriesChartTypesSelect({
seriesTypes?: SeriesType[];
defaultChartType: SeriesType;
}) {
- const { series, setSeries, allSeries } = useUrlStorage(seriesId);
+ const { getSeries, setSeries, allSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const seriesType = series?.seriesType ?? defaultChartType;
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.test.tsx
index 9348fcbe15f6c..51529a3b1ac17 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.test.tsx
@@ -7,7 +7,7 @@
import React from 'react';
import { fireEvent, screen } from '@testing-library/react';
-import { mockAppIndexPattern, mockUrlStorage, render } from '../../rtl_helpers';
+import { mockAppIndexPattern, render } from '../../rtl_helpers';
import { dataTypes, DataTypesCol } from './data_types_col';
describe('DataTypesCol', function () {
@@ -24,9 +24,7 @@ describe('DataTypesCol', function () {
});
it('should set series on change', function () {
- const { setSeries } = mockUrlStorage({});
-
- render();
+ const { setSeries } = render();
fireEvent.click(screen.getByText(/user experience \(rum\)/i));
@@ -35,18 +33,18 @@ describe('DataTypesCol', function () {
});
it('should set series on change on already selected', function () {
- mockUrlStorage({
+ const initSeries = {
data: {
[seriesId]: {
- dataType: 'synthetics',
- reportType: 'upp',
+ dataType: 'synthetics' as const,
+ reportType: 'upp' as const,
breakdown: 'monitor.status',
time: { from: 'now-15m', to: 'now' },
},
},
- });
+ };
- render();
+ render(, { initSeries });
const button = screen.getByRole('button', {
name: /Synthetic Monitoring/i,
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.tsx
index b64fad51e9778..08e7f4ddcd3d0 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/data_types_col.tsx
@@ -10,7 +10,7 @@ import { EuiButton, EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
import styled from 'styled-components';
import { AppDataType } from '../../types';
import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
import { ReportToDataTypeMap } from '../../configurations/constants';
export const dataTypes: Array<{ id: AppDataType; label: string }> = [
@@ -22,8 +22,9 @@ export const dataTypes: Array<{ id: AppDataType; label: string }> = [
];
export function DataTypesCol({ seriesId }: { seriesId: string }) {
- const { series, setSeries, removeSeries } = useUrlStorage(seriesId);
+ const { getSeries, setSeries, removeSeries } = useSeriesStorage();
+ const series = getSeries(seriesId);
const { loading } = useAppIndexPatternContext();
const onDataTypeChange = (dataType?: AppDataType) => {
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.test.tsx
index 9550b8e98103b..c262a94f968be 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.test.tsx
@@ -7,7 +7,7 @@
import React from 'react';
import { fireEvent, screen } from '@testing-library/react';
-import { mockUrlStorage, render } from '../../rtl_helpers';
+import { render } from '../../rtl_helpers';
import { OperationTypeSelect } from './operation_type_select';
describe('OperationTypeSelect', function () {
@@ -18,35 +18,35 @@ describe('OperationTypeSelect', function () {
});
it('should display selected value', function () {
- mockUrlStorage({
+ const initSeries = {
data: {
'performance-distribution': {
- dataType: 'ux',
- reportType: 'kpi',
- operationType: 'median',
+ dataType: 'ux' as const,
+ reportType: 'kpi' as const,
+ operationType: 'median' as const,
time: { from: 'now-15m', to: 'now' },
},
},
- });
+ };
- render();
+ render(, { initSeries });
screen.getByText('Median');
});
it('should call set series on change', function () {
- const { setSeries } = mockUrlStorage({
+ const initSeries = {
data: {
'series-id': {
- dataType: 'ux',
- reportType: 'kpi',
- operationType: 'median',
+ dataType: 'ux' as const,
+ reportType: 'kpi' as const,
+ operationType: 'median' as const,
time: { from: 'now-15m', to: 'now' },
},
},
- });
+ };
- render();
+ const { setSeries } = render(, { initSeries });
fireEvent.click(screen.getByTestId('operationTypeSelect'));
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.tsx
index 75203d7bae3a0..fa273f6180935 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/operation_type_select.tsx
@@ -9,7 +9,7 @@ import React, { useEffect } from 'react';
import { i18n } from '@kbn/i18n';
import { EuiSuperSelect } from '@elastic/eui';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
import { OperationType } from '../../../../../../../lens/public';
export function OperationTypeSelect({
@@ -19,7 +19,9 @@ export function OperationTypeSelect({
seriesId: string;
defaultOperationType?: OperationType;
}) {
- const { series, setSeries } = useUrlStorage(seriesId);
+ const { getSeries, setSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const operationType = series?.operationType;
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_breakdowns.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_breakdowns.test.tsx
index 3363d17d81eab..f576862f18e76 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_breakdowns.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_breakdowns.test.tsx
@@ -7,9 +7,8 @@
import React from 'react';
import { fireEvent, screen } from '@testing-library/react';
-import { render } from '../../../../../utils/test_helper';
import { getDefaultConfigs } from '../../configurations/default_configs';
-import { mockIndexPattern, mockUrlStorage } from '../../rtl_helpers';
+import { mockIndexPattern, render } from '../../rtl_helpers';
import { ReportBreakdowns } from './report_breakdowns';
import { USER_AGENT_OS } from '../../configurations/constants/elasticsearch_fieldnames';
@@ -22,8 +21,6 @@ describe('Series Builder ReportBreakdowns', function () {
});
it('should render properly', function () {
- mockUrlStorage({});
-
render();
screen.getByText('Select an option: , is selected');
@@ -31,9 +28,9 @@ describe('Series Builder ReportBreakdowns', function () {
});
it('should set new series breakdown on change', function () {
- const { setSeries } = mockUrlStorage({});
-
- render();
+ const { setSeries } = render(
+
+ );
const btn = screen.getByRole('button', {
name: /select an option: Browser family , is selected/i,
@@ -53,9 +50,9 @@ describe('Series Builder ReportBreakdowns', function () {
});
});
it('should set undefined on new series on no select breakdown', function () {
- const { setSeries } = mockUrlStorage({});
-
- render();
+ const { setSeries } = render(
+
+ );
const btn = screen.getByRole('button', {
name: /select an option: Browser family , is selected/i,
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_col.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_col.test.tsx
index 27adcf4682c02..fdf6633c0ddb5 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_col.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_col.test.tsx
@@ -11,7 +11,6 @@ import { getDefaultConfigs } from '../../configurations/default_configs';
import {
mockAppIndexPattern,
mockIndexPattern,
- mockUrlStorage,
mockUseValuesList,
render,
} from '../../rtl_helpers';
@@ -28,21 +27,23 @@ describe('Series Builder ReportDefinitionCol', function () {
indexPattern: mockIndexPattern,
});
- const { setSeries } = mockUrlStorage({
+ const initSeries = {
data: {
[seriesId]: {
- dataType: 'ux',
- reportType: 'pld',
+ dataType: 'ux' as const,
+ reportType: 'pld' as const,
time: { from: 'now-30d', to: 'now' },
reportDefinitions: { [SERVICE_NAME]: ['elastic-co'] },
},
},
- });
+ };
mockUseValuesList(['elastic-co']);
it('should render properly', async function () {
- render();
+ render(, {
+ initSeries,
+ });
screen.getByText('Web Application');
screen.getByText('Environment');
@@ -51,7 +52,9 @@ describe('Series Builder ReportDefinitionCol', function () {
});
it('should render selected report definitions', async function () {
- render();
+ render(, {
+ initSeries,
+ });
expect(await screen.findByText('elastic-co')).toBeInTheDocument();
@@ -59,7 +62,10 @@ describe('Series Builder ReportDefinitionCol', function () {
});
it('should be able to remove selected definition', async function () {
- render();
+ const { setSeries } = render(
+ ,
+ { initSeries }
+ );
expect(
await screen.findByLabelText('Remove elastic-co from selection in this group')
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_col.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_col.tsx
index ff8b0f7aa578b..338f5d52c26fa 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_col.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_col.tsx
@@ -9,7 +9,7 @@ import React from 'react';
import { EuiFlexGroup, EuiFlexItem, EuiHorizontalRule } from '@elastic/eui';
import styled from 'styled-components';
import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
import { CustomReportField } from '../custom_report_field';
import { DataSeries, URLReportDefinition } from '../../types';
import { SeriesChartTypesSelect } from './chart_types';
@@ -38,9 +38,11 @@ export function ReportDefinitionCol({
}) {
const { indexPattern } = useAppIndexPatternContext();
- const { series, setSeries } = useUrlStorage(seriesId);
+ const { getSeries, setSeries } = useSeriesStorage();
- const { reportDefinitions: selectedReportDefinitions = {} } = series;
+ const series = getSeries(seriesId);
+
+ const { reportDefinitions: selectedReportDefinitions = {} } = series ?? {};
const { reportDefinitions, defaultSeriesType, hasOperationType, yAxisColumns } = dataViewSeries;
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_field.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_field.tsx
index 9f92bec4d1f9c..1a6d2af8f4d40 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_field.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_definition_field.tsx
@@ -9,7 +9,7 @@ import React, { useMemo } from 'react';
import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
import { isEmpty } from 'lodash';
import FieldValueSuggestions from '../../../field_value_suggestions';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern';
import { ESFilter } from '../../../../../../../../../typings/elasticsearch';
import { PersistableFilter } from '../../../../../../../lens/common';
@@ -25,7 +25,9 @@ interface Props {
}
export function ReportDefinitionField({ seriesId, field, dataSeries, onChange }: Props) {
- const { series } = useUrlStorage(seriesId);
+ const { getSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const { indexPattern } = useAppIndexPatternContext();
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_filters.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_filters.test.tsx
index 1467cb54d648a..dc2dc629cc121 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_filters.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_filters.test.tsx
@@ -7,10 +7,9 @@
import React from 'react';
import { screen } from '@testing-library/react';
-import { render } from '../../../../../utils/test_helper';
import { ReportFilters } from './report_filters';
import { getDefaultConfigs } from '../../configurations/default_configs';
-import { mockIndexPattern, mockUrlStorage } from '../../rtl_helpers';
+import { mockIndexPattern, render } from '../../rtl_helpers';
describe('Series Builder ReportFilters', function () {
const seriesId = 'test-series-id';
@@ -20,7 +19,7 @@ describe('Series Builder ReportFilters', function () {
reportType: 'pld',
indexPattern: mockIndexPattern,
});
- mockUrlStorage({});
+
it('should render properly', function () {
render();
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.test.tsx
index 20c4ea98d482d..c721a2fa2fe77 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.test.tsx
@@ -7,11 +7,11 @@
import React from 'react';
import { fireEvent, screen } from '@testing-library/react';
-import { mockAppIndexPattern, mockUrlStorage, render } from '../../rtl_helpers';
+import { mockAppIndexPattern, render } from '../../rtl_helpers';
import { ReportTypesCol, SELECTED_DATA_TYPE_FOR_REPORT } from './report_types_col';
import { ReportTypes } from '../series_builder';
import { DEFAULT_TIME } from '../../configurations/constants';
-import { NEW_SERIES_KEY } from '../../hooks/use_url_storage';
+import { NEW_SERIES_KEY } from '../../hooks/use_series_storage';
describe('ReportTypesCol', function () {
const seriesId = 'test-series-id';
@@ -30,8 +30,9 @@ describe('ReportTypesCol', function () {
});
it('should set series on change', function () {
- const { setSeries } = mockUrlStorage({});
- render();
+ const { setSeries } = render(
+
+ );
fireEvent.click(screen.getByText(/monitor duration/i));
@@ -46,18 +47,21 @@ describe('ReportTypesCol', function () {
});
it('should set selected as filled', function () {
- const { setSeries } = mockUrlStorage({
+ const initSeries = {
data: {
[NEW_SERIES_KEY]: {
- dataType: 'synthetics',
- reportType: 'upp',
+ dataType: 'synthetics' as const,
+ reportType: 'upp' as const,
breakdown: 'monitor.status',
time: { from: 'now-15m', to: 'now' },
},
},
- });
+ };
- render();
+ const { setSeries } = render(
+ ,
+ { initSeries }
+ );
const button = screen.getByRole('button', {
name: /pings histogram/i,
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.tsx
index bd82d1d1bd500..9fff8dae14a47 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/columns/report_types_col.tsx
@@ -11,7 +11,7 @@ import { FormattedMessage } from '@kbn/i18n/react';
import { EuiButton, EuiFlexGroup, EuiFlexItem, EuiText } from '@elastic/eui';
import styled from 'styled-components';
import { ReportViewTypeId, SeriesUrl } from '../../types';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
import { DEFAULT_TIME } from '../../configurations/constants';
import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern';
@@ -21,10 +21,9 @@ interface Props {
}
export function ReportTypesCol({ seriesId, reportTypes }: Props) {
- const {
- series: { reportType: selectedReportType, ...restSeries },
- setSeries,
- } = useUrlStorage(seriesId);
+ const { setSeries, getSeries } = useSeriesStorage();
+
+ const { reportType: selectedReportType, ...restSeries } = getSeries(seriesId);
const { loading, hasData, selectedApp } = useAppIndexPatternContext();
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/custom_report_field.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/custom_report_field.tsx
index b41f3a603e5da..201df9628e135 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/custom_report_field.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/custom_report_field.tsx
@@ -7,7 +7,7 @@
import React from 'react';
import { EuiSuperSelect } from '@elastic/eui';
-import { useUrlStorage } from '../hooks/use_url_storage';
+import { useSeriesStorage } from '../hooks/use_series_storage';
import { ReportDefinition } from '../types';
interface Props {
@@ -18,7 +18,9 @@ interface Props {
}
export function CustomReportField({ field, seriesId, options: opts }: Props) {
- const { series, setSeries } = useUrlStorage(seriesId);
+ const { getSeries, setSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const { reportDefinitions: rtd = {} } = series;
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/series_builder.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/series_builder.tsx
index 1944bb281598b..32f1fb7f7c43b 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/series_builder.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_builder/series_builder.tsx
@@ -15,7 +15,7 @@ import { ReportTypesCol } from './columns/report_types_col';
import { ReportDefinitionCol } from './columns/report_definition_col';
import { ReportFilters } from './columns/report_filters';
import { ReportBreakdowns } from './columns/report_breakdowns';
-import { NEW_SERIES_KEY, useUrlStorage } from '../hooks/use_url_storage';
+import { NEW_SERIES_KEY, useSeriesStorage } from '../hooks/use_series_storage';
import { useAppIndexPatternContext } from '../hooks/use_app_index_pattern';
import { getDefaultConfigs } from '../configurations/default_configs';
@@ -53,7 +53,9 @@ export function SeriesBuilder({
seriesId: string;
seriesBuilderRef: RefObject;
}) {
- const { series, setSeries, removeSeries } = useUrlStorage(seriesId);
+ const { getSeries, setSeries, removeSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const {
dataType,
@@ -156,9 +158,8 @@ export function SeriesBuilder({
reportDefinitions,
};
- setSeries(newSeriesId, newSeriesN).then(() => {
- removeSeries(NEW_SERIES_KEY);
- });
+ setSeries(newSeriesId, newSeriesN);
+ removeSeries(NEW_SERIES_KEY);
}
};
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_date_picker/index.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_date_picker/index.tsx
index 960c2978287bc..d6a70532f4257 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_date_picker/index.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_date_picker/index.tsx
@@ -8,7 +8,7 @@
import { EuiSuperDatePicker } from '@elastic/eui';
import React, { useEffect } from 'react';
import { useHasData } from '../../../../hooks/use_has_data';
-import { useUrlStorage } from '../hooks/use_url_storage';
+import { useSeriesStorage } from '../hooks/use_series_storage';
import { useQuickTimeRanges } from '../../../../hooks/use_quick_time_ranges';
import { DEFAULT_TIME } from '../configurations/constants';
@@ -30,7 +30,9 @@ export function SeriesDatePicker({ seriesId }: Props) {
const commonlyUsedRanges = useQuickTimeRanges();
- const { series, setSeries } = useUrlStorage(seriesId);
+ const { getSeries, setSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
function onTimeChange({ start, end }: { start: string; end: string }) {
onRefreshTimeRange();
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_date_picker/series_date_picker.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_date_picker/series_date_picker.test.tsx
index e99b701f091fe..0edc4330ef97a 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_date_picker/series_date_picker.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_date_picker/series_date_picker.test.tsx
@@ -6,62 +6,67 @@
*/
import React from 'react';
-import { mockUrlStorage, mockUseHasData, render } from '../rtl_helpers';
+import { mockUseHasData, render } from '../rtl_helpers';
import { fireEvent, waitFor } from '@testing-library/react';
import { SeriesDatePicker } from './index';
import { DEFAULT_TIME } from '../configurations/constants';
describe('SeriesDatePicker', function () {
it('should render properly', function () {
- mockUrlStorage({
+ const initSeries = {
data: {
'uptime-pings-histogram': {
- dataType: 'synthetics',
- reportType: 'upp',
+ dataType: 'synthetics' as const,
+ reportType: 'upp' as const,
breakdown: 'monitor.status',
time: { from: 'now-30m', to: 'now' },
},
},
- });
- const { getByText } = render();
+ };
+ const { getByText } = render(, { initSeries });
getByText('Last 30 minutes');
});
it('should set defaults', async function () {
- const { setSeries: setSeries1 } = mockUrlStorage({
+ const initSeries = {
data: {
'uptime-pings-histogram': {
- reportType: 'upp',
- dataType: 'synthetics',
+ reportType: 'upp' as const,
+ dataType: 'synthetics' as const,
breakdown: 'monitor.status',
},
},
- } as any);
- render();
+ };
+ const { setSeries: setSeries1 } = render(
+ ,
+ { initSeries: initSeries as any }
+ );
expect(setSeries1).toHaveBeenCalledTimes(1);
expect(setSeries1).toHaveBeenCalledWith('uptime-pings-histogram', {
breakdown: 'monitor.status',
- dataType: 'synthetics',
- reportType: 'upp',
+ dataType: 'synthetics' as const,
+ reportType: 'upp' as const,
time: DEFAULT_TIME,
});
});
it('should set series data', async function () {
- const { setSeries } = mockUrlStorage({
+ const initSeries = {
data: {
'uptime-pings-histogram': {
- dataType: 'synthetics',
- reportType: 'upp',
+ dataType: 'synthetics' as const,
+ reportType: 'upp' as const,
breakdown: 'monitor.status',
time: { from: 'now-30m', to: 'now' },
},
},
- });
+ };
const { onRefreshTimeRange } = mockUseHasData();
- const { getByTestId } = render();
+ const { getByTestId, setSeries } = render(, {
+ initSeries,
+ });
await waitFor(function () {
fireEvent.click(getByTestId('superDatePickerToggleQuickMenuButton'));
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/breakdowns.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/breakdowns.test.tsx
index 9d26ec79c31ad..0ce9db73f92b1 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/breakdowns.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/breakdowns.test.tsx
@@ -8,8 +8,8 @@
import React from 'react';
import { fireEvent, screen } from '@testing-library/react';
import { Breakdowns } from './breakdowns';
-import { mockIndexPattern, mockUrlStorage, render } from '../../rtl_helpers';
-import { NEW_SERIES_KEY } from '../../hooks/use_url_storage';
+import { mockIndexPattern, render } from '../../rtl_helpers';
+import { NEW_SERIES_KEY } from '../../hooks/use_series_storage';
import { getDefaultConfigs } from '../../configurations/default_configs';
import { USER_AGENT_OS } from '../../configurations/constants/elasticsearch_fieldnames';
@@ -21,8 +21,6 @@ describe('Breakdowns', function () {
});
it('should render properly', async function () {
- mockUrlStorage({});
-
render(
+ />,
+ { initSeries }
);
screen.getAllByText('Operating system');
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/breakdowns.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/breakdowns.tsx
index 5cf6ac47aa8c7..cf24cb31951b1 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/breakdowns.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/breakdowns.tsx
@@ -8,8 +8,8 @@
import React from 'react';
import { EuiSuperSelect } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
import { USE_BREAK_DOWN_COLUMN } from '../../configurations/constants';
-import { useUrlStorage } from '../../hooks/use_url_storage';
import { DataSeries } from '../../types';
interface Props {
@@ -19,7 +19,9 @@ interface Props {
}
export function Breakdowns({ reportViewConfig, seriesId, breakdowns = [] }: Props) {
- const { setSeries, series } = useUrlStorage(seriesId);
+ const { setSeries, getSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const selectedBreakdown = series.breakdown;
const NO_BREAKDOWN = 'no_breakdown';
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.test.tsx
index 8d3060792857e..1a8c5b335bc4f 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.test.tsx
@@ -8,12 +8,12 @@
import React from 'react';
import { fireEvent, screen } from '@testing-library/react';
import { FilterExpanded } from './filter_expanded';
-import { mockAppIndexPattern, mockUrlStorage, mockUseValuesList, render } from '../../rtl_helpers';
+import { mockAppIndexPattern, mockUseValuesList, render } from '../../rtl_helpers';
import { USER_AGENT_NAME } from '../../configurations/constants/elasticsearch_fieldnames';
describe('FilterExpanded', function () {
it('should render properly', async function () {
- mockUrlStorage({ filters: [{ field: USER_AGENT_NAME, values: ['Chrome'] }] });
+ const initSeries = { filters: [{ field: USER_AGENT_NAME, values: ['Chrome'] }] };
mockAppIndexPattern();
render(
@@ -22,13 +22,14 @@ describe('FilterExpanded', function () {
label={'Browser Family'}
field={USER_AGENT_NAME}
goBack={jest.fn()}
- />
+ />,
+ { initSeries }
);
screen.getByText('Browser Family');
});
it('should call go back on click', async function () {
- mockUrlStorage({ filters: [{ field: USER_AGENT_NAME, values: ['Chrome'] }] });
+ const initSeries = { filters: [{ field: USER_AGENT_NAME, values: ['Chrome'] }] };
const goBack = jest.fn();
render(
@@ -37,7 +38,8 @@ describe('FilterExpanded', function () {
label={'Browser Family'}
field={USER_AGENT_NAME}
goBack={goBack}
- />
+ />,
+ { initSeries }
);
fireEvent.click(screen.getByText('Browser Family'));
@@ -47,7 +49,7 @@ describe('FilterExpanded', function () {
});
it('should call useValuesList on load', async function () {
- mockUrlStorage({ filters: [{ field: USER_AGENT_NAME, values: ['Chrome'] }] });
+ const initSeries = { filters: [{ field: USER_AGENT_NAME, values: ['Chrome'] }] };
const { spy } = mockUseValuesList(['Chrome', 'Firefox']);
@@ -59,7 +61,8 @@ describe('FilterExpanded', function () {
label={'Browser Family'}
field={USER_AGENT_NAME}
goBack={goBack}
- />
+ />,
+ { initSeries }
);
expect(spy).toHaveBeenCalledTimes(1);
@@ -71,7 +74,7 @@ describe('FilterExpanded', function () {
);
});
it('should filter display values', async function () {
- mockUrlStorage({ filters: [{ field: USER_AGENT_NAME, values: ['Chrome'] }] });
+ const initSeries = { filters: [{ field: USER_AGENT_NAME, values: ['Chrome'] }] };
mockUseValuesList(['Chrome', 'Firefox']);
@@ -81,7 +84,8 @@ describe('FilterExpanded', function () {
label={'Browser Family'}
field={USER_AGENT_NAME}
goBack={jest.fn()}
- />
+ />,
+ { initSeries }
);
expect(screen.queryByText('Firefox')).toBeTruthy();
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.tsx
index 7a646c9035968..cc1769cfa8c95 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_expanded.tsx
@@ -11,7 +11,7 @@ import styled from 'styled-components';
import { rgba } from 'polished';
import { i18n } from '@kbn/i18n';
import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
import { UrlFilter } from '../../types';
import { FilterValueButton } from './filter_value_btn';
import { useValuesList } from '../../../../../hooks/use_values_list';
@@ -33,7 +33,9 @@ export function FilterExpanded({ seriesId, field, label, goBack, nestedField, is
const [isOpen, setIsOpen] = useState({ value: '', negate: false });
- const { series } = useUrlStorage(seriesId);
+ const { getSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const { values, loading } = useValuesList({
query: value,
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.test.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.test.tsx
index befbb3b74d6d7..79eb858b7624b 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.test.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.test.tsx
@@ -8,7 +8,7 @@
import React from 'react';
import { fireEvent, screen } from '@testing-library/react';
import { FilterValueButton } from './filter_value_btn';
-import { mockUrlStorage, mockUseSeriesFilter, mockUseValuesList, render } from '../../rtl_helpers';
+import { mockUseSeriesFilter, mockUseValuesList, render } from '../../rtl_helpers';
import {
USER_AGENT_NAME,
USER_AGENT_VERSION,
@@ -75,7 +75,6 @@ describe('FilterValueButton', function () {
});
});
it('should remove filter on click if already selected', async function () {
- mockUrlStorage({});
const { removeFilter } = mockUseSeriesFilter();
render(
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.tsx
index ccb9c90a884bb..ea84ec6b6c212 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.tsx
@@ -8,7 +8,7 @@ import { i18n } from '@kbn/i18n';
import React, { useMemo } from 'react';
import { EuiFilterButton, hexToRgb } from '@elastic/eui';
import { useAppIndexPatternContext } from '../../hooks/use_app_index_pattern';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
import { useSeriesFilters } from '../../hooks/use_series_filters';
import { euiStyled } from '../../../../../../../../../src/plugins/kibana_react/common';
import FieldValueSuggestions from '../../../field_value_suggestions';
@@ -37,7 +37,9 @@ export function FilterValueButton({
nestedField,
allSelectedValues,
}: Props) {
- const { series } = useUrlStorage(seriesId);
+ const { getSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const { indexPattern } = useAppIndexPatternContext();
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/remove_series.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/remove_series.tsx
index ba2cdc545fbef..dc84352ff3b3d 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/remove_series.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/remove_series.tsx
@@ -8,14 +8,14 @@
import { i18n } from '@kbn/i18n';
import React from 'react';
import { EuiButtonIcon } from '@elastic/eui';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
interface Props {
seriesId: string;
}
export function RemoveSeries({ seriesId }: Props) {
- const { removeSeries } = useUrlStorage();
+ const { removeSeries } = useSeriesStorage();
const onClick = () => {
removeSeries(seriesId);
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_actions.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_actions.tsx
index cdc20e2d9ab6c..5374fc33093a1 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_actions.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_actions.tsx
@@ -9,14 +9,15 @@ import React from 'react';
import { EuiButtonIcon, EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { RemoveSeries } from './remove_series';
-import { NEW_SERIES_KEY, useUrlStorage } from '../../hooks/use_url_storage';
+import { NEW_SERIES_KEY, useSeriesStorage } from '../../hooks/use_series_storage';
import { ReportToDataTypeMap } from '../../configurations/constants';
interface Props {
seriesId: string;
}
export function SeriesActions({ seriesId }: Props) {
- const { series, removeSeries, setSeries } = useUrlStorage(seriesId);
+ const { getSeries, removeSeries, setSeries } = useSeriesStorage();
+ const series = getSeries(seriesId);
const onEdit = () => {
removeSeries(seriesId);
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_filter.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_filter.tsx
index 926852fda5cbc..9e5770c2de8f9 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_filter.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/columns/series_filter.tsx
@@ -19,7 +19,7 @@ import { FilterExpanded } from './filter_expanded';
import { DataSeries } from '../../types';
import { FieldLabels } from '../../configurations/constants/constants';
import { SelectedFilters } from '../selected_filters';
-import { useUrlStorage } from '../../hooks/use_url_storage';
+import { useSeriesStorage } from '../../hooks/use_series_storage';
interface Props {
seriesId: string;
@@ -53,7 +53,8 @@ export function SeriesFilter({ series, isNew, seriesId, defaultFilters = [] }: P
};
});
- const { setSeries, series: urlSeries } = useUrlStorage(seriesId);
+ const { setSeries, getSeries } = useSeriesStorage();
+ const urlSeries = getSeries(seriesId);
const button = (
);
+ render(, { initSeries });
await waitFor(() => {
screen.getByText('Chrome');
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.tsx
index aabb39f88507f..63abb581c9c72 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/selected_filters.tsx
@@ -7,7 +7,7 @@
import React, { Fragment } from 'react';
import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
-import { useUrlStorage } from '../hooks/use_url_storage';
+import { useSeriesStorage } from '../hooks/use_series_storage';
import { FilterLabel } from '../components/filter_label';
import { DataSeries, UrlFilter } from '../types';
import { useAppIndexPatternContext } from '../hooks/use_app_index_pattern';
@@ -20,7 +20,9 @@ interface Props {
isNew?: boolean;
}
export function SelectedFilters({ seriesId, isNew, series: dataSeries }: Props) {
- const { series } = useUrlStorage(seriesId);
+ const { getSeries } = useSeriesStorage();
+
+ const series = getSeries(seriesId);
const { reportDefinitions = {} } = series;
diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/series_editor.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/series_editor.tsx
index d883b854c88cb..6e513fcd2fec9 100644
--- a/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/series_editor.tsx
+++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/series_editor/series_editor.tsx
@@ -11,7 +11,7 @@ import { EuiBasicTable, EuiIcon, EuiSpacer, EuiText } from '@elastic/eui';
import { FormattedMessage } from '@kbn/i18n/react';
import { SeriesFilter } from './columns/series_filter';
import { DataSeries } from '../types';
-import { NEW_SERIES_KEY, useUrlStorage } from '../hooks/use_url_storage';
+import { NEW_SERIES_KEY, useSeriesStorage } from '../hooks/use_series_storage';
import { getDefaultConfigs } from '../configurations/default_configs';
import { DatePickerCol } from './columns/date_picker_col';
import { useAppIndexPatternContext } from '../hooks/use_app_index_pattern';
@@ -19,7 +19,7 @@ import { SeriesActions } from './columns/series_actions';
import { ChartEditOptions } from './chart_edit_options';
export function SeriesEditor() {
- const { allSeries, firstSeriesId } = useUrlStorage();
+ const { allSeries, firstSeriesId } = useSeriesStorage();
const columns = [
{
diff --git a/x-pack/plugins/security_solution/common/endpoint/constants.ts b/x-pack/plugins/security_solution/common/endpoint/constants.ts
index 1c0b09a4648e5..c85778f2f38fa 100644
--- a/x-pack/plugins/security_solution/common/endpoint/constants.ts
+++ b/x-pack/plugins/security_solution/common/endpoint/constants.ts
@@ -32,3 +32,6 @@ export const AGENT_POLICY_SUMMARY_ROUTE = `${BASE_POLICY_ROUTE}/summaries`;
/** Host Isolation Routes */
export const ISOLATE_HOST_ROUTE = `/api/endpoint/isolate`;
export const UNISOLATE_HOST_ROUTE = `/api/endpoint/unisolate`;
+
+/** Endpoint Actions Log Routes */
+export const ENDPOINT_ACTION_LOG_ROUTE = `/api/endpoint/action_log/{agent_id}`;
diff --git a/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts b/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts
index e8997158cdfad..32affddf46294 100644
--- a/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts
+++ b/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts
@@ -20,3 +20,11 @@ export const HostIsolationRequestSchema = {
comment: schema.maybe(schema.string()),
}),
};
+
+export const EndpointActionLogRequestSchema = {
+ // TODO improve when using pagination with query params
+ query: schema.object({}),
+ params: schema.object({
+ agent_id: schema.string(),
+ }),
+};
diff --git a/x-pack/plugins/security_solution/cypress/support/commands.js b/x-pack/plugins/security_solution/cypress/support/commands.js
index d9de00be0ea9e..90eb9a38d7509 100644
--- a/x-pack/plugins/security_solution/cypress/support/commands.js
+++ b/x-pack/plugins/security_solution/cypress/support/commands.js
@@ -31,62 +31,17 @@
// -- This is will overwrite an existing command --
// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })
-import { findIndex } from 'lodash/fp';
-
-const getFindRequestConfig = (searchStrategyName, factoryQueryType) => {
- if (!factoryQueryType) {
- return {
- options: { strategy: searchStrategyName },
- };
- }
-
- return {
- options: { strategy: searchStrategyName },
- request: { factoryQueryType },
- };
-};
-
Cypress.Commands.add(
'stubSearchStrategyApi',
function (stubObject, factoryQueryType, searchStrategyName = 'securitySolutionSearchStrategy') {
cy.intercept('POST', '/internal/bsearch', (req) => {
- const findRequestConfig = getFindRequestConfig(searchStrategyName, factoryQueryType);
- const requestIndex = findIndex(findRequestConfig, req.body.batch);
-
- if (requestIndex > -1) {
- return req.reply((res) => {
- const responseObjectsArray = res.body.split('\n').map((responseString) => {
- try {
- return JSON.parse(responseString);
- } catch {
- return responseString;
- }
- });
- const responseIndex = findIndex({ id: requestIndex }, responseObjectsArray);
-
- const stubbedResponseObjectsArray = [...responseObjectsArray];
- stubbedResponseObjectsArray[responseIndex] = {
- ...stubbedResponseObjectsArray[responseIndex],
- result: {
- ...stubbedResponseObjectsArray[responseIndex].result,
- ...stubObject,
- },
- };
-
- const stubbedResponse = stubbedResponseObjectsArray
- .map((object) => {
- try {
- return JSON.stringify(object);
- } catch {
- return object;
- }
- })
- .join('\n');
-
- res.send(stubbedResponse);
- });
+ if (searchStrategyName === 'securitySolutionIndexFields') {
+ req.reply(stubObject.rawResponse);
+ } else if (factoryQueryType === 'overviewHost') {
+ req.reply(stubObject.overviewHost);
+ } else if (factoryQueryType === 'overviewNetwork') {
+ req.reply(stubObject.overviewNetwork);
}
-
req.reply();
});
}
diff --git a/x-pack/plugins/security_solution/public/common/components/endpoint/formatted_date_time.tsx b/x-pack/plugins/security_solution/public/common/components/endpoint/formatted_date_time.tsx
index 2fdb7e99d860e..740437646f61a 100644
--- a/x-pack/plugins/security_solution/public/common/components/endpoint/formatted_date_time.tsx
+++ b/x-pack/plugins/security_solution/public/common/components/endpoint/formatted_date_time.tsx
@@ -8,10 +8,14 @@
import React from 'react';
import { FormattedDate, FormattedTime, FormattedRelative } from '@kbn/i18n/react';
-export const FormattedDateAndTime: React.FC<{ date: Date }> = ({ date }) => {
+export const FormattedDateAndTime: React.FC<{ date: Date; showRelativeTime?: boolean }> = ({
+ date,
+ showRelativeTime = false,
+}) => {
// If date is greater than or equal to 1h (ago), then show it as a date
+ // and if showRelativeTime is false
// else, show it as relative to "now"
- return Date.now() - date.getTime() >= 3.6e6 ? (
+ return Date.now() - date.getTime() >= 3.6e6 && !showRelativeTime ? (
<>
{' @'}
diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/index.tsx b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/index.tsx
index a31371c31cbbb..8a85d35d77fac 100644
--- a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/index.tsx
+++ b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/index.tsx
@@ -89,6 +89,7 @@ const StepRuleActionsComponent: FC = ({
...(defaultValues ?? stepActionsDefaultValue),
kibanaSiemAppUrl: kibanaAbsoluteUrl,
};
+
const schema = useMemo(() => getSchema({ actionTypeRegistry }), [actionTypeRegistry]);
const { form } = useForm({
defaultValue: initialState,
diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/schema.test.tsx b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/schema.test.tsx
index 992f30e795bbf..3266d6f61eeed 100644
--- a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/schema.test.tsx
+++ b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/schema.test.tsx
@@ -15,13 +15,13 @@ describe('stepRuleActions schema', () => {
const actionTypeRegistry = actionTypeRegistryMock.create();
describe('validateSingleAction', () => {
- it('should validate single action', () => {
+ it('should validate single action', async () => {
(isUuid as jest.Mock).mockReturnValue(true);
(validateActionParams as jest.Mock).mockReturnValue([]);
(validateMustache as jest.Mock).mockReturnValue([]);
expect(
- validateSingleAction(
+ await validateSingleAction(
{
id: '817b8bca-91d1-4729-8ee1-3a83aaafd9d4',
group: 'default',
@@ -33,12 +33,12 @@ describe('stepRuleActions schema', () => {
).toHaveLength(0);
});
- it('should validate single action with invalid mustache template', () => {
+ it('should validate single action with invalid mustache template', async () => {
(isUuid as jest.Mock).mockReturnValue(true);
(validateActionParams as jest.Mock).mockReturnValue([]);
(validateMustache as jest.Mock).mockReturnValue(['Message is not valid mustache template']);
- const errors = validateSingleAction(
+ const errors = await validateSingleAction(
{
id: '817b8bca-91d1-4729-8ee1-3a83aaafd9d4',
group: 'default',
@@ -54,12 +54,12 @@ describe('stepRuleActions schema', () => {
expect(errors[0]).toEqual('Message is not valid mustache template');
});
- it('should validate single action with incorrect id', () => {
+ it('should validate single action with incorrect id', async () => {
(isUuid as jest.Mock).mockReturnValue(false);
(validateMustache as jest.Mock).mockReturnValue([]);
(validateActionParams as jest.Mock).mockReturnValue([]);
- const errors = validateSingleAction(
+ const errors = await validateSingleAction(
{
id: '823d4',
group: 'default',
@@ -74,10 +74,10 @@ describe('stepRuleActions schema', () => {
});
describe('validateRuleActionsField', () => {
- it('should validate rule actions field', () => {
+ it('should validate rule actions field', async () => {
const validator = validateRuleActionsField(actionTypeRegistry);
- const result = validator({
+ const result = await validator({
path: '',
value: [],
form: {} as FormHook,
@@ -88,11 +88,11 @@ describe('stepRuleActions schema', () => {
expect(result).toEqual(undefined);
});
- it('should validate incorrect rule actions field', () => {
+ it('should validate incorrect rule actions field', async () => {
(getActionTypeName as jest.Mock).mockReturnValue('Slack');
const validator = validateRuleActionsField(actionTypeRegistry);
- const result = validator({
+ const result = await validator({
path: '',
value: [
{
@@ -117,7 +117,7 @@ describe('stepRuleActions schema', () => {
});
});
- it('should validate multiple incorrect rule actions field', () => {
+ it('should validate multiple incorrect rule actions field', async () => {
(isUuid as jest.Mock).mockReturnValueOnce(false);
(getActionTypeName as jest.Mock).mockReturnValueOnce('Slack');
(isUuid as jest.Mock).mockReturnValueOnce(true);
@@ -126,7 +126,7 @@ describe('stepRuleActions schema', () => {
(validateMustache as jest.Mock).mockReturnValue(['Component is not valid mustache template']);
const validator = validateRuleActionsField(actionTypeRegistry);
- const result = validator({
+ const result = await validator({
path: '',
value: [
{
diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/schema.tsx b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/schema.tsx
index bc32bdc387cd2..a697d922eda97 100644
--- a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/schema.tsx
+++ b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/schema.tsx
@@ -13,42 +13,46 @@ import {
AlertAction,
ActionTypeRegistryContract,
} from '../../../../../../triggers_actions_ui/public';
-import { FormSchema, ValidationFunc, ERROR_CODE } from '../../../../shared_imports';
+import {
+ FormSchema,
+ ValidationFunc,
+ ERROR_CODE,
+ ValidationError,
+} from '../../../../shared_imports';
import { ActionsStepRule } from '../../../pages/detection_engine/rules/types';
import * as I18n from './translations';
import { isUuid, getActionTypeName, validateMustache, validateActionParams } from './utils';
-export const validateSingleAction = (
+export const validateSingleAction = async (
actionItem: AlertAction,
actionTypeRegistry: ActionTypeRegistryContract
-): string[] => {
+): Promise => {
if (!isUuid(actionItem.id)) {
return [I18n.NO_CONNECTOR_SELECTED];
}
- const actionParamsErrors = validateActionParams(actionItem, actionTypeRegistry);
+ const actionParamsErrors = await validateActionParams(actionItem, actionTypeRegistry);
const mustacheErrors = validateMustache(actionItem.params);
return [...actionParamsErrors, ...mustacheErrors];
};
-export const validateRuleActionsField = (actionTypeRegistry: ActionTypeRegistryContract) => (
+export const validateRuleActionsField = (actionTypeRegistry: ActionTypeRegistryContract) => async (
...data: Parameters
-): ReturnType> | undefined => {
+): Promise | void | undefined> => {
const [{ value, path }] = data as [{ value: AlertAction[]; path: string }];
- const errors = value.reduce((acc, actionItem) => {
- const errorsArray = validateSingleAction(actionItem, actionTypeRegistry);
+ const errors = [];
+ for (const actionItem of value) {
+ const errorsArray = await validateSingleAction(actionItem, actionTypeRegistry);
if (errorsArray.length) {
const actionTypeName = getActionTypeName(actionItem.actionTypeId);
const errorsListItems = errorsArray.map((error) => `* ${error}\n`);
- return [...acc, `\n**${actionTypeName}:**\n${errorsListItems.join('')}`];
+ errors.push(`\n**${actionTypeName}:**\n${errorsListItems.join('')}`);
}
-
- return acc;
- }, [] as string[]);
+ }
if (errors.length) {
return {
diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/utils.test.ts b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/utils.test.ts
index 3d7299c1673b1..7c4ea71c983c8 100644
--- a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/utils.test.ts
+++ b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/utils.test.ts
@@ -61,11 +61,11 @@ describe('stepRuleActions utils', () => {
actionTypeRegistry.get.mockReturnValue(actionMock);
});
- it('should validate action params', () => {
+ it('should validate action params', async () => {
validateParamsMock.mockReturnValue({ errors: [] });
expect(
- validateActionParams(
+ await validateActionParams(
{
id: '817b8bca-91d1-4729-8ee1-3a83aaafd9d4',
group: 'default',
@@ -79,13 +79,13 @@ describe('stepRuleActions utils', () => {
).toHaveLength(0);
});
- it('should validate incorrect action params', () => {
+ it('should validate incorrect action params', async () => {
validateParamsMock.mockReturnValue({
errors: ['Message is required'],
});
expect(
- validateActionParams(
+ await validateActionParams(
{
id: '817b8bca-91d1-4729-8ee1-3a83aaafd9d4',
group: 'default',
@@ -97,7 +97,7 @@ describe('stepRuleActions utils', () => {
).toHaveLength(1);
});
- it('should validate incorrect action params and filter error objects', () => {
+ it('should validate incorrect action params and filter error objects', async () => {
validateParamsMock.mockReturnValue({
errors: [
{
@@ -107,7 +107,7 @@ describe('stepRuleActions utils', () => {
});
expect(
- validateActionParams(
+ await validateActionParams(
{
id: '817b8bca-91d1-4729-8ee1-3a83aaafd9d4',
group: 'default',
@@ -119,13 +119,13 @@ describe('stepRuleActions utils', () => {
).toHaveLength(0);
});
- it('should validate incorrect action params and filter duplicated errors', () => {
+ it('should validate incorrect action params and filter duplicated errors', async () => {
validateParamsMock.mockReturnValue({
errors: ['Message is required', 'Message is required', 'Message is required'],
});
expect(
- validateActionParams(
+ await validateActionParams(
{
id: '817b8bca-91d1-4729-8ee1-3a83aaafd9d4',
group: 'default',
diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/utils.ts b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/utils.ts
index d241d4283fc77..22363df5164a6 100644
--- a/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/utils.ts
+++ b/x-pack/plugins/security_solution/public/detections/components/rules/step_rule_actions/utils.ts
@@ -41,11 +41,11 @@ export const validateMustache = (params: AlertAction['params']) => {
return errors;
};
-export const validateActionParams = (
+export const validateActionParams = async (
actionItem: AlertAction,
actionTypeRegistry: ActionTypeRegistryContract
-): string[] => {
- const actionErrors = actionTypeRegistry
+): Promise => {
+ const actionErrors = await actionTypeRegistry
.get(actionItem.actionTypeId)
?.validateParams(actionItem.params);
diff --git a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/alerts/api.ts b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/alerts/api.ts
index 65185b4d05135..a7bd42c6af5ee 100644
--- a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/alerts/api.ts
+++ b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/alerts/api.ts
@@ -25,7 +25,7 @@ import {
UpdateAlertStatusProps,
CasesFromAlertsResponse,
} from './types';
-import { resolvePathVariables } from '../../../../management/pages/trusted_apps/service/utils';
+import { resolvePathVariables } from '../../../../management/common/utils';
import { isolateHost, unIsolateHost } from '../../../../common/lib/host_isolation';
/**
diff --git a/x-pack/plugins/security_solution/public/management/common/utils.test.ts b/x-pack/plugins/security_solution/public/management/common/utils.test.ts
index 59455ccd6bb04..8918261b6a436 100644
--- a/x-pack/plugins/security_solution/public/management/common/utils.test.ts
+++ b/x-pack/plugins/security_solution/public/management/common/utils.test.ts
@@ -5,7 +5,7 @@
* 2.0.
*/
-import { parseQueryFilterToKQL } from './utils';
+import { parseQueryFilterToKQL, resolvePathVariables } from './utils';
describe('utils', () => {
const searchableFields = [`name`, `description`, `entries.value`, `entries.entries.value`];
@@ -39,4 +39,39 @@ describe('utils', () => {
);
});
});
+
+ describe('resolvePathVariables', () => {
+ it('should resolve defined variables', () => {
+ expect(resolvePathVariables('/segment1/{var1}/segment2', { var1: 'value1' })).toBe(
+ '/segment1/value1/segment2'
+ );
+ });
+
+ it('should not resolve undefined variables', () => {
+ expect(resolvePathVariables('/segment1/{var1}/segment2', {})).toBe(
+ '/segment1/{var1}/segment2'
+ );
+ });
+
+ it('should ignore unused variables', () => {
+ expect(resolvePathVariables('/segment1/{var1}/segment2', { var2: 'value2' })).toBe(
+ '/segment1/{var1}/segment2'
+ );
+ });
+
+ it('should replace multiple variable occurences', () => {
+ expect(resolvePathVariables('/{var1}/segment1/{var1}', { var1: 'value1' })).toBe(
+ '/value1/segment1/value1'
+ );
+ });
+
+ it('should replace multiple variables', () => {
+ const path = resolvePathVariables('/{var1}/segment1/{var2}', {
+ var1: 'value1',
+ var2: 'value2',
+ });
+
+ expect(path).toBe('/value1/segment1/value2');
+ });
+ });
});
diff --git a/x-pack/plugins/security_solution/public/management/common/utils.ts b/x-pack/plugins/security_solution/public/management/common/utils.ts
index c8cf761ccaf86..78a95eb4d6f81 100644
--- a/x-pack/plugins/security_solution/public/management/common/utils.ts
+++ b/x-pack/plugins/security_solution/public/management/common/utils.ts
@@ -19,3 +19,8 @@ export const parseQueryFilterToKQL = (filter: string, fields: Readonly
return kuery;
};
+
+export const resolvePathVariables = (path: string, variables: { [K: string]: string | number }) =>
+ Object.keys(variables).reduce((acc, paramName) => {
+ return acc.replace(new RegExp(`\{${paramName}\}`, 'g'), String(variables[paramName]));
+ }, path);
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts
index d80a7d03903ac..25f2631ef46ff 100644
--- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts
@@ -37,7 +37,6 @@ export interface ServerFailedToReturnEndpointDetails {
type: 'serverFailedToReturnEndpointDetails';
payload: ServerApiError;
}
-
export interface ServerReturnedEndpointPolicyResponse {
type: 'serverReturnedEndpointPolicyResponse';
payload: GetHostPolicyResponse;
@@ -137,19 +136,24 @@ export interface ServerFailedToReturnEndpointsTotal {
payload: ServerApiError;
}
-type EndpointIsolationRequest = Action<'endpointIsolationRequest'> & {
+export type EndpointIsolationRequest = Action<'endpointIsolationRequest'> & {
payload: HostIsolationRequestBody;
};
-type EndpointIsolationRequestStateChange = Action<'endpointIsolationRequestStateChange'> & {
+export type EndpointIsolationRequestStateChange = Action<'endpointIsolationRequestStateChange'> & {
payload: EndpointState['isolationRequestState'];
};
+export type EndpointDetailsActivityLogChanged = Action<'endpointDetailsActivityLogChanged'> & {
+ payload: EndpointState['endpointDetails']['activityLog'];
+};
+
export type EndpointAction =
| ServerReturnedEndpointList
| ServerFailedToReturnEndpointList
| ServerReturnedEndpointDetails
| ServerFailedToReturnEndpointDetails
+ | EndpointDetailsActivityLogChanged
| ServerReturnedEndpointPolicyResponse
| ServerFailedToReturnEndpointPolicyResponse
| ServerReturnedPoliciesForOnboarding
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/builders.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/builders.ts
new file mode 100644
index 0000000000000..d5416d9f8ec96
--- /dev/null
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/builders.ts
@@ -0,0 +1,53 @@
+/*
+ * 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 { Immutable } from '../../../../../common/endpoint/types';
+import { DEFAULT_POLL_INTERVAL } from '../../../common/constants';
+import { createUninitialisedResourceState } from '../../../state';
+import { EndpointState } from '../types';
+
+export const initialEndpointPageState = (): Immutable => {
+ return {
+ hosts: [],
+ pageSize: 10,
+ pageIndex: 0,
+ total: 0,
+ loading: false,
+ error: undefined,
+ endpointDetails: {
+ activityLog: createUninitialisedResourceState(),
+ hostDetails: {
+ details: undefined,
+ detailsLoading: false,
+ detailsError: undefined,
+ },
+ },
+ policyResponse: undefined,
+ policyResponseLoading: false,
+ policyResponseError: undefined,
+ location: undefined,
+ policyItems: [],
+ selectedPolicyId: undefined,
+ policyItemsLoading: false,
+ endpointPackageInfo: undefined,
+ nonExistingPolicies: {},
+ agentPolicies: {},
+ endpointsExist: true,
+ patterns: [],
+ patternsError: undefined,
+ isAutoRefreshEnabled: true,
+ autoRefreshInterval: DEFAULT_POLL_INTERVAL,
+ agentsWithEndpointsTotal: 0,
+ agentsWithEndpointsTotalError: undefined,
+ endpointsTotal: 0,
+ endpointsTotalError: undefined,
+ queryStrategyVersion: undefined,
+ policyVersionInfo: undefined,
+ hostStatus: undefined,
+ isolationRequestState: createUninitialisedResourceState(),
+ };
+};
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/index.test.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/index.test.ts
index 79f0c5af9bbe3..5be67a3581c9e 100644
--- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/index.test.ts
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/index.test.ts
@@ -41,9 +41,16 @@ describe('EndpointList store concerns', () => {
total: 0,
loading: false,
error: undefined,
- details: undefined,
- detailsLoading: false,
- detailsError: undefined,
+ endpointDetails: {
+ activityLog: {
+ type: 'UninitialisedResourceState',
+ },
+ hostDetails: {
+ details: undefined,
+ detailsLoading: false,
+ detailsError: undefined,
+ },
+ },
policyResponse: undefined,
policyResponseLoading: false,
policyResponseError: undefined,
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.test.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.test.ts
index c52d922001887..04a04bc38996b 100644
--- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.test.ts
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.test.ts
@@ -18,6 +18,7 @@ import {
Immutable,
HostResultList,
HostIsolationResponse,
+ EndpointAction,
} from '../../../../../common/endpoint/types';
import { AppAction } from '../../../../common/store/actions';
import { mockEndpointResultList } from './mock_endpoint_result_list';
@@ -25,8 +26,9 @@ import { listData } from './selectors';
import { EndpointState } from '../types';
import { endpointListReducer } from './reducer';
import { endpointMiddlewareFactory } from './middleware';
-import { getEndpointListPath } from '../../../common/routing';
+import { getEndpointListPath, getEndpointDetailsPath } from '../../../common/routing';
import {
+ createLoadedResourceState,
FailedResourceState,
isFailedResourceState,
isLoadedResourceState,
@@ -39,6 +41,7 @@ import {
hostIsolationRequestBodyMock,
hostIsolationResponseMock,
} from '../../../../common/lib/host_isolation/mocks';
+import { FleetActionGenerator } from '../../../../../common/endpoint/data_generators/fleet_action_generator';
jest.mock('../../policy/store/services/ingest', () => ({
sendGetAgentConfigList: () => Promise.resolve({ items: [] }),
@@ -192,4 +195,65 @@ describe('endpoint list middleware', () => {
expect(failedAction.error).toBe(apiError);
});
});
+
+ describe('handle ActivityLog State Change actions', () => {
+ const endpointList = getEndpointListApiResponse();
+ const search = getEndpointDetailsPath({
+ name: 'endpointDetails',
+ selected_endpoint: endpointList.hosts[0].metadata.agent.id,
+ });
+ const dispatchUserChangedUrl = () => {
+ dispatch({
+ type: 'userChangedUrl',
+ payload: {
+ ...history.location,
+ pathname: '/endpoints',
+ search: `?${search.split('?').pop()}`,
+ },
+ });
+ };
+ const fleetActionGenerator = new FleetActionGenerator(Math.random().toString());
+ const activityLog = [
+ fleetActionGenerator.generate({
+ agents: [endpointList.hosts[0].metadata.agent.id],
+ }),
+ ];
+ const dispatchGetActivityLog = () => {
+ dispatch({
+ type: 'endpointDetailsActivityLogChanged',
+ payload: createLoadedResourceState(activityLog),
+ });
+ };
+
+ it('should set ActivityLog state to loading', async () => {
+ dispatchUserChangedUrl();
+
+ const loadingDispatched = waitForAction('endpointDetailsActivityLogChanged', {
+ validate(action) {
+ return isLoadingResourceState(action.payload);
+ },
+ });
+
+ const loadingDispatchedResponse = await loadingDispatched;
+ expect(loadingDispatchedResponse.payload.type).toEqual('LoadingResourceState');
+ });
+
+ it('should set ActivityLog state to loaded when fetching activity log is successful', async () => {
+ dispatchUserChangedUrl();
+
+ const loadedDispatched = waitForAction('endpointDetailsActivityLogChanged', {
+ validate(action) {
+ return isLoadedResourceState(action.payload);
+ },
+ });
+
+ dispatchGetActivityLog();
+ const loadedDispatchedResponse = await loadedDispatched;
+ const activityLogData = (loadedDispatchedResponse.payload as LoadedResourceState<
+ EndpointAction[]
+ >).data;
+
+ expect(activityLogData).toEqual(activityLog);
+ });
+ });
});
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts
index 9db9932dd4387..90427d5003384 100644
--- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts
@@ -7,6 +7,7 @@
import { HttpStart } from 'kibana/public';
import {
+ EndpointAction,
HostInfo,
HostIsolationRequestBody,
HostIsolationResponse,
@@ -18,6 +19,7 @@ import { ImmutableMiddlewareAPI, ImmutableMiddlewareFactory } from '../../../../
import {
isOnEndpointPage,
hasSelectedEndpoint,
+ selectedAgent,
uiQueryParams,
listData,
endpointPackageInfo,
@@ -27,6 +29,7 @@ import {
isTransformEnabled,
getIsIsolationRequestPending,
getCurrentIsolationRequestState,
+ getActivityLogData,
} from './selectors';
import { EndpointState, PolicyIds } from '../types';
import {
@@ -37,12 +40,13 @@ import {
} from '../../policy/store/services/ingest';
import { AGENT_POLICY_SAVED_OBJECT_TYPE } from '../../../../../../fleet/common';
import {
+ ENDPOINT_ACTION_LOG_ROUTE,
HOST_METADATA_GET_API,
HOST_METADATA_LIST_API,
metadataCurrentIndexPattern,
} from '../../../../../common/endpoint/constants';
import { IIndexPattern, Query } from '../../../../../../../../src/plugins/data/public';
-import { resolvePathVariables } from '../../trusted_apps/service/utils';
+import { resolvePathVariables } from '../../../common/utils';
import {
createFailedResourceState,
createLoadedResourceState,
@@ -336,6 +340,29 @@ export const endpointMiddlewareFactory: ImmutableMiddlewareFactory(getActivityLogData(getState())),
+ });
+
+ try {
+ const activityLog = await coreStart.http.get(
+ resolvePathVariables(ENDPOINT_ACTION_LOG_ROUTE, { agent_id: selectedAgent(getState()) })
+ );
+ dispatch({
+ type: 'endpointDetailsActivityLogChanged',
+ payload: createLoadedResourceState(activityLog),
+ });
+ } catch (error) {
+ dispatch({
+ type: 'endpointDetailsActivityLogChanged',
+ payload: createFailedResourceState(error.body ?? error),
+ });
+ }
+
// call the policy response api
try {
const policyResponse = await coreStart.http.get(`/api/endpoint/policy_response`, {
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/reducer.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/reducer.ts
index b2b46e6de9842..19235b792b270 100644
--- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/reducer.ts
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/reducer.ts
@@ -5,6 +5,7 @@
* 2.0.
*/
+import { EndpointDetailsActivityLogChanged } from './action';
import {
isOnEndpointPage,
hasSelectedEndpoint,
@@ -12,52 +13,33 @@ import {
getCurrentIsolationRequestState,
} from './selectors';
import { EndpointState } from '../types';
+import { initialEndpointPageState } from './builders';
import { AppAction } from '../../../../common/store/actions';
import { ImmutableReducer } from '../../../../common/store';
import { Immutable } from '../../../../../common/endpoint/types';
-import { DEFAULT_POLL_INTERVAL } from '../../../common/constants';
import { createUninitialisedResourceState, isUninitialisedResourceState } from '../../../state';
-export const initialEndpointListState: Immutable = {
- hosts: [],
- pageSize: 10,
- pageIndex: 0,
- total: 0,
- loading: false,
- error: undefined,
- details: undefined,
- detailsLoading: false,
- detailsError: undefined,
- policyResponse: undefined,
- policyResponseLoading: false,
- policyResponseError: undefined,
- location: undefined,
- policyItems: [],
- selectedPolicyId: undefined,
- policyItemsLoading: false,
- endpointPackageInfo: undefined,
- nonExistingPolicies: {},
- agentPolicies: {},
- endpointsExist: true,
- patterns: [],
- patternsError: undefined,
- isAutoRefreshEnabled: true,
- autoRefreshInterval: DEFAULT_POLL_INTERVAL,
- agentsWithEndpointsTotal: 0,
- agentsWithEndpointsTotalError: undefined,
- endpointsTotal: 0,
- endpointsTotalError: undefined,
- queryStrategyVersion: undefined,
- policyVersionInfo: undefined,
- hostStatus: undefined,
- isolationRequestState: createUninitialisedResourceState(),
-};
+type StateReducer = ImmutableReducer;
+type CaseReducer = (
+ state: Immutable,
+ action: Immutable
+) => Immutable;
-/* eslint-disable-next-line complexity */
-export const endpointListReducer: ImmutableReducer = (
- state = initialEndpointListState,
+const handleEndpointDetailsActivityLogChanged: CaseReducer = (
+ state,
action
) => {
+ return {
+ ...state!,
+ endpointDetails: {
+ ...state.endpointDetails!,
+ activityLog: action.payload,
+ },
+ };
+};
+
+/* eslint-disable-next-line complexity */
+export const endpointListReducer: StateReducer = (state = initialEndpointPageState(), action) => {
if (action.type === 'serverReturnedEndpointList') {
const {
hosts,
@@ -115,18 +97,32 @@ export const endpointListReducer: ImmutableReducer = (
} else if (action.type === 'serverReturnedEndpointDetails') {
return {
...state,
- details: action.payload.metadata,
+ endpointDetails: {
+ ...state.endpointDetails,
+ hostDetails: {
+ ...state.endpointDetails.hostDetails,
+ details: action.payload.metadata,
+ detailsLoading: false,
+ detailsError: undefined,
+ },
+ },
policyVersionInfo: action.payload.policy_info,
hostStatus: action.payload.host_status,
- detailsLoading: false,
- detailsError: undefined,
};
} else if (action.type === 'serverFailedToReturnEndpointDetails') {
return {
...state,
- detailsError: action.payload,
- detailsLoading: false,
+ endpointDetails: {
+ ...state.endpointDetails,
+ hostDetails: {
+ ...state.endpointDetails.hostDetails,
+ detailsError: action.payload,
+ detailsLoading: false,
+ },
+ },
};
+ } else if (action.type === 'endpointDetailsActivityLogChanged') {
+ return handleEndpointDetailsActivityLogChanged(state, action);
} else if (action.type === 'serverReturnedPoliciesForOnboarding') {
return {
...state,
@@ -221,7 +217,6 @@ export const endpointListReducer: ImmutableReducer = (
const stateUpdates: Partial = {
location: action.payload,
error: undefined,
- detailsError: undefined,
policyResponseError: undefined,
};
@@ -239,6 +234,13 @@ export const endpointListReducer: ImmutableReducer = (
return {
...state,
...stateUpdates,
+ endpointDetails: {
+ ...state.endpointDetails,
+ hostDetails: {
+ ...state.endpointDetails.hostDetails,
+ detailsError: undefined,
+ },
+ },
loading: true,
policyItemsLoading: true,
};
@@ -249,6 +251,14 @@ export const endpointListReducer: ImmutableReducer = (
return {
...state,
...stateUpdates,
+ endpointDetails: {
+ ...state.endpointDetails,
+ hostDetails: {
+ ...state.endpointDetails.hostDetails,
+ detailsLoading: true,
+ detailsError: undefined,
+ },
+ },
detailsLoading: true,
policyResponseLoading: true,
};
@@ -257,8 +267,15 @@ export const endpointListReducer: ImmutableReducer = (
return {
...state,
...stateUpdates,
+ endpointDetails: {
+ ...state.endpointDetails,
+ hostDetails: {
+ ...state.endpointDetails.hostDetails,
+ detailsLoading: true,
+ detailsError: undefined,
+ },
+ },
loading: true,
- detailsLoading: true,
policyResponseLoading: true,
policyItemsLoading: true,
};
@@ -268,6 +285,13 @@ export const endpointListReducer: ImmutableReducer = (
return {
...state,
...stateUpdates,
+ endpointDetails: {
+ ...state.endpointDetails,
+ hostDetails: {
+ ...state.endpointDetails.hostDetails,
+ detailsError: undefined,
+ },
+ },
endpointsExist: true,
};
}
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/selectors.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/selectors.ts
index af95d89fdc10b..8b6599611ffc4 100644
--- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/selectors.ts
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/selectors.ts
@@ -45,11 +45,16 @@ export const listLoading = (state: Immutable): boolean => state.l
export const listError = (state: Immutable) => state.error;
-export const detailsData = (state: Immutable) => state.details;
+export const detailsData = (state: Immutable) =>
+ state.endpointDetails.hostDetails.details;
-export const detailsLoading = (state: Immutable): boolean => state.detailsLoading;
+export const detailsLoading = (state: Immutable): boolean =>
+ state.endpointDetails.hostDetails.detailsLoading;
-export const detailsError = (state: Immutable) => state.detailsError;
+export const detailsError = (
+ state: Immutable
+): EndpointState['endpointDetails']['hostDetails']['detailsError'] =>
+ state.endpointDetails.hostDetails.detailsError;
export const policyItems = (state: Immutable) => state.policyItems;
@@ -209,7 +214,12 @@ export const uiQueryParams: (
if (value !== undefined) {
if (key === 'show') {
- if (value === 'policy_response' || value === 'details' || value === 'isolate') {
+ if (
+ value === 'policy_response' ||
+ value === 'details' ||
+ value === 'activity_log' ||
+ value === 'isolate'
+ ) {
data[key] = value;
}
} else {
@@ -240,6 +250,19 @@ export const showView: (
return searchParams.show ?? 'details';
});
+/**
+ * Returns the selected endpoint's elastic agent Id
+ * used for fetching endpoint actions log
+ */
+export const selectedAgent = (state: Immutable): string => {
+ const hostList = state.hosts;
+ const { selected_endpoint: selectedEndpoint } = uiQueryParams(state);
+ return (
+ hostList.find((host) => host.metadata.agent.id === selectedEndpoint)?.metadata.elastic.agent
+ .id || ''
+ );
+};
+
/**
* Returns the Host Status which is connected the fleet agent
*/
@@ -331,3 +354,27 @@ export const getIsolationRequestError: (
return isolateHost.error;
}
});
+
+export const getActivityLogData = (
+ state: Immutable
+): Immutable => state.endpointDetails.activityLog;
+
+export const getActivityLogRequestLoading: (
+ state: Immutable
+) => boolean = createSelector(getActivityLogData, (activityLog) =>
+ isLoadingResourceState(activityLog)
+);
+
+export const getActivityLogRequestLoaded: (
+ state: Immutable
+) => boolean = createSelector(getActivityLogData, (activityLog) =>
+ isLoadedResourceState(activityLog)
+);
+
+export const getActivityLogError: (
+ state: Immutable
+) => ServerApiError | undefined = createSelector(getActivityLogData, (activityLog) => {
+ if (isFailedResourceState(activityLog)) {
+ return activityLog.error;
+ }
+});
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts
index 74eee0602722b..ac06f98004f59 100644
--- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts
@@ -14,6 +14,7 @@ import {
PolicyData,
MetadataQueryStrategyVersions,
HostStatus,
+ EndpointAction,
HostIsolationResponse,
} from '../../../../common/endpoint/types';
import { ServerApiError } from '../../../common/types';
@@ -34,12 +35,17 @@ export interface EndpointState {
loading: boolean;
/** api error from retrieving host list */
error?: ServerApiError;
- /** details data for a specific host */
- details?: Immutable;
- /** details page is retrieving data */
- detailsLoading: boolean;
- /** api error from retrieving host details */
- detailsError?: ServerApiError;
+ endpointDetails: {
+ activityLog: AsyncResourceState;
+ hostDetails: {
+ /** details data for a specific host */
+ details?: Immutable;
+ /** details page is retrieving data */
+ detailsLoading: boolean;
+ /** api error from retrieving host details */
+ detailsError?: ServerApiError;
+ };
+ };
/** Holds the Policy Response for the Host currently being displayed in the details */
policyResponse?: HostPolicyResponse;
/** policyResponse is being retrieved */
@@ -108,7 +114,7 @@ export interface EndpointIndexUIQueryParams {
/** Which page to show */
page_index?: string;
/** show the policy response or host details */
- show?: 'policy_response' | 'details' | 'isolate';
+ show?: 'policy_response' | 'activity_log' | 'details' | 'isolate';
/** Query text from search bar*/
admin_query?: string;
}
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/endpoint_details_tabs.tsx b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/endpoint_details_tabs.tsx
new file mode 100644
index 0000000000000..3e228be4565b1
--- /dev/null
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/endpoint_details_tabs.tsx
@@ -0,0 +1,78 @@
+/*
+ * 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 React, { memo, useCallback, useMemo, useState } from 'react';
+import styled from 'styled-components';
+import { EuiTabbedContent, EuiTabbedContentTab } from '@elastic/eui';
+import { EndpointIndexUIQueryParams } from '../../../types';
+export enum EndpointDetailsTabsTypes {
+ overview = 'overview',
+ activityLog = 'activity_log',
+}
+
+export type EndpointDetailsTabsId =
+ | EndpointDetailsTabsTypes.overview
+ | EndpointDetailsTabsTypes.activityLog;
+
+interface EndpointDetailsTabs {
+ id: string;
+ name: string;
+ content: JSX.Element;
+}
+
+const StyledEuiTabbedContent = styled(EuiTabbedContent)`
+ overflow: hidden;
+ padding-bottom: ${(props) => props.theme.eui.paddingSizes.xl};
+
+ > [role='tabpanel'] {
+ height: 100%;
+ padding-right: 12px;
+ overflow: hidden;
+ overflow-y: auto;
+ ::-webkit-scrollbar {
+ -webkit-appearance: none;
+ width: 4px;
+ }
+ ::-webkit-scrollbar-thumb {
+ border-radius: 2px;
+ background-color: rgba(0, 0, 0, 0.5);
+ -webkit-box-shadow: 0 0 1px rgba(255, 255, 255, 0.5);
+ }
+ }
+`;
+
+export const EndpointDetailsFlyoutTabs = memo(
+ ({ show, tabs }: { show: EndpointIndexUIQueryParams['show']; tabs: EndpointDetailsTabs[] }) => {
+ const [selectedTabId, setSelectedTabId] = useState(() => {
+ return show === 'details'
+ ? EndpointDetailsTabsTypes.overview
+ : EndpointDetailsTabsTypes.activityLog;
+ });
+
+ const handleTabClick = useCallback(
+ (tab: EuiTabbedContentTab) => setSelectedTabId(tab.id as EndpointDetailsTabsId),
+ [setSelectedTabId]
+ );
+
+ const selectedTab = useMemo(() => tabs.find((tab) => tab.id === selectedTabId), [
+ tabs,
+ selectedTabId,
+ ]);
+
+ return (
+
+ );
+ }
+);
+
+EndpointDetailsFlyoutTabs.displayName = 'EndpointDetailsFlyoutTabs';
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/log_entry.tsx b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/log_entry.tsx
new file mode 100644
index 0000000000000..de6d2ecf36ecc
--- /dev/null
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/log_entry.tsx
@@ -0,0 +1,57 @@
+/*
+ * 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 React, { memo } from 'react';
+
+import { EuiAvatar, EuiComment, EuiText } from '@elastic/eui';
+import { Immutable, EndpointAction } from '../../../../../../../common/endpoint/types';
+import { FormattedDateAndTime } from '../../../../../../common/components/endpoint/formatted_date_time';
+import { useEuiTheme } from '../../../../../../common/lib/theme/use_eui_theme';
+
+export const LogEntry = memo(
+ ({ endpointAction }: { endpointAction: Immutable }) => {
+ const euiTheme = useEuiTheme();
+ const isIsolated = endpointAction?.data.command === 'isolate';
+
+ // do this better when we can distinguish between endpoint events vs user events
+ const iconType = endpointAction.user_id === 'sys' ? 'dot' : isIsolated ? 'lock' : 'lockOpen';
+ const commentType = endpointAction.user_id === 'sys' ? 'update' : 'regular';
+ const timelineIcon = (
+
+ );
+ const event = `${isIsolated ? 'isolated' : 'unisolated'} host`;
+ const hasComment = !!endpointAction.data.comment;
+
+ return (
+
+ {hasComment ? (
+
+ {endpointAction.data.comment}
+
+ ) : undefined}
+
+ );
+ }
+);
+
+LogEntry.displayName = 'LogEntry';
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/endpoint_activity_log.tsx b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/endpoint_activity_log.tsx
new file mode 100644
index 0000000000000..50c91730e332c
--- /dev/null
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/endpoint_activity_log.tsx
@@ -0,0 +1,45 @@
+/*
+ * 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 React, { memo, useCallback } from 'react';
+
+import { EuiEmptyPrompt, EuiSpacer } from '@elastic/eui';
+import { LogEntry } from './components/log_entry';
+import * as i18 from '../translations';
+import { SearchBar } from '../../../../components/search_bar';
+import { Immutable, EndpointAction } from '../../../../../../common/endpoint/types';
+import { AsyncResourceState } from '../../../../state';
+
+export const EndpointActivityLog = memo(
+ ({ endpointActions }: { endpointActions: AsyncResourceState> }) => {
+ // TODO
+ const onSearch = useCallback(() => {}, []);
+ return (
+ <>
+
+ {endpointActions.type !== 'LoadedResourceState' || !endpointActions.data.length ? (
+ {'No logged actions'}}
+ body={{'No actions have been logged for this endpoint.'}
}
+ />
+ ) : (
+ <>
+
+
+ {endpointActions.data.map((endpointAction) => (
+
+ ))}
+
+ )}
+
+ );
+ }
+);
+
+EndpointActivityLog.displayName = 'EndpointActivityLog';
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/endpoint_details.tsx b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/endpoint_details.tsx
index c9db78f425afa..16cae79d42c0f 100644
--- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/endpoint_details.tsx
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/endpoint_details.tsx
@@ -258,6 +258,7 @@ export const EndpointDetails = memo(
return (
<>
+
> => ({
+ type: 'LoadedResourceState',
+ data: [
+ {
+ action_id: '1',
+ '@timestamp': moment().subtract(1, 'hours').fromNow().toString(),
+ expiration: moment().add(3, 'day').fromNow().toString(),
+ type: 'INPUT_ACTION',
+ input_type: 'endpoint',
+ agents: [`${selectedEndpoint}`],
+ user_id: 'sys',
+ data: {
+ command: 'isolate',
+ },
+ },
+ {
+ action_id: '2',
+ '@timestamp': moment().subtract(2, 'hours').fromNow().toString(),
+ expiration: moment().add(1, 'day').fromNow().toString(),
+ type: 'INPUT_ACTION',
+ input_type: 'endpoint',
+ agents: [`${selectedEndpoint}`],
+ user_id: 'ash',
+ data: {
+ command: 'isolate',
+ comment: 'Sem et tortor consequat id porta nibh venenatis cras sed.',
+ },
+ },
+ {
+ action_id: '3',
+ '@timestamp': moment().subtract(4, 'hours').fromNow().toString(),
+ expiration: moment().add(1, 'day').fromNow().toString(),
+ type: 'INPUT_ACTION',
+ input_type: 'endpoint',
+ agents: [`${selectedEndpoint}`],
+ user_id: 'someone',
+ data: {
+ command: 'unisolate',
+ comment: 'Turpis egestas pretium aenean pharetra.',
+ },
+ },
+ {
+ action_id: '4',
+ '@timestamp': moment().subtract(1, 'day').fromNow().toString(),
+ expiration: moment().add(3, 'day').fromNow().toString(),
+ type: 'INPUT_ACTION',
+ input_type: 'endpoint',
+ agents: [`${selectedEndpoint}`],
+ user_id: 'ash',
+ data: {
+ command: 'isolate',
+ comment:
+ 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, \
+ sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',
+ },
+ },
+ ],
+});
+
+export default {
+ title: 'Endpoints/Endpoint Details',
+ component: EndpointDetailsFlyout,
+ decorators: [
+ (Story: ComponentType) => (
+
+
+
+ ),
+ ],
+};
+
+export const Tabs = () => (
+ {'Endpoint Details'},
+ },
+ {
+ id: 'activity_log',
+ name: 'Activity Log',
+ content: ActivityLog(),
+ },
+ ]}
+ />
+);
+
+export const ActivityLog = () => (
+
+);
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/index.tsx b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/index.tsx
index 09b1bbceef21d..8d985f3a4cfe2 100644
--- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/index.tsx
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/index.tsx
@@ -5,7 +5,8 @@
* 2.0.
*/
-import React, { useCallback, useEffect, memo } from 'react';
+import React, { useCallback, useEffect, useMemo, memo } from 'react';
+import styled from 'styled-components';
import {
EuiFlyout,
EuiFlyoutBody,
@@ -16,6 +17,8 @@ import {
EuiSpacer,
EuiEmptyPrompt,
EuiToolTip,
+ EuiFlexGroup,
+ EuiFlexItem,
} from '@elastic/eui';
import { useHistory } from 'react-router-dom';
import { FormattedMessage } from '@kbn/i18n/react';
@@ -26,8 +29,11 @@ import {
uiQueryParams,
detailsData,
detailsError,
- showView,
detailsLoading,
+ getActivityLogData,
+ getActivityLogError,
+ getActivityLogRequestLoading,
+ showView,
policyResponseConfigurations,
policyResponseActions,
policyResponseFailedOrWarningActionCount,
@@ -39,14 +45,36 @@ import {
policyResponseAppliedRevision,
} from '../../store/selectors';
import { EndpointDetails } from './endpoint_details';
+import { EndpointActivityLog } from './endpoint_activity_log';
import { PolicyResponse } from './policy_response';
+import * as i18 from '../translations';
import { HostMetadata } from '../../../../../../common/endpoint/types';
+import {
+ EndpointDetailsFlyoutTabs,
+ EndpointDetailsTabsTypes,
+} from './components/endpoint_details_tabs';
+
import { PreferenceFormattedDateFromPrimitive } from '../../../../../common/components/formatted_date';
import { EndpointIsolateFlyoutPanel } from './components/endpoint_isolate_flyout_panel';
import { BackToEndpointDetailsFlyoutSubHeader } from './components/back_to_endpoint_details_flyout_subheader';
import { FlyoutBodyNoTopPadding } from './components/flyout_body_no_top_padding';
import { getEndpointListPath } from '../../../../common/routing';
+const DetailsFlyoutBody = styled(EuiFlyoutBody)`
+ overflow-y: hidden;
+ flex: 1;
+
+ .euiFlyoutBody__overflow {
+ overflow: hidden;
+ mask-image: none;
+ }
+
+ .euiFlyoutBody__overflowContent {
+ height: 100%;
+ display: flex;
+ }
+`;
+
export const EndpointDetailsFlyout = memo(() => {
const history = useHistory();
const toasts = useToasts();
@@ -55,13 +83,51 @@ export const EndpointDetailsFlyout = memo(() => {
selected_endpoint: selectedEndpoint,
...queryParamsWithoutSelectedEndpoint
} = queryParams;
- const details = useEndpointSelector(detailsData);
+
+ const activityLog = useEndpointSelector(getActivityLogData);
+ const activityLoading = useEndpointSelector(getActivityLogRequestLoading);
+ const activityError = useEndpointSelector(getActivityLogError);
+ const hostDetails = useEndpointSelector(detailsData);
+ const hostDetailsLoading = useEndpointSelector(detailsLoading);
+ const hostDetailsError = useEndpointSelector(detailsError);
+
const policyInfo = useEndpointSelector(policyVersionInfo);
const hostStatus = useEndpointSelector(hostStatusInfo);
- const loading = useEndpointSelector(detailsLoading);
- const error = useEndpointSelector(detailsError);
const show = useEndpointSelector(showView);
+ const ContentLoadingMarkup = useMemo(
+ () => (
+ <>
+
+
+
+
+ ),
+ []
+ );
+
+ const tabs = [
+ {
+ id: EndpointDetailsTabsTypes.overview,
+ name: i18.OVERVIEW,
+ content:
+ hostDetails === undefined ? (
+ ContentLoadingMarkup
+ ) : (
+
+ ),
+ },
+ {
+ id: EndpointDetailsTabsTypes.activityLog,
+ name: i18.ACTIVITY_LOG,
+ content: activityLoading ? (
+ ContentLoadingMarkup
+ ) : (
+
+ ),
+ },
+ ];
+
const handleFlyoutClose = useCallback(() => {
const { show: _show, ...urlSearchParams } = queryParamsWithoutSelectedEndpoint;
history.push(
@@ -73,7 +139,7 @@ export const EndpointDetailsFlyout = memo(() => {
}, [history, queryParamsWithoutSelectedEndpoint]);
useEffect(() => {
- if (error !== undefined) {
+ if (hostDetailsError !== undefined) {
toasts.addDanger({
title: i18n.translate('xpack.securitySolution.endpoint.details.errorTitle', {
defaultMessage: 'Could not find host',
@@ -83,7 +149,17 @@ export const EndpointDetailsFlyout = memo(() => {
}),
});
}
- }, [error, toasts]);
+ if (activityError !== undefined) {
+ toasts.addDanger({
+ title: i18n.translate('xpack.securitySolution.endpoint.activityLog.errorTitle', {
+ defaultMessage: 'Could not find activity log for host',
+ }),
+ text: i18n.translate('xpack.securitySolution.endpoint.activityLog.errorBody', {
+ defaultMessage: 'Please exit the flyout and select another host with actions.',
+ }),
+ });
+ }
+ }, [hostDetailsError, activityError, toasts]);
return (
{
style={{ zIndex: 4001 }}
data-test-subj="endpointDetailsFlyout"
size="m"
+ paddingSize="m"
>
- {loading ? (
+ {hostDetailsLoading || activityLoading ? (
) : (
-
+
- {details?.host?.hostname}
+ {hostDetails?.host?.hostname}
)}
- {details === undefined ? (
+ {hostDetails === undefined ? (
) : (
<>
- {show === 'details' && (
-
-
-
+ {(show === 'details' || show === 'activity_log') && (
+
+
+
+
+
+
+
)}
- {show === 'policy_response' && }
+ {show === 'policy_response' && }
- {show === 'isolate' && }
+ {show === 'isolate' && }
)}
diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/translations.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/translations.ts
new file mode 100644
index 0000000000000..fd2806713183b
--- /dev/null
+++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/translations.ts
@@ -0,0 +1,23 @@
+/*
+ * 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 { i18n } from '@kbn/i18n';
+
+export const OVERVIEW = i18n.translate('xpack.securitySolution.endpointDetails.overview', {
+ defaultMessage: 'Overview',
+});
+
+export const ACTIVITY_LOG = i18n.translate('xpack.securitySolution.endpointDetails.activityLog', {
+ defaultMessage: 'Activity Log',
+});
+
+export const SEARCH_ACTIVITY_LOG = i18n.translate(
+ 'xpack.securitySolution.endpointDetails.activityLog.search',
+ {
+ defaultMessage: 'Search activity log',
+ }
+);
diff --git a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/index.ts b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/index.ts
index 5f572251daeda..01bccc81b5063 100644
--- a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/index.ts
+++ b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/index.ts
@@ -30,7 +30,7 @@ import {
GetOneTrustedAppResponse,
} from '../../../../../common/endpoint/types/trusted_apps';
-import { resolvePathVariables } from './utils';
+import { resolvePathVariables } from '../../../common/utils';
import { sendGetEndpointSpecificPackagePolicies } from '../../policy/store/services/ingest';
export interface TrustedAppsService {
diff --git a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/utils.test.ts b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/utils.test.ts
deleted file mode 100644
index c2067f9d0848f..0000000000000
--- a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/utils.test.ts
+++ /dev/null
@@ -1,45 +0,0 @@
-/*
- * 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 { resolvePathVariables } from './utils';
-
-describe('utils', () => {
- describe('resolvePathVariables', () => {
- it('should resolve defined variables', () => {
- expect(resolvePathVariables('/segment1/{var1}/segment2', { var1: 'value1' })).toBe(
- '/segment1/value1/segment2'
- );
- });
-
- it('should not resolve undefined variables', () => {
- expect(resolvePathVariables('/segment1/{var1}/segment2', {})).toBe(
- '/segment1/{var1}/segment2'
- );
- });
-
- it('should ignore unused variables', () => {
- expect(resolvePathVariables('/segment1/{var1}/segment2', { var2: 'value2' })).toBe(
- '/segment1/{var1}/segment2'
- );
- });
-
- it('should replace multiple variable occurences', () => {
- expect(resolvePathVariables('/{var1}/segment1/{var1}', { var1: 'value1' })).toBe(
- '/value1/segment1/value1'
- );
- });
-
- it('should replace multiple variables', () => {
- const path = resolvePathVariables('/{var1}/segment1/{var2}', {
- var1: 'value1',
- var2: 'value2',
- });
-
- expect(path).toBe('/value1/segment1/value2');
- });
- });
-});
diff --git a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/utils.ts b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/utils.ts
deleted file mode 100644
index 89067e575665d..0000000000000
--- a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/utils.ts
+++ /dev/null
@@ -1,11 +0,0 @@
-/*
- * 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.
- */
-
-export const resolvePathVariables = (path: string, variables: { [K: string]: string | number }) =>
- Object.keys(variables).reduce((acc, paramName) => {
- return acc.replace(new RegExp(`\{${paramName}\}`, 'g'), String(variables[paramName]));
- }, path);
diff --git a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/trusted_apps_page.test.tsx b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/trusted_apps_page.test.tsx
index 3f02d505daea1..dc0032243312f 100644
--- a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/trusted_apps_page.test.tsx
+++ b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/trusted_apps_page.test.tsx
@@ -31,7 +31,7 @@ import {
import { EndpointDocGenerator } from '../../../../../common/endpoint/generate_data';
import { isFailedResourceState, isLoadedResourceState } from '../state';
import { forceHTMLElementOffsetWidth } from './components/effected_policy_select/test_utils';
-import { resolvePathVariables } from '../service/utils';
+import { resolvePathVariables } from '../../../common/utils';
import { toUpdateTrustedApp } from '../../../../../common/endpoint/service/trusted_apps/to_update_trusted_app';
import { useIsExperimentalFeatureEnabled } from '../../../../common/hooks/use_experimental_features';
diff --git a/x-pack/plugins/security_solution/public/management/store/reducer.ts b/x-pack/plugins/security_solution/public/management/store/reducer.ts
index bf8cd416a3e39..25c7c87c6f5c9 100644
--- a/x-pack/plugins/security_solution/public/management/store/reducer.ts
+++ b/x-pack/plugins/security_solution/public/management/store/reducer.ts
@@ -19,14 +19,12 @@ import {
import { ImmutableCombineReducers } from '../../common/store';
import { Immutable } from '../../../common/endpoint/types';
import { ManagementState } from '../types';
-import {
- endpointListReducer,
- initialEndpointListState,
-} from '../pages/endpoint_hosts/store/reducer';
+import { endpointListReducer } from '../pages/endpoint_hosts/store/reducer';
import { initialTrustedAppsPageState } from '../pages/trusted_apps/store/builders';
import { trustedAppsPageReducer } from '../pages/trusted_apps/store/reducer';
import { initialEventFiltersPageState } from '../pages/event_filters/store/builders';
import { eventFiltersPageReducer } from '../pages/event_filters/store/reducer';
+import { initialEndpointPageState } from '../pages/endpoint_hosts/store/builders';
const immutableCombineReducers: ImmutableCombineReducers = combineReducers;
@@ -35,7 +33,7 @@ const immutableCombineReducers: ImmutableCombineReducers = combineReducers;
*/
export const mockManagementState: Immutable = {
[MANAGEMENT_STORE_POLICY_DETAILS_NAMESPACE]: initialPolicyDetailsState(),
- [MANAGEMENT_STORE_ENDPOINTS_NAMESPACE]: initialEndpointListState,
+ [MANAGEMENT_STORE_ENDPOINTS_NAMESPACE]: initialEndpointPageState(),
[MANAGEMENT_STORE_TRUSTED_APPS_NAMESPACE]: initialTrustedAppsPageState(),
[MANAGEMENT_STORE_EVENT_FILTERS_NAMESPACE]: initialEventFiltersPageState(),
};
diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/audit_log.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/audit_log.ts
new file mode 100644
index 0000000000000..487ee16558fec
--- /dev/null
+++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/audit_log.ts
@@ -0,0 +1,30 @@
+/*
+ * 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 { ENDPOINT_ACTION_LOG_ROUTE } from '../../../../common/endpoint/constants';
+import { EndpointActionLogRequestSchema } from '../../../../common/endpoint/schema/actions';
+import { actionsLogRequestHandler } from './audit_log_handler';
+
+import { SecuritySolutionPluginRouter } from '../../../types';
+import { EndpointAppContext } from '../../types';
+
+/**
+ * Registers the endpoint activity_log route
+ */
+export function registerActionAuditLogRoutes(
+ router: SecuritySolutionPluginRouter,
+ endpointContext: EndpointAppContext
+) {
+ router.get(
+ {
+ path: ENDPOINT_ACTION_LOG_ROUTE,
+ validate: EndpointActionLogRequestSchema,
+ options: { authRequired: true, tags: ['access:securitySolution'] },
+ },
+ actionsLogRequestHandler(endpointContext)
+ );
+}
diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/audit_log_handler.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/audit_log_handler.ts
new file mode 100644
index 0000000000000..fdbb9608463e9
--- /dev/null
+++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/audit_log_handler.ts
@@ -0,0 +1,59 @@
+/*
+ * 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 { TypeOf } from '@kbn/config-schema';
+import { RequestHandler } from 'kibana/server';
+import { AGENT_ACTIONS_INDEX } from '../../../../../fleet/common';
+import { EndpointActionLogRequestSchema } from '../../../../common/endpoint/schema/actions';
+
+import { SecuritySolutionRequestHandlerContext } from '../../../types';
+import { EndpointAppContext } from '../../types';
+
+export const actionsLogRequestHandler = (
+ endpointContext: EndpointAppContext
+): RequestHandler<
+ TypeOf,
+ unknown,
+ unknown,
+ SecuritySolutionRequestHandlerContext
+> => {
+ const logger = endpointContext.logFactory.get('audit_log');
+ return async (context, req, res) => {
+ const esClient = context.core.elasticsearch.client.asCurrentUser;
+ let result;
+ try {
+ result = await esClient.search({
+ index: AGENT_ACTIONS_INDEX,
+ body: {
+ query: {
+ match: {
+ agents: req.params.agent_id,
+ },
+ },
+ sort: [
+ {
+ '@timestamp': {
+ order: 'desc',
+ },
+ },
+ ],
+ },
+ });
+ } catch (error) {
+ logger.error(error);
+ throw error;
+ }
+ if (result?.statusCode !== 200) {
+ logger.error(`Error fetching actions log for agent_id ${req.params.agent_id}`);
+ throw new Error(`Error fetching actions log for agent_id ${req.params.agent_id}`);
+ }
+
+ return res.ok({
+ body: result.body.hits.hits.map((e) => e._source),
+ });
+ };
+};
diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts
index 9dec4fb2cbb79..e95a33253034d 100644
--- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts
+++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts
@@ -6,3 +6,4 @@
*/
export * from './isolation';
+export * from './audit_log';
diff --git a/x-pack/plugins/security_solution/server/plugin.ts b/x-pack/plugins/security_solution/server/plugin.ts
index 2507475592e88..732ae48223421 100644
--- a/x-pack/plugins/security_solution/server/plugin.ts
+++ b/x-pack/plugins/security_solution/server/plugin.ts
@@ -75,7 +75,10 @@ import { registerEndpointRoutes } from './endpoint/routes/metadata';
import { registerLimitedConcurrencyRoutes } from './endpoint/routes/limited_concurrency';
import { registerResolverRoutes } from './endpoint/routes/resolver';
import { registerPolicyRoutes } from './endpoint/routes/policy';
-import { registerHostIsolationRoutes } from './endpoint/routes/actions';
+import {
+ registerHostIsolationRoutes,
+ registerActionAuditLogRoutes,
+} from './endpoint/routes/actions';
import { EndpointArtifactClient, ManifestManager } from './endpoint/services';
import { EndpointAppContextService } from './endpoint/endpoint_app_context_services';
import { EndpointAppContext } from './endpoint/types';
@@ -291,6 +294,7 @@ export class Plugin implements IPlugin {
+ validateConnector: (): Promise => {
return { errors: {} };
},
- validateParams: (actionParams: ServerLogActionParams): ValidationResult => {
+ validateParams: (actionParams: ServerLogActionParams): Promise => {
// validation of action params implementation
},
actionConnectorFields: null,
@@ -929,10 +929,10 @@ export function getActionType(): ActionTypeModel {
defaultMessage: 'Send to email',
}
),
- validateConnector: (action: EmailActionConnector): ValidationResult => {
+ validateConnector: (action: EmailActionConnector): Promise => {
// validation of connector properties implementation
},
- validateParams: (actionParams: EmailActionParams): ValidationResult => {
+ validateParams: (actionParams: EmailActionParams): Promise => {
// validation of action params implementation
},
actionConnectorFields: EmailActionConnectorFields,
@@ -967,10 +967,10 @@ export function getActionType(): ActionTypeModel {
defaultMessage: 'Send to Slack',
}
),
- validateConnector: (action: SlackActionConnector): ValidationResult => {
+ validateConnector: (action: SlackActionConnector): Promise => {
// validation of connector properties implementation
},
- validateParams: (actionParams: SlackActionParams): ValidationResult => {
+ validateParams: (actionParams: SlackActionParams): Promise => {
// validation of action params implementation
},
actionConnectorFields: SlackActionFields,
@@ -1000,12 +1000,12 @@ export function getActionType(): ActionTypeModel {
defaultMessage: 'Index data into Elasticsearch.',
}
),
- validateConnector: (): ValidationResult => {
+ validateConnector: (): Promise => {
return { errors: {} };
},
actionConnectorFields: IndexActionConnectorFields,
actionParamsFields: IndexParamsFields,
- validateParams: (): ValidationResult => {
+ validateParams: (): Promise => {
return { errors: {} };
},
};
@@ -1046,10 +1046,10 @@ export function getActionType(): ActionTypeModel {
defaultMessage: 'Send a request to a web service.',
}
),
- validateConnector: (action: WebhookActionConnector): ValidationResult => {
+ validateConnector: (action: WebhookActionConnector): Promise => {
// validation of connector properties implementation
},
- validateParams: (actionParams: WebhookActionParams): ValidationResult => {
+ validateParams: (actionParams: WebhookActionParams): Promise => {
// validation of action params implementation
},
actionConnectorFields: WebhookActionConnectorFields,
@@ -1086,10 +1086,10 @@ export function getActionType(): ActionTypeModel {
defaultMessage: 'Send to PagerDuty',
}
),
- validateConnector: (action: PagerDutyActionConnector): ValidationResult => {
+ validateConnector: (action: PagerDutyActionConnector): Promise => {
// validation of connector properties implementation
},
- validateParams: (actionParams: PagerDutyActionParams): ValidationResult => {
+ validateParams: (actionParams: PagerDutyActionParams): Promise => {
// validation of action params implementation
},
actionConnectorFields: PagerDutyActionConnectorFields,
@@ -1113,8 +1113,8 @@ Each action type should be defined as an `ActionTypeModel` object with the follo
iconClass: IconType;
selectMessage: string;
actionTypeTitle?: string;
- validateConnector: (connector: any) => ValidationResult;
- validateParams: (actionParams: any) => ValidationResult;
+ validateConnector: (connector: any) => Promise;
+ validateParams: (actionParams: any) => Promise;
actionConnectorFields: React.FunctionComponent | null;
actionParamsFields: React.LazyExoticComponent>>;
```
@@ -1186,7 +1186,7 @@ export function getActionType(): ActionTypeModel {
defaultMessage: 'Example Action',
}
),
- validateConnector: (action: ExampleActionConnector): ValidationResult => {
+ validateConnector: (action: ExampleActionConnector): Promise => {
const validationResult = { errors: {} };
const errors = {
someConnectorField: new Array(),
@@ -1204,7 +1204,7 @@ export function getActionType(): ActionTypeModel {
}
return validationResult;
},
- validateParams: (actionParams: ExampleActionParams): ValidationResult => {
+ validateParams: (actionParams: ExampleActionParams): Promise => {
const validationResult = { errors: {} };
const errors = {
message: new Array(),
diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email.test.tsx
index bebddba0c1110..4d669ab4c76a1 100644
--- a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email.test.tsx
+++ b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email.test.tsx
@@ -30,7 +30,7 @@ describe('actionTypeRegistry.get() works', () => {
});
describe('connector validation', () => {
- test('connector validation succeeds when connector config is valid', () => {
+ test('connector validation succeeds when connector config is valid', async () => {
const actionConnector = {
secrets: {
user: 'user',
@@ -49,7 +49,7 @@ describe('connector validation', () => {
},
} as EmailActionConnector;
- expect(actionTypeModel.validateConnector(actionConnector)).toEqual({
+ expect(await actionTypeModel.validateConnector(actionConnector)).toEqual({
config: {
errors: {
from: [],
@@ -66,7 +66,7 @@ describe('connector validation', () => {
});
});
- test('connector validation succeeds when connector config is valid with empty user/password', () => {
+ test('connector validation succeeds when connector config is valid with empty user/password', async () => {
const actionConnector = {
secrets: {
user: null,
@@ -85,7 +85,7 @@ describe('connector validation', () => {
},
} as EmailActionConnector;
- expect(actionTypeModel.validateConnector(actionConnector)).toEqual({
+ expect(await actionTypeModel.validateConnector(actionConnector)).toEqual({
config: {
errors: {
from: [],
@@ -101,7 +101,7 @@ describe('connector validation', () => {
},
});
});
- test('connector validation fails when connector config is not valid', () => {
+ test('connector validation fails when connector config is not valid', async () => {
const actionConnector = {
secrets: {
user: 'user',
@@ -116,7 +116,7 @@ describe('connector validation', () => {
},
} as EmailActionConnector;
- expect(actionTypeModel.validateConnector(actionConnector)).toEqual({
+ expect(await actionTypeModel.validateConnector(actionConnector)).toEqual({
config: {
errors: {
from: [],
@@ -132,7 +132,7 @@ describe('connector validation', () => {
},
});
});
- test('connector validation fails when user specified but not password', () => {
+ test('connector validation fails when user specified but not password', async () => {
const actionConnector = {
secrets: {
user: 'user',
@@ -151,7 +151,7 @@ describe('connector validation', () => {
},
} as EmailActionConnector;
- expect(actionTypeModel.validateConnector(actionConnector)).toEqual({
+ expect(await actionTypeModel.validateConnector(actionConnector)).toEqual({
config: {
errors: {
from: [],
@@ -167,7 +167,7 @@ describe('connector validation', () => {
},
});
});
- test('connector validation fails when password specified but not user', () => {
+ test('connector validation fails when password specified but not user', async () => {
const actionConnector = {
secrets: {
user: null,
@@ -186,7 +186,7 @@ describe('connector validation', () => {
},
} as EmailActionConnector;
- expect(actionTypeModel.validateConnector(actionConnector)).toEqual({
+ expect(await actionTypeModel.validateConnector(actionConnector)).toEqual({
config: {
errors: {
from: [],
@@ -205,7 +205,7 @@ describe('connector validation', () => {
});
describe('action params validation', () => {
- test('action params validation succeeds when action params is valid', () => {
+ test('action params validation succeeds when action params is valid', async () => {
const actionParams = {
to: [],
cc: ['test1@test.com'],
@@ -213,7 +213,7 @@ describe('action params validation', () => {
subject: 'test',
};
- expect(actionTypeModel.validateParams(actionParams)).toEqual({
+ expect(await actionTypeModel.validateParams(actionParams)).toEqual({
errors: {
to: [],
cc: [],
@@ -224,13 +224,13 @@ describe('action params validation', () => {
});
});
- test('action params validation fails when action params is not valid', () => {
+ test('action params validation fails when action params is not valid', async () => {
const actionParams = {
to: ['test@test.com'],
subject: 'test',
};
- expect(actionTypeModel.validateParams(actionParams)).toEqual({
+ expect(await actionTypeModel.validateParams(actionParams)).toEqual({
errors: {
to: [],
cc: [],
diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email.tsx
index 81eadda4fc278..5e23754621430 100644
--- a/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email.tsx
+++ b/x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/email/email.tsx
@@ -31,9 +31,12 @@ export function getActionType(): ActionTypeModel, EmailSecrets> => {
+ ): Promise<
+ ConnectorValidationResult