[data.search] Add search session methods to search service contract

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchsessionservice.asscopedprovider.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; [ISearchSessionService](./kibana-plugin-plugins-data-server.isearchsessionservice.md) &gt; [asScopedProvider](./kibana-plugin-plugins-data-server.isearchsessionservice.asscopedprovider.md)
+
+## ISearchSessionService.asScopedProvider property
+
+<b>Signature:</b>
+
+```typescript
+asScopedProvider: (core: CoreStart) => (request: KibanaRequest) => IScopedSearchSessionsClient<T>;
+```

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

@@ -0,0 +1,18 @@
+<!-- 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; [ISearchSessionService](./kibana-plugin-plugins-data-server.isearchsessionservice.md)
+
+## ISearchSessionService interface
+
+<b>Signature:</b>
+
+```typescript
+export interface ISearchSessionService<T = unknown> 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [asScopedProvider](./kibana-plugin-plugins-data-server.isearchsessionservice.asscopedprovider.md) | <code>(core: CoreStart) =&gt; (request: KibanaRequest) =&gt; IScopedSearchSessionsClient&lt;T&gt;</code> |  |
+

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

@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-asScoped: (request: KibanaRequest) => ISearchClient;
+asScoped: (request: KibanaRequest) => IScopedSearchClient;
 ```

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

@@ -15,7 +15,7 @@ export interface ISearchStart<SearchStrategyRequest extends IKibanaSearchRequest
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [aggs](./kibana-plugin-plugins-data-server.isearchstart.aggs.md) | <code>AggsStart</code> |  |
-|  [asScoped](./kibana-plugin-plugins-data-server.isearchstart.asscoped.md) | <code>(request: KibanaRequest) =&gt; ISearchClient</code> |  |
+|  [asScoped](./kibana-plugin-plugins-data-server.isearchstart.asscoped.md) | <code>(request: KibanaRequest) =&gt; IScopedSearchClient</code> |  |
 |  [getSearchStrategy](./kibana-plugin-plugins-data-server.isearchstart.getsearchstrategy.md) | <code>(name?: string) =&gt; ISearchStrategy&lt;SearchStrategyRequest, SearchStrategyResponse&gt;</code> | Get other registered search strategies by name (or, by default, the Elasticsearch strategy). For example, if a new strategy needs to use the already-registered ES search strategy, it can use this function to accomplish that. |
 |  [searchSource](./kibana-plugin-plugins-data-server.isearchstart.searchsource.md) | <code>{</code><br/><code>        asScoped: (request: KibanaRequest) =&gt; Promise&lt;ISearchStartSearchSource&gt;;</code><br/><code>    }</code> |  |
 

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

@@ -14,7 +14,11 @@
 |  [IndexPatternsService](./kibana-plugin-plugins-data-server.indexpatternsservice.md) |  |
 |  [OptionedParamType](./kibana-plugin-plugins-data-server.optionedparamtype.md) |  |
 |  [Plugin](./kibana-plugin-plugins-data-server.plugin.md) |  |
+<<<<<<< HEAD
+|  [SearchSessionService](./kibana-plugin-plugins-data-server.searchsessionservice.md) | The OSS session service, which leaves most search session-related logic unimplemented.  x-pack/plugins/data\_enhanced/server/search/session/session\_service.ts |
+=======
 |  [SessionService](./kibana-plugin-plugins-data-server.sessionservice.md) | The OSS session service. See data\_enhanced in X-Pack for the search session service. |
+>>>>>>> master
 
 ## Enumerations
 
@@ -53,10 +57,10 @@
 |  [IFieldType](./kibana-plugin-plugins-data-server.ifieldtype.md) |  |
 |  [IndexPatternAttributes](./kibana-plugin-plugins-data-server.indexpatternattributes.md) |  |
 |  [ISearchOptions](./kibana-plugin-plugins-data-server.isearchoptions.md) |  |
+|  [ISearchSessionService](./kibana-plugin-plugins-data-server.isearchsessionservice.md) |  |
 |  [ISearchSetup](./kibana-plugin-plugins-data-server.isearchsetup.md) |  |
 |  [ISearchStart](./kibana-plugin-plugins-data-server.isearchstart.md) |  |
 |  [ISearchStrategy](./kibana-plugin-plugins-data-server.isearchstrategy.md) | Search strategy interface contains a search method that takes in a request and returns a promise that resolves to a response. |
-|  [ISessionService](./kibana-plugin-plugins-data-server.isessionservice.md) |  |
 |  [KueryNode](./kibana-plugin-plugins-data-server.kuerynode.md) |  |
 |  [OptionedValueProp](./kibana-plugin-plugins-data-server.optionedvalueprop.md) |  |
 |  [PluginSetup](./kibana-plugin-plugins-data-server.pluginsetup.md) |  |

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.searchsessionservice._constructor_.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; [SearchSessionService](./kibana-plugin-plugins-data-server.searchsessionservice.md) &gt; [(constructor)](./kibana-plugin-plugins-data-server.searchsessionservice._constructor_.md)
+
+## SearchSessionService.(constructor)
+
+Constructs a new instance of the `SearchSessionService` class
+
+<b>Signature:</b>
+
+```typescript
+constructor();
+```

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

@@ -0,0 +1,35 @@
+<!-- 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; [SearchSessionService](./kibana-plugin-plugins-data-server.searchsessionservice.md) &gt; [asScopedProvider](./kibana-plugin-plugins-data-server.searchsessionservice.asscopedprovider.md)
+
+## SearchSessionService.asScopedProvider() method
+
+<b>Signature:</b>
+
+```typescript
+asScopedProvider(): () => {
+        getId: () => never;
+        trackId: () => Promise<void>;
+        getSearchIdMapping: () => Promise<Map<string, string>>;
+        save: () => Promise<never>;
+        get: () => Promise<never>;
+        find: () => Promise<never>;
+        update: () => Promise<never>;
+        extend: () => Promise<never>;
+        cancel: () => Promise<never>;
+    };
+```
+<b>Returns:</b>
+
+`() => {
+        getId: () => never;
+        trackId: () => Promise<void>;
+        getSearchIdMapping: () => Promise<Map<string, string>>;
+        save: () => Promise<never>;
+        get: () => Promise<never>;
+        find: () => Promise<never>;
+        update: () => Promise<never>;
+        extend: () => Promise<never>;
+        cancel: () => Promise<never>;
+    }`
+

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

@@ -0,0 +1,26 @@
+<!-- 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; [SearchSessionService](./kibana-plugin-plugins-data-server.searchsessionservice.md)
+
+## SearchSessionService class
+
+The OSS session service, which leaves most search session-related logic unimplemented.  x-pack/plugins/data\_enhanced/server/search/session/session\_service.ts
+
+<b>Signature:</b>
+
+```typescript
+export declare class SearchSessionService implements ISearchSessionService 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)()](./kibana-plugin-plugins-data-server.searchsessionservice._constructor_.md) |  | Constructs a new instance of the <code>SearchSessionService</code> class |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [asScopedProvider()](./kibana-plugin-plugins-data-server.searchsessionservice.asscopedprovider.md) |  |  |
+

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

@@ -16,5 +16,6 @@ export interface SearchStrategyDependencies
 |  --- | --- | --- |
 |  [esClient](./kibana-plugin-plugins-data-server.searchstrategydependencies.esclient.md) | <code>IScopedClusterClient</code> |  |
 |  [savedObjectsClient](./kibana-plugin-plugins-data-server.searchstrategydependencies.savedobjectsclient.md) | <code>SavedObjectsClientContract</code> |  |
+|  [searchSessionsClient](./kibana-plugin-plugins-data-server.searchstrategydependencies.searchsessionsclient.md) | <code>IScopedSearchSessionsClient</code> |  |
 |  [uiSettingsClient](./kibana-plugin-plugins-data-server.searchstrategydependencies.uisettingsclient.md) | <code>IUiSettingsClient</code> |  |
 

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.searchstrategydependencies.searchsessionsclient.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; [SearchStrategyDependencies](./kibana-plugin-plugins-data-server.searchstrategydependencies.md) &gt; [searchSessionsClient](./kibana-plugin-plugins-data-server.searchstrategydependencies.searchsessionsclient.md)
+
+## SearchStrategyDependencies.searchSessionsClient property
+
+<b>Signature:</b>
+
+```typescript
+searchSessionsClient: IScopedSearchSessionsClient;
+```

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

@@ -28,6 +28,7 @@ export function getSessionsClientMock(): jest.Mocked<ISessionsClient> {
     create: jest.fn(),
     find: jest.fn(),
     update: jest.fn(),
+    extend: jest.fn(),
     delete: jest.fn(),
   };
 }

src/plugins/data/public/search/session/sessions_client.ts

@@ -79,6 +79,12 @@ export class SessionsClient {
     });
   }
 
+  public extend(sessionId: string, keepAlive: string): Promise<SavedObjectsFindResponse> {
+    return this.http!.post(`/internal/session/${encodeURIComponent(sessionId)}/_extend`, {
+      body: JSON.stringify({ keepAlive }),
+    });
+  }
+
   public delete(sessionId: string): Promise<void> {
     return this.http!.delete(`/internal/session/${encodeURIComponent(sessionId)}`);
   }

src/plugins/data/server/index.ts

@@ -244,8 +244,8 @@ export {
   searchUsageObserver,
   shimAbortSignal,
   SearchUsage,
-  SessionService,
-  ISessionService,
+  SearchSessionService,
+  ISearchSessionService,
 } from './search';
 
 // Search namespace

src/plugins/data/server/mocks.ts

@@ -17,7 +17,12 @@
  * under the License.
  */
 
-import { createSearchSetupMock, createSearchStartMock } from './search/mocks';
+import { RequestHandlerContext } from 'kibana/server';
+import {
+  createSearchSetupMock,
+  createSearchStartMock,
+  createSearchRequestHandlerContext,
+} from './search/mocks';
 import { createFieldFormatsSetupMock, createFieldFormatsStartMock } from './field_formats/mocks';
 import { createIndexPatternsStartMock } from './index_patterns/mocks';
 
@@ -36,7 +41,14 @@ function createStartContract() {
   };
 }
 
+function createRequestHandlerContext() {
+  return ({
+    search: createSearchRequestHandlerContext(),
+  } as unknown) as jest.Mocked<RequestHandlerContext>;
+}
+
 export const dataPluginMock = {
   createSetupContract,
   createStartContract,
+  createRequestHandlerContext,
 };

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

@@ -21,6 +21,8 @@ import { ISearchSetup, ISearchStart } from './types';
 import { searchAggsSetupMock, searchAggsStartMock } from './aggs/mocks';
 import { searchSourceMock } from './search_source/mocks';
 
+export { createSearchSessionsClientMock } from './session/mocks';
+
 export function createSearchSetupMock(): jest.Mocked<ISearchSetup> {
   return {
     aggs: searchAggsSetupMock(),
@@ -33,10 +35,21 @@ export function createSearchStartMock(): jest.Mocked<ISearchStart> {
   return {
     aggs: searchAggsStartMock(),
     getSearchStrategy: jest.fn(),
-    asScoped: jest.fn().mockReturnValue({
-      search: jest.fn(),
-      cancel: jest.fn(),
-    }),
+    asScoped: jest.fn().mockReturnValue(createSearchRequestHandlerContext()),
     searchSource: searchSourceMock.createStartContract(),
   };
 }
+
+export function createSearchRequestHandlerContext() {
+  return {
+    search: jest.fn(),
+    cancel: jest.fn(),
+    extend: jest.fn(),
+    saveSession: jest.fn(),
+    getSession: jest.fn(),
+    findSessions: jest.fn(),
+    updateSession: jest.fn(),
+    extendSession: jest.fn(),
+    cancelSession: jest.fn(),
+  };
+}