Skip to content
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

Jump to bottom

[Lens] More memoization work on the editor_frame #102186

Merged
merged 4 commits into from
Jun 17, 2021
Merged

[Lens] More memoization work on the editor_frame #102186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2af2294
:zap: More memoization to stabilize refs
dej611 Jun 15, 2021
b5ca0f5
:white_check_mark: Fix tests
dej611 Jun 15, 2021
0d034d1
Merge branch 'master' into lens/more-perf-memoization
kibanamachine Jun 16, 2021
b6b38e8
Merge branch 'master' into lens/more-perf-memoization
kibanamachine Jun 16, 2021
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
99 changes: 61 additions & 38 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 @@ -70,6 +70,9 @@ export function LayerPanel(
updateDatasource,
toggleFullscreen,
isFullscreen,
updateAll,
updateDatasourceAsync,
visualizationState,
} = props;
const datasourcePublicAPI = framePublicAPI.datasourceLayers[layerId];

Expand Down Expand Up @@ -114,7 +117,11 @@ export function LayerPanel(
activeData: props.framePublicAPI.activeData,
};

const { groups } = activeVisualization.getConfiguration(layerVisualizationConfigProps);
const { groups } = useMemo(
() => activeVisualization.getConfiguration(layerVisualizationConfigProps),
// eslint-disable-next-line react-hooks/exhaustive-deps
[layerDatasourceConfigProps.frame, layerDatasourceDropProps, activeVisualization]
);
const isEmptyLayer = !groups.some((d) => d.accessors.length > 0);
const { activeId, activeGroup } = activeDimension;

Expand Down Expand Up @@ -204,6 +211,58 @@ export function LayerPanel(

const isDimensionPanelOpen = Boolean(activeId);

const updateDataLayerState = useCallback(
(newState: unknown, { isDimensionComplete = true }: { isDimensionComplete?: boolean } = {}) => {
if (!activeGroup || !activeId) {
return;
}
if (allAccessors.includes(activeId)) {
if (isDimensionComplete) {
updateDatasourceAsync(datasourceId, newState);
} else {
// The datasource can indicate that the previously-valid column is no longer
// complete, which clears the visualization. This keeps the flyout open and reuses
// the previous columnId
updateAll(
datasourceId,
newState,
activeVisualization.removeDimension({
layerId,
columnId: activeId,
prevState: visualizationState,
})
);
}
} else if (isDimensionComplete) {
updateAll(
datasourceId,
newState,
activeVisualization.setDimension({
layerId,
groupId: activeGroup.groupId,
columnId: activeId,
prevState: visualizationState,
})
);
setActiveDimension({ ...activeDimension, isNew: false });
} else {
updateDatasourceAsync(datasourceId, newState);
}
},
// eslint-disable-next-line react-hooks/exhaustive-deps
[
activeDimension,
activeGroup,
activeId,
activeVisualization,
datasourceId,
layerId,
updateAll,
updateDatasourceAsync,
visualizationState,
]
);

return (
<>
<section
Expand Down Expand Up @@ -460,43 +519,7 @@ export function LayerPanel(
dimensionGroups: groups,
toggleFullscreen,
isFullscreen,
setState: (
newState: unknown,
{ isDimensionComplete = true }: { isDimensionComplete?: boolean } = {}
) => {
if (allAccessors.includes(activeId)) {
if (isDimensionComplete) {
props.updateDatasourceAsync(datasourceId, newState);
} else {
// The datasource can indicate that the previously-valid column is no longer
// complete, which clears the visualization. This keeps the flyout open and reuses
// the previous columnId
props.updateAll(
datasourceId,
newState,
activeVisualization.removeDimension({
layerId,
columnId: activeId,
prevState: props.visualizationState,
})
);
}
} else if (isDimensionComplete) {
props.updateAll(
datasourceId,
newState,
activeVisualization.setDimension({
layerId,
groupId: activeGroup.groupId,
columnId: activeId,
prevState: props.visualizationState,
})
);
setActiveDimension({ ...activeDimension, isNew: false });
} else {
props.updateDatasourceAsync(datasourceId, newState);
}
},
setState: updateDataLayerState,
}}
/>
)}
Expand Down
9 changes: 3 additions & 6 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 @@ -570,9 +570,8 @@ describe('editor_frame', () => {
setDatasourceState(updatedState);
});

// TODO: temporary regression
// validation requires to calls this getConfiguration API
expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(9);
expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(6);
expect(mockVisualization.getConfiguration).toHaveBeenLastCalledWith(
expect.objectContaining({
state: updatedState,
Expand Down Expand Up @@ -645,9 +644,8 @@ describe('editor_frame', () => {
setDatasourceState({});
});

// TODO: temporary regression, selectors will help
// validation requires to calls this getConfiguration API
expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(9);
expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(6);
expect(mockVisualization.getConfiguration).toHaveBeenLastCalledWith(
expect.objectContaining({
frame: expect.objectContaining({
Expand Down Expand Up @@ -1124,8 +1122,7 @@ describe('editor_frame', () => {
});

// validation requires to calls this getConfiguration API
// TODO: why so many times?
expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(10);
expect(mockVisualization.getConfiguration).toHaveBeenCalledTimes(7);
expect(mockVisualization.getConfiguration).toHaveBeenCalledWith(
expect.objectContaining({
state: suggestionVisState,
Expand Down
108 changes: 63 additions & 45 deletions x-pack/plugins/lens/public/editor_frame_service/editor_frame/editor_frame.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* 2.0.
*/

import React, { useEffect, useReducer, useState, useCallback, useRef } from 'react';
import React, { useEffect, useReducer, useState, useCallback, useRef, useMemo } from 'react';
import { CoreStart } from 'kibana/public';
import { isEqual } from 'lodash';
import { PaletteRegistry } from 'src/plugins/charts/public';
Expand Down Expand Up @@ -118,56 +118,74 @@ export function EditorFrame(props: EditorFrameProps) {
);
const datasourceLayers = createDatasourceLayers(props.datasourceMap, state.datasourceStates);

const framePublicAPI: FramePublicAPI = {
datasourceLayers,
activeData,
dateRange,
query,
filters,
searchSessionId,
availablePalettes: props.palettes,

addNewLayer() {
const newLayerId = generateId();

dispatch({
type: 'UPDATE_LAYER',
datasourceId: state.activeDatasourceId!,
layerId: newLayerId,
updater: props.datasourceMap[state.activeDatasourceId!].insertLayer,
});
const framePublicAPI: FramePublicAPI = useMemo(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Probably a ref here would be even better, but it requires way more refactoring than just this place.

() => ({
datasourceLayers,
activeData,
dateRange,
query,
filters,
searchSessionId,
availablePalettes: props.palettes,

return newLayerId;
},
addNewLayer() {
const newLayerId = generateId();

removeLayers(layerIds: string[]) {
if (activeVisualization && activeVisualization.removeLayer && state.visualization.state) {
dispatch({
type: 'UPDATE_VISUALIZATION_STATE',
visualizationId: activeVisualization.id,
updater: layerIds.reduce(
(acc, layerId) =>
activeVisualization.removeLayer ? activeVisualization.removeLayer(acc, layerId) : acc,
state.visualization.state
),
type: 'UPDATE_LAYER',
datasourceId: state.activeDatasourceId!,
layerId: newLayerId,
updater: props.datasourceMap[state.activeDatasourceId!].insertLayer,
});
}

layerIds.forEach((layerId) => {
const layerDatasourceId = Object.entries(props.datasourceMap).find(
([datasourceId, datasource]) =>
state.datasourceStates[datasourceId] &&
datasource.getLayers(state.datasourceStates[datasourceId].state).includes(layerId)
)![0];
dispatch({
type: 'UPDATE_LAYER',
layerId,
datasourceId: layerDatasourceId,
updater: props.datasourceMap[layerDatasourceId].removeLayer,
return newLayerId;
},

removeLayers(layerIds: string[]) {
if (activeVisualization && activeVisualization.removeLayer && state.visualization.state) {
dispatch({
type: 'UPDATE_VISUALIZATION_STATE',
visualizationId: activeVisualization.id,
updater: layerIds.reduce(
(acc, layerId) =>
activeVisualization.removeLayer
? activeVisualization.removeLayer(acc, layerId)
: acc,
state.visualization.state
),
});
}

layerIds.forEach((layerId) => {
const layerDatasourceId = Object.entries(props.datasourceMap).find(
([datasourceId, datasource]) =>
state.datasourceStates[datasourceId] &&
datasource.getLayers(state.datasourceStates[datasourceId].state).includes(layerId)
)![0];
dispatch({
type: 'UPDATE_LAYER',
layerId,
datasourceId: layerDatasourceId,
updater: props.datasourceMap[layerDatasourceId].removeLayer,
});
});
});
},
};
},
}),
[
activeData,
activeVisualization,
datasourceLayers,
dateRange,
query,
filters,
searchSessionId,
props.palettes,
props.datasourceMap,
state.activeDatasourceId,
state.datasourceStates,
state.visualization.state,
]
);

useEffect(
() => {
Expand Down
5 changes: 3 additions & 2 deletions 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 @@ -7,6 +7,7 @@

import { SavedObjectReference } from 'kibana/public';
import { Ast } from '@kbn/interpreter/common';
import memoizeOne from 'memoize-one';
import {
Datasource,
DatasourcePublicAPI,
Expand Down Expand Up @@ -53,7 +54,7 @@ export async function initializeDatasources(
return states;
}

export function createDatasourceLayers(
export const createDatasourceLayers = memoizeOne(function createDatasourceLayers(
datasourceMap: Record<string, Datasource>,
datasourceStates: Record<string, { state: unknown; isLoading: boolean }>
) {
Expand All @@ -73,7 +74,7 @@ export function createDatasourceLayers(
});
});
return datasourceLayers;
}
});

export async function persistedStateToExpression(
datasources: Record<string, Datasource>,
Expand Down
Loading