[content mgmt / maps] Saved Object wrapper for Content Management API

packages/kbn-content-management-utils/index.ts

@@ -8,3 +8,5 @@
 
 export * from './src/types';
 export * from './src/schema';
+export * from './src/saved_object_content_storage';
+export * from './src/utils';

packages/kbn-content-management-utils/src/saved_object_content_storage.ts

@@ -0,0 +1,391 @@
+/*
+ * 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 Boom from '@hapi/boom';
+import type { SearchQuery, SearchIn } from '@kbn/content-management-plugin/common';
+import type {
+  ContentStorage,
+  StorageContext,
+  MSearchConfig,
+} from '@kbn/content-management-plugin/server';
+import type {
+  SavedObject,
+  SavedObjectReference,
+  SavedObjectsFindOptions,
+  SavedObjectsCreateOptions,
+  SavedObjectsUpdateOptions,
+  SavedObjectsFindResult,
+} from '@kbn/core-saved-objects-api-server';
+import type {
+  CMCrudTypes,
+  ServicesDefinitionSet,
+  SOWithMetadata,
+  SOWithMetadataPartial,
+} from './types';
+
+const savedObjectClientFromRequest = async (ctx: StorageContext) => {
+  if (!ctx.requestHandlerContext) {
+    throw new Error('Storage context.requestHandlerContext missing.');
+  }
+
+  const { savedObjects } = await ctx.requestHandlerContext.core;
+  return savedObjects.client;
+};
+
+type PartialSavedObject<T> = Omit<SavedObject<Partial<T>>, 'references'> & {
+  references: SavedObjectReference[] | undefined;
+};
+
+function savedObjectToItem<Attributes extends object, Item extends SOWithMetadata>(
+  savedObject: SavedObject<Attributes>,
+  partial: false
+): Item;
+
+function savedObjectToItem<Attributes extends object, PartialItem extends SOWithMetadata>(
+  savedObject: PartialSavedObject<Attributes>,
+  partial: true
+): PartialItem;
+
+function savedObjectToItem<Attributes extends object>(
+  savedObject: SavedObject<Attributes> | PartialSavedObject<Attributes>
+): SOWithMetadata | SOWithMetadataPartial {
+  const {
+    id,
+    type,
+    updated_at: updatedAt,
+    created_at: createdAt,
+    attributes,
+    references,
+    error,
+    namespaces,
+  } = savedObject;
+
+  return {
+    id,
+    type,
+    updatedAt,
+    createdAt,
+    attributes,
+    references,
+    error,
+    namespaces,
+  };
+}
+
+export interface SearchArgsToSOFindOptionsOptionsDefault {
+  fields?: string[];
+  searchFields?: string[];
+}
+
+export const searchArgsToSOFindOptionsDefault = <T extends string>(
+  params: SearchIn<T, SearchArgsToSOFindOptionsOptionsDefault>
+): SavedObjectsFindOptions => {
+  const { query, contentTypeId, options } = params;
+  const { included, excluded } = query.tags ?? {};
+
+  const hasReference: SavedObjectsFindOptions['hasReference'] = included
+    ? included.map((id) => ({
+        id,
+        type: 'tag',
+      }))
+    : undefined;
+
+  const hasNoReference: SavedObjectsFindOptions['hasNoReference'] = excluded
+    ? excluded.map((id) => ({
+        id,
+        type: 'tag',
+      }))
+    : undefined;
+
+  return {
+    type: contentTypeId,
+    search: query.text,
+    perPage: query.limit,
+    page: query.cursor ? +query.cursor : undefined,
+    defaultSearchOperator: 'AND',
+    searchFields: options?.searchFields ?? ['description', 'title'],
+    fields: options?.fields ?? ['description', 'title'],
+    hasReference,
+    hasNoReference,
+  };
+};
+
+export const createArgsToSoCreateOptionsDefault = (
+  params: SavedObjectsCreateOptions
+): SavedObjectsCreateOptions => params;
+
+export const updateArgsToSoUpdateOptionsDefault = <Types extends CMCrudTypes>(
+  params: SavedObjectsUpdateOptions<Types['Attributes']>
+): SavedObjectsUpdateOptions<Types['Attributes']> => params;
+
+export type CreateArgsToSoCreateOptions<Types extends CMCrudTypes> = (
+  params: Types['CreateOptions']
+) => SavedObjectsCreateOptions;
+
+export type SearchArgsToSOFindOptions<Types extends CMCrudTypes> = (
+  params: Types['SearchIn']
+) => SavedObjectsFindOptions;
+
+export type UpdateArgsToSoUpdateOptions<Types extends CMCrudTypes> = (
+  params: Types['UpdateOptions']
+) => SavedObjectsUpdateOptions<Types['Attributes']>;
+
+export interface SOContentStorageConstrutorParams<Types extends CMCrudTypes> {
+  savedObjectType: string;
+  cmServicesDefinition: ServicesDefinitionSet;
+  createArgsToSoCreateOptions?: CreateArgsToSoCreateOptions<Types>;
+  updateArgsToSoUpdateOptions?: UpdateArgsToSoUpdateOptions<Types>;
+  searchArgsToSOFindOptions?: SearchArgsToSOFindOptions<Types>;
+  enableMSearch?: boolean;
+}
+
+export abstract class SOContentStorage<Types extends CMCrudTypes>
+  implements
+    ContentStorage<
+      Types['Item'],
+      Types['PartialItem'],
+      MSearchConfig<Types['Item'], Types['Attributes']>
+    >
+{
+  constructor({
+    savedObjectType,
+    cmServicesDefinition,
+    createArgsToSoCreateOptions,
+    updateArgsToSoUpdateOptions,
+    searchArgsToSOFindOptions,
+    enableMSearch,
+  }: SOContentStorageConstrutorParams<Types>) {
+    this.savedObjectType = savedObjectType;
+    this.cmServicesDefinition = cmServicesDefinition;
+    this.createArgsToSoCreateOptions =
+      createArgsToSoCreateOptions || createArgsToSoCreateOptionsDefault;
+    this.updateArgsToSoUpdateOptions =
+      updateArgsToSoUpdateOptions || updateArgsToSoUpdateOptionsDefault;
+    this.searchArgsToSOFindOptions = searchArgsToSOFindOptions || searchArgsToSOFindOptionsDefault;
+
+    if (enableMSearch) {
+      this.mSearch = {
+        savedObjectType: this.savedObjectType,
+        toItemResult: (ctx: StorageContext, savedObject: SavedObjectsFindResult): Types['Item'] => {
+          const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
+
+          // Validate DB response and DOWN transform to the request version
+          const { value, error: resultError } = transforms.mSearch.out.result.down<
+            Types['Item'],
+            Types['Item']
+          >(savedObjectToItem(savedObject as SavedObjectsFindResult<Types['Attributes']>, false));
+
+          if (resultError) {
+            throw Boom.badRequest(`Invalid response. ${resultError.message}`);
+          }
+
+          return value;
+        },
+      };
+    }
+  }
+
+  private savedObjectType: SOContentStorageConstrutorParams<Types>['savedObjectType'];
+  private cmServicesDefinition: SOContentStorageConstrutorParams<Types>['cmServicesDefinition'];
+  private createArgsToSoCreateOptions: CreateArgsToSoCreateOptions<Types>;
+  private updateArgsToSoUpdateOptions: UpdateArgsToSoUpdateOptions<Types>;
+  private searchArgsToSOFindOptions: SearchArgsToSOFindOptions<Types>;
+
+  mSearch?: {
+    savedObjectType: string;
+    toItemResult: (ctx: StorageContext, savedObject: SavedObjectsFindResult) => Types['Item'];
+  };
+
+  async get(ctx: StorageContext, id: string): Promise<Types['GetOut']> {
+    const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
+    const soClient = await savedObjectClientFromRequest(ctx);
+
+    // Save data in DB
+    const {
+      saved_object: savedObject,
+      alias_purpose: aliasPurpose,
+      alias_target_id: aliasTargetId,
+      outcome,
+    } = await soClient.resolve<Types['Attributes']>(this.savedObjectType, id);
+
+    const response: Types['GetOut'] = {
+      item: savedObjectToItem(savedObject, false),
+      meta: {
+        aliasPurpose,
+        aliasTargetId,
+        outcome,
+      },
+    };
+
+    // Validate DB response and DOWN transform to the request version
+    const { value, error: resultError } = transforms.get.out.result.down<
+      Types['GetOut'],
+      Types['GetOut']
+    >(response);
+
+    if (resultError) {
+      throw Boom.badRequest(`Invalid response. ${resultError.message}`);
+    }
+
+    return value;
+  }
+
+  async bulkGet(): Promise<never> {
+    // Not implemented
+    throw new Error(`[bulkGet] has not been implemented. See ${this.constructor.name} class.`);
+  }
+
+  async create(
+    ctx: StorageContext,
+    data: Types['Attributes'],
+    options: Types['CreateOptions']
+  ): Promise<Types['CreateOut']> {
+    const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
+    const soClient = await savedObjectClientFromRequest(ctx);
+
+    // Validate input (data & options) & UP transform them to the latest version
+    const { value: dataToLatest, error: dataError } = transforms.create.in.data.up<
+      Types['Attributes'],
+      Types['Attributes']
+    >(data);
+    if (dataError) {
+      throw Boom.badRequest(`Invalid data. ${dataError.message}`);
+    }
+
+    const { value: optionsToLatest, error: optionsError } = transforms.create.in.options.up<
+      Types['CreateOptions'],
+      Types['CreateOptions']
+    >(options);
+    if (optionsError) {
+      throw Boom.badRequest(`Invalid options. ${optionsError.message}`);
+    }
+
+    const createOptions = this.createArgsToSoCreateOptions(optionsToLatest);
+
+    // Save data in DB
+    const savedObject = await soClient.create<Types['Attributes']>(
+      this.savedObjectType,
+      dataToLatest,
+      createOptions
+    );
+
+    // Validate DB response and DOWN transform to the request version
+    const { value, error: resultError } = transforms.create.out.result.down<
+      Types['CreateOut'],
+      Types['CreateOut']
+    >({
+      item: savedObjectToItem(savedObject, false),
+    });
+
+    if (resultError) {
+      throw Boom.badRequest(`Invalid response. ${resultError.message}`);
+    }
+
+    return value;
+  }
+
+  async update(
+    ctx: StorageContext,
+    id: string,
+    data: Types['Attributes'],
+    options: Types['UpdateOptions']
+  ): Promise<Types['UpdateOut']> {
+    const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
+    const soClient = await savedObjectClientFromRequest(ctx);
+
+    // Validate input (data & options) & UP transform them to the latest version
+    const { value: dataToLatest, error: dataError } = transforms.update.in.data.up<
+      Types['Attributes'],
+      Types['Attributes']
+    >(data);
+    if (dataError) {
+      throw Boom.badRequest(`Invalid data. ${dataError.message}`);
+    }
+
+    const { value: optionsToLatest, error: optionsError } = transforms.update.in.options.up<
+      Types['CreateOptions'],
+      Types['CreateOptions']
+    >(options);
+    if (optionsError) {
+      throw Boom.badRequest(`Invalid options. ${optionsError.message}`);
+    }
+
+    const updateOptions = this.updateArgsToSoUpdateOptions(optionsToLatest);
+
+    // Save data in DB
+    const partialSavedObject = await soClient.update<Types['Attributes']>(
+      this.savedObjectType,
+      id,
+      dataToLatest,
+      updateOptions
+    );
+
+    // Validate DB response and DOWN transform to the request version
+    const { value, error: resultError } = transforms.update.out.result.down<
+      Types['UpdateOut'],
+      Types['UpdateOut']
+    >({
+      item: savedObjectToItem(partialSavedObject, true),
+    });
+
+    if (resultError) {
+      throw Boom.badRequest(`Invalid response. ${resultError.message}`);
+    }
+
+    return value;
+  }
+
+  async delete(ctx: StorageContext, id: string): Promise<Types['DeleteOut']> {
+    const soClient = await savedObjectClientFromRequest(ctx);
+    await soClient.delete(this.savedObjectType, id);
+    return { success: true };
+  }
+
+  async search(
+    ctx: StorageContext,
+    query: SearchQuery,
+    options: Types['SearchOptions'] = {}
+  ): Promise<Types['SearchOut']> {
+    const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
+    const soClient = await savedObjectClientFromRequest(ctx);
+
+    // Validate and UP transform the options
+    const { value: optionsToLatest, error: optionsError } = transforms.search.in.options.up<
+      Types['SearchOptions'],
+      Types['SearchOptions']
+    >(options);
+    if (optionsError) {
+      throw Boom.badRequest(`Invalid payload. ${optionsError.message}`);
+    }
+
+    const soQuery: SavedObjectsFindOptions = this.searchArgsToSOFindOptions({
+      contentTypeId: this.savedObjectType,
+      query,
+      options: optionsToLatest,
+    });
+    // Execute the query in the DB
+    const response = await soClient.find<Types['Attributes']>(soQuery);
+
+    // Validate the response and DOWN transform to the request version
+    const { value, error: resultError } = transforms.search.out.result.down<
+      Types['SearchOut'],
+      Types['SearchOut']
+    >({
+      hits: response.saved_objects.map((so) => savedObjectToItem(so, false)),
+      pagination: {
+        total: response.total,
+      },
+    });
+
+    if (resultError) {
+      throw Boom.badRequest(`Invalid response. ${resultError.message}`);
+    }
+
+    return value;
+  }
+}