Extract License service from CCR and Watcher into license_api_guard p…

…lugin in x-pack (#95973) (#97332) * Localize error messages. # Conflicts: # .github/CODEOWNERS
elastic · Apr 16, 2021 · 84d8a7d · 84d8a7d
1 parent 034a952
commit 84d8a7d
Show file tree

Hide file tree

Showing 57 changed files with 431 additions and 339 deletions.
diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc
@@ -444,6 +444,10 @@ the infrastructure monitoring use-case within Kibana.
 |Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads.
 
 
+|{kib-repo}blob/{branch}/x-pack/plugins/license_api_guard[licenseApiGuard]
+|WARNING: Missing README.
+
+
 |{kib-repo}blob/{branch}/x-pack/plugins/license_management/README.md[licenseManagement]
 |This plugin enables users to activate a trial license, downgrade to Basic, and upload a new license.
 

diff --git a/src/plugins/es_ui_shared/tsconfig.json b/src/plugins/es_ui_shared/tsconfig.json
@@ -16,6 +16,6 @@
   ],
   "references": [
     { "path": "../../core/tsconfig.json" },
-    { "path": "../data/tsconfig.json" },
+    { "path": "../data/tsconfig.json" }
   ]
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -105,6 +105,7 @@
     { "path": "./x-pack/plugins/infra/tsconfig.json" },
     { "path": "./x-pack/plugins/ingest_pipelines/tsconfig.json" },
     { "path": "./x-pack/plugins/lens/tsconfig.json" },
+    { "path": "./x-pack/plugins/license_api_guard/tsconfig.json" },
     { "path": "./x-pack/plugins/license_management/tsconfig.json" },
     { "path": "./x-pack/plugins/licensing/tsconfig.json" },
     { "path": "./x-pack/plugins/logstash/tsconfig.json" },

diff --git a/x-pack/.i18nrc.json b/x-pack/.i18nrc.json
@@ -31,6 +31,7 @@
     "xpack.fleet": "plugins/fleet",
     "xpack.ingestPipelines": "plugins/ingest_pipelines",
     "xpack.lens": "plugins/lens",
+    "xpack.licenseApiGuard": "plugins/license_api_guard",
     "xpack.licenseMgmt": "plugins/license_management",
     "xpack.licensing": "plugins/licensing",
     "xpack.lists": "plugins/lists",

diff --git a/x-pack/plugins/cross_cluster_replication/kibana.json b/x-pack/plugins/cross_cluster_replication/kibana.json
@@ -6,6 +6,7 @@
   "requiredPlugins": [
     "home",
     "licensing",
+    "licenseApiGuard",
     "management",
     "remoteClusters",
     "indexManagement",

diff --git a/x-pack/plugins/cross_cluster_replication/server/plugin.ts b/x-pack/plugins/cross_cluster_replication/server/plugin.ts
@@ -7,9 +7,9 @@
 
 import { Observable } from 'rxjs';
 import { first } from 'rxjs/operators';
-import { i18n } from '@kbn/i18n';
 import {
   CoreSetup,
+  CoreStart,
   ILegacyCustomClusterClient,
   Plugin,
   Logger,
@@ -19,12 +19,11 @@ import {
 
 import { Index } from '../../index_management/server';
 import { PLUGIN } from '../common/constants';
-import type { Dependencies, CcrRequestHandlerContext } from './types';
+import { SetupDependencies, StartDependencies, CcrRequestHandlerContext } from './types';
 import { registerApiRoutes } from './routes';
-import { License } from './services';
 import { elasticsearchJsPlugin } from './client/elasticsearch_ccr';
 import { CrossClusterReplicationConfig } from './config';
-import { isEsError } from './shared_imports';
+import { License, isEsError } from './shared_imports';
 import { formatEsError } from './lib/format_es_error';
 
 async function getCustomEsClient(getStartServices: CoreSetup['getStartServices']) {
@@ -77,7 +76,7 @@ export class CrossClusterReplicationServerPlugin implements Plugin<void, void, a
 
   setup(
     { http, getStartServices }: CoreSetup,
-    { features, licensing, indexManagement, remoteClusters }: Dependencies
+    { features, licensing, indexManagement, remoteClusters }: SetupDependencies
   ) {
     this.config$
       .pipe(first())
@@ -97,22 +96,10 @@ export class CrossClusterReplicationServerPlugin implements Plugin<void, void, a
         }
       });
 
-    this.license.setup(
-      {
-        pluginId: PLUGIN.ID,
-        minimumLicenseType: PLUGIN.minimumLicenseType,
-        defaultErrorMessage: i18n.translate(
-          'xpack.crossClusterReplication.licenseCheckErrorMessage',
-          {
-            defaultMessage: 'License check failed',
-          }
-        ),
-      },
-      {
-        licensing,
-        logger: this.logger,
-      }
-    );
+    this.license.setup({
+      pluginName: PLUGIN.TITLE,
+      logger: this.logger,
+    });
 
     features.registerElasticsearchFeature({
       id: 'cross_cluster_replication',
@@ -147,7 +134,13 @@ export class CrossClusterReplicationServerPlugin implements Plugin<void, void, a
     });
   }
 
-  start() {}
+  start(core: CoreStart, { licensing }: StartDependencies) {
+    this.license.start({
+      pluginId: PLUGIN.ID,
+      minimumLicenseType: PLUGIN.minimumLicenseType,
+      licensing,
+    });
+  }
 
   stop() {
     if (this.ccrEsClient) {

diff --git a/...s_cluster_replication/server/routes/api/auto_follow_pattern/register_create_route.test.ts b/...s_cluster_replication/server/routes/api/auto_follow_pattern/register_create_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerCreateRoute } from './register_create_route';
 

diff --git a/...s_cluster_replication/server/routes/api/auto_follow_pattern/register_delete_route.test.ts b/...s_cluster_replication/server/routes/api/auto_follow_pattern/register_delete_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerDeleteRoute } from './register_delete_route';
 

diff --git a/...ss_cluster_replication/server/routes/api/auto_follow_pattern/register_fetch_route.test.ts b/...ss_cluster_replication/server/routes/api/auto_follow_pattern/register_fetch_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerFetchRoute } from './register_fetch_route';
 

diff --git a/...ross_cluster_replication/server/routes/api/auto_follow_pattern/register_get_route.test.ts b/...ross_cluster_replication/server/routes/api/auto_follow_pattern/register_get_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerGetRoute } from './register_get_route';
 

diff --git a/...ss_cluster_replication/server/routes/api/auto_follow_pattern/register_pause_route.test.ts b/...ss_cluster_replication/server/routes/api/auto_follow_pattern/register_pause_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerPauseRoute } from './register_pause_route';
 

diff --git a/...s_cluster_replication/server/routes/api/auto_follow_pattern/register_resume_route.test.ts b/...s_cluster_replication/server/routes/api/auto_follow_pattern/register_resume_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerResumeRoute } from './register_resume_route';
 

diff --git a/...s_cluster_replication/server/routes/api/auto_follow_pattern/register_update_route.test.ts b/...s_cluster_replication/server/routes/api/auto_follow_pattern/register_update_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerUpdateRoute } from './register_update_route';
 

diff --git a/.../cross_cluster_replication/server/routes/api/follower_index/register_create_route.test.ts b/.../cross_cluster_replication/server/routes/api/follower_index/register_create_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerCreateRoute } from './register_create_route';
 

diff --git a/...s/cross_cluster_replication/server/routes/api/follower_index/register_fetch_route.test.ts b/...s/cross_cluster_replication/server/routes/api/follower_index/register_fetch_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerFetchRoute } from './register_fetch_route';
 

diff --git a/...ins/cross_cluster_replication/server/routes/api/follower_index/register_get_route.test.ts b/...ins/cross_cluster_replication/server/routes/api/follower_index/register_get_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerGetRoute } from './register_get_route';
 

diff --git a/...s/cross_cluster_replication/server/routes/api/follower_index/register_pause_route.test.ts b/...s/cross_cluster_replication/server/routes/api/follower_index/register_pause_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerPauseRoute } from './register_pause_route';
 

diff --git a/.../cross_cluster_replication/server/routes/api/follower_index/register_resume_route.test.ts b/.../cross_cluster_replication/server/routes/api/follower_index/register_resume_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerResumeRoute } from './register_resume_route';
 

diff --git a/...ross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.test.ts b/...ross_cluster_replication/server/routes/api/follower_index/register_unfollow_route.test.ts
@@ -8,9 +8,8 @@
 import { httpServiceMock, httpServerMock } from 'src/core/server/mocks';
 import { kibanaResponseFactory, RequestHandler } from 'src/core/server';
 
-import { isEsError } from '../../../shared_imports';
+import { isEsError, License } from '../../../shared_imports';
 import { formatEsError } from '../../../lib/format_es_error';
-import { License } from '../../../services';
 import { mockRouteContext } from '../test_lib';
 import { registerUnfollowRoute } from './register_unfollow_route';
 

diff --git a/x-pack/plugins/cross_cluster_replication/server/services/index.ts b/x-pack/plugins/cross_cluster_replication/server/services/index.ts
@@ -5,5 +5,4 @@
  * 2.0.
  */
 
-export { License } from './license';
 export { addBasePath } from './add_base_path';
diff --git a/x-pack/plugins/cross_cluster_replication/server/services/license.ts b/x-pack/plugins/cross_cluster_replication/server/services/license.ts
diff --git a/x-pack/plugins/cross_cluster_replication/server/shared_imports.ts b/x-pack/plugins/cross_cluster_replication/server/shared_imports.ts
@@ -6,3 +6,4 @@
  */
 
 export { isEsError } from '../../../../src/plugins/es_ui_shared/server';
+export { License } from '../../license_api_guard/server';
diff --git a/x-pack/plugins/cross_cluster_replication/server/types.ts b/x-pack/plugins/cross_cluster_replication/server/types.ts
@@ -7,20 +7,23 @@
 
 import { IRouter, ILegacyScopedClusterClient, RequestHandlerContext } from 'src/core/server';
 import { PluginSetupContract as FeaturesPluginSetup } from '../../features/server';
-import { LicensingPluginSetup } from '../../licensing/server';
+import { LicensingPluginSetup, LicensingPluginStart } from '../../licensing/server';
 import { IndexManagementPluginSetup } from '../../index_management/server';
 import { RemoteClustersPluginSetup } from '../../remote_clusters/server';
-import { License } from './services';
-import { isEsError } from './shared_imports';
+import { License, isEsError } from './shared_imports';
 import { formatEsError } from './lib/format_es_error';
 
-export interface Dependencies {
+export interface SetupDependencies {
   licensing: LicensingPluginSetup;
   indexManagement: IndexManagementPluginSetup;
   remoteClusters: RemoteClustersPluginSetup;
   features: FeaturesPluginSetup;
 }
 
+export interface StartDependencies {
+  licensing: LicensingPluginStart;
+}
+
 export interface RouteDependencies {
   router: CcrPluginRouter;
   license: License;