Add new advanced settings for vis augmenter

config/opensearch_dashboards.yml

@@ -239,4 +239,7 @@
 #data_source.encryption.wrappingKey: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
 
 # Set the value of this setting to false to hide the help menu link to the OpenSearch Dashboards user survey
-# opensearchDashboards.survey.url: "https://survey.opensearch.org"
+# opensearchDashboards.survey.url: "https://survey.opensearch.org"
+
+# Set the value of this setting to false to disable plugin augmentation on Dashboard
+# vis_augmenter.pluginAugmentationEnabled: false

src/plugins/opensearch_dashboards_usage_collection/server/collectors/management/schema.ts

@@ -40,6 +40,8 @@ export const stackManagementSchema: MakeSchemaFrom<UsageStats> = {
   'visualization:regionmap:showWarnings': { type: 'boolean' },
   'visualization:dimmingOpacity': { type: 'float' },
   'visualization:tileMap:maxPrecision': { type: 'long' },
+  'visualization:enablePluginAugmentation': { type: 'boolean' },
+  'visualization:enablePluginAugmentation.maxPluginObjects': { type: 'number' },
   'securitySolution:ipReputationLinks': { type: 'text' },
   'csv:separator': { type: 'keyword' },
   'visualization:tileMap:WMSdefaults': { type: 'text' },

src/plugins/telemetry/schema/oss_plugins.json

@@ -1372,6 +1372,12 @@
         "visualization:tileMap:maxPrecision": {
           "type": "long"
         },
+        "visualization:enablePluginAugmentation": {
+          "type": "boolean"
+        },
+        "visualization:enablePluginAugmentation.maxPluginObjects": {
+          "type": "number"
+        },
         "securitySolution:ipReputationLinks": {
           "type": "text"
         },

src/plugins/vis_augmenter/config.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { schema, TypeOf } from '@osd/config-schema';
+
+export const configSchema = schema.object({
+  pluginAugmentationEnabled: schema.boolean({ defaultValue: true }),
+});
+
+export type VisAugmenterPluginConfigType = TypeOf<typeof configSchema>;

src/plugins/vis_augmenter/public/plugin.ts

@@ -7,7 +7,7 @@ import { ExpressionsSetup } from '../../expressions/public';
 import { PluginInitializerContext, CoreSetup, CoreStart, Plugin } from '../../../core/public';
 import { DataPublicPluginSetup, DataPublicPluginStart } from '../../data/public';
 import { visLayers } from './expressions';
-import { setSavedAugmentVisLoader } from './services';
+import { setSavedAugmentVisLoader, setUISettings } from './services';
 import { createSavedAugmentVisLoader, SavedAugmentVisLoader } from './saved_augment_vis';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -40,6 +40,7 @@ export class VisAugmenterPlugin
   }
 
   public start(core: CoreStart, { data }: VisAugmenterStartDeps): VisAugmenterStart {
+    setUISettings(core.uiSettings);
     const savedAugmentVisLoader = createSavedAugmentVisLoader({
       savedObjectsClient: core.savedObjects.client,
       indexPatterns: data.indexPatterns,

src/plugins/vis_augmenter/public/saved_augment_vis/saved_augment_vis.ts

@@ -4,59 +4,87 @@
  */
 
 import { get, isEmpty } from 'lodash';
+import { IUiSettingsClient } from 'opensearch-dashboards/public';
 import {
   SavedObjectLoader,
   SavedObjectOpenSearchDashboardsServices,
 } from '../../../saved_objects/public';
 import { createSavedAugmentVisClass } from './_saved_augment_vis';
 import { VisLayerTypes } from '../types';
+import { getUISettings } from '../services';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface SavedObjectOpenSearchDashboardsServicesWithAugmentVis
   extends SavedObjectOpenSearchDashboardsServices {}
 export type SavedAugmentVisLoader = ReturnType<typeof createSavedAugmentVisLoader>;
+
+export class SavedObjectLoaderAugmentVis extends SavedObjectLoader {
+  private readonly config: IUiSettingsClient = getUISettings();
+
+  mapHitSource = (source: Record<string, any>, id: string) => {
+    source.id = id;
+    source.visId = get(source, 'visReference.id', '');
+
+    if (isEmpty(source.visReference)) {
+      source.error = 'visReference is missing in augment-vis saved object';
+      return source;
+    }
+    if (isEmpty(source.visLayerExpressionFn)) {
+      source.error = 'visLayerExpressionFn is missing in augment-vis saved object';
+      return source;
+    }
+    if (!(get(source, 'visLayerExpressionFn.type', '') in VisLayerTypes)) {
+      source.error = 'Unknown VisLayer expression function type';
+      return source;
+    }
+    return source;
+  };
+
+  /**
+   * Updates hit.attributes to contain an id related to the referenced visualization
+   * (visId) and returns the updated attributes object.
+   * @param hit
+   * @returns {hit.attributes} The modified hit.attributes object, with an id and url field.
+   */
+  mapSavedObjectApiHits(hit: {
+    references: any[];
+    attributes: Record<string, unknown>;
+    id: string;
+  }) {
+    // For now we are assuming only one vis reference per saved object.
+    // If we change to multiple, we will need to dynamically handle that
+    const visReference = hit.references[0];
+    return this.mapHitSource({ ...hit.attributes, visReference }, hit.id);
+  }
+
+  /**
+   * Retrieve a saved object by id or create new one.
+   * Returns a promise that completes when the object finishes
+   * initializing. Throws exception when the setting is set to false.
+   * @param opts
+   * @returns {Promise<SavedObject>}
+   */
+  get(opts?: Record<string, unknown> | string) {
+    const isAugmentationEnabled = this.config.get('visualization:enablePluginAugmentation');
+
+    if (!isAugmentationEnabled) {
+      // eslint-disable-next-line no-throw-literal
+      throw 'Visualization augmentation is disabled, please enable visualization:enablePluginAugmentation.';
+    }
+
+    // can accept object as argument in accordance to SavedVis class
+    // see src/plugins/saved_objects/public/saved_object/saved_object_loader.ts
+    // @ts-ignore
+    const obj = new this.Class(opts);
+    return obj.init();
+  }
+}
+
 export function createSavedAugmentVisLoader(
   services: SavedObjectOpenSearchDashboardsServicesWithAugmentVis
 ) {
   const { savedObjectsClient } = services;
 
-  class SavedObjectLoaderAugmentVis extends SavedObjectLoader {
-    mapHitSource = (source: Record<string, any>, id: string) => {
-      source.id = id;
-      source.visId = get(source, 'visReference.id', '');
-
-      if (isEmpty(source.visReference)) {
-        source.error = 'visReference is missing in augment-vis saved object';
-        return source;
-      }
-      if (isEmpty(source.visLayerExpressionFn)) {
-        source.error = 'visLayerExpressionFn is missing in augment-vis saved object';
-        return source;
-      }
-      if (!(get(source, 'visLayerExpressionFn.type', '') in VisLayerTypes)) {
-        source.error = 'Unknown VisLayer expression function type';
-        return source;
-      }
-      return source;
-    };
-
-    /**
-     * Updates hit.attributes to contain an id related to the referenced visualization
-     * (visId) and returns the updated attributes object.
-     * @param hit
-     * @returns {hit.attributes} The modified hit.attributes object, with an id and url field.
-     */
-    mapSavedObjectApiHits(hit: {
-      references: any[];
-      attributes: Record<string, unknown>;
-      id: string;
-    }) {
-      // For now we are assuming only one vis reference per saved object.
-      // If we change to multiple, we will need to dynamically handle that
-      const visReference = hit.references[0];
-      return this.mapHitSource({ ...hit.attributes, visReference }, hit.id);
-    }
-  }
   const SavedAugmentVis = createSavedAugmentVisClass(services);
-  return new SavedObjectLoaderAugmentVis(SavedAugmentVis, savedObjectsClient) as SavedObjectLoader;
+  return new SavedObjectLoaderAugmentVis(SavedAugmentVis, savedObjectsClient);
 }

src/plugins/vis_augmenter/public/saved_augment_vis/utils/helpers.ts

@@ -3,14 +3,46 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { getSavedAugmentVisLoader } from '../../services';
-import { ISavedAugmentVis } from '../../types';
+import { get } from 'lodash';
+import { getSavedAugmentVisLoader, getUISettings } from '../../services';
+import { ISavedAugmentVis } from '../types';
 
 /**
  * Create an augment vis saved object given an object that
  * implements the ISavedAugmentVis interface
  */
 export const createAugmentVisSavedObject = async (AugmentVis: ISavedAugmentVis): Promise<any> => {
   const loader = getSavedAugmentVisLoader();
+  const config = getUISettings();
+
+  const isAugmentationEnabled = config.get('visualization:enablePluginAugmentation');
+  if (!isAugmentationEnabled) {
+    // eslint-disable-next-line no-throw-literal
+    throw 'Visualization augmentation is disabled, please enable visualization:enablePluginAugmentation.';
+  }
+  const maxAssociatedCount = config.get('visualization:enablePluginAugmentation.maxPluginObjects');
+
+  await loader.findAll().then(async (resp) => {
+    if (resp !== undefined) {
+      const savedAugmentObjects = get(resp, 'hits', []);
+      // gets all the saved object for this visualization
+      const savedObjectsForThisVisualization = savedAugmentObjects.filter(
+        (savedObj) => get(savedObj, 'visId', '') === AugmentVis.visId
+      );
+
+      if (maxAssociatedCount <= savedObjectsForThisVisualization.length) {
+        // eslint-disable-next-line no-throw-literal
+        throw (
+          'Cannot associate the plugin resource to the visualization due to the limit of the' +
+          'max amount of associated plugin resources (' +
+          maxAssociatedCount +
+          ') with ' +
+          savedObjectsForThisVisualization.length +
+          ' associated to the visualization'
+        );
+      }
+    }
+  });
+
   return await loader.get((AugmentVis as any) as Record<string, unknown>);
 };

src/plugins/vis_augmenter/public/services.ts

@@ -3,9 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { createGetterSetter } from '../../opensearch_dashboards_utils/common';
-import { SavedObjectLoader } from '../../saved_objects/public';
+import { createGetterSetter } from '../../opensearch_dashboards_utils/public';
+import { IUiSettingsClient } from '../../../core/public';
+import { SavedObjectLoaderAugmentVis } from './saved_augment_vis';
 
 export const [getSavedAugmentVisLoader, setSavedAugmentVisLoader] = createGetterSetter<
-  SavedObjectLoader
+  SavedObjectLoaderAugmentVis
 >('savedAugmentVisLoader');
+
+export const [getUISettings, setUISettings] = createGetterSetter<IUiSettingsClient>('UISettings');

src/plugins/vis_augmenter/public/utils/utils.ts

@@ -18,6 +18,7 @@ import {
   VisLayer,
   isVisLayerWithError,
 } from '../';
+import { getUISettings } from '../services';
 
 export const isEligibleForVisLayers = (vis: Vis): boolean => {
   // Only support date histogram and ensure there is only 1 x-axis and it has to be on the bottom.
@@ -38,7 +39,10 @@ export const isEligibleForVisLayers = (vis: Vis): boolean => {
   const hasOnlyLineSeries =
     vis.params.seriesParams.every((seriesParam: { type: string }) => seriesParam.type === 'line') &&
     vis.params.type === 'line';
-  return hasValidXaxis && hasCorrectAggregationCount && hasOnlyLineSeries;
+  // Checks if the augmentation setting is enabled
+  const config = getUISettings();
+  const isAugmentationEnabled = config.get('visualization:enablePluginAugmentation');
+  return isAugmentationEnabled && hasValidXaxis && hasCorrectAggregationCount && hasOnlyLineSeries;
 };
 
 /**
@@ -50,6 +54,15 @@ export const getAugmentVisSavedObjs = async (
   visId: string | undefined,
   loader: SavedAugmentVisLoader | undefined
 ): Promise<ISavedAugmentVis[]> => {
+  if (visId === undefined || loader === undefined) {
+    return [] as ISavedAugmentVis[];
+  }
+  const config = getUISettings();
+  const isAugmentationEnabled = config.get('visualization:enablePluginAugmentation');
+  if (!isAugmentationEnabled) {
+    // eslint-disable-next-line no-throw-literal
+    throw 'Visualization augmentation is disabled, please enable visualization:enablePluginAugmentation.';
+  }
   try {
     const resp = await loader?.findAll();
     const allSavedObjects = (get(resp, 'hits', []) as any[]) as ISavedAugmentVis[];

src/plugins/vis_augmenter/server/index.ts

@@ -3,9 +3,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { PluginInitializerContext } from '../../../core/server';
+import { PluginConfigDescriptor, PluginInitializerContext } from '../../../core/server';
 import { VisAugmenterPlugin } from './plugin';
+import { configSchema, VisAugmenterPluginConfigType } from '../config';
 
+export const config: PluginConfigDescriptor<VisAugmenterPluginConfigType> = {
+  exposeToBrowser: {
+    pluginAugmentationEnabled: true,
+  },
+  schema: configSchema,
+};
 export function plugin(initializerContext: PluginInitializerContext) {
   return new VisAugmenterPlugin(initializerContext);
 }

src/plugins/vis_augmenter/server/plugin.ts

@@ -3,6 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { i18n } from '@osd/i18n';
+import { schema } from '@osd/config-schema';
+import { Observable } from 'rxjs';
+import { first } from 'rxjs/operators';
 import {
   PluginInitializerContext,
   CoreSetup,
@@ -12,6 +16,7 @@ import {
 } from '../../../core/server';
 import { augmentVisSavedObjectType } from './saved_objects';
 import { capabilitiesProvider } from './capabilities_provider';
+import { VisAugmenterPluginConfigType } from '../config';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface VisAugmenterPluginSetup {}
@@ -21,15 +26,53 @@ export interface VisAugmenterPluginStart {}
 export class VisAugmenterPlugin
   implements Plugin<VisAugmenterPluginSetup, VisAugmenterPluginStart> {
   private readonly logger: Logger;
+  private readonly config$: Observable<VisAugmenterPluginConfigType>;
 
   constructor(initializerContext: PluginInitializerContext) {
     this.logger = initializerContext.logger.get();
+    this.config$ = initializerContext.config.create<VisAugmenterPluginConfigType>();
   }
 
-  public setup(core: CoreSetup) {
+  public async setup(core: CoreSetup) {
     this.logger.debug('VisAugmenter: Setup');
     core.savedObjects.registerType(augmentVisSavedObjectType);
     core.capabilities.registerProvider(capabilitiesProvider);
+
+    const config: VisAugmenterPluginConfigType = await this.config$.pipe(first()).toPromise();
+    const isAugmentationEnabled =
+      config.pluginAugmentationEnabled === undefined ? true : config.pluginAugmentationEnabled;
+
+    if (isAugmentationEnabled) {
+      core.uiSettings.register({
+        ['visualization:enablePluginAugmentation']: {
+          name: i18n.translate('visualization.enablePluginAugmentationTitle', {
+            defaultMessage: 'Enable plugin augmentation',
+          }),
+          value: true,
+          description: i18n.translate('visualization.enablePluginAugmentationText', {
+            defaultMessage: 'Plugin functionality can be accessed from line chart visualizations',
+          }),
+          category: ['visualization'],
+          schema: schema.boolean(),
+        },
+        ['visualization:enablePluginAugmentation.maxPluginObjects']: {
+          name: i18n.translate('visualization.enablePluginAugmentation.maxPluginObjectsTitle', {
+            defaultMessage: 'Max number of associated augmentations',
+          }),
+          value: 10,
+          description: i18n.translate(
+            'visualization.enablePluginAugmentation.maxPluginObjectsText',
+            {
+              defaultMessage:
+                'Associating more than 10 plugin resources per visualization can lead to performance ' +
+                'issues and increase the cost of running clusters.',
+            }
+          ),
+          category: ['visualization'],
+          schema: schema.number({ min: 0 }),
+        },
+      });
+    }
     return {};
   }