Allow custom NP plugin paths in production (#53562)

* allow NP plugins --plugin-path in production, logs a warning

* remove env.staticFilesDir (unused)

* only show warning in development

* update rendering tests snapshots

* fix typo

src/cli/serve/serve.js

@@ -140,23 +140,12 @@ function applyConfigOverrides(rawConfig, opts, extraCliOptions) {
   }
 
   set('plugins.scanDirs', _.compact([].concat(get('plugins.scanDirs'), opts.pluginDir)));
-
   set(
     'plugins.paths',
     _.compact(
       [].concat(
         get('plugins.paths'),
         opts.pluginPath,
-        opts.runExamples
-          ? [
-              // Ideally this would automatically include all plugins in the examples dir
-              fromRoot('examples/demo_search'),
-              fromRoot('examples/search_explorer'),
-              fromRoot('examples/embeddable_examples'),
-              fromRoot('examples/embeddable_explorer'),
-            ]
-          : [],
-
         XPACK_INSTALLED && !opts.oss ? [XPACK_DIR] : []
       )
     )
@@ -253,6 +242,7 @@ export default function(program) {
         silent: !!opts.silent,
         watch: !!opts.watch,
         repl: !!opts.repl,
+        runExamples: !!opts.runExamples,
         // We want to run without base path when the `--run-examples` flag is given so that we can use local
         // links in other documentation sources, like "View this tutorial [here](http://localhost:5601/app/tutorial/xyz)".
         // We can tell users they only have to run with `yarn start --run-examples` to get those

src/core/server/config/__mocks__/env.ts

@@ -38,6 +38,7 @@ export function getEnvOptions(options: DeepPartial<EnvOptions> = {}): EnvOptions
       basePath: false,
       optimize: false,
       oss: false,
+      runExamples: false,
       ...(options.cliArgs || {}),
     },
     isDevClusterMaster:

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

@@ -152,3 +152,25 @@ test('pluginSearchPaths does not contains x-pack plugins path if --oss flag is t
 
   expect(env.pluginSearchPaths).not.toContain('/some/home/dir/x-pack/plugins');
 });
+
+test('pluginSearchPaths contains examples plugins path if --run-examples flag is true', () => {
+  const env = new Env(
+    '/some/home/dir',
+    getEnvOptions({
+      cliArgs: { runExamples: true },
+    })
+  );
+
+  expect(env.pluginSearchPaths).toContain('/some/home/dir/examples');
+});
+
+test('pluginSearchPaths does not contains examples plugins path if --run-examples flag is false', () => {
+  const env = new Env(
+    '/some/home/dir',
+    getEnvOptions({
+      cliArgs: { runExamples: false },
+    })
+  );
+
+  expect(env.pluginSearchPaths).not.toContain('/some/home/dir/examples');
+});

src/core/server/config/env.ts

@@ -43,6 +43,7 @@ export interface CliArgs {
   optimize: boolean;
   open: boolean;
   oss: boolean;
+  runExamples: boolean;
 }
 
 export class Env {
@@ -61,8 +62,6 @@ export class Env {
   /** @internal */
   public readonly logDir: string;
   /** @internal */
-  public readonly staticFilesDir: string;
-  /** @internal */
   public readonly pluginSearchPaths: readonly string[];
 
   /**
@@ -100,14 +99,14 @@ export class Env {
     this.configDir = resolve(this.homeDir, 'config');
     this.binDir = resolve(this.homeDir, 'bin');
     this.logDir = resolve(this.homeDir, 'log');
-    this.staticFilesDir = resolve(this.homeDir, 'ui');
 
     this.pluginSearchPaths = [
       resolve(this.homeDir, 'src', 'plugins'),
-      options.cliArgs.oss ? '' : resolve(this.homeDir, 'x-pack', 'plugins'),
+      ...(options.cliArgs.oss ? [] : [resolve(this.homeDir, 'x-pack', 'plugins')]),
       resolve(this.homeDir, 'plugins'),
+      ...(options.cliArgs.runExamples ? [resolve(this.homeDir, 'examples')] : []),
       resolve(this.homeDir, '..', 'kibana-extra'),
-    ].filter(Boolean);
+    ];
 
     this.cliArgs = Object.freeze(options.cliArgs);
     this.configs = Object.freeze(options.configs);

src/core/server/http/http_config.test.ts

@@ -19,8 +19,6 @@
 
 import uuid from 'uuid';
 import { config, HttpConfig } from '.';
-import { Env } from '../config';
-import { getEnvOptions } from '../config/__mocks__/env';
 
 const validHostnames = ['www.example.com', '8.8.8.8', '::1', 'localhost'];
 const invalidHostname = 'asdf$%^';
@@ -265,8 +263,7 @@ describe('with TLS', () => {
           clientAuthentication: 'none',
         },
       }),
-      {} as any,
-      Env.createDefault(getEnvOptions())
+      {} as any
     );
 
     expect(httpConfig.ssl.requestCert).toBe(false);
@@ -283,8 +280,7 @@ describe('with TLS', () => {
           clientAuthentication: 'optional',
         },
       }),
-      {} as any,
-      Env.createDefault(getEnvOptions())
+      {} as any
     );
 
     expect(httpConfig.ssl.requestCert).toBe(true);
@@ -301,8 +297,7 @@ describe('with TLS', () => {
           clientAuthentication: 'required',
         },
       }),
-      {} as any,
-      Env.createDefault(getEnvOptions())
+      {} as any
     );
 
     expect(httpConfig.ssl.requestCert).toBe(true);

src/core/server/http/http_config.ts

@@ -18,7 +18,6 @@
  */
 
 import { ByteSizeValue, schema, TypeOf } from '@kbn/config-schema';
-import { Env } from '../config';
 import { CspConfigType, CspConfig, ICspConfig } from '../csp';
 import { SslConfig, sslSchema } from './ssl_config';
 
@@ -135,7 +134,6 @@ export class HttpConfig {
   public maxPayload: ByteSizeValue;
   public basePath?: string;
   public rewriteBasePath: boolean;
-  public publicDir: string;
   public defaultRoute?: string;
   public ssl: SslConfig;
   public compression: { enabled: boolean; referrerWhitelist?: string[] };
@@ -144,7 +142,7 @@ export class HttpConfig {
   /**
    * @internal
    */
-  constructor(rawHttpConfig: HttpConfigType, rawCspConfig: CspConfigType, env: Env) {
+  constructor(rawHttpConfig: HttpConfigType, rawCspConfig: CspConfigType) {
     this.autoListen = rawHttpConfig.autoListen;
     this.host = rawHttpConfig.host;
     this.port = rawHttpConfig.port;
@@ -154,7 +152,6 @@ export class HttpConfig {
     this.keepaliveTimeout = rawHttpConfig.keepaliveTimeout;
     this.socketTimeout = rawHttpConfig.socketTimeout;
     this.rewriteBasePath = rawHttpConfig.rewriteBasePath;
-    this.publicDir = env.staticFilesDir;
     this.ssl = new SslConfig(rawHttpConfig.ssl || {});
     this.defaultRoute = rawHttpConfig.defaultRoute;
     this.compression = rawHttpConfig.compression;

src/core/server/http/http_service.ts

@@ -61,14 +61,14 @@ export class HttpService implements CoreService<InternalHttpServiceSetup, HttpSe
   private requestHandlerContext?: RequestHandlerContextContainer;
 
   constructor(private readonly coreContext: CoreContext) {
-    const { logger, configService, env } = coreContext;
+    const { logger, configService } = coreContext;
 
     this.logger = logger;
     this.log = logger.get('http');
     this.config$ = combineLatest(
       configService.atPath<HttpConfigType>(httpConfig.path),
       configService.atPath<CspConfigType>(cspConfig.path)
-    ).pipe(map(([http, csp]) => new HttpConfig(http, csp, env)));
+    ).pipe(map(([http, csp]) => new HttpConfig(http, csp)));
     this.httpServer = new HttpServer(logger, 'Kibana');
     this.httpsRedirectServer = new HttpsRedirectServer(logger.get('http', 'redirect', 'server'));
   }

src/core/server/http/http_tools.test.ts

@@ -31,8 +31,6 @@ import { HttpConfig, config } from './http_config';
 import { Router } from './router';
 import { loggingServiceMock } from '../logging/logging_service.mock';
 import { ByteSizeValue } from '@kbn/config-schema';
-import { Env } from '../config';
-import { getEnvOptions } from '../config/__mocks__/env';
 
 const emptyOutput = {
   statusCode: 400,
@@ -122,8 +120,7 @@ describe('getServerOptions', () => {
           certificate: 'some-certificate-path',
         },
       }),
-      {} as any,
-      Env.createDefault(getEnvOptions())
+      {} as any
     );
 
     expect(getServerOptions(httpConfig).tls).toMatchInlineSnapshot(`
@@ -152,8 +149,7 @@ describe('getServerOptions', () => {
           clientAuthentication: 'required',
         },
       }),
-      {} as any,
-      Env.createDefault(getEnvOptions())
+      {} as any
     );
 
     expect(getServerOptions(httpConfig).tls).toMatchInlineSnapshot(`

src/core/server/legacy/legacy_service.ts

@@ -84,7 +84,7 @@ export class LegacyService implements CoreService {
   private settings?: LegacyVars;
 
   constructor(private readonly coreContext: CoreContext) {
-    const { logger, configService, env } = coreContext;
+    const { logger, configService } = coreContext;
 
     this.log = logger.get('legacy-service');
     this.devConfig$ = configService
@@ -93,7 +93,7 @@ export class LegacyService implements CoreService {
     this.httpConfig$ = combineLatest(
       configService.atPath<HttpConfigType>(httpConfig.path),
       configService.atPath<CspConfigType>(cspConfig.path)
-    ).pipe(map(([http, csp]) => new HttpConfig(http, csp, env)));
+    ).pipe(map(([http, csp]) => new HttpConfig(http, csp)));
   }
 
   public async discoverPlugins(): Promise<LegacyServiceDiscoverPlugins> {