Move Storage ⇒ NP kibana_utils (#49448) (#49619)

* Move storage to kibana_utils * Updated all references to Storage and replace places where it was referenced to as "store" to avoid confusion. * fixed tests * Delete data legacy dependencies plugin * Imports fix * update snapshots
elastic · Oct 29, 2019 · 21770fd · 21770fd
1 parent 28c9bd7
commit 21770fd
Show file tree

Hide file tree

Showing 53 changed files with 152 additions and 210 deletions.
diff --git a/src/legacy/core_plugins/data/public/legacy.ts b/src/legacy/core_plugins/data/public/legacy.ts
@@ -35,18 +35,13 @@
  */
 
 import { npSetup, npStart } from 'ui/new_platform';
-import { LegacyDependenciesPlugin } from './shim/legacy_dependencies_plugin';
 import { plugin } from '.';
 
 const dataPlugin = plugin();
-const legacyPlugin = new LegacyDependenciesPlugin();
 
-export const setup = dataPlugin.setup(npSetup.core, {
-  __LEGACY: legacyPlugin.setup(),
-});
+export const setup = dataPlugin.setup(npSetup.core);
 
 export const start = dataPlugin.start(npStart.core, {
   data: npStart.plugins.data,
   uiActions: npSetup.plugins.uiActions,
-  __LEGACY: legacyPlugin.start(),
 });
diff --git a/src/legacy/core_plugins/data/public/plugin.ts b/src/legacy/core_plugins/data/public/plugin.ts
@@ -22,10 +22,7 @@ import { SearchService, SearchStart, createSearchBar, StatetfulSearchBarProps }
 import { QueryService, QuerySetup } from './query';
 import { TimefilterService, TimefilterSetup } from './timefilter';
 import { IndexPatternsService, IndexPatternsSetup, IndexPatternsStart } from './index_patterns';
-import {
-  LegacyDependenciesPluginSetup,
-  LegacyDependenciesPluginStart,
-} from './shim/legacy_dependencies_plugin';
+import { Storage, IStorageWrapper } from '../../../../../src/plugins/kibana_utils/public';
 import { DataPublicPluginStart } from '../../../../plugins/data/public';
 import { initLegacyModule } from './shim/legacy_module';
 import { IUiActionsSetup } from '../../../../plugins/ui_actions/public';
@@ -35,19 +32,9 @@ import {
 } from './filter/action/apply_filter_action';
 import { APPLY_FILTER_TRIGGER } from '../../../../plugins/embeddable/public';
 
-/**
- * Interface for any dependencies on other plugins' `setup` contracts.
- *
- * @internal
- */
-export interface DataPluginSetupDependencies {
-  __LEGACY: LegacyDependenciesPluginSetup;
-}
-
 export interface DataPluginStartDependencies {
   data: DataPublicPluginStart;
   uiActions: IUiActionsSetup;
-  __LEGACY: LegacyDependenciesPluginStart;
 }
 
 /**
@@ -87,22 +74,24 @@ export interface DataStart {
  * in the setup/start interfaces. The remaining items exported here are either types,
  * or static code.
  */
-export class DataPlugin
-  implements
-    Plugin<DataSetup, DataStart, DataPluginSetupDependencies, DataPluginStartDependencies> {
+
+export class DataPlugin implements Plugin<DataSetup, DataStart, {}, DataPluginStartDependencies> {
   private readonly indexPatterns: IndexPatternsService = new IndexPatternsService();
   private readonly query: QueryService = new QueryService();
   private readonly search: SearchService = new SearchService();
   private readonly timefilter: TimefilterService = new TimefilterService();
 
   private setupApi!: DataSetup;
+  private storage!: IStorageWrapper;
 
-  public setup(core: CoreSetup, { __LEGACY }: DataPluginSetupDependencies): DataSetup {
+  public setup(core: CoreSetup): DataSetup {
     const { uiSettings } = core;
 
+    this.storage = new Storage(window.localStorage);
+
     const timefilterService = this.timefilter.setup({
       uiSettings,
-      store: __LEGACY.storage,
+      storage: this.storage,
     });
     this.setupApi = {
       indexPatterns: this.indexPatterns.setup(),
@@ -113,10 +102,7 @@ export class DataPlugin
     return this.setupApi;
   }
 
-  public start(
-    core: CoreStart,
-    { __LEGACY, data, uiActions }: DataPluginStartDependencies
-  ): DataStart {
+  public start(core: CoreStart, { data, uiActions }: DataPluginStartDependencies): DataStart {
     const { uiSettings, http, notifications, savedObjects } = core;
 
     const indexPatternsService = this.indexPatterns.start({
@@ -131,7 +117,7 @@ export class DataPlugin
     const SearchBar = createSearchBar({
       core,
       data,
-      store: __LEGACY.storage,
+      storage: this.storage,
       timefilter: this.setupApi.timefilter,
     });
 

diff --git a/src/legacy/core_plugins/data/public/query/persisted_log/persisted_log.ts b/src/legacy/core_plugins/data/public/query/persisted_log/persisted_log.ts
@@ -20,7 +20,7 @@
 import _ from 'lodash';
 import * as Rx from 'rxjs';
 import { map } from 'rxjs/operators';
-import { Storage } from '../../types';
+import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
 
 const defaultIsDuplicate = (oldItem: any, newItem: any) => {
   return _.isEqual(oldItem, newItem);
@@ -37,12 +37,12 @@ export class PersistedLog<T = any> {
   public maxLength?: number;
   public filterDuplicates?: boolean;
   public isDuplicate: (oldItem: T, newItem: T) => boolean;
-  public storage: Storage;
+  public storage: IStorageWrapper;
   public items: T[];
 
   private update$ = new Rx.BehaviorSubject(undefined);
 
-  constructor(name: string, options: PersistedLogOptions<T> = {}, storage: Storage) {
+  constructor(name: string, options: PersistedLogOptions<T> = {}, storage: IStorageWrapper) {
     this.name = name;
     this.maxLength =
       typeof options.maxLength === 'string'

diff --git a/...lugins/data/public/query/query_bar/components/__snapshots__/query_bar_input.test.tsx.snap b/...lugins/data/public/query/query_bar/components/__snapshots__/query_bar_input.test.tsx.snap
diff --git a/src/legacy/core_plugins/data/public/query/query_bar/components/query_bar_input.test.tsx b/src/legacy/core_plugins/data/public/query/query_bar/components/query_bar_input.test.tsx
@@ -58,7 +58,7 @@ const createMockWebStorage = () => ({
 });
 
 const createMockStorage = () => ({
-  store: createMockWebStorage(),
+  storage: createMockWebStorage(),
   get: jest.fn(),
   set: jest.fn(),
   remove: jest.fn(),
@@ -80,7 +80,7 @@ const mockIndexPattern = {
   ],
 } as IndexPattern;
 
-function wrapQueryBarInputInContext(testProps: any, store?: any) {
+function wrapQueryBarInputInContext(testProps: any, storage?: any) {
   const defaultOptions = {
     screenTitle: 'Another Screen',
     intl: null as any,
@@ -89,7 +89,7 @@ function wrapQueryBarInputInContext(testProps: any, store?: any) {
   const services = {
     ...startMock,
     appName: testProps.appName || 'test',
-    store: store || createMockStorage(),
+    storage: storage || createMockStorage(),
   };
 
   return (

diff --git a/src/legacy/core_plugins/data/public/query/query_bar/components/query_bar_input.tsx b/src/legacy/core_plugins/data/public/query/query_bar/components/query_bar_input.tsx
@@ -365,7 +365,7 @@ export class QueryBarInputUI extends Component<Props, State> {
       body: JSON.stringify({ opt_in: language === 'kuery' }),
     });
 
-    this.services.store.set('kibana.userQueryLanguage', language);
+    this.services.storage.set('kibana.userQueryLanguage', language);
 
     const newQuery = { query: '', language };
     this.onChange(newQuery);
@@ -387,10 +387,10 @@ export class QueryBarInputUI extends Component<Props, State> {
   };
 
   private initPersistedLog = () => {
-    const { uiSettings, store, appName } = this.services;
+    const { uiSettings, storage, appName } = this.services;
     this.persistedLog = this.props.persistedLog
       ? this.props.persistedLog
-      : getQueryLog(uiSettings, store, appName, this.props.query.language);
+      : getQueryLog(uiSettings, storage, appName, this.props.query.language);
   };
 
   public onMouseEnterSuggestion = (index: number) => {

diff --git a/src/legacy/core_plugins/data/public/query/query_bar/components/query_bar_top_row.test.tsx b/src/legacy/core_plugins/data/public/query/query_bar/components/query_bar_top_row.test.tsx
@@ -79,7 +79,7 @@ const createMockWebStorage = () => ({
 });
 
 const createMockStorage = () => ({
-  store: createMockWebStorage(),
+  storage: createMockWebStorage(),
   get: jest.fn(),
   set: jest.fn(),
   remove: jest.fn(),
@@ -112,7 +112,7 @@ function wrapQueryBarTopRowInContext(testProps: any) {
   const services = {
     ...startMock,
     appName: 'discover',
-    store: createMockStorage(),
+    storage: createMockStorage(),
   };
 
   return (

diff --git a/src/legacy/core_plugins/data/public/query/query_bar/components/query_bar_top_row.tsx b/src/legacy/core_plugins/data/public/query/query_bar/components/query_bar_top_row.tsx
@@ -73,7 +73,7 @@ function QueryBarTopRowUI(props: Props) {
   const [isDateRangeInvalid, setIsDateRangeInvalid] = useState(false);
 
   const kibana = useKibana<IDataPluginServices>();
-  const { uiSettings, notifications, store, appName, docLinks } = kibana.services;
+  const { uiSettings, notifications, storage, appName, docLinks } = kibana.services;
 
   const kueryQuerySyntaxLink: string = docLinks!.links.query.kueryQuerySyntax;
 
@@ -82,7 +82,7 @@ function QueryBarTopRowUI(props: Props) {
 
   useEffect(() => {
     if (!props.query) return;
-    persistedLog = getQueryLog(uiSettings!, store, appName, props.query.language);
+    persistedLog = getQueryLog(uiSettings!, storage, appName, props.query.language);
   }, [queryLanguage]);
 
   function onClickSubmitButton(event: React.MouseEvent<HTMLButtonElement>) {
@@ -211,7 +211,7 @@ function QueryBarTopRowUI(props: Props) {
   }
 
   function shouldRenderQueryInput(): boolean {
-    return Boolean(props.showQueryInput && props.indexPatterns && props.query && store);
+    return Boolean(props.showQueryInput && props.indexPatterns && props.query && storage);
   }
 
   function renderUpdateButton() {
@@ -293,7 +293,7 @@ function QueryBarTopRowUI(props: Props) {
     if (
       language === 'kuery' &&
       typeof query === 'string' &&
-      (!store || !store.get('kibana.luceneSyntaxWarningOptOut')) &&
+      (!storage || !storage.get('kibana.luceneSyntaxWarningOptOut')) &&
       doesKueryExpressionHaveLuceneSyntaxError(query)
     ) {
       const toast = notifications!.toasts.addWarning({
@@ -337,8 +337,8 @@ function QueryBarTopRowUI(props: Props) {
   }
 
   function onLuceneSyntaxWarningOptOut(toast: Toast) {
-    if (!store) return;
-    store.set('kibana.luceneSyntaxWarningOptOut', true);
+    if (!storage) return;
+    storage.set('kibana.luceneSyntaxWarningOptOut', true);
     notifications!.toasts.remove(toast);
   }
 

diff --git a/src/legacy/core_plugins/data/public/query/query_bar/lib/get_query_log.ts b/src/legacy/core_plugins/data/public/query/query_bar/lib/get_query_log.ts
@@ -18,12 +18,12 @@
  */
 
 import { UiSettingsClientContract } from 'src/core/public';
+import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
 import { PersistedLog } from '../../persisted_log';
-import { Storage } from '../../../types';
 
 export function getQueryLog(
   uiSettings: UiSettingsClientContract,
-  store: Storage,
+  storage: IStorageWrapper,
   appName: string,
   language: string
 ) {
@@ -33,6 +33,6 @@ export function getQueryLog(
       maxLength: uiSettings.get('history:limit'),
       filterDuplicates: true,
     },
-    store
+    storage
   );
 }
diff --git a/src/legacy/core_plugins/data/public/search/search_bar/components/create_search_bar.tsx b/src/legacy/core_plugins/data/public/search/search_bar/components/create_search_bar.tsx
@@ -22,7 +22,7 @@ import { Subscription } from 'rxjs';
 import { Filter } from '@kbn/es-query';
 import { CoreStart } from 'src/core/public';
 import { DataPublicPluginStart } from 'src/plugins/data/public';
-import { Storage } from '../../../types';
+import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
 import { KibanaContextProvider } from '../../../../../../../../src/plugins/kibana_react/public';
 import { TimefilterSetup } from '../../../timefilter';
 import { SearchBar } from '../../../';
@@ -31,7 +31,7 @@ import { SearchBarOwnProps } from '.';
 interface StatefulSearchBarDeps {
   core: CoreStart;
   data: DataPublicPluginStart;
-  store: Storage;
+  storage: IStorageWrapper;
   timefilter: TimefilterSetup;
 }
 
@@ -54,7 +54,7 @@ const defaultOnRefreshChange = (timefilter: TimefilterSetup) => {
   };
 };
 
-export function createSearchBar({ core, store, timefilter, data }: StatefulSearchBarDeps) {
+export function createSearchBar({ core, storage, timefilter, data }: StatefulSearchBarDeps) {
   // App name should come from the core application service.
   // Until it's available, we'll ask the user to provide it for the pre-wired component.
   return (props: StatetfulSearchBarProps) => {
@@ -107,7 +107,7 @@ export function createSearchBar({ core, store, timefilter, data }: StatefulSearc
         services={{
           appName: props.appName,
           data,
-          store,
+          storage,
           ...core,
         }}
       >