[Alerting] Control Alerts Management via feature controls & privileges (

#72029) This PR removes the alerting and actions ui privileges (alerting:show, actions:show, etc...) and instead relies on the standard Kibana feature control model to decide whether management displays the Alerts Management section under management.
elastic · Jul 28, 2020 · f410474 · f410474
1 parent dca4a23
commit f410474
Show file tree

Hide file tree

Showing 16 changed files with 157 additions and 139 deletions.
diff --git a/examples/alerting_example/server/plugin.ts b/examples/alerting_example/server/plugin.ts
@@ -44,6 +44,9 @@ export class AlertingExamplePlugin implements Plugin<void, void, AlertingExample
         defaultMessage: 'Alerts Example',
       }),
       app: [],
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
       alerting: [alwaysFiringAlert.id, peopleInSpaceAlert.id, INDEX_THRESHOLD_ID],
       privileges: {
         all: {
@@ -54,7 +57,10 @@ export class AlertingExamplePlugin implements Plugin<void, void, AlertingExample
             all: [],
             read: [],
           },
-          ui: ['alerting:show'],
+          management: {
+            insightsAndAlerting: ['triggersActions'],
+          },
+          ui: [],
         },
         read: {
           alerting: {
@@ -64,7 +70,10 @@ export class AlertingExamplePlugin implements Plugin<void, void, AlertingExample
             all: [],
             read: [],
           },
-          ui: ['alerting:show'],
+          management: {
+            insightsAndAlerting: ['triggersActions'],
+          },
+          ui: [],
         },
       },
     });

diff --git a/x-pack/plugins/actions/server/feature.ts b/x-pack/plugins/actions/server/feature.ts
@@ -15,11 +15,17 @@ export const ACTIONS_FEATURE = {
   icon: 'bell',
   navLinkId: 'actions',
   app: [],
+  management: {
+    insightsAndAlerting: ['triggersActions'],
+  },
   privileges: {
     all: {
       app: [],
       api: [],
       catalogue: [],
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
       savedObject: {
         all: [ACTION_SAVED_OBJECT_TYPE, ACTION_TASK_PARAMS_SAVED_OBJECT_TYPE],
         read: [],
@@ -30,6 +36,9 @@ export const ACTIONS_FEATURE = {
       app: [],
       api: [],
       catalogue: [],
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
       savedObject: {
         // action execution requires 'read' over `actions`, but 'all' over `action_task_params`
         all: [ACTION_TASK_PARAMS_SAVED_OBJECT_TYPE],

diff --git a/x-pack/plugins/alerting_builtins/server/feature.ts b/x-pack/plugins/alerting_builtins/server/feature.ts
@@ -15,11 +15,17 @@ export const BUILT_IN_ALERTS_FEATURE = {
   }),
   icon: 'bell',
   app: [],
+  management: {
+    insightsAndAlerting: ['triggersActions'],
+  },
   alerting: [IndexThreshold],
   privileges: {
     all: {
       app: [],
       catalogue: [],
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
       alerting: {
         all: [IndexThreshold],
         read: [],
@@ -29,11 +35,14 @@ export const BUILT_IN_ALERTS_FEATURE = {
         read: [],
       },
       api: [],
-      ui: ['alerting:show'],
+      ui: [],
     },
     read: {
       app: [],
       catalogue: [],
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
       alerting: {
         all: [],
         read: [IndexThreshold],
@@ -43,7 +52,7 @@ export const BUILT_IN_ALERTS_FEATURE = {
         read: [],
       },
       api: [],
-      ui: ['alerting:show'],
+      ui: [],
     },
   },
 };
diff --git a/x-pack/plugins/alerts/server/plugin.ts b/x-pack/plugins/alerts/server/plugin.ts
@@ -129,6 +129,16 @@ export class AlertingPlugin {
     this.spaces = plugins.spaces?.spacesService;
     this.security = plugins.security;
 
+    core.capabilities.registerProvider(() => {
+      return {
+        management: {
+          insightsAndAlerting: {
+            triggersActions: true,
+          },
+        },
+      };
+    });
+
     this.isESOUsingEphemeralEncryptionKey =
       plugins.encryptedSavedObjects.usingEphemeralEncryptionKey;
 

diff --git a/x-pack/plugins/apm/server/feature.ts b/x-pack/plugins/apm/server/feature.ts
@@ -17,6 +17,9 @@ export const APM_FEATURE = {
   navLinkId: 'apm',
   app: ['apm', 'kibana'],
   catalogue: ['apm'],
+  management: {
+    insightsAndAlerting: ['triggersActions'],
+  },
   alerting: Object.values(AlertType),
   // see x-pack/plugins/features/common/feature_kibana_privileges.ts
   privileges: {
@@ -31,6 +34,9 @@ export const APM_FEATURE = {
       alerting: {
         all: Object.values(AlertType),
       },
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
       ui: ['show', 'save', 'alerting:show', 'alerting:save'],
     },
     read: {
@@ -44,6 +50,9 @@ export const APM_FEATURE = {
       alerting: {
         all: Object.values(AlertType),
       },
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
       ui: ['show', 'alerting:show', 'alerting:save'],
     },
   },

diff --git a/x-pack/plugins/infra/server/features.ts b/x-pack/plugins/infra/server/features.ts
@@ -19,6 +19,9 @@ export const METRICS_FEATURE = {
   navLinkId: 'metrics',
   app: ['infra', 'metrics', 'kibana'],
   catalogue: ['infraops'],
+  management: {
+    insightsAndAlerting: ['triggersActions'],
+  },
   alerting: [METRIC_THRESHOLD_ALERT_TYPE_ID, METRIC_INVENTORY_THRESHOLD_ALERT_TYPE_ID],
   privileges: {
     all: {
@@ -32,7 +35,10 @@ export const METRICS_FEATURE = {
       alerting: {
         all: [METRIC_THRESHOLD_ALERT_TYPE_ID, METRIC_INVENTORY_THRESHOLD_ALERT_TYPE_ID],
       },
-      ui: ['show', 'configureSource', 'save', 'alerting:show'],
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
+      ui: ['show', 'configureSource', 'save'],
     },
     read: {
       app: ['infra', 'metrics', 'kibana'],
@@ -45,7 +51,10 @@ export const METRICS_FEATURE = {
       alerting: {
         all: [METRIC_THRESHOLD_ALERT_TYPE_ID, METRIC_INVENTORY_THRESHOLD_ALERT_TYPE_ID],
       },
-      ui: ['show', 'alerting:show'],
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
+      ui: ['show'],
     },
   },
 };

diff --git a/x-pack/plugins/security_solution/server/plugin.ts b/x-pack/plugins/security_solution/server/plugin.ts
@@ -174,6 +174,9 @@ export class Plugin implements IPlugin<PluginSetup, PluginStart, SetupPlugins, S
       navLinkId: APP_ID,
       app: [...securitySubPlugins, 'kibana'],
       catalogue: ['securitySolution'],
+      management: {
+        insightsAndAlerting: ['triggersActions'],
+      },
       alerting: [SIGNALS_ID, NOTIFICATIONS_ID],
       privileges: {
         all: {
@@ -194,7 +197,10 @@ export class Plugin implements IPlugin<PluginSetup, PluginStart, SetupPlugins, S
           alerting: {
             all: [SIGNALS_ID, NOTIFICATIONS_ID],
           },
-          ui: ['show', 'crud', 'alerting:show'],
+          management: {
+            insightsAndAlerting: ['triggersActions'],
+          },
+          ui: ['show', 'crud'],
         },
         read: {
           app: [...securitySubPlugins, 'kibana'],
@@ -214,7 +220,10 @@ export class Plugin implements IPlugin<PluginSetup, PluginStart, SetupPlugins, S
           alerting: {
             all: [SIGNALS_ID, NOTIFICATIONS_ID],
           },
-          ui: ['show', 'alerting:show'],
+          management: {
+            insightsAndAlerting: ['triggersActions'],
+          },
+          ui: ['show'],
         },
       },
     });

diff --git a/x-pack/plugins/triggers_actions_ui/public/application/app.tsx b/x-pack/plugins/triggers_actions_ui/public/application/app.tsx
@@ -17,8 +17,7 @@ import {
   ScopedHistory,
 } from 'kibana/public';
 import { Section, routeToAlertDetails } from './constants';
-import { AppContextProvider, useAppDependencies } from './app_context';
-import { hasShowAlertsCapability } from './lib/capabilities';
+import { AppContextProvider } from './app_context';
 import { ActionTypeModel, AlertTypeModel } from '../types';
 import { TypeRegistry } from './type_registry';
 import { ChartsPluginStart } from '../../../../../src/plugins/charts/public';
@@ -63,22 +62,17 @@ export const App = (appDeps: AppDeps) => {
 };
 
 export const AppWithoutRouter = ({ sectionsRegex }: { sectionsRegex: string }) => {
-  const { capabilities } = useAppDependencies();
-  const canShowAlerts = hasShowAlertsCapability(capabilities);
-  const DEFAULT_SECTION: Section = canShowAlerts ? 'alerts' : 'connectors';
   return (
     <Switch>
       <Route
         path={`/:section(${sectionsRegex})`}
         component={suspendedComponentWithProps(TriggersActionsUIHome, 'xl')}
       />
-      {canShowAlerts && (
-        <Route
-          path={routeToAlertDetails}
-          component={suspendedComponentWithProps(AlertDetailsRoute, 'xl')}
-        />
-      )}
-      <Redirect from={'/'} to={`${DEFAULT_SECTION}`} />
+      <Route
+        path={routeToAlertDetails}
+        component={suspendedComponentWithProps(AlertDetailsRoute, 'xl')}
+      />
+      <Redirect from={'/'} to="alerts" />
     </Switch>
   );
 };
diff --git a/x-pack/plugins/triggers_actions_ui/public/application/home.tsx b/x-pack/plugins/triggers_actions_ui/public/application/home.tsx
@@ -25,7 +25,7 @@ import { Section, routeToConnectors, routeToAlerts } from './constants';
 import { getCurrentBreadcrumb } from './lib/breadcrumb';
 import { getCurrentDocTitle } from './lib/doc_title';
 import { useAppDependencies } from './app_context';
-import { hasShowActionsCapability, hasShowAlertsCapability } from './lib/capabilities';
+import { hasShowActionsCapability } from './lib/capabilities';
 
 import { ActionsConnectorsList } from './sections/actions_connectors_list/components/actions_connectors_list';
 import { AlertsList } from './sections/alerts_list/components/alerts_list';
@@ -45,23 +45,17 @@ export const TriggersActionsUIHome: React.FunctionComponent<RouteComponentProps<
   const { chrome, capabilities, setBreadcrumbs, docLinks, http } = useAppDependencies();
 
   const canShowActions = hasShowActionsCapability(capabilities);
-  const canShowAlerts = hasShowAlertsCapability(capabilities);
   const tabs: Array<{
     id: Section;
     name: React.ReactNode;
   }> = [];
 
-  if (canShowAlerts) {
-    tabs.push({
-      id: 'alerts',
-      name: (
-        <FormattedMessage
-          id="xpack.triggersActionsUI.home.alertsTabTitle"
-          defaultMessage="Alerts"
-        />
-      ),
-    });
-  }
+  tabs.push({
+    id: 'alerts',
+    name: (
+      <FormattedMessage id="xpack.triggersActionsUI.home.alertsTabTitle" defaultMessage="Alerts" />
+    ),
+  });
 
   if (canShowActions) {
     tabs.push({
@@ -151,17 +145,15 @@ export const TriggersActionsUIHome: React.FunctionComponent<RouteComponentProps<
               )}
             />
           )}
-          {canShowAlerts && (
-            <Route
-              exact
-              path={routeToAlerts}
-              component={() => (
-                <HealthCheck docLinks={docLinks} http={http}>
-                  <AlertsList />
-                </HealthCheck>
-              )}
-            />
-          )}
+          <Route
+            exact
+            path={routeToAlerts}
+            component={() => (
+              <HealthCheck docLinks={docLinks} http={http}>
+                <AlertsList />
+              </HealthCheck>
+            )}
+          />
         </Switch>
       </EuiPageContent>
     </EuiPageBody>

diff --git a/x-pack/plugins/triggers_actions_ui/public/application/lib/capabilities.ts b/x-pack/plugins/triggers_actions_ui/public/application/lib/capabilities.ts
@@ -4,7 +4,6 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { BUILT_IN_ALERTS_FEATURE_ID } from '../../../../alerting_builtins/common';
 import { Alert, AlertType } from '../../types';
 
 /**
@@ -15,18 +14,6 @@ import { Alert, AlertType } from '../../types';
 
 type Capabilities = Record<string, any>;
 
-const apps = ['apm', 'siem', 'uptime', 'infrastructure', 'actions', BUILT_IN_ALERTS_FEATURE_ID];
-
-function hasCapability(capabilities: Capabilities, capability: string) {
-  return apps.some((app) => capabilities[app]?.[capability]);
-}
-
-function createCapabilityCheck(capability: string) {
-  return (capabilities: Capabilities) => hasCapability(capabilities, capability);
-}
-
-export const hasShowAlertsCapability = createCapabilityCheck('alerting:show');
-
 export const hasShowActionsCapability = (capabilities: Capabilities) => capabilities?.actions?.show;
 export const hasSaveActionsCapability = (capabilities: Capabilities) => capabilities?.actions?.save;
 export const hasExecuteActionsCapability = (capabilities: Capabilities) =>

diff --git a/...rs_actions_ui/public/application/sections/alert_details/components/alert_details.test.tsx b/...rs_actions_ui/public/application/sections/alert_details/components/alert_details.test.tsx
@@ -29,9 +29,6 @@ jest.mock('../../../app_context', () => ({
     http: jest.fn(),
     capabilities: {
       get: jest.fn(() => ({})),
-      securitySolution: {
-        'alerting:show': true,
-      },
     },
     actionTypeRegistry: jest.fn(),
     alertTypeRegistry: {