Cleanup feature registration (#80909)

elastic · Oct 20, 2020 · bf0f8bb · bf0f8bb
1 parent b7ffefb
commit bf0f8bb
Show file tree

Hide file tree

Showing 35 changed files with 19 additions and 178 deletions.
diff --git a/docs/api/features.asciidoc b/docs/api/features.asciidoc
@@ -28,8 +28,6 @@ The API returns the following:
   {
     "id": "discover",
     "name": "Discover",
-    "icon": "discoverApp",
-    "navLinkId": "discover",
     "app": [
       "kibana"
     ],
@@ -73,8 +71,6 @@ The API returns the following:
   {
     "id": "visualize",
     "name": "Visualize",
-    "icon": "visualizeApp",
-    "navLinkId": "visualize",
     "app": [
       "kibana"
     ],
@@ -120,8 +116,6 @@ The API returns the following:
   {
     "id": "dashboard",
     "name": "Dashboard",
-    "icon": "dashboardApp",
-    "navLinkId": "dashboards",
     "app": [
       "kibana"
     ],
@@ -172,8 +166,6 @@ The API returns the following:
   {
     "id": "dev_tools",
     "name": "Dev Tools",
-    "icon": "devToolsApp",
-    "navLinkId": "dev_tools",
     "app": [
       "kibana"
     ],

diff --git a/docs/developer/architecture/security/feature-registration.asciidoc b/docs/developer/architecture/security/feature-registration.asciidoc
@@ -59,15 +59,6 @@ of features within the management screens.
 |See <<example-3-discover,Example 3>>
 |The set of subfeatures that enables finer access control than the `all` and `read` feature privileges. These options are only available in the Gold subscription level and higher.
 
-|`icon`
-|`string`
-|"discoverApp"
-|An https://elastic.github.io/eui/#/display/icons[EUI Icon] to use for this feature.
-
-|`navLinkId`
-|`string`
-|"sample_app"
-|The ID of the navigation link associated with your feature.
 |===
 
 ==== Privilege definition
@@ -100,8 +91,6 @@ public setup(core, { features }) {
   features.registerKibanaFeature({
     id: 'canvas',
     name: 'Canvas',
-    icon: 'canvasApp',
-    navLinkId: 'canvas',
     category: DEFAULT_APP_CATEGORIES.kibana,
     app: ['canvas', 'kibana'],
     catalogue: ['canvas'],
@@ -160,8 +149,6 @@ public setup(core, { features }) {
     name: i18n.translate('xpack.features.devToolsFeatureName', {
       defaultMessage: 'Dev Tools',
     }),
-    icon: 'devToolsApp',
-    navLinkId: 'dev_tools',
     category: DEFAULT_APP_CATEGORIES.management,
     app: ['kibana'],
     catalogue: ['console', 'searchprofiler', 'grokdebugger'],
@@ -223,8 +210,6 @@ public setup(core, { features }) {
         defaultMessage: 'Discover',
       }),
       order: 100,
-      icon: 'discoverApp',
-      navLinkId: 'discover',
       category: DEFAULT_APP_CATEGORIES.kibana,
       app: ['kibana'],
       catalogue: ['discover'],

diff --git a/x-pack/plugins/actions/server/feature.ts b/x-pack/plugins/actions/server/feature.ts
@@ -13,8 +13,6 @@ export const ACTIONS_FEATURE = {
   name: i18n.translate('xpack.actions.featureRegistry.actionsFeatureName', {
     defaultMessage: 'Actions and Connectors',
   }),
-  icon: 'bell',
-  navLinkId: 'actions',
   category: DEFAULT_APP_CATEGORIES.management,
   app: [],
   management: {

diff --git a/x-pack/plugins/apm/server/feature.ts b/x-pack/plugins/apm/server/feature.ts
@@ -20,8 +20,6 @@ export const APM_FEATURE = {
   }),
   order: 900,
   category: DEFAULT_APP_CATEGORIES.observability,
-  icon: 'apmApp',
-  navLinkId: 'apm',
   app: ['apm', 'ux', 'kibana'],
   catalogue: ['apm'],
   management: {

diff --git a/x-pack/plugins/canvas/server/plugin.ts b/x-pack/plugins/canvas/server/plugin.ts
@@ -43,8 +43,6 @@ export class CanvasPlugin implements Plugin {
       name: 'Canvas',
       order: 300,
       category: DEFAULT_APP_CATEGORIES.kibana,
-      icon: 'canvasApp',
-      navLinkId: 'canvas',
       app: ['canvas', 'kibana'],
       catalogue: ['canvas'],
       privileges: {

diff --git a/x-pack/plugins/enterprise_search/server/plugin.ts b/x-pack/plugins/enterprise_search/server/plugin.ts
@@ -85,7 +85,6 @@ export class EnterpriseSearchPlugin implements Plugin {
       name: ENTERPRISE_SEARCH_PLUGIN.NAME,
       order: 0,
       category: DEFAULT_APP_CATEGORIES.enterpriseSearch,
-      icon: 'logoEnterpriseSearch',
       app: [
         'kibana',
         ENTERPRISE_SEARCH_PLUGIN.ID,

diff --git a/x-pack/plugins/features/common/kibana_feature.ts b/x-pack/plugins/features/common/kibana_feature.ts
@@ -6,6 +6,7 @@
 
 import { RecursiveReadonly } from '@kbn/utility-types';
 import { AppCategory } from 'src/core/types';
+import { LicenseType } from '../../licensing/common/types';
 import { FeatureKibanaPrivileges } from './feature_kibana_privileges';
 import { SubFeatureConfig, SubFeature as KibanaSubFeature } from './sub_feature';
 import { ReservedKibanaPrivilege } from './reserved_kibana_privilege';
@@ -52,25 +53,12 @@ export interface KibanaFeatureConfig {
   excludeFromBasePrivileges?: boolean;
 
   /**
-   * Optional array of supported licenses.
+   * Optional minimum supported license.
    * If omitted, all licenses are allowed.
    * This does not restrict access to your feature based on license.
    * Its only purpose is to inform the space and roles UIs on which features to display.
    */
-  validLicenses?: ReadonlyArray<
-    'basic' | 'standard' | 'gold' | 'platinum' | 'enterprise' | 'trial'
-  >;
-
-  /**
-   * An optional EUI Icon to be used when displaying your feature.
-   */
-  icon?: string;
-
-  /**
-   * The optional Nav Link ID for feature.
-   * If specified, your link will be automatically hidden if needed based on the current space and user permissions.
-   */
-  navLinkId?: string;
+  minimumLicense?: LicenseType;
 
   /**
    * An array of app ids that are enabled when this feature is enabled.
@@ -170,10 +158,6 @@ export class KibanaFeature {
     return this.config.category;
   }
 
-  public get navLinkId() {
-    return this.config.navLinkId;
-  }
-
   public get app() {
     return this.config.app;
   }
@@ -186,12 +170,8 @@ export class KibanaFeature {
     return this.config.management;
   }
 
-  public get icon() {
-    return this.config.icon;
-  }
-
-  public get validLicenses() {
-    return this.config.validLicenses;
+  public get minimumLicense() {
+    return this.config.minimumLicense;
   }
 
   public get privileges() {

diff --git a/x-pack/plugins/features/server/__snapshots__/feature_registry.test.ts.snap b/x-pack/plugins/features/server/__snapshots__/feature_registry.test.ts.snap
diff --git a/x-pack/plugins/features/server/feature_registry.test.ts b/x-pack/plugins/features/server/feature_registry.test.ts
@@ -33,11 +33,9 @@ describe('FeatureRegistry', () => {
         id: 'test-feature',
         name: 'Test Feature',
         excludeFromBasePrivileges: true,
-        icon: 'addDataApp',
-        navLinkId: 'someNavLink',
         app: ['app1'],
         category: { id: 'foo', label: 'foo' },
-        validLicenses: ['standard', 'basic', 'gold', 'platinum'],
+        minimumLicense: 'platinum',
         catalogue: ['foo'],
         management: {
           foo: ['bar'],
@@ -421,20 +419,6 @@ describe('FeatureRegistry', () => {
     });
 
     ['contains space', 'contains_invalid()_chars', ''].forEach((prohibitedChars) => {
-      it(`prevents features from being registered with a navLinkId of "${prohibitedChars}"`, () => {
-        const featureRegistry = new FeatureRegistry();
-        expect(() =>
-          featureRegistry.registerKibanaFeature({
-            id: 'foo',
-            name: 'some feature',
-            navLinkId: prohibitedChars,
-            app: [],
-            category: { id: 'foo', label: 'foo' },
-            privileges: null,
-          })
-        ).toThrowErrorMatchingSnapshot();
-      });
-
       it(`prevents features from being registered with a management id of "${prohibitedChars}"`, () => {
         const featureRegistry = new FeatureRegistry();
         expect(() =>

diff --git a/x-pack/plugins/features/server/feature_schema.ts b/x-pack/plugins/features/server/feature_schema.ts
@@ -91,12 +91,14 @@ const kibanaFeatureSchema = Joi.object({
   category: appCategorySchema,
   order: Joi.number(),
   excludeFromBasePrivileges: Joi.boolean(),
-  validLicenses: Joi.array().items(
-    Joi.string().valid('basic', 'standard', 'gold', 'platinum', 'enterprise', 'trial')
+  minimumLicense: Joi.string().valid(
+    'basic',
+    'standard',
+    'gold',
+    'platinum',
+    'enterprise',
+    'trial'
   ),
-  icon: Joi.string(),
-  description: Joi.string(),
-  navLinkId: Joi.string().regex(uiCapabilitiesRegex),
   app: Joi.array().items(Joi.string()).required(),
   management: managementSchema,
   catalogue: catalogueSchema,

diff --git a/x-pack/plugins/features/server/oss_features.ts b/x-pack/plugins/features/server/oss_features.ts
@@ -21,8 +21,6 @@ export const buildOSSFeatures = ({ savedObjectTypes, includeTimelion }: BuildOSS
       }),
       order: 100,
       category: DEFAULT_APP_CATEGORIES.kibana,
-      icon: 'discoverApp',
-      navLinkId: 'discover',
       app: ['discover', 'kibana'],
       catalogue: ['discover'],
       privileges: {
@@ -82,8 +80,6 @@ export const buildOSSFeatures = ({ savedObjectTypes, includeTimelion }: BuildOSS
       }),
       order: 700,
       category: DEFAULT_APP_CATEGORIES.kibana,
-      icon: 'visualizeApp',
-      navLinkId: 'visualize',
       app: ['visualize', 'lens', 'kibana'],
       catalogue: ['visualize'],
       privileges: {
@@ -143,8 +139,6 @@ export const buildOSSFeatures = ({ savedObjectTypes, includeTimelion }: BuildOSS
       }),
       order: 200,
       category: DEFAULT_APP_CATEGORIES.kibana,
-      icon: 'dashboardApp',
-      navLinkId: 'dashboards',
       app: ['dashboards', 'kibana'],
       catalogue: ['dashboard'],
       privileges: {
@@ -222,8 +216,6 @@ export const buildOSSFeatures = ({ savedObjectTypes, includeTimelion }: BuildOSS
       }),
       order: 1300,
       category: DEFAULT_APP_CATEGORIES.management,
-      icon: 'devToolsApp',
-      navLinkId: 'dev_tools',
       app: ['dev_tools', 'kibana'],
       catalogue: ['console', 'searchprofiler', 'grokdebugger'],
       privileges: {
@@ -260,7 +252,6 @@ export const buildOSSFeatures = ({ savedObjectTypes, includeTimelion }: BuildOSS
       }),
       order: 1500,
       category: DEFAULT_APP_CATEGORIES.management,
-      icon: 'advancedSettingsApp',
       app: ['kibana'],
       catalogue: ['advanced_settings'],
       management: {
@@ -300,7 +291,6 @@ export const buildOSSFeatures = ({ savedObjectTypes, includeTimelion }: BuildOSS
       }),
       order: 1600,
       category: DEFAULT_APP_CATEGORIES.management,
-      icon: 'indexPatternApp',
       app: ['kibana'],
       catalogue: ['indexPatterns'],
       management: {
@@ -340,7 +330,6 @@ export const buildOSSFeatures = ({ savedObjectTypes, includeTimelion }: BuildOSS
       }),
       order: 1700,
       category: DEFAULT_APP_CATEGORIES.management,
-      icon: 'savedObjectsApp',
       app: ['kibana'],
       catalogue: ['saved_objects'],
       management: {
@@ -384,8 +373,6 @@ const timelionFeature: KibanaFeatureConfig = {
   name: 'Timelion',
   order: 350,
   category: DEFAULT_APP_CATEGORIES.kibana,
-  icon: 'timelionApp',
-  navLinkId: 'timelion',
   app: ['timelion', 'kibana'],
   catalogue: ['timelion'],
   privileges: {

diff --git a/x-pack/plugins/features/server/routes/index.test.ts b/x-pack/plugins/features/server/routes/index.test.ts
@@ -55,7 +55,7 @@ describe('GET /api/features', () => {
       name: 'Licensed Feature',
       app: ['bar-app'],
       category: { id: 'foo', label: 'foo' },
-      validLicenses: ['gold'],
+      minimumLicense: 'gold',
       privileges: null,
     });
 

diff --git a/x-pack/plugins/features/server/routes/index.ts b/x-pack/plugins/features/server/routes/index.ts
@@ -33,10 +33,9 @@ export function defineRoutes({ router, featureRegistry }: RouteDefinitionParams)
           .filter(
             (feature) =>
               request.query.ignoreValidLicenses ||
-              !feature.validLicenses ||
-              !feature.validLicenses.length ||
-              (context.licensing!.license.type &&
-                feature.validLicenses.includes(context.licensing!.license.type))
+              !feature.minimumLicense ||
+              (context.licensing!.license &&
+                context.licensing!.license.hasAtLeast(feature.minimumLicense))
           )
           .sort(
             (f1, f2) =>

diff --git a/x-pack/plugins/features/server/ui_capabilities_for_features.test.ts b/x-pack/plugins/features/server/ui_capabilities_for_features.test.ts
@@ -92,7 +92,6 @@ describe('populateUICapabilities', () => {
           new KibanaFeature({
             id: 'newFeature',
             name: 'my new feature',
-            navLinkId: 'newFeatureNavLink',
             app: ['bar-app'],
             category: { id: 'foo', label: 'foo' },
             privileges: {
@@ -146,7 +145,6 @@ describe('populateUICapabilities', () => {
           new KibanaFeature({
             id: 'newFeature',
             name: 'my new feature',
-            navLinkId: 'newFeatureNavLink',
             app: ['bar-app'],
             category: { id: 'foo', label: 'foo' },
             catalogue: ['anotherFooEntry', 'anotherBarEntry'],
@@ -216,7 +214,6 @@ describe('populateUICapabilities', () => {
           new KibanaFeature({
             id: 'newFeature',
             name: 'my new feature',
-            navLinkId: 'newFeatureNavLink',
             app: ['bar-app'],
             category: { id: 'foo', label: 'foo' },
             privileges: {
@@ -247,7 +244,6 @@ describe('populateUICapabilities', () => {
           new KibanaFeature({
             id: 'newFeature',
             name: 'my new feature',
-            navLinkId: 'newFeatureNavLink',
             app: ['bar-app'],
             category: { id: 'foo', label: 'foo' },
             privileges: null,
@@ -292,7 +288,6 @@ describe('populateUICapabilities', () => {
           new KibanaFeature({
             id: 'newFeature',
             name: 'my new feature',
-            navLinkId: 'newFeatureNavLink',
             app: ['bar-app'],
             category: { id: 'foo', label: 'foo' },
             privileges: {
@@ -364,7 +359,6 @@ describe('populateUICapabilities', () => {
           new KibanaFeature({
             id: 'newFeature',
             name: 'my new feature',
-            navLinkId: 'newFeatureNavLink',
             app: ['bar-app'],
             category: { id: 'foo', label: 'foo' },
             privileges: {
@@ -385,7 +379,6 @@ describe('populateUICapabilities', () => {
           new KibanaFeature({
             id: 'yetAnotherNewFeature',
             name: 'yet another new feature',
-            navLinkId: 'yetAnotherNavLink',
             app: ['bar-app'],
             category: { id: 'foo', label: 'foo' },
             privileges: {