Move KibanaEnvironmentContext to apm and infra

elastic · Jan 3, 2024 · 894d688 · 894d688
1 parent b3e0d7d
commit 894d688
Show file tree

Hide file tree

Showing 12 changed files with 174 additions and 109 deletions.
diff --git a/src/plugins/kibana_react/public/context/context.tsx b/src/plugins/kibana_react/public/context/context.tsx
@@ -7,20 +7,14 @@
  */
 
 import * as React from 'react';
-import type {
-  KibanaEnvironment,
-  KibanaReactContext,
-  KibanaReactContextValue,
-  KibanaServices,
-} from './types';
+import { KibanaReactContext, KibanaReactContextValue, KibanaServices } from './types';
 import { createReactOverlays } from '../overlays';
 import { createNotifications } from '../notifications';
 
 const { useMemo, useContext, createElement, createContext } = React;
 
 const defaultContextValue = {
   services: {},
-  kibanaEnvironment: {},
   overlays: createReactOverlays({}),
   notifications: createNotifications({}),
 };
@@ -43,29 +37,22 @@ export const withKibana = <Props extends { kibana: KibanaReactContextValue<{}> }
 };
 
 export const createKibanaReactContext = <Services extends KibanaServices>(
-  services: Services,
-  kibanaEnvironment?: KibanaEnvironment
+  services: Services
 ): KibanaReactContext<Services> => {
   const value: KibanaReactContextValue<Services> = {
     services,
     overlays: createReactOverlays(services),
     notifications: createNotifications(services),
-    kibanaEnvironment: kibanaEnvironment ?? {},
   };
 
-  const Provider: React.FC<{ services?: Services; kibanaEnvironment?: KibanaEnvironment }> = ({
+  const Provider: React.FC<{ services?: Services }> = ({
     services: newServices = {},
-    kibanaEnvironment: newKibanaEnvironment = {},
     children,
   }) => {
     const oldValue = useKibana();
     const { value: newValue } = useMemo(
-      () =>
-        createKibanaReactContext(
-          { ...services, ...oldValue.services, ...newServices },
-          { ...kibanaEnvironment, ...oldValue.kibanaEnvironment, ...newKibanaEnvironment }
-        ),
-      [services, oldValue, newServices, kibanaEnvironment, newKibanaEnvironment]
+      () => createKibanaReactContext({ ...services, ...oldValue.services, ...newServices }),
+      [services, oldValue, newServices]
     );
 
     const newProvider = createElement(context.Provider, {
@@ -83,4 +70,4 @@ export const createKibanaReactContext = <Services extends KibanaServices>(
   };
 };
 
-export const { Provider: KibanaContextProvider } = createKibanaReactContext({}, {});
+export const { Provider: KibanaContextProvider } = createKibanaReactContext({});
diff --git a/src/plugins/kibana_react/public/context/types.ts b/src/plugins/kibana_react/public/context/types.ts
@@ -12,21 +12,15 @@ import { KibanaReactOverlays } from '../overlays';
 import { KibanaReactNotifications } from '../notifications';
 
 export type KibanaServices = Partial<CoreStart>;
-export interface KibanaEnvironment {
-  kibanaVersion?: string;
-  isCloudEnv?: boolean;
-  isServerlessEnv?: boolean;
-}
 
 export interface KibanaReactContextValue<Services extends KibanaServices> {
   readonly services: Services;
-  readonly kibanaEnvironment: KibanaEnvironment;
   readonly overlays: KibanaReactOverlays;
   readonly notifications: KibanaReactNotifications;
 }
 
 export interface KibanaReactContext<T extends KibanaServices> {
   value: KibanaReactContextValue<T>;
-  Provider: React.FC<{ services?: T; kibanaEnvironment?: KibanaEnvironment }>;
+  Provider: React.FC<{ services?: T }>;
   Consumer: React.Consumer<KibanaReactContextValue<T>>;
 }
diff --git a/x-pack/plugins/apm/public/components/routing/app_root/index.tsx b/x-pack/plugins/apm/public/components/routing/app_root/index.tsx
@@ -21,6 +21,7 @@ import { RouteRenderer, RouterProvider } from '@kbn/typed-react-router-config';
 import { euiDarkVars, euiLightVars } from '@kbn/ui-theme';
 import React from 'react';
 import { DefaultTheme, ThemeProvider } from 'styled-components';
+import { useKibanaEnvironmentContextProvider } from '../../../context/kibana_environment_context/use_kibana_environment_context';
 import { AnomalyDetectionJobsContextProvider } from '../../../context/anomaly_detection_jobs/anomaly_detection_jobs_context';
 import {
   ApmPluginContext,
@@ -55,6 +56,8 @@ export function ApmAppRoot({
   apmServices: ApmServices;
 }) {
   const { appMountParameters, core } = apmPluginContextValue;
+  const KibanaEnvironmentContextProvider =
+    useKibanaEnvironmentContextProvider(pluginsStart);
   const { history } = appMountParameters;
   const i18nCore = core.i18n;
 
@@ -72,52 +75,49 @@ export function ApmAppRoot({
         <ApmPluginContext.Provider value={apmPluginContextValue}>
           <KibanaContextProvider
             services={{ ...core, ...pluginsStart, storage, ...apmServices }}
-            kibanaEnvironment={{
-              kibanaVersion: pluginsStart.kibanaVersion,
-              isCloudEnv: pluginsStart.isCloudEnv,
-              isServerlessEnv: pluginsStart.isServerlessEnv,
-            }}
           >
-            <i18nCore.Context>
-              <TimeRangeIdContextProvider>
-                <RouterProvider history={history} router={apmRouter as any}>
-                  <ApmErrorBoundary>
-                    <RedirectDependenciesToDependenciesInventory>
-                      <RedirectWithDefaultEnvironment>
-                        <RedirectWithDefaultDateRange>
-                          <RedirectWithOffset>
-                            <TrackPageview>
-                              <UpdateExecutionContextOnRouteChange>
-                                <BreadcrumbsContextProvider>
-                                  <UrlParamsProvider>
-                                    <LicenseProvider>
-                                      <AnomalyDetectionJobsContextProvider>
-                                        <InspectorContextProvider>
-                                          <ApmThemeProvider>
-                                            <MountApmHeaderActionMenu />
+            <KibanaEnvironmentContextProvider kibanaEnvironment={pluginsStart}>
+              <i18nCore.Context>
+                <TimeRangeIdContextProvider>
+                  <RouterProvider history={history} router={apmRouter as any}>
+                    <ApmErrorBoundary>
+                      <RedirectDependenciesToDependenciesInventory>
+                        <RedirectWithDefaultEnvironment>
+                          <RedirectWithDefaultDateRange>
+                            <RedirectWithOffset>
+                              <TrackPageview>
+                                <UpdateExecutionContextOnRouteChange>
+                                  <BreadcrumbsContextProvider>
+                                    <UrlParamsProvider>
+                                      <LicenseProvider>
+                                        <AnomalyDetectionJobsContextProvider>
+                                          <InspectorContextProvider>
+                                            <ApmThemeProvider>
+                                              <MountApmHeaderActionMenu />
 
-                                            <Route
-                                              component={
-                                                ScrollToTopOnPathChange
-                                              }
-                                            />
-                                            <RouteRenderer />
-                                          </ApmThemeProvider>
-                                        </InspectorContextProvider>
-                                      </AnomalyDetectionJobsContextProvider>
-                                    </LicenseProvider>
-                                  </UrlParamsProvider>
-                                </BreadcrumbsContextProvider>
-                              </UpdateExecutionContextOnRouteChange>
-                            </TrackPageview>
-                          </RedirectWithOffset>
-                        </RedirectWithDefaultDateRange>
-                      </RedirectWithDefaultEnvironment>
-                    </RedirectDependenciesToDependenciesInventory>
-                  </ApmErrorBoundary>
-                </RouterProvider>
-              </TimeRangeIdContextProvider>
-            </i18nCore.Context>
+                                              <Route
+                                                component={
+                                                  ScrollToTopOnPathChange
+                                                }
+                                              />
+                                              <RouteRenderer />
+                                            </ApmThemeProvider>
+                                          </InspectorContextProvider>
+                                        </AnomalyDetectionJobsContextProvider>
+                                      </LicenseProvider>
+                                    </UrlParamsProvider>
+                                  </BreadcrumbsContextProvider>
+                                </UpdateExecutionContextOnRouteChange>
+                              </TrackPageview>
+                            </RedirectWithOffset>
+                          </RedirectWithDefaultDateRange>
+                        </RedirectWithDefaultEnvironment>
+                      </RedirectDependenciesToDependenciesInventory>
+                    </ApmErrorBoundary>
+                  </RouterProvider>
+                </TimeRangeIdContextProvider>
+              </i18nCore.Context>
+            </KibanaEnvironmentContextProvider>
           </KibanaContextProvider>
         </ApmPluginContext.Provider>
       </RedirectAppLinks>

diff --git a/x-pack/plugins/apm/public/components/routing/templates/apm_main_template.tsx b/x-pack/plugins/apm/public/components/routing/templates/apm_main_template.tsx
@@ -9,9 +9,10 @@ import { EuiFlexGroup, EuiFlexItem, EuiPageHeaderProps } from '@elastic/eui';
 import { useKibana } from '@kbn/kibana-react-plugin/public';
 import { ObservabilityPageTemplateProps } from '@kbn/observability-shared-plugin/public';
 import type { KibanaPageTemplateProps } from '@kbn/shared-ux-page-kibana-template';
-import React from 'react';
+import React, { useContext } from 'react';
 import { useLocation } from 'react-router-dom';
 import { FeatureFeedbackButton } from '@kbn/observability-shared-plugin/public';
+import { KibanaEnvironmentContext } from '../../../context/kibana_environment_context/kibana_environment_context';
 import { getPathForFeedback } from '../../../utils/get_path_for_feedback';
 import { EnvironmentsContextProvider } from '../../../context/environments_context/environments_context';
 import { FETCH_STATUS, useFetcher } from '../../../hooks/use_fetcher';
@@ -58,7 +59,8 @@ export function ApmMainTemplate({
   Pick<ObservabilityPageTemplateProps, 'pageSectionProps'>) {
   const location = useLocation();
 
-  const { services, kibanaEnvironment } = useKibana<ApmPluginStartDeps>();
+  const { services } = useKibana<ApmPluginStartDeps>();
+  const kibanaEnvironment = useContext(KibanaEnvironmentContext);
   const { http, docLinks, observabilityShared, application } = services;
   const { kibanaVersion, isCloudEnv, isServerlessEnv } = kibanaEnvironment;
   const basePath = http?.basePath.get();

diff --git a/x-pack/plugins/apm/public/context/kibana_environment_context/kibana_environment_context.tsx b/x-pack/plugins/apm/public/context/kibana_environment_context/kibana_environment_context.tsx
@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { createContext } from 'react';
+
+export interface KibanaEnvContext {
+  kibanaVersion?: string;
+  isCloudEnv?: boolean;
+  isServerlessEnv?: boolean;
+}
+
+export const KibanaEnvironmentContext = createContext<KibanaEnvContext>({});
diff --git a/.../plugins/apm/public/context/kibana_environment_context/use_kibana_environment_context.tsx b/.../plugins/apm/public/context/kibana_environment_context/use_kibana_environment_context.tsx
@@ -0,0 +1,40 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React, { useMemo, createElement } from 'react';
+import { ApmPluginStartDeps } from '../../plugin';
+import {
+  KibanaEnvironmentContext,
+  type KibanaEnvContext,
+} from './kibana_environment_context';
+
+export const useKibanaEnvironmentContextProvider = (
+  plugins: ApmPluginStartDeps
+) => {
+  const value = useMemo(
+    () => ({
+      kibanaVersion: plugins.kibanaVersion,
+      isCloudEnv: plugins.isCloudEnv,
+      isServerlessEnv: plugins.isServerlessEnv,
+    }),
+    [plugins]
+  );
+
+  const Provider: React.FC<{ kibanaEnvironment?: KibanaEnvContext }> = ({
+    kibanaEnvironment = {},
+    children,
+  }) => {
+    const newProvider = createElement(KibanaEnvironmentContext.Provider, {
+      value: { ...kibanaEnvironment, ...value },
+      children,
+    });
+
+    return newProvider;
+  };
+
+  return Provider;
+};
diff --git a/x-pack/plugins/infra/public/apps/common_providers.tsx b/x-pack/plugins/infra/public/apps/common_providers.tsx
@@ -13,7 +13,10 @@ import type { ObservabilityAIAssistantPluginStart } from '@kbn/observability-ai-
 import { Storage } from '@kbn/kibana-utils-plugin/public';
 import { NavigationWarningPromptProvider } from '@kbn/observability-shared-plugin/public';
 import { TriggersAndActionsUIPublicPluginStart } from '@kbn/triggers-actions-ui-plugin/public';
-import { useKibanaContextForPluginProvider } from '../hooks/use_kibana';
+import {
+  useKibanaContextForPluginProvider,
+  useKibanaEnvironmentContextProvider,
+} from '../hooks/use_kibana';
 import { InfraClientStartDeps, InfraClientStartExports } from '../types';
 import { HeaderActionMenuProvider } from '../utils/header_action_menu_provider';
 import { TriggersActionsProvider } from '../utils/triggers_actions_context';
@@ -70,11 +73,15 @@ export const CoreProviders: React.FC<CoreProvidersProps> = ({
     pluginStart
   );
 
+  const MyEnvContextForPluginProvider = useKibanaEnvironmentContextProvider(plugins);
+
   return (
     <KibanaContextProviderForPlugin services={{ ...core, ...plugins, ...pluginStart }}>
-      <core.i18n.Context>
-        <KibanaThemeProvider theme$={theme$}>{children}</KibanaThemeProvider>
-      </core.i18n.Context>
+      <MyEnvContextForPluginProvider kibanaEnvironment={{ ...plugins }}>
+        <core.i18n.Context>
+          <KibanaThemeProvider theme$={theme$}>{children}</KibanaThemeProvider>
+        </core.i18n.Context>
+      </MyEnvContextForPluginProvider>
     </KibanaContextProviderForPlugin>
   );
 };

diff --git a/x-pack/plugins/infra/public/hooks/use_kibana.tsx b/x-pack/plugins/infra/public/hooks/use_kibana.tsx
@@ -6,7 +6,7 @@
  */
 
 import type { PropsOf } from '@elastic/eui';
-import React, { useMemo } from 'react';
+import React, { useMemo, createElement, createContext } from 'react';
 import { CoreStart } from '@kbn/core/public';
 import {
   createKibanaReactContext,
@@ -17,23 +17,24 @@ import { InfraClientCoreSetup, InfraClientStartDeps, InfraClientStartExports } f
 
 export type PluginKibanaContextValue = CoreStart & InfraClientStartDeps & InfraClientStartExports;
 
+interface KibanaEnvContext {
+  kibanaVersion?: string;
+  isCloudEnv?: boolean;
+  isServerlessEnv?: boolean;
+}
+
 export const createKibanaContextForPlugin = (
   core: CoreStart,
   plugins: InfraClientStartDeps,
   pluginStart: InfraClientStartExports
 ) =>
-  createKibanaReactContext<PluginKibanaContextValue>(
-    {
-      ...core,
-      ...plugins,
-      ...pluginStart,
-    },
-    {
-      kibanaVersion: plugins.kibanaVersion,
-      isCloudEnv: plugins.isCloudEnv,
-      isServerlessEnv: plugins.isServerlessEnv,
-    }
-  );
+  createKibanaReactContext<PluginKibanaContextValue>({
+    ...core,
+    ...plugins,
+    ...pluginStart,
+  });
+
+export const KibanaEnvironmentContext = createContext<KibanaEnvContext>({});
 
 export const useKibanaContextForPlugin =
   useKibana as () => KibanaReactContextValue<PluginKibanaContextValue>;
@@ -50,6 +51,31 @@ export const useKibanaContextForPluginProvider = (
   return Provider;
 };
 
+export const useKibanaEnvironmentContextProvider = (plugins: InfraClientStartDeps) => {
+  const value = useMemo(
+    () => ({
+      kibanaVersion: plugins.kibanaVersion,
+      isCloudEnv: plugins.isCloudEnv,
+      isServerlessEnv: plugins.isServerlessEnv,
+    }),
+    [plugins]
+  );
+
+  const Provider: React.FC<{ kibanaEnvironment?: KibanaEnvContext }> = ({
+    kibanaEnvironment = {},
+    children,
+  }) => {
+    const newProvider = createElement(KibanaEnvironmentContext.Provider, {
+      value: { ...kibanaEnvironment, ...value },
+      children,
+    });
+
+    return newProvider;
+  };
+
+  return Provider;
+};
+
 export const createLazyComponentWithKibanaContext = <T extends React.ComponentType<any>>(
   coreSetup: InfraClientCoreSetup,
   lazyComponentFactory: () => Promise<{ default: T }>