Add saved queries to maps #44442

TinaHeiligers · 2019-08-29T23:01:28Z

Summary

Saved queries were introduced in 7.4 in applications that used the full search bar and, at that time, the scope was Discover, Dashboard and Visualize. Maps introduced filters during the course of saved queries development and was not within the original scope of the feature introduction. Now that the full search bar is used, this PR introduces "saved queries" to Maps.

What are saved queries?
From Implement saved queries and filters

Saved queries are a new saved object type similar to saved searches but more limited in scope. They allow users to store the the query string in the query bar and optionally the set of filters and timefilter in order to reload them anywhere a query is expected: Discover, Visualize, Dashboard, anywhere that uses our full SearchBar component.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~- [] This was checked for cross-browser compatibility, including a check against IE11~~
~~- [ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
~~- [ ] Documentation was added for features that require explanation or tutorials~~

Unit or functional tests were updated or added to match the most common scenarios
~~- [ ] This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

… changes to last 15 min on saving a query with a time filter. The time filter saves correctly in the saved query

…ries-to-maps

… all privileges

…al tests

elasticmachine · 2019-08-29T23:01:29Z

Pinging @elastic/kibana-app

elasticmachine · 2019-08-29T23:01:30Z

Pinging @elastic/kibana-gis

elasticmachine · 2019-08-30T00:41:18Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…ries-to-maps

elasticmachine · 2019-08-30T22:59:51Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

nreese

Thanks for adding saved queries to Maps.

x-pack/test/functional/es_archives/maps/kibana/data.json

x-pack/legacy/plugins/maps/public/angular/map_controller.js

…ries-to-maps

elasticmachine · 2019-09-03T19:13:55Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

TinaHeiligers · 2019-09-03T19:38:25Z

@Bargs do we need to add the v8.0.0 label to all new PR's from now? I thought that this work was targeted for v7.5.

Bargs · 2019-09-03T20:32:11Z

@TinaHeiligers we always label PRs with every version that they will get merged into.

elasticmachine · 2019-09-03T20:46:35Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

nreese · 2019-09-03T21:22:41Z

x-pack/legacy/plugins/maps/public/angular/map_controller.js

+    $state.savedQuery = newSavedQuery.id;
+
+    if (newSavedQuery.id === (oldSavedQuery && oldSavedQuery.id)) {
+      updateStateFromSavedQuery(newSavedQuery);


Calling updateStateFromSavedQuery inside the savedQuery watch results in dispatching onQueryChange multiple times. on-query-submit callback is called when saved query is saved. That triggers onQueryChange. Is there ever an instance where savedQuery changes and on-query-submit, on-refresh-change, or on-filters-updated has not already been triggered?

@nreese after consulting with @Bargs, I deleted a redundant call to onQuerySubmit from the search bar, thereby reducing the number of time onQueryChange is called. @Bargs, please confirm the change is what we decided on as a solution.

@nreese If I understand your comment, the trouble also lies with calling updateStateFromSavedQuery inside the watchers on $state.savedQuery and $scope.savedQuery. I'm looking into that too. Done: 1b8333f#diff-8f39ea21edecd35fad6f4c0df45681a3L195

I wouldn't call the line removed in 1b8333f redundant. Things only work now because the watcher on $scope.savedQuery runs after the async request for the saved query completes. At that point the old and new saved query IDs are the same so the conditional passes and we call updateStateFromSavedQuery. But that's not why we added that conditional in the first place. It's an unintentional and confusing side effect and I don't think we should rely on it.

I was thinking about how we set up these watchers some more and I think we're unnecessarily triggering a request for the saved query from the server when we already have it in hand. That's ultimately causing the unnecessary extra call of updateStateFromSavedQuery as well. I didn't think I could explain this idea very well in text, so @TinaHeiligers I submitted a PR against your branch to demonstrate the change I'm suggesting.

https://github.com/TinaHeiligers/kibana/pull/4/files

@Bargs the changes have been implemented and onQueryChange now only dispatches once per event.

Would you mind applying these changes to Discover, Visualize, and Dashboard as well? updateStateFromSavedQuery also gets called twice in those apps, and this should solve it.

@Bargs Sure, I'll create a new branch for that.
PR #45046

x-pack/legacy/plugins/maps/public/angular/map_controller.js

…ries-to-maps

elasticmachine · 2019-09-04T19:57:59Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…ry watcher

elasticmachine · 2019-09-04T22:39:32Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…ries-to-maps

elasticmachine · 2019-09-05T18:42:24Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…ries-to-maps

elasticmachine · 2019-09-06T16:59:34Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…ries-to-maps

elasticmachine · 2019-09-09T15:50:33Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

nreese

Thanks for adding Saved query support to Maps. This is going to be really useful

LGTM
Code review, tested in chrome

* initial attempt at adding saved-queries to maps * Adds savedQuery methods to map_controller * Adds saveQuery to Maps ui * Fixes watcher on state * Fixes adding filters, still debuggin why the timefilter automatically changes to last 15 min on saving a query with a time filter. The time filter saves correctly in the saved query * Gets time filter working with saved queries * Adds saved query management component functionality tests to maps for all privileges * Adds a saved query to the mapping and data for maps security functional tests * Updates test saved query doc * Adds functional tests for saved queries as a maps read-only user * Adds 'skip' back to maps security functional tests * uses onRefreshChange in map_controller * Removes redundant trigger of onQuerySubmit call in the search bar * deletes redundant call to updateStateFromSavedQuery in state.savedQuery watcher * Refactors savedQuery watchers in map controller

TinaHeiligers added 14 commits August 26, 2019 16:01

initial attempt at adding saved-queries to maps

71ba760

Merge branch 'master' into add-saved-queries-to-maps

ef3b6ac

Adds savedQuery methods to map_controller

180e175

Adds saveQuery to Maps ui

33e4ec4

Fixes watcher on state

31c767f

Fixes adding filters, still debuggin why the timefilter automatically…

9e72e68

… changes to last 15 min on saving a query with a time filter. The time filter saves correctly in the saved query

Merge branch 'master' of github.com:elastic/kibana into add-saved-que…

4e98f88

…ries-to-maps

Merge branch 'master' of github.com:elastic/kibana into add-saved-que…

19ca831

…ries-to-maps

Gets time filter working with saved queries

683b76b

Adds saved query management component functionality tests to maps for…

5c8f731

… all privileges

Adds a saved query to the mapping and data for maps security function…

cf7e0b5

…al tests

Updates test saved query doc

40424c9

Adds functional tests for saved queries as a maps read-only user

fcd6098

Adds 'skip' back to maps security functional tests

ddf0923

TinaHeiligers added [Deprecated-Use Team:Presentation]Team:Geo Former Team Label for Geo Team. Now use Team:Presentation Team:Visualizations Visualization editors, elastic-charts and infrastructure v7.5.0 labels Aug 29, 2019

TinaHeiligers added the release_note:enhancement label Aug 29, 2019

TinaHeiligers requested review from nreese and Bargs August 29, 2019 23:29

Merge branch 'master' of github.com:elastic/kibana into add-saved-que…

17fd9fe

…ries-to-maps

nreese reviewed Sep 3, 2019

View reviewed changes

x-pack/test/functional/es_archives/maps/kibana/data.json Show resolved Hide resolved

x-pack/legacy/plugins/maps/public/angular/map_controller.js Outdated Show resolved Hide resolved

Merge branch 'master' of github.com:elastic/kibana into add-saved-que…

bc2af18

…ries-to-maps

Bargs added the v8.0.0 label Sep 3, 2019

uses onRefreshChange in map_controller

4333b87

nreese reviewed Sep 3, 2019

View reviewed changes

TinaHeiligers added 2 commits September 4, 2019 08:23

Merge branch 'master' of github.com:elastic/kibana into add-saved-que…

75b1ad0

…ries-to-maps

Removes redundant trigger of onQuerySubmit call in the search bar

4d6a62c

deletes redundant call to updateStateFromSavedQuery in state.savedQue…

1b8333f

…ry watcher

TinaHeiligers added 2 commits September 5, 2019 07:43

Merge branch 'master' of github.com:elastic/kibana into add-saved-que…

e9fdada

…ries-to-maps

Refactors savedQuery watchers in map controller

72e9d7d

Merge branch 'master' of github.com:elastic/kibana into add-saved-que…

5151323

…ries-to-maps

TinaHeiligers added 2 commits September 6, 2019 16:22

Merge branch 'master' of github.com:elastic/kibana into add-saved-que…

d7a5448

…ries-to-maps

Merge branch 'master' of github.com:elastic/kibana into add-saved-que…

88f9313

…ries-to-maps

nreese approved these changes Sep 9, 2019

View reviewed changes

TinaHeiligers merged commit 2541850 into elastic:master Sep 9, 2019

TinaHeiligers mentioned this pull request Sep 9, 2019

[7.x] Add saved queries to maps (#44442) #45165

Merged

TinaHeiligers deleted the add-saved-queries-to-maps branch September 9, 2019 18:02

TinaHeiligers mentioned this pull request Sep 17, 2019

Add Saved Queries to Maps #43922

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add saved queries to maps #44442

Add saved queries to maps #44442

TinaHeiligers commented Aug 29, 2019 •

edited

Loading

elasticmachine commented Aug 29, 2019

elasticmachine commented Aug 29, 2019

elasticmachine commented Aug 30, 2019

elasticmachine commented Aug 30, 2019

nreese left a comment

elasticmachine commented Sep 3, 2019

TinaHeiligers commented Sep 3, 2019

Bargs commented Sep 3, 2019

elasticmachine commented Sep 3, 2019

nreese Sep 3, 2019 •

edited

Loading

TinaHeiligers Sep 4, 2019

TinaHeiligers Sep 4, 2019 •

edited

Loading

Bargs Sep 4, 2019

TinaHeiligers Sep 5, 2019

Bargs Sep 6, 2019

TinaHeiligers Sep 6, 2019 •

edited

Loading

elasticmachine commented Sep 4, 2019

elasticmachine commented Sep 4, 2019

elasticmachine commented Sep 5, 2019

elasticmachine commented Sep 6, 2019

elasticmachine commented Sep 9, 2019

nreese left a comment

Add saved queries to maps #44442

Add saved queries to maps #44442

Conversation

TinaHeiligers commented Aug 29, 2019 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Aug 29, 2019

elasticmachine commented Aug 29, 2019

elasticmachine commented Aug 30, 2019

💚 Build Succeeded

elasticmachine commented Aug 30, 2019

💚 Build Succeeded

nreese left a comment

Choose a reason for hiding this comment

elasticmachine commented Sep 3, 2019

💚 Build Succeeded

TinaHeiligers commented Sep 3, 2019

Bargs commented Sep 3, 2019

elasticmachine commented Sep 3, 2019

💚 Build Succeeded

nreese Sep 3, 2019 • edited Loading

Choose a reason for hiding this comment

TinaHeiligers Sep 4, 2019

Choose a reason for hiding this comment

TinaHeiligers Sep 4, 2019 • edited Loading

Choose a reason for hiding this comment

Bargs Sep 4, 2019

Choose a reason for hiding this comment

TinaHeiligers Sep 5, 2019

Choose a reason for hiding this comment

Bargs Sep 6, 2019

Choose a reason for hiding this comment

TinaHeiligers Sep 6, 2019 • edited Loading

Choose a reason for hiding this comment

elasticmachine commented Sep 4, 2019

💚 Build Succeeded

elasticmachine commented Sep 4, 2019

💚 Build Succeeded

elasticmachine commented Sep 5, 2019

💚 Build Succeeded

elasticmachine commented Sep 6, 2019

💚 Build Succeeded

elasticmachine commented Sep 9, 2019

💚 Build Succeeded

nreese left a comment

Choose a reason for hiding this comment

TinaHeiligers commented Aug 29, 2019 •

edited

Loading

nreese Sep 3, 2019 •

edited

Loading

TinaHeiligers Sep 4, 2019 •

edited

Loading

TinaHeiligers Sep 6, 2019 •

edited

Loading