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.

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

Retain pinned filters when loading and clearing saved queries #54307

Merged
merged 7 commits into from
Jan 21, 2020
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -470,18 +470,21 @@ export class DashboardAppController {
language:
localStorage.get('kibana.userQueryLanguage') || config.get('search:queryLanguage'),
},
[]
queryFilter.getGlobalFilters()
);
// Making this method sync broke the updates.
// Temporary fix, until we fix the complex state in this file.
setTimeout(queryFilter.removeAll, 0);
setTimeout(() => {
queryFilter.setFilters(queryFilter.getGlobalFilters());
}, 0);
};

const updateStateFromSavedQuery = (savedQuery: SavedQuery) => {
dashboardStateManager.applyFilters(
savedQuery.attributes.query,
savedQuery.attributes.filters || []
);
const savedQueryFilters = savedQuery.attributes.filters || [];
const globalFilters = queryFilter.getGlobalFilters();
const allFilters = [...globalFilters, ...savedQueryFilters];

dashboardStateManager.applyFilters(savedQuery.attributes.query, allFilters);
if (savedQuery.attributes.timefilter) {
timefilter.setTime({
from: savedQuery.attributes.timefilter.from,
Expand All @@ -494,7 +497,7 @@ export class DashboardAppController {
// Making this method sync broke the updates.
// Temporary fix, until we fix the complex state in this file.
setTimeout(() => {
queryFilter.setFilters(savedQuery.attributes.filters || []);
queryFilter.setFilters(allFilters);
}, 0);
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1000,15 +1000,17 @@ function discoverController(
query: '',
language: localStorage.get('kibana.userQueryLanguage') || config.get('search:queryLanguage'),
};
filterManager.removeAll();
filterManager.setFilters(filterManager.getGlobalFilters());
$state.save();
$scope.fetch();
};

const updateStateFromSavedQuery = savedQuery => {
$state.query = savedQuery.attributes.query;
$state.save();
filterManager.setFilters(savedQuery.attributes.filters || []);
const savedQueryFilters = savedQuery.attributes.filters || [];
const globalFilters = filterManager.getGlobalFilters();
filterManager.setFilters([...globalFilters, ...savedQueryFilters]);

if (savedQuery.attributes.timefilter) {
timefilter.setTime({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ function VisualizeAppController(
language:
localStorage.get('kibana.userQueryLanguage') || uiSettings.get('search:queryLanguage'),
};
queryFilter.removeAll();
queryFilter.setFilters(queryFilter.getGlobalFilters());
$state.save();
$scope.fetch();
};
Expand All @@ -505,7 +505,9 @@ function VisualizeAppController(
$state.query = savedQuery.attributes.query;
$state.save();

queryFilter.setFilters(savedQuery.attributes.filters || []);
const savedQueryFilters = savedQuery.attributes.filters || [];
const globalFilters = queryFilter.getGlobalFilters();
queryFilter.setFilters([...globalFilters, ...savedQueryFilters]);

if (savedQuery.attributes.timefilter) {
timefilter.setTime({
Expand Down
22 changes: 18 additions & 4 deletions x-pack/legacy/plugins/lens/public/app_plugin/app.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ import { EditorFrameInstance } from '../types';
import { Storage } from '../../../../../../src/plugins/kibana_utils/public';
import { Document, SavedObjectStore } from '../persistence';
import { mount } from 'enzyme';
import { esFilters, IFieldType, IIndexPattern } from '../../../../../../src/plugins/data/public';
import {
esFilters,
FilterManager,
IFieldType,
IIndexPattern,
} from '../../../../../../src/plugins/data/public';
import { dataPluginMock } from '../../../../../../src/plugins/data/public/mocks';
const dataStartMock = dataPluginMock.createStartContract();

Expand Down Expand Up @@ -60,6 +65,10 @@ function createMockFilterManager() {
subscriber();
},
getFilters: () => filters,
getGlobalFilters: () => {
// @ts-ignore
return filters.filter(esFilters.isFilterPinned);
},
removeAll: () => {
filters = [];
subscriber();
Expand Down Expand Up @@ -821,7 +830,7 @@ describe('Lens App', () => {
);
});

it('clears all existing filters when the active saved query is cleared', () => {
it('clears all existing unpinned filters when the active saved query is cleared', () => {
const args = makeDefaultArgs();
args.editorFrame = frame;

Expand All @@ -834,8 +843,13 @@ describe('Lens App', () => {

const indexPattern = ({ id: 'index1' } as unknown) as IIndexPattern;
const field = ({ name: 'myfield' } as unknown) as IFieldType;
const pinnedField = ({ name: 'pinnedField' } as unknown) as IFieldType;

args.data.query.filterManager.setFilters([esFilters.buildExistsFilter(field, indexPattern)]);
const unpinned = esFilters.buildExistsFilter(field, indexPattern);
const pinned = esFilters.buildExistsFilter(pinnedField, indexPattern);
FilterManager.setFiltersStore([pinned], esFilters.FilterStateStore.GLOBAL_STATE);

args.data.query.filterManager.setFilters([pinned, unpinned]);
instance.update();

instance.find(TopNavMenu).prop('onClearSavedQuery')!();
Expand All @@ -844,7 +858,7 @@ describe('Lens App', () => {
expect(frame.mount).toHaveBeenLastCalledWith(
expect.any(Element),
expect.objectContaining({
filters: [],
filters: [pinned],
})
);
});
Expand Down
8 changes: 5 additions & 3 deletions x-pack/legacy/plugins/lens/public/app_plugin/app.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,9 @@ export function App({
setState(s => ({ ...s, savedQuery }));
}}
onSavedQueryUpdated={savedQuery => {
data.query.filterManager.setFilters(savedQuery.attributes.filters || state.filters);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@wylieconlon do you mind looking at the Lens changes to make sure I didn't screw anything up? It's just this file and the test file above.

const savedQueryFilters = savedQuery.attributes.filters || [];
const globalFilters = data.query.filterManager.getGlobalFilters();
data.query.filterManager.setFilters([...globalFilters, ...savedQueryFilters]);
setState(s => ({
...s,
savedQuery: { ...savedQuery }, // Shallow query for reference issues
Expand All @@ -252,11 +254,11 @@ export function App({
}));
}}
onClearSavedQuery={() => {
data.query.filterManager.removeAll();
data.query.filterManager.setFilters(data.query.filterManager.getGlobalFilters());
setState(s => ({
...s,
savedQuery: undefined,
filters: [],
filters: data.query.filterManager.getGlobalFilters(),
query: {
query: '',
language:
Expand Down
10 changes: 7 additions & 3 deletions x-pack/legacy/plugins/maps/public/angular/map_controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ app.controller(
delete $scope.savedQuery;
delete $state.savedQuery;
onQueryChange({
filters: [],
filters: filterManager.getGlobalFilters(),
query: {
query: '',
language: localStorage.get('kibana.userQueryLanguage'),
Expand All @@ -162,6 +162,10 @@ app.controller(
};

function updateStateFromSavedQuery(savedQuery) {
const savedQueryFilters = savedQuery.attributes.filters || [];
const globalFilters = filterManager.getGlobalFilters();
const allFilters = [...savedQueryFilters, ...globalFilters];

if (savedQuery.attributes.timefilter) {
if (savedQuery.attributes.timefilter.refreshInterval) {
$scope.onRefreshChange({
Expand All @@ -170,13 +174,13 @@ app.controller(
});
}
onQueryChange({
filters: savedQuery.attributes.filters || [],
filters: allFilters,
query: savedQuery.attributes.query,
time: savedQuery.attributes.timefilter,
});
} else {
onQueryChange({
filters: savedQuery.attributes.filters || [],
filters: allFilters,
query: savedQuery.attributes.query,
});
}
Expand Down