@lizozom review

Dosant · Dosant · commit b9bbbdbea98f · 2020-11-30T17:55:56.000+01:00
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
@@ -89,7 +89,7 @@
 |  [SavedQueryService](./kibana-plugin-plugins-data-public.savedqueryservice.md) |  |
 |  [SearchError](./kibana-plugin-plugins-data-public.searcherror.md) |  |
 |  [SearchInterceptorDeps](./kibana-plugin-plugins-data-public.searchinterceptordeps.md) |  |
-|  [SearchSessionRestorationInfoProvider](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md) | Provide info about current search session to be stored in backgroundSearch saved object |
+|  [SearchSessionInfoProvider](./kibana-plugin-plugins-data-public.searchSessionInfoprovider.md) | Provide info about current search session to be stored in backgroundSearch saved object |
 |  [SearchSourceFields](./kibana-plugin-plugins-data-public.searchsourcefields.md) | search source fields |
 |  [TabbedAggColumn](./kibana-plugin-plugins-data-public.tabbedaggcolumn.md) | \* |
 |  [TabbedTable](./kibana-plugin-plugins-data-public.tabbedtable.md) | \* |
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.getname.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.getname.md
@@ -1,8 +1,8 @@
 <!-- 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; [SearchSessionRestorationInfoProvider](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md) &gt; [getName](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.getname.md)
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SearchSessionInfoProvider](./kibana-plugin-plugins-data-public.searchSessionInfoprovider.md) &gt; [getName](./kibana-plugin-plugins-data-public.searchSessionInfoprovider.getname.md)
 
-## SearchSessionRestorationInfoProvider.getName property
+## SearchSessionInfoProvider.getName property
 
 User-facing name of the session. e.g. will be displayed in background sessions management list
 
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.geturlgeneratordata.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.geturlgeneratordata.md
@@ -1,8 +1,8 @@
 <!-- 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; [SearchSessionRestorationInfoProvider](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md) &gt; [getUrlGeneratorData](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.geturlgeneratordata.md)
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SearchSessionInfoProvider](./kibana-plugin-plugins-data-public.searchSessionInfoprovider.md) &gt; [getUrlGeneratorData](./kibana-plugin-plugins-data-public.searchSessionInfoprovider.geturlgeneratordata.md)
 
-## SearchSessionRestorationInfoProvider.getUrlGeneratorData property
+## SearchSessionInfoProvider.getUrlGeneratorData property
 
 <b>Signature:</b>
 
diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md
@@ -1,21 +1,21 @@
 <!-- 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; [SearchSessionRestorationInfoProvider](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md)
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SearchSessionInfoProvider](./kibana-plugin-plugins-data-public.searchSessionInfoprovider.md)
 
-## SearchSessionRestorationInfoProvider interface
+## SearchSessionInfoProvider interface
 
 Provide info about current search session to be stored in backgroundSearch saved object
 
 <b>Signature:</b>
 
 ```typescript
-export interface SearchSessionRestorationInfoProvider<ID extends UrlGeneratorId = UrlGeneratorId> 
+export interface SearchSessionInfoProvider<ID extends UrlGeneratorId = UrlGeneratorId> 
 ```
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [getName](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.getname.md) | <code>() =&gt; Promise&lt;string&gt;</code> | User-facing name of the session. e.g. will be displayed in background sessions management list |
-|  [getUrlGeneratorData](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.geturlgeneratordata.md) | <code>() =&gt; Promise&lt;{</code><br/><code>        urlGeneratorId: ID;</code><br/><code>        initialState: UrlGeneratorStateMapping[ID]['State'];</code><br/><code>        restoreState: UrlGeneratorStateMapping[ID]['State'];</code><br/><code>    }&gt;</code> |  |
+|  [getName](./kibana-plugin-plugins-data-public.searchSessionInfoprovider.getname.md) | <code>() =&gt; Promise&lt;string&gt;</code> | User-facing name of the session. e.g. will be displayed in background sessions management list |
+|  [getUrlGeneratorData](./kibana-plugin-plugins-data-public.searchSessionInfoprovider.geturlgeneratordata.md) | <code>() =&gt; Promise&lt;{</code><br/><code>        urlGeneratorId: ID;</code><br/><code>        initialState: UrlGeneratorStateMapping[ID]['State'];</code><br/><code>        restoreState: UrlGeneratorStateMapping[ID]['State'];</code><br/><code>    }&gt;</code> |  |
 
diff --git a/src/plugins/dashboard/public/application/dashboard_app_controller.tsx b/src/plugins/dashboard/public/application/dashboard_app_controller.tsx
@@ -441,7 +441,7 @@ export class DashboardAppController {
       DashboardContainer
     >(DASHBOARD_CONTAINER_TYPE);
 
-    searchService.session.setSearchSessionRestorationInfoProvider(
+    searchService.session.setSearchSessionInfoProvider(
       createSessionRestorationDataProvider({
         data,
         getDashboardTitle: () => getDashTitle(),
diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts
@@ -399,7 +399,7 @@ export {
 export type {
   SearchSource,
   ISessionService,
-  SearchSessionRestorationInfoProvider,
+  SearchSessionInfoProvider,
   ISessionsClient,
 } from './search';
 
diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
@@ -2133,10 +2133,10 @@ export interface SearchInterceptorDeps {
 export type SearchRequest = Record<string, any>;
 
 // Warning: (ae-forgotten-export) The symbol "UrlGeneratorId" needs to be exported by the entry point index.d.ts
-// Warning: (ae-missing-release-tag) "SearchSessionRestorationInfoProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+// Warning: (ae-missing-release-tag) "SearchSessionInfoProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
-export interface SearchSessionRestorationInfoProvider<ID extends UrlGeneratorId = UrlGeneratorId> {
+export interface SearchSessionInfoProvider<ID extends UrlGeneratorId = UrlGeneratorId> {
     getName: () => Promise<string>;
     // (undocumented)
     getUrlGeneratorData: () => Promise<{
diff --git a/src/plugins/data/public/search/index.ts b/src/plugins/data/public/search/index.ts
@@ -44,7 +44,7 @@ export {
 export {
   SessionService,
   ISessionService,
-  SearchSessionRestorationInfoProvider,
+  SearchSessionInfoProvider,
   SessionState,
   SessionsClient,
   ISessionsClient,
diff --git a/src/plugins/data/public/search/search_interceptor.ts b/src/plugins/data/public/search/search_interceptor.ts
@@ -170,7 +170,7 @@ export class SearchInterceptor {
     // 1. The user manually aborts (via `cancelPending`)
     // 2. The request times out
     // 3. abort() is called on `selfAbortController`. This is used by session service to abort all pending searches that it tracks.
-    // to cancel searches that belong to the currently tracked session
+    //    to cancel searches that belong to the currently tracked session
     // 4. The passed-in signal aborts (e.g. when re-fetching, or whenever the app determines)
     const signals = [
       this.abortController.signal,
diff --git a/src/plugins/data/public/search/session/index.ts b/src/plugins/data/public/search/session/index.ts
@@ -17,10 +17,6 @@
  * under the License.
  */
 
-export {
-  SessionService,
-  ISessionService,
-  SearchSessionRestorationInfoProvider,
-} from './session_service';
+export { SessionService, ISessionService, SearchSessionInfoProvider } from './session_service';
 export { SessionState } from './session_state';
 export { SessionsClient, ISessionsClient } from './sessions_client';
diff --git a/src/plugins/data/public/search/session/mocks.ts b/src/plugins/data/public/search/session/mocks.ts
@@ -40,7 +40,7 @@ export function getSessionServiceMock(): jest.Mocked<ISessionService> {
     getSessionId: jest.fn(),
     getSession$: jest.fn(() => new BehaviorSubject(undefined).asObservable()),
     state$: new BehaviorSubject<SessionState>(SessionState.None).asObservable(),
-    setSearchSessionRestorationInfoProvider: jest.fn(),
+    setSearchSessionInfoProvider: jest.fn(),
     trackSearch: jest.fn((searchDescriptor) => () => {}),
     destroy: jest.fn(),
     onRefresh$: new Subject(),
diff --git a/src/plugins/data/public/search/session/session_service.ts b/src/plugins/data/public/search/session/session_service.ts
@@ -35,7 +35,7 @@ export interface TrackSearchDescriptor {
 /**
  * Provide info about current search session to be stored in backgroundSearch saved object
  */
-export interface SearchSessionRestorationInfoProvider<ID extends UrlGeneratorId = UrlGeneratorId> {
+export interface SearchSessionInfoProvider<ID extends UrlGeneratorId = UrlGeneratorId> {
   /**
    * User-facing name of the session.
    * e.g. will be displayed in background sessions management list
@@ -55,7 +55,7 @@ export class SessionService {
   public readonly state$: Observable<SessionState>;
   private readonly state: SessionStateContainer<TrackSearchDescriptor>;
 
-  private searchSessionRestorationInfoProvider?: SearchSessionRestorationInfoProvider;
+  private searchSessionInfoProvider?: SearchSessionInfoProvider;
   private appChangeSubscription$?: Subscription;
   private curApp?: string;
 
@@ -89,20 +89,19 @@ export class SessionService {
           }
         }
         this.curApp = appName;
-        this.setSearchSessionRestorationInfoProvider(undefined);
       });
     });
   }
 
   /**
    * Set a provider of info about current session
    * This will be used for creating a background session saved object
-   * @param searchSessionRestorationInfoProvider
+   * @param searchSessionInfoProvider
    */
-  public setSearchSessionRestorationInfoProvider<ID extends UrlGeneratorId = UrlGeneratorId>(
-    searchSessionRestorationInfoProvider: SearchSessionRestorationInfoProvider<ID> | undefined
+  public setSearchSessionInfoProvider<ID extends UrlGeneratorId = UrlGeneratorId>(
+    searchSessionInfoProvider: SearchSessionInfoProvider<ID> | undefined
   ) {
-    this.searchSessionRestorationInfoProvider = searchSessionRestorationInfoProvider;
+    this.searchSessionInfoProvider = searchSessionInfoProvider;
   }
 
   /**
@@ -123,7 +122,7 @@ export class SessionService {
       this.appChangeSubscription$.unsubscribe();
     }
     this.clear();
-    this.setSearchSessionRestorationInfoProvider(undefined);
+    this.setSearchSessionInfoProvider(undefined);
   }
 
   /**
@@ -180,11 +179,14 @@ export class SessionService {
    */
   public clear() {
     this.state.transitions.clear();
+    this.setSearchSessionInfoProvider(undefined);
   }
 
   private refresh$ = new Subject<void>();
   /**
    * Observable emits when search result refresh was requested
+   * For example, search to background UI could have it's own "refresh" button
+   * Application would use this observable to handle user interaction on that button
    */
   public onRefresh$ = this.refresh$.asObservable();
 
@@ -217,7 +219,7 @@ export class SessionService {
     const sessionId = this.getSessionId();
     if (!sessionId) throw new Error('No current session');
     if (!this.curApp) throw new Error('No current app id');
-    const currentSessionInfoProvider = this.searchSessionRestorationInfoProvider;
+    const currentSessionInfoProvider = this.searchSessionInfoProvider;
     if (!currentSessionInfoProvider) throw new Error('No info provider for current session');
     const [name, { initialState, restoreState, urlGeneratorId }] = await Promise.all([
       currentSessionInfoProvider.getName(),
diff --git a/src/plugins/discover/public/application/angular/discover.js b/src/plugins/discover/public/application/angular/discover.js
@@ -288,7 +288,7 @@ function discoverController($element, $route, $scope, $timeout, $window, Promise
     }
   });
 
-  data.search.session.setSearchSessionRestorationInfoProvider(
+  data.search.session.setSearchSessionInfoProvider(
     createSearchSessionRestorationDataProvider({
       appStateContainer,
       data,
diff --git a/src/plugins/discover/public/application/angular/discover_state.ts b/src/plugins/discover/public/application/angular/discover_state.ts
@@ -33,7 +33,7 @@ import {
   esFilters,
   Filter,
   Query,
-  SearchSessionRestorationInfoProvider,
+  SearchSessionInfoProvider,
 } from '../../../../data/public';
 import { migrateLegacyQuery } from '../helpers/migrate_legacy_query';
 import { DISCOVER_APP_URL_GENERATOR, DiscoverUrlGeneratorState } from '../../url_generator';
@@ -260,7 +260,7 @@ export function createSearchSessionRestorationDataProvider(deps: {
   appStateContainer: StateContainer<AppState>;
   data: DataPublicPluginStart;
   getSavedSearchId: () => string | undefined;
-}): SearchSessionRestorationInfoProvider {
+}): SearchSessionInfoProvider {
   return {
     getName: async () => 'Discover',
     getUrlGeneratorData: async () => {
