Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a method for plugins to add injected vars to every app #9071

Merged
merged 8 commits into from
Nov 18, 2016
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@
"image-diff": "1.6.0",
"intern": "3.2.3",
"istanbul-instrumenter-loader": "0.1.3",
"jsdom": "9.8.3",
"karma": "1.2.0",
"karma-chrome-launcher": "0.2.0",
"karma-coverage": "0.5.1",
Expand Down
2 changes: 1 addition & 1 deletion src/server/status/states.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ exports.all = [
severity: -1,
icon: 'toggle-off',
nicknames: [
'I\'m I even a thing?'
'Am I even a thing?'
]
}
];
Expand Down
13 changes: 13 additions & 0 deletions src/ui/__tests__/fixtures/test_app/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module.exports = kibana => new kibana.Plugin({
uiExports: {
app: {
name: 'test_app',
main: 'plugins/test_app/index.js',
injectVars() {
return {
from_test_app: true
};
}
}
}
});
4 changes: 4 additions & 0 deletions src/ui/__tests__/fixtures/test_app/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"name": "test_app",
"version": "kibana"
}
Empty file.
125 changes: 125 additions & 0 deletions src/ui/__tests__/ui_exports_replace_injected_vars.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
import { resolve } from 'path';

import { delay } from 'bluebird';
import expect from 'expect.js';
import sinon from 'sinon';
import jsdom from 'jsdom';
import { noop } from 'lodash';

import KbnServer from '../../server/kbn_server';

const getInjectedVarsFromResponse = (resp) => {
const document = jsdom.jsdom(resp.payload);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't you just use jquery to do the css selection and read the data from the DOM here? And if not, wouldn't something like cheerio be a lighter solution for it?

Copy link
Contributor Author

@spalger spalger Nov 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These tests are run in node, so jQuery isn't an option. cheerio looks perfect

const data = document.querySelector('kbn-initial-state').getAttribute('data');
return JSON.parse(data).vars;
};

const injectReplacer = (kbnServer, replacer) => {
// normally the replacer would be defined in a plugin's uiExports,
// but that requires stubbing out an entire plugin directory for
// each test, so we fake it and jam the replacer into uiExports
kbnServer.uiExports.injectedVarsReplacers.push(replacer);
};

describe('UiExports', function () {
describe('#replaceInjectedVars', function () {
this.slow(2000);
this.timeout(10000);

let kbnServer;
beforeEach(async () => {
kbnServer = new KbnServer({
server: { port: 0 }, // pick a random open port
logging: { silent: true }, // no logs
optimize: { enabled: false },
uiSettings: { enabled: false },
plugins: {
paths: [resolve(__dirname, './fixtures/test_app')] // inject an app so we can hit /app/{id}
},
});

await kbnServer.ready();
kbnServer.status.get('ui settings').state = 'green';
kbnServer.server.decorate('server', 'uiSettings', () => {
return { getDefaults: noop };
});
});

afterEach(async () => {
await kbnServer.close();
kbnServer = null;
});

it('allows sync replacing of injected vars', async () => {
injectReplacer(kbnServer, () => ({ a: 1 }));

const resp = await kbnServer.inject('/app/test_app');
const injectedVars = getInjectedVarsFromResponse(resp);

expect(injectedVars).to.eql({ a: 1 });
});

it('allows async replacing of injected vars', async () => {
const asyncThing = () => delay(100).return('world');

injectReplacer(kbnServer, async () => {
return {
hello: await asyncThing()
};
});

const resp = await kbnServer.inject('/app/test_app');
const injectedVars = getInjectedVarsFromResponse(resp);

expect(injectedVars).to.eql({
hello: 'world'
});
});

it('passes originalInjectedVars, request, and server to replacer', async () => {
const stub = sinon.stub();
injectReplacer(kbnServer, () => ({ foo: 'bar' }));
injectReplacer(kbnServer, stub);

await kbnServer.inject('/app/test_app');

sinon.assert.calledOnce(stub);
expect(stub.firstCall.args[0]).to.eql({ foo: 'bar' }); // originalInjectedVars
expect(stub.firstCall.args[1]).to.have.property('path', '/app/test_app'); // request
expect(stub.firstCall.args[1]).to.have.property('server', kbnServer.server); // request
expect(stub.firstCall.args[2]).to.be(kbnServer.server);
});

it('calls the methods sequentially', async () => {
injectReplacer(kbnServer, () => ({ name: '' }));
injectReplacer(kbnServer, orig => ({ name: orig.name + 's' }));
injectReplacer(kbnServer, orig => ({ name: orig.name + 'a' }));
injectReplacer(kbnServer, orig => ({ name: orig.name + 'm' }));

const resp = await kbnServer.inject('/app/test_app');
const injectedVars = getInjectedVarsFromResponse(resp);

expect(injectedVars).to.eql({ name: 'sam' });
});

it('propogates errors thrown in replacers', async () => {
injectReplacer(kbnServer, async () => {
await delay(100);
throw new Error('replacer failed');
});

const resp = await kbnServer.inject('/app/test_app');
expect(resp).to.have.property('statusCode', 500);
});

it('starts off with the injected vars for the app merged with the default injected vars', async () => {
const stub = sinon.stub();
injectReplacer(kbnServer, stub);
kbnServer.uiExports.defaultInjectedVars.from_defaults = true;

const resp = await kbnServer.inject('/app/test_app');
sinon.assert.calledOnce(stub);
expect(stub.firstCall.args[0]).to.eql({ from_defaults: true, from_test_app: true });
});
});
});
31 changes: 21 additions & 10 deletions src/ui/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { format as formatUrl } from 'url';
import { readFileSync as readFile } from 'fs';
import { defaults } from 'lodash';
import Boom from 'boom';
import { reduce as reduceAsync } from 'bluebird';
import { resolve } from 'path';
import fromRoot from '../utils/from_root';
import UiExports from './ui_exports';
Expand Down Expand Up @@ -47,15 +48,19 @@ export default async (kbnServer, server, config) => {
server.route({
path: '/app/{id}',
method: 'GET',
handler: function (req, reply) {
async handler(req, reply) {
const id = req.params.id;
const app = uiExports.apps.byId[id];
if (!app) return reply(Boom.notFound('Unknown app ' + id));

if (kbnServer.status.isGreen()) {
return reply.renderApp(app);
} else {
return reply.renderStatusPage();
try {
if (kbnServer.status.isGreen()) {
await reply.renderApp(app);
} else {
await reply.renderStatusPage();
}
} catch (err) {
reply(Boom.wrap(err));
}
}
});
Expand All @@ -74,7 +79,11 @@ export default async (kbnServer, server, config) => {
defaults: await server.uiSettings().getDefaults(),
user: {}
},
vars: defaults(app.getInjectedVars() || {}, uiExports.defaultInjectedVars),
vars: await reduceAsync(
uiExports.injectedVarsReplacers,
(acc, extender) => extender(acc, this.request, server),
defaults(await app.getInjectedVars() || {}, uiExports.defaultInjectedVars)
)
};
}

Expand All @@ -88,16 +97,18 @@ export default async (kbnServer, server, config) => {
}

async function renderApp(app) {
const isElasticsearchPluginRed = server.plugins.elasticsearch.status.state === 'red';
const payload = await getPayload(app);
if (!isElasticsearchPluginRed) {
const payload = await getPayload.call(this, app);

const esStatus = kbnServer.status.getForPluginId('elasticsearch');
if (esStatus && esStatus.state !== 'red') {
payload.uiSettings.user = await server.uiSettings().getUserProvided();
}

return viewAppWithPayload.call(this, app, payload);
}

async function renderAppWithDefaultConfig(app) {
const payload = await getPayload(app);
const payload = await getPayload.call(this, app);
return viewAppWithPayload.call(this, app, payload);
}

Expand Down
6 changes: 6 additions & 0 deletions src/ui/ui_exports.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ class UiExports {
this.consumers = [];
this.bundleProviders = [];
this.defaultInjectedVars = {};
this.injectedVarsReplacers = [];
}

consumePlugin(plugin) {
Expand Down Expand Up @@ -107,6 +108,11 @@ class UiExports {
_.merge(this.defaultInjectedVars, await injector.call(plugin, server, options));
});
};

case 'replaceInjectedVars':
return (plugin, extender) => {
this.injectedVarsReplacers.push(extender);
};
}
}

Expand Down