Ability to have telemetry always opted in (#49798)

* Initial work * WIP changes * Turn off banner when allowChangingOptInStatus is true * Fix bugs * Fix broken jest tests * Add jest tests for TelemetryForm * Add TelemetryOptIn jest tests * Make some adjustments to allow always being opted in * Disallow turning telemetry completely off * Fix bug in Joi config * Keep route there
elastic · Nov 11, 2019 · ea9bb0a · ea9bb0a
1 parent a746bce
commit ea9bb0a
Show file tree

Hide file tree

Showing 15 changed files with 470 additions and 23 deletions.
diff --git a/src/legacy/core_plugins/telemetry/index.ts b/src/legacy/core_plugins/telemetry/index.ts
@@ -17,6 +17,7 @@
  * under the License.
  */
 
+import * as Rx from 'rxjs';
 import { resolve } from 'path';
 import JoiNamespace from 'joi';
 import { Server } from 'hapi';
@@ -45,6 +46,14 @@ const telemetry = (kibana: any) => {
     config(Joi: typeof JoiNamespace) {
       return Joi.object({
         enabled: Joi.boolean().default(true),
+        optIn: Joi.when('allowChangingOptInStatus', {
+          is: false,
+          then: Joi.valid(true),
+          otherwise: Joi.boolean()
+            .allow(null)
+            .default(null),
+        }),
+        allowChangingOptInStatus: Joi.boolean().default(true),
         // `config` is used internally and not intended to be set
         config: Joi.string().default(Joi.ref('$defaultConfigPath')),
         banner: Joi.boolean().default(true),
@@ -80,8 +89,25 @@ const telemetry = (kibana: any) => {
         },
       },
       async replaceInjectedVars(originalInjectedVars: any, request: any) {
+        const config = request.server.config();
+        const optIn = config.get('telemetry.optIn');
+        const allowChangingOptInStatus = config.get('telemetry.allowChangingOptInStatus');
         const currentKibanaVersion = getCurrentKibanaVersion(request.server);
-        const telemetryOptedIn = await getTelemetryOptIn({ request, currentKibanaVersion });
+        let telemetryOptedIn: boolean | null;
+
+        if (typeof optIn === 'boolean' && !allowChangingOptInStatus) {
+          // When not allowed to change optIn status and an optIn value is set, we'll overwrite with that
+          telemetryOptedIn = optIn;
+        } else {
+          telemetryOptedIn = await getTelemetryOptIn({
+            request,
+            currentKibanaVersion,
+          });
+          if (telemetryOptedIn === null) {
+            // In the senario there's no value set in telemetryOptedIn, we'll return optIn value
+            telemetryOptedIn = optIn;
+          }
+        }
 
         return {
           ...originalInjectedVars,
@@ -93,28 +119,44 @@ const telemetry = (kibana: any) => {
         return {
           telemetryEnabled: getXpackConfigWithDeprecated(config, 'telemetry.enabled'),
           telemetryUrl: getXpackConfigWithDeprecated(config, 'telemetry.url'),
-          telemetryBanner: getXpackConfigWithDeprecated(config, 'telemetry.banner'),
-          telemetryOptedIn: null,
+          telemetryBanner:
+            config.get('telemetry.allowChangingOptInStatus') !== false &&
+            getXpackConfigWithDeprecated(config, 'telemetry.banner'),
+          telemetryOptedIn: config.get('telemetry.optIn'),
+          allowChangingOptInStatus: config.get('telemetry.allowChangingOptInStatus'),
         };
       },
       hacks: ['plugins/telemetry/hacks/telemetry_init', 'plugins/telemetry/hacks/telemetry_opt_in'],
       mappings,
     },
-    init(server: Server) {
+    async init(server: Server) {
       const initializerContext = {
         env: {
           packageInfo: {
             version: getCurrentKibanaVersion(server),
           },
         },
+        config: {
+          create() {
+            const config = server.config();
+            return Rx.of({
+              enabled: config.get('telemetry.enabled'),
+              optIn: config.get('telemetry.optIn'),
+              config: config.get('telemetry.config'),
+              banner: config.get('telemetry.banner'),
+              url: config.get('telemetry.url'),
+              allowChangingOptInStatus: config.get('telemetry.allowChangingOptInStatus'),
+            });
+          },
+        },
       } as PluginInitializerContext;
 
       const coreSetup = ({
         http: { server },
         log: server.log,
       } as any) as CoreSetup;
 
-      telemetryPlugin(initializerContext).setup(coreSetup);
+      await telemetryPlugin(initializerContext).setup(coreSetup);
 
       // register collectors
       server.usage.collectorSet.register(createLocalizationUsageCollector(server));

diff --git a/...legacy/core_plugins/telemetry/public/components/__snapshots__/telemetry_form.test.js.snap b/...legacy/core_plugins/telemetry/public/components/__snapshots__/telemetry_form.test.js.snap
diff --git a/src/legacy/core_plugins/telemetry/public/components/telemetry_form.js b/src/legacy/core_plugins/telemetry/public/components/telemetry_form.js
@@ -78,6 +78,10 @@ export class TelemetryForm extends Component {
       queryMatches,
     } = this.state;
 
+    if (!telemetryOptInProvider.canChangeOptInStatus()) {
+      return null;
+    }
+
     if (queryMatches !== null && !queryMatches) {
       return null;
     }

diff --git a/src/legacy/core_plugins/telemetry/public/components/telemetry_form.test.js b/src/legacy/core_plugins/telemetry/public/components/telemetry_form.test.js
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import '../services/telemetry_opt_in.test.mocks';
+import { mockInjectedMetadata } from '../services/telemetry_opt_in.test.mocks';
 import React from 'react';
 import { shallowWithIntl } from 'test_utils/enzyme_helpers';
 import { TelemetryForm } from './telemetry_form';
@@ -33,6 +33,8 @@ const buildTelemetryOptInProvider = () => {
       switch (key) {
         case '$http':
           return mockHttp;
+        case 'allowChangingOptInStatus':
+          return true;
         default:
           return null;
       }
@@ -47,7 +49,23 @@ const buildTelemetryOptInProvider = () => {
 };
 
 describe('TelemetryForm', () => {
-  it('renders as expected', () => {
+  it('renders as expected when allows to change optIn status', () => {
+    mockInjectedMetadata({ telemetryOptedIn: null, allowChangingOptInStatus: true });
+
+    expect(shallowWithIntl(
+      <TelemetryForm
+        spacesEnabled={false}
+        query={{ text: '' }}
+        onQueryMatchChange={jest.fn()}
+        telemetryOptInProvider={buildTelemetryOptInProvider()}
+        enableSaving={true}
+      />)
+    ).toMatchSnapshot();
+  });
+
+  it(`doesn't render form when not allowed to change optIn status`, () => {
+    mockInjectedMetadata({ telemetryOptedIn: null, allowChangingOptInStatus: false });
+
     expect(shallowWithIntl(
       <TelemetryForm
         spacesEnabled={false}

diff --git a/src/legacy/core_plugins/telemetry/public/hacks/welcome_banner/click_banner.test.js b/src/legacy/core_plugins/telemetry/public/hacks/welcome_banner/click_banner.test.js
@@ -72,7 +72,7 @@ describe('click_banner', () => {
 
     const optIn = true;
     const bannerId = 'bruce-banner';
-    mockInjectedMetadata({ telemetryOptedIn: optIn });
+    mockInjectedMetadata({ telemetryOptedIn: optIn, allowChangingOptInStatus: true });
     const telemetryOptInProvider = getTelemetryOptInProvider();
 
     telemetryOptInProvider.setBannerId(bannerId);
@@ -92,7 +92,7 @@ describe('click_banner', () => {
       remove: sinon.spy()
     };
     const optIn = true;
-    mockInjectedMetadata({ telemetryOptedIn: null });
+    mockInjectedMetadata({ telemetryOptedIn: null, allowChangingOptInStatus: true });
     const telemetryOptInProvider = getTelemetryOptInProvider({ simulateFailure: true });
 
     await clickBanner(telemetryOptInProvider, optIn, { _banners: banners, _toastNotifications: toastNotifications });
@@ -110,7 +110,7 @@ describe('click_banner', () => {
       remove: sinon.spy()
     };
     const optIn = false;
-    mockInjectedMetadata({ telemetryOptedIn: null });
+    mockInjectedMetadata({ telemetryOptedIn: null, allowChangingOptInStatus: true });
     const telemetryOptInProvider = getTelemetryOptInProvider({ simulateError: true });
 
     await clickBanner(telemetryOptInProvider, optIn, { _banners: banners, _toastNotifications: toastNotifications });

diff --git a/src/legacy/core_plugins/telemetry/public/hacks/welcome_banner/handle_old_settings.test.js b/src/legacy/core_plugins/telemetry/public/hacks/welcome_banner/handle_old_settings.test.js
@@ -38,7 +38,7 @@ const getTelemetryOptInProvider = (enabled, { simulateFailure = false } = {}) =>
   const chrome = {
     addBasePath: url => url
   };
-  mockInjectedMetadata({ telemetryOptedIn: enabled });
+  mockInjectedMetadata({ telemetryOptedIn: enabled, allowChangingOptInStatus: true });
 
   const $injector = {
     get: (key) => {

diff --git a/src/legacy/core_plugins/telemetry/public/hacks/welcome_banner/should_show_banner.test.js b/src/legacy/core_plugins/telemetry/public/hacks/welcome_banner/should_show_banner.test.js
@@ -38,7 +38,7 @@ const getMockInjector = () => {
 };
 
 const getTelemetryOptInProvider = ({ telemetryOptedIn = null } = {}) => {
-  mockInjectedMetadata({ telemetryOptedIn });
+  mockInjectedMetadata({ telemetryOptedIn, allowChangingOptInStatus: true });
   const injector = getMockInjector();
   const chrome = {
     addBasePath: (url) => url

diff --git a/src/legacy/core_plugins/telemetry/public/services/telemetry_opt_in.test.js b/src/legacy/core_plugins/telemetry/public/services/telemetry_opt_in.test.js
@@ -34,7 +34,7 @@ describe('TelemetryOptInProvider', () => {
       addBasePath: (url) => url
     };
 
-    mockInjectedMetadata({ telemetryOptedIn: optedIn });
+    mockInjectedMetadata({ telemetryOptedIn: optedIn, allowChangingOptInStatus: true });
 
     const mockInjector = {
       get: (key) => {

diff --git a/src/legacy/core_plugins/telemetry/public/services/telemetry_opt_in.test.mocks.js b/src/legacy/core_plugins/telemetry/public/services/telemetry_opt_in.test.mocks.js
@@ -24,10 +24,11 @@ import {
 } from '../../../../../core/public/mocks';
 const injectedMetadataMock = injectedMetadataServiceMock.createStartContract();
 
-export function mockInjectedMetadata({ telemetryOptedIn }) {
+export function mockInjectedMetadata({ telemetryOptedIn, allowChangingOptInStatus }) {
   const mockGetInjectedVar = jest.fn().mockImplementation((key) => {
     switch (key) {
       case 'telemetryOptedIn': return telemetryOptedIn;
+      case 'allowChangingOptInStatus': return allowChangingOptInStatus;
       default: throw new Error(`unexpected injectedVar ${key}`);
     }
   });

diff --git a/src/legacy/core_plugins/telemetry/public/services/telemetry_opt_in.ts b/src/legacy/core_plugins/telemetry/public/services/telemetry_opt_in.ts
@@ -28,11 +28,15 @@ let currentOptInStatus = false;
 
 export function TelemetryOptInProvider($injector: any, chrome: any) {
   currentOptInStatus = npStart.core.injectedMetadata.getInjectedVar('telemetryOptedIn') as boolean;
+  const allowChangingOptInStatus = npStart.core.injectedMetadata.getInjectedVar(
+    'allowChangingOptInStatus'
+  ) as boolean;
 
   setCanTrackUiMetrics(currentOptInStatus);
   const provider = {
     getBannerId: () => bannerId,
     getOptIn: () => currentOptInStatus,
+    canChangeOptInStatus: () => allowChangingOptInStatus,
     setBannerId(id: string) {
       bannerId = id;
     },

diff --git a/src/legacy/core_plugins/telemetry/server/plugin.ts b/src/legacy/core_plugins/telemetry/server/plugin.ts
@@ -29,7 +29,7 @@ export class TelemetryPlugin {
     this.currentKibanaVersion = initializerContext.env.packageInfo.version;
   }
 
-  public setup(core: CoreSetup) {
+  public async setup(core: CoreSetup) {
     const currentKibanaVersion = this.currentKibanaVersion;
     telemetryCollectionManager.setStatsGetter(getStats, 'local');
     registerRoutes({ core, currentKibanaVersion });

diff --git a/src/legacy/core_plugins/telemetry/server/routes/index.ts b/src/legacy/core_plugins/telemetry/server/routes/index.ts
@@ -27,6 +27,6 @@ interface RegisterRoutesParams {
 }
 
 export function registerRoutes({ core, currentKibanaVersion }: RegisterRoutesParams) {
-  registerOptInRoutes({ core, currentKibanaVersion });
   registerTelemetryDataRoutes(core);
+  registerOptInRoutes({ core, currentKibanaVersion });
 }