Migrate UseAppIndexPattern

elastic · Feb 1, 2022 · 94387b8 · 94387b8
1 parent f804e8a
commit 94387b8
Show file tree

Hide file tree

Showing 30 changed files with 153 additions and 155 deletions.
diff --git a/.../observability/public/components/shared/exploratory_view/components/filter_label.test.tsx b/.../observability/public/components/shared/exploratory_view/components/filter_label.test.tsx
@@ -7,14 +7,14 @@
 
 import React from 'react';
 import { fireEvent, screen, waitFor } from '@testing-library/react';
-import { mockAppIndexPattern, mockDataView, mockUxSeries, render } from '../rtl_helpers';
+import { mockAppDataView, mockDataView, mockUxSeries, render } from '../rtl_helpers';
 import { FilterLabel } from './filter_label';
 import * as useSeriesHook from '../hooks/use_series_filters';
 import { buildFilterLabel } from '../../filter_value_label/filter_value_label';
 
 // FLAKY: https://github.com/elastic/kibana/issues/115324
 describe.skip('FilterLabel', function () {
-  mockAppIndexPattern();
+  mockAppDataView();
 
   const invertFilter = jest.fn();
   jest.spyOn(useSeriesHook, 'useSeriesFilters').mockReturnValue({

diff --git a/...vability/public/components/shared/exploratory_view/configurations/lens_attributes.test.ts b/...vability/public/components/shared/exploratory_view/configurations/lens_attributes.test.ts
@@ -6,7 +6,7 @@
  */
 
 import { LayerConfig, LensAttributes } from './lens_attributes';
-import { mockAppIndexPattern, mockDataView } from '../rtl_helpers';
+import { mockAppDataView, mockDataView } from '../rtl_helpers';
 import { getDefaultConfigs } from './default_configs';
 import { sampleAttribute } from './test_data/sample_attribute';
 
@@ -21,7 +21,7 @@ import { RECORDS_FIELD, REPORT_METRIC_FIELD, PERCENTILE_RANKS, ReportTypes } fro
 import { obsvReportConfigMap } from '../obsv_exploratory_view';
 
 describe('Lens Attribute', () => {
-  mockAppIndexPattern();
+  mockAppDataView();
 
   const reportViewConfig = getDefaultConfigs({
     reportType: 'data-distribution',

diff --git a/...blic/components/shared/exploratory_view/configurations/rum/core_web_vitals_config.test.ts b/...blic/components/shared/exploratory_view/configurations/rum/core_web_vitals_config.test.ts
@@ -5,15 +5,15 @@
  * 2.0.
  */
 
-import { mockAppIndexPattern, mockDataView } from '../../rtl_helpers';
+import { mockAppDataView, mockDataView } from '../../rtl_helpers';
 import { getDefaultConfigs } from '../default_configs';
 import { LayerConfig, LensAttributes } from '../lens_attributes';
 import { sampleAttributeCoreWebVital } from '../test_data/sample_attribute_cwv';
 import { LCP_FIELD, SERVICE_NAME, USER_AGENT_OS } from '../constants/elasticsearch_fieldnames';
 import { obsvReportConfigMap } from '../../obsv_exploratory_view';
 
 describe('Core web vital config test', function () {
-  mockAppIndexPattern();
+  mockAppDataView();
 
   const seriesConfig = getDefaultConfigs({
     reportType: 'core-web-vitals',

diff --git a/...plugins/observability/public/components/shared/exploratory_view/embeddable/embeddable.tsx b/...plugins/observability/public/components/shared/exploratory_view/embeddable/embeddable.tsx
@@ -14,7 +14,7 @@ import { AppDataType, ReportViewType } from '../types';
 import { getLayerConfigs } from '../hooks/use_lens_attributes';
 import { LensEmbeddableInput, LensPublicStart, XYState } from '../../../../../../lens/public';
 import { OperationTypeComponent } from '../series_editor/columns/operation_type_select';
-import { IndexPatternState } from '../hooks/use_app_index_pattern';
+import { DataViewState } from '../hooks/use_app_data_view';
 import { ReportConfigMap } from '../contexts/exploratory_view_config';
 import { obsvReportConfigMap } from '../obsv_exploratory_view';
 import { ActionTypes, useActions } from './use_actions';
@@ -36,7 +36,7 @@ export interface ExploratoryEmbeddableProps {
 
 export interface ExploratoryEmbeddableComponentProps extends ExploratoryEmbeddableProps {
   lens: LensPublicStart;
-  indexPatterns: IndexPatternState;
+  indexPatterns: DataViewState;
 }
 
 // eslint-disable-next-line import/no-default-export

diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/embeddable/index.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/embeddable/index.tsx
@@ -11,7 +11,7 @@ import { CoreStart } from 'kibana/public';
 import type { ExploratoryEmbeddableProps, ExploratoryEmbeddableComponentProps } from './embeddable';
 import { ObservabilityDataViews } from '../../../../utils/observability_data_views';
 import { ObservabilityPublicPluginsStart } from '../../../../plugin';
-import type { IndexPatternState } from '../hooks/use_app_index_pattern';
+import type { DataViewState } from '../hooks/use_app_data_view';
 import { EuiThemeProvider } from '../../../../../../../../src/plugins/kibana_react/common';
 import type { AppDataType } from '../types';
 
@@ -30,7 +30,7 @@ export function getExploratoryViewEmbeddable(
   plugins: ObservabilityPublicPluginsStart
 ) {
   return (props: ExploratoryEmbeddableProps) => {
-    const [indexPatterns, setIndexPatterns] = useState<IndexPatternState>({} as IndexPatternState);
+    const [indexPatterns, setIndexPatterns] = useState<DataViewState>({} as DataViewState);
     const [loading, setLoading] = useState(false);
 
     const series = props.attributes[0];

diff --git a/...plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx b/...plugins/observability/public/components/shared/exploratory_view/exploratory_view.test.tsx
@@ -7,7 +7,7 @@
 
 import React from 'react';
 import { screen } from '@testing-library/dom';
-import { render, mockAppIndexPattern } from './rtl_helpers';
+import { render, mockAppDataView } from './rtl_helpers';
 import { ExploratoryView } from './exploratory_view';
 import * as obsvDataViews from '../../../utils/observability_data_views/observability_data_views';
 import * as pluginHook from '../../../hooks/use_plugin_context';
@@ -19,7 +19,7 @@ jest.spyOn(pluginHook, 'usePluginContext').mockReturnValue({
   },
 } as any);
 describe('ExploratoryView', () => {
-  mockAppIndexPattern();
+  mockAppDataView();
 
   beforeEach(() => {
     const indexPattern = createStubIndexPattern({

diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx b/x-pack/plugins/observability/public/components/shared/exploratory_view/exploratory_view.tsx
@@ -23,7 +23,7 @@ import { ExploratoryViewHeader } from './header/header';
 import { useSeriesStorage } from './hooks/use_series_storage';
 import { useLensAttributes } from './hooks/use_lens_attributes';
 import { TypedLensByValueInput } from '../../../../../lens/public';
-import { useAppIndexPatternContext } from './hooks/use_app_index_pattern';
+import { useAppDataViewContext } from './hooks/use_app_data_view';
 import { SeriesViews } from './views/series_views';
 import { LensEmbeddable } from './lens_embeddable';
 import { EmptyView } from './components/empty_view';
@@ -51,7 +51,7 @@ export function ExploratoryView({
     null
   );
 
-  const { loadIndexPattern, loading } = useAppIndexPatternContext();
+  const { loadDataView, loading } = useAppDataViewContext();
 
   const { firstSeries, allSeries, lastRefresh, reportType } = useSeriesStorage();
 
@@ -66,11 +66,11 @@ export function ExploratoryView({
 
   useEffect(() => {
     allSeries.forEach((seriesT) => {
-      loadIndexPattern({
+      loadDataView({
         dataType: seriesT.dataType,
       });
     });
-  }, [allSeries, loadIndexPattern]);
+  }, [allSeries, loadDataView]);
 
   useEffect(() => {
     setLensAttributes(lensAttributesT);

diff --git a/...tory_view/hooks/use_app_index_pattern.tsx → ...loratory_view/hooks/use_app_data_view.tsx b/...tory_view/hooks/use_app_index_pattern.tsx → ...loratory_view/hooks/use_app_data_view.tsx
@@ -7,7 +7,7 @@
 
 import React, { createContext, useContext, Context, useState, useCallback, useMemo } from 'react';
 import { HttpFetchError } from 'kibana/public';
-import { IndexPattern } from '../../../../../../../../src/plugins/data/common';
+import { DataView } from '../../../../../../../../src/plugins/data/common';
 import { AppDataType } from '../types';
 import { useKibana } from '../../../../../../../../src/plugins/kibana_react/public';
 import { ObservabilityPublicPluginsStart } from '../../../../plugin';
@@ -16,49 +16,47 @@ import { getDataHandler } from '../../../../data_handler';
 import { useExploratoryView } from '../contexts/exploratory_view_config';
 import { DataViewInsufficientAccessError } from '../../../../../../../../src/plugins/data_views/common';
 
-export interface IndexPatternContext {
+export interface DataViewContext {
   loading: boolean;
-  indexPatterns: IndexPatternState;
-  indexPatternErrors: IndexPatternErrors;
+  dataViews: DataViewState;
+  dataViewErrors: DataViewErrors;
   hasAppData: HasAppDataState;
-  loadIndexPattern: (params: { dataType: AppDataType }) => void;
+  loadDataView: (params: { dataType: AppDataType }) => void;
 }
 
-export const IndexPatternContext = createContext<Partial<IndexPatternContext>>({});
+export const DataViewContext = createContext<Partial<DataViewContext>>({});
 
 interface ProviderProps {
   children: JSX.Element;
 }
 
 type HasAppDataState = Record<AppDataType, boolean | undefined>;
-export type IndexPatternState = Record<AppDataType, IndexPattern>;
-export type IndexPatternErrors = Record<AppDataType, HttpFetchError>;
+export type DataViewState = Record<AppDataType, DataView>;
+export type DataViewErrors = Record<AppDataType, HttpFetchError>;
 type LoadingState = Record<AppDataType, boolean>;
 
-export function IndexPatternContextProvider({ children }: ProviderProps) {
+export function DataViewContextProvider({ children }: ProviderProps) {
   const [loading, setLoading] = useState<LoadingState>({} as LoadingState);
-  const [indexPatterns, setIndexPatterns] = useState<IndexPatternState>({} as IndexPatternState);
-  const [indexPatternErrors, setIndexPatternErrors] = useState<IndexPatternErrors>(
-    {} as IndexPatternErrors
-  );
+  const [dataViews, setDataViews] = useState<DataViewState>({} as DataViewState);
+  const [dataViewErrors, setDataViewErrors] = useState<DataViewErrors>({} as DataViewErrors);
   const [hasAppData, setHasAppData] = useState<HasAppDataState>({} as HasAppDataState);
 
   const {
     services: { data },
   } = useKibana<ObservabilityPublicPluginsStart>();
 
-  const { dataViews: indexPatternsList } = useExploratoryView();
+  const { dataViews: dataViewsList } = useExploratoryView();
 
-  const loadIndexPattern: IndexPatternContext['loadIndexPattern'] = useCallback(
+  const loadDataView: DataViewContext['loadDataView'] = useCallback(
     async ({ dataType }) => {
       if (typeof hasAppData[dataType] === 'undefined' && !loading[dataType]) {
         setLoading((prevState) => ({ ...prevState, [dataType]: true }));
 
         try {
           let hasDataT = false;
           let indices: string | undefined = '';
-          if (indexPatternsList[dataType]) {
-            indices = indexPatternsList[dataType];
+          if (dataViewsList[dataType]) {
+            indices = dataViewsList[dataType];
             hasDataT = true;
           }
           switch (dataType) {
@@ -83,59 +81,59 @@ export function IndexPatternContextProvider({ children }: ProviderProps) {
           setHasAppData((prevState) => ({ ...prevState, [dataType]: hasDataT }));
 
           if (hasDataT && indices) {
-            const obsvIndexP = new ObservabilityDataViews(data);
-            const indPattern = await obsvIndexP.getDataView(dataType, indices);
+            const obsvDataV = new ObservabilityDataViews(data);
+            const dataV = await obsvDataV.getDataView(dataType, indices);
 
-            setIndexPatterns((prevState) => ({ ...prevState, [dataType]: indPattern }));
+            setDataViews((prevState) => ({ ...prevState, [dataType]: dataV }));
           }
           setLoading((prevState) => ({ ...prevState, [dataType]: false }));
         } catch (e) {
           if (
             e instanceof DataViewInsufficientAccessError ||
             (e as HttpFetchError).body === 'Forbidden'
           ) {
-            setIndexPatternErrors((prevState) => ({ ...prevState, [dataType]: e }));
+            setDataViewErrors((prevState) => ({ ...prevState, [dataType]: e }));
           }
           setLoading((prevState) => ({ ...prevState, [dataType]: false }));
         }
       }
     },
-    [data, hasAppData, indexPatternsList, loading]
+    [data, hasAppData, dataViewsList, loading]
   );
 
   return (
-    <IndexPatternContext.Provider
+    <DataViewContext.Provider
       value={{
         hasAppData,
-        indexPatterns,
-        loadIndexPattern,
-        indexPatternErrors,
+        dataViews,
+        loadDataView,
+        dataViewErrors,
         loading: !!Object.values(loading).find((loadingT) => loadingT),
       }}
     >
       {children}
-    </IndexPatternContext.Provider>
+    </DataViewContext.Provider>
   );
 }
 
-export const useAppIndexPatternContext = (dataType?: AppDataType) => {
-  const { loading, hasAppData, loadIndexPattern, indexPatterns, indexPatternErrors } = useContext(
-    IndexPatternContext as unknown as Context<IndexPatternContext>
+export const useAppDataViewContext = (dataType?: AppDataType) => {
+  const { loading, hasAppData, loadDataView, dataViews, dataViewErrors } = useContext(
+    DataViewContext as unknown as Context<DataViewContext>
   );
 
-  if (dataType && !indexPatterns?.[dataType] && !loading) {
-    loadIndexPattern({ dataType });
+  if (dataType && !dataViews?.[dataType] && !loading) {
+    loadDataView({ dataType });
   }
 
   return useMemo(() => {
     return {
       hasAppData,
       loading,
-      indexPatterns,
-      indexPatternErrors,
-      indexPattern: dataType ? indexPatterns?.[dataType] : undefined,
+      dataViews,
+      dataViewErrors,
+      dataView: dataType ? dataViews?.[dataType] : undefined,
       hasData: dataType ? hasAppData?.[dataType] : undefined,
-      loadIndexPattern,
+      loadDataView,
     };
-  }, [dataType, hasAppData, indexPatternErrors, indexPatterns, loadIndexPattern, loading]);
+  }, [dataType, hasAppData, dataViewErrors, dataViews, loadDataView, loading]);
 };
diff --git a/...ugins/observability/public/components/shared/exploratory_view/hooks/use_discover_link.tsx b/...ugins/observability/public/components/shared/exploratory_view/hooks/use_discover_link.tsx
@@ -8,7 +8,7 @@
 import { useCallback, useEffect, useState } from 'react';
 import { useKibana } from '../../../../utils/kibana_react';
 import { SeriesConfig, SeriesUrl } from '../types';
-import { useAppIndexPatternContext } from './use_app_index_pattern';
+import { useAppDataViewContext } from './use_app_data_view';
 import { buildExistsFilter, urlFilterToPersistedFilter } from '../configurations/utils';
 import { getFiltersFromDefs } from './use_lens_attributes';
 import { RECORDS_FIELD, RECORDS_PERCENTAGE_FIELD } from '../configurations/constants';
@@ -24,21 +24,21 @@ export const useDiscoverLink = ({ series, seriesConfig }: UseDiscoverLink) => {
     application: { navigateToUrl },
   } = kServices;
 
-  const { indexPatterns } = useAppIndexPatternContext();
+  const { dataViews } = useAppDataViewContext();
 
   const urlGenerator = kServices.discover?.urlGenerator;
   const [discoverUrl, setDiscoverUrl] = useState<string>('');
 
   useEffect(() => {
-    const indexPattern = indexPatterns?.[series.dataType];
+    const dataView = dataViews?.[series.dataType];
 
-    if (indexPattern) {
+    if (dataView) {
       const definitions = series.reportDefinitions ?? {};
 
       const urlFilters = (series.filters ?? []).concat(getFiltersFromDefs(definitions));
 
       const filters = urlFilterToPersistedFilter({
-        dataView: indexPattern,
+        dataView,
         urlFilters,
         initFilters: seriesConfig?.baseFilters,
       });
@@ -50,22 +50,22 @@ export const useDiscoverLink = ({ series, seriesConfig }: UseDiscoverLink) => {
         selectedMetricField !== RECORDS_FIELD &&
         selectedMetricField !== RECORDS_PERCENTAGE_FIELD
       ) {
-        filters.push(buildExistsFilter(selectedMetricField, indexPattern)[0]);
+        filters.push(buildExistsFilter(selectedMetricField, dataView)[0]);
       }
 
       const getDiscoverUrl = async () => {
         if (!urlGenerator?.createUrl) return;
 
         const newUrl = await urlGenerator.createUrl({
           filters,
-          indexPatternId: indexPattern?.id,
+          indexPatternId: dataView?.id,
         });
         setDiscoverUrl(newUrl);
       };
       getDiscoverUrl();
     }
   }, [
-    indexPatterns,
+    dataViews,
     series.dataType,
     series.filters,
     series.reportDefinitions,

diff --git a/...bservability/public/components/shared/exploratory_view/hooks/use_lens_attributes.test.tsx b/...bservability/public/components/shared/exploratory_view/hooks/use_lens_attributes.test.tsx
@@ -15,7 +15,7 @@ import { mockDataView } from '../rtl_helpers';
 import { createKbnUrlStateStorage } from '../../../../../../../../src/plugins/kibana_utils/public';
 import { TRANSACTION_DURATION } from '../configurations/constants/elasticsearch_fieldnames';
 import * as lensAttributes from '../configurations/lens_attributes';
-import * as indexPattern from './use_app_index_pattern';
+import * as useAppDataViewHook from './use_app_data_view';
 import * as theme from '../../../../hooks/use_theme';
 import { dataTypes, obsvReportConfigMap, reportTypesList } from '../obsv_exploratory_view';
 import { ExploratoryViewContextProvider } from '../contexts/exploratory_view_config';
@@ -35,8 +35,8 @@ const mockSingleSeries = [
 describe('useExpViewTimeRange', function () {
   const storage = createKbnUrlStateStorage({ useHash: false });
   // @ts-ignore
-  jest.spyOn(indexPattern, 'useAppIndexPatternContext').mockReturnValue({
-    indexPatterns: {
+  jest.spyOn(useAppDataViewHook, 'useAppDataViewContext').mockReturnValue({
+    dataViews: {
       ux: mockDataView,
       apm: mockDataView,
       mobile: mockDataView,