[Monitoring] Improve permissions required around setup mode (#50421) (#50919)

* Add error messages when setup mode is not enabled, disable it for users without the necessary permissions, and change one query to relax the privilege requirements

* Fix default value

* PR feedback

* Forgot to update this part

* Fix tests

Author: chrisronline

x-pack/legacy/plugins/monitoring/public/lib/setup_mode.js

@@ -7,6 +7,7 @@
 import { ajaxErrorHandlersProvider } from './ajax_error_handler';
 import { get, contains } from 'lodash';
 import chrome from 'ui/chrome';
+import { toastNotifications } from 'ui/notify';
 import { i18n } from '@kbn/i18n';
 
 function isOnPage(hash) {
@@ -81,7 +82,26 @@ export const updateSetupModeData = async (uuid, fetchWithoutClusterUuid = false)
   const oldData = setupModeState.data;
   const data = await fetchCollectionData(uuid, fetchWithoutClusterUuid);
   setupModeState.data = data;
-  if (chrome.getInjected('isOnCloud')) {
+
+  const isCloud = chrome.getInjected('isOnCloud');
+  const hasPermissions = get(data, '_meta.hasPermissions', false);
+  if (isCloud || !hasPermissions) {
+    const text = !hasPermissions
+      ? i18n.translate('xpack.monitoring.setupMode.notAvailablePermissions', {
+        defaultMessage: 'You do not have the necessary permissions to do this.'
+      })
+      : i18n.translate('xpack.monitoring.setupMode.notAvailableCloud', {
+        defaultMessage: 'This feature is not available on cloud.'
+      });
+
+    angularState.scope.$evalAsync(() => {
+      toastNotifications.addDanger({
+        title: i18n.translate('xpack.monitoring.setupMode.notAvailableTitle', {
+          defaultMessage: 'Setup mode is not available'
+        }),
+        text,
+      });
+    });
     return toggleSetupMode(false); // eslint-disable-line no-use-before-define
   }
   notifySetupModeDataChange(oldData);

x-pack/legacy/plugins/monitoring/public/lib/setup_mode.test.js

@@ -40,7 +40,8 @@ const angularStateMock = {
     }
   },
   scope: {
-    $apply: fn => fn && fn()
+    $apply: fn => fn && fn(),
+    $evalAsync: fn => fn && fn()
   }
 };
 
@@ -123,19 +124,60 @@ describe('setup_mode', () => {
     });
 
     it('should not fetch data if on cloud', async (done) => {
+      const addDanger = jest.fn();
       jest.doMock('ui/chrome', () => ({
         getInjected: (key) => {
           if (key === 'isOnCloud') {
             return true;
           }
         }
       }));
+      data = {
+        _meta: {
+          hasPermissions: true
+        }
+      };
+      jest.doMock('ui/notify', () => ({
+        toastNotifications: {
+          addDanger,
+        }
+      }));
+      setModules();
+      initSetupModeState(angularStateMock.scope, angularStateMock.injector);
+      await toggleSetupMode(true);
+      waitForSetupModeData(() => {
+        const state = getSetupModeState();
+        expect(state.enabled).toBe(false);
+        expect(addDanger).toHaveBeenCalledWith({
+          title: 'Setup mode is not available',
+          text: 'This feature is not available on cloud.'
+        });
+        done();
+      });
+    });
+
+    it('should not fetch data if the user does not have sufficient permissions', async (done) => {
+      const addDanger = jest.fn();
+      jest.doMock('ui/notify', () => ({
+        toastNotifications: {
+          addDanger,
+        }
+      }));
+      data = {
+        _meta: {
+          hasPermissions: false
+        }
+      };
       setModules();
       initSetupModeState(angularStateMock.scope, angularStateMock.injector);
       await toggleSetupMode(true);
       waitForSetupModeData(() => {
         const state = getSetupModeState();
         expect(state.enabled).toBe(false);
+        expect(addDanger).toHaveBeenCalledWith({
+          title: 'Setup mode is not available',
+          text: 'You do not have the necessary permissions to do this.'
+        });
         done();
       });
     });
@@ -144,7 +186,8 @@ describe('setup_mode', () => {
       const clusterUuid = '1ajy';
       data = {
         _meta: {
-          liveClusterUuid: clusterUuid
+          liveClusterUuid: clusterUuid,
+          hasPermissions: true
         },
         elasticsearch: {
           byUuid: {
@@ -166,7 +209,8 @@ describe('setup_mode', () => {
       const clusterUuid = '1ajy';
       data = {
         _meta: {
-          liveClusterUuid: clusterUuid
+          liveClusterUuid: clusterUuid,
+          hasPermissions: true
         },
         elasticsearch: {
           byUuid: {

x-pack/legacy/plugins/monitoring/server/lib/setup/collection/get_collection_status.js

@@ -145,6 +145,21 @@ const getRecentMonitoringDocuments = async (req, indexPatterns, clusterUuid, nod
   return await callWithRequest(req, 'search', params);
 };
 
+async function doesIndexExist(req, index) {
+  const params = {
+    index,
+    size: 0,
+    terminate_after: 1,
+    ignoreUnavailable: true,
+    filterPath: [
+      'hits.total.value'
+    ],
+  };
+  const { callWithRequest } = req.server.plugins.elasticsearch.getCluster('monitoring');
+  const response = await callWithRequest(req, 'search', params);
+  return get(response, 'hits.total.value', 0) > 0;
+}
+
 async function detectProducts(req, isLiveCluster) {
   const result = {
     [KIBANA_SYSTEM_ID]: {
@@ -188,10 +203,9 @@ async function detectProducts(req, isLiveCluster) {
   ];
 
   if (isLiveCluster) {
-    const { callWithRequest } = req.server.plugins.elasticsearch.getCluster('data');
     for (const { id, indices } of detectionSearch) {
-      const response = await callWithRequest(req, 'cat.indices', { index: indices, format: 'json' });
-      if (response.length) {
+      const exists = await doesIndexExist(req, indices.join(','));
+      if (exists) {
         result[id].mightExist = true;
       }
     }
@@ -223,6 +237,19 @@ function isBeatFromAPM(bucket) {
   return get(beatType, 'buckets[0].key') === 'apm-server';
 }
 
+async function hasNecessaryPermissions(req) {
+  const { callWithRequest } = req.server.plugins.elasticsearch.getCluster('data');
+  const response = await callWithRequest(req, 'transport.request', {
+    method: 'POST',
+    path: '/_security/user/_has_privileges',
+    body: {
+      cluster: ['monitor'],
+    }
+  });
+  // If there is some problem, assume they do not have access
+  return get(response, 'has_all_requested', false);
+}
+
 /**
  * Determines if we should ignore this bucket from this product.
  *
@@ -316,6 +343,14 @@ async function getLiveElasticsearchCollectionEnabled(req) {
 export const getCollectionStatus = async (req, indexPatterns, clusterUuid, nodeUuid, skipLiveData) => {
   const config = req.server.config();
   const kibanaUuid = config.get('server.uuid');
+  const hasPermissions = await hasNecessaryPermissions(req);
+  if (!hasPermissions) {
+    return {
+      _meta: {
+        hasPermissions: false
+      }
+    };
+  }
   const liveClusterUuid = skipLiveData ? null : await getLiveElasticsearchClusterUuid(req);
   const isLiveCluster = !clusterUuid || liveClusterUuid === clusterUuid;
 
@@ -547,6 +582,7 @@ export const getCollectionStatus = async (req, indexPatterns, clusterUuid, nodeU
   status._meta = {
     secondsAgo: NUMBER_OF_SECONDS_AGO_TO_LOOK,
     liveClusterUuid,
+    hasPermissions,
   };
 
   return status;

x-pack/test/api_integration/apis/monitoring/setup/collection/fixtures/detect_apm.json

@@ -51,6 +51,7 @@
   },
   "_meta": {
     "secondsAgo": 30,
-    "liveClusterUuid": null
+    "liveClusterUuid": null,
+    "hasPermissions": true
   }
 }

x-pack/test/api_integration/apis/monitoring/setup/collection/fixtures/detect_beats.json

@@ -60,6 +60,7 @@
   },
   "_meta": {
     "secondsAgo": 30,
-    "liveClusterUuid": null
+    "liveClusterUuid": null,
+    "hasPermissions": true
   }
 }

x-pack/test/api_integration/apis/monitoring/setup/collection/fixtures/detect_beats_management.json

@@ -51,6 +51,7 @@
   },
   "_meta": {
     "secondsAgo": 30,
-    "liveClusterUuid": null
+    "liveClusterUuid": null,
+    "hasPermissions": true
   }
 }

x-pack/test/api_integration/apis/monitoring/setup/collection/fixtures/detect_logstash.json

@@ -51,6 +51,7 @@
   },
   "_meta": {
     "secondsAgo": 30,
-    "liveClusterUuid": null
+    "liveClusterUuid": null,
+    "hasPermissions": true
   }
 }

x-pack/test/api_integration/apis/monitoring/setup/collection/fixtures/detect_logstash_management.json

@@ -51,6 +51,7 @@
   },
   "_meta": {
     "secondsAgo": 30,
-    "liveClusterUuid": null
+    "liveClusterUuid": null,
+    "hasPermissions": true
   }
 }

x-pack/test/api_integration/apis/monitoring/setup/collection/fixtures/es_and_kibana_exclusive_mb.json

@@ -71,6 +71,7 @@
   },
   "_meta": {
     "secondsAgo": 30,
-    "liveClusterUuid": null
+    "liveClusterUuid": null,
+    "hasPermissions": true
   }
 }

x-pack/test/api_integration/apis/monitoring/setup/collection/fixtures/es_and_kibana_mb.json

@@ -71,6 +71,7 @@
   },
   "_meta": {
     "secondsAgo": 30,
-    "liveClusterUuid": null
+    "liveClusterUuid": null,
+    "hasPermissions": true
   }
 }