Throttle KbnUrlStateStorage error messages (#152983)

Fix duplicate error messages caused by invalid URLs in Discover & Dashboard.
elastic · Mar 9, 2023 · 63da800 · 63da800
1 parent b3d8661
commit 63da800
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/...ana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.test.ts b/...ana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.test.ts
@@ -102,6 +102,16 @@ describe('KbnUrlStateStorage', () => {
       expect(cb).toBeCalledWith(expect.any(Error));
     });
 
+    it('should notify about errors throttled', () => {
+      const cb = jest.fn();
+      urlStateStorage = createKbnUrlStateStorage({ useHash: false, history, onGetError: cb });
+      const key = '_s';
+      history.replace(`/#?${key}=(ok:2,test:`); // malformed rison
+      urlStateStorage.get(key);
+      urlStateStorage.get(key);
+      expect(cb).toBeCalledTimes(1);
+    });
+
     describe('withNotifyOnErrors integration', () => {
       test('toast is shown', () => {
         const toasts = coreMock.createStart().notifications.toasts;

diff --git a/...s/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts b/...s/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts
@@ -9,6 +9,7 @@
 import { Observable, of } from 'rxjs';
 import { catchError, map, share } from 'rxjs/operators';
 import { History } from 'history';
+import { throttle } from 'lodash';
 import { IStateStorage } from './types';
 import {
   createKbnUrlControls,
@@ -74,6 +75,7 @@ export const createKbnUrlStateStorage = (
   }
 ): IKbnUrlStateStorage => {
   const url = createKbnUrlControls(history);
+  const onGetErrorThrottled = onGetError ? throttle((e) => onGetError(e), 100) : undefined;
   return {
     set: <State>(
       key: string,
@@ -100,7 +102,7 @@ export const createKbnUrlStateStorage = (
       try {
         return getStateFromKbnUrl(key, url.getPendingUrl(), { getFromHashQuery: useHashQuery });
       } catch (e) {
-        if (onGetError) onGetError(e);
+        if (onGetErrorThrottled) onGetErrorThrottled(e);
         return null;
       }
     },
@@ -116,7 +118,7 @@ export const createKbnUrlStateStorage = (
       }).pipe(
         map(() => getStateFromKbnUrl<State>(key, undefined, { getFromHashQuery: useHashQuery })),
         catchError((error) => {
-          if (onGetError) onGetError(error);
+          if (onGetErrorThrottled) onGetErrorThrottled(error);
           return of(null);
         }),
         share()