[uiApp] replace uiApp.injectVars with server.injectUiAppVars() (#17485)

* [uiApp] replace uiApp.injectVars with server.injectUiAppVars() * [server/injectUiAppVars] cleanup styling * [server/injectUiAppVars] add test to verify injectUiAppVars merging * [server/injectUiAppVars] describe what type of id we expect * [uiExportTypes/uiApp] add removal error to proper location * [uiApps/tests] avoid snapshots for undefined/{} values
elastic · Apr 6, 2018 · 1ecddb4 · 1ecddb4
1 parent 3a29e18
commit 1ecddb4
Show file tree

Hide file tree

Showing 11 changed files with 244 additions and 96 deletions.
diff --git a/src/core_plugins/kibana/index.js b/src/core_plugins/kibana/index.js
@@ -64,7 +64,6 @@ export default function (kibana) {
           'docViews',
           'embeddableFactories',
         ],
-        injectVars,
       },
 
       links: [
@@ -155,8 +154,7 @@ export default function (kibana) {
       registerTutorials(server);
       server.expose('systemApi', systemApi);
       server.expose('handleEsError', handleEsError);
-      server.expose('injectVars', injectVars);
-
+      server.injectUiAppVars('kibana', () => injectVars(server));
     }
   });
 }
diff --git a/src/core_plugins/timelion/index.js b/src/core_plugins/timelion/index.js
@@ -8,14 +8,6 @@ export default function (kibana) {
         description: 'Time series expressions for everything',
         icon: 'plugins/timelion/icon.svg',
         main: 'plugins/timelion/app',
-        injectVars: function (server) {
-          const config = server.config();
-          return {
-            kbnIndex: config.get('kibana.index'),
-            esShardTimeout: config.get('elasticsearch.shardTimeout'),
-            esApiVersion: config.get('elasticsearch.apiVersion')
-          };
-        },
         uses: [
           'fieldFormats',
           'savedObjectTypes'

diff --git a/src/core_plugins/timelion/init.js b/src/core_plugins/timelion/init.js
@@ -24,5 +24,12 @@ export default function (server) {
     getFunction: getFunction
   };
 
-
+  server.injectUiAppVars('timelion', () => {
+    const config = server.config();
+    return {
+      kbnIndex: config.get('kibana.index'),
+      esShardTimeout: config.get('elasticsearch.shardTimeout'),
+      esApiVersion: config.get('elasticsearch.apiVersion')
+    };
+  });
 }
diff --git a/src/ui/__tests__/fixtures/test_app/index.js b/src/ui/__tests__/fixtures/test_app/index.js
@@ -3,17 +3,17 @@ export default kibana => new kibana.Plugin({
     app: {
       name: 'test_app',
       main: 'plugins/test_app/index.js',
-      injectVars() {
-        return {
-          from_test_app: true
-        };
-      }
     },
 
     injectDefaultVars() {
       return {
         from_defaults: true
       };
     }
+  },
+  init(server) {
+    server.injectUiAppVars('test_app', () => ({
+      from_test_app: true
+    }));
   }
 });
diff --git a/src/ui/ui_apps/__snapshots__/ui_apps_mixin.test.js.snap b/src/ui/ui_apps/__snapshots__/ui_apps_mixin.test.js.snap
@@ -0,0 +1,92 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`UiAppsMixin creates kbnServer.uiApps from uiExports 1`] = `
+Array [
+  StubUiApp {
+    "_hidden": true,
+    "_id": "foo",
+  },
+  StubUiApp {
+    "_hidden": false,
+    "_id": "bar",
+  },
+]
+`;
+
+exports[`UiAppsMixin decorates server with methods 1`] = `
+Array [
+  Array [
+    "server",
+    "getAllUiApps",
+    [Function],
+  ],
+  Array [
+    "server",
+    "getUiAppById",
+    [Function],
+  ],
+  Array [
+    "server",
+    "getHiddenUiAppById",
+    [Function],
+  ],
+  Array [
+    "server",
+    "injectUiAppVars",
+    [Function],
+  ],
+  Array [
+    "server",
+    "getInjectedUiAppVars",
+    [Function],
+  ],
+]
+`;
+
+exports[`UiAppsMixin server.getAllUiApps() returns hidden and non-hidden apps 1`] = `
+Array [
+  StubUiApp {
+    "_hidden": true,
+    "_id": "foo",
+  },
+  StubUiApp {
+    "_hidden": false,
+    "_id": "bar",
+  },
+]
+`;
+
+exports[`UiAppsMixin server.getHiddenUiAppById() returns hidden apps when requested, undefined for non-hidden and unknown apps 1`] = `
+StubUiApp {
+  "_hidden": true,
+  "_id": "foo",
+}
+`;
+
+exports[`UiAppsMixin server.getUiAppById() returns non-hidden apps when requested, undefined for non-hidden and unknown apps 1`] = `
+StubUiApp {
+  "_hidden": false,
+  "_id": "bar",
+}
+`;
+
+exports[`UiAppsMixin server.injectUiAppVars()/server.getInjectedUiAppVars() merges injected vars provided by multiple providers in the order they are registered: foo 1`] = `
+Object {
+  "bar": false,
+  "baz": 1,
+  "box": true,
+  "foo": true,
+}
+`;
+
+exports[`UiAppsMixin server.injectUiAppVars()/server.getInjectedUiAppVars() stored injectVars provider and returns provider result when requested: bar 1`] = `
+Object {
+  "thisIsFoo": false,
+}
+`;
+
+exports[`UiAppsMixin server.injectUiAppVars()/server.getInjectedUiAppVars() stored injectVars provider and returns provider result when requested: foo 1`] = `
+Object {
+  "thisIsFoo": true,
+}
+`;
diff --git a/src/ui/ui_apps/__tests__/ui_app.js b/src/ui/ui_apps/__tests__/ui_app.js
@@ -23,9 +23,6 @@ function createStubUiAppSpec(extraParams) {
       'chromeNavControls',
       'hacks',
     ],
-    injectVars() {
-      return { foo: 'bar' };
-    },
     ...extraParams
   };
 }
@@ -84,10 +81,6 @@ describe('ui apps / UiApp', () => {
         expect(app.getNavLink()).to.be.a(UiNavLink);
       });
 
-      it('has no injected vars', () => {
-        expect(app.getInjectedVars()).to.be(undefined);
-      });
-
       it('has an empty modules list', () => {
         expect(app.getModules()).to.eql([]);
       });
@@ -133,10 +126,6 @@ describe('ui apps / UiApp', () => {
         expect(app.getNavLink()).to.be(undefined);
       });
 
-      it('has injected vars', () => {
-        expect(app.getInjectedVars()).to.eql({ foo: 'bar' });
-      });
-
       it('includes main and hack modules', () => {
         expect(app.getModules()).to.eql([
           'main.js',
@@ -295,49 +284,6 @@ describe('ui apps / UiApp', () => {
   });
 
   describe('pluginId', () => {
-    describe('not specified', () => {
-      it('passes the root server and undefined for plugin/optoins to injectVars()', () => {
-        const injectVars = sinon.stub();
-        const kbnServer = createStubKbnServer();
-        createUiApp(createStubUiAppSpec({ injectVars }), kbnServer).getInjectedVars();
-
-        sinon.assert.calledOnce(injectVars);
-        sinon.assert.calledOn(injectVars, sinon.match.same(undefined));
-        sinon.assert.calledWithExactly(
-          injectVars,
-          // server arg, uses root server because there is no plugin
-          sinon.match.same(kbnServer.server),
-          // options is undefined because there is no plugin
-          sinon.match.same(undefined)
-        );
-      });
-    });
-    describe('matches a kbnServer plugin', () => {
-      it('passes the plugin/server/options from the plugin to injectVars()', () => {
-        const server = {};
-        const options = {};
-        const plugin = {
-          id: 'test plugin id',
-          getServer() {
-            return server;
-          },
-          getOptions() {
-            return options;
-          }
-        };
-
-        const kbnServer = createStubKbnServer();
-        kbnServer.plugins.push(plugin);
-
-        const injectVars = sinon.stub();
-        const spec = createStubUiAppSpec({ pluginId: plugin.id, injectVars });
-        createUiApp(spec, kbnServer).getInjectedVars();
-
-        sinon.assert.calledOnce(injectVars);
-        sinon.assert.calledOn(injectVars, sinon.match.same(plugin));
-        sinon.assert.calledWithExactly(injectVars, sinon.match.same(server), sinon.match.same(options));
-      });
-    });
     describe('does not match a kbnServer plugin', () => {
       it('throws an error at instantiation', () => {
         expect(() => {

diff --git a/src/ui/ui_apps/ui_app.js b/src/ui/ui_apps/ui_app.js
@@ -13,7 +13,6 @@ export class UiApp {
       hidden,
       linkToLastSubUrl,
       listed,
-      injectVars,
       url = `/app/${id}`,
       uses = []
     } = spec;
@@ -32,7 +31,6 @@ export class UiApp {
     this._hidden = hidden;
     this._listed = listed;
     this._url = url;
-    this._injectedVarsProvider = injectVars;
     this._pluginId = pluginId;
     this._kbnServer = kbnServer;
 
@@ -94,25 +92,6 @@ export class UiApp {
     }
   }
 
-  getInjectedVars() {
-    const provider = this._injectedVarsProvider;
-    const plugin = this._getPlugin();
-
-    if (!provider) {
-      return;
-    }
-
-    return provider.call(
-      plugin,
-      plugin
-        ? plugin.getServer()
-        : this._kbnServer.server,
-      plugin
-        ? plugin.getOptions()
-        : undefined
-    );
-  }
-
   getModules() {
     return this._modules;
   }

diff --git a/src/ui/ui_apps/ui_apps_mixin.js b/src/ui/ui_apps/ui_apps_mixin.js
@@ -29,4 +29,18 @@ export function uiAppsMixin(kbnServer, server) {
   server.decorate('server', 'getAllUiApps', () => kbnServer.uiApps.slice(0));
   server.decorate('server', 'getUiAppById', id => appsById.get(id));
   server.decorate('server', 'getHiddenUiAppById', id => hiddenAppsById.get(id));
+
+  const injectedVarProviders = [];
+  server.decorate('server', 'injectUiAppVars', (appId, provider) => {
+    injectedVarProviders.push({ appId, provider });
+  });
+
+  server.decorate('server', 'getInjectedUiAppVars', async (appId) => {
+    return await injectedVarProviders
+      .filter(p => p.appId === appId)
+      .reduce(async (acc, { provider }) => ({
+        ...await acc,
+        ...await provider(server)
+      }), {});
+  });
 }