Migrate CSP usage collector to kibana_usage_collection plugin (#75536)

* move csp usage collector from legacy kibana plugin to kibana_usage_collection

* make scripts/telemetry_check happy.

* remove assertion on legacy kibana plugin

* remove test on legacy kibana plugin

* update README

Author: pgayvallet

src/legacy/core_plugins/kibana/index.js

@@ -21,7 +21,6 @@ import Fs from 'fs';
 import { promisify } from 'util';
 
 import { getUiSettingDefaults } from './server/ui_setting_defaults';
-import { registerCspCollector } from './server/lib/csp_usage_collector';
 
 const mkdirAsync = promisify(Fs.mkdir);
 
@@ -53,10 +52,5 @@ export default function (kibana) {
         throw err;
       }
     },
-
-    init: async function (server) {
-      const { usageCollection } = server.newPlatform.setup.plugins;
-      registerCspCollector(usageCollection, server);
-    },
   });
 }

src/plugins/kibana_usage_collection/README.md

@@ -7,3 +7,4 @@ This plugin registers the basic usage collectors from Kibana:
 - Ops stats
 - Number of Saved Objects per type
 - Non-default UI Settings
+- CSP configuration

src/plugins/kibana_usage_collection/server/__snapshots__/index.test.ts.snap

@@ -17,35 +17,24 @@
  * under the License.
  */
 
-import { CspConfig, ICspConfig } from '../../../../../../core/server';
+import { CspConfig, ICspConfig } from '../../../../../core/server';
 import { createCspCollector } from './csp_collector';
-
-const createMockKbnServer = () => ({
-  newPlatform: {
-    setup: {
-      core: {
-        http: {
-          csp: new CspConfig(),
-        },
-      },
-    },
-  },
-});
+import { httpServiceMock } from '../../../../../core/server/mocks';
 
 describe('csp collector', () => {
-  let kbnServer: ReturnType<typeof createMockKbnServer>;
+  let httpMock: ReturnType<typeof httpServiceMock.createSetupContract>;
   const mockCallCluster = null as any;
 
   function updateCsp(config: Partial<ICspConfig>) {
-    kbnServer.newPlatform.setup.core.http.csp = new CspConfig(config);
+    httpMock.csp = new CspConfig(config);
   }
 
   beforeEach(() => {
-    kbnServer = createMockKbnServer();
+    httpMock = httpServiceMock.createSetupContract();
   });
 
   test('fetches whether strict mode is enabled', async () => {
-    const collector = createCspCollector(kbnServer as any);
+    const collector = createCspCollector(httpMock);
 
     expect((await collector.fetch(mockCallCluster)).strict).toEqual(true);
 
@@ -54,7 +43,7 @@ describe('csp collector', () => {
   });
 
   test('fetches whether the legacy browser warning is enabled', async () => {
-    const collector = createCspCollector(kbnServer as any);
+    const collector = createCspCollector(httpMock);
 
     expect((await collector.fetch(mockCallCluster)).warnLegacyBrowsers).toEqual(true);
 
@@ -63,7 +52,7 @@ describe('csp collector', () => {
   });
 
   test('fetches whether the csp rules have been changed or not', async () => {
-    const collector = createCspCollector(kbnServer as any);
+    const collector = createCspCollector(httpMock);
 
     expect((await collector.fetch(mockCallCluster)).rulesChangedFromDefault).toEqual(false);
 
@@ -72,7 +61,7 @@ describe('csp collector', () => {
   });
 
   test('does not include raw csp rules under any property names', async () => {
-    const collector = createCspCollector(kbnServer as any);
+    const collector = createCspCollector(httpMock);
 
     // It's important that we do not send the value of csp.rules here as it
     // can be customized with values that can be identifiable to given

src/legacy/core_plugins/kibana/server/lib/csp_usage_collector/csp_collector.test.ts renamed to src/plugins/kibana_usage_collection/server/collectors/csp/csp_collector.test.ts

@@ -17,25 +17,21 @@
  * under the License.
  */
 
-import { Server } from 'hapi';
-import { CspConfig } from '../../../../../../core/server';
-import {
-  UsageCollectionSetup,
-  CollectorOptions,
-} from '../../../../../../plugins/usage_collection/server';
+import { UsageCollectionSetup, CollectorOptions } from 'src/plugins/usage_collection/server';
+import { HttpServiceSetup, CspConfig } from '../../../../../core/server';
 
 interface Usage {
   strict: boolean;
   warnLegacyBrowsers: boolean;
   rulesChangedFromDefault: boolean;
 }
 
-export function createCspCollector(server: Server): CollectorOptions<Usage> {
+export function createCspCollector(http: HttpServiceSetup): CollectorOptions<Usage> {
   return {
     type: 'csp',
     isReady: () => true,
     async fetch() {
-      const { strict, warnLegacyBrowsers, header } = server.newPlatform.setup.core.http.csp;
+      const { strict, warnLegacyBrowsers, header } = http.csp;
 
       return {
         strict,
@@ -60,8 +56,11 @@ export function createCspCollector(server: Server): CollectorOptions<Usage> {
   };
 }
 
-export function registerCspCollector(usageCollection: UsageCollectionSetup, server: Server): void {
-  const collectorConfig = createCspCollector(server);
-  const collector = usageCollection.makeUsageCollector<Usage>(collectorConfig);
+export function registerCspCollector(
+  usageCollection: UsageCollectionSetup,
+  http: HttpServiceSetup
+): void {
+  const collectorOptions = createCspCollector(http);
+  const collector = usageCollection.makeUsageCollector<Usage>(collectorOptions);
   usageCollection.registerCollector(collector);
 }

src/legacy/core_plugins/kibana/server/lib/csp_usage_collector/csp_collector.ts renamed to src/plugins/kibana_usage_collection/server/collectors/csp/csp_collector.ts

@@ -22,3 +22,4 @@ export { registerManagementUsageCollector } from './management';
 export { registerApplicationUsageCollector } from './application_usage';
 export { registerKibanaUsageCollector } from './kibana';
 export { registerOpsStatsCollector } from './ops_stats';
+export { registerCspCollector } from './csp';

src/legacy/core_plugins/kibana/server/lib/csp_usage_collector/index.ts renamed to src/plugins/kibana_usage_collection/server/collectors/csp/index.ts

@@ -37,6 +37,7 @@ import {
   registerManagementUsageCollector,
   registerOpsStatsCollector,
   registerUiMetricUsageCollector,
+  registerCspCollector,
 } from './collectors';
 
 interface KibanaUsageCollectionPluginsDepsSetup {
@@ -56,12 +57,9 @@ export class KibanaUsageCollectionPlugin implements Plugin {
     this.metric$ = new Subject<OpsMetrics>();
   }
 
-  public setup(
-    { savedObjects }: CoreSetup,
-    { usageCollection }: KibanaUsageCollectionPluginsDepsSetup
-  ) {
-    this.registerUsageCollectors(usageCollection, this.metric$, (opts) =>
-      savedObjects.registerType(opts)
+  public setup(coreSetup: CoreSetup, { usageCollection }: KibanaUsageCollectionPluginsDepsSetup) {
+    this.registerUsageCollectors(usageCollection, coreSetup, this.metric$, (opts) =>
+      coreSetup.savedObjects.registerType(opts)
     );
   }
 
@@ -79,6 +77,7 @@ export class KibanaUsageCollectionPlugin implements Plugin {
 
   private registerUsageCollectors(
     usageCollection: UsageCollectionSetup,
+    coreSetup: CoreSetup,
     metric$: Subject<OpsMetrics>,
     registerType: SavedObjectsRegisterType
   ) {
@@ -90,5 +89,6 @@ export class KibanaUsageCollectionPlugin implements Plugin {
     registerManagementUsageCollector(usageCollection, getUiSettingsClient);
     registerUiMetricUsageCollector(usageCollection, registerType, getSavedObjectsClient);
     registerApplicationUsageCollector(usageCollection, registerType, getSavedObjectsClient);
+    registerCspCollector(usageCollection, coreSetup.http);
   }
 }

src/plugins/kibana_usage_collection/server/collectors/index.ts

@@ -39,10 +39,6 @@ export default function ({ getService }) {
           expect(body.status.overall.state).to.be('green');
 
           expect(body.status.statuses).to.be.an('array');
-          const kibanaPlugin = body.status.statuses.find((s) => {
-            return s.id.indexOf('plugin:kibana') === 0;
-          });
-          expect(kibanaPlugin.state).to.be('green');
 
           expect(body.metrics.collection_interval_in_millis).to.be.a('number');
 

src/plugins/kibana_usage_collection/server/plugin.ts

@@ -21,7 +21,6 @@ import expect from '@kbn/expect';
 import { FtrProviderContext } from '../../ftr_provider_context';
 
 export default function ({ getService, getPageObjects }: FtrProviderContext) {
-  const retry = getService('retry');
   const testSubjects = getService('testSubjects');
   const PageObjects = getPageObjects(['common']);
 
@@ -32,13 +31,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
       await PageObjects.common.navigateToApp('status_page');
     });
 
-    it('should show the kibana plugin as ready', async () => {
-      await retry.tryForTime(6000, async () => {
-        const text = await testSubjects.getVisibleText('statusBreakdown');
-        expect(text.indexOf('plugin:kibana')).to.be.above(-1);
-      });
-    });
-
     it('should show the build hash and number', async () => {
       const buildNumberText = await testSubjects.getVisibleText('statusBuildNumber');
       expect(buildNumberText).to.contain('BUILD ');