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

Licensing plugin and XPackInfo uses the same license data #52507

Merged
merged 20 commits into from
Dec 13, 2019
Merged
Show file tree
Hide file tree
Changes from 11 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
3 changes: 3 additions & 0 deletions x-pack/legacy/common/poller.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,7 @@ export declare class Poller {
constructor(options: any);

public start(): void;
public stop(): void;
public isRunning(): boolean;
public getPollFrequency(): number;
}
3 changes: 3 additions & 0 deletions x-pack/legacy/plugins/xpack_main/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ export const xpackMain = (kibana) => {
},

uiExports: {
hacks: [
'plugins/xpack_main/hacks/check_xpack_info_change',
],
replaceInjectedVars,
injectDefaultVars(server) {
const config = server.config();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/

import { identity } from 'lodash';
import { uiModules } from 'ui/modules';
import { Path } from 'plugins/xpack_main/services/path';
import { xpackInfo } from 'plugins/xpack_main/services/xpack_info';
import { xpackInfoSignature } from 'plugins/xpack_main/services/xpack_info_signature';

const module = uiModules.get('xpack_main', []);

module.factory('checkXPackInfoChange', ($q, Private, $injector) => {
/**
* Intercept each network response to look for the kbn-xpack-sig header.
* When that header is detected, compare its value with the value cached
* in the browser storage. When the value is new, call `xpackInfo.refresh()`
* so that it will pull down the latest x-pack info
*
* @param {object} response - the angular $http response object
* @param {function} handleResponse - callback, expects to receive the response
* @return
*/
function interceptor(response, handleResponse) {
if (Path.isUnauthenticated()) {
return handleResponse(response);
}

const currentSignature = response.headers('kbn-xpack-sig');
const cachedSignature = xpackInfoSignature.get();

if (currentSignature && cachedSignature !== currentSignature) {
Copy link
Contributor Author

@mshustov mshustov Dec 10, 2019

Choose a reason for hiding this comment

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

That was removed in #51818 by mistake.
Xpack cannot detect license update without it. I also noticed that it doesn't work well with different fetching mechanism. Some plugins use NP fetch, some custom fetching mechanism, for example

We need to talk to solution teams about unifying the network stack.
@elastic/kibana-platform
Should we create a separate issue to track?

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want an issue, or should we 'just' add in our guidelines that the fetching mecanism in kibana should be core.http?

Apollo can be hard to migrate though, as it's not 'only' a fetch.

Copy link
Contributor Author

@mshustov mshustov Dec 11, 2019

Choose a reason for hiding this comment

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

It seems we need to solve several problems:

// Signature from the server differ from the signature of our
// cached info, so we need to refresh it.
// Intentionally swallowing this error
// because nothing catches it and it's an ugly console error.
xpackInfo.refresh($injector);
}

return handleResponse(response);
}

return {
response: (response) => interceptor(response, identity),
responseError: (response) => interceptor(response, $q.reject)
};
});

module.config(($httpProvider) => {
$httpProvider.interceptors.push('checkXPackInfoChange');
});
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { BehaviorSubject } from 'rxjs';
import sinon from 'sinon';
import { XPackInfo } from '../xpack_info';
import { setupXPackMain } from '../setup_xpack_main';
import * as InjectXPackInfoSignatureNS from '../inject_xpack_info_signature';


describe('setupXPackMain()', () => {
const sandbox = sinon.createSandbox();

Expand Down Expand Up @@ -39,7 +41,7 @@ describe('setupXPackMain()', () => {
elasticsearch: mockElasticsearchPlugin,
xpack_main: mockXPackMainPlugin
},
newPlatform: { setup: { plugins: { features: {} } } },
newPlatform: { setup: { plugins: { features: {}, licensing: { license$: new BehaviorSubject() } } } },
Comment on lines -42 to +44
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we have a licensingPluginMock in the licensing plugin and use it instead of inline declaration ? something like what's done in src/legacy/ui/public/new_platform/__mocks__/helpers.ts.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  1. I will add a mock for NP the plugin.
  2. This file uses Sinon instead of Jest. I don't want to provide the full mock because we are about to delete this setup completely.

events: { on() {} },
log() {},
config() {},
Expand Down
Loading