Implement new platform plugin discovery.

src/core/server/config/__snapshots__/env.test.ts.snap

@@ -17,7 +17,6 @@ Env {
   "configs": Array [
     "/some/other/path/some-kibana.yml",
   ],
-  "corePluginsDir": "/test/cwd/core_plugins",
   "homeDir": "/test/cwd",
   "isDevClusterMaster": false,
   "logDir": "/test/cwd/log",
@@ -53,7 +52,6 @@ Env {
   "configs": Array [
     "/some/other/path/some-kibana.yml",
   ],
-  "corePluginsDir": "/test/cwd/core_plugins",
   "homeDir": "/test/cwd",
   "isDevClusterMaster": false,
   "logDir": "/test/cwd/log",
@@ -88,7 +86,6 @@ Env {
   "configs": Array [
     "/test/cwd/config/kibana.yml",
   ],
-  "corePluginsDir": "/test/cwd/core_plugins",
   "homeDir": "/test/cwd",
   "isDevClusterMaster": true,
   "logDir": "/test/cwd/log",
@@ -123,7 +120,6 @@ Env {
   "configs": Array [
     "/some/other/path/some-kibana.yml",
   ],
-  "corePluginsDir": "/test/cwd/core_plugins",
   "homeDir": "/test/cwd",
   "isDevClusterMaster": false,
   "logDir": "/test/cwd/log",
@@ -158,7 +154,6 @@ Env {
   "configs": Array [
     "/some/other/path/some-kibana.yml",
   ],
-  "corePluginsDir": "/test/cwd/core_plugins",
   "homeDir": "/test/cwd",
   "isDevClusterMaster": false,
   "logDir": "/test/cwd/log",
@@ -193,7 +188,6 @@ Env {
   "configs": Array [
     "/some/other/path/some-kibana.yml",
   ],
-  "corePluginsDir": "/some/home/dir/core_plugins",
   "homeDir": "/some/home/dir",
   "isDevClusterMaster": false,
   "logDir": "/some/home/dir/log",

src/core/server/config/env.ts

@@ -61,7 +61,6 @@ export class Env {
   }
 
   public readonly configDir: string;
-  public readonly corePluginsDir: string;
   public readonly binDir: string;
   public readonly logDir: string;
   public readonly staticFilesDir: string;
@@ -96,7 +95,6 @@ export class Env {
    */
   constructor(readonly homeDir: string, options: EnvOptions) {
     this.configDir = resolve(this.homeDir, 'config');
-    this.corePluginsDir = resolve(this.homeDir, 'core_plugins');
     this.binDir = resolve(this.homeDir, 'bin');
     this.logDir = resolve(this.homeDir, 'log');
     this.staticFilesDir = resolve(this.homeDir, 'ui');

src/core/server/index.test.ts

@@ -22,6 +22,11 @@ jest.mock('./http/http_service', () => ({
   HttpService: jest.fn(() => mockHttpService),
 }));
 
+const mockPluginsService = { start: jest.fn(), stop: jest.fn() };
+jest.mock('./plugins/plugins_service', () => ({
+  PluginsService: jest.fn(() => mockPluginsService),
+}));
+
 const mockLegacyService = { start: jest.fn(), stop: jest.fn() };
 jest.mock('./legacy_compat/legacy_service', () => ({
   LegacyService: jest.fn(() => mockLegacyService),
@@ -45,6 +50,8 @@ afterEach(() => {
   mockConfigService.atPath.mockReset();
   mockHttpService.start.mockReset();
   mockHttpService.stop.mockReset();
+  mockPluginsService.start.mockReset();
+  mockPluginsService.stop.mockReset();
   mockLegacyService.start.mockReset();
   mockLegacyService.stop.mockReset();
 });
@@ -56,11 +63,13 @@ test('starts services on "start"', async () => {
   const server = new Server(mockConfigService as any, logger, env);
 
   expect(mockHttpService.start).not.toHaveBeenCalled();
+  expect(mockPluginsService.start).not.toHaveBeenCalled();
   expect(mockLegacyService.start).not.toHaveBeenCalled();
 
   await server.start();
 
   expect(mockHttpService.start).toHaveBeenCalledTimes(1);
+  expect(mockPluginsService.start).toHaveBeenCalledTimes(1);
   expect(mockLegacyService.start).toHaveBeenCalledTimes(1);
   expect(mockLegacyService.start).toHaveBeenCalledWith(mockHttpServiceStartContract);
 });
@@ -112,10 +121,12 @@ test('stops services on "stop"', async () => {
   await server.start();
 
   expect(mockHttpService.stop).not.toHaveBeenCalled();
+  expect(mockPluginsService.stop).not.toHaveBeenCalled();
   expect(mockLegacyService.stop).not.toHaveBeenCalled();
 
   await server.stop();
 
   expect(mockHttpService.stop).toHaveBeenCalledTimes(1);
+  expect(mockPluginsService.stop).toHaveBeenCalledTimes(1);
   expect(mockLegacyService.stop).toHaveBeenCalledTimes(1);
 });

src/core/server/index.ts

@@ -17,6 +17,8 @@
  * under the License.
  */
 
+import { PluginsModule } from './plugins';
+
 export { bootstrap } from './bootstrap';
 
 import { first } from 'rxjs/operators';
@@ -27,6 +29,7 @@ import { Logger, LoggerFactory } from './logging';
 
 export class Server {
   private readonly http: HttpModule;
+  private readonly plugins: PluginsModule;
   private readonly legacy: LegacyCompatModule;
   private readonly log: Logger;
 
@@ -38,6 +41,7 @@ export class Server {
     this.log = logger.get('server');
 
     this.http = new HttpModule(configService.atPath('server', HttpConfig), logger);
+    this.plugins = new PluginsModule(configService, logger, env);
     this.legacy = new LegacyCompatModule(configService, logger, env);
   }
 
@@ -54,6 +58,7 @@ export class Server {
       httpServerInfo = await this.http.service.start();
     }
 
+    await this.plugins.service.start();
     await this.legacy.service.start(httpServerInfo);
 
     const unhandledConfigPaths = await this.configService.getUnusedPaths();
@@ -70,6 +75,7 @@ export class Server {
     this.log.debug('stopping server');
 
     await this.legacy.service.stop();
+    await this.plugins.service.stop();
     await this.http.service.stop();
   }
 }

src/core/server/plugins/index.ts

@@ -0,0 +1,30 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { ConfigService, Env } from '../config';
+import { LoggerFactory } from '../logging';
+import { PluginsService } from './plugins_service';
+
+export class PluginsModule {
+  public readonly service: PluginsService;
+
+  constructor(private readonly configService: ConfigService, logger: LoggerFactory, env: Env) {
+    this.service = new PluginsService(env, logger, this.configService);
+  }
+}

src/core/server/plugins/plugin_discovery.test.ts

@@ -0,0 +1,139 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+const mockReaddir = jest.fn();
+const mockReadFile = jest.fn();
+const mockStat = jest.fn();
+jest.mock('fs', () => ({
+  readdir: mockReaddir,
+  readFile: mockReadFile,
+  stat: mockStat,
+}));
+
+import { of } from 'rxjs';
+import { map, toArray } from 'rxjs/operators';
+import { logger } from '../logging/__mocks__';
+import { PluginsDiscovery } from './plugins_discovery';
+
+beforeEach(() => {
+  mockReaddir.mockImplementation((path, cb) => {
+    if (path === '/scan/non-empty/') {
+      cb(null, ['1', '2-no-manifest', '3', '4-incomplete-manifest']);
+    } else if (path === '/scan/non-empty-2/') {
+      cb(null, ['5-invalid-manifest', '6', '7-non-dir']);
+    } else if (path.includes('non-existent')) {
+      cb(new Error('ENOENT'));
+    } else {
+      cb(null, []);
+    }
+  });
+
+  mockStat.mockImplementation((path, cb) => {
+    if (path.includes('non-existent')) {
+      cb(new Error('ENOENT'));
+    } else {
+      cb(null, { isDirectory: () => !path.includes('non-dir') });
+    }
+  });
+
+  mockReadFile.mockImplementation((path, cb) => {
+    if (path.endsWith('no-manifest/kibana.json')) {
+      cb(new Error('ENOENT'));
+    } else if (path.endsWith('invalid-manifest/kibana.json')) {
+      cb(null, Buffer.from('not-json'));
+    } else if (path.endsWith('incomplete-manifest/kibana.json')) {
+      cb(null, Buffer.from(JSON.stringify({ version: '1' })));
+    } else {
+      cb(null, Buffer.from(JSON.stringify({ id: 'plugin', version: '1' })));
+    }
+  });
+});
+
+afterEach(() => {
+  jest.clearAllMocks();
+});
+
+test('properly scans folders and paths', async () => {
+  const discovery = new PluginsDiscovery(logger.get());
+  const { plugins$, errors$ } = discovery.discover(
+    of({
+      initialize: true,
+      scanDirs: ['/scan/non-empty/', '/scan/non-existent/', '/scan/empty/', '/scan/non-empty-2/'],
+      paths: ['/path/existent-dir', '/path/non-dir', '/path/non-existent', '/path/existent-dir-2'],
+    })
+  );
+
+  await expect(plugins$.pipe(toArray()).toPromise()).resolves.toMatchInlineSnapshot(`
+Array [
+  Object {
+    "manifest": Object {
+      "id": "plugin",
+      "version": "1",
+    },
+    "path": "/scan/non-empty/1",
+  },
+  Object {
+    "manifest": Object {
+      "id": "plugin",
+      "version": "1",
+    },
+    "path": "/scan/non-empty/3",
+  },
+  Object {
+    "manifest": Object {
+      "id": "plugin",
+      "version": "1",
+    },
+    "path": "/scan/non-empty-2/6",
+  },
+  Object {
+    "manifest": Object {
+      "id": "plugin",
+      "version": "1",
+    },
+    "path": "/path/existent-dir",
+  },
+  Object {
+    "manifest": Object {
+      "id": "plugin",
+      "version": "1",
+    },
+    "path": "/path/existent-dir-2",
+  },
+]
+`);
+
+  await expect(
+    errors$
+      .pipe(
+        map(error => error.toString()),
+        toArray()
+      )
+      .toPromise()
+  ).resolves.toMatchInlineSnapshot(`
+Array [
+  "Error: ENOENT (missing-manifest, /scan/non-empty/2-no-manifest/kibana.json)",
+  "Error: The \\"id\\" or/and \\"version\\" is missing in the plugin manifest. (invalid-manifest, /scan/non-empty/4-incomplete-manifest/kibana.json)",
+  "Error: ENOENT (invalid-scan-dir, /scan/non-existent/)",
+  "Error: Unexpected token o in JSON at position 1 (invalid-manifest, /scan/non-empty-2/5-invalid-manifest/kibana.json)",
+  "Error: /path/non-dir is not a directory. (invalid-plugin-dir, /path/non-dir)",
+  "Error: ENOENT (invalid-plugin-dir, /path/non-existent)",
+]
+`);
+});

src/core/server/plugins/plugin_discovery_error.ts

@@ -0,0 +1,43 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export enum PluginDiscoveryErrorType {
+  InvalidScanDirectory = 'invalid-scan-dir',
+  InvalidPluginDirectory = 'invalid-plugin-dir',
+  InvalidManifest = 'invalid-manifest',
+  MissingManifest = 'missing-manifest',
+}
+
+export class PluginDiscoveryError extends Error {
+  constructor(
+    public readonly type: PluginDiscoveryErrorType,
+    public readonly path: string,
+    public readonly cause?: Error
+  ) {
+    super(cause && cause.message);
+
+    // Set the prototype explicitly, see:
+    // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work
+    Object.setPrototypeOf(this, PluginDiscoveryError.prototype);
+  }
+
+  public toString() {
+    return `${super.toString()} (${this.type}, ${this.path})`;
+  }
+}