Do not serve legacy JS when serving a Kibana Platform applicat… (#61011)

elastic · Apr 22, 2020 · fc1f4f2 · fc1f4f2
1 parent e708b41
commit fc1f4f2
Show file tree

Hide file tree

Showing 34 changed files with 335 additions and 232 deletions.
diff --git a/packages/kbn-optimizer/src/cli.ts b/packages/kbn-optimizer/src/cli.ts
@@ -44,6 +44,11 @@ run(
       throw createFlagError('expected --cache to have no value');
     }
 
+    const includeCoreBundle = flags.core ?? true;
+    if (typeof includeCoreBundle !== 'boolean') {
+      throw createFlagError('expected --core to have no value');
+    }
+
     const dist = flags.dist ?? false;
     if (typeof dist !== 'boolean') {
       throw createFlagError('expected --dist to have no value');
@@ -87,6 +92,7 @@ run(
       profileWebpack,
       extraPluginScanDirs,
       inspectWorkers,
+      includeCoreBundle,
     });
 
     await runOptimizer(config)
@@ -95,9 +101,10 @@ run(
   },
   {
     flags: {
-      boolean: ['watch', 'oss', 'examples', 'dist', 'cache', 'profile', 'inspect-workers'],
+      boolean: ['core', 'watch', 'oss', 'examples', 'dist', 'cache', 'profile', 'inspect-workers'],
       string: ['workers', 'scan-dir'],
       default: {
+        core: true,
         examples: true,
         cache: true,
         'inspect-workers': true,
@@ -107,6 +114,7 @@ run(
         --workers          max number of workers to use
         --oss              only build oss plugins
         --profile          profile the webpack builds and write stats.json files to build outputs
+        --no-core          disable generating the core bundle
         --no-cache         disable the cache
         --no-examples      don't build the example plugins
         --dist             create bundles that are suitable for inclusion in the Kibana distributable

diff --git a/packages/kbn-optimizer/src/common/bundle.ts b/packages/kbn-optimizer/src/common/bundle.ts
@@ -23,7 +23,7 @@ import { BundleCache } from './bundle_cache';
 import { UnknownVals } from './ts_helpers';
 import { includes, ascending, entriesToObject } from './array_helpers';
 
-const VALID_BUNDLE_TYPES = ['plugin' as const];
+const VALID_BUNDLE_TYPES = ['plugin' as const, 'entry' as const];
 
 export interface BundleSpec {
   readonly type: typeof VALID_BUNDLE_TYPES[0];

diff --git a/...timizer/src/optimizer/get_bundles.test.ts → .../src/optimizer/get_plugin_bundles.test.ts b/...timizer/src/optimizer/get_bundles.test.ts → .../src/optimizer/get_plugin_bundles.test.ts
@@ -19,13 +19,13 @@
 
 import { createAbsolutePathSerializer } from '@kbn/dev-utils';
 
-import { getBundles } from './get_bundles';
+import { getPluginBundles } from './get_plugin_bundles';
 
 expect.addSnapshotSerializer(createAbsolutePathSerializer('/repo'));
 
-it('returns a bundle for each plugin', () => {
+it('returns a bundle for core and each plugin', () => {
   expect(
-    getBundles(
+    getPluginBundles(
       [
         {
           directory: '/repo/plugins/foo',

diff --git a/...bn-optimizer/src/optimizer/get_bundles.ts → ...mizer/src/optimizer/get_plugin_bundles.ts b/...bn-optimizer/src/optimizer/get_bundles.ts → ...mizer/src/optimizer/get_plugin_bundles.ts
@@ -23,7 +23,7 @@ import { Bundle } from '../common';
 
 import { KibanaPlatformPlugin } from './kibana_platform_plugins';
 
-export function getBundles(plugins: KibanaPlatformPlugin[], repoRoot: string) {
+export function getPluginBundles(plugins: KibanaPlatformPlugin[], repoRoot: string) {
   return plugins
     .filter(p => p.isUiPlugin)
     .map(

diff --git a/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts b/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts
@@ -19,7 +19,7 @@
 
 jest.mock('./assign_bundles_to_workers.ts');
 jest.mock('./kibana_platform_plugins.ts');
-jest.mock('./get_bundles.ts');
+jest.mock('./get_plugin_bundles.ts');
 
 import Path from 'path';
 import Os from 'os';
@@ -90,6 +90,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": true,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 2,
         "pluginPaths": Array [],
@@ -114,6 +115,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": false,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 2,
         "pluginPaths": Array [],
@@ -138,6 +140,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": true,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 2,
         "pluginPaths": Array [],
@@ -164,6 +167,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": true,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 2,
         "pluginPaths": Array [],
@@ -187,6 +191,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": true,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 2,
         "pluginPaths": Array [],
@@ -210,6 +215,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": true,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 100,
         "pluginPaths": Array [],
@@ -230,6 +236,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": false,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 100,
         "pluginPaths": Array [],
@@ -250,6 +257,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": false,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 100,
         "pluginPaths": Array [],
@@ -271,6 +279,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": false,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 100,
         "pluginPaths": Array [],
@@ -292,6 +301,7 @@ describe('OptimizerConfig::parseOptions()', () => {
       Object {
         "cache": true,
         "dist": false,
+        "includeCoreBundle": false,
         "inspectWorkers": false,
         "maxWorkerCount": 100,
         "pluginPaths": Array [],
@@ -314,7 +324,7 @@ describe('OptimizerConfig::create()', () => {
     .assignBundlesToWorkers;
   const findKibanaPlatformPlugins: jest.Mock = jest.requireMock('./kibana_platform_plugins.ts')
     .findKibanaPlatformPlugins;
-  const getBundles: jest.Mock = jest.requireMock('./get_bundles.ts').getBundles;
+  const getPluginBundles: jest.Mock = jest.requireMock('./get_plugin_bundles.ts').getPluginBundles;
 
   beforeEach(() => {
     if ('mock' in OptimizerConfig.parseOptions) {
@@ -326,7 +336,7 @@ describe('OptimizerConfig::create()', () => {
       { config: Symbol('worker config 2') },
     ]);
     findKibanaPlatformPlugins.mockReturnValue(Symbol('new platform plugins'));
-    getBundles.mockReturnValue(Symbol('bundles'));
+    getPluginBundles.mockReturnValue([Symbol('bundle1'), Symbol('bundle2')]);
 
     jest.spyOn(OptimizerConfig, 'parseOptions').mockImplementation((): any => ({
       cache: Symbol('parsed cache'),
@@ -348,7 +358,10 @@ describe('OptimizerConfig::create()', () => {
 
     expect(config).toMatchInlineSnapshot(`
       OptimizerConfig {
-        "bundles": Symbol(bundles),
+        "bundles": Array [
+          Symbol(bundle1),
+          Symbol(bundle2),
+        ],
         "cache": Symbol(parsed cache),
         "dist": Symbol(parsed dist),
         "inspectWorkers": Symbol(parsed inspect workers),
@@ -383,7 +396,7 @@ describe('OptimizerConfig::create()', () => {
       }
     `);
 
-    expect(getBundles.mock).toMatchInlineSnapshot(`
+    expect(getPluginBundles.mock).toMatchInlineSnapshot(`
       Object {
         "calls": Array [
           Array [
@@ -400,7 +413,10 @@ describe('OptimizerConfig::create()', () => {
         "results": Array [
           Object {
             "type": "return",
-            "value": Symbol(bundles),
+            "value": Array [
+              Symbol(bundle1),
+              Symbol(bundle2),
+            ],
           },
         ],
       }

diff --git a/packages/kbn-optimizer/src/optimizer/optimizer_config.ts b/packages/kbn-optimizer/src/optimizer/optimizer_config.ts
@@ -23,7 +23,7 @@ import Os from 'os';
 import { Bundle, WorkerConfig } from '../common';
 
 import { findKibanaPlatformPlugins, KibanaPlatformPlugin } from './kibana_platform_plugins';
-import { getBundles } from './get_bundles';
+import { getPluginBundles } from './get_plugin_bundles';
 
 function pickMaxWorkerCount(dist: boolean) {
   // don't break if cpus() returns nothing, or an empty array
@@ -60,6 +60,9 @@ interface Options {
   pluginScanDirs?: string[];
   /** absolute paths that should be added to the default scan dirs */
   extraPluginScanDirs?: string[];
+
+  /** flag that causes the core bundle to be built along with plugins */
+  includeCoreBundle?: boolean;
 }
 
 interface ParsedOptions {
@@ -72,6 +75,7 @@ interface ParsedOptions {
   pluginPaths: string[];
   pluginScanDirs: string[];
   inspectWorkers: boolean;
+  includeCoreBundle: boolean;
 }
 
 export class OptimizerConfig {
@@ -83,6 +87,7 @@ export class OptimizerConfig {
     const profileWebpack = !!options.profileWebpack;
     const inspectWorkers = !!options.inspectWorkers;
     const cache = options.cache !== false && !process.env.KBN_OPTIMIZER_NO_CACHE;
+    const includeCoreBundle = !!options.includeCoreBundle;
 
     const repoRoot = options.repoRoot;
     if (!Path.isAbsolute(repoRoot)) {
@@ -134,13 +139,28 @@ export class OptimizerConfig {
       pluginScanDirs,
       pluginPaths,
       inspectWorkers,
+      includeCoreBundle,
     };
   }
 
   static create(inputOptions: Options) {
     const options = OptimizerConfig.parseOptions(inputOptions);
     const plugins = findKibanaPlatformPlugins(options.pluginScanDirs, options.pluginPaths);
-    const bundles = getBundles(plugins, options.repoRoot);
+    const bundles = [
+      ...(options.includeCoreBundle
+        ? [
+            new Bundle({
+              type: 'entry',
+              id: 'core',
+              entry: './public/entry_point',
+              sourceRoot: options.repoRoot,
+              contextDir: Path.resolve(options.repoRoot, 'src/core'),
+              outputDir: Path.resolve(options.repoRoot, 'src/core/target/public'),
+            }),
+          ]
+        : []),
+      ...getPluginBundles(plugins, options.repoRoot),
+    ];
 
     return new OptimizerConfig(
       bundles,

diff --git a/packages/kbn-optimizer/src/worker/webpack.config.ts b/packages/kbn-optimizer/src/worker/webpack.config.ts
@@ -104,7 +104,7 @@ export function getWebpackConfig(bundle: Bundle, worker: WorkerConfig) {
 
     output: {
       path: bundle.outputDir,
-      filename: '[name].plugin.js',
+      filename: `[name].${bundle.type}.js`,
       publicPath: PUBLIC_PATH_PLACEHOLDER,
       devtoolModuleFilenameTemplate: info =>
         `/${bundle.type}:${bundle.id}/${Path.relative(

diff --git a/src/cli/cluster/run_kbn_optimizer.ts b/src/cli/cluster/run_kbn_optimizer.ts
@@ -34,6 +34,7 @@ export function runKbnOptimizer(opts: Record<string, any>, config: LegacyConfig)
   const optimizerConfig = OptimizerConfig.create({
     repoRoot: REPO_ROOT,
     watch: true,
+    includeCoreBundle: true,
     oss: !!opts.oss,
     examples: !!opts.runExamples,
     pluginPaths: config.get('plugins.paths'),

diff --git a/src/core/public/core.css → src/core/public/_core.scss b/src/core/public/core.css → src/core/public/_core.scss
diff --git a/src/core/public/application/ui/app_router.tsx b/src/core/public/application/ui/app_router.tsx
@@ -21,7 +21,7 @@ import React, { FunctionComponent, useMemo } from 'react';
 import { Route, RouteComponentProps, Router, Switch } from 'react-router-dom';
 import { History } from 'history';
 import { Observable } from 'rxjs';
-import { useObservable } from 'react-use';
+import useObservable from 'react-use/lib/useObservable';
 
 import { AppLeaveHandler, AppStatus, Mounter } from '../types';
 import { AppContainer } from './app_container';

diff --git a/src/core/public/core_system.test.ts b/src/core/public/core_system.test.ts
@@ -59,7 +59,6 @@ const defaultCoreSystemParams = {
       warnLegacyBrowsers: true,
     },
   } as any,
-  requireLegacyFiles: jest.fn(),
 };
 
 beforeEach(() => {
@@ -104,19 +103,22 @@ describe('constructor', () => {
     });
   });
 
-  it('passes requireLegacyFiles, useLegacyTestHarness, and a dom element to LegacyPlatformService', () => {
+  it('passes required params to LegacyPlatformService', () => {
     const requireLegacyFiles = { requireLegacyFiles: true };
-    const useLegacyTestHarness = { useLegacyTestHarness: true };
+    const requireLegacyBootstrapModule = { requireLegacyBootstrapModule: true };
+    const requireNewPlatformShimModule = { requireNewPlatformShimModule: true };
 
     createCoreSystem({
       requireLegacyFiles,
-      useLegacyTestHarness,
+      requireLegacyBootstrapModule,
+      requireNewPlatformShimModule,
     });
 
     expect(LegacyPlatformServiceConstructor).toHaveBeenCalledTimes(1);
     expect(LegacyPlatformServiceConstructor).toHaveBeenCalledWith({
       requireLegacyFiles,
-      useLegacyTestHarness,
+      requireLegacyBootstrapModule,
+      requireNewPlatformShimModule,
     });
   });
 

diff --git a/src/core/public/core_system.ts b/src/core/public/core_system.ts
@@ -17,8 +17,6 @@
  * under the License.
  */
 
-import './core.css';
-
 import { CoreId } from '../server';
 import { PackageInfo, EnvironmentMode } from '../server/types';
 import { CoreSetup, CoreStart } from '.';
@@ -50,8 +48,9 @@ interface Params {
   rootDomElement: HTMLElement;
   browserSupportsCsp: boolean;
   injectedMetadata: InjectedMetadataParams['injectedMetadata'];
-  requireLegacyFiles: LegacyPlatformParams['requireLegacyFiles'];
-  useLegacyTestHarness?: LegacyPlatformParams['useLegacyTestHarness'];
+  requireLegacyFiles?: LegacyPlatformParams['requireLegacyFiles'];
+  requireLegacyBootstrapModule?: LegacyPlatformParams['requireLegacyBootstrapModule'];
+  requireNewPlatformShimModule?: LegacyPlatformParams['requireNewPlatformShimModule'];
 }
 
 /** @internal */
@@ -111,7 +110,8 @@ export class CoreSystem {
       browserSupportsCsp,
       injectedMetadata,
       requireLegacyFiles,
-      useLegacyTestHarness,
+      requireLegacyBootstrapModule,
+      requireNewPlatformShimModule,
     } = params;
 
     this.rootDomElement = rootDomElement;
@@ -145,7 +145,8 @@ export class CoreSystem {
 
     this.legacy = new LegacyPlatformService({
       requireLegacyFiles,
-      useLegacyTestHarness,
+      requireLegacyBootstrapModule,
+      requireNewPlatformShimModule,
     });
   }