[Search] Add "restore" to session service (elastic#81924)

Dosant · Dosant · commit be4889c31866 · 2020-10-30T11:44:35.000+01:00
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.md
@@ -17,6 +17,6 @@ export interface ISearchSetup
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [aggs](./kibana-plugin-plugins-data-public.isearchsetup.aggs.md) | <code>AggsSetup</code> |  |
-|  [session](./kibana-plugin-plugins-data-public.isearchsetup.session.md) | <code>ISessionService</code> | session management  |
+|  [session](./kibana-plugin-plugins-data-public.isearchsetup.session.md) | <code>ISessionService</code> | session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |
 |  [usageCollector](./kibana-plugin-plugins-data-public.isearchsetup.usagecollector.md) | <code>SearchUsageCollector</code> |  |
 
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.session.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.session.md
@@ -4,7 +4,7 @@
 
 ## ISearchSetup.session property
 
-session management 
+session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md)
 
 <b>Signature:</b>
 
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.md
@@ -19,6 +19,6 @@ export interface ISearchStart
 |  [aggs](./kibana-plugin-plugins-data-public.isearchstart.aggs.md) | <code>AggsStart</code> | agg config sub service [AggsStart](./kibana-plugin-plugins-data-public.aggsstart.md) |
 |  [search](./kibana-plugin-plugins-data-public.isearchstart.search.md) | <code>ISearchGeneric</code> | low level search [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) |
 |  [searchSource](./kibana-plugin-plugins-data-public.isearchstart.searchsource.md) | <code>ISearchStartSearchSource</code> | high level search [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md) |
-|  [session](./kibana-plugin-plugins-data-public.isearchstart.session.md) | <code>ISessionService</code> | session management  |
+|  [session](./kibana-plugin-plugins-data-public.isearchstart.session.md) | <code>ISessionService</code> | session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |
 |  [showError](./kibana-plugin-plugins-data-public.isearchstart.showerror.md) | <code>(e: Error) =&gt; void</code> |  |
 
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.session.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.session.md
@@ -4,7 +4,7 @@
 
 ## ISearchStart.session property
 
-session management 
+session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md)
 
 <b>Signature:</b>
 
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.clear.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.clear.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) &gt; [clear](./kibana-plugin-plugins-data-public.isessionservice.clear.md)
+
+## ISessionService.clear property
+
+Clears the active session.
+
+<b>Signature:</b>
+
+```typescript
+clear: () => void;
+```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.getsession_.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.getsession_.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) &gt; [getSession$](./kibana-plugin-plugins-data-public.isessionservice.getsession_.md)
+
+## ISessionService.getSession$ property
+
+Returns the observable that emits an update every time the session ID changes
+
+<b>Signature:</b>
+
+```typescript
+getSession$: () => Observable<string | undefined>;
+```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.getsessionid.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.getsessionid.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) &gt; [getSessionId](./kibana-plugin-plugins-data-public.isessionservice.getsessionid.md)
+
+## ISessionService.getSessionId property
+
+Returns the active session ID
+
+<b>Signature:</b>
+
+```typescript
+getSessionId: () => string | undefined;
+```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.md
@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md)
+
+## ISessionService interface
+
+<b>Signature:</b>
+
+```typescript
+export interface ISessionService 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [clear](./kibana-plugin-plugins-data-public.isessionservice.clear.md) | <code>() =&gt; void</code> | Clears the active session. |
+|  [getSession$](./kibana-plugin-plugins-data-public.isessionservice.getsession_.md) | <code>() =&gt; Observable&lt;string &#124; undefined&gt;</code> | Returns the observable that emits an update every time the session ID changes |
+|  [getSessionId](./kibana-plugin-plugins-data-public.isessionservice.getsessionid.md) | <code>() =&gt; string &#124; undefined</code> | Returns the active session ID |
+|  [restore](./kibana-plugin-plugins-data-public.isessionservice.restore.md) | <code>(sessionId: string) =&gt; void</code> | Restores existing session |
+|  [start](./kibana-plugin-plugins-data-public.isessionservice.start.md) | <code>() =&gt; string</code> | Starts a new session |
+
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.restore.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.restore.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) &gt; [restore](./kibana-plugin-plugins-data-public.isessionservice.restore.md)
+
+## ISessionService.restore property
+
+Restores existing session
+
+<b>Signature:</b>
+
+```typescript
+restore: (sessionId: string) => void;
+```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.start.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isessionservice.start.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) &gt; [start](./kibana-plugin-plugins-data-public.isessionservice.start.md)
+
+## ISessionService.start property
+
+Starts a new session
+
+<b>Signature:</b>
+
+```typescript
+start: () => string;
+```
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md
@@ -74,6 +74,7 @@
 |  [ISearchSetup](./kibana-plugin-plugins-data-public.isearchsetup.md) | The setup contract exposed by the Search plugin exposes the search strategy extension point. |
 |  [ISearchStart](./kibana-plugin-plugins-data-public.isearchstart.md) | search service |
 |  [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md) | high level search service |
+|  [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |  |
 |  [KueryNode](./kibana-plugin-plugins-data-public.kuerynode.md) |  |
 |  [OptionedValueProp](./kibana-plugin-plugins-data-public.optionedvalueprop.md) |  |
 |  [QueryState](./kibana-plugin-plugins-data-public.querystate.md) | All query state service state |
diff --git a/src/plugins/data/common/search/session/mocks.ts b/src/plugins/data/common/search/session/mocks.ts
@@ -23,6 +23,7 @@ export function getSessionServiceMock(): jest.Mocked<ISessionService> {
   return {
     clear: jest.fn(),
     start: jest.fn(),
+    restore: jest.fn(),
     getSessionId: jest.fn(),
     getSession$: jest.fn(),
   };
diff --git a/src/plugins/data/common/search/session/types.ts b/src/plugins/data/common/search/session/types.ts
@@ -34,6 +34,12 @@ export interface ISessionService {
    * Starts a new session
    */
   start: () => string;
+
+  /**
+   * Restores existing session
+   */
+  restore: (sessionId: string) => void;
+
   /**
    * Clears the active session.
    */
diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts
@@ -380,7 +380,7 @@ export {
   PainlessError,
 } from './search';
 
-export type { SearchSource } from './search';
+export type { SearchSource, ISessionService } from './search';
 
 export { ISearchOptions, isErrorResponse, isCompleteResponse, isPartialResponse } from '../common';
 
diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
@@ -1423,8 +1423,6 @@ export interface ISearchSetup {
     //
     // (undocumented)
     aggs: AggsSetup;
-    // Warning: (ae-forgotten-export) The symbol "ISessionService" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "ISessionService"
     session: ISessionService;
     // Warning: (ae-forgotten-export) The symbol "SearchUsageCollector" needs to be exported by the entry point index.d.ts
     //
@@ -1440,7 +1438,6 @@ export interface ISearchStart {
     aggs: AggsStart;
     search: ISearchGeneric;
     searchSource: ISearchStartSearchSource;
-    // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "ISessionService"
     session: ISessionService;
     // (undocumented)
     showError: (e: Error) => void;
@@ -1457,6 +1454,17 @@ export interface ISearchStartSearchSource {
 // @public (undocumented)
 export const isErrorResponse: (response?: IKibanaSearchResponse<any> | undefined) => boolean | undefined;
 
+// Warning: (ae-missing-release-tag) "ISessionService" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ISessionService {
+    clear: () => void;
+    getSession$: () => Observable<string | undefined>;
+    getSessionId: () => string | undefined;
+    restore: (sessionId: string) => void;
+    start: () => string;
+}
+
 // Warning: (ae-missing-release-tag) "isFilter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
diff --git a/src/plugins/data/public/search/index.ts b/src/plugins/data/public/search/index.ts
@@ -41,6 +41,7 @@ export {
   SearchSourceDependencies,
   SearchSourceFields,
   SortDirection,
+  ISessionService,
 } from '../../common/search';
 
 export { getEsPreference } from './es_search';
diff --git a/src/plugins/data/public/search/session_service.test.ts b/src/plugins/data/public/search/session_service.test.ts
@@ -20,6 +20,7 @@
 import { SessionService } from './session_service';
 import { ISessionService } from '../../common';
 import { coreMock } from '../../../../core/public/mocks';
+import { take, toArray } from 'rxjs/operators';
 
 describe('Session service', () => {
   let sessionService: ISessionService;
@@ -39,5 +40,20 @@ describe('Session service', () => {
       sessionService.clear();
       expect(sessionService.getSessionId()).toBeUndefined();
     });
+
+    it('Restores a session', async () => {
+      const sessionId = 'sessionId';
+      sessionService.restore(sessionId);
+      expect(sessionService.getSessionId()).toBe(sessionId);
+    });
+
+    it('sessionId$ observable emits current value', async () => {
+      sessionService.restore('1');
+      const emittedValues = sessionService.getSession$().pipe(take(3), toArray()).toPromise();
+      sessionService.restore('2');
+      sessionService.clear();
+
+      expect(await emittedValues).toEqual(['1', '2', undefined]);
+    });
   });
 });
diff --git a/src/plugins/data/public/search/session_service.ts b/src/plugins/data/public/search/session_service.ts
@@ -18,14 +18,16 @@
  */
 
 import uuid from 'uuid';
-import { Subject, Subscription } from 'rxjs';
+import { BehaviorSubject, Subscription } from 'rxjs';
 import { PluginInitializerContext, StartServicesAccessor } from 'kibana/public';
-import { ISessionService } from '../../common/search';
 import { ConfigSchema } from '../../config';
+import { ISessionService } from '../../common/search';
 
 export class SessionService implements ISessionService {
-  private sessionId?: string;
-  private session$: Subject<string | undefined> = new Subject();
+  private session$ = new BehaviorSubject<string | undefined>(undefined);
+  private get sessionId() {
+    return this.session$.getValue();
+  }
   private appChangeSubscription$?: Subscription;
   private curApp?: string;
 
@@ -68,13 +70,15 @@ export class SessionService implements ISessionService {
   }
 
   public start() {
-    this.sessionId = uuid.v4();
-    this.session$.next(this.sessionId);
-    return this.sessionId;
+    this.session$.next(uuid.v4());
+    return this.sessionId!;
+  }
+
+  public restore(sessionId: string) {
+    this.session$.next(sessionId);
   }
 
   public clear() {
-    this.sessionId = undefined;
-    this.session$.next(this.sessionId);
+    this.session$.next(undefined);
   }
 }
