[data / search session] BWCA all the routes

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

@@ -10,7 +10,6 @@ import { PublicContract } from '@kbn/utility-types';
 import { HttpSetup } from '@kbn/core/public';
 import type {
   SavedObject,
-  SavedObjectsFindResponse,
   SavedObjectsUpdateResponse,
   SavedObjectsFindOptions,
 } from '@kbn/core/server';
@@ -24,6 +23,9 @@ export interface SessionsClientDeps {
   http: HttpSetup;
 }
 
+const version = '1';
+const options = { version };
+
 /**
  * CRUD Search Session SO
  */
@@ -35,7 +37,7 @@ export class SessionsClient {
   }
 
   public get(sessionId: string): Promise<SearchSessionSavedObject> {
-    return this.http.get(`/internal/session/${encodeURIComponent(sessionId)}`);
+    return this.http.get(`/internal/session/${encodeURIComponent(sessionId)}`, options);
   }
 
   public create({
@@ -54,6 +56,7 @@ export class SessionsClient {
     sessionId: string;
   }): Promise<SearchSessionSavedObject> {
     return this.http.post(`/internal/session`, {
+      version,
       body: JSON.stringify({
         name,
         appId,
@@ -65,9 +68,10 @@ export class SessionsClient {
     });
   }
 
-  public find(options: Omit<SavedObjectsFindOptions, 'type'>): Promise<SearchSessionsFindResponse> {
+  public find(opts: Omit<SavedObjectsFindOptions, 'type'>): Promise<SearchSessionsFindResponse> {
     return this.http!.post(`/internal/session/_find`, {
-      body: JSON.stringify(options),
+      version,
+      body: JSON.stringify(opts),
     });
   }
 
@@ -76,27 +80,23 @@ export class SessionsClient {
     attributes: unknown
   ): Promise<SavedObjectsUpdateResponse<SearchSessionSavedObjectAttributes>> {
     return this.http!.put(`/internal/session/${encodeURIComponent(sessionId)}`, {
+      version,
       body: JSON.stringify(attributes),
     });
   }
 
-  public rename(
-    sessionId: string,
-    newName: string
-  ): Promise<SavedObjectsUpdateResponse<Pick<SearchSessionSavedObjectAttributes, 'name'>>> {
-    return this.update(sessionId, { name: newName });
+  public async rename(sessionId: string, newName: string): Promise<void> {
+    await this.update(sessionId, { name: newName });
   }
 
-  public extend(
-    sessionId: string,
-    expires: string
-  ): Promise<SavedObjectsFindResponse<SearchSessionSavedObjectAttributes>> {
-    return this.http!.post(`/internal/session/${encodeURIComponent(sessionId)}/_extend`, {
+  public async extend(sessionId: string, expires: string): Promise<void> {
+    await this.http!.post(`/internal/session/${encodeURIComponent(sessionId)}/_extend`, {
+      version,
       body: JSON.stringify({ expires }),
     });
   }
 
   public delete(sessionId: string): Promise<void> {
-    return this.http!.delete(`/internal/session/${encodeURIComponent(sessionId)}`);
+    return this.http!.delete(`/internal/session/${encodeURIComponent(sessionId)}`, options);
   }
 }

src/plugins/data/server/index.ts

@@ -71,7 +71,12 @@ export type {
   DataRequestHandlerContext,
   AsyncSearchStatusResponse,
 } from './search';
-export { shimHitsTotal, SearchSessionService, NoSearchIdInSessionError } from './search';
+export {
+  shimHitsTotal,
+  SearchSessionService,
+  NoSearchIdInSessionError,
+  INITIAL_SEARCH_SESSION_REST_VERSION,
+} from './search';
 
 // Search namespace
 export const search = {

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

@@ -15,3 +15,4 @@ export { usageProvider, searchUsageObserver } from './collectors/search';
 export * from './aggs';
 export * from './session';
 export * from './errors/no_search_id_in_session';
+export { INITIAL_SEARCH_SESSION_REST_VERSION } from './routes/session';

src/plugins/data/server/search/routes/response_schema.ts

@@ -0,0 +1,72 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { schema } from '@kbn/config-schema';
+
+const searchSessionRequestInfoSchema = schema.object({
+  id: schema.string(),
+  strategy: schema.string(),
+});
+
+const serializeableSchema = schema.mapOf(schema.string(), schema.any());
+
+const searchSessionAttrSchema = schema.object({
+  sessionId: schema.string(),
+  name: schema.maybe(schema.string()),
+  appId: schema.maybe(schema.string()),
+  created: schema.string(),
+  expires: schema.string(),
+  locatorId: schema.maybe(schema.string()),
+  initialState: schema.maybe(serializeableSchema),
+  restoreState: schema.maybe(serializeableSchema),
+  idMapping: schema.mapOf(schema.string(), searchSessionRequestInfoSchema),
+  realmType: schema.maybe(schema.string()),
+  realmName: schema.maybe(schema.string()),
+  username: schema.maybe(schema.string()),
+  version: schema.string(),
+  isCanceled: schema.maybe(schema.boolean()),
+});
+
+export const searchSessionSchema = schema.object({
+  id: schema.string(),
+  attributes: searchSessionAttrSchema,
+});
+
+export const searchSessionStatusSchema = schema.object({
+  status: schema.oneOf([
+    schema.literal('in_progress'),
+    schema.literal('error'),
+    schema.literal('complete'),
+    schema.literal('cancelled'),
+    schema.literal('expired'),
+  ]),
+  errors: schema.maybe(schema.arrayOf(schema.string())),
+});
+
+export const searchSessionsFindSchema = schema.object({
+  total: schema.number(),
+  saved_objects: schema.arrayOf(searchSessionSchema),
+  statuses: schema.recordOf(schema.string(), searchSessionStatusSchema),
+});
+
+const referencesSchema = schema.arrayOf(
+  schema.object({ id: schema.string(), type: schema.string(), name: schema.string() })
+);
+
+export const searchSessionsUpdateSchema = schema.object({
+  id: schema.string(),
+  type: schema.string(),
+  updated_at: schema.maybe(schema.string()),
+  version: schema.maybe(schema.string()),
+  namespaces: schema.maybe(schema.arrayOf(schema.string())),
+  references: schema.maybe(referencesSchema),
+  attributes: schema.object({
+    name: schema.maybe(schema.string()),
+    expires: schema.maybe(schema.string()),
+  }),
+});

src/plugins/data/server/search/routes/response_types.ts

@@ -0,0 +1,65 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { SerializableRecord } from '@kbn/utility-types';
+
+interface SearchSessionAttrRestResponse {
+  sessionId: string;
+  name?: string;
+  appId?: string;
+  created: string;
+  expires: string;
+  locatorId?: string;
+  initialState?: SerializableRecord;
+  restoreState?: SerializableRecord;
+  idMapping: Record<string, SearchSessionRequestInfoRestResponse>;
+  realmType?: string;
+  realmName?: string;
+  username?: string;
+  version: string;
+  isCanceled?: boolean;
+}
+
+interface SearchSessionRequestInfoRestResponse {
+  id: string;
+  strategy: string;
+}
+
+export interface SearchSessionRestResponse {
+  id: string;
+  attributes: SearchSessionAttrRestResponse;
+}
+
+export interface SearchSessionStatusRestResponse {
+  status: StatusRestRespone;
+  errors?: string[];
+}
+
+type StatusRestRespone = 'in_progress' | 'error' | 'complete' | 'cancelled' | 'expired';
+
+export interface SearchSessionsFindRestResponse {
+  saved_objects: SearchSessionRestResponse[];
+  total: number;
+  /**
+   * Map containing calculated statuses of search sessions from the find response
+   */
+  statuses: Record<string, SearchSessionStatusRestResponse>;
+}
+
+export interface SearchSessionsUpdateRestResponse {
+  id: string;
+  type: string;
+  updated_at?: string;
+  version?: string;
+  namespaces?: string[];
+  references?: Array<{ id: string; type: string; name: string }>;
+  attributes: {
+    name?: string;
+    expires?: string;
+  };
+}

src/plugins/data/server/search/routes/session.test.ts

@@ -15,6 +15,11 @@ import { dataPluginMock } from '../../mocks';
 
 import { registerSessionRoutes } from './session';
 
+enum GetHandlerIndex {
+  ID,
+  STATUS,
+}
+
 enum PostHandlerIndex {
   SAVE,
   FIND,
@@ -43,7 +48,8 @@ describe('registerSessionRoutes', () => {
     const mockResponse = httpServerMock.createResponseFactory();
 
     const mockRouter = mockCoreSetup.http.createRouter.mock.results[0].value;
-    const [, saveHandler] = mockRouter.post.mock.calls[PostHandlerIndex.SAVE];
+    const [[, saveHandler]] =
+      mockRouter.versioned.post.mock.results[PostHandlerIndex.SAVE].value.addVersion.mock.calls;
 
     await saveHandler(mockContext, mockRequest, mockResponse);
 
@@ -58,7 +64,7 @@ describe('registerSessionRoutes', () => {
     const mockResponse = httpServerMock.createResponseFactory();
 
     const mockRouter = mockCoreSetup.http.createRouter.mock.results[0].value;
-    const [[, getHandler]] = mockRouter.get.mock.calls;
+    const [[, getHandler]] = mockRouter.versioned.get.mock.results[0].value.addVersion.mock.calls;
 
     await getHandler(mockContext, mockRequest, mockResponse);
 
@@ -73,10 +79,12 @@ describe('registerSessionRoutes', () => {
     const mockResponse = httpServerMock.createResponseFactory();
 
     const mockRouter = mockCoreSetup.http.createRouter.mock.results[0].value;
-    const [[], [, statusHandler]] = mockRouter.get.mock.calls;
+    const [[, statusHandler]] =
+      mockRouter.versioned.get.mock.results[GetHandlerIndex.STATUS].value.addVersion.mock.calls;
 
     await statusHandler(mockContext, mockRequest, mockResponse);
 
+    expect(mockContext.search!.getSessionStatus).toHaveBeenCalled();
     expect(mockContext.search!.getSessionStatus).toHaveBeenCalledWith(id);
   });
 
@@ -92,7 +100,8 @@ describe('registerSessionRoutes', () => {
     const mockResponse = httpServerMock.createResponseFactory();
 
     const mockRouter = mockCoreSetup.http.createRouter.mock.results[0].value;
-    const [, findHandler] = mockRouter.post.mock.calls[PostHandlerIndex.FIND];
+    const [[, findHandler]] =
+      mockRouter.versioned.post.mock.results[PostHandlerIndex.FIND].value.addVersion.mock.calls;
 
     await findHandler(mockContext, mockRequest, mockResponse);
 
@@ -110,7 +119,8 @@ describe('registerSessionRoutes', () => {
     const mockResponse = httpServerMock.createResponseFactory();
 
     const mockRouter = mockCoreSetup.http.createRouter.mock.results[0].value;
-    const [, updateHandler] = mockRouter.put.mock.calls[0];
+    const [[, updateHandler]] =
+      mockRouter.versioned.put.mock.results[0].value.addVersion.mock.calls;
 
     await updateHandler(mockContext, mockRequest, mockResponse);
 
@@ -125,7 +135,8 @@ describe('registerSessionRoutes', () => {
     const mockResponse = httpServerMock.createResponseFactory();
 
     const mockRouter = mockCoreSetup.http.createRouter.mock.results[0].value;
-    const [, cancelHandler] = mockRouter.post.mock.calls[PostHandlerIndex.CANCEL];
+    const [[, cancelHandler]] =
+      mockRouter.versioned.post.mock.results[PostHandlerIndex.CANCEL].value.addVersion.mock.calls;
 
     await cancelHandler(mockContext, mockRequest, mockResponse);
 
@@ -140,7 +151,8 @@ describe('registerSessionRoutes', () => {
     const mockResponse = httpServerMock.createResponseFactory();
 
     const mockRouter = mockCoreSetup.http.createRouter.mock.results[0].value;
-    const [, deleteHandler] = mockRouter.delete.mock.calls[0];
+    const [[, deleteHandler]] =
+      mockRouter.versioned.delete.mock.results[0].value.addVersion.mock.calls;
 
     await deleteHandler(mockContext, mockRequest, mockResponse);
 
@@ -157,7 +169,8 @@ describe('registerSessionRoutes', () => {
     const mockResponse = httpServerMock.createResponseFactory();
 
     const mockRouter = mockCoreSetup.http.createRouter.mock.results[0].value;
-    const [, extendHandler] = mockRouter.post.mock.calls[PostHandlerIndex.EXTEND];
+    const [[, extendHandler]] =
+      mockRouter.versioned.post.mock.results[PostHandlerIndex.EXTEND].value.addVersion.mock.calls;
 
     await extendHandler(mockContext, mockRequest, mockResponse);