Clean up permissions, security, and stats logic.

cjcenizal · cjcenizal · commit 1daf9ad5a302 · 2020-04-18T23:09:44.000-07:00
- Remove security dependency.
- Render timestamp for autofollow errors.
- Fix license check so that CCR won't render if the license is invalid.
- Fix server security check to be more precise by checking if ES has security disabled.
diff --git a/x-pack/plugins/cross_cluster_replication/common/constants/index.ts b/x-pack/plugins/cross_cluster_replication/common/constants/index.ts
@@ -11,7 +11,7 @@ import { LicenseType } from '../../../licensing/common/types';
 const platinumLicense: LicenseType = 'platinum';
 
 export const PLUGIN = {
-  ID: 'cross_cluster_replication',
+  ID: 'crossClusterReplication',
   TITLE: i18n.translate('xpack.crossClusterReplication.appTitle', {
     defaultMessage: 'Cross-Cluster Replication',
   }),
@@ -23,7 +23,8 @@ export const APPS = {
   REMOTE_CLUSTER_APP: 'remote_cluster',
 };
 
-export const BASE_PATH = '/management/elasticsearch/cross_cluster_replication';
+export const MANAGEMENT_ID = 'cross_cluster_replication';
+export const BASE_PATH = `/management/elasticsearch/${MANAGEMENT_ID}`;
 export const BASE_PATH_REMOTE_CLUSTERS = '/management/elasticsearch/remote_clusters';
 export const API_BASE_PATH = '/api/cross_cluster_replication';
 export const API_REMOTE_CLUSTERS_BASE_PATH = '/api/remote_clusters';
diff --git a/x-pack/plugins/cross_cluster_replication/common/types.ts b/x-pack/plugins/cross_cluster_replication/common/types.ts
@@ -140,6 +140,7 @@ export interface FollowerIndexAdvancedSettingsToEs {
 }
 
 export interface RecentAutoFollowError {
+  timestamp: number;
   leaderIndex: string;
   autoFollowException: {
     type: string;
@@ -148,6 +149,7 @@ export interface RecentAutoFollowError {
 }
 
 export interface RecentAutoFollowErrorFromEs {
+  timestamp: number;
   leader_index: string;
   auto_follow_exception: {
     type: string;
diff --git a/x-pack/plugins/cross_cluster_replication/kibana.json b/x-pack/plugins/cross_cluster_replication/kibana.json
@@ -11,8 +11,7 @@
     "indexManagement"
   ],
   "optionalPlugins": [
-    "usageCollection",
-    "security"
+    "usageCollection"
   ],
   "configPath": ["xpack", "ccr"]
 }
diff --git a/x-pack/plugins/cross_cluster_replication/public/__jest__/client_integration/auto_follow_pattern_list.test.js b/x-pack/plugins/cross_cluster_replication/public/__jest__/client_integration/auto_follow_pattern_list.test.js
@@ -302,10 +302,12 @@ describe('<AutoFollowPatternList />', () => {
         const message = 'bar';
         const recentAutoFollowErrors = [
           {
+            timestamp: 1587081600021,
             leaderIndex: `${autoFollowPattern1.name}:my-leader-test`,
             autoFollowException: { type: 'exception', reason: message },
           },
           {
+            timestamp: 1587081600021,
             leaderIndex: `${autoFollowPattern2.name}:my-leader-test`,
             autoFollowException: { type: 'exception', reason: message },
           },
@@ -324,7 +326,7 @@ describe('<AutoFollowPatternList />', () => {
         expect(exists('autoFollowPatternDetail.errors')).toBe(true);
         expect(exists('autoFollowPatternDetail.titleErrors')).toBe(true);
         expect(find('autoFollowPatternDetail.recentError').map(error => error.text())).toEqual([
-          message,
+          'April 16th, 2020 8:00:00 PM: bar',
         ]);
       });
     });
diff --git a/x-pack/plugins/cross_cluster_replication/public/app/index.tsx b/x-pack/plugins/cross_cluster_replication/public/app/index.tsx
@@ -42,7 +42,7 @@ export async function mountApp({
   I18nContext: I18nStart['Context'];
   ELASTIC_WEBSITE_URL: string;
   DOC_LINK_VERSION: string;
-}): UnmountCallback {
+}): Promise<UnmountCallback> {
   // Initialize additional services.
   initBreadcrumbs(setBreadcrumbs);
   initDocumentation(`${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/`);
diff --git a/x-pack/plugins/cross_cluster_replication/public/app/sections/home/auto_follow_pattern_list/components/detail_panel/detail_panel.js b/x-pack/plugins/cross_cluster_replication/public/app/sections/home/auto_follow_pattern_list/components/detail_panel/detail_panel.js
@@ -7,6 +7,8 @@
 import React, { Component } from 'react';
 import PropTypes from 'prop-types';
 import { FormattedMessage } from '@kbn/i18n/react';
+import moment from 'moment';
+
 import { getIndexListUri } from '../../../../../../../../../plugins/index_management/public';
 
 import {
@@ -247,6 +249,7 @@ export class DetailPanel extends Component {
           <ul>
             {autoFollowPattern.errors.map((error, i) => (
               <li key={i} data-test-subj="recentError">
+                <strong>{moment(error.timestamp).format('MMMM Do, YYYY h:mm:ss A')}</strong>:{' '}
                 {error.autoFollowException.reason}
               </li>
             ))}
diff --git a/x-pack/plugins/cross_cluster_replication/public/app/services/auto_follow_errors.js b/x-pack/plugins/cross_cluster_replication/public/app/services/auto_follow_errors.js
@@ -9,11 +9,12 @@ export const parseAutoFollowError = error => {
     return null;
   }
 
-  const { leaderIndex, autoFollowException } = error;
+  const { leaderIndex, autoFollowException, timestamp } = error;
   const id = leaderIndex.substring(0, leaderIndex.lastIndexOf(':'));
 
   return {
     id,
+    timestamp,
     leaderIndex,
     autoFollowException,
   };
diff --git a/x-pack/plugins/cross_cluster_replication/public/plugin.ts b/x-pack/plugins/cross_cluster_replication/public/plugin.ts
@@ -9,7 +9,7 @@ import { get } from 'lodash';
 import { first } from 'rxjs/operators';
 import { CoreSetup, Plugin, PluginInitializerContext } from 'src/core/public';
 
-import { PLUGIN } from '../common/constants';
+import { PLUGIN, MANAGEMENT_ID } from '../common/constants';
 import { init as initUiMetric } from './app/services/track_ui_metric';
 import { init as initNotification } from './app/services/notifications';
 import { PluginDependencies, ClientConfigType } from './types';
@@ -27,8 +27,8 @@ export class CrossClusterReplicationPlugin implements Plugin {
       .pipe(first())
       .toPromise()
       .then(license => {
-        const isLicenseOk = license.isAvailable && license.isActive;
-
+        const licenseStatus = license.check(PLUGIN.ID, PLUGIN.minimumLicenseType);
+        const isLicenseOk = licenseStatus.state === 'valid';
         const config = this.initializerContext.config.get<ClientConfigType>();
 
         // The UI is also dependent upon the Remote Clusters UI.
@@ -48,7 +48,7 @@ export class CrossClusterReplicationPlugin implements Plugin {
           initNotification(toasts, fatalErrors);
 
           management.sections.getSection('elasticsearch')!.registerApp({
-            id: PLUGIN.ID,
+            id: MANAGEMENT_ID,
             title: PLUGIN.TITLE,
             order: 4,
             mount: async ({ element, setBreadcrumbs }) => {
diff --git a/x-pack/plugins/cross_cluster_replication/server/lib/__snapshots__/ccr_stats_serialization.test.ts.snap b/x-pack/plugins/cross_cluster_replication/server/lib/__snapshots__/ccr_stats_serialization.test.ts.snap
diff --git a/x-pack/plugins/cross_cluster_replication/server/lib/ccr_stats_serialization.test.ts b/x-pack/plugins/cross_cluster_replication/server/lib/ccr_stats_serialization.test.ts
@@ -15,6 +15,7 @@ describe('[CCR] auto-follow stats serialization', () => {
       recent_auto_follow_errors: [
         {
           leader_index: 'pattern-1:kibana_sample_1',
+          timestamp: 1587081600021,
           auto_follow_exception: {
             type: 'exception',
             reason:
@@ -23,6 +24,7 @@ describe('[CCR] auto-follow stats serialization', () => {
         },
         {
           leader_index: 'pattern-2:kibana_sample_1',
+          timestamp: 1587081600021,
           auto_follow_exception: {
             type: 'exception',
             reason:
diff --git a/x-pack/plugins/cross_cluster_replication/server/lib/ccr_stats_serialization.ts b/x-pack/plugins/cross_cluster_replication/server/lib/ccr_stats_serialization.ts
@@ -14,9 +14,11 @@ import {
 } from '../../common/types';
 
 export const deserializeRecentAutoFollowErrors = ({
+  timestamp,
   leader_index,
   auto_follow_exception: { type, reason },
 }: RecentAutoFollowErrorFromEs): RecentAutoFollowError => ({
+  timestamp,
   leaderIndex: leader_index,
   autoFollowException: {
     type,
diff --git a/x-pack/plugins/cross_cluster_replication/server/plugin.ts b/x-pack/plugins/cross_cluster_replication/server/plugin.ts
@@ -78,7 +78,7 @@ export class CrossClusterReplicationServerPlugin implements Plugin<void, void, a
 
   async setup(
     { http, elasticsearch }: CoreSetup,
-    { licensing, indexManagement, remoteClusters, security }: Dependencies
+    { licensing, indexManagement, remoteClusters }: Dependencies
   ): Promise<void> {
     const router = http.createRouter();
     const config = await this.config$.pipe(first()).toPromise();
@@ -109,7 +109,6 @@ export class CrossClusterReplicationServerPlugin implements Plugin<void, void, a
     registerApiRoutes({
       router,
       license: this.license,
-      security,
       lib: {
         isEsError,
         formatEsError,
diff --git a/x-pack/plugins/cross_cluster_replication/server/routes/api/cross_cluster_replication/register_permissions_route.ts b/x-pack/plugins/cross_cluster_replication/server/routes/api/cross_cluster_replication/register_permissions_route.ts
@@ -14,16 +14,16 @@ export const registerPermissionsRoute = ({
   router,
   license,
   lib: { isEsError, formatEsError },
-  security,
 }: RouteDependencies) => {
   router.get(
     {
       path: addBasePath('/permissions'),
       validate: false,
     },
     license.guardApiRoute(async (context, request, response) => {
-      if (!security) {
-        // If security isn't enabled or available (in the case where security is enabled but license reverted to Basic) let the user use CCR.
+      if (!license.isEsSecurityEnabled) {
+        // If security has been disabled in elasticsearch.yml. we'll just let the user use CCR
+        // because permissions are irrelevant.
         return response.ok({
           body: {
             hasPermission: true,
diff --git a/x-pack/plugins/cross_cluster_replication/server/services/license.ts b/x-pack/plugins/cross_cluster_replication/server/services/license.ts
@@ -31,6 +31,8 @@ export class License {
     message: 'Invalid License',
   };
 
+  private _isEsSecurityEnabled: boolean = false;
+
   setup(
     { pluginId, minimumLicenseType, defaultErrorMessage }: SetupSettings,
     { licensing, logger }: { licensing: LicensingPluginSetup; logger: Logger }
@@ -39,6 +41,10 @@ export class License {
       const { state, message } = license.check(pluginId, minimumLicenseType);
       const hasRequiredLicense = state === 'valid';
 
+      // Retrieving security checks the results of GET /_xpack as well as license state,
+      // so we're also checking whether the security is disabled in elasticsearch.yml.
+      this._isEsSecurityEnabled = license.getFeature('security').isEnabled;
+
       if (hasRequiredLicense) {
         this.licenseStatus = { isValid: true };
       } else {
@@ -79,4 +85,9 @@ export class License {
   getStatus() {
     return this.licenseStatus;
   }
+
+  // eslint-disable-next-line @typescript-eslint/explicit-member-accessibility
+  get isEsSecurityEnabled() {
+    return this._isEsSecurityEnabled;
+  }
 }
diff --git a/x-pack/plugins/cross_cluster_replication/server/types.ts b/x-pack/plugins/cross_cluster_replication/server/types.ts
@@ -8,7 +8,6 @@ import { IRouter } from 'src/core/server';
 import { LicensingPluginSetup } from '../../licensing/server';
 import { IndexManagementPluginSetup } from '../../index_management/server';
 import { RemoteClustersPluginSetup } from '../../remote_clusters/server';
-import { SecurityPluginSetup } from '../../security/server';
 import { License } from './services';
 import { isEsError } from './lib/is_es_error';
 import { formatEsError } from './lib/format_es_error';
@@ -17,13 +16,11 @@ export interface Dependencies {
   licensing: LicensingPluginSetup;
   indexManagement: IndexManagementPluginSetup;
   remoteClusters: RemoteClustersPluginSetup;
-  security?: SecurityPluginSetup;
 }
 
 export interface RouteDependencies {
   router: IRouter;
   license: License;
-  security?: SecurityPluginSetup;
   lib: {
     isEsError: typeof isEsError;
     formatEsError: typeof formatEsError;

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,7 @@ export interface FollowerIndexAdvancedSettingsToEs {`
`140`	`140`	`}`
`141`	`141`
`142`	`142`	`export interface RecentAutoFollowError {`
	`143`	`+ timestamp: number;`
`143`	`144`	`leaderIndex: string;`
`144`	`145`	`autoFollowException: {`
`145`	`146`	`type: string;`
`@@ -148,6 +149,7 @@ export interface RecentAutoFollowError {`
`148`	`149`	`}`
`149`	`150`
`150`	`151`	`export interface RecentAutoFollowErrorFromEs {`
	`152`	`+ timestamp: number;`
`151`	`153`	`leader_index: string;`
`152`	`154`	`auto_follow_exception: {`
`153`	`155`	`type: string;`