[Saved Queries] Improve saved query management

packages/kbn-check-mappings-update-cli/current_fields.json

@@ -172,7 +172,8 @@
   ],
   "query": [
     "description",
-    "title"
+    "title",
+    "titleKeyword"
   ],
   "kql-telemetry": [],
   "search-session": [

packages/kbn-check-mappings-update-cli/current_mappings.json

@@ -572,6 +572,9 @@
       "title": {
         "type": "text"
       },
+      "titleKeyword": {
+        "type": "keyword"
+      },
       "description": {
         "type": "text"
       }

src/core/server/integration_tests/ci_checks/saved_objects/check_registered_types.test.ts

@@ -130,7 +130,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "osquery-pack-asset": "cd140bc2e4b092e93692b587bf6e38051ef94c75",
         "osquery-saved-query": "6095e288750aa3164dfe186c74bc5195c2bf2bd4",
         "policy-settings-protection-updates-note": "33924bb246f9e5bcb876109cc83e3c7a28308352",
-        "query": "21cbbaa09abb679078145ce90087b1e88b7eae95",
+        "query": "501bece68f26fe561286a488eabb1a8ab12f1137",
         "risk-engine-configuration": "b105d4a3c6adce40708d729d12e5ef3c8fbd9508",
         "rules-settings": "892a2918ebaeba809a612b8d97cec0b07c800b5f",
         "sample-data-telemetry": "37441b12f5b0159c2d6d5138a494c9f440e950b5",

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

@@ -38,7 +38,7 @@ const createStartContractMock = () => {
     addToQueryLog: jest.fn(),
     filterManager: createFilterManagerMock(),
     queryString: queryStringManagerMock.createStartContract(),
-    savedQueries: { getSavedQuery: jest.fn() } as any,
+    savedQueries: { getSavedQuery: jest.fn(), getSavedQueryCount: jest.fn() } as any,
     state$: new Observable(),
     getState: jest.fn(),
     timefilter: timefilterServiceMock.createStartContract(),

src/plugins/data/public/query/saved_query/saved_query_service.test.ts

@@ -19,7 +19,6 @@ const {
   findSavedQueries,
   createQuery,
   updateQuery,
-  getAllSavedQueries,
   getSavedQueryCount,
 } = createSavedQueryService(http);
 
@@ -64,19 +63,6 @@ describe('saved query service', () => {
     });
   });
 
-  describe('getAllSavedQueries', function () {
-    it('should post and extract the saved queries from the response', async () => {
-      http.post.mockResolvedValue({
-        total: 0,
-        savedQueries: [{ attributes: savedQueryAttributes }],
-      });
-      const result = await getAllSavedQueries();
-      expect(http.post).toBeCalled();
-      expect(http.post).toHaveBeenCalledWith(`${SAVED_QUERY_BASE_URL}/_all`, { version });
-      expect(result).toEqual([{ attributes: savedQueryAttributes }]);
-    });
-  });
-
   describe('findSavedQueries', function () {
     it('should post and return the total & saved queries', async () => {
       http.post.mockResolvedValue({

src/plugins/data/public/query/saved_query/saved_query_service.ts

@@ -30,15 +30,6 @@ export const createSavedQueryService = (http: HttpStart) => {
     return savedQuery;
   };
 
-  // we have to tell the saved objects client how many to fetch, otherwise it defaults to fetching 20 per page
-  const getAllSavedQueries = async (): Promise<SavedQuery[]> => {
-    const { savedQueries } = await http.post<{ savedQueries: SavedQuery[] }>(
-      `${SAVED_QUERY_BASE_URL}/_all`,
-      { version }
-    );
-    return savedQueries;
-  };
-
   // findSavedQueries will do a 'match_all' if no search string is passed in
   const findSavedQueries = async (
     search: string = '',
@@ -71,7 +62,6 @@ export const createSavedQueryService = (http: HttpStart) => {
   return {
     createQuery,
     updateQuery,
-    getAllSavedQueries,
     findSavedQueries,
     getSavedQuery,
     deleteSavedQuery,

src/plugins/data/public/query/saved_query/types.ts

@@ -19,7 +19,6 @@ export type { SavedQuery, SavedQueryAttributes };
 export interface SavedQueryService {
   createQuery: (attributes: SavedQueryAttributes) => Promise<SavedQuery>;
   updateQuery: (id: string, attributes: SavedQueryAttributes) => Promise<SavedQuery>;
-  getAllSavedQueries: () => Promise<SavedQuery[]>;
   findSavedQueries: (
     searchText?: string,
     perPage?: number,

src/plugins/data/server/query/route_handler_context.test.ts

@@ -10,7 +10,10 @@ import { coreMock } from '@kbn/core/server/mocks';
 import { FilterStateStore, Query } from '@kbn/es-query';
 import { DATA_VIEW_SAVED_OBJECT_TYPE } from '../../common';
 import type { SavedObject, SavedQueryAttributes } from '../../common';
-import { registerSavedQueryRouteHandlerContext } from './route_handler_context';
+import {
+  InternalSavedQueryAttributes,
+  registerSavedQueryRouteHandlerContext,
+} from './route_handler_context';
 import { SavedObjectsFindResponse, SavedObjectsUpdateResponse } from '@kbn/core/server';
 
 const mockContext = {
@@ -31,6 +34,10 @@ const savedQueryAttributes: SavedQueryAttributes = {
   },
   filters: [],
 };
+const internalSavedQueryAttributes: InternalSavedQueryAttributes = {
+  ...savedQueryAttributes,
+  titleKeyword: 'foo',
+};
 const savedQueryAttributesBar: SavedQueryAttributes = {
   title: 'bar',
   description: 'baz',
@@ -90,19 +97,23 @@ describe('saved query route handler context', () => {
 
   describe('create', function () {
     it('should create a saved object for the given attributes', async () => {
-      const mockResponse: SavedObject<SavedQueryAttributes> = {
+      const mockResponse: SavedObject<InternalSavedQueryAttributes> = {
         id: 'foo',
         type: 'query',
-        attributes: savedQueryAttributes,
+        attributes: internalSavedQueryAttributes,
         references: [],
       };
       mockSavedObjectsClient.create.mockResolvedValue(mockResponse);
 
       const response = await context.create(savedQueryAttributes);
 
-      expect(mockSavedObjectsClient.create).toHaveBeenCalledWith('query', savedQueryAttributes, {
-        references: [],
-      });
+      expect(mockSavedObjectsClient.create).toHaveBeenCalledWith(
+        'query',
+        internalSavedQueryAttributes,
+        {
+          references: [],
+        }
+      );
       expect(response).toEqual({
         id: 'foo',
         attributes: savedQueryAttributes,
@@ -117,10 +128,13 @@ describe('saved query route handler context', () => {
           query: { match_all: {} },
         },
       };
-      const mockResponse: SavedObject<SavedQueryAttributes> = {
+      const mockResponse: SavedObject<InternalSavedQueryAttributes> = {
         id: 'foo',
         type: 'query',
-        attributes: savedQueryAttributesWithQueryObject,
+        attributes: {
+          ...savedQueryAttributesWithQueryObject,
+          titleKeyword: 'foo',
+        },
         references: [],
       };
       mockSavedObjectsClient.create.mockResolvedValue(mockResponse);
@@ -136,10 +150,13 @@ describe('saved query route handler context', () => {
         filters: savedQueryAttributesWithFilters.filters,
         timefilter: savedQueryAttributesWithFilters.timefilter,
       };
-      const mockResponse: SavedObject<SavedQueryAttributes> = {
+      const mockResponse: SavedObject<InternalSavedQueryAttributes> = {
         id: 'foo',
         type: 'query',
-        attributes: serializedSavedQueryAttributesWithFilters,
+        attributes: {
+          ...serializedSavedQueryAttributesWithFilters,
+          titleKeyword: 'foo',
+        },
         references: [],
       };
       mockSavedObjectsClient.create.mockResolvedValue(mockResponse);
@@ -176,10 +193,10 @@ describe('saved query route handler context', () => {
 
   describe('update', function () {
     it('should update a saved object for the given attributes', async () => {
-      const mockResponse: SavedObject<SavedQueryAttributes> = {
+      const mockResponse: SavedObject<InternalSavedQueryAttributes> = {
         id: 'foo',
         type: 'query',
-        attributes: savedQueryAttributes,
+        attributes: internalSavedQueryAttributes,
         references: [],
       };
       mockSavedObjectsClient.update.mockResolvedValue(mockResponse);
@@ -189,7 +206,7 @@ describe('saved query route handler context', () => {
       expect(mockSavedObjectsClient.update).toHaveBeenCalledWith(
         'query',
         'foo',
-        savedQueryAttributes,
+        internalSavedQueryAttributes,
         {
           references: [],
         }
@@ -241,6 +258,14 @@ describe('saved query route handler context', () => {
 
       const response = await context.find();
 
+      expect(mockSavedObjectsClient.find).toHaveBeenCalledWith({
+        type: 'query',
+        page: 1,
+        perPage: 50,
+        search: '',
+        sortField: 'titleKeyword',
+        sortOrder: 'asc',
+      });
       expect(response.savedQueries).toEqual([{ id: 'foo', attributes: savedQueryAttributes }]);
     });
 
@@ -274,10 +299,12 @@ describe('saved query route handler context', () => {
       const response = await context.find({ search: 'foo' });
 
       expect(mockSavedObjectsClient.find).toHaveBeenCalledWith({
+        type: 'query',
         page: 1,
         perPage: 50,
         search: 'foo',
-        type: 'query',
+        sortField: undefined,
+        sortOrder: undefined,
       });
       expect(response.savedQueries).toEqual([{ id: 'foo', attributes: savedQueryAttributes }]);
     });
@@ -361,6 +388,8 @@ describe('saved query route handler context', () => {
         page: 1,
         perPage: 2,
         search: '',
+        sortField: 'titleKeyword',
+        sortOrder: 'asc',
         type: 'query',
       });
       expect(response.savedQueries).toEqual(
@@ -568,6 +597,11 @@ describe('saved query route handler context', () => {
 
       const response = await context.count();
 
+      expect(mockSavedObjectsClient.find).toHaveBeenCalledWith({
+        type: 'query',
+        page: 0,
+        perPage: 0,
+      });
       expect(response).toEqual(1);
     });
   });

src/plugins/data/server/query/route_handler_context.ts

@@ -8,15 +8,24 @@
 
 import { CustomRequestHandlerContext, RequestHandlerContext, SavedObject } from '@kbn/core/server';
 import { isFilters, isOfQueryType } from '@kbn/es-query';
+import { omit } from 'lodash';
 import { isQuery, SavedQueryAttributes } from '../../common';
 import { extract, inject } from '../../common/query/filters/persistable_state';
 
+export interface InternalSavedQueryAttributes extends SavedQueryAttributes {
+  titleKeyword: string;
+}
+
 function injectReferences({
   id,
-  attributes,
+  attributes: internalAttributes,
   namespaces,
   references,
-}: Pick<SavedObject<SavedQueryAttributes>, 'id' | 'attributes' | 'namespaces' | 'references'>) {
+}: Pick<
+  SavedObject<InternalSavedQueryAttributes>,
+  'id' | 'attributes' | 'namespaces' | 'references'
+>) {
+  const attributes: SavedQueryAttributes = omit(internalAttributes, 'titleKeyword');
   const { query } = attributes;
   if (isOfQueryType(query) && typeof query.query === 'string') {
     try {
@@ -48,8 +57,9 @@ function extractReferences({
     }
   }
 
-  const attributes: SavedQueryAttributes = {
+  const attributes: InternalSavedQueryAttributes = {
     title: title.trim(),
+    titleKeyword: title.trim(),
     description: description.trim(),
     query: {
       ...query,
@@ -83,7 +93,7 @@ export async function registerSavedQueryRouteHandlerContext(context: RequestHand
     verifySavedQuery(attrs);
     const { attributes, references } = extractReferences(attrs);
 
-    const savedObject = await soClient.create<SavedQueryAttributes>('query', attributes, {
+    const savedObject = await soClient.create<InternalSavedQueryAttributes>('query', attributes, {
       references,
     });
 
@@ -97,9 +107,14 @@ export async function registerSavedQueryRouteHandlerContext(context: RequestHand
     verifySavedQuery(attrs);
     const { attributes, references } = extractReferences(attrs);
 
-    const savedObject = await soClient.update<SavedQueryAttributes>('query', id, attributes, {
-      references,
-    });
+    const savedObject = await soClient.update<InternalSavedQueryAttributes>(
+      'query',
+      id,
+      attributes,
+      {
+        references,
+      }
+    );
 
     // TODO: Handle properly
     if (savedObject.error) throw new Error(savedObject.error.message);
@@ -108,10 +123,8 @@ export async function registerSavedQueryRouteHandlerContext(context: RequestHand
   };
 
   const getSavedQuery = async (id: string) => {
-    const { saved_object: savedObject, outcome } = await soClient.resolve<SavedQueryAttributes>(
-      'query',
-      id
-    );
+    const { saved_object: savedObject, outcome } =
+      await soClient.resolve<InternalSavedQueryAttributes>('query', id);
     if (outcome === 'conflict') {
       throw new Error(`Multiple saved queries found with ID: ${id} (legacy URL alias conflict)`);
     } else if (savedObject.error) {
@@ -121,41 +134,30 @@ export async function registerSavedQueryRouteHandlerContext(context: RequestHand
   };
 
   const getSavedQueriesCount = async () => {
-    const { total } = await soClient.find<SavedQueryAttributes>({
+    const { total } = await soClient.find<InternalSavedQueryAttributes>({
       type: 'query',
+      page: 0,
+      perPage: 0,
     });
     return total;
   };
 
   const findSavedQueries = async ({ page = 1, perPage = 50, search = '' } = {}) => {
-    const { total, saved_objects: savedObjects } = await soClient.find<SavedQueryAttributes>({
-      type: 'query',
-      page,
-      perPage,
-      search,
-    });
+    const { total, saved_objects: savedObjects } =
+      await soClient.find<InternalSavedQueryAttributes>({
+        type: 'query',
+        page,
+        perPage,
+        search,
+        sortField: search ? undefined : 'titleKeyword',
+        sortOrder: search ? undefined : 'asc',
+      });
 
     const savedQueries = savedObjects.map(injectReferences);
 
     return { total, savedQueries };
   };
 
-  const getAllSavedQueries = async () => {
-    const finder = soClient.createPointInTimeFinder<SavedQueryAttributes>({
-      type: 'query',
-      perPage: 100,
-    });
-
-    const savedObjects: Array<SavedObject<SavedQueryAttributes>> = [];
-    for await (const response of finder.find()) {
-      savedObjects.push(...(response.saved_objects ?? []));
-    }
-    await finder.close();
-
-    const savedQueries = savedObjects.map(injectReferences);
-    return { total: savedQueries.length, savedQueries };
-  };
-
   const deleteSavedQuery = async (id: string) => {
     return await soClient.delete('query', id, { force: true });
   };
@@ -166,7 +168,6 @@ export async function registerSavedQueryRouteHandlerContext(context: RequestHand
     get: getSavedQuery,
     count: getSavedQueriesCount,
     find: findSavedQueries,
-    getAll: getAllSavedQueries,
     delete: deleteSavedQuery,
   };
 }