Licensing plugin #49345

mshustov · 2019-10-25T14:43:47Z

Summary

This work is based on #44922
I have several things to discuss, but we can implement them in follow-ups.

The main differences from the LP implementation:

state

That's the main question for me.
LP: The plugin allows consumers to calculate state on license change event and store this state within the license plugin.

kibana/x-pack/legacy/plugins/xpack_main/server/lib/xpack_info.js

Line 280 in 60c596c

this._cache.json.features[feature] = licenseChecker(this);

Later this state was passed to the client-side.
The signature calculation is based on this state + license content
NP: According to https://github.com/elastic/kibana/pull/44922/files#diff-d2c03a616ca4d2ea0b8c58f8a58e2c82 The licensing plugin does not store the state of the other plugins anymore. The licensing plugin emits a new license and other plugins have to react on the new state to enable/disable their API.
The license signature depends on the license object content only.
@epixa that design decision was discussed?

Network request failures

LP: The licensing plugin didn’t emit a license in case of network errors.
NP: Emits the license even if the request failed. Although I want to discuss how we going to handle this case.
Right now errors are ignored when creating a signature and not passed to the client.
I'd suggest to include error info in the signature. We'd have a consistent way to identify each license and can simplify this check to a string comparison https://github.com/elastic/kibana/pull/49345/files#diff-f5b81632d6d3326e85664175179e8664

clusterSource

LP: Allows specifying cluster source to perform polling. Monitoring uses this functionality plugin

kibana/x-pack/legacy/plugins/monitoring/server/init_monitoring_xpack_info.js

Line 16 in 60c596c

clusterSource: 'monitoring',

NP: The plugin always uses data client. If we want to support the case for monitoring we can expose already existing functionality https://github.com/elastic/kibana/pull/49345/files#diff-6cafae74a549dc892111f589f7faa6a7R74

Initial value on the client

LP: Passed on the page via inlined xpackInitialInfo
NP: Should be fetched

Config

LP: xpack.xpack_main.xpack_api_polling_frequency_millis
NP: xpack.licensing.pollingFrequency

License

NP: mode field not provided anymore

sessionStorage

LP: License and signature were stored under different keys in session storage
NP: License and signature were stored under one key xpack.licensing

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();
   }
});

…ient

elasticmachine · 2019-10-25T14:43:50Z

Pinging @elastic/kibana-platform (Team:Platform)

mshustov · 2019-10-25T15:20:43Z

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

+
+      return new License({
+        license: normalizedLicense,
+        features: response.features,


should we normalize features? we have the next logic
on the client:

kibana/x-pack/legacy/plugins/xpack_main/public/services/xpack_info.js

Line 30 in 60c596c

const camelCasedXPackInfo = convertKeysToCamelCaseDeep(updatedXPackInfo);

mshustov · 2019-10-25T15:21:01Z

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

+      return new License({
+        license: response.license,
+        features: response.features,
+        signature: response.signature,


http service doesn’t provide headers
https://github.com/elastic/kibana/blob/master/src/core/public/http/http_setup.ts#L207

elasticmachine · 2019-11-14T10:44:54Z

💚 Build Succeeded

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

pgayvallet

Great work, the test coverage is amazing.

pgayvallet · 2019-11-14T13:46:38Z

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

+  it('uid', () => {
+    expect(basicLicense.uid).toBe('uid-000000001234');
+    expect(errorLicense.uid).toBeUndefined();
+    expect(unavailableLicense.uid).toBeUndefined();
+  });
+
+  it('status', () => {
+    expect(basicLicense.status).toBe('active');
+    expect(errorLicense.status).toBeUndefined();
+    expect(unavailableLicense.status).toBeUndefined();
+  });
+
+  it('expiryDateInMillis', () => {
+    expect(basicLicense.expiryDateInMillis).toBe(5000);
+    expect(errorLicense.expiryDateInMillis).toBeUndefined();
+    expect(unavailableLicense.expiryDateInMillis).toBeUndefined();
+  });
+
+  it('type', () => {
+    expect(basicLicense.type).toBe('basic');
+    expect(goldLicense.type).toBe('gold');
+    expect(errorLicense.type).toBeUndefined();
+    expect(unavailableLicense.type).toBeUndefined();
+  });


I agree with josh, there are tests in this file that make sense (such as isActive or isOneOf) the mock license accessors checks (uid/status/expiryDateInMillis/type) don't really seems to provide any test value?

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

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

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

elasticmachine · 2019-11-18T10:36:01Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 1e06de4

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

joshdover · 2019-11-18T15:36:54Z

@restrry I'm good with this plan. I'm assuming we can close #43376 and #43378 then?

mshustov · 2019-11-18T16:11:23Z

@joshdover I closed both. created #50931

elasticmachine · 2019-11-18T16:28:31Z

💚 Build Succeeded

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

joshdover

LGTM after json serialization issue is resolved

elasticmachine · 2019-11-19T08:57:26Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 41b4935

elasticmachine · 2019-11-19T12:23:39Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 85f54eb

legrego

Security/Spaces changes LGTM

* Add x-pack plugin for new platform browser licensing information * Address next round of reviews * Remove poller functionality in favor of inline observables * More observable changes from review comments * Fix outstanding tests * More changes from review, adding additional testing * Add additional tests for license comparisons and sessions * Update test snapshot due to sessionstorage mock * Next round of review feedback from restrry * Fix more review requests from restrry, add additional tests * Pass correct sign mock to license info changed test * Improve doc comments, switch to I-interface pattern * Test error polling sanity, do not expose signature, do not poll on client * Fix type check issues from rebase * Fix build error from rebase * minimize config * move all types to server with consistency with other code * implement License * implement license update & refactor has License changed check * update tests for licensing extending route handler context * implement client side side license plugin * implement server side licensing plugin * remove old code * update testing harness * update types for license status * remove jest-localstorage-mock * fix tests * update license in security * address comments. first pass * error is a part of signature. pass error message to License * move common license types under common folder * rename feature props for BWC and unify name with ILicense * test should work in any timezone * make prettier happy * remove obsolete comment * address Pierre comments * use sha256 for security reasons * use stable stringify to avoid churn

eliperelman and others added 24 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

Fix build error from rebase

9f7892d

minimize config

d17aa56

move all types to server with consistency with other code

80b873a

implement License

3bccb47

implement license update & refactor has License changed check

532fc9c

update tests for licensing extending route handler context

40f238a

update testing harness

74f2f13

implement client side side license plugin

47ea081

implement server side licensing plugin

a76af93

remove old code

7fefe4d

mshustov added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:New Platform labels Oct 25, 2019

mshustov commented Oct 25, 2019

View reviewed changes

pgayvallet reviewed Nov 14, 2019

View reviewed changes

mshustov added 2 commits November 18, 2019 08:59

Merge branch 'master' into pr/44922

94c5509

address Pierre comments

1e06de4

mshustov requested a review from pgayvallet November 18, 2019 09:21

legrego reviewed Nov 18, 2019

View reviewed changes

x-pack/plugins/licensing/server/plugin.ts Outdated Show resolved Hide resolved

use sha256 for security reasons

1798239

mshustov mentioned this pull request Nov 18, 2019

NP Licensing service #50931

Closed

12 tasks

mshustov requested a review from a team November 18, 2019 16:11

joshdover approved these changes Nov 18, 2019

View reviewed changes

use stable stringify to avoid churn

41b4935

mshustov requested review from legrego and a team November 19, 2019 08:40

Merge branch 'master' into pr/44922

85f54eb

legrego approved these changes Nov 19, 2019

View reviewed changes

mshustov merged commit 643f15c into elastic:master Nov 19, 2019

This was referenced Nov 19, 2019

[7.x] Licensing plugin (#49345) #51026

Merged

Failing test: Jest Tests.src/core/utils - Poller executes a function on an interval #44560

Closed

spalger added the v8.0.0 label Nov 21, 2019

elasticmachine mentioned this pull request Nov 29, 2019

License plugin #18356

Closed

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Licensing plugin #49345

Licensing plugin #49345

mshustov commented Oct 25, 2019 •

edited

Loading

elasticmachine commented Oct 25, 2019

mshustov Oct 25, 2019

mshustov Oct 25, 2019

elasticmachine commented Nov 14, 2019

pgayvallet left a comment

pgayvallet Nov 14, 2019

elasticmachine commented Nov 18, 2019

joshdover commented Nov 18, 2019

mshustov commented Nov 18, 2019 •

edited

Loading

elasticmachine commented Nov 18, 2019

joshdover left a comment

elasticmachine commented Nov 19, 2019

elasticmachine commented Nov 19, 2019

legrego left a comment

Licensing plugin #49345

Licensing plugin #49345

Conversation

mshustov commented Oct 25, 2019 • edited Loading

Summary

The main differences from the LP implementation:

state

Network request failures

clusterSource

Initial value on the client

Config

License

sessionStorage

Checklist

For maintainers

Dev Docs

elasticmachine commented Oct 25, 2019

mshustov Oct 25, 2019

Choose a reason for hiding this comment

mshustov Oct 25, 2019

Choose a reason for hiding this comment

elasticmachine commented Nov 14, 2019

💚 Build Succeeded

pgayvallet left a comment

Choose a reason for hiding this comment

pgayvallet Nov 14, 2019

Choose a reason for hiding this comment

elasticmachine commented Nov 18, 2019

💚 Build Succeeded

joshdover commented Nov 18, 2019

mshustov commented Nov 18, 2019 • edited Loading

elasticmachine commented Nov 18, 2019

💚 Build Succeeded

joshdover left a comment

Choose a reason for hiding this comment

elasticmachine commented Nov 19, 2019

💚 Build Succeeded

elasticmachine commented Nov 19, 2019

💚 Build Succeeded

legrego left a comment

Choose a reason for hiding this comment

mshustov commented Oct 25, 2019 •

edited

Loading

mshustov commented Nov 18, 2019 •

edited

Loading