[SAVED_OBJECTS] [AGGS] Step I to add aggregations in the find of saved objects

docs/api/saved-objects/find.asciidoc

@@ -54,6 +54,10 @@ experimental[] Retrieve a paginated set of {kib} saved objects by various condit
   It should look like that savedObjectType.attributes.title: "myTitle". However, If you used a direct attribute of a saved object like `updatedAt`,
   you will have to define your filter like that savedObjectType.updatedAt > 2018-12-22.
 
+`aggs`::
+  (Optional, string) The aggs will support aggregation string with the caveat that your field from the aggregation will have the attribute from your type saved object, 
+  it should look like this: savedObjectType.attributes.field. However, If you use a direct attribute of a saved object like updatedAt, you will have to define your filter like this: savedObjectType.updatedAt.
+
 NOTE: As objects change in {kib}, the results on each page of the response also
 change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.
 

docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.find.md

@@ -9,7 +9,7 @@ Find all SavedObjects matching the search query
 <b>Signature:</b>
 
 ```typescript
-find<T = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T>>;
+find<T = unknown, A = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T, A>>;
 ```
 
 ## Parameters
@@ -20,5 +20,5 @@ find<T = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindRes
 
 <b>Returns:</b>
 
-`Promise<SavedObjectsFindResponse<T>>`
+`Promise<SavedObjectsFindResponse<T, A>>`
 

docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.aggs.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) &gt; [aggs](./kibana-plugin-core-server.savedobjectsfindoptions.aggs.md)
+
+## SavedObjectsFindOptions.aggs property
+
+<b>Signature:</b>
+
+```typescript
+aggs?: string;
+```

docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.md

@@ -15,6 +15,7 @@ export interface SavedObjectsFindOptions extends SavedObjectsBaseOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [aggs](./kibana-plugin-core-server.savedobjectsfindoptions.aggs.md) | <code>string</code> |  |
 |  [defaultSearchOperator](./kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md) | <code>'AND' &#124; 'OR'</code> |  |
 |  [fields](./kibana-plugin-core-server.savedobjectsfindoptions.fields.md) | <code>string[]</code> | An array of fields to include in the results |
 |  [filter](./kibana-plugin-core-server.savedobjectsfindoptions.filter.md) | <code>string</code> |  |

docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) &gt; [aggregations](./kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md)
+
+## SavedObjectsFindResponse.aggregations property
+
+<b>Signature:</b>
+
+```typescript
+aggregations?: A;
+```

docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.md

@@ -11,13 +11,14 @@ Return type of the Saved Objects `find()` method.
 <b>Signature:</b>
 
 ```typescript
-export interface SavedObjectsFindResponse<T = unknown> 
+export interface SavedObjectsFindResponse<T = unknown, A = unknown> 
 ```
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [aggregations](./kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md) | <code>A</code> |  |
 |  [page](./kibana-plugin-core-server.savedobjectsfindresponse.page.md) | <code>number</code> |  |
 |  [per\_page](./kibana-plugin-core-server.savedobjectsfindresponse.per_page.md) | <code>number</code> |  |
 |  [saved\_objects](./kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md) | <code>Array&lt;SavedObject&lt;T&gt;&gt;</code> |  |

docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.find.md

@@ -7,18 +7,18 @@
 <b>Signature:</b>
 
 ```typescript
-find<T = unknown>({ search, defaultSearchOperator, searchFields, hasReference, page, perPage, sortField, sortOrder, fields, namespace, type, filter, }: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T>>;
+find<T = unknown, A = unknown>({ search, defaultSearchOperator, searchFields, hasReference, page, perPage, sortField, sortOrder, fields, namespace, type, filter, aggs, }: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T, A>>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  { search, defaultSearchOperator, searchFields, hasReference, page, perPage, sortField, sortOrder, fields, namespace, type, filter, } | <code>SavedObjectsFindOptions</code> |  |
+|  { search, defaultSearchOperator, searchFields, hasReference, page, perPage, sortField, sortOrder, fields, namespace, type, filter, aggs, } | <code>SavedObjectsFindOptions</code> |  |
 
 <b>Returns:</b>
 
-`Promise<SavedObjectsFindResponse<T>>`
+`Promise<SavedObjectsFindResponse<T, A>>`
 
 {<!-- -->promise<!-- -->} - { saved\_objects: \[{ id, type, version, attributes }<!-- -->\], total, per\_page, page }
 

docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.md

@@ -23,7 +23,7 @@ export declare class SavedObjectsRepository
 |  [delete(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.delete.md) |  | Deletes an object |
 |  [deleteByNamespace(namespace, options)](./kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md) |  | Deletes all objects from the provided namespace. |
 |  [deleteFromNamespaces(type, id, namespaces, options)](./kibana-plugin-core-server.savedobjectsrepository.deletefromnamespaces.md) |  | Removes one or more namespaces from a given multi-namespace saved object. If no namespaces remain, the saved object is deleted entirely. This method and \[<code>addToNamespaces</code>\][SavedObjectsRepository.addToNamespaces()](./kibana-plugin-core-server.savedobjectsrepository.addtonamespaces.md) are the only ways to change which Spaces a multi-namespace saved object is shared to. |
-|  [find({ search, defaultSearchOperator, searchFields, hasReference, page, perPage, sortField, sortOrder, fields, namespace, type, filter, })](./kibana-plugin-core-server.savedobjectsrepository.find.md) |  |  |
+|  [find({ search, defaultSearchOperator, searchFields, hasReference, page, perPage, sortField, sortOrder, fields, namespace, type, filter, aggs, })](./kibana-plugin-core-server.savedobjectsrepository.find.md) |  |  |
 |  [get(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.get.md) |  | Gets a single object |
 |  [incrementCounter(type, id, counterFieldName, options)](./kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md) |  | Increases a counter field by one. Creates the document if one doesn't exist for the given id. |
 |  [update(type, id, attributes, options)](./kibana-plugin-core-server.savedobjectsrepository.update.md) |  | Updates an object |

src/core/public/saved_objects/saved_objects_client.ts

@@ -106,7 +106,9 @@ export interface SavedObjectsBatchResponse<T = unknown> {
  *
  * @public
  */
-export interface SavedObjectsFindResponsePublic<T = unknown> extends SavedObjectsBatchResponse<T> {
+export interface SavedObjectsFindResponsePublic<T = unknown, A = unknown>
+  extends SavedObjectsBatchResponse<T> {
+  aggregations?: A;
   total: number;
   perPage: number;
   page: number;
@@ -291,7 +293,7 @@ export class SavedObjectsClient {
    * @property {object} [options.hasReference] - { type, id }
    * @returns A find result with objects matching the specified search.
    */
-  public find = <T = unknown>(
+  public find = <T = unknown, A = unknown>(
     options: SavedObjectsFindOptions
   ): Promise<SavedObjectsFindResponsePublic<T>> => {
     const path = this.getPath(['_find']);
@@ -306,6 +308,7 @@ export class SavedObjectsClient {
       sortField: 'sort_field',
       type: 'type',
       filter: 'filter',
+      aggs: 'aggs',
     };
 
     const renamedQuery = renameKeys<SavedObjectsFindOptions, any>(renameMap, options);
@@ -322,13 +325,14 @@ export class SavedObjectsClient {
         SavedObjectsFindResponsePublic
       >(
         {
+          aggregations: 'aggregations',
           saved_objects: 'savedObjects',
           total: 'total',
           per_page: 'perPage',
           page: 'page',
         },
         resp
-      ) as SavedObjectsFindResponsePublic<T>;
+      ) as SavedObjectsFindResponsePublic<T, A>;
     });
   };
 

src/core/server/saved_objects/routes/find.ts

@@ -45,6 +45,7 @@ export const registerFindRoute = (router: IRouter) => {
           ),
           fields: schema.maybe(schema.oneOf([schema.string(), schema.arrayOf(schema.string())])),
           filter: schema.maybe(schema.string()),
+          aggs: schema.maybe(schema.string()),
         }),
       },
     },
@@ -62,6 +63,7 @@ export const registerFindRoute = (router: IRouter) => {
         hasReference: query.has_reference,
         fields: typeof query.fields === 'string' ? [query.fields] : query.fields,
         filter: query.filter,
+        aggs: query.aggs,
       });
 
       return res.ok({ body: result });

src/core/server/saved_objects/service/lib/aggs_utils.test.ts

@@ -0,0 +1,103 @@
+/*
+ * 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 { validateGetSavedObjectAggs } from './aggs_utils';
+import { mockMappings } from './filter_utils.test';
+
+describe('Filter Utils', () => {
+  describe('#validateGetSavedObjectAggs', () => {
+    test('Validate a simple aggregations', () => {
+      expect(
+        validateGetSavedObjectAggs(
+          ['foo'],
+          { aggName: { max: { field: 'foo.attributes.bytes' } } },
+          mockMappings
+        )
+      ).toEqual({
+        aggName: {
+          max: {
+            field: 'foo.bytes',
+          },
+        },
+      });
+    });
+    test('Validate a nested simple aggregations', () => {
+      expect(
+        validateGetSavedObjectAggs(
+          ['alert'],
+          { aggName: { cardinality: { field: 'alert.attributes.actions.group' } } },
+          mockMappings
+        )
+      ).toEqual({
+        aggName: {
+          cardinality: {
+            field: 'alert.actions.group',
+          },
+        },
+      });
+    });
+
+    test('Throw an error when types is not allowed', () => {
+      expect(() => {
+        validateGetSavedObjectAggs(
+          ['alert'],
+          {
+            aggName: {
+              max: { field: 'foo.attributes.bytes' },
+            },
+          },
+          mockMappings
+        );
+      }).toThrowErrorMatchingInlineSnapshot(`"This type foo is not allowed: Bad Request"`);
+    });
+
+    test('Throw an error when aggregation is not defined in  SavedObjectAggs', () => {
+      expect(() => {
+        validateGetSavedObjectAggs(
+          ['foo'],
+          {
+            aggName: {
+              MySuperAgg: { field: 'foo.attributes.bytes' },
+            },
+          },
+          mockMappings
+        );
+      }).toThrowErrorMatchingInlineSnapshot(
+        `"Invalid value {\\"aggName\\":{\\"MySuperAgg\\":{\\"field\\":\\"foo.attributes.bytes\\"}}} supplied to : { [K in string]: ((Partial<{ filter: { term: { [K in string]: string } }, histogram: ({ field: string } & { interval: number } & Partial<{ min_doc_count: number, extended_bounds: { min: number, max: number }, keyed: boolean, missing: number, order: { [K in string]: desc } }>), terms: ({ field: string } & Partial<{ field: string, size: number, show_term_doc_count_error: boolean, order: { [K in string]: desc } }>) }> & Partial<{ avg: { field: string }, weighted_avg: ({ value: ({ field: string } & Partial<{ missing: number }>), weight: ({ field: string } & Partial<{ missing: number }>) } & Partial<{ format: string, value_type: string }>), cardinality: { field: string }, max: ({ field: string } & Partial<{ missing: number }>), min: ({ field: string } & Partial<{ missing: number }>), top_hits: Partial<{ explain: boolean, from: string, highlight: any, seq_no_primary_term: boolean, size: number, sort: any, stored_fields: Array<string>, version: boolean, _name: string, _source: Partial<{ includes: Array<string>, excludes: Array<string> }> }> }>) & Partial<{ aggs: (Partial<{ filter: { term: { [K in string]: string } }, histogram: ({ field: string } & { interval: number } & Partial<{ min_doc_count: number, extended_bounds: { min: number, max: number }, keyed: boolean, missing: number, order: { [K in string]: desc } }>), terms: ({ field: string } & Partial<{ field: string, size: number, show_term_doc_count_error: boolean, order: { [K in string]: desc } }>) }> & Partial<{ avg: { field: string }, weighted_avg: ({ value: ({ field: string } & Partial<{ missing: number }>), weight: ({ field: string } & Partial<{ missing: number }>) } & Partial<{ format: string, value_type: string }>), cardinality: { field: string }, max: ({ field: string } & Partial<{ missing: number }>), min: ({ field: string } & Partial<{ missing: number }>), top_hits: Partial<{ explain: boolean, from: string, highlight: any, seq_no_primary_term: boolean, size: number, sort: any, stored_fields: Array<string>, version: boolean, _name: string, _source: Partial<{ includes: Array<string>, excludes: Array<string> }> }> }>) }>) }, excess properties: [\\"MySuperAgg\\"]: Bad Request"`
+      );
+    });
+
+    test('Throw an error when you add attributes who are not defined in SavedObjectAggs', () => {
+      expect(() => {
+        validateGetSavedObjectAggs(
+          ['alert'],
+          {
+            aggName: {
+              cardinality: { field: 'alert.attributes.actions.group' },
+              script: 'I want to access that I should not',
+            },
+          },
+          mockMappings
+        );
+      }).toThrowErrorMatchingInlineSnapshot(
+        `"Invalid value {\\"aggName\\":{\\"cardinality\\":{\\"field\\":\\"alert.attributes.actions.group\\"},\\"script\\":\\"I want to access that I should not\\"}} supplied to : { [K in string]: ((Partial<{ filter: { term: { [K in string]: string } }, histogram: ({ field: string } & { interval: number } & Partial<{ min_doc_count: number, extended_bounds: { min: number, max: number }, keyed: boolean, missing: number, order: { [K in string]: desc } }>), terms: ({ field: string } & Partial<{ field: string, size: number, show_term_doc_count_error: boolean, order: { [K in string]: desc } }>) }> & Partial<{ avg: { field: string }, weighted_avg: ({ value: ({ field: string } & Partial<{ missing: number }>), weight: ({ field: string } & Partial<{ missing: number }>) } & Partial<{ format: string, value_type: string }>), cardinality: { field: string }, max: ({ field: string } & Partial<{ missing: number }>), min: ({ field: string } & Partial<{ missing: number }>), top_hits: Partial<{ explain: boolean, from: string, highlight: any, seq_no_primary_term: boolean, size: number, sort: any, stored_fields: Array<string>, version: boolean, _name: string, _source: Partial<{ includes: Array<string>, excludes: Array<string> }> }> }>) & Partial<{ aggs: (Partial<{ filter: { term: { [K in string]: string } }, histogram: ({ field: string } & { interval: number } & Partial<{ min_doc_count: number, extended_bounds: { min: number, max: number }, keyed: boolean, missing: number, order: { [K in string]: desc } }>), terms: ({ field: string } & Partial<{ field: string, size: number, show_term_doc_count_error: boolean, order: { [K in string]: desc } }>) }> & Partial<{ avg: { field: string }, weighted_avg: ({ value: ({ field: string } & Partial<{ missing: number }>), weight: ({ field: string } & Partial<{ missing: number }>) } & Partial<{ format: string, value_type: string }>), cardinality: { field: string }, max: ({ field: string } & Partial<{ missing: number }>), min: ({ field: string } & Partial<{ missing: number }>), top_hits: Partial<{ explain: boolean, from: string, highlight: any, seq_no_primary_term: boolean, size: number, sort: any, stored_fields: Array<string>, version: boolean, _name: string, _source: Partial<{ includes: Array<string>, excludes: Array<string> }> }> }>) }>) }, excess properties: [\\"script\\"]: Bad Request"`
+      );
+    });
+  });
+});

src/core/server/saved_objects/service/lib/aggs_utils.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 { IndexMapping } from '../../mappings';
+
+import { SavedObjectsErrorHelpers } from './errors';
+import { hasFilterKeyError } from './filter_utils';
+import { SavedObjectAggs, validateSavedObjectTypeAggs } from './saved_object_aggs_types';
+
+export const validateGetSavedObjectAggs = (
+  allowedTypes: string[],
+  aggs: SavedObjectAggs,
+  indexMapping: IndexMapping
+): SavedObjectAggs => {
+  validateSavedObjectTypeAggs(aggs);
+  return validateGetAggFieldValue(allowedTypes, aggs, indexMapping);
+};
+
+const validateGetAggFieldValue = (
+  allowedTypes: string[],
+  aggs: any,
+  indexMapping: IndexMapping
+): SavedObjectAggs => {
+  return Object.keys(aggs).reduce((acc, key) => {
+    if (key === 'field') {
+      const error = hasFilterKeyError(aggs[key], allowedTypes, indexMapping);
+      if (error != null) {
+        throw SavedObjectsErrorHelpers.createBadRequestError(error);
+      }
+      return {
+        ...acc,
+        [key]: aggs[key].replace('.attributes', ''),
+      };
+    } else if (typeof aggs[key] === 'object') {
+      return { ...acc, [key]: validateGetAggFieldValue(allowedTypes, aggs[key], indexMapping) };
+    }
+    return {
+      ...acc,
+      [key]: aggs[key],
+    };
+  }, {});
+};

src/core/server/saved_objects/service/lib/filter_utils.test.ts

@@ -21,7 +21,7 @@ import { esKuery } from '../../../../../plugins/data/server';
 
 import { validateFilterKueryNode, validateConvertFilterToKueryNode } from './filter_utils';
 
-const mockMappings = {
+export const mockMappings = {
   properties: {
     updatedAt: {
       type: 'date',

src/core/server/saved_objects/service/lib/index.ts

@@ -30,3 +30,5 @@ export {
 } from './scoped_client_provider';
 
 export { SavedObjectsErrorHelpers } from './errors';
+
+export { SavedObjectAggs } from './saved_object_aggs_types';