Add new advanced settings for vis augmenter #3961

lezzago · 2023-05-01T21:29:32Z

Description

Add new advanced settings for vis augmenter
Sets default amount of associated plugin resources to a visualization is 10

Issues Resolved

#3361

Check List

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

codecov-commenter · 2023-05-01T22:23:09Z

Codecov Report

Merging #3961 (bb5dc5b) into feature/feature-anywhere (2cc88f3) will decrease coverage by 0.02%.
The diff coverage is 60.00%.

@@                     Coverage Diff                      @@
##           feature/feature-anywhere    #3961      +/-   ##
============================================================
- Coverage                     66.53%   66.52%   -0.02%     
============================================================
  Files                          3245     3246       +1     
  Lines                         62475    62514      +39     
  Branches                       9645     9650       +5     
============================================================
+ Hits                          41569    41585      +16     
- Misses                        18598    18619      +21     
- Partials                       2308     2310       +2

Flag	Coverage Δ
Linux	`66.46% <60.00%> (-0.02%)`	⬇️
Windows	`66.47% <60.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
..._collection/server/collectors/management/schema.ts	`100.00% <ø> (ø)`
src/plugins/vis_augmenter/public/plugin.ts	`0.00% <0.00%> (ø)`
...ugmenter/public/saved_augment_vis/utils/helpers.ts	`6.66% <0.00%> (-26.67%)`	⬇️
...ic/embeddable/create_vis_embeddable_from_object.ts	`5.26% <ø> (ø)`
...izations/public/embeddable/visualize_embeddable.ts	`0.60% <0.00%> (-0.01%)`	⬇️
src/plugins/vis_augmenter/public/utils/utils.ts	`93.02% <71.42%> (-4.28%)`	⬇️
...nter/public/saved_augment_vis/saved_augment_vis.ts	`97.43% <97.29%> (-2.57%)`	⬇️
src/plugins/vis_augmenter/common/constants.ts	`100.00% <100.00%> (ø)`
src/plugins/vis_augmenter/public/services.ts	`100.00% <100.00%> (ø)`
src/plugins/visualizations/public/services.ts	`100.00% <100.00%> (ø)`

... and 3 files with indirect coverage changes

src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts

src/plugins/visualizations/public/services.ts

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

src/plugins/vis_augmenter/public/constants.ts

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

src/plugins/vis_augmenter/public/index.ts

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

ohltyler · 2023-05-18T20:24:05Z

src/plugins/visualizations/public/plugin.ts

-    const savedAugmentVisLoader = createSavedAugmentVisLoader({
-      savedObjectsClient: core.savedObjects.client,
-      indexPatterns: data.indexPatterns,
-      search: data.search,
-      chrome: core.chrome,
-      overlays: core.overlays,
-    });
-    setSavedAugmentVisLoader(savedAugmentVisLoader);


We will still need this - why have you removed?

brought it back

src/plugins/visualizations/public/plugin.ts

…ect/OpenSearch-Dashboards into anywhere-settings

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

ohltyler

LGTM!

ohltyler

LGTM!

joshuarrrr

Cool, it's nice to see this all coming together.

joshuarrrr · 2023-05-22T22:05:30Z

config/opensearch_dashboards.yml

+# opensearchDashboards.survey.url: "https://survey.opensearch.org"
+
+# Set the value of this setting to false to disable plugin augmentation on Dashboard


I don't think we're consistent in this file, but I prefer the form of L232-234; because we provide the commented out default value, the instructions should be about setting it to the non-default:

Suggested change

# Set the value of this setting to false to disable plugin augmentation on Dashboard

# Set the value of this setting to true to enable plugin augmentation on Dashboard visualizations

Oh, I see the default is intended to be true. In that case, keep the text and change the commented value.

I followed the standard of the other settings and the commented value should be false based on that.

joshuarrrr · 2023-05-24T02:00:39Z

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

+  if (!isAugmentationEnabled) {
+    throw new Error(
+      'Visualization augmentation is disabled, please enable visualization:enablePluginAugmentation.'


Out of scope and unrelated to feature anywhere - but ideally we'd make it easy for these types of configuration errors to directly deep link to the relevant setting. I'll open an issue or add to our existing issue about error handling.

added to #1625 (comment)

joshuarrrr · 2023-05-24T02:04:06Z

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

+          `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`


Do we want this error message to indicate that visualization:enablePluginAugmentation.maxPluginObjects is actually a user-configurable setting?

ashwin-pc

The change looks good. The coverage can be added in a followup PR, but calling it out here since it can affect merge to main.

ashwin-pc · 2023-05-24T17:11:24Z

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

+import {
+  PLUGIN_AUGMENTATION_ENABLE_SETTING,
+  PLUGIN_AUGMENTATION_MAX_OBJECTS_SETTING,
+} from '../../../common/constants';

 /**
 * Create an augment vis saved object given an object that
 * implements the ISavedAugmentVis interface
 */
 export const createAugmentVisSavedObject = async (AugmentVis: ISavedAugmentVis): Promise<any> => {


Can you add unit tests here?

Will follow up in another pr

ashwin-pc · 2023-05-24T17:49:17Z

src/plugins/vis_augmenter/server/plugin.ts

+    // Checks if the global yaml setting for enabling plugin augmentation is disabled.
+    // If it is disabled, remove the settings as we would not want to show these to the
+    // user due to it being disabled at the cluster level.
+    if (isAugmentationEnabled) {


This is actually pretty neat that you are relying on the missing UI settings to disable it in the plugin. Calling it out in the comment here will be really helpful in the future though since it may not be obvious that you are doing it this way and its anon standard pattern in the repo.

Will follow up in another pr with the tests

ashwin-pc · 2023-05-24T17:58:32Z

src/plugins/visualizations/public/embeddable/visualize_embeddable.ts

-          id: this.id,
-        });
+    try {
+      const augmentVisSavedObjs = await getAugmentVisSavedObjs(


There seem to be a bunch of coverage failures here too.

Will follow up in another pr

Add new advanced settings

d19a257

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

github-actions bot added the first-time-contributor label May 1, 2023

lezzago added feature-anywhere and removed first-time-contributor labels May 1, 2023

lezzago added the v2.8.0 label May 4, 2023

ashwin-pc mentioned this pull request May 4, 2023

2.8.0 Platform Upgrades for Plugins (Feature Anywhere, Point in time, Node 18,+) #3981

Closed

9 tasks

Merge branch 'feature/feature-anywhere' into anywhere-settings

d2e2a48

lezzago marked this pull request as ready for review May 10, 2023 21:56

lezzago requested review from ananzh, kavilla, seanneumann, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, kristenTian, zhongnansu and manasvinibs as code owners May 10, 2023 21:56

lezzago removed request for seanneumann, joshuarrrr, AMoo-Miki, kavilla, ashwin-pc, zhongnansu, abbyhu2000, zengyan-amazon, ananzh and kristenTian May 10, 2023 21:56

ohltyler reviewed May 12, 2023

View reviewed changes

src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts Outdated Show resolved Hide resolved

ohltyler reviewed May 12, 2023

View reviewed changes

src/plugins/visualizations/public/services.ts Show resolved Hide resolved

lezzago added 2 commits May 12, 2023 16:55

Cleanup plus tests

42bd042

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

code cleanup and address comments

fdaf819

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

abbyhu2000 assigned joshuarrrr May 16, 2023

ohltyler reviewed May 16, 2023

View reviewed changes

src/plugins/vis_augmenter/public/constants.ts Outdated Show resolved Hide resolved

ohltyler mentioned this pull request May 17, 2023

[Feature Anywhere] Cleanup of dangling augment-vis saved objs #4044

Closed

lezzago added 2 commits May 17, 2023 08:55

fix comments

66f7f1f

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

address comments

67276c8

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

ohltyler approved these changes May 17, 2023

View reviewed changes

ohltyler reviewed May 17, 2023

View reviewed changes

src/plugins/vis_augmenter/public/index.ts Outdated Show resolved Hide resolved

lezzago added 2 commits May 17, 2023 10:00

nitpick fix

6c5cb9e

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

Fix the setting

7f553f3

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

ohltyler reviewed May 18, 2023

View reviewed changes

src/plugins/visualizations/public/plugin.ts Outdated Show resolved Hide resolved

ohltyler reviewed May 18, 2023

View reviewed changes

src/plugins/visualizations/public/plugin.ts Outdated Show resolved Hide resolved

lezzago added 2 commits May 18, 2023 16:10

Merge branch 'feature/feature-anywhere' of github.com:opensearch-proj…

0b31c87

…ect/OpenSearch-Dashboards into anywhere-settings

fix dependency issue

d60caa2

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

ohltyler reviewed May 18, 2023

View reviewed changes

src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts Outdated Show resolved Hide resolved

ohltyler reviewed May 18, 2023

View reviewed changes

src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts Outdated Show resolved Hide resolved

fix comments

bb5dc5b

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

ohltyler approved these changes May 18, 2023

View reviewed changes

joshuarrrr approved these changes May 24, 2023

View reviewed changes

joshuarrrr mentioned this pull request May 24, 2023

[Proposal] Error classes, components, and codes #1625

Open

ashwin-pc approved these changes May 24, 2023

View reviewed changes

ashwin-pc merged commit ec4c1df into opensearch-project:feature/feature-anywhere May 24, 2023

ohltyler mentioned this pull request May 24, 2023

[Feature Anywhere] Advanced settings to soft limit on number of anywhere saved objects on a single visualization #3361

Closed

kavilla added v2.9.0 and removed v2.8.0 labels Jun 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new advanced settings for vis augmenter #3961

Add new advanced settings for vis augmenter #3961

lezzago commented May 1, 2023

codecov-commenter commented May 1, 2023 •

edited by codecov bot

Loading

ohltyler May 18, 2023

lezzago May 18, 2023

ohltyler left a comment

ohltyler left a comment

joshuarrrr left a comment

joshuarrrr May 22, 2023

joshuarrrr May 22, 2023

lezzago May 24, 2023

joshuarrrr May 24, 2023

joshuarrrr May 24, 2023

joshuarrrr May 24, 2023

ashwin-pc left a comment

ashwin-pc May 24, 2023

lezzago May 24, 2023

ashwin-pc May 24, 2023

lezzago May 24, 2023

ashwin-pc May 24, 2023

lezzago May 24, 2023

		# opensearchDashboards.survey.url: "https://survey.opensearch.org"

		# Set the value of this setting to false to disable plugin augmentation on Dashboard

	# Set the value of this setting to false to disable plugin augmentation on Dashboard
	# Set the value of this setting to true to enable plugin augmentation on Dashboard visualizations

Add new advanced settings for vis augmenter #3961

Add new advanced settings for vis augmenter #3961

Conversation

lezzago commented May 1, 2023

Description

Issues Resolved

Check List

codecov-commenter commented May 1, 2023 • edited by codecov bot Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ohltyler left a comment

Choose a reason for hiding this comment

ohltyler left a comment

Choose a reason for hiding this comment

joshuarrrr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashwin-pc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented May 1, 2023 •

edited by codecov bot

Loading