Skip to content

[Lens] Extend Datasource props validation with VisualizationGroups #82607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 63 commits into from
Nov 9, 2020
Merged

[Lens] Extend Datasource props validation with VisualizationGroups #82607

Show file tree
Hide file tree
Changes from 61 commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
1bed7c0
:sparkles: First pass with visualization validation + error messages
dej611 Oct 20, 2020
bb93701
:fire: Remove indexpattern error handling for now
dej611 Oct 21, 2020
0aea6c5
:label: Fix type issues
dej611 Oct 21, 2020
d389d85
:white_check_mark: Add getErrorMessage test for data table
dej611 Oct 21, 2020
4c48b23
:white_check_mark: Add tests for pie and metric error messages
dej611 Oct 21, 2020
91a700a
:globe_with_meridians: Fix i18n checks issues
dej611 Oct 22, 2020
b1d71dd
:bug: Fix last issue
dej611 Oct 22, 2020
be2312d
:white_check_mark: Add more tests for the XY visualization validation…
dej611 Oct 22, 2020
c64603a
:ok_hand: Included all feedback from first review
dej611 Oct 27, 2020
8e77401
:pencil2: Off by one message
dej611 Oct 27, 2020
64a22ef
Merge remote-tracking branch 'upstream/master' into feature/lens/disp…
dej611 Oct 27, 2020
7089b2f
:globe_with_meridians: Fix i18n duplicate id
dej611 Oct 27, 2020
86cc058
:globe_with_meridians: Fix last i18n issue
dej611 Oct 28, 2020
4e0c179
Merge remote-tracking branch 'upstream/master' into feature/lens/disp…
dej611 Oct 28, 2020
6672302
:bug: Fixed a hook reflow issue
dej611 Oct 28, 2020
ee80a6b
:recycle:+:white_check_mark: Reworked validation flow + tests
dej611 Oct 28, 2020
f1127f4
:label: Fix type issue
dej611 Oct 28, 2020
95f9daf
:bug: Improved XY corner cases validation logic
dej611 Oct 29, 2020
ce7f857
:bug: Fix empty datatable scenario
dej611 Oct 29, 2020
d88d55d
:sparkles: + :white_check_mark: Improved error messages for invalid d…
dej611 Oct 29, 2020
694757b
:globe_with_meridians: Add missing i18n translation
dej611 Oct 29, 2020
0277aa5
:label: Fix type issues
dej611 Oct 29, 2020
822a23e
:globe_with_meridians: Fix i18n issues
dej611 Oct 29, 2020
957bd98
:sparkles: Filter out suggestions which fail to build
dej611 Oct 29, 2020
7bfabd1
Merge branch 'master' into feature/lens/display-error-workspace
kibanamachine Oct 30, 2020
2fd7a90
:truck: Migrate datatable validation logic to the building phase, han…
dej611 Oct 30, 2020
4464285
:label: Fix type issue
dej611 Oct 30, 2020
e039c4f
:pencil2: Add comment for future enhancements
dej611 Oct 30, 2020
a84fad2
:pencil2: Updated comment
dej611 Oct 30, 2020
d06f099
Merge branch 'master' into feature/lens/display-error-workspace
kibanamachine Oct 30, 2020
135c40d
:world_with_meridians: Refactor axis labels
dej611 Oct 30, 2020
b12a320
:globe_with_meridians: Reworked few validation messages
dej611 Oct 30, 2020
9f5d951
:bug: Fix break down validation + percentage charts
dej611 Oct 30, 2020
f984d5d
:white_check_mark: Align tests with new validation logic
dej611 Oct 30, 2020
5e265ae
Merge branch 'feature/lens/display-error-workspace' of github.com:dej…
dej611 Oct 30, 2020
4b3c36a
Merge branch 'master' into feature/lens/display-error-workspace
kibanamachine Nov 2, 2020
c7fdd61
:recycle: Fix suggestion panel validation to match main panel
dej611 Nov 2, 2020
d0bce6b
:globe_with_meridians: Fix i18n issues
dej611 Nov 2, 2020
cb0214e
:wrench: Fix some refs for validation checks in suggestions
dej611 Nov 2, 2020
d3fabc2
Merge branch 'feature/lens/display-error-workspace' of github.com:dej…
dej611 Nov 2, 2020
6c27723
:bug: Fix missing key prop in multiple errors scenario
dej611 Nov 2, 2020
9437162
Merge branch 'master' into feature/lens/display-error-workspace
kibanamachine Nov 2, 2020
4ac3bd8
Merge branch 'master' into feature/lens/display-error-workspace
kibanamachine Nov 2, 2020
6798112
Merge remote-tracking branch 'upstream/master' into feature/lens/disp…
dej611 Nov 2, 2020
8d31435
:bug: Fix swtich issue from XY to partition
dej611 Nov 2, 2020
97dc1ae
:globe_with_meridians: Fix i18n messages and aligned tests
dej611 Nov 2, 2020
33b71fa
Merge branch 'master' into feature/lens/display-error-workspace
kibanamachine Nov 3, 2020
0a0f5d3
:bug: Fix suggestions switching bug
dej611 Nov 3, 2020
37dca5a
:refactor: Add more validation + refactored validation logic in a sin…
dej611 Nov 3, 2020
fa32b19
:pencil2: Add note about lint hooks disable rule
dej611 Nov 3, 2020
1a440a9
Merge remote-tracking branch 'upstream/master' into feature/lens/disp…
dej611 Nov 4, 2020
cdb7054
:rotating_light: Fix linting issue
dej611 Nov 4, 2020
8618b3f
:building_construction: Add infra API for datasource advanced validation
dej611 Nov 4, 2020
11caf4a
:white_check_mark: Align tests with new API
dej611 Nov 4, 2020
41ff2ed
Merge branch 'feature/lens/display-error-workspace' into feature/lens…
dej611 Nov 4, 2020
9de02ff
:white_check_mark: Fix type issues in tests
dej611 Nov 4, 2020
8ccd1d4
:ok_hand: Early exists added
dej611 Nov 4, 2020
29ab103
Merge branch 'feature/lens/display-error-workspace' into feature/lens…
dej611 Nov 4, 2020
d160fe2
Merge remote-tracking branch 'upstream/master' into feature/lens/data…
dej611 Nov 5, 2020
c4949ef
:sparkles: Add layers groups to the API
dej611 Nov 6, 2020
f6a4e4d
:white_check_mark: Fix some broken test after the validation change
dej611 Nov 6, 2020
c374b24
:ok_hand: Move to disctionary shape
dej611 Nov 9, 2020
aa0ad1e
Merge branch 'master' into feature/lens/datasource-groups-validation
kibanamachine Nov 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,7 @@ export function LayerPanel(
columnId: activeId,
filterOperations: activeGroup.filterOperations,
suggestedPriority: activeGroup?.suggestedPriority,
dimensionGroups: groups,
setState: (newState: unknown) => {
props.updateAll(
datasourceId,
Expand Down
9 changes: 6 additions & 3 deletions x-pack/plugins/lens/public/editor_frame_service/editor_frame/editor_frame.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,8 @@ describe('editor_frame', () => {
setDatasourceState(updatedState);
});

expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(2);
// validation requires to calls this getConfiguration API
expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(6);
expect(mockVisualization.getConfiguration).toHaveBeenLastCalledWith(
expect.objectContaining({
state: updatedState,
Expand Down Expand Up @@ -680,7 +681,8 @@ describe('editor_frame', () => {
setDatasourceState({});
});

expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(2);
// validation requires to calls this getConfiguration API
expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(6);
expect(mockVisualization.getConfiguration).toHaveBeenLastCalledWith(
expect.objectContaining({
frame: expect.objectContaining({
Expand Down Expand Up @@ -1193,7 +1195,8 @@ describe('editor_frame', () => {
instance.find('[data-test-subj="lnsSuggestion"]').at(2).simulate('click');
});

expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(1);
// validation requires to calls this getConfiguration API
expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(4);
expect(mockVisualization.getConfiguration).toHaveBeenCalledWith(
expect.objectContaining({
state: suggestionVisState,
Expand Down
12 changes: 11 additions & 1 deletion x-pack/plugins/lens/public/editor_frame_service/editor_frame/state_helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,18 @@ export const validateDatasourceAndVisualization = (
longMessage: string;
}>
| undefined => {
const layersGroups =
currentVisualizationState &&
currentVisualization?.getLayerIds(currentVisualizationState).map((layerId) => {
Copy link
Contributor

@flash1293 flash1293 Nov 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has to be a map (with the keys being the layer id) - otherwise the datasource won't be able to map the right group arrays back to the right internal layer representation.

The type should be

getErrorMessages: (
    state: T,
    layersGroups?: Record<string, VisualizationDimensionGroupConfig[]>
  ) => Array<{ shortMessage: string; longMessage: string }> | undefined;

Copy link
Contributor Author

@dej611 dej611 Nov 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is an array, so always in order, so it shouldn't be a problem: probably the implementation will need to identify layers index anyway internally to output a better contextual message.
I understand it may be also useful to have a lookup by layerId, I'll update.

return currentVisualization?.getConfiguration({
frame: frameAPI,
layerId,
state: currentVisualizationState,
}).groups;
});

const datasourceValidationErrors = currentDatasourceState
? currentDataSource?.getErrorMessages(currentDatasourceState)
? currentDataSource?.getErrorMessages(currentDatasourceState, layersGroups)
: undefined;

const visualizationValidationErrors = currentVisualizationState
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ describe('IndexPatternDimensionEditorPanel', () => {
} as unknown) as DataPublicPluginStart['fieldFormats'],
} as unknown) as DataPublicPluginStart,
core: {} as CoreSetup,
dimensionGroups: [],
};

jest.clearAllMocks();
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ describe('IndexPatternDimensionEditorPanel', () => {
} as unknown) as DataPublicPluginStart['fieldFormats'],
} as unknown) as DataPublicPluginStart,
core: {} as CoreSetup,
dimensionGroups: [],
};

jest.clearAllMocks();
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ export function getIndexPatternDatasource({
getDatasourceSuggestionsFromCurrentState,
getDatasourceSuggestionsForVisualizeField,

getErrorMessages(state) {
getErrorMessages(state, layersGroups) {
if (!state) {
return;
}
Expand Down
6 changes: 5 additions & 1 deletion x-pack/plugins/lens/public/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,10 @@ export interface Datasource<T = unknown, P = unknown> {
getDatasourceSuggestionsFromCurrentState: (state: T) => Array<DatasourceSuggestion<T>>;

getPublicAPI: (props: PublicAPIProps<T>) => DatasourcePublicAPI;
getErrorMessages: (state: T) => Array<{ shortMessage: string; longMessage: string }> | undefined;
getErrorMessages: (
state: T,
layersGroups?: VisualizationDimensionGroupConfig[][]
) => Array<{ shortMessage: string; longMessage: string }> | undefined;
/**
* uniqueLabels of dimensions exposed for aria-labels of dragged dimensions
*/
Expand Down Expand Up @@ -238,6 +241,7 @@ export type DatasourceDimensionEditorProps<T = unknown> = DatasourceDimensionPro
setState: StateSetter<T>;
core: Pick<CoreSetup, 'http' | 'notifications' | 'uiSettings'>;
dateRange: DateRange;
dimensionGroups: VisualizationDimensionGroupConfig[];
};

export type DatasourceDimensionTriggerProps<T> = DatasourceDimensionProps<T> & {
Expand Down