Migrate ui/registry/feature_catalogue to New Platform plugin (elastic…

…#48818)

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

@@ -37,7 +37,7 @@ function getRoute() {
   return {
     template,
     resolve: {
-      directories: () => getServices().getFeatureCatalogueRegistryProvider().then(catalogue => catalogue.inTitleOrder)
+      directories: () => getServices().getFeatureCatalogueEntries()
     },
     controller($scope, $route) {
       const { chrome, addBasePath } = getServices();

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

@@ -27,7 +27,7 @@ import { wrapInI18nContext } from 'ui/i18n';
 // @ts-ignore
 import { uiModules as modules } from 'ui/modules';
 import routes from 'ui/routes';
-import { npStart } from 'ui/new_platform';
+import { npSetup, npStart } from 'ui/new_platform';
 import { IPrivate } from 'ui/private';
 import { FeatureCatalogueRegistryProvider } from 'ui/registry/feature_catalogue';
 import { createUiStatsReporter, METRIC_TYPE } from '../../../ui_metric/public';
@@ -55,10 +55,14 @@ export function getServices() {
     indexPatternService: data.indexPatterns.indexPatterns,
     shouldShowTelemetryOptIn,
     telemetryOptInProvider,
-    getFeatureCatalogueRegistryProvider: async () => {
+    getFeatureCatalogueEntries: async () => {
       const injector = await chrome.dangerouslyGetActiveInjector();
       const Private = injector.get<IPrivate>('Private');
-      return Private(FeatureCatalogueRegistryProvider as any);
+      // Merge legacy registry with new registry
+      (Private(FeatureCatalogueRegistryProvider as any) as any).inTitleOrder.map(
+        npSetup.plugins.feature_catalogue.register
+      );
+      return npStart.plugins.feature_catalogue.get();
     },
 
     trackUiMetric: createUiStatsReporter('Kibana_home'),

src/legacy/ui/public/new_platform/new_platform.ts

@@ -28,11 +28,16 @@ import {
   Start as InspectorStart,
 } from '../../../../plugins/inspector/public';
 import { EuiUtilsStart } from '../../../../plugins/eui_utils/public';
+import {
+  FeatureCatalogueSetup,
+  FeatureCatalogueStart,
+} from '../../../../plugins/feature_catalogue/public';
 
 export interface PluginsSetup {
   data: ReturnType<DataPlugin['setup']>;
   embeddable: EmbeddableSetup;
   expressions: ReturnType<ExpressionsPlugin['setup']>;
+  feature_catalogue: FeatureCatalogueSetup;
   inspector: InspectorSetup;
   uiActions: IUiActionsSetup;
 }
@@ -42,6 +47,7 @@ export interface PluginsStart {
   embeddable: EmbeddableStart;
   eui_utils: EuiUtilsStart;
   expressions: ReturnType<ExpressionsPlugin['start']>;
+  feature_catalogue: FeatureCatalogueStart;
   inspector: InspectorStart;
   uiActions: IUiActionsStart;
 }

src/legacy/ui/public/registry/feature_catalogue.js

@@ -19,6 +19,7 @@
 
 import { uiRegistry } from './_registry';
 import { capabilities } from '../capabilities';
+export { FeatureCatalogueCategory } from '../../../../plugins/feature_catalogue/public';
 
 export const FeatureCatalogueRegistryProvider = uiRegistry({
   name: 'featureCatalogue',
@@ -30,9 +31,3 @@ export const FeatureCatalogueRegistryProvider = uiRegistry({
     return !isDisabledViaCapabilities && Object.keys(featureCatalogItem).length > 0;
   }
 });
-
-export const FeatureCatalogueCategory = {
-  ADMIN: 'admin',
-  DATA: 'data',
-  OTHER: 'other'
-};

src/plugins/feature_catalogue/README.md

@@ -0,0 +1,26 @@
+# Feature catalogue plugin
+
+Replaces the legacy `ui/registry/feature_catalogue` module for registering "features" that should be showed in the home
+page's feature catalogue. This should not be confused with the "feature" plugin for registering features used to derive
+UI capabilities for feature controls.
+
+## Example registration
+
+```ts
+// For legacy plugins
+import { npSetup } from 'ui/new_platform';
+npSetup.plugins.feature_catalogue.register(/* same details here */);
+
+// For new plugins: first add 'feature_catalogue` to the list of `optionalPlugins` 
+// in your kibana.json file. Then access the plugin directly in `setup`:
+
+class MyPlugin {
+  setup(core, plugins) {
+    if (plugins.feature_catalogue) {
+      plugins.feature_catalogue.register(/* same details here. */);
+    }
+  }
+}
+```
+
+Note that the old module supported providing a Angular DI function to receive Angular dependencies. This is no longer supported as we migrate away from Angular and will be removed in 8.0.

src/plugins/feature_catalogue/kibana.json

@@ -0,0 +1,6 @@
+{
+  "id": "feature_catalogue",
+  "version": "kibana",
+  "server": false,
+  "ui": true
+}

src/plugins/feature_catalogue/public/index.ts

@@ -0,0 +1,24 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export { FeatureCatalogueSetup, FeatureCatalogueStart } from './plugin';
+export { FeatureCatalogueEntry, FeatureCatalogueCategory } from './services';
+import { FeatureCataloguePlugin } from './plugin';
+
+export const plugin = () => new FeatureCataloguePlugin();

src/plugins/feature_catalogue/public/plugin.test.mocks.ts

@@ -0,0 +1,25 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { featureCatalogueRegistryMock } from './services/feature_catalogue_registry.mock';
+
+export const registryMock = featureCatalogueRegistryMock.create();
+jest.doMock('./services', () => ({
+  FeatureCatalogueRegistry: jest.fn(() => registryMock),
+}));

src/plugins/feature_catalogue/public/plugin.test.ts

@@ -0,0 +1,49 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { registryMock } from './plugin.test.mocks';
+import { FeatureCataloguePlugin } from './plugin';
+
+describe('FeatureCataloguePlugin', () => {
+  beforeEach(() => {
+    registryMock.setup.mockClear();
+    registryMock.start.mockClear();
+  });
+
+  describe('setup', () => {
+    test('wires up and returns registry', async () => {
+      const setup = await new FeatureCataloguePlugin().setup();
+      expect(registryMock.setup).toHaveBeenCalledWith();
+      expect(setup.register).toBeDefined();
+    });
+  });
+
+  describe('start', () => {
+    test('wires up and returns registry', async () => {
+      const service = new FeatureCataloguePlugin();
+      await service.setup();
+      const core = { application: { capabilities: { catalogue: {} } } } as any;
+      const start = await service.start(core);
+      expect(registryMock.start).toHaveBeenCalledWith({
+        capabilities: core.application.capabilities,
+      });
+      expect(start.get).toBeDefined();
+    });
+  });
+});

src/plugins/feature_catalogue/public/plugin.ts

@@ -0,0 +1,50 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { CoreStart, Plugin } from 'src/core/public';
+import {
+  FeatureCatalogueRegistry,
+  FeatureCatalogueRegistrySetup,
+  FeatureCatalogueRegistryStart,
+} from './services';
+
+export class FeatureCataloguePlugin
+  implements Plugin<FeatureCatalogueSetup, FeatureCatalogueStart> {
+  private readonly featuresCatalogueRegistry = new FeatureCatalogueRegistry();
+
+  public async setup() {
+    return {
+      ...this.featuresCatalogueRegistry.setup(),
+    };
+  }
+
+  public async start(core: CoreStart) {
+    return {
+      ...this.featuresCatalogueRegistry.start({
+        capabilities: core.application.capabilities,
+      }),
+    };
+  }
+}
+
+/** @public */
+export type FeatureCatalogueSetup = FeatureCatalogueRegistrySetup;
+
+/** @public */
+export type FeatureCatalogueStart = FeatureCatalogueRegistryStart;

src/plugins/feature_catalogue/public/services/feature_catalogue_registry.mock.ts

@@ -0,0 +1,54 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import {
+  FeatureCatalogueRegistrySetup,
+  FeatureCatalogueRegistryStart,
+  FeatureCatalogueRegistry,
+} from './feature_catalogue_registry';
+
+const createSetupMock = (): jest.Mocked<FeatureCatalogueRegistrySetup> => {
+  const setup = {
+    register: jest.fn(),
+  };
+  return setup;
+};
+
+const createStartMock = (): jest.Mocked<FeatureCatalogueRegistryStart> => {
+  const start = {
+    get: jest.fn(),
+  };
+  return start;
+};
+
+const createMock = (): jest.Mocked<PublicMethodsOf<FeatureCatalogueRegistry>> => {
+  const service = {
+    setup: jest.fn(),
+    start: jest.fn(),
+  };
+  service.setup.mockImplementation(createSetupMock);
+  service.start.mockImplementation(createStartMock);
+  return service;
+};
+
+export const featureCatalogueRegistryMock = {
+  createSetup: createSetupMock,
+  createStart: createStartMock,
+  create: createMock,
+};