[Telemetry] Migrate public to NP (#56285)

* NP telemetry plugin barebones

* fully migrate telemetry sender

* license plugin to use NP telemetry

* fully migrated public to NP

* finish components testing

* fix all tests

* self code review

* remove commented code

* bracket notication for private methods

* bracket notication for private methods

* update license management tests

* afharo code review fixes

* type safe private method access in tests

* fix typecheck

* more type check fixes

* i18n check

* fix welcome page tests

* i18n optedInNoticeBanner title

* fix advanced settings field settings

* field name

* fix home snapshots

* listen to app id change

* NP code review fixes

* NP code review fixes

* update telemetry configs with np deprecations

* pass telemetry from setup instead of npStart

* type check

* update core snapshots with new api exposed

* remove debugging logs

* update home contract

* update home contract

* fix test eslint import

* navigate back to dashboard before start of next case for reporting

* gitignore reporting failure_debug generated dir

* use gotoDashboardEditMode instead of switch

* = instead of :

* merge master

* escape unused forced types in Field

* rename mock to mocks for eslint

* Update src/plugins/telemetry/public/components/telemetry_management_section.tsx

Co-Authored-By: Alejandro Fernández Haro <[email protected]>

* fix save/clear type

Co-authored-by: Alejandro Fernández Haro <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>

.i18nrc.json

@@ -37,7 +37,10 @@
     "savedObjects": "src/plugins/saved_objects",
     "server": "src/legacy/server",
     "statusPage": "src/legacy/core_plugins/status_page",
-    "telemetry": "src/legacy/core_plugins/telemetry",
+    "telemetry": [
+      "src/legacy/core_plugins/telemetry",
+      "src/plugins/telemetry"
+    ],
     "tileMap": "src/legacy/core_plugins/tile_map",
     "timelion": ["src/legacy/core_plugins/timelion", "src/legacy/core_plugins/vis_type_timelion", "src/plugins/timelion"],
     "uiActions": "src/plugins/ui_actions",

docs/development/core/public/kibana-plugin-public.applicationstart.currentappid_.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ApplicationStart](./kibana-plugin-public.applicationstart.md) &gt; [currentAppId$](./kibana-plugin-public.applicationstart.currentappid_.md)
+
+## ApplicationStart.currentAppId$ property
+
+An observable that emits the current application id and each subsequent id update.
+
+<b>Signature:</b>
+
+```typescript
+currentAppId$: Observable<string | undefined>;
+```

docs/development/core/public/kibana-plugin-public.applicationstart.md

@@ -16,6 +16,7 @@ export interface ApplicationStart
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [capabilities](./kibana-plugin-public.applicationstart.capabilities.md) | <code>RecursiveReadonly&lt;Capabilities&gt;</code> | Gets the read-only capabilities. |
+|  [currentAppId$](./kibana-plugin-public.applicationstart.currentappid_.md) | <code>Observable&lt;string &#124; undefined&gt;</code> | An observable that emits the current application id and each subsequent id update. |
 
 ## Methods
 

src/core/public/application/application_service.mock.ts

@@ -43,12 +43,17 @@ const createInternalSetupContractMock = (): jest.Mocked<InternalApplicationSetup
   registerMountContext: jest.fn(),
 });
 
-const createStartContractMock = (): jest.Mocked<ApplicationStart> => ({
-  capabilities: capabilitiesServiceMock.createStartContract().capabilities,
-  navigateToApp: jest.fn(),
-  getUrlForApp: jest.fn(),
-  registerMountContext: jest.fn(),
-});
+const createStartContractMock = (): jest.Mocked<ApplicationStart> => {
+  const currentAppId$ = new Subject<string | undefined>();
+
+  return {
+    currentAppId$: currentAppId$.asObservable(),
+    capabilities: capabilitiesServiceMock.createStartContract().capabilities,
+    navigateToApp: jest.fn(),
+    getUrlForApp: jest.fn(),
+    registerMountContext: jest.fn(),
+  };
+};
 
 const createInternalStartContractMock = (): jest.Mocked<InternalApplicationStart> => {
   const currentAppId$ = new Subject<string | undefined>();

src/core/public/application/types.ts

@@ -612,11 +612,19 @@ export interface ApplicationStart {
     contextName: T,
     provider: IContextProvider<AppMountDeprecated, T>
   ): void;
+
+  /**
+   * An observable that emits the current application id and each subsequent id update.
+   */
+  currentAppId$: Observable<string | undefined>;
 }
 
 /** @internal */
 export interface InternalApplicationStart
-  extends Pick<ApplicationStart, 'capabilities' | 'navigateToApp' | 'getUrlForApp'> {
+  extends Pick<
+    ApplicationStart,
+    'capabilities' | 'navigateToApp' | 'getUrlForApp' | 'currentAppId$'
+  > {
   /**
    * Apps available based on the current capabilities.
    * Should be used to show navigation links and make routing decisions.
@@ -640,7 +648,6 @@ export interface InternalApplicationStart
   ): void;
 
   // Internal APIs
-  currentAppId$: Observable<string | undefined>;
   getComponent(): JSX.Element | null;
 }
 

src/core/public/legacy/legacy_service.ts

@@ -121,6 +121,7 @@ export class LegacyPlatformService {
     const legacyCore: LegacyCoreStart = {
       ...core,
       application: {
+        currentAppId$: core.application.currentAppId$,
         capabilities: core.application.capabilities,
         getUrlForApp: core.application.getUrlForApp,
         navigateToApp: core.application.navigateToApp,

src/core/public/plugins/plugin_context.ts

@@ -134,6 +134,7 @@ export function createPluginStartContext<
 ): CoreStart {
   return {
     application: {
+      currentAppId$: deps.application.currentAppId$,
       capabilities: deps.application.capabilities,
       navigateToApp: deps.application.navigateToApp,
       getUrlForApp: deps.application.getUrlForApp,

src/core/public/public.api.md

@@ -98,6 +98,7 @@ export interface ApplicationSetup {
 // @public (undocumented)
 export interface ApplicationStart {
     capabilities: RecursiveReadonly<Capabilities>;
+    currentAppId$: Observable<string | undefined>;
     getUrlForApp(appId: string, options?: {
         path?: string;
     }): string;

src/core/server/config/deprecation/core_deprecations.ts

@@ -115,6 +115,9 @@ export const coreDeprecationProvider: ConfigDeprecationProvider = ({
   renameFromRoot('optimize.lazyHost', 'optimize.watchHost'),
   renameFromRoot('optimize.lazyPrebuild', 'optimize.watchPrebuild'),
   renameFromRoot('optimize.lazyProxyTimeout', 'optimize.watchProxyTimeout'),
+  renameFromRoot('xpack.xpack_main.telemetry.config', 'telemetry.config'),
+  renameFromRoot('xpack.xpack_main.telemetry.url', 'telemetry.url'),
+  renameFromRoot('xpack.xpack_main.telemetry.enabled', 'telemetry.enabled'),
   renameFromRoot('xpack.telemetry.enabled', 'telemetry.enabled'),
   renameFromRoot('xpack.telemetry.config', 'telemetry.config'),
   renameFromRoot('xpack.telemetry.banner', 'telemetry.banner'),

src/legacy/core_plugins/kibana/public/home/index.ts

@@ -18,41 +18,16 @@
  */
 
 import { npSetup, npStart } from 'ui/new_platform';
-import chrome from 'ui/chrome';
-import { HomePlugin, LegacyAngularInjectedDependencies } from './plugin';
-import { TelemetryOptInProvider } from '../../../telemetry/public/services';
-import { IPrivate } from '../../../../../plugins/kibana_legacy/public';
-
-/**
- * Get dependencies relying on the global angular context.
- * They also have to get resolved together with the legacy imports above
- */
-async function getAngularDependencies(): Promise<LegacyAngularInjectedDependencies> {
-  const injector = await chrome.dangerouslyGetActiveInjector();
-
-  const Private = injector.get<IPrivate>('Private');
-
-  const telemetryEnabled = npStart.core.injectedMetadata.getInjectedVar('telemetryEnabled');
-  const telemetryBanner = npStart.core.injectedMetadata.getInjectedVar('telemetryBanner');
-  const telemetryOptInProvider = Private(TelemetryOptInProvider);
-
-  return {
-    telemetryOptInProvider,
-    shouldShowTelemetryOptIn:
-      telemetryEnabled && telemetryBanner && !telemetryOptInProvider.getOptIn(),
-  };
-}
+import { HomePlugin } from './plugin';
 
 (async () => {
   const instance = new HomePlugin();
   instance.setup(npSetup.core, {
     ...npSetup.plugins,
     __LEGACY: {
       metadata: npStart.core.injectedMetadata.getLegacyMetadata(),
-      getAngularDependencies,
     },
   });
-  instance.start(npStart.core, {
-    ...npStart.plugins,
-  });
+
+  instance.start(npStart.core, npStart.plugins);
 })();

src/legacy/core_plugins/kibana/public/home/kibana_services.ts

@@ -29,6 +29,7 @@ import {
   UiSettingsState,
 } from 'kibana/public';
 import { UiStatsMetricType } from '@kbn/analytics';
+import { TelemetryPluginStart } from '../../../../../plugins/telemetry/public';
 import {
   Environment,
   HomePublicPluginSetup,
@@ -53,7 +54,6 @@ export interface HomeKibanaServices {
   };
   getInjected: (name: string, defaultValue?: any) => unknown;
   chrome: ChromeStart;
-  telemetryOptInProvider: any;
   uiSettings: IUiSettingsClient;
   config: KibanaLegacySetup['config'];
   homeConfig: HomePublicPluginSetup['config'];
@@ -64,10 +64,10 @@ export interface HomeKibanaServices {
   banners: OverlayStart['banners'];
   trackUiMetric: (type: UiStatsMetricType, eventNames: string | string[], count?: number) => void;
   getBasePath: () => string;
-  shouldShowTelemetryOptIn: boolean;
   docLinks: DocLinksStart;
   addBasePath: (url: string) => string;
   environment: Environment;
+  telemetry?: TelemetryPluginStart;
 }
 
 let services: HomeKibanaServices | null = null;

src/legacy/core_plugins/kibana/public/home/np_ready/components/home.js

@@ -51,7 +51,6 @@ export class Home extends Component {
       getServices().homeConfig.disableWelcomeScreen ||
       props.localStorage.getItem(KEY_ENABLE_WELCOME) === 'false'
     );
-    const currentOptInStatus = this.props.getOptInStatus();
     this.state = {
       // If welcome is enabled, we wait for loading to complete
       // before rendering. This prevents an annoying flickering
@@ -60,7 +59,6 @@ export class Home extends Component {
       isLoading: isWelcomeEnabled,
       isNewKibanaInstance: false,
       isWelcomeEnabled,
-      currentOptInStatus,
     };
   }
 
@@ -224,8 +222,7 @@ export class Home extends Component {
       <Welcome
         onSkip={this.skipWelcome}
         urlBasePath={this.props.urlBasePath}
-        onOptInSeen={this.props.onOptInSeen}
-        currentOptInStatus={this.state.currentOptInStatus}
+        telemetry={this.props.telemetry}
       />
     );
   }
@@ -264,6 +261,8 @@ Home.propTypes = {
   localStorage: PropTypes.object.isRequired,
   urlBasePath: PropTypes.string.isRequired,
   mlEnabled: PropTypes.bool.isRequired,
-  onOptInSeen: PropTypes.func.isRequired,
-  getOptInStatus: PropTypes.func.isRequired,
+  telemetry: PropTypes.shape({
+    telemetryService: PropTypes.any,
+    telemetryNotifications: PropTypes.any,
+  }),
 };

src/legacy/core_plugins/kibana/public/home/np_ready/components/home_app.js

@@ -35,7 +35,7 @@ export function HomeApp({ directories }) {
     getBasePath,
     addBasePath,
     environment,
-    telemetryOptInProvider: { setOptInNoticeSeen, getOptIn },
+    telemetry,
   } = getServices();
   const isCloudEnabled = environment.cloud;
   const mlEnabled = environment.ml;
@@ -84,8 +84,7 @@ export function HomeApp({ directories }) {
               find={savedObjectsClient.find}
               localStorage={localStorage}
               urlBasePath={getBasePath()}
-              onOptInSeen={setOptInNoticeSeen}
-              getOptInStatus={getOptIn}
+              telemetry={telemetry}
             />
           </Route>
           <Route path="/home">

src/legacy/core_plugins/kibana/public/home/np_ready/components/welcome.test.tsx

@@ -20,6 +20,7 @@
 import React from 'react';
 import { shallow } from 'enzyme';
 import { Welcome } from './welcome';
+import { telemetryPluginMock } from '../../../../../../../plugins/telemetry/public/mocks';
 
 jest.mock('../../kibana_services', () => ({
   getServices: () => ({
@@ -29,27 +30,32 @@ jest.mock('../../kibana_services', () => ({
 }));
 
 test('should render a Welcome screen with the telemetry disclaimer', () => {
+  const telemetry = telemetryPluginMock.createSetupContract();
   const component = shallow(
     // @ts-ignore
-    <Welcome urlBasePath="/" onSkip={() => {}} onOptInSeen={() => {}} />
+    <Welcome urlBasePath="/" onSkip={() => {}} telemetry={telemetry} />
   );
 
   expect(component).toMatchSnapshot();
 });
 
 test('should render a Welcome screen with the telemetry disclaimer when optIn is true', () => {
+  const telemetry = telemetryPluginMock.createSetupContract();
+  telemetry.telemetryService.getIsOptedIn = jest.fn().mockReturnValue(true);
   const component = shallow(
     // @ts-ignore
-    <Welcome urlBasePath="/" onSkip={() => {}} onOptInSeen={() => {}} currentOptInStatus={true} />
+    <Welcome urlBasePath="/" onSkip={() => {}} telemetry={telemetry} />
   );
 
   expect(component).toMatchSnapshot();
 });
 
 test('should render a Welcome screen with the telemetry disclaimer when optIn is false', () => {
+  const telemetry = telemetryPluginMock.createSetupContract();
+  telemetry.telemetryService.getIsOptedIn = jest.fn().mockReturnValue(false);
   const component = shallow(
     // @ts-ignore
-    <Welcome urlBasePath="/" onSkip={() => {}} onOptInSeen={() => {}} currentOptInStatus={false} />
+    <Welcome urlBasePath="/" onSkip={() => {}} telemetry={telemetry} />
   );
 
   expect(component).toMatchSnapshot();
@@ -59,19 +65,21 @@ test('should render a Welcome screen with no telemetry disclaimer', () => {
   // @ts-ignore
   const component = shallow(
     // @ts-ignore
-    <Welcome urlBasePath="/" onSkip={() => {}} onOptInSeen={() => {}} />
+    <Welcome urlBasePath="/" onSkip={() => {}} telemetry={null} />
   );
 
   expect(component).toMatchSnapshot();
 });
 
 test('fires opt-in seen when mounted', () => {
-  const seen = jest.fn();
-
+  const telemetry = telemetryPluginMock.createSetupContract();
+  const mockSetOptedInNoticeSeen = jest.fn();
+  // @ts-ignore
+  telemetry.telemetryNotifications.setOptedInNoticeSeen = mockSetOptedInNoticeSeen;
   shallow(
     // @ts-ignore
-    <Welcome urlBasePath="/" onSkip={() => {}} onOptInSeen={seen} />
+    <Welcome urlBasePath="/" onSkip={() => {}} telemetry={telemetry} />
   );
 
-  expect(seen).toHaveBeenCalled();
+  expect(mockSetOptedInNoticeSeen).toHaveBeenCalled();
 });