[VisBuilder] 2 way communication using UI actions and bug fixes #3732
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { ExpressionRendererEvent } from '../../../../expressions/public'; | ||
| import { VIS_EVENT_TO_TRIGGER } from '../../../../visualizations/public'; | ||
| import { handleVisEvent } from './handle_vis_event'; | ||
| import { uiActionsPluginMock } from '../../../../ui_actions/public/mocks'; | ||
| import { Action, ActionType, createAction } from '../../../../ui_actions/public'; | ||
|
|
||
| const executeFn = jest.fn(); | ||
|
|
||
| function createTestAction<C extends object>( | ||
| type: string, | ||
| checkCompatibility: (context: C) => boolean, | ||
| autoExecutable = true | ||
| ): Action<object> { | ||
| return createAction({ | ||
| type: type as ActionType, | ||
| id: type, | ||
| isCompatible: (context: C) => Promise.resolve(checkCompatibility(context)), | ||
| execute: (context) => { | ||
| return executeFn(context); | ||
| }, | ||
| shouldAutoExecute: () => Promise.resolve(autoExecutable), | ||
| }); | ||
| } | ||
|
|
||
| let uiActions: ReturnType<typeof uiActionsPluginMock.createPlugin>; | ||
|
|
||
| describe('handleVisEvent', () => { | ||
| beforeEach(() => { | ||
| uiActions = uiActionsPluginMock.createPlugin(); | ||
|
|
||
| executeFn.mockClear(); | ||
| jest.useFakeTimers(); | ||
| }); | ||
|
|
||
| test('should trigger the correct event', async () => { | ||
| const event: ExpressionRendererEvent = { | ||
| name: 'filter', | ||
| data: {}, | ||
| }; | ||
| const action = createTestAction('test1', () => true); | ||
| const timeFieldName = 'test-timefeild-name'; | ||
| uiActions.setup.addTriggerAction(VIS_EVENT_TO_TRIGGER.filter, action); | ||
|
|
||
| await handleVisEvent(event, uiActions.doStart(), timeFieldName); | ||
|
|
||
| jest.runAllTimers(); | ||
|
|
||
| expect(executeFn).toBeCalledTimes(1); | ||
| expect(executeFn).toBeCalledWith( | ||
| expect.objectContaining({ | ||
| data: { timeFieldName }, | ||
| }) | ||
| ); | ||
| }); | ||
|
|
||
| test('should trigger the default trigger when not found', async () => { | ||
| const event: ExpressionRendererEvent = { | ||
| name: 'test', | ||
| data: {}, | ||
| }; | ||
| const action = createTestAction('test2', () => true); | ||
| const timeFieldName = 'test-timefeild-name'; | ||
| uiActions.setup.addTriggerAction(VIS_EVENT_TO_TRIGGER.filter, action); | ||
|
|
||
| await handleVisEvent(event, uiActions.doStart(), timeFieldName); | ||
|
|
||
| jest.runAllTimers(); | ||
|
|
||
| expect(executeFn).toBeCalledTimes(1); | ||
| expect(executeFn).toBeCalledWith( | ||
| expect.objectContaining({ | ||
| data: { timeFieldName }, | ||
| }) | ||
| ); | ||
| }); | ||
|
|
||
| test('should have the correct context for `applyfilter`', async () => { | ||
| const event: ExpressionRendererEvent = { | ||
| name: 'applyFilter', | ||
| data: {}, | ||
| }; | ||
| const action = createTestAction('test3', () => true); | ||
| const timeFieldName = 'test-timefeild-name'; | ||
| uiActions.setup.addTriggerAction(VIS_EVENT_TO_TRIGGER.applyFilter, action); | ||
|
|
||
| await handleVisEvent(event, uiActions.doStart(), timeFieldName); | ||
|
|
||
| jest.runAllTimers(); | ||
|
|
||
| expect(executeFn).toBeCalledTimes(1); | ||
| expect(executeFn).toBeCalledWith( | ||
| expect.objectContaining({ | ||
| timeFieldName, | ||
| }) | ||
| ); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { ExpressionRendererEvent } from '../../../../expressions/public'; | ||
| import { VIS_EVENT_TO_TRIGGER } from '../../../../visualizations/public'; | ||
| import { UiActionsStart } from '../../../../ui_actions/public'; | ||
|
|
||
| export const handleVisEvent = async ( | ||
|
There was a problem hiding this comment. Just a question, do we need to add error handling here? There was a problem hiding this comment. How do see error handling being added here? There was a problem hiding this comment. Mmm i am mostly thinking if it's possible that |
||
| event: ExpressionRendererEvent, | ||
| uiActions: UiActionsStart, | ||
| timeFieldName?: string | ||
| ) => { | ||
| const triggerId = VIS_EVENT_TO_TRIGGER[event.name] ?? VIS_EVENT_TO_TRIGGER.filter; | ||
| const isApplyFilter = triggerId === VIS_EVENT_TO_TRIGGER.applyFilter; | ||
| const dataContext = { | ||
| timeFieldName, | ||
| ...event.data, | ||
| }; | ||
| const context = isApplyFilter ? dataContext : { data: dataContext }; | ||
|
|
||
| await uiActions.getTrigger(triggerId).exec(context); | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.