Fix dashboard to refresh visualizations when the refresh button is clicked #27353

stacey-gammon · 2018-12-18T00:38:01Z

suggestions to put on top of #27260

Summary

This PR updates dashboard so that clicking on the refresh button actually refreshes visualizations.

As of #19172, visualizations don't inherit from the dashboard's search source. As a result, when the search source is updated (even when clicking on the "refresh" button), they don't automatically get the new data that's fetched.

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

…icked

…/kibana into lukasolson-fix/dashboard-refresh

stacey-gammon · 2018-12-18T00:40:24Z

@lukasolson - sorry I'm not sure how to do that "suggest changes on top of this PR" for your PR, but what do you think of this method? I think you were on point for doing the route of a timestamp for the last fetch time. This completely removes the need for any embeddable store. I remember now that I went through an iteration with a store of embeddables and got some great feedback for removing the need for it, but keeping all of the management local inside dashboard_panel.js - that way that is the only thing that cares about the embeddable instance and there is less risk of forgetting about proper clean up of that object once the react component is destroyed.

This also lessens the coupling to angular I think, by removing the reload provider. cc @ppisljar

stacey-gammon · 2018-12-18T00:41:19Z

I think it'll also make it easy to do per panel reload requests, since the time stamp is stored on the redux tree, per embeddable.

elasticmachine · 2018-12-18T01:15:14Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

stacey-gammon · 2018-12-18T01:28:17Z

all tests passed except a stale dashboard jest snapshot that needs to be updated.

lukasolson · 2018-12-18T17:22:54Z

src/legacy/core_plugins/kibana/public/dashboard/dashboard_app.js

@@ -231,8 +231,6 @@ app.directive('dashboardApp', function ($injector) {
        $scope.indexPatterns = dashboardStateManager.getPanelIndexPatterns();
      };

-      $scope.$watch('model.query', $scope.updateQueryAndFetch);


Removing this line does prevent the duplicate network call, but it also makes it so that if you change the query in the URL (and not in the query bar), then saved searches aren't updated.

Cool, added a test that would have caught that and confirmed it fails:

lukasolson · 2018-12-18T17:29:02Z

It still seems odd to me to store something in state relating to a reload handler but honestly I like this approach much better than the way I was doing it before.

stacey-gammon · 2018-12-18T19:09:34Z

It still seems odd to me to store something in state relating to a reload handler but honestly I like this approach much better than the way I was doing it before.

Yea, I agree. I had a few thoughts/questions on this:

Do we want to reload the visualizations if an absolute time is chosen? Maybe because we are expecting data to be re-indexed? Or maybe that's so rare that it's okay to expect them to do a hard refresh in that case, and otherwise, the "refresh" button is only there to update the "now" time. If the latter, then you could store a timestamp for "now" which would be useful for relative timestamps - which could be helpful anyway in seeing how stale data is on a dashboard and I think there are requests for something like that (related: #21483)

But since I'm not sure of the answer to that, I think this is an okay solution. If you really want to hard refresh when that button is clicked, then I think it's okay to store this timestamp on there. I could even see it being useful in the UI (last query at timestamp x). But if anyone has other suggestions, I'm open!

…in url is modified

elasticmachine · 2018-12-18T19:46:41Z

Pinging @elastic/kibana-app

elasticmachine · 2018-12-18T19:50:19Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

lukasolson · 2018-12-18T20:02:43Z

src/legacy/core_plugins/kibana/public/dashboard/dashboard_state_manager.js

@@ -219,6 +220,12 @@ export class DashboardStateManager {
      FilterUtils.cleanFiltersForComparison(getFilters(state))
    )) {
      store.dispatch(updateFilters(dashboardFilters));
+    } else {
+      // If the user clickes "refresh" query, it'll get here but without any changes, we still


What if you added a separate method to DashboardStateManager to request reload? Then we can call that directly inside updateQueryAndFetch.

Can you help me see why you prefer that way? I tried to take as much code out of the dashboard_app file because it is coupled to angular, so any logic that didn't require scope, I would put into dashboard_state_manager. Way back dashboard_app was a monolithic file with all logic and everything tightly coupled to angular. Plus, if we pull out into dashboard_app, then to eliminate the double reload, we would have to duplicate the logic for determining if the filters changed and already caused an update in here. Just don't really see it as an improvement. Thoughts?

I understand your point of view, I agree that it'd be nice to remove as much as we can that relies on $scope and Angular. My argument is that in my brain "reloading" is meant to be an intentional action you take. In the current implementation it's a side effect that happens any time applyFilters is called, but the filters and query haven't changed. While that may currently only happen when the refresh button is clicked, couldn't there be other situations where applyFilters is called, and nothing changed, and we don't actually want to reload all of the embeddables?

Thanks for the explanation. I don't feel that strongly about this way, and I see your point, I can make the change. Stay tuned!

lukasolson · 2018-12-18T20:03:14Z

Do we want to reload the visualizations if an absolute time is chosen? Maybe because we are expecting data to be re-indexed?

Yeah, I think that's probably not actually all that rare, I think the way you've done it is good for now.

elasticmachine · 2018-12-18T20:24:27Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

joelgriffith

Looks good aside from the already mentioned comments.

elasticmachine · 2018-12-18T23:03:04Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

lukasolson

LGTM!

elasticmachine · 2018-12-18T23:20:10Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…icked (elastic#27353) * Fix dashboard to refresh visualizations when the refresh button is clicked * Suggestions * Fix tests * Catch bug with a new test to ensure saved searches update when query in url is modified * Add a test that would have caught the initial problem * Final fixes that should get ci passing and the bug fixed * Move requestReload out of _pushFiltersToState * Fix comparison

…icked (#27353) (#27458) * Fix dashboard to refresh visualizations when the refresh button is clicked * Suggestions * Fix tests * Catch bug with a new test to ensure saved searches update when query in url is modified * Add a test that would have caught the initial problem * Final fixes that should get ci passing and the bug fixed * Move requestReload out of _pushFiltersToState * Fix comparison

lukasolson and others added 3 commits December 14, 2018 15:09

Fix dashboard to refresh visualizations when the refresh button is cl…

f2df0ff

…icked

Merge branch 'fix/dashboard-refresh' of https://github.com/lukasolson…

881ed06

…/kibana into lukasolson-fix/dashboard-refresh

Suggestions

d9cb37e

lukasolson reviewed Dec 18, 2018

View reviewed changes

stacey-gammon added 4 commits December 18, 2018 14:12

Fix tests

f44fd61

Catch bug with a new test to ensure saved searches update when query …

c1cae0b

…in url is modified

Add a test that would have caught the initial problem

13d6242

Final fixes that should get ci passing and the bug fixed

46dfa60

stacey-gammon added the Team:Visualizations Visualization editors, elastic-charts and infrastructure label Dec 18, 2018

stacey-gammon added release_note:fix Feature:Dashboard Dashboard related features v7.0.0 v6.6.0 review labels Dec 18, 2018

stacey-gammon changed the title ~~Lukasolson fix/dashboard refresh~~ Fix dashboard to refresh visualizations when the refresh button is clicked Dec 18, 2018

lukasolson reviewed Dec 18, 2018

View reviewed changes

joelgriffith self-requested a review December 18, 2018 20:33

joelgriffith approved these changes Dec 18, 2018

View reviewed changes

stacey-gammon added 2 commits December 18, 2018 17:03

Move requestReload out of _pushFiltersToState

8df3196

Fix comparison

eb94441

lukasolson approved these changes Dec 18, 2018

View reviewed changes

stacey-gammon merged commit b2576f5 into elastic:master Dec 18, 2018

stacey-gammon mentioned this pull request Dec 18, 2018

[6.x] Fix dashboard to refresh visualizations when the refresh button is clicked (#27353) #27458

Merged

lukasolson mentioned this pull request Jan 2, 2019

Fix dashboard to refresh visualizations when the refresh button is clicked #27260

Closed

7 tasks

lukasolson mentioned this pull request Mar 14, 2019

Fix apps to always migrate legacy queries on state change #33276

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix dashboard to refresh visualizations when the refresh button is clicked #27353

Fix dashboard to refresh visualizations when the refresh button is clicked #27353

stacey-gammon commented Dec 18, 2018 •

edited

Loading

stacey-gammon commented Dec 18, 2018

stacey-gammon commented Dec 18, 2018

elasticmachine commented Dec 18, 2018

stacey-gammon commented Dec 18, 2018

lukasolson Dec 18, 2018

stacey-gammon Dec 18, 2018

lukasolson commented Dec 18, 2018

stacey-gammon commented Dec 18, 2018

elasticmachine commented Dec 18, 2018

elasticmachine commented Dec 18, 2018

lukasolson Dec 18, 2018

stacey-gammon Dec 18, 2018

lukasolson Dec 18, 2018

stacey-gammon Dec 18, 2018

lukasolson commented Dec 18, 2018

elasticmachine commented Dec 18, 2018

joelgriffith left a comment

elasticmachine commented Dec 18, 2018

lukasolson left a comment

elasticmachine commented Dec 18, 2018

Fix dashboard to refresh visualizations when the refresh button is clicked #27353

Fix dashboard to refresh visualizations when the refresh button is clicked #27353

Conversation

stacey-gammon commented Dec 18, 2018 • edited Loading

Summary

Checklist

For maintainers

stacey-gammon commented Dec 18, 2018

stacey-gammon commented Dec 18, 2018

elasticmachine commented Dec 18, 2018

💔 Build Failed

stacey-gammon commented Dec 18, 2018

lukasolson Dec 18, 2018

Choose a reason for hiding this comment

stacey-gammon Dec 18, 2018

Choose a reason for hiding this comment

lukasolson commented Dec 18, 2018

stacey-gammon commented Dec 18, 2018

elasticmachine commented Dec 18, 2018

elasticmachine commented Dec 18, 2018

💔 Build Failed

lukasolson Dec 18, 2018

Choose a reason for hiding this comment

stacey-gammon Dec 18, 2018

Choose a reason for hiding this comment

lukasolson Dec 18, 2018

Choose a reason for hiding this comment

stacey-gammon Dec 18, 2018

Choose a reason for hiding this comment

lukasolson commented Dec 18, 2018

elasticmachine commented Dec 18, 2018

💚 Build Succeeded

joelgriffith left a comment

Choose a reason for hiding this comment

elasticmachine commented Dec 18, 2018

💚 Build Succeeded

lukasolson left a comment

Choose a reason for hiding this comment

elasticmachine commented Dec 18, 2018

💚 Build Succeeded

stacey-gammon commented Dec 18, 2018 •

edited

Loading