Saved Object Namespaces (#22357)

* Adding a namespace * Allowing the saved objects client wrappers to specify the namespace * Moving namespace agnosticism to OSS * Fixing rbac tests, spaces can be managed with the SOC temporarily * Putting trimIdPrefix back to it's original name * Removing unused code and debug statements * Fixing some jsdocs * Removing unused type parameter * Another stray console.log... * Fixing repository provider test * Fixing repository tests * No longer exposing the namespace in get and bulkGet * Fixing SavedObjectClient tests, using more Symbols... It ends up that two different instances of {} are considered to be equal by jest's .toHaveBeenCalledWith, so for these white-box tests we're just using Symbols... * Fixing getSearchDsl tests * Removing filters, we don't use them anymore * Fixing query param tests * Adding Schema tests * Fixing secure saved objects client test * Namespaces via options * Removing duplicate test * Removing spaceId from mappings * Fixing test * Registering the namespace agnostic types using uiExports * Even better schema
elastic · Sep 4, 2018 · 8b77134 · 8b77134
1 parent e4ebd0b
commit 8b77134
Show file tree

Hide file tree

Showing 45 changed files with 1,283 additions and 2,681 deletions.
diff --git a/src/server/mappings/kibana_index_mappings_mixin.js b/src/server/mappings/kibana_index_mappings_mixin.js
@@ -29,6 +29,9 @@ const BASE_SAVED_OBJECT_MAPPINGS = {
   doc: {
     dynamic: 'strict',
     properties: {
+      namespace: {
+        type: 'keyword'
+      },
       type: {
         type: 'keyword'
       },

diff --git a/src/server/saved_objects/saved_objects_mixin.js b/src/server/saved_objects/saved_objects_mixin.js
@@ -54,7 +54,7 @@ export function savedObjectsMixin(kbnServer, server) {
   server.route(createGetRoute(prereqs));
   server.route(createUpdateRoute(prereqs));
 
-  server.decorate('server', 'savedObjects', createSavedObjectsService(server));
+  server.decorate('server', 'savedObjects', createSavedObjectsService(server, kbnServer.uiExports.savedObjectsSchema));
 
   const savedObjectsClientCache = new WeakMap();
   server.decorate('request', 'getSavedObjectsClient', function () {

diff --git a/src/server/saved_objects/service/create_saved_objects_service.js b/src/server/saved_objects/service/create_saved_objects_service.js
@@ -17,11 +17,11 @@
  * under the License.
  */
 
-import { getRootPropertiesObjects } from '../..//mappings';
-import { SavedObjectsRepository, ScopedSavedObjectsClientProvider, SavedObjectsRepositoryProvider } from './lib';
+import { getRootPropertiesObjects } from '../../mappings';
+import { SavedObjectsRepository, ScopedSavedObjectsClientProvider, SavedObjectsRepositoryProvider, SavedObjectsSchema } from './lib';
 import { SavedObjectsClient } from './saved_objects_client';
 
-export function createSavedObjectsService(server) {
+export function createSavedObjectsService(server, uiExportsSchema) {
   const onBeforeWrite = async () => {
     const adminCluster = server.plugins.elasticsearch.getCluster('admin');
 
@@ -59,10 +59,13 @@ export function createSavedObjectsService(server) {
     }
   };
 
+  const schema = new SavedObjectsSchema(uiExportsSchema);
+
   const mappings = server.getKibanaIndexMappingsDsl();
   const repositoryProvider = new SavedObjectsRepositoryProvider({
     index: server.config().get('kibana.index'),
     mappings,
+    schema,
     onBeforeWrite,
   });
 
@@ -86,6 +89,7 @@ export function createSavedObjectsService(server) {
     types: Object.keys(getRootPropertiesObjects(mappings)),
     SavedObjectsClient,
     SavedObjectsRepository,
+    schema,
     getSavedObjectsRepository: (...args) =>
       repositoryProvider.getRepository(...args),
     getScopedSavedObjectsClient: (...args) =>

diff --git a/src/server/saved_objects/service/lib/index.js b/src/server/saved_objects/service/lib/index.js
@@ -20,6 +20,7 @@
 export { SavedObjectsRepository } from './repository';
 export { ScopedSavedObjectsClientProvider } from './scoped_client_provider';
 export { SavedObjectsRepositoryProvider } from './repository_provider';
+export { SavedObjectsSchema } from './schema';
 
 import * as errors from './errors';
 export { errors };
diff --git a/src/server/saved_objects/service/lib/repository.js b/src/server/saved_objects/service/lib/repository.js
@@ -35,12 +35,14 @@ export class SavedObjectsRepository {
     const {
       index,
       mappings,
+      schema,
       callCluster,
       onBeforeWrite = () => { },
     } = options;
 
     this._index = index;
     this._mappings = mappings;
+    this._schema = schema;
     this._type = getRootType(this._mappings);
     this._onBeforeWrite = onBeforeWrite;
     this._unwrappedCallCluster = callCluster;
@@ -54,35 +56,35 @@ 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
+   * @property {string} [options.namespace]
    * @returns {promise} - { id, type, version, attributes }
   */
   async create(type, attributes = {}, options = {}) {
     const {
       id,
-      extraDocumentProperties = {},
-      overwrite = false
+      overwrite = false,
+      namespace,
     } = options;
 
     const method = id && !overwrite ? 'create' : 'index';
     const time = this._getCurrentTime();
 
     try {
       const response = await this._writeToCluster(method, {
-        id: this._generateEsId(type, id),
+        id: this._generateEsId(namespace, type, id),
         type: this._type,
         index: this._index,
         refresh: 'wait_for',
         body: {
-          ...extraDocumentProperties,
+          ...namespace && !this._schema.isNamespaceAgnostic(type) && { namespace },
           type,
           updated_at: time,
           [type]: attributes,
         },
       });
 
       return {
-        id: trimIdPrefix(response._id, type),
+        id: trimIdPrefix(this._schema, response._id, namespace, type),
         type,
         updated_at: time,
         version: response._version,
@@ -101,14 +103,16 @@ export class SavedObjectsRepository {
   /**
    * Creates multiple documents at once
    *
-   * @param {array} objects - [{ type, id, attributes, extraDocumentProperties }]
+   * @param {array} objects - [{ type, id, attributes }]
    * @param {object} [options={}]
    * @property {boolean} [options.overwrite=false] - overwrites existing documents
+   * @property {string} [options.namespace]
    * @returns {promise} -  {saved_objects: [[{ id, type, version, attributes, error: { message } }]}
    */
   async bulkCreate(objects, options = {}) {
     const {
-      overwrite = false
+      overwrite = false,
+      namespace
     } = options;
     const time = this._getCurrentTime();
     const objectToBulkRequest = (object) => {
@@ -117,12 +121,12 @@ export class SavedObjectsRepository {
       return [
         {
           [method]: {
-            _id: this._generateEsId(object.type, object.id),
+            _id: this._generateEsId(namespace, object.type, object.id),
             _type: this._type,
           }
         },
         {
-          ...object.extraDocumentProperties,
+          ... namespace && !this._schema.isNamespaceAgnostic(object.type) && { namespace },
           type: object.type,
           updated_at: time,
           [object.type]: object.attributes,
@@ -186,11 +190,17 @@ export class SavedObjectsRepository {
    *
    * @param {string} type
    * @param {string} id
+   * @param {object} [options={}]
+   * @property {string} [options.namespace]
    * @returns {promise}
    */
-  async delete(type, id) {
+  async delete(type, id, options = {}) {
+    const {
+      namespace
+    } = options;
+
     const response = await this._writeToCluster('delete', {
-      id: this._generateEsId(type, id),
+      id: this._generateEsId(namespace, type, id),
       type: this._type,
       index: this._index,
       refresh: 'wait_for',
@@ -220,12 +230,12 @@ 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]
    * @property {string} [options.sortOrder]
    * @property {Array<string>} [options.fields]
+   * @property {string} [options.namespace]
    * @returns {promise} - { saved_objects: [{ id, type, version, attributes }], total, per_page, page }
    */
   async find(options = {}) {
@@ -238,7 +248,7 @@ export class SavedObjectsRepository {
       sortField,
       sortOrder,
       fields,
-      filters,
+      namespace,
     } = options;
 
     if (searchFields && !Array.isArray(searchFields)) {
@@ -249,10 +259,6 @@ 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,
@@ -261,13 +267,13 @@ export class SavedObjectsRepository {
       ignore: [404],
       body: {
         version: true,
-        ...getSearchDsl(this._mappings, {
+        ...getSearchDsl(this._mappings, this._schema, {
+          namespace,
           search,
           searchFields,
           type,
           sortField,
           sortOrder,
-          filters
         })
       }
     };
@@ -292,7 +298,7 @@ export class SavedObjectsRepository {
       saved_objects: response.hits.hits.map(hit => {
         const { type, updated_at: updatedAt } = hit._source;
         return {
-          id: trimIdPrefix(hit._id, type),
+          id: trimIdPrefix(this._schema, hit._id, namespace, type),
           type,
           ...updatedAt && { updated_at: updatedAt },
           version: hit._version,
@@ -306,8 +312,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
+   * @param {object} [options={}]
+   * @property {string} [options.namespace]
    * @returns {promise} - { saved_objects: [{ id, type, version, attributes }] }
    * @example
    *
@@ -317,6 +323,10 @@ export class SavedObjectsRepository {
    * ])
    */
   async bulkGet(objects = [], options = {}) {
+    const {
+      namespace
+    } = options;
+
     if (objects.length === 0) {
       return { saved_objects: [] };
     }
@@ -325,16 +335,14 @@ export class SavedObjectsRepository {
       index: this._index,
       body: {
         docs: objects.map(object => ({
-          _id: this._generateEsId(object.type, object.id),
+          _id: this._generateEsId(namespace, object.type, object.id),
           _type: this._type,
         }))
       }
     });
 
     const { docs } = response;
 
-    const { extraDocumentProperties = [] } = options;
-
     return {
       saved_objects: docs.map((doc, i) => {
         const { id, type } = objects[i];
@@ -353,9 +361,6 @@ export class SavedObjectsRepository {
           type,
           ...time && { updated_at: time },
           version: doc._version,
-          ...extraDocumentProperties
-            .map(s => ({ [s]: doc._source[s] }))
-            .reduce((acc, prop) => ({ ...acc, ...prop }), {}),
           attributes: {
             ...doc._source[type],
           }
@@ -371,13 +376,17 @@ 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
+   * @param {object} [options={}]
+   * @property {string} [options.namespace]
    * @returns {promise} - { id, type, version, attributes }
    */
   async get(type, id, options = {}) {
+    const {
+      namespace
+    } = options;
+
     const response = await this._callCluster('get', {
-      id: this._generateEsId(type, id),
+      id: this._generateEsId(namespace, type, id),
       type: this._type,
       index: this._index,
       ignore: [404]
@@ -390,18 +399,13 @@ 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,
-      ...extraDocumentProperties
-        .map(s => ({ [s]: response._source[s] }))
-        .reduce((acc, prop) => ({ ...acc, ...prop }), {}),
       attributes: {
         ...response._source[type],
       }
@@ -415,21 +419,26 @@ 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
+   * @property {string} [options.namespace]
    * @returns {promise}
    */
   async update(type, id, attributes, options = {}) {
+    const {
+      version,
+      namespace
+    } = options;
+
     const time = this._getCurrentTime();
     const response = await this._writeToCluster('update', {
-      id: this._generateEsId(type, id),
+      id: this._generateEsId(namespace, type, id),
       type: this._type,
       index: this._index,
-      version: options.version,
+      version,
       refresh: 'wait_for',
       ignore: [404],
       body: {
         doc: {
-          ...options.extraDocumentProperties,
+          ...namespace && !this._schema.isNamespaceAgnostic(type) && { namespace },
           updated_at: time,
           [type]: attributes,
         }
@@ -467,8 +476,9 @@ export class SavedObjectsRepository {
     }
   }
 
-  _generateEsId(type, id) {
-    return `${type}:${id || uuid.v1()}`;
+  _generateEsId(namespace, type, id) {
+    const namespacePrefix = namespace && !this._schema.isNamespaceAgnostic(type) ? `${namespace}:` : '';
+    return `${namespacePrefix}${type}:${id || uuid.v1()}`;
   }
 
   _getCurrentTime() {