Licensing uses es from start contract. (#67291)

* use es client provided from start

* expose licengin API from start contract and deprecate setup counterparts

* update tests

* provide licensing API from start contract on the client-side

* update tests

* update mocks

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

@@ -8,5 +8,5 @@ import { PluginInitializerContext } from 'src/core/public';
 import { LicensingPlugin } from './plugin';
 
 export * from '../common/types';
-export * from './types';
+export { LicensingPluginSetup, LicensingPluginStart } from './types';
 export const plugin = (context: PluginInitializerContext) => new LicensingPlugin(context);

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

@@ -15,6 +15,7 @@ import { licenseMock } from '../common/licensing.mock';
 import { coreMock } from '../../../../src/core/public/mocks';
 import { HttpInterceptor } from 'src/core/public';
 
+const coreStart = coreMock.createStart();
 describe('licensing plugin', () => {
   let plugin: LicensingPlugin;
 
@@ -23,7 +24,7 @@ describe('licensing plugin', () => {
     await plugin.stop();
   });
 
-  describe('#setup', () => {
+  describe('#start', () => {
     describe('#refresh', () => {
       it('forces data re-fetch', async () => {
         const sessionStorage = coreMock.createStorage();
@@ -38,7 +39,8 @@ describe('licensing plugin', () => {
         });
         coreSetup.http.get.mockResolvedValueOnce(firstLicense).mockResolvedValueOnce(secondLicense);
 
-        const { license$, refresh } = await plugin.setup(coreSetup);
+        await plugin.setup(coreSetup);
+        const { license$, refresh } = await plugin.start(coreStart);
 
         let fromObservable;
         license$.subscribe((license) => (fromObservable = license));
@@ -60,7 +62,8 @@ describe('licensing plugin', () => {
         const fetchedLicense = licenseMock.createLicense();
         coreSetup.http.get.mockResolvedValue(fetchedLicense);
 
-        const { refresh } = await plugin.setup(coreSetup);
+        await plugin.setup(coreSetup);
+        const { refresh } = await plugin.start(coreStart);
 
         await refresh();
 
@@ -78,7 +81,8 @@ describe('licensing plugin', () => {
         plugin = new LicensingPlugin(coreMock.createPluginInitializerContext(), sessionStorage);
 
         const coreSetup = coreMock.createSetup();
-        const { license$ } = await plugin.setup(coreSetup);
+        await plugin.setup(coreSetup);
+        const { license$ } = await plugin.start(coreStart);
 
         const license = await license$.pipe(take(1)).toPromise();
         expect(license.isAvailable).toBe(true);
@@ -99,7 +103,9 @@ describe('licensing plugin', () => {
         coreSetup.http.get.mockImplementation(() =>
           Promise.resolve(licenseMock.createLicense({ license: { type: types.shift() } }))
         );
-        const { license$, refresh } = await plugin.setup(coreSetup);
+
+        await plugin.setup(coreSetup);
+        const { refresh, license$ } = await plugin.start(coreStart);
 
         let i = 0;
         license$.subscribe((value) => {
@@ -128,7 +134,8 @@ describe('licensing plugin', () => {
         const fetchedLicense = licenseMock.createLicense({ license: { uid: 'fresh' } });
         coreSetup.http.get.mockResolvedValue(fetchedLicense);
 
-        const { license$, refresh } = await plugin.setup(coreSetup);
+        await plugin.setup(coreSetup);
+        const { license$, refresh } = await plugin.start(coreStart);
 
         await refresh();
         const license = await license$.pipe(take(1)).toPromise();
@@ -153,7 +160,8 @@ describe('licensing plugin', () => {
         const coreSetup = coreMock.createSetup();
         coreSetup.http.get.mockRejectedValue(new Error('reason'));
 
-        const { license$, refresh } = await plugin.setup(coreSetup);
+        await plugin.setup(coreSetup);
+        const { license$, refresh } = await plugin.start(coreStart);
         await refresh();
 
         const license = await license$.pipe(take(1)).toPromise();
@@ -169,7 +177,8 @@ describe('licensing plugin', () => {
         const coreSetup = coreMock.createSetup();
         coreSetup.http.get.mockRejectedValue(new Error('sorry'));
 
-        const { license$, refresh } = await plugin.setup(coreSetup);
+        await plugin.setup(coreSetup);
+        const { license$, refresh } = await plugin.start(coreStart);
         expect(sessionStorage.removeItem).toHaveBeenCalledTimes(0);
 
         await refresh();
@@ -206,7 +215,8 @@ describe('licensing plugin', () => {
         return () => undefined;
       });
 
-      const { license$ } = await plugin.setup(coreSetup);
+      await plugin.setup(coreSetup);
+      const { license$ } = await plugin.start(coreStart);
       expect(registeredInterceptor!.response).toBeDefined();
 
       const httpResponse = {
@@ -284,7 +294,8 @@ describe('licensing plugin', () => {
         return () => undefined;
       });
 
-      const { license$ } = await plugin.setup(coreSetup);
+      await plugin.setup(coreSetup);
+      const { license$ } = await plugin.start(coreStart);
 
       let updated = false;
       license$.subscribe(() => (updated = true));
@@ -326,10 +337,8 @@ describe('licensing plugin', () => {
         licenseMock.createLicense({ license: { status: 'active', type: 'gold' } })
       );
 
-      const { refresh } = await plugin.setup(coreSetup);
-
-      const coreStart = coreMock.createStart();
-      await plugin.start(coreStart);
+      await plugin.setup(coreSetup);
+      const { refresh } = await plugin.start(coreStart);
 
       await refresh();
       expect(coreStart.overlays.banners.add).toHaveBeenCalledTimes(0);
@@ -352,10 +361,8 @@ describe('licensing plugin', () => {
         .mockResolvedValueOnce(activeLicense)
         .mockResolvedValueOnce(expiredLicense);
 
-      const { refresh } = await plugin.setup(coreSetup);
-
-      const coreStart = coreMock.createStart();
-      await plugin.start(coreStart);
+      await plugin.setup(coreSetup);
+      const { refresh } = await plugin.start(coreStart);
 
       await refresh();
       expect(coreStart.overlays.banners.add).toHaveBeenCalledTimes(0);
@@ -377,7 +384,8 @@ describe('licensing plugin', () => {
       const sessionStorage = coreMock.createStorage();
       plugin = new LicensingPlugin(coreMock.createPluginInitializerContext(), sessionStorage);
       const coreSetup = coreMock.createSetup();
-      const { license$ } = await plugin.setup(coreSetup);
+      await plugin.setup(coreSetup);
+      const { license$ } = await plugin.start(coreStart);
 
       let completed = false;
       license$.subscribe({ complete: () => (completed = true) });

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

@@ -3,12 +3,12 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-import { Subject, Subscription } from 'rxjs';
+import { Observable, Subject, Subscription } from 'rxjs';
 
 import { CoreSetup, CoreStart, Plugin, PluginInitializerContext } from 'src/core/public';
 
 import { ILicense } from '../common/types';
-import { LicensingPluginSetup } from './types';
+import { LicensingPluginSetup, LicensingPluginStart } from './types';
 import { createLicenseUpdate } from '../common/license_update';
 import { License } from '../common/license';
 import { mountExpiredBanner } from './expired_banner';
@@ -20,7 +20,7 @@ export const licensingSessionStorageKey = 'xpack.licensing';
  * A plugin for fetching, refreshing, and receiving information about the license for the
  * current Kibana instance.
  */
-export class LicensingPlugin implements Plugin<LicensingPluginSetup> {
+export class LicensingPlugin implements Plugin<LicensingPluginSetup, LicensingPluginStart> {
   /**
    * Used as a flag to halt all other plugin observables.
    */
@@ -37,6 +37,9 @@ export class LicensingPlugin implements Plugin<LicensingPluginSetup> {
   private coreStart?: CoreStart;
   private prevSignature?: string;
 
+  private refresh?: () => Promise<ILicense>;
+  private license$?: Observable<ILicense>;
+
   constructor(
     context: PluginInitializerContext,
     private readonly storage: Storage = sessionStorage
@@ -107,6 +110,9 @@ export class LicensingPlugin implements Plugin<LicensingPluginSetup> {
       },
     });
 
+    this.refresh = refreshManually;
+    this.license$ = license$;
+
     return {
       refresh: refreshManually,
       license$,
@@ -115,6 +121,13 @@ export class LicensingPlugin implements Plugin<LicensingPluginSetup> {
 
   public async start(core: CoreStart) {
     this.coreStart = core;
+    if (!this.refresh || !this.license$) {
+      throw new Error('Setup has not been completed');
+    }
+    return {
+      refresh: this.refresh,
+      license$: this.license$,
+    };
   }
 
   public stop() {

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

@@ -9,6 +9,20 @@ import { ILicense } from '../common/types';
 
 /** @public */
 export interface LicensingPluginSetup {
+  /**
+   * Steam of licensing information {@link ILicense}.
+   * @deprecated in favour of the counterpart provided from start contract
+   */
+  license$: Observable<ILicense>;
+  /**
+   * Triggers licensing information re-fetch.
+   * @deprecated in favour of the counterpart provided from start contract
+   */
+  refresh(): Promise<ILicense>;
+}
+
+/** @public */
+export interface LicensingPluginStart {
   /**
    * Steam of licensing information {@link ILicense}.
    */

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

@@ -26,10 +26,20 @@ const createSetupMock = (): jest.Mocked<LicensingPluginSetup> => {
 };
 
 const createStartMock = (): jest.Mocked<LicensingPluginStart> => {
+  const license = licenseMock.createLicense();
   const mock = {
+    license$: new BehaviorSubject(license),
+    refresh: jest.fn(),
+    createLicensePoller: jest.fn(),
     featureUsage: featureUsageMock.createStart(),
   };
 
+  mock.refresh.mockResolvedValue(license);
+  mock.createLicensePoller.mockReturnValue({
+    license$: mock.license$,
+    refresh: mock.refresh,
+  });
+
   return mock;
 };