Initial implementation of server licensing service #41026

eliperelman · 2019-07-12T17:37:42Z

Summary

Licensing service. This is currently a work in progress:

Server implementation
Server tests

Fixes #18356.

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

elasticmachine · 2019-07-12T17:37:44Z

Pinging @elastic/kibana-platform

eliperelman · 2019-07-12T17:39:30Z

Right now the current return value of setting up the server licensing service returns a BehaviorSubject to allow consumers to subscribe to changes to the license over time and react accordingly.

type LicensingServiceSubject = BehaviorSubject<LicensingServiceSetup | null>;

const licensing: LicensingServiceSubject;
// ...

licensing.subscribe(license => {
  if (!license) {
    // Service is null until polled and started.
    return;
  }

  const { status, message } = license.check('discovery', LICENSE_TYPE.gold);
  // ...
});

joshdover · 2019-07-12T18:09:05Z

src/core/server/licensing/licensing_service.ts

+        from(this.fetchInfo(deps, clusterSource, pollingFrequency)).pipe(
+          tap(({ license, error, features }) => {
+            // If license is false, the license did not change and we don't need to push
+            // a new one


On line 91 it returns false if the license did change?

Good catch!

elasticmachine · 2019-07-12T18:14:05Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

joshdover · 2019-07-12T18:16:10Z

Overall, this is looking like how I would expect it to 👍

Per our discussion in the weekly, I would advise changing the interface exposed by the service to be a Observable of some interface rather than a class, and then you can implement that interface in the class. This makes testing and mocking easier for consumers. #39446 (comment)

cjcenizal

I was curious so I had to look. 😄 Had some comments I thought worth sharing, feel free to disregard them.

cjcenizal · 2019-07-12T18:07:25Z

src/core/server/licensing/license_feature.ts

+  private serializable: LicenseFeatureSerializer = service => ({
+    name: this.name,
+    isAvailable: this.isAvailable,
+    isEnabled: this.isEnabled,


What's the difference between isAvailable and isEnabled?

Not a clue, I'll see what I can find out. 😄

cjcenizal · 2019-07-12T18:07:59Z

src/core/server/licensing/licensing_service.ts

+
+  private hasLicenseInfoChanged(newLicense: any) {
+    return (
+      newLicense.mode !== this.license.mode ||


What's mode? If this corresponds to the LICENSE_TYPE enum, then maybe type would make that clear?

This was preexisting from x-pack legacy, so I'll see about making this clearer.

cjcenizal · 2019-07-12T18:12:35Z

src/core/server/licensing/licensing_service_setup.ts

+    private clusterSource: string
+  ) {
+    this._license = license;
+    this.license = license || {};


I probably won't ever maintain this code, but if I did, I think I would be confused by the presence of this._license and this.license. I would be able to follow this code more easily if we only had one or the other. It looks like this._license is only used to assert whether there is a license or not. In that case, could we do this instead?

constructor( license: any, features: any, private error: Error | null, private clusterSource: string ) { this.hasLicense = Boolean(license); this.license = license || {};

cjcenizal · 2019-07-12T18:25:01Z

src/core/server/licensing/licensing_service_setup.ts

+    return this.objectified;
+  }
+
+  feature(name: string) {


Minor nit, but I'd find this method easier to understand if there was a verb in the name, e.g. getFeature.

cjcenizal · 2019-07-12T18:26:45Z

src/core/server/licensing/licensing_config.ts

+   * @internal
+   */
+  constructor(rawConfig: LicensingConfigType, env: Env) {
+    this.enabled = rawConfig.enabled;


I see isEnabled used in some places and enabled in others. Should be standardize on one or the other? My preference would be isEnabled, because I'm used to seeing words like is used to identify booleans.

Since this comes from configuration that we control, this is a good idea. Will revise.

elasticmachine · 2019-07-12T18:35:04Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

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.4.0 labels Jul 12, 2019

eliperelman self-assigned this Jul 12, 2019

Initial implementation of server licensing service

0415e96

eliperelman force-pushed the licensing-service branch from f78bdb4 to 0415e96 Compare July 12, 2019 17:57

joshdover reviewed Jul 12, 2019

View reviewed changes

Set licensing to false to denote lack of license change correctly

499ff7b

cjcenizal reviewed Jul 12, 2019

View reviewed changes

joshdover added this to In progress in kibana-core [DEPRECATED] Jul 15, 2019

eliperelman closed this Aug 20, 2019

kibana-core [DEPRECATED] automation moved this from In progress to Done (this week) Aug 20, 2019

eliperelman mentioned this pull request Aug 20, 2019

Add x-pack plugin for new platform server licensing information #43623

Merged

9 tasks

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial implementation of server licensing service #41026

Initial implementation of server licensing service #41026

eliperelman commented Jul 12, 2019 •

edited

Loading

elasticmachine commented Jul 12, 2019

eliperelman commented Jul 12, 2019 •

edited

Loading

joshdover Jul 12, 2019

eliperelman Jul 12, 2019

elasticmachine commented Jul 12, 2019

joshdover commented Jul 12, 2019

cjcenizal left a comment

cjcenizal Jul 12, 2019

eliperelman Jul 12, 2019

cjcenizal Jul 12, 2019

eliperelman Jul 12, 2019

cjcenizal Jul 12, 2019

eliperelman Jul 12, 2019

cjcenizal Jul 12, 2019

cjcenizal Jul 12, 2019

eliperelman Jul 12, 2019

elasticmachine commented Jul 12, 2019

Initial implementation of server licensing service #41026

Initial implementation of server licensing service #41026

Conversation

eliperelman commented Jul 12, 2019 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Jul 12, 2019

eliperelman commented Jul 12, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jul 12, 2019

💔 Build Failed

joshdover commented Jul 12, 2019

cjcenizal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jul 12, 2019

💔 Build Failed

eliperelman commented Jul 12, 2019 •

edited

Loading

eliperelman commented Jul 12, 2019 •

edited

Loading