[Spaces] Space-Aware Saved Objects

src/core_plugins/kibana/ui_setting_defaults.js

@@ -511,4 +511,4 @@ export function getUiSettingDefaults() {
       category: ['discover'],
     },
   };
-}
+}

src/server/saved_objects/service/lib/repository.js

@@ -36,7 +36,7 @@ export class SavedObjectsRepository {
       index,
       mappings,
       callCluster,
-      onBeforeWrite = () => {},
+      onBeforeWrite = () => { },
     } = options;
 
     this._index = index;
@@ -54,11 +54,13 @@ export class SavedObjectsRepository {
    * @param {object} [options={}]
    * @property {string} [options.id] - force id on creation, not recommended
    * @property {boolean} [options.overwrite=false]
+   * @property {object} [options.extraDocumentProperties={}] - extra properties to append to the document body, outside of the object's type property
    * @returns {promise} - { id, type, version, attributes }
   */
   async create(type, attributes = {}, options = {}) {
     const {
       id,
+      extraDocumentProperties = {},
       overwrite = false
     } = options;
 
@@ -72,9 +74,10 @@ export class SavedObjectsRepository {
         index: this._index,
         refresh: 'wait_for',
         body: {
+          ...extraDocumentProperties,
           type,
           updated_at: time,
-          [type]: attributes
+          [type]: attributes,
         },
       });
 
@@ -98,7 +101,7 @@ export class SavedObjectsRepository {
   /**
    * Creates multiple documents at once
    *
-   * @param {array} objects - [{ type, id, attributes }]
+   * @param {array} objects - [{ type, id, attributes, extraDocumentProperties }]
    * @param {object} [options={}]
    * @property {boolean} [options.overwrite=false] - overwrites existing documents
    * @returns {promise} -  {saved_objects: [[{ id, type, version, attributes, error: { message } }]}
@@ -119,9 +122,10 @@ export class SavedObjectsRepository {
           }
         },
         {
+          ...object.extraDocumentProperties,
           type: object.type,
           updated_at: time,
-          [object.type]: object.attributes
+          [object.type]: object.attributes,
         }
       ];
     };
@@ -216,6 +220,7 @@ export class SavedObjectsRepository {
    * @property {string} [options.search]
    * @property {Array<string>} [options.searchFields] - see Elasticsearch Simple Query String
    *                                        Query field argument for more information
+   * @property {object} [options.filters] - ES Query filters to append
    * @property {integer} [options.page=1]
    * @property {integer} [options.perPage=20]
    * @property {string} [options.sortField]
@@ -233,6 +238,7 @@ export class SavedObjectsRepository {
       sortField,
       sortOrder,
       fields,
+      filters,
     } = options;
 
     if (searchFields && !Array.isArray(searchFields)) {
@@ -243,6 +249,10 @@ export class SavedObjectsRepository {
       throw new TypeError('options.searchFields must be an array');
     }
 
+    if (filters && !Array.isArray(filters)) {
+      throw new TypeError('options.filters must be an array');
+    }
+
     const esOptions = {
       index: this._index,
       size: perPage,
@@ -256,7 +266,8 @@ export class SavedObjectsRepository {
           searchFields,
           type,
           sortField,
-          sortOrder
+          sortOrder,
+          filters
         })
       }
     };
@@ -295,6 +306,8 @@ export class SavedObjectsRepository {
    * Returns an array of objects by id
    *
    * @param {array} objects - an array ids, or an array of objects containing id and optionally type
+   * @param {object} [options = {}]
+   * @param {array} [options.extraDocumentProperties = []] - an array of extra properties to return from the underlying document
    * @returns {promise} - { saved_objects: [{ id, type, version, attributes }] }
    * @example
    *
@@ -303,7 +316,7 @@ export class SavedObjectsRepository {
    *   { id: 'foo', type: 'index-pattern' }
    * ])
    */
-  async bulkGet(objects = []) {
+  async bulkGet(objects = [], options = {}) {
     if (objects.length === 0) {
       return { saved_objects: [] };
     }
@@ -318,8 +331,12 @@ export class SavedObjectsRepository {
       }
     });
 
+    const { docs } = response;
+
+    const { extraDocumentProperties = [] } = options;
+
     return {
-      saved_objects: response.docs.map((doc, i) => {
+      saved_objects: docs.map((doc, i) => {
         const { id, type } = objects[i];
 
         if (!doc.found) {
@@ -331,13 +348,20 @@ export class SavedObjectsRepository {
         }
 
         const time = doc._source.updated_at;
-        return {
+        const savedObject = {
           id,
           type,
           ...time && { updated_at: time },
           version: doc._version,
-          attributes: doc._source[type]
+          ...extraDocumentProperties
+            .map(s => ({ [s]: doc._source[s] }))
+            .reduce((acc, prop) => ({ ...acc, ...prop }), {}),
+          attributes: {
+            ...doc._source[type],
+          }
         };
+
+        return savedObject;
       })
     };
   }
@@ -347,9 +371,11 @@ export class SavedObjectsRepository {
    *
    * @param {string} type
    * @param {string} id
+   * @param {object} [options = {}]
+   * @param {array} [options.extraDocumentProperties = []] - an array of extra properties to return from the underlying document
    * @returns {promise} - { id, type, version, attributes }
    */
-  async get(type, id) {
+  async get(type, id, options = {}) {
     const response = await this._callCluster('get', {
       id: this._generateEsId(type, id),
       type: this._type,
@@ -364,14 +390,21 @@ export class SavedObjectsRepository {
       throw errors.createGenericNotFoundError(type, id);
     }
 
+    const { extraDocumentProperties = [] } = options;
+
     const { updated_at: updatedAt } = response._source;
 
     return {
       id,
       type,
       ...updatedAt && { updated_at: updatedAt },
       version: response._version,
-      attributes: response._source[type]
+      ...extraDocumentProperties
+        .map(s => ({ [s]: response._source[s] }))
+        .reduce((acc, prop) => ({ ...acc, ...prop }), {}),
+      attributes: {
+        ...response._source[type],
+      }
     };
   }
 
@@ -382,6 +415,7 @@ export class SavedObjectsRepository {
    * @param {string} id
    * @param {object} [options={}]
    * @property {integer} options.version - ensures version matches that of persisted object
+   * @param {array} [options.extraDocumentProperties = {}] - an object of extra properties to write into the underlying document
    * @returns {promise}
    */
   async update(type, id, attributes, options = {}) {
@@ -395,8 +429,9 @@ export class SavedObjectsRepository {
       ignore: [404],
       body: {
         doc: {
+          ...options.extraDocumentProperties,
           updated_at: time,
-          [type]: attributes
+          [type]: attributes,
         }
       },
     });