[Search] Client side session service

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iscompleteresponse.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; [isCompleteResponse](./kibana-plugin-plugins-data-public.iscompleteresponse.md)
+
+## isCompleteResponse variable
+
+<b>Signature:</b>
+
+```typescript
+isCompleteResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined
+```

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> |  |
 |  [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,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; [ISearchOptions](./kibana-plugin-plugins-data-public.isearchoptions.md) &gt; [sessionId](./kibana-plugin-plugins-data-public.isearchoptions.sessionid.md)
+
+## ISearchOptions.sessionId property
+
+<b>Signature:</b>
+
+```typescript
+sessionId?: string;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iserrorresponse.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; [isErrorResponse](./kibana-plugin-plugins-data-public.iserrorresponse.md)
+
+## isErrorResponse variable
+
+<b>Signature:</b>
+
+```typescript
+isErrorResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ispartialresponse.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; [isPartialResponse](./kibana-plugin-plugins-data-public.ispartialresponse.md)
+
+## isPartialResponse variable
+
+<b>Signature:</b>
+
+```typescript
+isPartialResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined
+```

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

@@ -106,8 +106,11 @@
 |  [getKbnTypeNames](./kibana-plugin-plugins-data-public.getkbntypenames.md) | Get the esTypes known by all kbnFieldTypes {<!-- -->Array<string>} |
 |  [indexPatterns](./kibana-plugin-plugins-data-public.indexpatterns.md) |  |
 |  [injectSearchSourceReferences](./kibana-plugin-plugins-data-public.injectsearchsourcereferences.md) |  |
+|  [isCompleteResponse](./kibana-plugin-plugins-data-public.iscompleteresponse.md) |  |
+|  [isErrorResponse](./kibana-plugin-plugins-data-public.iserrorresponse.md) |  |
 |  [isFilter](./kibana-plugin-plugins-data-public.isfilter.md) |  |
 |  [isFilters](./kibana-plugin-plugins-data-public.isfilters.md) |  |
+|  [isPartialResponse](./kibana-plugin-plugins-data-public.ispartialresponse.md) |  |
 |  [isQuery](./kibana-plugin-plugins-data-public.isquery.md) |  |
 |  [isTimeRange](./kibana-plugin-plugins-data-public.istimerange.md) |  |
 |  [parseSearchSourceJSON](./kibana-plugin-plugins-data-public.parsesearchsourcejson.md) |  |

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

@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-QueryStringInput: React.FC<Pick<Props, "query" | "prepend" | "size" | "placeholder" | "onChange" | "onBlur" | "onSubmit" | "indexPatterns" | "dataTestSubj" | "screenTitle" | "disableAutoFocus" | "persistedLog" | "bubbleSubmitEvent" | "languageSwitcherPopoverAnchorPosition" | "onChangeQueryInputFocus">>
+QueryStringInput: React.FC<Pick<Props, "query" | "prepend" | "size" | "className" | "placeholder" | "onChange" | "onBlur" | "onSubmit" | "indexPatterns" | "dataTestSubj" | "screenTitle" | "disableAutoFocus" | "persistedLog" | "bubbleSubmitEvent" | "languageSwitcherPopoverAnchorPosition" | "onChangeQueryInputFocus">>
 ```

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

@@ -28,6 +28,9 @@ export declare class SearchInterceptor
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [getPendingCount$()](./kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md) |  | Returns an <code>Observable</code> over the current number of pending searches. This could mean that one of the search requests is still in flight, or that it has only received partial responses. |
+|  [onRequestComplete(request, sessionId)](./kibana-plugin-plugins-data-public.searchinterceptor.onrequestcomplete.md) |  |  |
+|  [onRequestError(request, sessionId)](./kibana-plugin-plugins-data-public.searchinterceptor.onrequesterror.md) |  |  |
+|  [onRequestStart(request, sessionId, timeoutSignal, searchId)](./kibana-plugin-plugins-data-public.searchinterceptor.onrequeststart.md) |  |  |
 |  [runSearch(request, signal, strategy)](./kibana-plugin-plugins-data-public.searchinterceptor.runsearch.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. |
 |  [setupTimers(options)](./kibana-plugin-plugins-data-public.searchinterceptor.setuptimers.md) |  |  |

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

@@ -0,0 +1,23 @@
+<!-- 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; [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) &gt; [onRequestComplete](./kibana-plugin-plugins-data-public.searchinterceptor.onrequestcomplete.md)
+
+## SearchInterceptor.onRequestComplete() method
+
+<b>Signature:</b>
+
+```typescript
+protected onRequestComplete(request: IEsSearchRequest, sessionId?: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | <code>IEsSearchRequest</code> |  |
+|  sessionId | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

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

@@ -0,0 +1,23 @@
+<!-- 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; [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) &gt; [onRequestError](./kibana-plugin-plugins-data-public.searchinterceptor.onrequesterror.md)
+
+## SearchInterceptor.onRequestError() method
+
+<b>Signature:</b>
+
+```typescript
+protected onRequestError(request: IEsSearchRequest, sessionId?: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | <code>IEsSearchRequest</code> |  |
+|  sessionId | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

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

@@ -0,0 +1,25 @@
+<!-- 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; [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) &gt; [onRequestStart](./kibana-plugin-plugins-data-public.searchinterceptor.onrequeststart.md)
+
+## SearchInterceptor.onRequestStart() method
+
+<b>Signature:</b>
+
+```typescript
+protected onRequestStart(request: IEsSearchRequest, sessionId: string | undefined, timeoutSignal: AbortSignal, searchId?: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | <code>IEsSearchRequest</code> |  |
+|  sessionId | <code>string &#124; undefined</code> |  |
+|  timeoutSignal | <code>AbortSignal</code> |  |
+|  searchId | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

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

@@ -8,6 +8,7 @@
 
 ```typescript
 protected setupTimers(options?: ISearchOptions): {
+        timeoutSignal: AbortSignal;
         combinedSignal: AbortSignal;
         cleanup: () => void;
     };
@@ -22,6 +23,7 @@ protected setupTimers(options?: ISearchOptions): {
 <b>Returns:</b>
 
 `{
+        timeoutSignal: AbortSignal;
         combinedSignal: AbortSignal;
         cleanup: () => void;
     }`

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.iscompleteresponse.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-server](./kibana-plugin-plugins-data-server.md) &gt; [isCompleteResponse](./kibana-plugin-plugins-data-server.iscompleteresponse.md)
+
+## isCompleteResponse variable
+
+<b>Signature:</b>
+
+```typescript
+isCompleteResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined
+```

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> |  |
 |  [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,11 @@
+<!-- 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
+
+<b>Signature:</b>
+
+```typescript
+sessionId?: string;
+```

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.iserrorresponse.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-server](./kibana-plugin-plugins-data-server.md) &gt; [isErrorResponse](./kibana-plugin-plugins-data-server.iserrorresponse.md)
+
+## isErrorResponse variable
+
+<b>Signature:</b>
+
+```typescript
+isErrorResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined
+```

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

@@ -77,6 +77,8 @@
 |  [esQuery](./kibana-plugin-plugins-data-server.esquery.md) |  |
 |  [fieldFormats](./kibana-plugin-plugins-data-server.fieldformats.md) |  |
 |  [indexPatterns](./kibana-plugin-plugins-data-server.indexpatterns.md) |  |
+|  [isCompleteResponse](./kibana-plugin-plugins-data-server.iscompleteresponse.md) |  |
+|  [isErrorResponse](./kibana-plugin-plugins-data-server.iserrorresponse.md) |  |
 |  [search](./kibana-plugin-plugins-data-server.search.md) |  |
 |  [UI\_SETTINGS](./kibana-plugin-plugins-data-server.ui_settings.md) |  |
 

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

@@ -140,12 +140,11 @@ export class DashboardAppController {
     dashboardCapabilities,
     scopedHistory,
     embeddableCapabilities: { visualizeCapabilities, mapsCapabilities },
-    data: { query: queryService },
+    data: { query: queryService, search: searchService },
     core: {
       notifications,
       overlays,
       chrome,
-      injectedMetadata,
       fatalErrors,
       uiSettings,
       savedObjects,
@@ -385,6 +384,8 @@ export class DashboardAppController {
         refreshInterval: timefilter.getRefreshInterval(),
       };
       $scope.panels = dashboardStateManager.getPanels();
+
+      searchService.session.start();
     };
 
     updateState();
@@ -531,9 +532,6 @@ export class DashboardAppController {
       filterManager.getFilters()
     );
 
-    timefilter.disableTimeRangeSelector();
-    timefilter.disableAutoRefreshSelector();
-
     const landingPageUrl = () => `#${DashboardConstants.LANDING_PAGE_PATH}`;
 
     const getDashTitle = () =>
@@ -598,6 +596,7 @@ export class DashboardAppController {
     const refreshDashboardContainer = () => {
       const changes = getChangesFromAppStateForContainerState();
       if (changes && dashboardContainer) {
+        // searchService.session.start();
         dashboardContainer.updateInput(changes);
       }
     };
@@ -1107,6 +1106,7 @@ export class DashboardAppController {
         $scope.model.query = queryStringManager.getQuery();
         dashboardStateManager.applyFilters($scope.model.query, $scope.model.filters);
         if (dashboardContainer) {
+          // searchService.session.start();
           dashboardContainer.updateInput({
             filters: $scope.model.filters,
             query: $scope.model.query,

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

@@ -24,3 +24,5 @@ export {
   ES_SEARCH_STRATEGY,
   ISearchOptions,
 } from './types';
+
+export * from './utils';

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

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

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

@@ -0,0 +1,32 @@
+/*
+ * 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 { IEsSearchResponse } from './types';
+
+export const isErrorResponse = (response?: IEsSearchResponse) => {
+  return !response || (!response.isRunning && response.isPartial);
+};
+
+export const isCompleteResponse = (response?: IEsSearchResponse) => {
+  return response && !response.isRunning && !response.isPartial;
+};
+
+export const isPartialResponse = (response?: IEsSearchResponse) => {
+  return response && response.isRunning && response.isPartial;
+};

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

@@ -23,10 +23,4 @@ export * from './expressions';
 export * from './tabify';
 export * from './types';
 
-export {
-  IEsSearchRequest,
-  IEsSearchResponse,
-  ES_SEARCH_STRATEGY,
-  ISearchRequestParams,
-  ISearchOptions,
-} from './es_search';
+export * from './es_search';

src/plugins/data/public/index.ts

@@ -365,7 +365,7 @@ export {
   EsRawResponseExpressionTypeDefinition,
 } from './search';
 
-export { ISearchOptions } from '../common';
+export { ISearchOptions, isErrorResponse, isCompleteResponse, isPartialResponse } from '../common';
 
 // Search namespace
 export const search = {

src/plugins/data/public/plugin.ts

@@ -210,6 +210,14 @@ export class DataPublicPlugin
       storage: this.storage,
     });
 
+    /*
+      Clear any open sessions upon navigation to make sure they are not used mistakenly by
+      another application.
+     */
+    core.application.currentAppId$.subscribe(() => {
+      search.session.clear();
+    });
+
     return {
       ...dataServices,
       ui: {