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

[Visualize] Make linked saved search work when user navigates back using browser back button #59690

Merged
merged 7 commits into from
Mar 12, 2020
Merged

[Visualize] Make linked saved search work when user navigates back using browser back button #59690

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c8f3527
Fix linked search behavior
sulemanof Mar 9, 2020
bdc2e4a
Revert relying on savedSearchId in url
sulemanof Mar 10, 2020
05a4eee
Merge branch 'master' into fix/linked_search
sulemanof Mar 11, 2020
85e40c0
Fix comments
sulemanof Mar 11, 2020
b45bd07
Return back savedSearchId into vis object
sulemanof Mar 11, 2020
75e3d32
Merge remote-tracking branch 'upstream/master' into fix/linked_search
sulemanof Mar 11, 2020
d1ebdad
Merge branch 'master' into fix/linked_search
elasticmachine Mar 11, 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
59 changes: 27 additions & 32 deletions src/legacy/core_plugins/kibana/public/visualize/np_ready/editor/editor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,8 @@ function VisualizeAppController(
savedVis.vis.on('apply', _applyVis);
// vis is instance of src/legacy/ui/public/vis/vis.js.
// SearchSource is a promise-based stream of search results that can inherit from other search sources.
const { vis, searchSource } = savedVis;
const { vis, searchSource, savedSearchId } = savedVis;
const searchSourceParent = searchSource.getParent();

$scope.vis = vis;

Expand Down Expand Up @@ -379,6 +380,18 @@ function VisualizeAppController(
},
};

const handleLinkedSearch = linked => {
if (linked && !savedVis.savedSearchId) {
Copy link
Member

Choose a reason for hiding this comment

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

this confuses me ... you desctructure savedSearchId from savedVis ... so this logic is actually:

if (linked && !savedVis.savdSearchId) {
  savedVis.savedSearchId = savedVis.savedSearchId;
  vis.savedSearchId = savedVis.savedSearchId;
  ...
}

also i am not sure why we need to duplicate information on vis.savedSearchId, which is also violating the types (vis has no savedSearchId property)

Copy link
Member

@ppisljar ppisljar Mar 11, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

i think once you unlink, all we need is to delete savedVis.savedSearchId (for the sake of saved object) and remove the parent search source (for the sake of current view)

and when linking back, you will need to select the saved search, so you get the new savedSearchId and you can set it on savedVis

Copy link
Member

Choose a reason for hiding this comment

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

ps: i am working on a small refactor to vis saved object and vis state, which will allow to further clean this up: you will no longer need to care about savedVis here, all you will need to do is remove parent search source and we will provide utilities to serialize searchSource + vis into the saved vis object.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey @ppisljar , thanks for taking a look and reasonable comments here!
PR updated!
About storing the vis.savedSearchId , I'm not sure why, but it's presented in the vis object on creation of a visualization based on saved search:

image

so would be great if you could get rid of it in your refactoring pr.

savedVis.savedSearchId = savedSearchId;
vis.savedSearchId = savedSearchId;

searchSource.setParent(searchSourceParent);
} else if (!linked && savedVis.savedSearchId) {
delete savedVis.savedSearchId;
delete vis.savedSearchId;
}
};

// Create a PersistedState instance for uiState.
const { persistedState, unsubscribePersisted, persistOnChange } = makeStateful(
'uiState',
Expand All @@ -387,9 +400,9 @@ function VisualizeAppController(
$scope.uiState = persistedState;
$scope.savedVis = savedVis;
$scope.query = initialState.query;
$scope.linked = initialState.linked;
$scope.searchSource = searchSource;
$scope.refreshInterval = timefilter.getRefreshInterval();
handleLinkedSearch(initialState.linked);

const addToDashMode =
$route.current.params[DashboardConstants.ADD_VISUALIZATION_TO_DASHBOARD_MODE_PARAM];
Expand Down Expand Up @@ -468,7 +481,7 @@ function VisualizeAppController(
$scope.fetch = function() {
const { query, linked, filters } = stateContainer.getState();
$scope.query = query;
$scope.linked = linked;
handleLinkedSearch(linked);
savedVis.searchSource.setField('query', query);
savedVis.searchSource.setField('filter', filters);
$scope.$broadcast('render');
Expand Down Expand Up @@ -558,20 +571,6 @@ function VisualizeAppController(
updateStateFromSavedQuery(savedQuery);
};

$scope.$watch('linked', linked => {
if (linked && !savedVis.savedSearchId) {
savedVis.savedSearchId = savedVis.searchSource.id;
vis.savedSearchId = savedVis.searchSource.id;

$scope.$broadcast('render');
} else if (!linked && savedVis.savedSearchId) {
delete savedVis.savedSearchId;
delete vis.savedSearchId;

$scope.$broadcast('render');
}
});

/**
* Called when the user clicks "Save" button.
*/
Expand Down Expand Up @@ -663,23 +662,21 @@ function VisualizeAppController(
}

const unlinkFromSavedSearch = () => {
const searchSourceParent = searchSource.getParent();
const searchSourceGrandparent = searchSourceParent.getParent();
if (!searchSourceParent) {
return;
}

delete savedVis.savedSearchId;
delete vis.savedSearchId;
searchSourceParent.setField(
'filter',
_.union(searchSource.getOwnField('filter'), searchSourceParent.getOwnField('filter'))
);
const searchSourceGrandparent = searchSourceParent.getParent();
const currentIndex = searchSourceParent.getField('index');

stateContainer.transitions.unlinkSavedSearch(
searchSourceParent.getField('query'),
searchSourceParent.getField('filter')
);
searchSource.setField('index', searchSourceParent.getField('index'));
searchSource.setField('index', currentIndex);
Copy link
Contributor Author

@sulemanof sulemanof Mar 10, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I'm still not sure, whether we should inherit the index of the parent source while unlinking,
since both the searchSource index and searchSourceParent index are equal always. At least, I didn't find a case, when they could be different.
Maybe it's a question to @ppisljar

Copy link
Member

Choose a reason for hiding this comment

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

if you create visualization based on saved search, then searchsource won't have index field, but the parent will.
calling searchSource.getField('index') will of course show the correct index (as that walks up the tree)

searchSource.setParent(searchSourceGrandparent);

stateContainer.transitions.unlinkSavedSearch({
query: searchSourceParent.getField('query'),
parentFilters: searchSourceParent.getOwnField('filter'),
});

toastNotifications.addSuccess(
i18n.translate('kbn.visualize.linkedToSearch.unlinkSuccessNotificationText', {
defaultMessage: `Unlinked from saved search '{searchTitle}'`,
Expand All @@ -688,8 +685,6 @@ function VisualizeAppController(
},
})
);

$scope.fetch();
};

$scope.getAdditionalMessage = () => {
Expand Down
8 changes: 4 additions & 4 deletions src/legacy/core_plugins/kibana/public/visualize/np_ready/editor/lib/visualize_app_state.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/

import { isFunction, omit } from 'lodash';
import { isFunction, omit, union } from 'lodash';

import { migrateAppState } from './migrate_app_state';
import {
Expand Down Expand Up @@ -75,10 +75,10 @@ export function useVisualizeAppState({ stateDefaults, kbnUrlStateStorage }: Argu
query: defaultQuery,
};
},
unlinkSavedSearch: state => (query, filters) => ({
unlinkSavedSearch: state => ({ query, parentFilters = [] }) => ({
...state,
query,
filters,
query: query || state.query,
filters: union(state.filters, parentFilters),
linked: false,
}),
updateVisState: state => newVisState => ({ ...state, vis: toObject(newVisState) }),
Expand Down
2 changes: 1 addition & 1 deletion src/legacy/core_plugins/kibana/public/visualize/np_ready/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export interface VisualizeAppStateTransitions {
removeSavedQuery: (state: VisualizeAppState) => (defaultQuery: Query) => VisualizeAppState;
unlinkSavedSearch: (
state: VisualizeAppState
) => (query: Query, filters: Filter[]) => VisualizeAppState;
) => ({ query, parentFilters }: { query?: Query; parentFilters?: Filter[] }) => VisualizeAppState;
updateVisState: (state: VisualizeAppState) => (vis: PureVisState) => VisualizeAppState;
updateFromSavedQuery: (state: VisualizeAppState) => (savedQuery: SavedQuery) => VisualizeAppState;
}
Expand Down