[Observability] Load hasData call asynchronously (#80644)

* obs perf * fixing unit tests * fixing ts issues * fixing empty state * addressing pr comments * addressing pr comments * fixing TS issue * fixing some stuff * refactoring * fixing ts issues and unit tests * addressing PR comments * fixing TS issues * fixing eslint issue Co-authored-by: Kibana Machine <[email protected]>
elastic · Nov 23, 2020 · ac73b6a · ac73b6a
1 parent e3ca8a9
commit ac73b6a
Show file tree

Hide file tree

Showing 32 changed files with 1,214 additions and 640 deletions.
diff --git a/x-pack/plugins/apm/public/components/app/RumDashboard/ux_overview_fetchers.ts b/x-pack/plugins/apm/public/components/app/RumDashboard/ux_overview_fetchers.ts
@@ -8,6 +8,7 @@ import {
   FetchDataParams,
   HasDataParams,
   UxFetchDataResponse,
+  UXHasDataResponse,
 } from '../../../../../observability/public/';
 import { callApmApi } from '../../../services/rest/createCallApmApi';
 
@@ -35,7 +36,9 @@ export const fetchUxOverviewDate = async ({
   };
 };
 
-export async function hasRumData({ absoluteTime }: HasDataParams) {
+export async function hasRumData({
+  absoluteTime,
+}: HasDataParams): Promise<UXHasDataResponse> {
   return await callApmApi({
     endpoint: 'GET /api/apm/observability_overview/has_rum_data',
     params: {

diff --git a/x-pack/plugins/apm/server/lib/rum_client/has_rum_data.ts b/x-pack/plugins/apm/server/lib/rum_client/has_rum_data.ts
@@ -54,6 +54,6 @@ export async function hasRumData({ setup }: { setup: Setup & SetupTimeRange }) {
         response.aggregations?.services?.mostTraffic?.buckets?.[0]?.key,
     };
   } catch (e) {
-    return false;
+    return { hasData: false, serviceName: undefined };
   }
 }
diff --git a/x-pack/plugins/infra/public/utils/logs_overview_fetchers.ts b/x-pack/plugins/infra/public/utils/logs_overview_fetchers.ts
@@ -6,12 +6,7 @@
 
 import { encode } from 'rison-node';
 import { SearchResponse } from 'elasticsearch';
-import {
-  FetchData,
-  FetchDataParams,
-  HasData,
-  LogsFetchDataResponse,
-} from '../../../observability/public';
+import { FetchData, FetchDataParams, LogsFetchDataResponse } from '../../../observability/public';
 import { DEFAULT_SOURCE_ID } from '../../common/constants';
 import { callFetchLogSourceConfigurationAPI } from '../containers/logs/log_source/api/fetch_log_source_configuration';
 import { callFetchLogSourceStatusAPI } from '../containers/logs/log_source/api/fetch_log_source_status';
@@ -38,9 +33,7 @@ interface LogParams {
 
 type StatsAndSeries = Pick<LogsFetchDataResponse, 'stats' | 'series'>;
 
-export function getLogsHasDataFetcher(
-  getStartServices: InfraClientCoreSetup['getStartServices']
-): HasData {
+export function getLogsHasDataFetcher(getStartServices: InfraClientCoreSetup['getStartServices']) {
   return async () => {
     const [core] = await getStartServices();
     const sourceStatus = await callFetchLogSourceStatusAPI(DEFAULT_SOURCE_ID, core.http.fetch);

diff --git a/x-pack/plugins/observability/public/application/application.test.tsx b/x-pack/plugins/observability/public/application/application.test.tsx
@@ -11,9 +11,25 @@ import { ObservabilityPluginSetupDeps } from '../plugin';
 import { renderApp } from './';
 
 describe('renderApp', () => {
+  const originalConsole = global.console;
+  beforeAll(() => {
+    // mocks console to avoid poluting the test output
+    global.console = ({ error: jest.fn() } as unknown) as typeof console;
+  });
+
+  afterAll(() => {
+    global.console = originalConsole;
+  });
   it('renders', async () => {
     const plugins = ({
       usageCollection: { reportUiStats: () => {} },
+      data: {
+        query: {
+          timefilter: {
+            timefilter: { setTime: jest.fn(), getTime: jest.fn().mockImplementation(() => ({})) },
+          },
+        },
+      },
     } as unknown) as ObservabilityPluginSetupDeps;
     const core = ({
       application: { currentAppId$: new Observable(), navigateToUrl: () => {} },

diff --git a/x-pack/plugins/observability/public/application/index.tsx b/x-pack/plugins/observability/public/application/index.tsx
@@ -17,6 +17,7 @@ import { PluginContext } from '../context/plugin_context';
 import { usePluginContext } from '../hooks/use_plugin_context';
 import { useRouteParams } from '../hooks/use_route_params';
 import { ObservabilityPluginSetupDeps } from '../plugin';
+import { HasDataContextProvider } from '../context/has_data_context';
 import { Breadcrumbs, routes } from '../routes';
 
 const observabilityLabelBreadcrumb = {
@@ -46,8 +47,8 @@ function App() {
               core.chrome.docTitle.change(getTitleFromBreadCrumbs(breadcrumb));
             }, [core, breadcrumb]);
 
-            const { query, path: pathParams } = useRouteParams(route.params);
-            return route.handler({ query, path: pathParams });
+            const params = useRouteParams(path);
+            return route.handler(params);
           };
           return <Route key={path} path={path} exact={true} component={Wrapper} />;
         })}
@@ -79,7 +80,9 @@ export const renderApp = (
           <EuiThemeProvider darkMode={isDarkMode}>
             <i18nCore.Context>
               <RedirectAppLinks application={core.application}>
-                <App />
+                <HasDataContextProvider>
+                  <App />
+                </HasDataContextProvider>
               </RedirectAppLinks>
             </i18nCore.Context>
           </EuiThemeProvider>

diff --git a/...mponents/app/empty_section/index.test.tsx → ...app/empty_sections/empty_section.test.tsx b/...mponents/app/empty_section/index.test.tsx → ...app/empty_sections/empty_section.test.tsx
@@ -6,7 +6,7 @@
 import React from 'react';
 import { ISection } from '../../../typings/section';
 import { render } from '../../../utils/test_helper';
-import { EmptySection } from './';
+import { EmptySection } from './empty_section';
 
 describe('EmptySection', () => {
   it('renders without action button', () => {

diff --git a/...ic/components/app/empty_section/index.tsx → ...ents/app/empty_sections/empty_section.tsx b/...ic/components/app/empty_section/index.tsx → ...ents/app/empty_sections/empty_section.tsx
diff --git a/x-pack/plugins/observability/public/components/app/empty_sections/index.tsx b/x-pack/plugins/observability/public/components/app/empty_sections/index.tsx
@@ -0,0 +1,64 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { EuiFlexGrid, EuiFlexItem, EuiSpacer } from '@elastic/eui';
+import React, { useContext } from 'react';
+import { ThemeContext } from 'styled-components';
+import { Alert } from '../../../../../alerts/common';
+import { FETCH_STATUS } from '../../../hooks/use_fetcher';
+import { useHasData } from '../../../hooks/use_has_data';
+import { usePluginContext } from '../../../hooks/use_plugin_context';
+import { getEmptySections } from '../../../pages/overview/empty_section';
+import { UXHasDataResponse } from '../../../typings';
+import { EmptySection } from './empty_section';
+
+export function EmptySections() {
+  const { core } = usePluginContext();
+  const theme = useContext(ThemeContext);
+  const { hasData } = useHasData();
+
+  const appEmptySections = getEmptySections({ core }).filter(({ id }) => {
+    if (id === 'alert') {
+      const { status, hasData: alerts } = hasData.alert || {};
+      return (
+        status === FETCH_STATUS.FAILURE ||
+        (status === FETCH_STATUS.SUCCESS && (alerts as Alert[]).length === 0)
+      );
+    } else {
+      const app = hasData[id];
+      if (app) {
+        const _hasData = id === 'ux' ? (app.hasData as UXHasDataResponse)?.hasData : app.hasData;
+        return app.status === FETCH_STATUS.FAILURE || !_hasData;
+      }
+    }
+    return false;
+  });
+  return (
+    <EuiFlexItem>
+      <EuiSpacer size="s" />
+      <EuiFlexGrid
+        columns={
+          // when more than 2 empty sections are available show them on 2 columns, otherwise 1
+          appEmptySections.length > 2 ? 2 : 1
+        }
+        gutterSize="s"
+      >
+        {appEmptySections.map((app) => {
+          return (
+            <EuiFlexItem
+              key={app.id}
+              style={{
+                border: `1px dashed ${theme.eui.euiBorderColor}`,
+                borderRadius: '4px',
+              }}
+            >
+              <EmptySection section={app} />
+            </EuiFlexItem>
+          );
+        })}
+      </EuiFlexGrid>
+    </EuiFlexItem>
+  );
+}
diff --git a/x-pack/plugins/observability/public/components/app/section/apm/index.test.tsx b/x-pack/plugins/observability/public/components/app/section/apm/index.test.tsx
@@ -8,25 +8,59 @@ import * as fetcherHook from '../../../../hooks/use_fetcher';
 import { render } from '../../../../utils/test_helper';
 import { APMSection } from './';
 import { response } from './mock_data/apm.mock';
-import moment from 'moment';
+import * as hasDataHook from '../../../../hooks/use_has_data';
+import * as pluginContext from '../../../../hooks/use_plugin_context';
+import { HasDataContextValue } from '../../../../context/has_data_context';
+import { AppMountParameters, CoreStart } from 'kibana/public';
+import { ObservabilityPluginSetupDeps } from '../../../../plugin';
+
+jest.mock('react-router-dom', () => ({
+  useLocation: () => ({
+    pathname: '/observability/overview/',
+    search: '',
+  }),
+  useHistory: jest.fn(),
+}));
 
 describe('APMSection', () => {
+  beforeAll(() => {
+    jest.spyOn(hasDataHook, 'useHasData').mockReturnValue({
+      hasData: {
+        apm: {
+          status: fetcherHook.FETCH_STATUS.SUCCESS,
+          hasData: true,
+        },
+      },
+    } as HasDataContextValue);
+    jest.spyOn(pluginContext, 'usePluginContext').mockImplementation(() => ({
+      core: ({
+        uiSettings: { get: jest.fn() },
+        http: { basePath: { prepend: jest.fn() } },
+      } as unknown) as CoreStart,
+      appMountParameters: {} as AppMountParameters,
+      plugins: ({
+        data: {
+          query: {
+            timefilter: {
+              timefilter: {
+                getTime: jest.fn().mockImplementation(() => ({
+                  from: '2020-10-08T06:00:00.000Z',
+                  to: '2020-10-08T07:00:00.000Z',
+                })),
+              },
+            },
+          },
+        },
+      } as unknown) as ObservabilityPluginSetupDeps,
+    }));
+  });
   it('renders with transaction series and stats', () => {
     jest.spyOn(fetcherHook, 'useFetcher').mockReturnValue({
       data: response,
       status: fetcherHook.FETCH_STATUS.SUCCESS,
       refetch: jest.fn(),
     });
-    const { getByText, queryAllByTestId } = render(
-      <APMSection
-        absoluteTime={{
-          start: moment('2020-06-29T11:38:23.747Z').valueOf(),
-          end: moment('2020-06-29T12:08:23.748Z').valueOf(),
-        }}
-        relativeTime={{ start: 'now-15m', end: 'now' }}
-        bucketSize="60s"
-      />
-    );
+    const { getByText, queryAllByTestId } = render(<APMSection bucketSize="60s" />);
 
     expect(getByText('APM')).toBeInTheDocument();
     expect(getByText('View in app')).toBeInTheDocument();
@@ -40,16 +74,7 @@ describe('APMSection', () => {
       status: fetcherHook.FETCH_STATUS.LOADING,
       refetch: jest.fn(),
     });
-    const { getByText, queryAllByText, getByTestId } = render(
-      <APMSection
-        absoluteTime={{
-          start: moment('2020-06-29T11:38:23.747Z').valueOf(),
-          end: moment('2020-06-29T12:08:23.748Z').valueOf(),
-        }}
-        relativeTime={{ start: 'now-15m', end: 'now' }}
-        bucketSize="60s"
-      />
-    );
+    const { getByText, queryAllByText, getByTestId } = render(<APMSection bucketSize="60s" />);
 
     expect(getByText('APM')).toBeInTheDocument();
     expect(getByTestId('loading')).toBeInTheDocument();

diff --git a/x-pack/plugins/observability/public/components/app/section/apm/index.tsx b/x-pack/plugins/observability/public/components/app/section/apm/index.tsx
@@ -12,43 +12,54 @@ import moment from 'moment';
 import React, { useContext } from 'react';
 import { useHistory } from 'react-router-dom';
 import { ThemeContext } from 'styled-components';
+import { useTimeRange } from '../../../../hooks/use_time_range';
 import { SectionContainer } from '../';
 import { getDataHandler } from '../../../../data_handler';
 import { useChartTheme } from '../../../../hooks/use_chart_theme';
 import { FETCH_STATUS, useFetcher } from '../../../../hooks/use_fetcher';
+import { useHasData } from '../../../../hooks/use_has_data';
 import { ChartContainer } from '../../chart_container';
 import { StyledStat } from '../../styled_stat';
 import { onBrushEnd } from '../helper';
 
 interface Props {
-  absoluteTime: { start?: number; end?: number };
-  relativeTime: { start: string; end: string };
   bucketSize?: string;
 }
 
 function formatTpm(value?: number) {
   return numeral(value).format('0.00a');
 }
 
-export function APMSection({ absoluteTime, relativeTime, bucketSize }: Props) {
+export function APMSection({ bucketSize }: Props) {
   const theme = useContext(ThemeContext);
+  const chartTheme = useChartTheme();
   const history = useHistory();
+  const { forceUpdate, hasData } = useHasData();
+  const { relativeStart, relativeEnd, absoluteStart, absoluteEnd } = useTimeRange();
 
-  const { start, end } = absoluteTime;
-  const { data, status } = useFetcher(() => {
-    if (start && end && bucketSize) {
-      return getDataHandler('apm')?.fetchData({
-        absoluteTime: { start, end },
-        relativeTime,
-        bucketSize,
-      });
-    }
-  }, [start, end, bucketSize, relativeTime]);
+  const { data, status } = useFetcher(
+    () => {
+      if (bucketSize) {
+        return getDataHandler('apm')?.fetchData({
+          absoluteTime: { start: absoluteStart, end: absoluteEnd },
+          relativeTime: { start: relativeStart, end: relativeEnd },
+          bucketSize,
+        });
+      }
+    },
+    // Absolute times shouldn't be used here, since it would refetch on every render
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [bucketSize, relativeStart, relativeEnd, forceUpdate]
+  );
+
+  if (!hasData.apm?.hasData) {
+    return null;
+  }
 
   const { appLink, stats, series } = data || {};
 
-  const min = moment.utc(absoluteTime.start).valueOf();
-  const max = moment.utc(absoluteTime.end).valueOf();
+  const min = moment.utc(absoluteStart).valueOf();
+  const max = moment.utc(absoluteEnd).valueOf();
 
   const formatter = niceTimeFormatter([min, max]);
 
@@ -93,7 +104,7 @@ export function APMSection({ absoluteTime, relativeTime, bucketSize }: Props) {
       <ChartContainer isInitialLoad={isLoading && !data}>
         <Settings
           onBrushEnd={({ x }) => onBrushEnd({ x, history })}
-          theme={useChartTheme()}
+          theme={chartTheme}
           showLegend={false}
           xDomain={{ min, max }}
         />