Consolidate capabilities check for Stack Management (elastic#69437)

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Bamieh · Jul 1, 2020 · 8584dbb · 8584dbb
1 parent a9aa9b0
commit 8584dbb
Show file tree

Hide file tree

Showing 28 changed files with 119 additions and 136 deletions.
diff --git a/src/plugins/advanced_settings/public/plugin.ts b/src/plugins/advanced_settings/public/plugin.ts
@@ -17,8 +17,8 @@
  * under the License.
  */
 import { i18n } from '@kbn/i18n';
-import { CoreSetup, CoreStart, Plugin } from 'kibana/public';
-import { ManagementApp, ManagementSectionId } from '../../management/public';
+import { CoreSetup, Plugin } from 'kibana/public';
+import { ManagementSectionId } from '../../management/public';
 import { ComponentRegistry } from './component_registry';
 import { AdvancedSettingsSetup, AdvancedSettingsStart, AdvancedSettingsPluginSetup } from './types';
 
@@ -30,11 +30,10 @@ const title = i18n.translate('advancedSettings.advancedSettingsLabel', {
 
 export class AdvancedSettingsPlugin
   implements Plugin<AdvancedSettingsSetup, AdvancedSettingsStart, AdvancedSettingsPluginSetup> {
-  private managementApp?: ManagementApp;
   public setup(core: CoreSetup, { management }: AdvancedSettingsPluginSetup) {
     const kibanaSection = management.sections.getSection(ManagementSectionId.Kibana);
 
-    this.managementApp = kibanaSection.registerApp({
+    kibanaSection.registerApp({
       id: 'settings',
       title,
       order: 3,
@@ -51,11 +50,7 @@ export class AdvancedSettingsPlugin
     };
   }
 
-  public start(core: CoreStart) {
-    if (!core.application.capabilities.management.kibana.settings) {
-      this.managementApp!.disable();
-    }
-
+  public start() {
     return {
       component: component.start,
     };

diff --git a/src/plugins/data/public/index_patterns/index_patterns/redirect_no_index_pattern.tsx b/src/plugins/data/public/index_patterns/index_patterns/redirect_no_index_pattern.tsx
@@ -30,7 +30,7 @@ export const onRedirectNoIndexPattern = (
   navigateToApp: CoreStart['application']['navigateToApp'],
   overlays: CoreStart['overlays']
 ) => () => {
-  const canManageIndexPatterns = capabilities.management.kibana.index_patterns;
+  const canManageIndexPatterns = capabilities.management.kibana.indexPatterns;
   const redirectTarget = canManageIndexPatterns ? '/management/kibana/indexPatterns' : '/home';
   let timeoutId: NodeJS.Timeout | undefined;
 

diff --git a/src/plugins/data/server/saved_objects/index_patterns.ts b/src/plugins/data/server/saved_objects/index_patterns.ts
@@ -37,7 +37,7 @@ export const indexPatternSavedObjectType: SavedObjectsType = {
     getInAppUrl(obj) {
       return {
         path: `/app/management/kibana/indexPatterns/patterns/${encodeURIComponent(obj.id)}`,
-        uiCapabilitiesPath: 'management.kibana.index_patterns',
+        uiCapabilitiesPath: 'management.kibana.indexPatterns',
       };
     },
   },

diff --git a/src/plugins/home/server/capabilities_provider.ts b/src/plugins/home/server/capabilities_provider.ts
@@ -24,6 +24,6 @@ export const capabilitiesProvider = () => ({
     visualize: true,
     console: true,
     advanced_settings: true,
-    index_patterns: true,
+    indexPatterns: true,
   },
 });
diff --git a/src/plugins/index_pattern_management/public/plugin.ts b/src/plugins/index_pattern_management/public/plugin.ts
@@ -27,7 +27,7 @@ import {
   IndexPatternManagementServiceStart,
 } from './service';
 
-import { ManagementSetup, ManagementApp, ManagementSectionId } from '../../management/public';
+import { ManagementSetup, ManagementSectionId } from '../../management/public';
 
 export interface IndexPatternManagementSetupDependencies {
   management: ManagementSetup;
@@ -57,7 +57,6 @@ export class IndexPatternManagementPlugin
       IndexPatternManagementStartDependencies
     > {
   private readonly indexPatternManagementService = new IndexPatternManagementService();
-  private managementApp?: ManagementApp;
 
   constructor(initializerContext: PluginInitializerContext) {}
 
@@ -80,7 +79,7 @@ export class IndexPatternManagementPlugin
       return pathInApp && `/patterns${pathInApp}`;
     });
 
-    this.managementApp = kibanaSection.registerApp({
+    kibanaSection.registerApp({
       id: IPM_APP_ID,
       title: sectionsHeader,
       order: 0,
@@ -95,10 +94,6 @@ export class IndexPatternManagementPlugin
   }
 
   public start(core: CoreStart, plugins: IndexPatternManagementStartDependencies) {
-    if (!core.application.capabilities.management.kibana.index_patterns) {
-      this.managementApp!.disable();
-    }
-
     return this.indexPatternManagementService.start();
   }
 

diff --git a/src/plugins/management/public/management_sections_service.test.ts b/src/plugins/management/public/management_sections_service.test.ts
@@ -27,9 +27,15 @@ describe('ManagementService', () => {
     managementService = new ManagementSectionsService();
   });
 
+  const capabilities = {
+    navLinks: {},
+    catalogue: {},
+    management: {},
+  };
+
   test('Provides default sections', () => {
     managementService.setup();
-    const start = managementService.start();
+    const start = managementService.start({ capabilities });
 
     expect(start.getAllSections().length).toEqual(6);
     expect(start.getSection(ManagementSectionId.Ingest)).toBeDefined();
@@ -48,12 +54,46 @@ describe('ManagementService', () => {
     expect(setup.getSection('test-section')).not.toBeUndefined();
 
     // Start phase:
-    const start = managementService.start();
+    const start = managementService.start({ capabilities });
 
     expect(start.getSectionsEnabled().length).toEqual(7);
 
     testSection.disable();
 
     expect(start.getSectionsEnabled().length).toEqual(6);
   });
+
+  test('Disables items that are not allowed by Capabilities', () => {
+    // Setup phase:
+    const setup = managementService.setup();
+    const testSection = setup.register({ id: 'test-section', title: 'Test Section' });
+    testSection.registerApp({ id: 'test-app-1', title: 'Test App 1', mount: jest.fn() });
+    testSection.registerApp({ id: 'test-app-2', title: 'Test App 2', mount: jest.fn() });
+    testSection.registerApp({ id: 'test-app-3', title: 'Test App 3', mount: jest.fn() });
+
+    expect(setup.getSection('test-section')).not.toBeUndefined();
+
+    // Start phase:
+    managementService.start({
+      capabilities: {
+        navLinks: {},
+        catalogue: {},
+        management: {
+          ['test-section']: {
+            'test-app-1': true,
+            'test-app-2': false,
+            // test-app-3 intentionally left undefined. Should be enabled by default
+          },
+        },
+      },
+    });
+
+    expect(testSection.apps).toHaveLength(3);
+    expect(testSection.getAppsEnabled().map((app) => app.id)).toMatchInlineSnapshot(`
+      Array [
+        "test-app-1",
+        "test-app-3",
+      ]
+    `);
+  });
 });
diff --git a/src/plugins/management/public/management_sections_service.ts b/src/plugins/management/public/management_sections_service.ts
@@ -21,7 +21,12 @@ import { ReactElement } from 'react';
 import { ManagementSection, RegisterManagementSectionArgs } from './utils';
 import { managementSections } from './components/management_sections';
 
-import { ManagementSectionId, SectionsServiceSetup, SectionsServiceStart } from './types';
+import {
+  ManagementSectionId,
+  SectionsServiceSetup,
+  SectionsServiceStart,
+  SectionsServiceStartDeps,
+} from './types';
 
 export class ManagementSectionsService {
   private sections: Map<ManagementSectionId | string, ManagementSection> = new Map();
@@ -55,7 +60,18 @@ export class ManagementSectionsService {
     };
   }
 
-  start(): SectionsServiceStart {
+  start({ capabilities }: SectionsServiceStartDeps): SectionsServiceStart {
+    this.getAllSections().forEach((section) => {
+      if (capabilities.management.hasOwnProperty(section.id)) {
+        const sectionCapabilities = capabilities.management[section.id];
+        section.apps.forEach((app) => {
+          if (sectionCapabilities.hasOwnProperty(app.id) && sectionCapabilities[app.id] !== true) {
+            app.disable();
+          }
+        });
+      }
+    });
+
     return {
       getSection: this.getSection,
       getAllSections: this.getAllSections,

diff --git a/src/plugins/management/public/plugin.ts b/src/plugins/management/public/plugin.ts
@@ -82,7 +82,7 @@ export class ManagementPlugin implements Plugin<ManagementSetup, ManagementStart
 
   public start(core: CoreStart) {
     return {
-      sections: this.managementSections.start(),
+      sections: this.managementSections.start({ capabilities: core.application.capabilities }),
     };
   }
 }
diff --git a/src/plugins/management/public/types.ts b/src/plugins/management/public/types.ts
@@ -18,7 +18,7 @@
  */
 
 import { ReactElement } from 'react';
-import { ScopedHistory } from 'kibana/public';
+import { ScopedHistory, Capabilities } from 'kibana/public';
 import { ManagementSection, RegisterManagementSectionArgs } from './utils';
 import { ChromeBreadcrumb } from '../../../core/public/';
 
@@ -30,8 +30,12 @@ export interface ManagementStart {
   sections: SectionsServiceStart;
 }
 
+export interface SectionsServiceStartDeps {
+  capabilities: Capabilities;
+}
+
 export interface SectionsServiceSetup {
-  register: (args: RegisterManagementSectionArgs) => ManagementSection;
+  register: (args: Omit<RegisterManagementSectionArgs, 'capabilities'>) => ManagementSection;
   getSection: (sectionId: ManagementSectionId | string) => ManagementSection;
 }
 

diff --git a/src/plugins/management/server/capabilities_provider.ts b/src/plugins/management/server/capabilities_provider.ts
@@ -25,7 +25,7 @@ export const capabilitiesProvider = () => ({
      */
     kibana: {
       settings: true,
-      index_patterns: true,
+      indexPatterns: true,
       objects: true,
     },
   },

diff --git a/src/plugins/saved_objects_management/public/lib/in_app_url.test.ts b/src/plugins/saved_objects_management/public/lib/in_app_url.test.ts
@@ -70,7 +70,7 @@ describe('canViewInApp', () => {
     let uiCapabilities = createCapabilities({
       management: {
         kibana: {
-          index_patterns: true,
+          indexPatterns: true,
         },
       },
     });
@@ -81,7 +81,7 @@ describe('canViewInApp', () => {
     uiCapabilities = createCapabilities({
       management: {
         kibana: {
-          index_patterns: false,
+          indexPatterns: false,
         },
       },
     });

diff --git a/src/plugins/saved_objects_management/public/lib/in_app_url.ts b/src/plugins/saved_objects_management/public/lib/in_app_url.ts
@@ -30,7 +30,7 @@ export function canViewInApp(uiCapabilities: Capabilities, type: string): boolea
     case 'index-pattern':
     case 'index-patterns':
     case 'indexPatterns':
-      return uiCapabilities.management.kibana.index_patterns as boolean;
+      return uiCapabilities.management.kibana.indexPatterns as boolean;
     case 'dashboard':
     case 'dashboards':
       return uiCapabilities.dashboard.show as boolean;

diff --git a/...t/public/management_section/objects_table/__snapshots__/saved_objects_table.test.tsx.snap b/...t/public/management_section/objects_table/__snapshots__/saved_objects_table.test.tsx.snap
diff --git a/...lic/management_section/objects_table/components/__snapshots__/relationships.test.tsx.snap b/...lic/management_section/objects_table/components/__snapshots__/relationships.test.tsx.snap
diff --git a/...ment/public/management_section/objects_table/components/__snapshots__/table.test.tsx.snap b/...ment/public/management_section/objects_table/components/__snapshots__/table.test.tsx.snap
diff --git a/...ects_management/public/management_section/objects_table/components/relationships.test.tsx b/...ects_management/public/management_section/objects_table/components/relationships.test.tsx
@@ -77,7 +77,7 @@ describe('Relationships', () => {
           editUrl: '#/management/kibana/indexPatterns/patterns/1',
           inAppUrl: {
             path: '/management/kibana/indexPatterns/patterns/1',
-            uiCapabilitiesPath: 'management.kibana.index_patterns',
+            uiCapabilitiesPath: 'management.kibana.indexPatterns',
           },
         },
       },
@@ -113,7 +113,7 @@ describe('Relationships', () => {
             icon: 'indexPatternApp',
             inAppUrl: {
               path: '/app/management/kibana/indexPatterns/patterns/1',
-              uiCapabilitiesPath: 'management.kibana.index_patterns',
+              uiCapabilitiesPath: 'management.kibana.indexPatterns',
             },
             title: 'My Index Pattern',
           },

diff --git a/...aved_objects_management/public/management_section/objects_table/components/table.test.tsx b/...aved_objects_management/public/management_section/objects_table/components/table.test.tsx
@@ -41,7 +41,7 @@ const defaultProps: TableProps = {
         editUrl: '#/management/kibana/indexPatterns/patterns/1',
         inAppUrl: {
           path: '/management/kibana/indexPatterns/patterns/1',
-          uiCapabilitiesPath: 'management.kibana.index_patterns',
+          uiCapabilitiesPath: 'management.kibana.indexPatterns',
         },
       },
     },
@@ -68,7 +68,7 @@ const defaultProps: TableProps = {
         editUrl: '#/management/kibana/indexPatterns/patterns/1',
         inAppUrl: {
           path: '/management/kibana/indexPatterns/patterns/1',
-          uiCapabilitiesPath: 'management.kibana.index_patterns',
+          uiCapabilitiesPath: 'management.kibana.indexPatterns',
         },
       },
     },

diff --git a/...d_objects_management/public/management_section/objects_table/saved_objects_table.test.tsx b/...d_objects_management/public/management_section/objects_table/saved_objects_table.test.tsx
@@ -158,7 +158,7 @@ describe('SavedObjectsTable', () => {
             editUrl: '#/management/kibana/indexPatterns/patterns/1',
             inAppUrl: {
               path: '/management/kibana/indexPatterns/patterns/1',
-              uiCapabilitiesPath: 'management.kibana.index_patterns',
+              uiCapabilitiesPath: 'management.kibana.indexPatterns',
             },
           },
         },

diff --git a/test/api_integration/apis/saved_objects_management/find.ts b/test/api_integration/apis/saved_objects_management/find.ts
@@ -287,7 +287,7 @@ export default function ({ getService }: FtrProviderContext) {
               inAppUrl: {
                 path:
                   '/app/management/kibana/indexPatterns/patterns/8963ca30-3224-11e8-a572-ffca06da1357',
-                uiCapabilitiesPath: 'management.kibana.index_patterns',
+                uiCapabilitiesPath: 'management.kibana.indexPatterns',
               },
             });
           }));

diff --git a/test/api_integration/apis/saved_objects_management/relationships.ts b/test/api_integration/apis/saved_objects_management/relationships.ts
@@ -87,7 +87,7 @@ export default function ({ getService }: FtrProviderContext) {
               inAppUrl: {
                 path:
                   '/app/management/kibana/indexPatterns/patterns/8963ca30-3224-11e8-a572-ffca06da1357',
-                uiCapabilitiesPath: 'management.kibana.index_patterns',
+                uiCapabilitiesPath: 'management.kibana.indexPatterns',
               },
             },
           },
@@ -128,7 +128,7 @@ export default function ({ getService }: FtrProviderContext) {
               inAppUrl: {
                 path:
                   '/app/management/kibana/indexPatterns/patterns/8963ca30-3224-11e8-a572-ffca06da1357',
-                uiCapabilitiesPath: 'management.kibana.index_patterns',
+                uiCapabilitiesPath: 'management.kibana.indexPatterns',
               },
             },
             relationship: 'child',