Merge pull request #7999 from elastic/jasper/backport/6773/4.x

[backport] PR #6773 to 4.x - IE length warning

src/plugins/kibana/public/dashboard/directives/grid.js

@@ -83,14 +83,15 @@ define(function (require) {
           });
 
           $scope.$on('$destroy', function () {
+            safeLayout.cancel();
             $window.off('resize', safeLayout);
 
             if (!gridster) return;
             gridster.$widgets.each(function (i, el) {
               const panel = getPanelFor(el);
-              removePanel(panel);
               // stop any animations
               panel.$el.stop();
+              removePanel(panel, true);
               // not that we will, but lets be safe
               makePanelSerializeable(panel);
             });
@@ -125,9 +126,9 @@ define(function (require) {
         }
 
         // tell gridster to remove the panel, and cleanup our metadata
-        function removePanel(panel) {
+        function removePanel(panel, silent) {
           // remove from grister 'silently' (don't reorganize after)
-          gridster.remove_widget(panel.$el);
+          gridster.remove_widget(panel.$el, silent);
 
           // destroy the scope
           panel.$scope.$destroy();

src/ui/public/chrome/api/angular.js

@@ -1,4 +1,10 @@
 let _ = require('lodash');
+import { format as formatUrl, parse as parseUrl } from 'url';
+
+import Notifier from 'ui/notify/notifier';
+import { UrlOverflowServiceProvider } from '../../error_url_overflow';
+
+const URL_LIMIT_WARN_WITHIN = 150;
 
 module.exports = function (chrome, internals) {
 
@@ -20,7 +26,31 @@ module.exports = function (chrome, internals) {
       a.href = chrome.addBasePath('/elasticsearch');
       return a.href;
     }()))
-    .config(chrome.$setupXsrfRequestInterceptor);
+    .config(chrome.$setupXsrfRequestInterceptor)
+    .run(($location, $rootScope, Private) => {
+      const notify = new Notifier();
+      const urlOverflow = Private(UrlOverflowServiceProvider);
+      const check = (event) => {
+        if ($location.path() === '/error/url-overflow') return;
+
+        try {
+          if (urlOverflow.check($location.absUrl()) <= URL_LIMIT_WARN_WITHIN) {
+            notify.warning(`
+              The URL has gotten big and may cause Kibana
+              to stop working. Please simplify the data on screen.
+            `);
+          }
+        } catch (e) {
+          const { host, path, search, protocol } = parseUrl(window.location.href);
+          // rewrite the entire url to force the browser to reload and
+          // discard any potentially unstable state from before
+          window.location.href = formatUrl({ host, path, search, protocol, hash: '#/error/url-overflow' });
+        }
+      };
+
+      $rootScope.$on('$routeUpdate', check);
+      $rootScope.$on('$routeChangeStart', check);
+    });
 
     require('../directives')(chrome, internals);
 

src/ui/public/config/defaults.js

@@ -206,7 +206,7 @@ define(function (require) {
       'dashboard:defaultDarkTheme': {
         value: false,
         description: 'New dashboards use dark theme by default',
-      }
+      },
     };
   };
 });

src/ui/public/error_url_overflow/error_url_overflow.html

@@ -0,0 +1,18 @@
+<div class="app-container error-url-overflow-app">
+  <h3>
+    <i aria-hidden="true" class="fa fa-warning text-danger"></i> Woah there!
+  </h3>
+  <p>
+    That's a big URL you have there. I have some unfortunate news: Your browser doesn't play nice with Kibana's bacon-double-cheese-burger-with-extra-fries sized URL. To keep you from running into problems Kibana limits URLs in your browser to {{controller.limit}} characters for your safety.
+  </p>
+
+  <h3>Ok, how do I fix this?</h3>
+  <p>This usually only happens with big, complex dashboards, so you have some options:</p>
+  <ol>
+    <li>Remove some stuff from your dashboard. This will reduce the length of the URL and keep IE in a good place.</li>
+    <li>Don't use IE. Every other supported browser we know of doesn't have this limit.</li>
+  </ol>
+  <br>
+  <br>
+  <p><small>Foot note: Party size candy bars are tiny. Party size sub sandwiches are massive. Really makes you think.</small></p>
+</div>

src/ui/public/error_url_overflow/error_url_overflow.js

@@ -0,0 +1,30 @@
+import uiRoutes from 'ui/routes';
+import uiModules from 'ui/modules';
+import KbnUrlProvider from 'ui/url';
+
+import './error_url_overflow.less';
+import template from './error_url_overflow.html';
+import { UrlOverflowServiceProvider } from './url_overflow_service';
+
+export * from './url_overflow_service';
+
+uiRoutes
+.when('/error/url-overflow', {
+  template,
+  controllerAs: 'controller',
+  controller: class OverflowController {
+    constructor(Private, config, $scope) {
+      const kbnUrl = Private(KbnUrlProvider);
+      const urlOverflow = Private(UrlOverflowServiceProvider);
+
+      if (!urlOverflow.get()) {
+        kbnUrl.redirectPath('/');
+        return;
+      }
+
+      this.url = urlOverflow.get();
+      this.limit = urlOverflow.failLength();
+      $scope.$on('$destroy', () => urlOverflow.clear());
+    }
+  }
+});

src/ui/public/error_url_overflow/error_url_overflow.less

@@ -0,0 +1,7 @@
+.error-url-overflow-app {
+  padding: 25px;
+
+  pre {
+    white-space: pre-wrap;
+  }
+}

src/ui/public/error_url_overflow/url_overflow_service.js

@@ -0,0 +1,65 @@
+const URL_MAX_IE = 2000;
+const URL_MAX_OTHERS = 25000;
+const IE_REGEX = /(;MSIE |Edge\/\d)/;
+
+export class UrlOverflowService {
+  constructor() {
+    const key = 'error/url-overflow/url';
+    const store = window.sessionStorage || {
+      getItem() {},
+      setItem() {},
+      removeItem() {},
+    };
+
+    // FIXME: Couldn't find a way to test for browser compatibility without
+    // complex redirect and cookie based "feature-detection" page, so going
+    // with user-agent detection for now.
+    this._ieLike = IE_REGEX.test(window.navigator.userAgent);
+
+    this._val = store.getItem(key);
+    this._sync = () => {
+      if (this._val == null) store.removeItem(key);
+      else store.setItem(key, this._val);
+    };
+  }
+
+  failLength() {
+    return this._ieLike ? URL_MAX_IE : URL_MAX_OTHERS;
+  }
+
+  set(v) {
+    this._val = v;
+    this._sync();
+  }
+
+  get() {
+    return this._val;
+  }
+
+  check(absUrl) {
+    if (!this.get()) {
+      const urlLength = absUrl.length;
+      const remaining = this.failLength() - urlLength;
+
+      if (remaining > 0) {
+        return remaining;
+      }
+
+      this.set(absUrl);
+    }
+
+    throw new Error(`
+      The URL has gotten too big and kibana can no longer
+      continue. Please refresh to return to your previous state.
+    `);
+  }
+
+  clear() {
+    this._val = undefined;
+    this._sync();
+  }
+}
+
+export function UrlOverflowServiceProvider() {
+  return new UrlOverflowService();
+}

src/ui/public/state_management/state.js

@@ -1,3 +1,5 @@
+import KbnUrlProvider from 'ui/url';
+
 define(function (require) {
   let _ = require('lodash');
   let rison = require('ui/utils/rison');
@@ -6,7 +8,8 @@ define(function (require) {
   let qs = require('ui/utils/query_string');
 
   return function StateProvider(Notifier, Private, $rootScope, $location) {
-    let Events = Private(require('ui/events'));
+    const notify = new Notifier();
+    const Events = Private(require('ui/events'));
 
     _.class(State).inherits(Events);
     function State(urlParam, defaults) {
@@ -43,7 +46,6 @@ define(function (require) {
       try {
         return search[this._urlParam] ? rison.decode(search[this._urlParam]) : null;
       } catch (e) {
-        let notify = new Notifier();
         notify.error('Unable to parse URL');
         search[this._urlParam] = rison.encode(this._defaults);
         $location.search(search).replace();