[Lens] Update Lens CM and APIs

packages/kbn-check-saved-objects-cli/current_mappings.json

@@ -2584,6 +2584,7 @@
     }
   },
   "lens": {
+    "dynamic": false,
     "properties": {
       "description": {
         "type": "text"

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

@@ -136,7 +136,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "inventory-view": "e125c6e6e49729055421e7b3a0544f24330d8dc6",
         "kql-telemetry": "92d6357aa3ce28727492f86a54783f802dc38893",
         "legacy-url-alias": "9b8cca3fbb2da46fd12823d3cd38fdf1c9f24bc8",
-        "lens": "6fa6bdc5de12859815de6e50488fa2a7b038278a",
+        "lens": "1914604f1afd63e23cbd0628757c809e641400a0",
         "lens-ui-telemetry": "d6c4e330d170eefc6214dbf77a53de913fa3eebc",
         "links": "53ae5a770d69eee34d842617be761cd059ab4b51",
         "maintenance-window": "f3f19d1828e91418d13703ce6009e9c76a1686f9",
@@ -833,8 +833,9 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "legacy-url-alias|8.2.0: 4c58be29493363cb48eb37fa5612fb3fb0eed77e",
         "================================================================",
         "lens|global: 0267d37678684c5f234bd74f0f6ae2a5f6180eb4",
-        "lens|mappings: ccf7f3aea93efcf8d26faffa63e4bf6f0748ea80",
+        "lens|mappings: 5edb12dfc3770ed521bc96b28103e325f04cf9f6",
         "lens|schemas: da39a3ee5e6b4b0d3255bfef95601890afd80709",
+        "lens|10.1.0: e053504b39aceec3b665388bb586e89e162e5a60",
         "lens|8.9.0: f6592efb2500e39d1d31b1effdfad7d7ad1eca32",
         "lens|8.6.0: 54c152a2584673672445346cf69d72bda587cc52",
         "lens|8.5.0: 54c152a2584673672445346cf69d72bda587cc52",
@@ -1293,7 +1294,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "inventory-view": "10.2.0",
         "kql-telemetry": "10.0.0",
         "legacy-url-alias": "10.0.0",
-        "lens": "10.0.0",
+        "lens": "10.1.0",
         "lens-ui-telemetry": "10.0.0",
         "links": "10.0.0",
         "maintenance-window": "10.2.0",
@@ -1438,7 +1439,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "inventory-view": "10.2.0",
         "kql-telemetry": "0.0.0",
         "legacy-url-alias": "8.2.0",
-        "lens": "8.9.0",
+        "lens": "10.1.0",
         "lens-ui-telemetry": "0.0.0",
         "links": "0.0.0",
         "maintenance-window": "10.2.0",

src/platform/packages/shared/kbn-content-management-utils/src/saved_object_content_storage.test.ts

@@ -7,10 +7,11 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import { SOContentStorage } from './saved_object_content_storage';
-import type { CMCrudTypes } from './types';
-import type { MockedLogger } from '@kbn/logging-mocks';
 import { loggerMock } from '@kbn/logging-mocks';
+import type { MockedLogger } from '@kbn/logging-mocks';
+
+import { SOContentStorage } from './saved_object_content_storage';
+import type { ContentManagementCrudTypes } from './types';
 
 import { schema } from '@kbn/config-schema';
 import type {
@@ -21,9 +22,15 @@ import { getContentManagementServicesTransforms } from '@kbn/object-versioning';
 import { savedObjectSchema, objectTypeToGetResultSchema, createResultSchema } from './schema';
 
 import { coreMock } from '@kbn/core/server/mocks';
-import type { SavedObject } from '@kbn/core/server';
+import type { RequestHandlerContext, SavedObject } from '@kbn/core/server';
 import { mockRouter } from '@kbn/core-http-router-server-mocks';
 
+interface MockAttributes {
+  title: string;
+  description: string | null;
+}
+type MockCrudTypes = ContentManagementCrudTypes<'content-id', MockAttributes, {}, {}, {}>;
+
 const testAttributesSchema = schema.object(
   {
     title: schema.string(),
@@ -78,7 +85,7 @@ export const cmServicesDefinition: { [version: Version]: ServicesDefinition } =
 
 const transforms = getContentManagementServicesTransforms(cmServicesDefinition, 1);
 
-class TestSOContentStorage extends SOContentStorage<CMCrudTypes> {
+class TestSOContentStorage extends SOContentStorage<MockCrudTypes> {
   constructor({
     throwOnResultValidationError,
     logger,
@@ -97,11 +104,10 @@ class TestSOContentStorage extends SOContentStorage<CMCrudTypes> {
 const setup = ({ storage }: { storage?: TestSOContentStorage } = {}) => {
   storage = storage ?? new TestSOContentStorage();
   const requestHandlerCoreContext = coreMock.createRequestHandlerContext();
-
-  const requestHandlerContext = {
+  const requestHandlerContext = jest.mocked<RequestHandlerContext>({
     core: Promise.resolve(requestHandlerCoreContext),
     resolve: jest.fn(),
-  };
+  });
 
   return {
     get: (mockSavedObject: SavedObject) => {
@@ -125,7 +131,7 @@ const setup = ({ storage }: { storage?: TestSOContentStorage } = {}) => {
         mockSavedObject.id
       );
     },
-    create: (mockSavedObject: SavedObject<{}>) => {
+    create: (mockSavedObject: SavedObject<MockAttributes>) => {
       requestHandlerCoreContext.savedObjects.client.create.mockResolvedValue(mockSavedObject);
 
       return storage!.create(
@@ -144,7 +150,7 @@ const setup = ({ storage }: { storage?: TestSOContentStorage } = {}) => {
         {}
       );
     },
-    update: (mockSavedObject: SavedObject<{}>) => {
+    update: (mockSavedObject: SavedObject<MockAttributes>) => {
       requestHandlerCoreContext.savedObjects.client.update.mockResolvedValue(mockSavedObject);
 
       return storage!.update(
@@ -164,7 +170,7 @@ const setup = ({ storage }: { storage?: TestSOContentStorage } = {}) => {
         {}
       );
     },
-    search: (mockSavedObject: SavedObject<{}>) => {
+    search: (mockSavedObject: SavedObject<MockAttributes>) => {
       requestHandlerCoreContext.savedObjects.client.find.mockResolvedValue({
         saved_objects: [{ ...mockSavedObject, score: 100 }],
         total: 1,
@@ -188,7 +194,7 @@ const setup = ({ storage }: { storage?: TestSOContentStorage } = {}) => {
         {}
       );
     },
-    mSearch: async (mockSavedObject: SavedObject<{}>) => {
+    mSearch: async (mockSavedObject: SavedObject<MockAttributes>) => {
       return storage!.mSearch!.toItemResult(
         {
           request: mockRouter.createFakeKibanaRequest({}),

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

@@ -32,66 +32,10 @@ import type {
 } from './types';
 import { tagsToFindOptions } from './utils';
 
-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>,
-  allowedSavedObjectAttributes: string[],
-  partial: false
-): Item;
-
-function savedObjectToItem<Attributes extends object, PartialItem extends SOWithMetadata>(
-  savedObject: PartialSavedObject<Attributes>,
-  allowedSavedObjectAttributes: string[],
-  partial: true
-): PartialItem;
-
-function savedObjectToItem<Attributes extends object>(
-  savedObject: SavedObject<Attributes> | PartialSavedObject<Attributes>,
-  allowedSavedObjectAttributes: string[]
-): SOWithMetadata | SOWithMetadataPartial {
-  const {
-    id,
-    type,
-    updated_at: updatedAt,
-    updated_by: updatedBy,
-    created_at: createdAt,
-    created_by: createdBy,
-    attributes,
-    references,
-    error,
-    namespaces,
-    version,
-    managed,
-  } = savedObject;
-
-  return {
-    id,
-    type,
-    managed,
-    updatedBy,
-    updatedAt,
-    createdAt,
-    createdBy,
-    attributes: pick(attributes, allowedSavedObjectAttributes),
-    references,
-    error,
-    namespaces,
-    version,
-  };
-}
-
 export interface SearchArgsToSOFindOptionsOptionsDefault {
   fields?: string[];
   searchFields?: string[];
@@ -138,7 +82,7 @@ export interface SOContentStorageConstructorParams<Types extends CMCrudTypes> {
   savedObjectType: string;
   cmServicesDefinition: ServicesDefinitionSet;
   // this is necessary since unexpected saved object attributes could cause schema validation to fail
-  allowedSavedObjectAttributes: string[];
+  allowedSavedObjectAttributes: Array<keyof Types['Attributes']>;
   createArgsToSoCreateOptions?: CreateArgsToSoCreateOptions<Types>;
   updateArgsToSoUpdateOptions?: UpdateArgsToSoUpdateOptions<Types>;
   searchArgsToSOFindOptions?: SearchArgsToSOFindOptions<Types>;
@@ -193,10 +137,8 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
         toItemResult: (ctx: StorageContext, savedObject: SavedObjectsFindResult): Types['Item'] => {
           const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
 
-          const contentItem = savedObjectToItem(
-            savedObject as SavedObjectsFindResult<Types['Attributes']>,
-            this.allowedSavedObjectAttributes,
-            false
+          const contentItem = this.savedObjectToItem(
+            savedObject as SavedObjectsFindResult<Types['Attributes']>
           );
 
           const validationError = transforms.mSearch.out.result.validate(contentItem);
@@ -228,14 +170,62 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
     }
   }
 
-  private throwOnResultValidationError: boolean;
-  private logger: Logger;
-  private savedObjectType: SOContentStorageConstructorParams<Types>['savedObjectType'];
-  private cmServicesDefinition: SOContentStorageConstructorParams<Types>['cmServicesDefinition'];
-  private createArgsToSoCreateOptions: CreateArgsToSoCreateOptions<Types>;
-  private updateArgsToSoUpdateOptions: UpdateArgsToSoUpdateOptions<Types>;
-  private searchArgsToSOFindOptions: SearchArgsToSOFindOptions<Types>;
-  private allowedSavedObjectAttributes: string[];
+  protected static getSOClientFromRequest = async (ctx: StorageContext) => {
+    if (!ctx.requestHandlerContext) {
+      throw new Error('Storage context.requestHandlerContext missing.');
+    }
+
+    const { savedObjects } = await ctx.requestHandlerContext.core;
+    return savedObjects.client;
+  };
+
+  protected readonly throwOnResultValidationError: boolean;
+  protected readonly logger: Logger;
+  protected readonly savedObjectType: SOContentStorageConstructorParams<Types>['savedObjectType'];
+  protected readonly cmServicesDefinition: SOContentStorageConstructorParams<Types>['cmServicesDefinition'];
+  protected readonly createArgsToSoCreateOptions: CreateArgsToSoCreateOptions<Types>;
+  protected readonly updateArgsToSoUpdateOptions: UpdateArgsToSoUpdateOptions<Types>;
+  protected readonly searchArgsToSOFindOptions: SearchArgsToSOFindOptions<Types>;
+  protected readonly allowedSavedObjectAttributes: Array<keyof Types['Attributes']>;
+
+  protected savedObjectToItem(savedObject: SavedObject<Types['Attributes']>): Types['Item'];
+  protected savedObjectToItem(
+    savedObject: PartialSavedObject<Types['Attributes']>,
+    partial: true
+  ): Types['PartialItem'];
+  protected savedObjectToItem(
+    savedObject: SavedObject<Types['Attributes']> | PartialSavedObject<Types['Attributes']>
+  ): SOWithMetadata | SOWithMetadataPartial {
+    const {
+      id,
+      type,
+      updated_at: updatedAt,
+      updated_by: updatedBy,
+      created_at: createdAt,
+      created_by: createdBy,
+      attributes,
+      references,
+      error,
+      namespaces,
+      version,
+      managed,
+    } = savedObject;
+
+    return {
+      id,
+      type,
+      managed,
+      updatedBy,
+      updatedAt,
+      createdAt,
+      createdBy,
+      attributes: pick(attributes, this.allowedSavedObjectAttributes),
+      references,
+      error,
+      namespaces,
+      version,
+    };
+  }
 
   mSearch?: {
     savedObjectType: string;
@@ -245,7 +235,7 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
 
   async get(ctx: StorageContext, id: string): Promise<Types['GetOut']> {
     const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
-    const soClient = await savedObjectClientFromRequest(ctx);
+    const soClient = await SOContentStorage.getSOClientFromRequest(ctx);
 
     // Save data in DB
     const {
@@ -256,7 +246,7 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
     } = await soClient.resolve<Types['Attributes']>(this.savedObjectType, id);
 
     const response: Types['GetOut'] = {
-      item: savedObjectToItem(savedObject, this.allowedSavedObjectAttributes, false),
+      item: this.savedObjectToItem(savedObject),
       meta: {
         aliasPurpose,
         aliasTargetId,
@@ -301,7 +291,7 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
     options: Types['CreateOptions']
   ): Promise<Types['CreateOut']> {
     const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
-    const soClient = await savedObjectClientFromRequest(ctx);
+    const soClient = await SOContentStorage.getSOClientFromRequest(ctx);
 
     // Validate input (data & options) & UP transform them to the latest version
     const { value: dataToLatest, error: dataError } = transforms.create.in.data.up<
@@ -330,7 +320,7 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
     );
 
     const result = {
-      item: savedObjectToItem(savedObject, this.allowedSavedObjectAttributes, false),
+      item: this.savedObjectToItem(savedObject),
     };
 
     const validationError = transforms.create.out.result.validate(result);
@@ -366,7 +356,7 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
     options: Types['UpdateOptions']
   ): Promise<Types['UpdateOut']> {
     const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
-    const soClient = await savedObjectClientFromRequest(ctx);
+    const soClient = await SOContentStorage.getSOClientFromRequest(ctx);
 
     // Validate input (data & options) & UP transform them to the latest version
     const { value: dataToLatest, error: dataError } = transforms.update.in.data.up<
@@ -396,7 +386,7 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
     );
 
     const result = {
-      item: savedObjectToItem(partialSavedObject, this.allowedSavedObjectAttributes, true),
+      item: this.savedObjectToItem(partialSavedObject, true),
     };
 
     const validationError = transforms.update.out.result.validate(result);
@@ -431,7 +421,7 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
     // force is necessary to delete saved objects that exist in multiple namespaces
     options?: { force: boolean }
   ): Promise<Types['DeleteOut']> {
-    const soClient = await savedObjectClientFromRequest(ctx);
+    const soClient = await SOContentStorage.getSOClientFromRequest(ctx);
     await soClient.delete(this.savedObjectType, id, { force: options?.force ?? false });
     return { success: true };
   }
@@ -442,7 +432,7 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
     options: Types['SearchOptions'] = {}
   ): Promise<Types['SearchOut']> {
     const transforms = ctx.utils.getTransforms(this.cmServicesDefinition);
-    const soClient = await savedObjectClientFromRequest(ctx);
+    const soClient = await SOContentStorage.getSOClientFromRequest(ctx);
 
     // Validate and UP transform the options
     const { value: optionsToLatest, error: optionsError } = transforms.search.in.options.up<
@@ -461,9 +451,7 @@ export abstract class SOContentStorage<Types extends CMCrudTypes>
     // Execute the query in the DB
     const soResponse = await soClient.find<Types['Attributes']>(soQuery);
     const response = {
-      hits: soResponse.saved_objects.map((so) =>
-        savedObjectToItem(so, this.allowedSavedObjectAttributes, false)
-      ),
+      hits: soResponse.saved_objects.map((so) => this.savedObjectToItem(so)),
       pagination: {
         total: soResponse.total,
       },