Silence URL restore errors for Discover & Dashboards (#242788)

Silences the annoying URL restoration error notifications for Discover and Dashboards

Author: ThomThomson

src/platform/plugins/shared/dashboard/public/dashboard_app/dashboard_app.tsx

@@ -9,7 +9,7 @@
 
 import { DASHBOARD_APP_LOCATOR } from '@kbn/deeplinks-analytics';
 import { useExecutionContext } from '@kbn/kibana-react-plugin/public';
-import { createKbnUrlStateStorage, withNotifyOnErrors } from '@kbn/kibana-utils-plugin/public';
+import { createKbnUrlStateStorage } from '@kbn/kibana-utils-plugin/public';
 import type { ViewMode } from '@kbn/presentation-publishing';
 import type { History } from 'history';
 import React, { useCallback, useEffect, useMemo, useState } from 'react';
@@ -117,7 +117,6 @@ export function DashboardApp({
       createKbnUrlStateStorage({
         history,
         useHash: coreServices.uiSettings.get('state:storeInSessionStorage'),
-        ...withNotifyOnErrors(coreServices.notifications.toasts),
       }),
     [history]
   );

src/platform/plugins/shared/dashboard/public/dashboard_app/dashboard_router.tsx

@@ -8,7 +8,7 @@
  */
 
 import type { AppMountParameters, CoreStart } from '@kbn/core/public';
-import { createKbnUrlStateStorage, withNotifyOnErrors } from '@kbn/kibana-utils-plugin/public';
+import { createKbnUrlStateStorage } from '@kbn/kibana-utils-plugin/public';
 import { KibanaRenderContextProvider } from '@kbn/react-kibana-context-render';
 import { Route, Routes } from '@kbn/shared-ux-router';
 import type { ParsedQuery } from 'query-string';
@@ -61,7 +61,6 @@ export async function mountApp({
     createKbnUrlStateStorage({
       history,
       useHash: coreServices.uiSettings.get('state:storeInSessionStorage'),
-      ...withNotifyOnErrors(coreServices.notifications.toasts),
     });
 
   const redirect = (redirectTo: RedirectToProps) => {

src/platform/plugins/shared/discover/public/__mocks__/discover_state.mock.ts

@@ -23,7 +23,7 @@ import {
 } from '../application/main/state_management/redux';
 import type { DiscoverServices, HistoryLocationState } from '../build_services';
 import type { IKbnUrlStateStorage } from '@kbn/kibana-utils-plugin/public';
-import { createKbnUrlStateStorage, withNotifyOnErrors } from '@kbn/kibana-utils-plugin/public';
+import { createKbnUrlStateStorage } from '@kbn/kibana-utils-plugin/public';
 import type { History } from 'history';
 import {
   getConnectedCustomizationService,
@@ -62,7 +62,7 @@ function createInternalStateStoreMock({
     useHash: storeInSessionStorage,
     history: services.history,
     useHashQuery: customizationContext.displayMode !== 'embedded',
-    ...(toasts && withNotifyOnErrors(toasts)),
+    ...toasts,
   });
   runtimeStateManager ??= createRuntimeStateManager();
   const tabsStorageManager = createTabsStorageManager({

src/platform/plugins/shared/discover/public/application/context/services/context_state.ts

@@ -17,7 +17,6 @@ import {
   createStateContainer,
   createKbnUrlStateStorage,
   syncStates,
-  withNotifyOnErrors,
 } from '@kbn/kibana-utils-plugin/public';
 
 import type { DataPublicPluginStart, FilterManager } from '@kbn/data-plugin/public';
@@ -155,7 +154,7 @@ export function getState({
   const stateStorage = createKbnUrlStateStorage({
     useHash: storeInSessionStorage,
     history,
-    ...(toasts && withNotifyOnErrors(toasts)),
+    ...toasts,
   });
 
   const globalStateFromUrl = stateStorage.get<GlobalState>(GLOBAL_STATE_URL_KEY) as GlobalState;

src/platform/plugins/shared/discover/public/application/main/discover_main_route.tsx

@@ -9,7 +9,7 @@
 
 import { useHistory, useParams } from 'react-router-dom';
 import type { IKbnUrlStateStorage } from '@kbn/kibana-utils-plugin/public';
-import { createKbnUrlStateStorage, withNotifyOnErrors } from '@kbn/kibana-utils-plugin/public';
+import { createKbnUrlStateStorage } from '@kbn/kibana-utils-plugin/public';
 import { useEffect, useState } from 'react';
 import React from 'react';
 import useUnmount from 'react-use/lib/useUnmount';
@@ -74,7 +74,6 @@ export const DiscoverMainRoute = ({
         useHash: services.uiSettings.get('state:storeInSessionStorage'),
         history,
         useHashQuery: customizationContext.displayMode !== 'embedded',
-        ...withNotifyOnErrors(services.core.notifications.toasts),
       })
   );
   const { internalState, runtimeStateManager, searchSessionManager } = useStateManagers({

src/platform/plugins/shared/discover/public/application/main/state_management/discover_app_state_container.test.ts

@@ -10,7 +10,7 @@
 import { createSearchSourceMock } from '@kbn/data-plugin/public/mocks';
 import { dataViewMock } from '@kbn/discover-utils/src/__mocks__';
 import type { IKbnUrlStateStorage } from '@kbn/kibana-utils-plugin/public';
-import { createKbnUrlStateStorage, withNotifyOnErrors } from '@kbn/kibana-utils-plugin/public';
+import { createKbnUrlStateStorage } from '@kbn/kibana-utils-plugin/public';
 import type { Filter } from '@kbn/es-query';
 import type { History } from 'history';
 import { discoverServiceMock } from '../../../__mocks__/services';
@@ -47,7 +47,7 @@ describe('Test discover app state container', () => {
     stateStorage = createKbnUrlStateStorage({
       useHash: storeInSessionStorage,
       history,
-      ...(toasts && withNotifyOnErrors(toasts)),
+      ...toasts,
     });
     tabsStorageManager = createTabsStorageManager({
       urlStateStorage: stateStorage,

src/platform/plugins/shared/kibana_utils/public/state_management/url/kbn_url_tracker.test.ts

@@ -123,7 +123,8 @@ describe('kbnUrlTracker', () => {
     expect(getActiveNavLinkUrl()).toEqual('#/start/deep/path/3?unhashed');
   });
 
-  test('show warning and use hashed url if unhashing does not work', () => {
+  test('warn in console and use hashed url if unhashing does not work', () => {
+    const consoleWarnSpy = jest.spyOn(console, 'warn');
     (unhashUrl as jest.Mock).mockImplementation(() => {
       throw new Error('unhash broke');
     });
@@ -132,7 +133,8 @@ describe('kbnUrlTracker', () => {
     history.push('#/start/deep/path/2');
     urlTracker.appUnMounted();
     expect(getActiveNavLinkUrl()).toEqual('#/start/deep/path/2');
-    expect(toastService.addDanger).toHaveBeenCalledWith('unhash broke');
+
+    expect(consoleWarnSpy).toHaveBeenCalledWith('unhash broke');
   });
 
   test('change nav link back to default if app gets mounted again', () => {

src/platform/plugins/shared/kibana_utils/public/state_management/url/kbn_url_tracker.ts

@@ -158,7 +158,8 @@ export function createKbnUrlTracker({
     try {
       urlWithStates = unhashUrl(urlWithHashes);
     } catch (e) {
-      toastNotifications.addDanger(e.message);
+      // eslint-disable-next-line no-console
+      console.warn(e.message);
     }
 
     previousActiveUrl = activeUrl;

src/platform/test/functional/apps/discover/group5/_shared_links.ts

@@ -143,12 +143,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
           await browser.get(currentUrl, false);
           const resolvedUrl = await browser.getCurrentUrl();
           expect(resolvedUrl).to.match(/discover/);
-          const { title } = await toasts.getErrorByIndex(1, true);
-          expect(title).to.contain(
-            'Unable to completely restore the URL, be sure to use the share functionality.'
-          );
         });
-        await toasts.dismissAll();
       });
     });
   });