[Search] Client side session service (elastic#76889)

* Add a session service and use it in discover and dashboard

* check unefined

* Start session in visualize

* Fix tests

* docs

* OSS error alignemnt

* Adjust error messages in xpack

* Add getErrorMessage

* Use showError in vizualize
Add original error to expression exception

* Cleanup

* ts, doc and i18n fixes

* Fix jest tests

* Fix functional test

* functional test

* ts

* Update functional tests

* Add unit tests to interceptor and timeout error

* expose toasts test function

* doc

* typos

* lint

* Cleanup

* review 1

* Code review

* doc

* doc fix

* visualization type fix

* fix jest

* Fix xpack functional test

* fix xpack test

* code review

* Add tracking methods to session service

* remove chromium

* Fix ts and jest tests

* jest + docs

* ts fix

* siem test

* Use session service to show a timeout notification per session + more unit tests

* ts and docs

* Remove session service from search source (not needed)

* Code review

* ts

* Single active session in FE session service

* Cleanup

* Don't integrate with dashboard \ visualize
Add functional tests for session toast plugin

* Typescript

* ts

* Improve functional tests

* es

* simplify filter test

* wait until loadedw

* filter test

* delete crypto for now

* Select the correct index 🤦

* timerange

* Adjust functional test logic

* improved test format @Dosant

* Handle exceptions

* Don't close sessions automatically, warn instead

* jest

* Adjust functional test

* Remove unused code

* delete export

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchoptions.md

@@ -15,5 +15,6 @@ export interface ISearchOptions
 | Property | Type | Description |
 | --- | --- | --- |
 | [abortSignal](./kibana-plugin-plugins-data-public.isearchoptions.abortsignal.md) | <code>AbortSignal</code> | An <code>AbortSignal</code> that allows the caller of <code>search</code> to abort a search request. |
+| [sessionId](./kibana-plugin-plugins-data-public.isearchoptions.sessionid.md) | <code>string</code> | A session ID, grouping multiple search requests into a single session. |
 | [strategy](./kibana-plugin-plugins-data-public.isearchoptions.strategy.md) | <code>string</code> | Use this option to force using a specific server side search strategy. Leave empty to use the default strategy. |
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchoptions.sessionid.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; [ISearchOptions](./kibana-plugin-plugins-data-public.isearchoptions.md) &gt; [sessionId](./kibana-plugin-plugins-data-public.isearchoptions.sessionid.md)
+
+## ISearchOptions.sessionId property
+
+A session ID, grouping multiple search requests into a single session.
+
+<b>Signature:</b>
+
+```typescript
+sessionId?: string;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.md

@@ -17,5 +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 |
 | [usageCollector](./kibana-plugin-plugins-data-public.isearchsetup.usagecollector.md) | <code>SearchUsageCollector</code> | |
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.session.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; [ISearchSetup](./kibana-plugin-plugins-data-public.isearchsetup.md) &gt; [session](./kibana-plugin-plugins-data-public.isearchsetup.session.md)
+
+## ISearchSetup.session property
+
+session management 
+
+<b>Signature:</b>
+
+```typescript
+session: ISessionService;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.md

@@ -19,5 +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 |
 | [showError](./kibana-plugin-plugins-data-public.isearchstart.showerror.md) | <code>(e: Error) =&gt; void</code> | |
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.session.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; [ISearchStart](./kibana-plugin-plugins-data-public.isearchstart.md) &gt; [session](./kibana-plugin-plugins-data-public.isearchstart.session.md)
+
+## ISearchStart.session property
+
+session management 
+
+<b>Signature:</b>
+
+```typescript
+session: ISessionService;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.handlesearcherror.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-protected handleSearchError(e: any, request: IKibanaSearchRequest, timeoutSignal: AbortSignal, appAbortSignal?: AbortSignal): Error;
+protected handleSearchError(e: any, request: IKibanaSearchRequest, timeoutSignal: AbortSignal, options?: ISearchOptions): Error;
 ```
 
 ## Parameters
@@ -17,7 +17,7 @@ protected handleSearchError(e: any, request: IKibanaSearchRequest, timeoutSignal
 | e | <code>any</code> | |
 | request | <code>IKibanaSearchRequest</code> | |
 | timeoutSignal | <code>AbortSignal</code> | |
-| appAbortSignal | <code>AbortSignal</code> | |
+| options | <code>ISearchOptions</code> | |
 
 <b>Returns:</b>
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.md

@@ -27,7 +27,7 @@ export declare class SearchInterceptor
 | Method | Modifiers | Description |
 | --- | --- | --- |
 | [getTimeoutMode()](./kibana-plugin-plugins-data-public.searchinterceptor.gettimeoutmode.md) | | |
-| [handleSearchError(e, request, timeoutSignal, appAbortSignal)](./kibana-plugin-plugins-data-public.searchinterceptor.handlesearcherror.md) | | |
+| [handleSearchError(e, request, timeoutSignal, options)](./kibana-plugin-plugins-data-public.searchinterceptor.handlesearcherror.md) | | |
 | [search(request, options)](./kibana-plugin-plugins-data-public.searchinterceptor.search.md) | | Searches using the given <code>search</code> method. Overrides the <code>AbortSignal</code> with one that will abort either when <code>cancelPending</code> is called, when the request times out, or when the original <code>AbortSignal</code> is aborted. Updates <code>pendingCount$</code> when the request is started/finalized. |
 | [showError(e)](./kibana-plugin-plugins-data-public.searchinterceptor.showerror.md) | | |
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptordeps.md

@@ -15,6 +15,7 @@ export interface SearchInterceptorDeps
 | Property | Type | Description |
 | --- | --- | --- |
 | [http](./kibana-plugin-plugins-data-public.searchinterceptordeps.http.md) | <code>CoreSetup['http']</code> | |
+| [session](./kibana-plugin-plugins-data-public.searchinterceptordeps.session.md) | <code>ISessionService</code> | |
 | [startServices](./kibana-plugin-plugins-data-public.searchinterceptordeps.startservices.md) | <code>Promise&lt;[CoreStart, any, unknown]&gt;</code> | |
 | [toasts](./kibana-plugin-plugins-data-public.searchinterceptordeps.toasts.md) | <code>ToastsSetup</code> | |
 | [uiSettings](./kibana-plugin-plugins-data-public.searchinterceptordeps.uisettings.md) | <code>CoreSetup['uiSettings']</code> | |

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptordeps.session.md

@@ -0,0 +1,11 @@
+<!-- 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; [SearchInterceptorDeps](./kibana-plugin-plugins-data-public.searchinterceptordeps.md) &gt; [session](./kibana-plugin-plugins-data-public.searchinterceptordeps.session.md)
+
+## SearchInterceptorDeps.session property
+
+<b>Signature:</b>
+
+```typescript
+session: ISessionService;
+```

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchoptions.md

@@ -15,5 +15,6 @@ export interface ISearchOptions
 | Property | Type | Description |
 | --- | --- | --- |
 | [abortSignal](./kibana-plugin-plugins-data-server.isearchoptions.abortsignal.md) | <code>AbortSignal</code> | An <code>AbortSignal</code> that allows the caller of <code>search</code> to abort a search request. |
+| [sessionId](./kibana-plugin-plugins-data-server.isearchoptions.sessionid.md) | <code>string</code> | A session ID, grouping multiple search requests into a single session. |
 | [strategy](./kibana-plugin-plugins-data-server.isearchoptions.strategy.md) | <code>string</code> | Use this option to force using a specific server side search strategy. Leave empty to use the default strategy. |
 

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchoptions.sessionid.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-server](./kibana-plugin-plugins-data-server.md) &gt; [ISearchOptions](./kibana-plugin-plugins-data-server.isearchoptions.md) &gt; [sessionId](./kibana-plugin-plugins-data-server.isearchoptions.sessionid.md)
+
+## ISearchOptions.sessionId property
+
+A session ID, grouping multiple search requests into a single session.
+
+<b>Signature:</b>
+
+```typescript
+sessionId?: string;
+```

src/plugins/dashboard/public/application/dashboard_app_controller.tsx

@@ -144,7 +144,6 @@ export class DashboardAppController {
  notifications,
  overlays,
  chrome,
- injectedMetadata,
  fatalErrors,
  uiSettings,
  savedObjects,
@@ -527,9 +526,6 @@ export class DashboardAppController {
  filterManager.getFilters()
  );
 
- timefilter.disableTimeRangeSelector();
- timefilter.disableAutoRefreshSelector();
-
  const landingPageUrl = () => `#${DashboardConstants.LANDING_PAGE_PATH}`;
 
  const getDashTitle = () =>

src/plugins/data/common/mocks.ts

@@ -0,0 +1,20 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export { getSessionServiceMock } from './search/session/mocks';

src/plugins/data/common/search/es_search/types.ts

@@ -31,6 +31,11 @@ export interface ISearchOptions {
  * Use this option to force using a specific server side search strategy. Leave empty to use the default strategy.
  */
  strategy?: string;
+
+ /**
+ * A session ID, grouping multiple search requests into a single session.
+ */
+ sessionId?: string;
 }
 
 export type ISearchRequestParams<T = Record<string, any>> = {

src/plugins/data/common/search/index.ts

@@ -23,3 +23,4 @@ export * from './expressions';
 export * from './search_source';
 export * from './tabify';
 export * from './types';
+export * from './session';

src/plugins/data/common/search/session/index.ts

@@ -0,0 +1,20 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export * from './types';

src/plugins/data/common/search/session/mocks.ts

@@ -0,0 +1,29 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { ISessionService } from './types';
+
+export function getSessionServiceMock(): jest.Mocked<ISessionService> {
+ return {
+ clear: jest.fn(),
+ start: jest.fn(),
+ getSessionId: jest.fn(),
+ getSession$: jest.fn(),
+ };
+}

src/plugins/data/common/search/session/types.ts

@@ -0,0 +1,41 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Observable } from 'rxjs';
+
+export interface ISessionService {
+ /**
+ * Returns the active session ID
+ * @returns The active session ID
+ */
+ getSessionId: () => string | undefined;
+ /**
+ * Returns the observable that emits an update every time the session ID changes
+ * @returns `Observable`
+ */
+ getSession$: () => Observable<string | undefined>;
+ /**
+ * Starts a new session
+ */
+ start: () => string;
+ /**
+ * Clears the active session.
+ */
+ clear: () => void;
+}

src/plugins/data/public/public.api.md

@@ -1397,6 +1397,7 @@ export type ISearchGeneric = <SearchStrategyRequest extends IKibanaSearchRequest
 // @public (undocumented)
 export interface ISearchOptions {
  abortSignal?: AbortSignal;
+ sessionId?: string;
  strategy?: string;
 }
 
@@ -1412,6 +1413,9 @@ 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
  //
  // (undocumented)
@@ -1426,6 +1430,8 @@ 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;
 }
@@ -1995,7 +2001,7 @@ export class SearchInterceptor {
  // (undocumented)
  protected getTimeoutMode(): TimeoutErrorMode;
  // (undocumented)
- protected handleSearchError(e: any, request: IKibanaSearchRequest, timeoutSignal: AbortSignal, appAbortSignal?: AbortSignal): Error;
+ protected handleSearchError(e: any, request: IKibanaSearchRequest, timeoutSignal: AbortSignal, options?: ISearchOptions): Error;
  // @internal
  protected pendingCount$: BehaviorSubject<number>;
  // @internal (undocumented)
@@ -2006,8 +2012,8 @@ export class SearchInterceptor {
  abortSignal?: AbortSignal;
  timeout?: number;
  }): {
- combinedSignal: AbortSignal;
  timeoutSignal: AbortSignal;
+ combinedSignal: AbortSignal;
  cleanup: () => void;
  };
  // (undocumented)
@@ -2021,6 +2027,8 @@ export interface SearchInterceptorDeps {
  // (undocumented)
  http: CoreSetup_2['http'];
  // (undocumented)
+ session: ISessionService;
+ // (undocumented)
  startServices: Promise<[CoreStart, any, unknown]>;
  // (undocumented)
  toasts: ToastsSetup;

src/plugins/data/public/search/expressions/esaggs.ts

@@ -149,7 +149,9 @@ const handleCourierRequest = async ({
  request.stats(getRequestInspectorStats(requestSearchSource));
 
  try {
- const response = await requestSearchSource.fetch({ abortSignal });
+ const response = await requestSearchSource.fetch({
+ abortSignal,
+ });
 
  request.stats(getResponseInspectorStats(response, searchSource)).ok({ json: response });
 

src/plugins/data/public/search/mocks.ts

@@ -20,11 +20,13 @@
 import { searchAggsSetupMock, searchAggsStartMock } from './aggs/mocks';
 import { searchSourceMock } from './search_source/mocks';
 import { ISearchSetup, ISearchStart } from './types';
+import { getSessionServiceMock } from '../../common/mocks';
 
 function createSetupContract(): jest.Mocked<ISearchSetup> {
  return {
  aggs: searchAggsSetupMock(),
  __enhance: jest.fn(),
+ session: getSessionServiceMock(),
  };
 }
 
@@ -33,6 +35,7 @@ function createStartContract(): jest.Mocked<ISearchStart> {
  aggs: searchAggsStartMock(),
  search: jest.fn(),
  showError: jest.fn(),
+ session: getSessionServiceMock(),
  searchSource: searchSourceMock.createStartContract(),
  };
 }