Add x-pack plugin for new platform browser licensing information #44922

eliperelman · 2019-09-05T18:24:17Z

Summary

Add x-pack plugin for new platform client licensing information. This will eventually replace the licensing information consumed via xpack_main.

Also fixes #44560

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~This was checked for cross-browser compatibility, including a check against IE11~~
Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
~~This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

Dev Docs

Add x-pack plugin for new platform public licensing information. This will eventually replace the licensing information consumed via xpack_main. Upon setup, this plugin exposes an observable API for inspecting and making checks against the license information.

license$.subscribe(license => {
   console.log(license.uid);
   console.log(license.isActive);
   console.log(license.type);

   const { state } = license.check('my-plugin', LICENSE_TYPE.gold);

   if (state !== LICENSE_STATUS.Valid) {
     disableSomething();
   }
});

elasticmachine · 2019-09-05T18:24:19Z

Pinging @elastic/kibana-platform

elasticmachine · 2019-09-05T19:46:51Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

joshdover

Some initial things I noticed. Still need to dig into actual behavior to verify correctness.

x-pack/plugins/licensing/common/license.ts

x-pack/plugins/licensing/server/license.test.ts

x-pack/plugins/licensing/public/plugin.ts

x-pack/plugins/licensing/server/license_feature.test.ts

mshustov

are we okay provide not backward compatible interface? if yes we can cleanup some other interfaces as well

x-pack/plugins/licensing/server/plugin.ts

x-pack/plugins/licensing/common/license.ts

x-pack/plugins/licensing/common/has_license_info_changed.ts

x-pack/plugins/licensing/server/licensing_config.ts

x-pack/plugins/licensing/public/license.test.ts

x-pack/plugins/licensing/public/plugin.ts

x-pack/plugins/licensing/common/license.ts

eliperelman · 2019-09-27T18:11:11Z

are we okay provide not backward compatible interface? if yes we can cleanup some other interfaces as well

#43376.

elasticmachine · 2019-09-27T18:11:27Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-09-27T20:49:40Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-10-01T17:54:36Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-10-02T18:06:32Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-10-14T18:39:05Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: aa320ec952e3ae970f178e88fbf743821024500a

elasticmachine · 2019-10-15T20:14:11Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: a72414232ff0b229df58dd9ca9c54ce9ff1897ef

elasticmachine · 2019-10-16T16:31:43Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: de94fe11ea04990b016f4713d3b78ace8c7af3da

…ient

elasticmachine · 2019-10-17T18:07:24Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: a4678bc

elasticmachine · 2019-10-18T17:52:32Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 9f7892d

mshustov · 2019-10-21T08:06:43Z

x-pack/plugins/licensing/server/plugin.ts

-          clusterSource,
-          pollingFrequency
+      try {
+        const cluster = await this.elasticsearch.dataClient$.pipe(first()).toPromise();


plugin config specified clusterSource, but plugin always uses data client.
also legacy config doesn't allow to specify client name

kibana/x-pack/legacy/plugins/xpack_main/index.js

Line 44 in 60c596c

xpack_api_polling_frequency_millis: Joi.number().default(XPACK_INFO_API_DEFAULT_POLL_FREQUENCY_IN_MILLIS),

mshustov · 2019-10-21T10:19:54Z

x-pack/plugins/licensing/server/plugin.ts

+        const cluster = await this.elasticsearch.dataClient$.pipe(first()).toPromise();
+        const response = await cluster.callAsInternalUser('transport.request', {
+          method: 'GET',
+          path: '/_xpack',


/_xpack is deprecated and will be removed in v8.elastic/elasticsearch#35958
we should switch to /_license

mshustov · 2019-10-21T10:34:22Z

x-pack/plugins/licensing/server/plugin.ts

+          method: 'GET',
+          path: '/_xpack',
+        });
+        const rawLicense = response && response.license;


Is it a real case when the server responds with empty data?
As I can see ES returns "Not Found" error if a user has no license https://github.com/elastic/elasticsearch/blob/master/x-pack/plugin/core/src/main/java/org/elasticsearch/license/RestGetLicenseAction.java#L76

mshustov · 2019-10-21T13:13:39Z

x-pack/plugins/licensing/server/plugin.ts

+  /**
+   * Used to trigger manual fetches of the license information from the server.
+   */
+  private refresher$ = new BehaviorSubject(true);


not connected.

mshustov · 2019-10-21T13:20:42Z

x-pack/plugins/licensing/server/plugin.ts

+/**
+ * Generate the signature for a serialized/stringified license.
+ */
+function sign(serialized: string) {


should be provided as a part of plugin API

mshustov · 2019-10-21T14:35:07Z

x-pack/plugins/licensing/public/plugin.ts

+    );
+    const setup = {
+      refresh: () => this.refresher$.next(true),
+      license$: initial$,


new subscriber causes a data refetch

mshustov · 2019-10-25T18:09:43Z

superseded by #49345

eliperelman added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:New Platform release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. v8.0.0 v7.5.0 labels Sep 5, 2019

eliperelman requested a review from a team September 5, 2019 18:24

eliperelman self-assigned this Sep 5, 2019

eliperelman force-pushed the licensing-plugin-client branch from 80988dd to 958be47 Compare September 5, 2019 18:26

joshdover reviewed Sep 5, 2019

View reviewed changes

mshustov reviewed Sep 9, 2019

View reviewed changes

eliperelman force-pushed the licensing-plugin-client branch from 958be47 to 3034061 Compare September 27, 2019 19:28

eliperelman force-pushed the licensing-plugin-client branch from 3034061 to 970da28 Compare October 1, 2019 16:39

eliperelman force-pushed the licensing-plugin-client branch from 970da28 to e54f5f6 Compare October 2, 2019 16:55

eliperelman force-pushed the licensing-plugin-client branch from e54f5f6 to 8ffe6b7 Compare October 3, 2019 20:25

joshdover requested review from a team as code owners October 3, 2019 20:25

joshdover requested a review from a team October 3, 2019 20:25

joshdover requested review from a team as code owners October 3, 2019 20:25

eliperelman force-pushed the licensing-plugin-client branch from a724142 to de94fe1 Compare October 16, 2019 15:43

eliperelman added 14 commits October 17, 2019 11:44

Add x-pack plugin for new platform browser licensing information

6e96f55

Address next round of reviews

8d088cb

Remove poller functionality in favor of inline observables

d0814c1

More observable changes from review comments

d43abcf

Fix outstanding tests

fe3a08d

More changes from review, adding additional testing

258ce8d

Add additional tests for license comparisons and sessions

0443de0

Update test snapshot due to sessionstorage mock

6f30fec

Next round of review feedback from restrry

3f3210e

Fix more review requests from restrry, add additional tests

86983f8

Pass correct sign mock to license info changed test

9d20c1f

Improve doc comments, switch to I-interface pattern

1cb0900

Test error polling sanity, do not expose signature, do not poll on cl…

84df2a8

…ient

Fix type check issues from rebase

a4678bc

eliperelman force-pushed the licensing-plugin-client branch from de94fe1 to a4678bc Compare October 17, 2019 17:04

Fix build error from rebase

9f7892d

mshustov reviewed Oct 21, 2019

View reviewed changes

joshdover mentioned this pull request Oct 23, 2019

[Graph] Shim plugin #47469

Merged

mshustov mentioned this pull request Oct 25, 2019

Licensing plugin #49345

Merged

3 tasks

mshustov closed this Oct 25, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add x-pack plugin for new platform browser licensing information #44922

Add x-pack plugin for new platform browser licensing information #44922

eliperelman commented Sep 5, 2019 •

edited by rudolf

Loading

elasticmachine commented Sep 5, 2019

elasticmachine commented Sep 5, 2019

joshdover left a comment

mshustov left a comment

eliperelman commented Sep 27, 2019

elasticmachine commented Sep 27, 2019

elasticmachine commented Sep 27, 2019

elasticmachine commented Oct 1, 2019

elasticmachine commented Oct 2, 2019

elasticmachine commented Oct 14, 2019

elasticmachine commented Oct 15, 2019

elasticmachine commented Oct 16, 2019

elasticmachine commented Oct 17, 2019

elasticmachine commented Oct 18, 2019

mshustov Oct 21, 2019

mshustov Oct 21, 2019

mshustov Oct 21, 2019

mshustov Oct 21, 2019

mshustov Oct 21, 2019

mshustov Oct 21, 2019

mshustov commented Oct 25, 2019 •

edited

Loading

Add x-pack plugin for new platform browser licensing information #44922

Add x-pack plugin for new platform browser licensing information #44922

Conversation

eliperelman commented Sep 5, 2019 • edited by rudolf Loading

Summary

Checklist

For maintainers

Dev Docs

elasticmachine commented Sep 5, 2019

elasticmachine commented Sep 5, 2019

💚 Build Succeeded

joshdover left a comment

Choose a reason for hiding this comment

mshustov left a comment

Choose a reason for hiding this comment

eliperelman commented Sep 27, 2019

elasticmachine commented Sep 27, 2019

💔 Build Failed

elasticmachine commented Sep 27, 2019

💚 Build Succeeded

elasticmachine commented Oct 1, 2019

💔 Build Failed

elasticmachine commented Oct 2, 2019

💔 Build Failed

elasticmachine commented Oct 14, 2019

💚 Build Succeeded

elasticmachine commented Oct 15, 2019

💚 Build Succeeded

elasticmachine commented Oct 16, 2019

💔 Build Failed

elasticmachine commented Oct 17, 2019

💔 Build Failed

elasticmachine commented Oct 18, 2019

💔 Build Failed

mshustov Oct 21, 2019

Choose a reason for hiding this comment

mshustov Oct 21, 2019

Choose a reason for hiding this comment

mshustov Oct 21, 2019

Choose a reason for hiding this comment

mshustov Oct 21, 2019

Choose a reason for hiding this comment

mshustov Oct 21, 2019

Choose a reason for hiding this comment

mshustov Oct 21, 2019

Choose a reason for hiding this comment

mshustov commented Oct 25, 2019 • edited Loading

eliperelman commented Sep 5, 2019 •

edited by rudolf

Loading

mshustov commented Oct 25, 2019 •

edited

Loading