Clean up stale augment-vis saved objs (#4059)

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>

src/plugins/saved_objects_management/opensearch_dashboards.json

@@ -3,7 +3,7 @@
   "version": "opensearchDashboards",
   "server": true,
   "ui": true,
-  "requiredPlugins": ["management", "data"],
+  "requiredPlugins": ["management", "data", "uiActions"],
   "optionalPlugins": [
     "dashboard",
     "visualizations",

src/plugins/saved_objects_management/public/index.ts

@@ -48,6 +48,8 @@ export {
 } from './services';
 export { ProcessedImportResponse, processImportResponse, FailedImport } from './lib';
 export { SavedObjectRelation, SavedObjectWithMetadata, SavedObjectMetadata } from './types';
+export { SAVED_OBJECT_DELETE_TRIGGER, savedObjectDeleteTrigger } from './triggers';
+export { SavedObjectDeleteContext } from './ui_actions_bootstrap';
 
 export function plugin(initializerContext: PluginInitializerContext) {
   return new SavedObjectsManagementPlugin();

src/plugins/saved_objects_management/public/management_section/mount_section.tsx

@@ -59,7 +59,7 @@ export const mountManagementSection = async ({
   mountParams,
   serviceRegistry,
 }: MountParams) => {
-  const [coreStart, { data }, pluginStart] = await core.getStartServices();
+  const [coreStart, { data, uiActions }, pluginStart] = await core.getStartServices();
   const { element, history, setBreadcrumbs } = mountParams;
   if (allowedObjectTypes === undefined) {
     allowedObjectTypes = await getAllowedTypes(coreStart.http);
@@ -88,6 +88,7 @@ export const mountManagementSection = async ({
               <Suspense fallback={<EuiLoadingSpinner />}>
                 <SavedObjectsEditionPage
                   coreStart={coreStart}
+                  uiActionsStart={uiActions}
                   serviceRegistry={serviceRegistry}
                   setBreadcrumbs={setBreadcrumbs}
                   history={history}

src/plugins/saved_objects_management/public/management_section/object_view/saved_object_view.tsx

@@ -43,6 +43,8 @@ import { ISavedObjectsManagementServiceRegistry } from '../../services';
 import { Header, NotFoundErrors, Intro, Form } from './components';
 import { canViewInApp } from '../../lib';
 import { SubmittedFormData } from '../types';
+import { UiActionsStart } from '../../../../ui_actions/public';
+import { SAVED_OBJECT_DELETE_TRIGGER } from '../../triggers';
 
 interface SavedObjectEditionProps {
   id: string;
@@ -51,6 +53,7 @@ interface SavedObjectEditionProps {
   capabilities: Capabilities;
   overlays: OverlayStart;
   notifications: NotificationsStart;
+  uiActions: UiActionsStart;
   notFoundType?: string;
   savedObjectsClient: SavedObjectsClientContract;
   history: ScopedHistory;
@@ -168,7 +171,11 @@ export class SavedObjectEdition extends Component<
       }
     );
     if (confirmed) {
+      this.props.uiActions
+        .getTrigger(SAVED_OBJECT_DELETE_TRIGGER)
+        .exec({ type, savedObjectId: id });
       await savedObjectsClient.delete(type, id);
+
       notifications.toasts.addSuccess(`Deleted ${this.formatTitle(object)} ${type} object`);
       this.redirectToListing();
     }

src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx

@@ -33,16 +33,19 @@ import { useParams, useLocation } from 'react-router-dom';
 import { parse } from 'query-string';
 import { i18n } from '@osd/i18n';
 import { CoreStart, ChromeBreadcrumb, ScopedHistory } from 'src/core/public';
+import { UiActionsStart } from 'src/plugins/ui_actions/public';
 import { ISavedObjectsManagementServiceRegistry } from '../services';
 import { SavedObjectEdition } from './object_view';
 
 const SavedObjectsEditionPage = ({
   coreStart,
+  uiActionsStart,
   serviceRegistry,
   setBreadcrumbs,
   history,
 }: {
   coreStart: CoreStart;
+  uiActionsStart: UiActionsStart;
   serviceRegistry: ISavedObjectsManagementServiceRegistry;
   setBreadcrumbs: (crumbs: ChromeBreadcrumb[]) => void;
   history: ScopedHistory;
@@ -79,6 +82,7 @@ const SavedObjectsEditionPage = ({
       savedObjectsClient={coreStart.savedObjects.client}
       overlays={coreStart.overlays}
       notifications={coreStart.notifications}
+      uiActions={uiActionsStart}
       capabilities={capabilities}
       notFoundType={query.notFound as string}
       history={history}

src/plugins/saved_objects_management/public/plugin.test.ts

@@ -32,6 +32,7 @@ import { coreMock } from '../../../core/public/mocks';
 import { homePluginMock } from '../../home/public/mocks';
 import { managementPluginMock } from '../../management/public/mocks';
 import { dataPluginMock } from '../../data/public/mocks';
+import { uiActionsPluginMock } from '../../ui_actions/public/mocks';
 import { SavedObjectsManagementPlugin } from './plugin';
 
 describe('SavedObjectsManagementPlugin', () => {
@@ -48,8 +49,13 @@ describe('SavedObjectsManagementPlugin', () => {
       });
       const homeSetup = homePluginMock.createSetupContract();
       const managementSetup = managementPluginMock.createSetupContract();
+      const uiActionsSetup = uiActionsPluginMock.createSetupContract();
 
-      await plugin.setup(coreSetup, { home: homeSetup, management: managementSetup });
+      await plugin.setup(coreSetup, {
+        home: homeSetup,
+        management: managementSetup,
+        uiActions: uiActionsSetup,
+      });
 
       expect(homeSetup.featureCatalogue.register).toHaveBeenCalledTimes(1);
       expect(homeSetup.featureCatalogue.register).toHaveBeenCalledWith(

src/plugins/saved_objects_management/public/plugin.ts

@@ -33,6 +33,7 @@ import { CoreSetup, CoreStart, Plugin } from 'src/core/public';
 
 import { VisBuilderStart } from '../../vis_builder/public';
 import { ManagementSetup } from '../../management/public';
+import { UiActionsSetup, UiActionsStart } from '../../ui_actions/public';
 import { DataPublicPluginStart } from '../../data/public';
 import { DashboardStart } from '../../dashboard/public';
 import { DiscoverStart } from '../../discover/public';
@@ -53,6 +54,7 @@ import {
   ISavedObjectsManagementServiceRegistry,
 } from './services';
 import { registerServices } from './register_services';
+import { bootstrap } from './ui_actions_bootstrap';
 
 export interface SavedObjectsManagementPluginSetup {
   actions: SavedObjectsManagementActionServiceSetup;
@@ -70,6 +72,7 @@ export interface SavedObjectsManagementPluginStart {
 export interface SetupDependencies {
   management: ManagementSetup;
   home?: HomePublicPluginSetup;
+  uiActions: UiActionsSetup;
 }
 
 export interface StartDependencies {
@@ -79,6 +82,7 @@ export interface StartDependencies {
   visAugmenter?: VisAugmenterStart;
   discover?: DiscoverStart;
   visBuilder?: VisBuilderStart;
+  uiActions: UiActionsStart;
 }
 
 export class SavedObjectsManagementPlugin
@@ -96,7 +100,7 @@ export class SavedObjectsManagementPlugin
 
   public setup(
     core: CoreSetup<StartDependencies, SavedObjectsManagementPluginStart>,
-    { home, management }: SetupDependencies
+    { home, management, uiActions }: SetupDependencies
   ): SavedObjectsManagementPluginSetup {
     const actionSetup = this.actionService.setup();
     const columnSetup = this.columnService.setup();
@@ -136,6 +140,9 @@ export class SavedObjectsManagementPlugin
       },
     });
 
+    // sets up the context mappings and registers any triggers/actions for the plugin
+    bootstrap(uiActions);
+
     // depends on `getStartServices`, should not be awaited
     registerServices(this.serviceRegistry, core.getStartServices);
 
@@ -147,7 +154,7 @@ export class SavedObjectsManagementPlugin
     };
   }
 
-  public start(core: CoreStart, { data }: StartDependencies) {
+  public start(core: CoreStart, { data, uiActions }: StartDependencies) {
     const actionStart = this.actionService.start();
     const columnStart = this.columnService.start();
     const namespaceStart = this.namespaceService.start();

src/plugins/saved_objects_management/public/triggers/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export {
+  SAVED_OBJECT_DELETE_TRIGGER,
+  savedObjectDeleteTrigger,
+} from './saved_object_delete_trigger';

src/plugins/saved_objects_management/public/triggers/saved_object_delete_trigger.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { i18n } from '@osd/i18n';
+import { Trigger } from '../../../ui_actions/public';
+
+export const SAVED_OBJECT_DELETE_TRIGGER = 'SAVED_OBJECT_DELETE_TRIGGER';
+export const savedObjectDeleteTrigger: Trigger<'SAVED_OBJECT_DELETE_TRIGGER'> = {
+  id: SAVED_OBJECT_DELETE_TRIGGER,
+  title: i18n.translate('savedObjectsManagement.triggers.savedObjectDeleteTitle', {
+    defaultMessage: 'Saved object delete',
+  }),
+  description: i18n.translate('savedObjectsManagement.triggers.savedObjectDeleteDescription', {
+    defaultMessage: 'Perform additional actions after deleting a saved object',
+  }),
+};

src/plugins/saved_objects_management/public/ui_actions_bootstrap.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { UiActionsSetup } from '../../ui_actions/public';
+import { SAVED_OBJECT_DELETE_TRIGGER, savedObjectDeleteTrigger } from './triggers';
+
+export interface SavedObjectDeleteContext {
+  type: string;
+  savedObjectId: string;
+}
+
+declare module '../../ui_actions/public' {
+  export interface TriggerContextMapping {
+    [SAVED_OBJECT_DELETE_TRIGGER]: SavedObjectDeleteContext;
+  }
+}
+
+export const bootstrap = (uiActions: UiActionsSetup) => {
+  uiActions.registerTrigger(savedObjectDeleteTrigger);
+};

src/plugins/vis_augmenter/opensearch_dashboards.json

@@ -12,5 +12,5 @@
     "uiActions",
     "embeddable"
   ],
-  "requiredBundles": ["opensearchDashboardsReact"]
+  "requiredBundles": ["opensearchDashboardsReact", "savedObjectsManagement"]
 }

src/plugins/vis_augmenter/public/actions/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export {
+  PLUGIN_RESOURCE_DELETE_ACTION,
+  PluginResourceDeleteAction,
+} from './plugin_resource_delete_action';
+export { SAVED_OBJECT_DELETE_ACTION, SavedObjectDeleteAction } from './saved_object_delete_action';

src/plugins/vis_augmenter/public/actions/plugin_resource_delete_action.test.ts

@@ -0,0 +1,81 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { createPointInTimeEventsVisLayer } from '../mocks';
+import { generateAugmentVisSavedObject } from '../saved_augment_vis';
+import { PluginResourceDeleteAction } from './plugin_resource_delete_action';
+
+const sampleSavedObj = generateAugmentVisSavedObject(
+  'test-id',
+  {
+    type: 'PointInTimeEvents',
+    name: 'test-fn-name',
+    args: {},
+  },
+  'test-vis-id',
+  'test-origin-plugin',
+  {
+    type: 'test-resource-type',
+    id: 'test-resource-id',
+  }
+);
+
+const sampleVisLayer = createPointInTimeEventsVisLayer();
+
+describe('SavedObjectDeleteAction', () => {
+  it('is incompatible with invalid saved obj list', async () => {
+    const action = new PluginResourceDeleteAction();
+    const visLayers = [sampleVisLayer];
+    // @ts-ignore
+    expect(await action.isCompatible({ savedObjs: null, visLayers })).toBe(false);
+    // @ts-ignore
+    expect(await action.isCompatible({ savedObjs: undefined, visLayers })).toBe(false);
+    expect(await action.isCompatible({ savedObjs: [], visLayers })).toBe(false);
+  });
+
+  it('is incompatible with invalid vislayer list', async () => {
+    const action = new PluginResourceDeleteAction();
+    const savedObjs = [sampleSavedObj];
+    // @ts-ignore
+    expect(await action.isCompatible({ savedObjs, visLayers: null })).toBe(false);
+    // @ts-ignore
+    expect(await action.isCompatible({ savedObjs, visLayers: undefined })).toBe(false);
+    expect(await action.isCompatible({ savedObjs, visLayers: [] })).toBe(false);
+  });
+
+  it('execute throws error if incompatible saved objs list', async () => {
+    const action = new PluginResourceDeleteAction();
+    async function check(savedObjs: any, visLayers: any) {
+      await action.execute({ savedObjs, visLayers });
+    }
+    await expect(check(null, [sampleVisLayer])).rejects.toThrow(Error);
+  });
+
+  it('execute throws error if incompatible vis layer list', async () => {
+    const action = new PluginResourceDeleteAction();
+    async function check(savedObjs: any, visLayers: any) {
+      await action.execute({ savedObjs, visLayers });
+    }
+    await expect(check([sampleSavedObj], null)).rejects.toThrow(Error);
+  });
+
+  it('execute is successful if valid saved obj and vis layer lists', async () => {
+    const action = new PluginResourceDeleteAction();
+    async function check(savedObjs: any, visLayers: any) {
+      await action.execute({ savedObjs, visLayers });
+    }
+    await expect(check([sampleSavedObj], [sampleVisLayer])).resolves;
+  });
+
+  it('Returns display name', async () => {
+    const action = new PluginResourceDeleteAction();
+    expect(action.getDisplayName()).toBeDefined();
+  });
+
+  it('Returns icon type', async () => {
+    const action = new PluginResourceDeleteAction();
+    expect(action.getIconType()).toBeDefined();
+  });
+});

src/plugins/vis_augmenter/public/actions/plugin_resource_delete_action.ts

@@ -0,0 +1,47 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { isEmpty } from 'lodash';
+import { i18n } from '@osd/i18n';
+import { EuiIconType } from '@elastic/eui/src/components/icon/icon';
+import { Action, IncompatibleActionError } from '../../../ui_actions/public';
+import { getSavedAugmentVisLoader } from '../services';
+import { PluginResourceDeleteContext } from '../ui_actions_bootstrap';
+import { cleanupStaleObjects } from '../utils';
+
+export const PLUGIN_RESOURCE_DELETE_ACTION = 'PLUGIN_RESOURCE_DELETE_ACTION';
+
+export class PluginResourceDeleteAction implements Action<PluginResourceDeleteContext> {
+  public readonly type = PLUGIN_RESOURCE_DELETE_ACTION;
+  public readonly id = PLUGIN_RESOURCE_DELETE_ACTION;
+  public order = 1;
+
+  public getIconType(): EuiIconType {
+    return `trash`;
+  }
+
+  public getDisplayName() {
+    return i18n.translate('dashboard.actions.deleteSavedObject.name', {
+      defaultMessage:
+        'Clean up all augment-vis saved objects associated to the deleted visualization',
+    });
+  }
+
+  public async isCompatible({ savedObjs, visLayers }: PluginResourceDeleteContext) {
+    return !isEmpty(savedObjs) && !isEmpty(visLayers);
+  }
+
+  /**
+   * If we have just collected all of the saved objects and generated vis layers,
+   * sweep through them all and if any of the resources are deleted, delete those
+   * corresponding saved objects
+   */
+  public async execute({ savedObjs, visLayers }: PluginResourceDeleteContext) {
+    if (!(await this.isCompatible({ savedObjs, visLayers }))) {
+      throw new IncompatibleActionError();
+    }
+    cleanupStaleObjects(savedObjs, visLayers, getSavedAugmentVisLoader());
+  }
+}