[Search Sessions] Save all sessions, with persisted flag

x-pack/plugins/data_enhanced/common/index.ts

@@ -5,6 +5,7 @@
  */
 
 export {
+  SEARCH_SESSION_TYPE,
   ENHANCED_ES_SEARCH_STRATEGY,
   EQL_SEARCH_STRATEGY,
   EqlRequestParams,

x-pack/plugins/data_enhanced/common/search/session/types.ts

@@ -6,19 +6,25 @@
 
 import { SearchSessionStatus } from './';
 
+export const SEARCH_SESSION_TYPE = 'search-session';
 export interface SearchSessionSavedObjectAttributes {
+  sessionId: string;
   /**
    * User-facing session name to be displayed in session management
    */
-  name: string;
+  name?: string;
   /**
    * App that created the session. e.g 'discover'
    */
-  appId: string;
+  appId?: string;
   /**
    * Creation time of the session
    */
   created: string;
+  /**
+   * Last touch time of the session
+   */
+  touched: string;
   /**
    * Expiration time of the session. Expiration itself is managed by Elasticsearch.
    */
@@ -30,22 +36,28 @@ export interface SearchSessionSavedObjectAttributes {
   /**
    * urlGeneratorId
    */
-  urlGeneratorId: string;
+  urlGeneratorId?: string;
   /**
    * The application state that was used to create the session.
    * Should be used, for example, to re-load an expired search session.
    */
-  initialState: Record<string, unknown>;
+  initialState?: Record<string, unknown>;
   /**
    * Application state that should be used to restore the session.
    * For example, relative dates are conveted to absolute ones.
    */
-  restoreState: Record<string, unknown>;
+  restoreState?: Record<string, unknown>;
   /**
    * Mapping of search request hashes to their corresponsing info (async search id, etc.)
    */
   idMapping: Record<string, SearchSessionRequestInfo>;
+
+  /**
+   * This value is true if the session was actively stored by the user. If it is false, the session may be purged by the system.
+   */
+  persisted: boolean;
 }
+
 export interface SearchSessionRequestInfo {
   /**
    * ID of the async search request

x-pack/plugins/data_enhanced/config.ts

@@ -12,7 +12,8 @@ export const configSchema = schema.object({
       enabled: schema.boolean({ defaultValue: false }),
       pageSize: schema.number({ defaultValue: 10000 }),
       trackingInterval: schema.duration({ defaultValue: '10s' }),
-      inMemTimeout: schema.duration({ defaultValue: '1m' }),
+      completedTimeout: schema.duration({ defaultValue: '5m' }),
+      notTouchedTimeout: schema.duration({ defaultValue: '1m' }),
       maxUpdateRetries: schema.number({ defaultValue: 3 }),
       defaultExpiration: schema.duration({ defaultValue: '7d' }),
       management: schema.object({

x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/api.ts

@@ -10,12 +10,11 @@ import moment from 'moment';
 import { from, race, timer } from 'rxjs';
 import { mapTo, tap } from 'rxjs/operators';
 import type { SharePluginStart } from 'src/plugins/share/public';
-import { SessionsConfigSchema } from '../';
-import type { ISessionsClient } from '../../../../../../../src/plugins/data/public';
-import type { SearchSessionSavedObjectAttributes } from '../../../../common';
+import { ISessionsClient } from '../../../../../../../src/plugins/data/public';
 import { SearchSessionStatus } from '../../../../common/search';
 import { ACTION } from '../components/actions';
-import { UISession } from '../types';
+import { PersistedSearchSessionSavedObjectAttributes, UISession } from '../types';
+import { SessionsConfigSchema } from '..';
 
 type UrlGeneratorsStart = SharePluginStart['urlGenerators'];
 
@@ -48,7 +47,7 @@ async function getUrlFromState(
 
 // Helper: factory for a function to map server objects to UI objects
 const mapToUISession = (urls: UrlGeneratorsStart, config: SessionsConfigSchema) => async (
-  savedObject: SavedObject<SearchSessionSavedObjectAttributes>
+  savedObject: SavedObject<PersistedSearchSessionSavedObjectAttributes>
 ): Promise<UISession> => {
   const {
     name,
@@ -110,6 +109,8 @@ export class SearchSessionsMgmtAPI {
         perPage: mgmtConfig.maxSessions,
         sortField: 'created',
         sortOrder: 'asc',
+        searchFields: ['persisted'],
+        search: 'true',
       })
     );
     const timeout$ = timer(refreshTimeout.asMilliseconds()).pipe(
@@ -129,7 +130,7 @@ export class SearchSessionsMgmtAPI {
       const result = await race<FetchResult | null>(fetch$, timeout$).toPromise();
       if (result && result.saved_objects) {
         const savedObjects = result.saved_objects as Array<
-          SavedObject<SearchSessionSavedObjectAttributes>
+          SavedObject<PersistedSearchSessionSavedObjectAttributes>
         >;
         return await Promise.all(savedObjects.map(mapToUISession(this.deps.urls, this.config)));
       }

x-pack/plugins/data_enhanced/public/search/sessions_mgmt/types.ts

@@ -4,11 +4,23 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { SearchSessionStatus } from '../../../common';
+import { SearchSessionSavedObjectAttributes, SearchSessionStatus } from '../../../common';
 import { ACTION } from './components/actions';
 
 export const DATE_STRING_FORMAT = 'D MMM, YYYY, HH:mm:ss';
 
+/**
+ * Some properties are optional for a non-persisted Search Session.
+ * This interface makes them mandatory, because management only shows persisted search sessions.
+ */
+export type PersistedSearchSessionSavedObjectAttributes = SearchSessionSavedObjectAttributes &
+  Required<
+    Pick<
+      SearchSessionSavedObjectAttributes,
+      'name' | 'appId' | 'urlGeneratorId' | 'initialState' | 'restoreState'
+    >
+  >;
+
 export interface UISession {
   id: string;
   name: string;

x-pack/plugins/data_enhanced/server/plugin.ts

@@ -5,6 +5,7 @@
  */
 
 import { CoreSetup, CoreStart, Logger, Plugin, PluginInitializerContext } from 'kibana/server';
+import { Observable } from 'rxjs';
 import { TaskManagerSetupContract, TaskManagerStartContract } from '../../task_manager/server';
 import {
   PluginSetup as DataPluginSetup,
@@ -22,6 +23,7 @@ import {
 } from './search';
 import { getUiSettings } from './ui_settings';
 import type { DataEnhancedRequestHandlerContext } from './type';
+import { ConfigSchema } from '../config';
 
 interface SetupDependencies {
   data: DataPluginSetup;
@@ -37,9 +39,11 @@ export class EnhancedDataServerPlugin
   implements Plugin<void, void, SetupDependencies, StartDependencies> {
   private readonly logger: Logger;
   private sessionService!: SearchSessionService;
+  private config$: Observable<ConfigSchema>;
 
-  constructor(private initializerContext: PluginInitializerContext) {
+  constructor(private initializerContext: PluginInitializerContext<ConfigSchema>) {
     this.logger = initializerContext.logger.get('data_enhanced');
+    this.config$ = this.initializerContext.config.create();
   }
 
   public setup(core: CoreSetup<DataPluginStart>, deps: SetupDependencies) {
@@ -51,6 +55,7 @@ export class EnhancedDataServerPlugin
     deps.data.search.registerSearchStrategy(
       ENHANCED_ES_SEARCH_STRATEGY,
       enhancedEsSearchStrategyProvider(
+        this.config$,
         this.initializerContext.config.legacy.globalConfig$,
         this.logger,
         usage

x-pack/plugins/data_enhanced/server/routes/session.ts

@@ -91,18 +91,22 @@ export function registerSessionRoutes(router: DataEnhancedPluginRouter, logger:
           sortField: schema.maybe(schema.string()),
           sortOrder: schema.maybe(schema.string()),
           filter: schema.maybe(schema.string()),
+          searchFields: schema.maybe(schema.arrayOf(schema.string())),
+          search: schema.maybe(schema.string()),
         }),
       },
     },
     async (context, request, res) => {
-      const { page, perPage, sortField, sortOrder, filter } = request.body;
+      const { page, perPage, sortField, sortOrder, filter, searchFields, search } = request.body;
       try {
         const response = await context.search!.session.find({
           page,
           perPage,
           sortField,
           sortOrder,
           filter,
+          searchFields,
+          search,
         });
 
         return res.ok({

x-pack/plugins/data_enhanced/server/saved_objects/search_session.ts

@@ -5,15 +5,17 @@
  */
 
 import { SavedObjectsType } from 'kibana/server';
-
-export const SEARCH_SESSION_TYPE = 'search-session';
+import { SEARCH_SESSION_TYPE } from '../../common';
 
 export const searchSessionMapping: SavedObjectsType = {
   name: SEARCH_SESSION_TYPE,
   namespaceType: 'single',
   hidden: true,
   mappings: {
     properties: {
+      persisted: {
+        type: 'boolean',
+      },
       sessionId: {
         type: 'keyword',
       },
@@ -26,6 +28,9 @@ export const searchSessionMapping: SavedObjectsType = {
       expires: {
         type: 'date',
       },
+      touched: {
+        type: 'date',
+      },
       status: {
         type: 'keyword',
       },

x-pack/plugins/data_enhanced/server/search/eql_search_strategy.test.ts

@@ -117,7 +117,6 @@ describe('EQL search strategy', () => {
         expect(request).toEqual(
           expect.objectContaining({
             wait_for_completion_timeout: '100ms',
-            keep_alive: '1m',
           })
         );
       });
@@ -156,7 +155,6 @@ describe('EQL search strategy', () => {
         expect(request).toEqual(
           expect.objectContaining({
             wait_for_completion_timeout: '5ms',
-            keep_alive: '1m',
             keep_on_completion: false,
           })
         );

x-pack/plugins/data_enhanced/server/search/eql_search_strategy.ts

@@ -22,7 +22,8 @@ export const eqlSearchStrategyProvider = (
   logger: Logger
 ): ISearchStrategy<EqlSearchStrategyRequest, EqlSearchStrategyResponse> => {
   async function cancelAsyncSearch(id: string, esClient: IScopedClusterClient) {
-    await esClient.asCurrentUser.asyncSearch.delete({ id });
+    const client = esClient.asCurrentUser.eql;
+    await client.delete({ id });
   }
 
   return {
@@ -41,11 +42,11 @@ export const eqlSearchStrategyProvider = (
           uiSettingsClient
         );
         const params = id
-          ? getDefaultAsyncGetParams()
+          ? getDefaultAsyncGetParams(options)
           : {
               ...(await getIgnoreThrottled(uiSettingsClient)),
               ...defaultParams,
-              ...getDefaultAsyncGetParams(),
+              ...getDefaultAsyncGetParams(options),
               ...request.params,
             };
         const promise = id