[core/ui] bootstrap the legacy platform within the new platform

src/core/public/core_system.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 global polyfills before everything else
+import 'babel-polyfill';
+import 'custom-event-polyfill';
+import 'whatwg-fetch';
+
+import { InjectedMetadata, InjectedMetadataService } from './injected_metadata';
+
+interface CoreSystemParams {
+ injectedMetadataForTesting?: InjectedMetadata;
+}
+
+export class CoreSystem {
+ private injectedMetadata: InjectedMetadataService;
+
+ constructor(params: CoreSystemParams = {}) {
+ const { injectedMetadataForTesting } = params;
+
+ this.injectedMetadata = new InjectedMetadataService(injectedMetadataForTesting);
+ }
+
+ public initLegacyPlatform(bootstrapFn: () => void) {
+ /**
+ * Injects parts of the new platform into parts of the legacy platform
+ * so that legacy APIs/modules can mimic their new platform counterparts
+ */
+ require('ui/metadata').__newPlatformInit__(this.injectedMetadata.getLegacyMetadata());
+
+ // call the legacy platform bootstrap function (bootstraps ui/chrome in apps and ui/test_harness in browser tests)
+ bootstrapFn();
+ }
+}

src/core/public/index.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 { CoreSystem } from './core_system';

src/core/public/injected_metadata/deep_freeze.ts

@@ -0,0 +1,36 @@
+/*
+ * 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.
+ */
+
+type Freezable = { [k: string]: any } | ArrayLike<any>;
+
+type RecursiveReadOnly<T> = T extends Freezable
+ ? Readonly<{ [K in keyof T]: RecursiveReadOnly<T[K]> }>
+ : T;
+
+export function deepFreeze<T extends Freezable>(object: T) {
+ // for any properties that reference an object, makes sure that object is
+ // recursively frozen as well
+ for (const value of Object.values(object)) {
+ if (value !== null && typeof value === 'object') {
+ deepFreeze(value);
+ }
+ }
+
+ return Object.freeze(object) as RecursiveReadOnly<T>;
+}

src/core/public/injected_metadata/index.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 { InjectedMetadata, InjectedMetadataService } from './injected_metadata_service';

src/ui/ui_bundles/__tests__/app_entry_template.js → src/core/public/injected_metadata/injected_metadata_service.ts

@@ -17,33 +17,23 @@
  * under the License.
  */
 
-import sinon from 'sinon';
-import expect from 'expect.js';
+import { deepFreeze } from './deep_freeze';
+import { readInjectedMetadataFromDom } from './read_injected_metadata_from_dom';
 
-import { appEntryTemplate } from '../app_entry_template';
-
-function createMockBundle() {
- return {
- getContext: sinon.stub().returns(''),
- getRequires: sinon.stub().returns([])
+export interface InjectedState {
+ legacyMetadata: {
+ [key: string]: any;
  };
 }
 
-describe('ui bundles / appEntryTemplate', () => {
- it('embeds bundle.getContext() result', () => {
- const bundle = createMockBundle();
-  bundle.getContext.returns('foo bar baz');
- expect(appEntryTemplate(bundle)).to.contain('foo bar baz');
- });
+export class InjectedStateService {
+ private state: InjectedState;
+
+ constructor(injectedStateForTesting?: InjectedState) {
+ this.state = deepFreeze(injectedStateForTesting || readInjectedMetadataFromDom());
+ }
 
- it('joins requires into list', () => {
- const bundle = createMockBundle();
- const requires = [
- 'foo',
- 'bar',
- 'baz'
- ];
- bundle.getRequires.returns(requires);
- expect(appEntryTemplate(bundle)).to.contain(requires.join('\n'));
- });
-});
+ public getLegacyMetadata() {
+ return this.state.legacyMetadata;
+ }
+}

src/core/public/injected_metadata/read_injected_metadata_from_dom.ts

@@ -0,0 +1,33 @@
+/*
+ * 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 function readInjectedMetadataFromDom() {
+ const el = document.querySelector('kbn-injected-metadata');
+
+ if (!el) {
+ throw new Error('unable to find <kbn-injected-metadata> element');
+ }
+
+ const json = el.getAttribute('data');
+ if (!json) {
+ throw new Error('<kbn-injected-metadata> does not have a data atttibute');
+ }
+
+ return JSON.parse(json);
+}

src/core_plugins/tests_bundle/index.js

@@ -17,8 +17,6 @@
  * under the License.
  */
 
-import { union } from 'lodash';
-
 import { fromRoot } from '../../utils';
 
 import findSourceFiles from './find_source_files';
@@ -36,7 +34,7 @@ export default (kibana) => {
 
  uiExports: {
  async __bundleProvider__(kbnServer) {
- let modules = [];
+ const modules = [];
 
  const {
  config,
@@ -66,8 +64,8 @@ export default (kibana) => {
 
  // add the modules from all of this plugins apps
  for (const app of uiApps) {
- if (app.getPluginId() === pluginId) {
- modules = union(modules, app.getModules());
+ if (app.getPluginId() === pluginId && !modules.includes(app.getMainModuleId())) {
+ modules.push(app.getMainModuleId());
  }
  }
 
@@ -76,7 +74,9 @@ export default (kibana) => {
  } else {
  // add the modules from all of the apps
  for (const app of uiApps) {
- modules = union(modules, app.getModules());
+ if (!modules.includes(app.getMainModuleId())) {
+ modules.push(app.getMainModuleId());
+ }
  }
 
  for (const plugin of plugins) {

src/core_plugins/tests_bundle/tests_entry_template.js

@@ -29,7 +29,9 @@ export const createTestEntryTemplate = (defaultUiSettings) => (bundle) => `
  *
  */
 
-window.__KBN__ = {
+import { CoreSystem } from '__kibanaCore__'
+
+const legacyMetadata = {
  version: '1.2.3',
  buildNum: 1234,
  vars: {
@@ -64,7 +66,13 @@ window.__KBN__ = {
  }
 };
 
-require('ui/test_harness');
-${bundle.getRequires().join('\n')}
-require('ui/test_harness').bootstrap(/* go! */);
+new CoreSystem({
+ injectedMetadataForTesting: {
+ legacyMetadata
+ }
+}).initLegacyPlatform(() => {
+ require('ui/test_harness');
+ ${bundle.getRequires().join('\n ')}
+ require('ui/test_harness').bootstrap();
+})
 `;

src/optimize/index.js

@@ -42,12 +42,6 @@ export default async (kbnServer, server, config) => {
  basePublicPath: config.get('server.basePath')
  }));
 
- await uiBundles.writeEntryFiles();
-
- // Not all entry files produce a css asset. Ensuring they exist prevents
- // an error from occurring when the file is missing.
- await uiBundles.ensureStyleFiles();
-
  // in prod, only bundle when something is missing or invalid
  const reuseCache = config.get('optimize.useBundleCache')
  ? await uiBundles.areAllBundleCachesValid()
@@ -62,6 +56,8 @@ export default async (kbnServer, server, config) => {
  return;
  }
 
+ await uiBundles.resetBundleDir();
+
  // only require the FsOptimizer when we need to
  const optimizer = new FsOptimizer({
  uiBundles,

src/optimize/watch/watch_optimizer.js

@@ -45,10 +45,7 @@ export default class WatchOptimizer extends BaseOptimizer {
 
  // log status changes
  this.status$.subscribe(this.onStatusChangeHandler);
-
- await this.uiBundles.writeEntryFiles();
- await this.uiBundles.ensureStyleFiles();
-
+ await this.uiBundles.resetBundleDir();
  await this.initCompiler();
 
  this.compiler.plugin('watch-run', this.compilerRunStartHandler);

src/ui/__tests__/ui_exports_replace_injected_vars.js

@@ -29,7 +29,7 @@ import KbnServer from '../../server/kbn_server';
 
 const getInjectedVarsFromResponse = (resp) => {
  const $ = cheerio.load(resp.payload);
- const data = $('kbn-initial-state').attr('data');
+ const data = $('kbn-injected-metadata').attr('data');
  return JSON.parse(data).vars;
 };
 

src/ui/public/chrome/chrome.js

@@ -21,9 +21,6 @@ import _ from 'lodash';
 import angular from 'angular';
 
 import { metadata } from '../metadata';
-import 'babel-polyfill';
-import 'whatwg-fetch';
-import 'custom-event-polyfill';
 import '../state_management/global_state';
 import '../config';
 import '../notify';

src/ui/public/metadata.js

@@ -17,29 +17,12 @@
  * under the License.
  */
 
-import $ from 'jquery';
-import _ from 'lodash';
+export let metadata = null;
 
-export const metadata = deepFreeze(getState());
-
-function deepFreeze(object) {
- // for any properties that reference an object, makes sure that object is
- // recursively frozen as well
- Object.keys(object).forEach(key => {
- const value = object[key];
- if (_.isObject(value)) {
- deepFreeze(value);
- }
- });
-
- return Object.freeze(object);
-}
-
-function getState() {
- const stateKey = '__KBN__';
- if (!(stateKey in window)) {
- const state = $('kbn-initial-state').attr('data');
- window[stateKey] = JSON.parse(state);
+export function __newPlatformInit__(legacyMetadata) {
+ if (metadata === null) {
+ metadata = legacyMetadata;
+ } else {
+ throw new Error('ui/metadata can only be initialized once');
  }
- return window[stateKey];
 }

src/ui/public/test_harness/index.js

@@ -17,6 +17,4 @@
  * under the License.
  */
 
-import './test_harness';
-
 export { bootstrap } from './test_harness';