Skip to content

Commit e9e5c3c

Browse files
drewdaemondrewdaemon
authored
[Lens] warn user before leaving editor after creating new library annotation group (#161307)
1 parent 2774812 commit e9e5c3c

File tree

9 files changed

+102
-20
lines changed

9 files changed

+102
-20
lines changed

‎x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.tsx‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,11 @@ export function LayerPanels(
246246
setNextFocusedLayerId(layerId);
247247
};
248248

249+
const registerLibraryAnnotationGroupFunction = useCallback(
250+
(groupInfo) => dispatchLens(registerLibraryAnnotationGroup(groupInfo)),
251+
[dispatchLens]
252+
);
253+
249254
const hideAddLayerButton = query && isOfAggregateQueryType(query);
250255

251256
return (
@@ -261,6 +266,7 @@ export function LayerPanels(
261266
!hidden && (
262267
<LayerPanel
263268
{...props}
269+
registerLibraryAnnotationGroup={registerLibraryAnnotationGroupFunction}
264270
dimensionGroups={groups}
265271
activeVisualization={activeVisualization}
266272
registerNewLayerRef={registerNewLayerRef}
@@ -369,8 +375,7 @@ export function LayerPanels(
369375
);
370376
}
371377
},
372-
registerLibraryAnnotationGroup: (groupInfo) =>
373-
dispatchLens(registerLibraryAnnotationGroup(groupInfo)),
378+
registerLibraryAnnotationGroup: registerLibraryAnnotationGroupFunction,
374379
})}
375380
</EuiForm>
376381
);

‎x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.test.tsx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ describe('LayerPanel', () => {
115115
toggleFullscreen: jest.fn(),
116116
onEmptyDimensionAdd: jest.fn(),
117117
onChangeIndexPattern: jest.fn(),
118+
registerLibraryAnnotationGroup: jest.fn(),
118119
indexPatternService: createIndexPatternServiceMock(),
119120
getUserMessages: () => [],
120121
displayLayerSettings: true,

‎x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import {
3434
VisualizationDimensionGroupConfig,
3535
UserMessagesGetter,
3636
AddLayerFunction,
37+
RegisterLibraryAnnotationGroupFunction,
3738
} from '../../../types';
3839
import { LayerSettings } from './layer_settings';
3940
import { LayerPanelProps, ActiveDimensionState } from './types';
@@ -63,6 +64,7 @@ export function LayerPanel(
6364
layerIndex: number;
6465
isOnlyLayer: boolean;
6566
addLayer: AddLayerFunction;
67+
registerLibraryAnnotationGroup: RegisterLibraryAnnotationGroupFunction;
6668
updateVisualization: StateSetter<unknown>;
6769
updateDatasource: (
6870
datasourceId: string | undefined,
@@ -352,6 +354,7 @@ export function LayerPanel(
352354
layerId,
353355
visualizationState,
354356
updateVisualization,
357+
props.registerLibraryAnnotationGroup,
355358
isSaveable
356359
)
357360
.map((action) => ({
@@ -385,18 +388,19 @@ export function LayerPanel(
385388
].filter((i) => i.isCompatible),
386389
[
387390
activeVisualization,
391+
layerId,
392+
visualizationState,
393+
updateVisualization,
394+
props.registerLibraryAnnotationGroup,
395+
isSaveable,
388396
core,
397+
layerIndex,
389398
isOnlyLayer,
390399
isTextBasedLanguage,
400+
visualizationLayerSettings,
391401
layerDatasource?.renderLayerSettings,
392-
layerId,
393-
layerIndex,
394402
onCloneLayer,
395403
onRemoveLayer,
396-
updateVisualization,
397-
visualizationLayerSettings,
398-
visualizationState,
399-
isSaveable,
400404
]
401405
);
402406
const layerActionsFlyoutRef = useRef<HTMLDivElement | null>(null);

‎x-pack/plugins/lens/public/types.ts‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1027,6 +1027,11 @@ export interface VisualizationLayerDescription {
10271027
autoTimeField?: boolean;
10281028
}>;
10291029
}
1030+
1031+
export type RegisterLibraryAnnotationGroupFunction = (groupInfo: {
1032+
id: string;
1033+
group: EventAnnotationGroupConfig;
1034+
}) => void;
10301035
export interface Visualization<T = unknown, P = T, ExtraAppendLayerArg = unknown> {
10311036
/** Plugin ID, such as "lnsXY" */
10321037
id: string;
@@ -1115,6 +1120,7 @@ export interface Visualization<T = unknown, P = T, ExtraAppendLayerArg = unknown
11151120
layerId: string,
11161121
state: T,
11171122
setState: StateSetter<T>,
1123+
registerLibraryAnnotationGroup: RegisterLibraryAnnotationGroupFunction,
11181124
isSaveable?: boolean
11191125
) => LayerAction[];
11201126

@@ -1251,10 +1257,7 @@ export interface Visualization<T = unknown, P = T, ExtraAppendLayerArg = unknown
12511257
supportedLayers: VisualizationLayerDescription[];
12521258
addLayer: AddLayerFunction;
12531259
ensureIndexPattern: (specOrId: DataViewSpec | string) => Promise<void>;
1254-
registerLibraryAnnotationGroup: (groupInfo: {
1255-
id: string;
1256-
group: EventAnnotationGroupConfig;
1257-
}) => void;
1260+
registerLibraryAnnotationGroup: RegisterLibraryAnnotationGroupFunction;
12581261
}) => JSX.Element | null;
12591262
/**
12601263
* Creates map of columns ids and unique lables. Used only for noDatasource layers

‎x-pack/plugins/lens/public/visualizations/xy/annotations/actions/index.ts‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ import type { ThemeServiceStart } from '@kbn/core/public';
1212
import { DataViewsContract } from '@kbn/data-views-plugin/public';
1313
import { VISUALIZE_APP_NAME } from '@kbn/visualizations-plugin/common/constants';
1414
import { ANNOTATIONS_LISTING_VIEW_ID } from '@kbn/event-annotation-plugin/common';
15-
import type { LayerAction, StateSetter } from '../../../../types';
15+
import type {
16+
LayerAction,
17+
RegisterLibraryAnnotationGroupFunction,
18+
StateSetter,
19+
} from '../../../../types';
1620
import { XYState, XYAnnotationLayerConfig } from '../../types';
1721
import { getUnlinkLayerAction } from './unlink_action';
1822
import { getSaveLayerAction } from './save_action';
@@ -23,6 +27,7 @@ export const createAnnotationActions = ({
2327
state,
2428
layer,
2529
setState,
30+
registerLibraryAnnotationGroup,
2631
core,
2732
isSaveable,
2833
eventAnnotationService,
@@ -33,6 +38,7 @@ export const createAnnotationActions = ({
3338
state: XYState;
3439
layer: XYAnnotationLayerConfig;
3540
setState: StateSetter<XYState, unknown>;
41+
registerLibraryAnnotationGroup: RegisterLibraryAnnotationGroupFunction;
3642
core: CoreStart;
3743
isSaveable?: boolean;
3844
eventAnnotationService: EventAnnotationServiceType;
@@ -52,6 +58,7 @@ export const createAnnotationActions = ({
5258
state,
5359
layer,
5460
setState,
61+
registerLibraryAnnotationGroup,
5562
eventAnnotationService,
5663
toasts: core.notifications.toasts,
5764
savedObjectsTagging,

‎x-pack/plugins/lens/public/visualizations/xy/annotations/actions/save_action.test.tsx‎

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ import {
1616
} from '../../types';
1717
import { onSave, SaveModal } from './save_action';
1818
import { shallowWithIntl } from '@kbn/test-jest-helpers';
19-
import { PointInTimeEventAnnotationConfig } from '@kbn/event-annotation-plugin/common';
19+
import {
20+
EventAnnotationGroupConfig,
21+
PointInTimeEventAnnotationConfig,
22+
} from '@kbn/event-annotation-plugin/common';
2023
import { SavedObjectSaveModal } from '@kbn/saved-objects-plugin/public';
2124
import { taggingApiMock } from '@kbn/saved-objects-tagging-plugin/public/mocks';
2225
import { dataViewPluginMocks } from '@kbn/data-views-plugin/public/mocks';
@@ -145,6 +148,7 @@ describe('annotation group save action', () => {
145148
layers: [{ layerId } as XYAnnotationLayerConfig],
146149
} as XYState,
147150
layer: byValueLayer,
151+
registerLibraryAnnotationGroup: jest.fn(),
148152
setState: jest.fn(),
149153
eventAnnotationService: {
150154
createAnnotationGroup: jest.fn(() => Promise.resolve({ id: savedId })),
@@ -178,13 +182,22 @@ describe('annotation group save action', () => {
178182
test('successful initial save', async () => {
179183
await onSave(props);
180184

181-
expect(props.eventAnnotationService.createAnnotationGroup).toHaveBeenCalledWith({
185+
const expectedConfig: EventAnnotationGroupConfig = {
182186
annotations: props.layer.annotations,
183187
indexPatternId: props.layer.indexPatternId,
184188
ignoreGlobalFilters: props.layer.ignoreGlobalFilters,
185189
title: props.modalOnSaveProps.newTitle,
186190
description: props.modalOnSaveProps.newDescription,
187191
tags: props.modalOnSaveProps.newTags,
192+
};
193+
194+
expect(props.eventAnnotationService.createAnnotationGroup).toHaveBeenCalledWith(
195+
expectedConfig
196+
);
197+
198+
expect(props.registerLibraryAnnotationGroup).toHaveBeenCalledWith({
199+
id: savedId,
200+
group: expectedConfig,
188201
});
189202

190203
expect(props.modalOnSaveProps.closeModal).toHaveBeenCalled();
@@ -206,14 +219,23 @@ describe('annotation group save action', () => {
206219

207220
await onSave(props);
208221

209-
expect(props.eventAnnotationService.createAnnotationGroup).toHaveBeenCalledWith({
222+
const expectedConfig: EventAnnotationGroupConfig = {
210223
annotations: props.layer.annotations,
211224
indexPatternId: props.layer.indexPatternId,
212225
ignoreGlobalFilters: props.layer.ignoreGlobalFilters,
213226
title: props.modalOnSaveProps.newTitle,
214227
description: props.modalOnSaveProps.newDescription,
215228
tags: props.modalOnSaveProps.newTags,
216229
dataViewSpec,
230+
};
231+
232+
expect(props.eventAnnotationService.createAnnotationGroup).toHaveBeenCalledWith(
233+
expectedConfig
234+
);
235+
236+
expect(props.registerLibraryAnnotationGroup).toHaveBeenCalledWith({
237+
id: savedId,
238+
group: expectedConfig,
217239
});
218240

219241
expect(props.modalOnSaveProps.closeModal).toHaveBeenCalled();
@@ -241,6 +263,8 @@ describe('annotation group save action', () => {
241263

242264
expect(props.toasts.addError).toHaveBeenCalledTimes(1);
243265

266+
expect(props.registerLibraryAnnotationGroup).not.toHaveBeenCalled();
267+
244268
expect(props.modalOnSaveProps.closeModal).not.toHaveBeenCalled();
245269

246270
expect(props.setState).not.toHaveBeenCalled();
@@ -307,13 +331,22 @@ describe('annotation group save action', () => {
307331

308332
expect(props.eventAnnotationService.updateAnnotationGroup).not.toHaveBeenCalled();
309333

310-
expect(props.eventAnnotationService.createAnnotationGroup).toHaveBeenCalledWith({
334+
const expectedConfig: EventAnnotationGroupConfig = {
311335
annotations: props.layer.annotations,
312336
indexPatternId: props.layer.indexPatternId,
313337
ignoreGlobalFilters: props.layer.ignoreGlobalFilters,
314338
title: props.modalOnSaveProps.newTitle,
315339
description: props.modalOnSaveProps.newDescription,
316340
tags: props.modalOnSaveProps.newTags,
341+
};
342+
343+
expect(props.eventAnnotationService.createAnnotationGroup).toHaveBeenCalledWith(
344+
expectedConfig
345+
);
346+
347+
expect(props.registerLibraryAnnotationGroup).toHaveBeenCalledWith({
348+
id: savedId,
349+
group: expectedConfig,
317350
});
318351

319352
expect(props.modalOnSaveProps.closeModal).toHaveBeenCalled();

‎x-pack/plugins/lens/public/visualizations/xy/annotations/actions/save_action.tsx‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ import { EventAnnotationGroupConfig } from '@kbn/event-annotation-plugin/common'
2222
import { EuiIcon, EuiLink } from '@elastic/eui';
2323
import { type SavedObjectTaggingPluginStart } from '@kbn/saved-objects-tagging-plugin/public';
2424
import { DataViewsContract } from '@kbn/data-views-plugin/public';
25-
import type { LayerAction, StateSetter } from '../../../../types';
25+
import type {
26+
LayerAction,
27+
RegisterLibraryAnnotationGroupFunction,
28+
StateSetter,
29+
} from '../../../../types';
2630
import { XYByReferenceAnnotationLayerConfig, XYAnnotationLayerConfig, XYState } from '../../types';
2731
import { isByReferenceAnnotationsLayer } from '../../visualization_helpers';
2832

@@ -160,6 +164,7 @@ export const onSave = async ({
160164
state,
161165
layer,
162166
setState,
167+
registerLibraryAnnotationGroup,
163168
eventAnnotationService,
164169
toasts,
165170
modalOnSaveProps: {
@@ -177,6 +182,10 @@ export const onSave = async ({
177182
state: XYState;
178183
layer: XYAnnotationLayerConfig;
179184
setState: StateSetter<XYState, unknown>;
185+
registerLibraryAnnotationGroup: (props: {
186+
id: string;
187+
group: EventAnnotationGroupConfig;
188+
}) => void;
180189
eventAnnotationService: EventAnnotationServiceType;
181190
toasts: ToastsStart;
182191
modalOnSaveProps: ModalOnSaveProps;
@@ -202,6 +211,12 @@ export const onSave = async ({
202211
eventAnnotationService,
203212
dataViews
204213
);
214+
215+
// add new group to state
216+
registerLibraryAnnotationGroup({
217+
id: savedInfo.id,
218+
group: savedInfo.config,
219+
});
205220
} catch (err) {
206221
toasts.addError(err, {
207222
title: i18n.translate(
@@ -275,6 +290,7 @@ export const getSaveLayerAction = ({
275290
state,
276291
layer,
277292
setState,
293+
registerLibraryAnnotationGroup,
278294
eventAnnotationService,
279295
toasts,
280296
savedObjectsTagging,
@@ -285,6 +301,7 @@ export const getSaveLayerAction = ({
285301
state: XYState;
286302
layer: XYAnnotationLayerConfig;
287303
setState: StateSetter<XYState, unknown>;
304+
registerLibraryAnnotationGroup: RegisterLibraryAnnotationGroupFunction;
288305
eventAnnotationService: EventAnnotationServiceType;
289306
toasts: ToastsStart;
290307
savedObjectsTagging?: SavedObjectTaggingPluginStart;
@@ -320,6 +337,7 @@ export const getSaveLayerAction = ({
320337
state,
321338
layer,
322339
setState,
340+
registerLibraryAnnotationGroup,
323341
eventAnnotationService,
324342
toasts,
325343
modalOnSaveProps: props,

‎x-pack/plugins/lens/public/visualizations/xy/visualization.test.tsx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3633,7 +3633,7 @@ describe('xy_visualization', () => {
36333633
describe('getSupportedActionsForLayer', () => {
36343634
it('should return no actions for a data layer', () => {
36353635
expect(
3636-
xyVisualization.getSupportedActionsForLayer?.('first', exampleState(), jest.fn())
3636+
xyVisualization.getSupportedActionsForLayer?.('first', exampleState(), jest.fn(), jest.fn())
36373637
).toHaveLength(0);
36383638
});
36393639

@@ -3655,6 +3655,7 @@ describe('xy_visualization', () => {
36553655
...baseState,
36563656
layers: [annotationLayer],
36573657
},
3658+
jest.fn(),
36583659
jest.fn()
36593660
)
36603661
).toEqual([]);
@@ -3688,6 +3689,7 @@ describe('xy_visualization', () => {
36883689
layers: [annotationLayer],
36893690
},
36903691
jest.fn(),
3692+
jest.fn(),
36913693
true
36923694
)
36933695
).toMatchInlineSnapshot(`
@@ -3736,6 +3738,7 @@ describe('xy_visualization', () => {
37363738
layers: [annotationLayer],
37373739
},
37383740
jest.fn(),
3741+
jest.fn(),
37393742
false
37403743
)
37413744
.some((action) => action['data-test-subj'] === 'lnsXY_annotationLayer_saveToLibrary')
@@ -3758,6 +3761,7 @@ describe('xy_visualization', () => {
37583761
],
37593762
},
37603763
jest.fn(),
3764+
jest.fn(),
37613765
false
37623766
)
37633767
.find((action) => action['data-test-subj'] === 'lnsXY_annotationLayer_revertChanges')

‎x-pack/plugins/lens/public/visualizations/xy/visualization.tsx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,13 @@ export const getXyVisualization = ({
298298
];
299299
},
300300

301-
getSupportedActionsForLayer(layerId, state, setState, isSaveable) {
301+
getSupportedActionsForLayer(
302+
layerId,
303+
state,
304+
setState,
305+
registerLibraryAnnotationGroup,
306+
isSaveable
307+
) {
302308
const layerIndex = state.layers.findIndex((l) => l.layerId === layerId);
303309
const layer = state.layers[layerIndex];
304310
const actions = [];
@@ -308,6 +314,7 @@ export const getXyVisualization = ({
308314
state,
309315
layer,
310316
setState,
317+
registerLibraryAnnotationGroup,
311318
core,
312319
isSaveable,
313320
eventAnnotationService,

0 commit comments

Comments
 (0)