Cancel visualize fetches when navigating away or re-fetching #42035

lukasolson · 2019-07-25T23:54:18Z

Summary

Depends on #40238.

Fixes #17844.
Fixes #17845.
Fixes #17846.
Fixes #24058.

This PR updates visualize embeddables to cancel existing fetch requests when a new fetch request is submitted. This can be when something is changed (like filters, time range, query, agg config, etc.), when clicking Refresh, or when navigating away.

Release Notes

In-progress search requests to Elasticsearch will now be cancelled when a new search is requested, or when a user navigates away from the page or removes a panel from a dashboard. In order for Elasticsearch to cancel the tasks associated with search requests that are cancelled, please disable the advanced setting courier:batchSearches (which is enabled by default).

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

…ches when necessary

…ff for canceling interpreter

…g the page

elasticmachine · 2019-07-25T23:54:21Z

Pinging @elastic/kibana-app-arch

elasticmachine · 2019-07-26T00:44:01Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

lukasolson · 2019-07-31T16:29:53Z

@ppisljar Could you take another look at this? I think we can push this over the line before we do a big refactor of the expressions service.

lukasolson · 2019-07-31T16:30:26Z

src/legacy/ui/public/visualize/loader/embedded_visualize_handler.ts

@@ -435,7 +436,13 @@ export class EmbeddedVisualizeHandler {
    this.fetchAndRender();
  };

+  private cancel = () => {


Should this be public?

yup, i think so, but not necessary for now
we'll want to cancel externally (once we have cancel buttons around)

elasticmachine · 2019-07-31T17:05:07Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

ppisljar

few minor comments, haven't tested yet

src/legacy/ui/public/visualize/loader/embedded_visualize_handler.ts

src/legacy/ui/public/visualize/loader/pipeline_data_loader.ts

ppisljar · 2019-08-01T12:54:10Z

src/legacy/ui/public/visualize/loader/embedded_visualize_handler.ts

@@ -435,7 +436,13 @@ export class EmbeddedVisualizeHandler {
    this.fetchAndRender();
  };

+  private cancel = () => {


yup, i think so, but not necessary for now
we'll want to cancel externally (once we have cancel buttons around)

elasticmachine · 2019-08-01T17:18:21Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-08-02T21:55:24Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

lukasolson · 2019-08-02T22:37:22Z

Retest

…zeRequests

lukasolson · 2019-08-12T18:55:17Z

@ppisljar Maybe we can jump on a zoom tomorrow to see what's happening. It seems to be aborting just fine for me, when interpreter.enableInVisualize is set to both true and false.

lukasolson · 2019-08-21T00:20:06Z

Took another look at this today and realize there are some cases where we aren't successfully cancelling fetches:

Vega visualizations
TSVB visualizations
~~Input controls~~
~~Saved searches~~ (which is what is popping up the "Abort was requested" errors @ppisljar was referring to)
Maps embeddables

With regards to saved searches, it should be easy to update them to cancel once #43634 is merged.

With regards to the others, I think it'd be best to open a follow-up PR to handle these cases.

elasticmachine · 2019-08-23T23:57:57Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-08-27T18:23:34Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-08-27T23:24:40Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

lukasolson · 2019-08-28T00:20:38Z

@ppisljar Could you take another look at this?

elasticmachine · 2019-08-28T01:37:41Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

ppisljar

postFlightRequests (like other bucket for term agg) are not being canceled

ppisljar · 2019-08-28T06:29:33Z

src/legacy/ui/public/agg_types/buckets/histogram.js

@@ -76,13 +76,13 @@ export const histogramBucketAgg = new BucketAggType({
    {
      name: 'interval',
      editorComponent: NumberIntervalParamEditor,
-      modifyAggConfigOnSearchRequestStart(aggConfig, searchSource) {
+      modifyAggConfigOnSearchRequestStart(aggConfig, searchSource, searchRequest) {


can we rather pass abortSignal in here to have same implementation as in other places ?( abortSignal.addEventListener)

This won't quite work since this method is called from both buildVislibDimensions (which has access to the abortSignal but not the searchRequest) and searchSource.requestIsStarting (which has access to the searchRequest but not the abortSignal). I could theoretically pass in abortSignal as an additional argument, then check both searchRequest and abortSignal but that seems kinda messy. Any other proposals?

src/legacy/ui/public/vis/request_handlers/courier.js

spalger · 2019-08-28T20:58:27Z

retest

elasticmachine · 2019-08-28T22:23:49Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

Resolved

…#42035) * add AbortSignal to interpreter * adding AbortSignal to visualize_loader * adding AbortSignal to embeddables and dashboard * passing AbortSignal to courier request handler * Remove abort signal from dashboard and move to handler, and abort fetches when necessary * Remove the rest of the references to abort signal in dashboard * Revert changes to dashboard_app * Remove code related to canceling visualize requests and only keep stuff for canceling interpreter * Use createError * Cancel in-progress fetches when a new one is requested or when leaving the page * Update with cancel methods and make visualize data loader work * Remove unnecessary call to * Fix tests * Remove cancel from data loaders * Fix search source to always either resolve or reject in fetch() * Fix naming * Update search request to reject on abort, and don't render errors in the UI * Update tests * Add cancellation to input control * Cancel histogram fetches * Update esaggs typings * Add cancellation for search embeddables * Abort post-flight requests

lukasolson · 2019-08-28T22:58:36Z

7.x (7.4.0): d7a7c73

ppisljar and others added 11 commits July 3, 2019 10:37

add AbortSignal to interpreter

802f608

adding AbortSignal to visualize_loader

daf72d2

adding AbortSignal to embeddables and dashboard

332dae1

passing AbortSignal to courier request handler

04e1240

Remove abort signal from dashboard and move to handler, and abort fet…

0c429c1

…ches when necessary

Remove the rest of the references to abort signal in dashboard

095860e

Revert changes to dashboard_app

3c7e344

Remove code related to canceling visualize requests and only keep stu…

4af0b64

…ff for canceling interpreter

Merge branch 'master' into interpreter/canceling

89ebc13

Use createError

d8f5208

Cancel in-progress fetches when a new one is requested or when leavin…

00a672d

…g the page

lukasolson added Feature:Search Querying infrastructure in Kibana Team:AppArch labels Jul 25, 2019

lukasolson requested a review from a team as a code owner July 25, 2019 23:54

lukasolson self-assigned this Jul 25, 2019

lukasolson added 2 commits July 31, 2019 08:39

Merge branch 'master' into cancelVisualizeRequests

1d7f782

Update with cancel methods and make visualize data loader work

b37525f

lukasolson commented Jul 31, 2019

View reviewed changes

ppisljar reviewed Aug 1, 2019

View reviewed changes

Remove unnecessary call to

dd784a3

lukasolson added the release_note:enhancement label Aug 2, 2019

Fix tests

cb2fb2d

Merge branch 'master' of github.com:elastic/kibana into cancelVisuali…

daa3a48

…zeRequests

Merge branch 'master' into cancelVisualizeRequests

726c4a0

Merge branch 'master' into cancelVisualizeRequests

8255d2f

lukasolson added 2 commits August 27, 2019 09:14

Merge branch 'master' into cancelVisualizeRequests

6492023

Add cancellation to input control

728a7b4

Cancel histogram fetches

e068744

lukasolson added 3 commits August 27, 2019 16:57

Update esaggs typings

72a8965

Merge branch 'master' into cancelVisualizeRequests

33180fb

Add cancellation for search embeddables

d5983e4

ppisljar previously requested changes Aug 28, 2019

View reviewed changes

Abort post-flight requests

4949fb4

mattkime approved these changes Aug 28, 2019

View reviewed changes

lukasolson merged commit 9fecf8d into elastic:master Aug 28, 2019

lukasolson added v7.4.0 v8.0.0 labels Aug 28, 2019

lukasolson deleted the cancelVisualizeRequests branch December 2, 2019 22:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel visualize fetches when navigating away or re-fetching #42035

Cancel visualize fetches when navigating away or re-fetching #42035

lukasolson commented Jul 25, 2019 •

edited

Loading

elasticmachine commented Jul 25, 2019

elasticmachine commented Jul 26, 2019

lukasolson commented Jul 31, 2019

lukasolson Jul 31, 2019

ppisljar Aug 1, 2019

elasticmachine commented Jul 31, 2019

ppisljar left a comment

ppisljar Aug 1, 2019

elasticmachine commented Aug 1, 2019

elasticmachine commented Aug 2, 2019

lukasolson commented Aug 2, 2019

lukasolson commented Aug 12, 2019

lukasolson commented Aug 21, 2019 •

edited

Loading

elasticmachine commented Aug 23, 2019

elasticmachine commented Aug 27, 2019

elasticmachine commented Aug 27, 2019

lukasolson commented Aug 28, 2019

elasticmachine commented Aug 28, 2019

ppisljar left a comment

ppisljar Aug 28, 2019

lukasolson Aug 28, 2019 •

edited

Loading

spalger commented Aug 28, 2019

elasticmachine commented Aug 28, 2019

lukasolson commented Aug 28, 2019

Cancel visualize fetches when navigating away or re-fetching #42035

Cancel visualize fetches when navigating away or re-fetching #42035

Conversation

lukasolson commented Jul 25, 2019 • edited Loading

Summary

Release Notes

Checklist

For maintainers

elasticmachine commented Jul 25, 2019

elasticmachine commented Jul 26, 2019

💔 Build Failed

lukasolson commented Jul 31, 2019

lukasolson Jul 31, 2019

Choose a reason for hiding this comment

ppisljar Aug 1, 2019

Choose a reason for hiding this comment

elasticmachine commented Jul 31, 2019

💔 Build Failed

ppisljar left a comment

Choose a reason for hiding this comment

ppisljar Aug 1, 2019

Choose a reason for hiding this comment

elasticmachine commented Aug 1, 2019

💔 Build Failed

elasticmachine commented Aug 2, 2019

💔 Build Failed

lukasolson commented Aug 2, 2019

lukasolson commented Aug 12, 2019

lukasolson commented Aug 21, 2019 • edited Loading

elasticmachine commented Aug 23, 2019

💔 Build Failed

elasticmachine commented Aug 27, 2019

💔 Build Failed

elasticmachine commented Aug 27, 2019

💔 Build Failed

lukasolson commented Aug 28, 2019

elasticmachine commented Aug 28, 2019

💚 Build Succeeded

ppisljar left a comment

Choose a reason for hiding this comment

ppisljar Aug 28, 2019

Choose a reason for hiding this comment

lukasolson Aug 28, 2019 • edited Loading

Choose a reason for hiding this comment

spalger commented Aug 28, 2019

elasticmachine commented Aug 28, 2019

💚 Build Succeeded

lukasolson commented Aug 28, 2019

lukasolson commented Jul 25, 2019 •

edited

Loading

lukasolson commented Aug 21, 2019 •

edited

Loading

lukasolson Aug 28, 2019 •

edited

Loading