Introduce support for the server-side new platform plugins.

src/cli/serve/integration_tests/invalid_config.test.js

@@ -32,10 +32,11 @@ describe('cli invalid config support', function () {
       cwd: ROOT_DIR
     });
 
-    const logLines = stdout.toString('utf8')
+    const [fatalLogLine] = stdout.toString('utf8')
       .split('\n')
       .filter(Boolean)
       .map(JSON.parse)
+      .filter(line => line.tags.includes('fatal'))
       .map(obj => ({
         ...obj,
         pid: '## PID ##',
@@ -45,9 +46,9 @@ describe('cli invalid config support', function () {
 
     expect(error).toBe(undefined);
     expect(status).toBe(64);
-    expect(logLines[0].message).toMatch('{ Error: "unknown.key", "other.unknown.key", "other.third", "some.flat.key", and "' +
-        'some.array" settings were not applied. Check for spelling errors and ensure that expected plugins are installed.');
-    expect(logLines[0].tags).toEqual(['fatal', 'root']);
-    expect(logLines[0].type).toEqual('log');
+    expect(fatalLogLine.message).toMatch('{ Error: "unknown.key", "other.unknown.key", "other.third", "some.flat.key", and "' +
+      'some.array" settings were not applied. Check for spelling errors and ensure that expected plugins are installed.');
+    expect(fatalLogLine.tags).toEqual(['fatal', 'root']);
+    expect(fatalLogLine.type).toEqual('log');
   }, 20 * 1000);
 });

src/core/server/__snapshots__/index.test.ts.snap

@@ -11,11 +11,7 @@ Object {
   "fatal": Array [],
   "info": Array [],
   "log": Array [],
-  "trace": Array [
-    Array [
-      "some config paths are not handled by the core: [\\"some.path\\",\\"another.path\\"]",
-    ],
-  ],
+  "trace": Array [],
   "warn": Array [],
 }
 `;

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

@@ -32,6 +32,11 @@ Env {
     "buildSha": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
     "version": "v1",
   },
+  "pluginSearchPaths": Array [
+    "/test/cwd/src/plugins",
+    "/test/cwd/plugins",
+    "/test/cwd/../kibana-extra",
+  ],
   "staticFilesDir": "/test/cwd/ui",
 }
 `;
@@ -68,6 +73,11 @@ Env {
     "buildSha": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
     "version": "v1",
   },
+  "pluginSearchPaths": Array [
+    "/test/cwd/src/plugins",
+    "/test/cwd/plugins",
+    "/test/cwd/../kibana-extra",
+  ],
   "staticFilesDir": "/test/cwd/ui",
 }
 `;
@@ -103,6 +113,11 @@ Env {
     "buildSha": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
     "version": "some-version",
   },
+  "pluginSearchPaths": Array [
+    "/test/cwd/src/plugins",
+    "/test/cwd/plugins",
+    "/test/cwd/../kibana-extra",
+  ],
   "staticFilesDir": "/test/cwd/ui",
 }
 `;
@@ -138,6 +153,11 @@ Env {
     "buildSha": "feature-v1-build-sha",
     "version": "v1",
   },
+  "pluginSearchPaths": Array [
+    "/test/cwd/src/plugins",
+    "/test/cwd/plugins",
+    "/test/cwd/../kibana-extra",
+  ],
   "staticFilesDir": "/test/cwd/ui",
 }
 `;
@@ -173,6 +193,11 @@ Env {
     "buildSha": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
     "version": "v1",
   },
+  "pluginSearchPaths": Array [
+    "/test/cwd/src/plugins",
+    "/test/cwd/plugins",
+    "/test/cwd/../kibana-extra",
+  ],
   "staticFilesDir": "/test/cwd/ui",
 }
 `;
@@ -208,6 +233,11 @@ Env {
     "buildSha": "feature-v1-build-sha",
     "version": "v1",
   },
+  "pluginSearchPaths": Array [
+    "/some/home/dir/src/plugins",
+    "/some/home/dir/plugins",
+    "/some/home/dir/../kibana-extra",
+  ],
   "staticFilesDir": "/some/home/dir/ui",
 }
 `;

src/core/server/config/config.ts

@@ -19,8 +19,26 @@
 
 export type ConfigPath = string | string[];
 
+/**
+ * Checks whether specified value can be considered as config path.
+ * @param value Value to check.
+ * @internal
+ */
+export function isConfigPath(value: unknown): value is ConfigPath {
+  if (!value) {
+    return false;
+  }
+
+  if (typeof value === 'string') {
+    return true;
+  }
+
+  return Array.isArray(value) && value.every(segment => typeof segment === 'string');
+}
+
 /**
  * Represents config store.
+ * @internal
  */
 export interface Config {
   /**

src/core/server/config/config_service.ts

@@ -25,6 +25,7 @@ import { distinctUntilChanged, first, map } from 'rxjs/operators';
 import { Config, ConfigPath, ConfigWithSchema, Env } from '.';
 import { Logger, LoggerFactory } from '../logging';
 
+/** @internal */
 export class ConfigService {
   private readonly log: Logger;
 
@@ -107,13 +108,20 @@ export class ConfigService {
     return true;
   }
 
-  public async getUnusedPaths(): Promise<string[]> {
+  public async getUnusedPaths() {
     const config = await this.config$.pipe(first()).toPromise();
     const handledPaths = this.handledPaths.map(pathToString);
 
     return config.getFlattenedPaths().filter(path => !isPathHandled(path, handledPaths));
   }
 
+  public async getUsedPaths() {
+    const config = await this.config$.pipe(first()).toPromise();
+    const handledPaths = this.handledPaths.map(pathToString);
+
+    return config.getFlattenedPaths().filter(path => isPathHandled(path, handledPaths));
+  }
+
   private createConfig<TSchema extends Type<any>, TConfig>(
     path: ConfigPath,
     config: Record<string, any>,

src/core/server/config/env.ts

@@ -29,18 +29,20 @@ export interface PackageInfo {
   buildSha: string;
 }
 
-interface EnvironmentMode {
+export interface EnvironmentMode {
   name: 'development' | 'production';
   dev: boolean;
   prod: boolean;
 }
 
+/** @internal */
 export interface EnvOptions {
   configs: string[];
   cliArgs: CliArgs;
   isDevClusterMaster: boolean;
 }
 
+/** @internal */
 export interface CliArgs {
   dev: boolean;
   envName?: string;
@@ -61,10 +63,16 @@ export class Env {
     return new Env(process.cwd(), options);
   }
 
+  /** @internal */
   public readonly configDir: string;
+  /** @internal */
   public readonly binDir: string;
+  /** @internal */
   public readonly logDir: string;
+  /** @internal */
   public readonly staticFilesDir: string;
+  /** @internal */
+  public readonly pluginSearchPaths: ReadonlyArray<string>;
 
   /**
    * Information about Kibana package (version, build number etc.).
@@ -78,16 +86,19 @@ export class Env {
 
   /**
    * Arguments provided through command line.
+   * @internal
    */
   public readonly cliArgs: Readonly<CliArgs>;
 
   /**
    * Paths to the configuration files.
+   * @internal
    */
   public readonly configs: ReadonlyArray<string>;
 
   /**
    * Indicates that this Kibana instance is run as development Node Cluster master.
+   * @internal
    */
   public readonly isDevClusterMaster: boolean;
 
@@ -100,6 +111,12 @@ export class Env {
     this.logDir = resolve(this.homeDir, 'log');
     this.staticFilesDir = resolve(this.homeDir, 'ui');
 
+    this.pluginSearchPaths = [
+      resolve(this.homeDir, 'src', 'plugins'),
+      resolve(this.homeDir, 'plugins'),
+      resolve(this.homeDir, '..', 'kibana-extra'),
+    ];
+
     this.cliArgs = Object.freeze(options.cliArgs);
     this.configs = Object.freeze(options.configs);
     this.isDevClusterMaster = options.isDevClusterMaster;

src/core/server/config/index.ts

@@ -17,10 +17,16 @@
  * under the License.
  */
 
+/** @internal */
 export { ConfigService } from './config_service';
+/** @internal */
 export { RawConfigService } from './raw_config_service';
-export { Config, ConfigPath } from './config';
+/** @internal */
+export { Config, ConfigPath, isConfigPath } from './config';
 /** @internal */
 export { ObjectToConfigAdapter } from './object_to_config_adapter';
-export { Env, CliArgs, PackageInfo } from './env';
+/** @internal */
+export { CliArgs } from './env';
+
+export { Env, EnvironmentMode, PackageInfo } from './env';
 export { ConfigWithSchema } from './config_with_schema';

src/core/server/config/raw_config_service.ts

@@ -26,6 +26,7 @@ import { Config } from './config';
 import { ObjectToConfigAdapter } from './object_to_config_adapter';
 import { getConfigFromFiles } from './read_config';
 
+/** @internal */
 export class RawConfigService {
   /**
    * The stream of configs read from the config file.

src/core/server/config/read_config.ts

@@ -48,6 +48,7 @@ function merge(target: Record<string, any>, value: any, key?: string) {
   return target;
 }
 
+/** @internal */
 export const getConfigFromFiles = (configFiles: ReadonlyArray<string>) => {
   let mergedYaml = {};
 

src/core/server/http/http_service.ts

@@ -20,13 +20,17 @@
 import { Observable, Subscription } from 'rxjs';
 import { first } from 'rxjs/operators';
 
-import { CoreService } from '../../types/core_service';
+import { CoreService } from '../../types';
 import { Logger, LoggerFactory } from '../logging';
 import { HttpConfig } from './http_config';
 import { HttpServer, HttpServerInfo } from './http_server';
 import { HttpsRedirectServer } from './https_redirect_server';
 import { Router } from './router';
 
+/** @internal */
+export type HttpServiceStartContract = HttpServerInfo;
+
+/** @internal */
 export class HttpService implements CoreService<HttpServerInfo> {
   private readonly httpServer: HttpServer;
   private readonly httpsRedirectServer: HttpsRedirectServer;

src/core/server/http/index.ts

@@ -21,11 +21,11 @@ import { Observable } from 'rxjs';
 
 import { LoggerFactory } from '../logging';
 import { HttpConfig } from './http_config';
-import { HttpService } from './http_service';
+import { HttpService, HttpServiceStartContract } from './http_service';
 import { Router } from './router';
 
 export { Router, KibanaRequest } from './router';
-export { HttpService };
+export { HttpService, HttpServiceStartContract };
 export { HttpServerInfo } from './http_server';
 export { BasePathProxyServer } from './base_path_proxy_server';
 

src/core/server/index.test.ts

@@ -60,6 +60,9 @@ test('starts services on "start"', async () => {
   const mockHttpServiceStartContract = { something: true };
   mockHttpService.start.mockReturnValue(Promise.resolve(mockHttpServiceStartContract));
 
+  const mockPluginsServiceStartContract = new Map([['some-plugin', 'some-value']]);
+  mockPluginsService.start.mockReturnValue(Promise.resolve(mockPluginsServiceStartContract));
+
   const server = new Server(mockConfigService as any, logger, env);
 
   expect(mockHttpService.start).not.toHaveBeenCalled();
@@ -71,7 +74,10 @@ test('starts services on "start"', async () => {
   expect(mockHttpService.start).toHaveBeenCalledTimes(1);
   expect(mockPluginsService.start).toHaveBeenCalledTimes(1);
   expect(mockLegacyService.start).toHaveBeenCalledTimes(1);
-  expect(mockLegacyService.start).toHaveBeenCalledWith(mockHttpServiceStartContract);
+  expect(mockLegacyService.start).toHaveBeenCalledWith({
+    http: mockHttpServiceStartContract,
+    plugins: mockPluginsServiceStartContract,
+  });
 });
 
 test('does not fail on "start" if there are unused paths detected', async () => {
@@ -93,7 +99,7 @@ test('does not start http service is `autoListen:false`', async () => {
 
   expect(mockHttpService.start).not.toHaveBeenCalled();
   expect(mockLegacyService.start).toHaveBeenCalledTimes(1);
-  expect(mockLegacyService.start).toHaveBeenCalledWith(undefined);
+  expect(mockLegacyService.start).toHaveBeenCalledWith({});
 });
 
 test('does not start http service if process is dev cluster master', async () => {
@@ -109,7 +115,7 @@ test('does not start http service if process is dev cluster master', async () =>
 
   expect(mockHttpService.start).not.toHaveBeenCalled();
   expect(mockLegacyService.start).toHaveBeenCalledTimes(1);
-  expect(mockLegacyService.start).toHaveBeenCalledWith(undefined);
+  expect(mockLegacyService.start).toHaveBeenCalledWith({});
 });
 
 test('stops services on "stop"', async () => {