[VisBuilder] Adds UIState to vis, adds index patterns to embeddable, bug fixes #3751

ashwin-pc · 2023-03-31T01:24:02Z

Note: This Change was built on top of #3732. Some the changes from that PR are in here. This is the diff for the change thats going in this PR: https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3751/files/1472ee1ae26f19b4d8c49e37f65625af2f0076df..6fcace5b6038ae0a5dc41024369410df0c27f02a

Description

This PR has a combination of changes and fixes as listed below:

Adds UI state to the saved object and metadata state to persist data
the multiple errors shown on page load even when there are no aggregations selected
Fixes the issue of being able to select the index pattern in the dashboard views filters when more than one index pattern exists (or if the index pattern differs from the default index pattern)
Fixes typescript errors
Simplifies the serializing and deserializing of saved object data with error handling

Demo:

Screen.Recording.2023-03-30.at.7.04.55.PM.mov

Issues Resolved

Check List

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

codecov-commenter · 2023-03-31T02:08:13Z

Codecov Report

Merging #3751 (71ee8fc) into main (0762566) will increase coverage by 0.03%.
The diff coverage is 27.27%.

❗ Current head 71ee8fc differs from pull request most recent head 68c5a00. Consider uploading reports for the commit 68c5a00 to get more accurate results

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main    #3751      +/-   ##
==========================================
+ Coverage   66.38%   66.42%   +0.03%     
==========================================
  Files        3208     3209       +1     
  Lines       61750    61783      +33     
  Branches     9538     9542       +4     
==========================================
+ Hits        40993    41037      +44     
+ Misses      18461    18456       -5     
+ Partials     2296     2290       -6

Flag	Coverage Δ
Linux	`66.36% <27.27%> (-0.03%)`	⬇️
Windows	`66.36% <27.27%> (?)`

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

Impacted Files	Coverage Δ
...lder/common/vis_builder_saved_object_attributes.ts	`100.00% <ø> (ø)`
...uilder/public/application/components/right_nav.tsx	`12.50% <ø> (ø)`
...uilder/public/application/components/workspace.tsx	`5.26% <0.00%> (-1.19%)`	⬇️
...plication/utils/state_management/metadata_slice.ts	`61.53% <ø> (ø)`
...cation/utils/state_management/redux_persistence.ts	`80.00% <ø> (ø)`
...public/application/utils/state_management/store.ts	`18.75% <ø> (ø)`
...application/utils/use/use_saved_vis_builder_vis.ts	`2.77% <0.00%> (-0.26%)`	⬇️
...ilder/public/embeddable/vis_builder_embeddable.tsx	`0.91% <0.00%> (-0.11%)`	⬇️
...blic/embeddable/vis_builder_embeddable_factory.tsx	`8.69% <0.00%> (-2.42%)`	⬇️
..._builder/public/saved_visualizations/_saved_vis.ts	`0.00% <ø> (ø)`
... and 4 more

... and 12 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

abbyhu2000 · 2023-04-14T15:54:11Z

src/plugins/vis_builder/public/application/utils/state_management/metadata_slice.ts

@@ -22,6 +22,7 @@ export interface MetadataState {
    state: EditorState;
  };
  originatingApp?: string;
+  uiState: any;


Why do we decide to put uiState in the metadata slice? Isn't it better to put uiState in the style slice?

Does uiState have to be any type?

joshuarrrr · 2023-04-17T17:05:38Z

@ashwin-pc When you rebase this, can you take a look at the remaining nits here? #3732 (review)

joshuarrrr · 2023-04-17T18:42:35Z

@ashwin-pc CHANGELOG is missing.

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

joshuarrrr

@ashwin-pc no particular concerns. But it needs a CHANGELOG entry (or skip label), and the snapshots need updating.

joshuarrrr · 2023-04-17T21:09:35Z

src/plugins/vis_builder/public/saved_visualizations/_saved_vis.ts

+          uiState: '{}',
+          version: 3,


Does this need a migration? To initially set the uiState for any previous VisBuilder objects?

joshuarrrr · 2023-04-17T21:35:21Z

src/plugins/vis_builder/public/application/utils/schema.json

+    "styleState",
+    "visualizationState"
+  ],
+  "additionalProperties": false
 }


nit - missing EOF newline

how did I type mission instead of missing 🤣

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

joshuarrrr · 2023-04-17T23:34:39Z

I'm waiting for automation co complete before resolving the CHANGELOG conflict.

joshuarrrr · 2023-04-18T00:38:34Z

All tests pass. I'll resolve the changelog conflict, and then merge without awaiting another test run.

…bug fixes (#3751) * adds uiActions to visBuilder * prevents multiple errors on load * fixes visbuilder type errors * fixes save * adds ui state to vis builder * fixes tests * Adds support in embeddables for multiple indices * Moves ui state to separate slice * Adds changelog Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> --------- Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Co-authored-by: Josh Romero <rmerqg@amazon.com> (cherry picked from commit ee32d20) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

…to embeddable, bug fixes (#3874) * [VisBuilder] Adds UIState to vis, adds index patterns to embeddable, bug fixes (#3751) * adds uiActions to visBuilder * prevents multiple errors on load * fixes visbuilder type errors * fixes save * adds ui state to vis builder * fixes tests * Adds support in embeddables for multiple indices * Moves ui state to separate slice * Adds changelog Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> --------- Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Co-authored-by: Josh Romero <rmerqg@amazon.com> (cherry picked from commit ee32d20) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md * add changelog Signed-off-by: Josh Romero <rmerqg@amazon.com> --------- Signed-off-by: Josh Romero <rmerqg@amazon.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Josh Romero <rmerqg@amazon.com>

ashwin-pc added 7 commits March 28, 2023 02:34

adds uiActions to visBuilder

5d2338e

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

prevents multiple errors on load

aab0349

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

fixes visbuilder type errors

217286f

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

fixes save

1472ee1

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

adds ui state to vis builder

9fe1a32

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

fixes tests

d2b1b0e

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

Adds support in embeddables for multiple indices

6fcace5

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

ashwin-pc requested a review from a team as a code owner March 31, 2023 01:24

ashwin-pc self-assigned this Mar 31, 2023

ashwin-pc added vis builder backport 2.x v2.7.0 labels Mar 31, 2023

ashwin-pc mentioned this pull request Apr 5, 2023

2.7.0 Platform Upgrades for Plugins (O11y, MDS, Geospatial,+) #3674

Closed

23 tasks

joshuarrrr assigned joshuarrrr and abbyhu2000 Apr 13, 2023

abbyhu2000 mentioned this pull request Apr 14, 2023

[VisBuilder] 2 way communication using UI actions and bug fixes #3732

Merged

8 tasks

abbyhu2000 reviewed Apr 17, 2023

View reviewed changes

Merge branch 'main' into embeddables-multiple-indices

a3743c4

ashwin-pc requested review from ananzh, kavilla, seanneumann, AMoo-Miki, joshuarrrr, zengyan-amazon, kristenTian, zhongnansu and manasvinibs as code owners April 17, 2023 18:27

Moves ui state to separate slice

97ccbe9

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

joshuarrrr reviewed Apr 17, 2023

View reviewed changes

Fixes tests

71ee8fc

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

joshuarrrr previously approved these changes Apr 17, 2023

View reviewed changes

Adds changelog

ceb5860

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

ashwin-pc dismissed joshuarrrr’s stale review via ceb5860 April 17, 2023 22:50

Merge branch 'main' into embeddables-multiple-indices

68c5a00

abbyhu2000 previously approved these changes Apr 17, 2023

View reviewed changes

joshuarrrr previously approved these changes Apr 17, 2023

View reviewed changes

Merge branch 'main' into embeddables-multiple-indices

6c9bddc

joshuarrrr dismissed stale reviews from abbyhu2000 and themself via 6c9bddc April 18, 2023 00:38

abbyhu2000 approved these changes Apr 18, 2023

View reviewed changes

joshuarrrr approved these changes Apr 18, 2023

View reviewed changes

joshuarrrr merged commit ee32d20 into opensearch-project:main Apr 18, 2023

opensearch-trigger-bot bot mentioned this pull request Apr 18, 2023

[Backport 2.x] [VisBuilder] Adds UIState to vis, adds index patterns to embeddable, bug fixes #3874

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[VisBuilder] Adds UIState to vis, adds index patterns to embeddable, bug fixes #3751

[VisBuilder] Adds UIState to vis, adds index patterns to embeddable, bug fixes #3751

ashwin-pc commented Mar 31, 2023 •

edited

Loading

codecov-commenter commented Mar 31, 2023 •

edited

Loading

abbyhu2000 Apr 14, 2023

abbyhu2000 Apr 14, 2023

joshuarrrr commented Apr 17, 2023

joshuarrrr commented Apr 17, 2023

joshuarrrr left a comment

joshuarrrr Apr 17, 2023

joshuarrrr Apr 17, 2023 •

edited

Loading

joshuarrrr Apr 17, 2023

joshuarrrr commented Apr 17, 2023

joshuarrrr commented Apr 18, 2023

[VisBuilder] Adds UIState to vis, adds index patterns to embeddable, bug fixes #3751

[VisBuilder] Adds UIState to vis, adds index patterns to embeddable, bug fixes #3751

Conversation

ashwin-pc commented Mar 31, 2023 • edited Loading

Description

Issues Resolved

Check List

codecov-commenter commented Mar 31, 2023 • edited Loading

Codecov Report

abbyhu2000 Apr 14, 2023

Choose a reason for hiding this comment

abbyhu2000 Apr 14, 2023

Choose a reason for hiding this comment

joshuarrrr commented Apr 17, 2023

joshuarrrr commented Apr 17, 2023

joshuarrrr left a comment

Choose a reason for hiding this comment

joshuarrrr Apr 17, 2023

Choose a reason for hiding this comment

joshuarrrr Apr 17, 2023 • edited Loading

Choose a reason for hiding this comment

joshuarrrr Apr 17, 2023

Choose a reason for hiding this comment

joshuarrrr commented Apr 17, 2023

joshuarrrr commented Apr 18, 2023

ashwin-pc commented Mar 31, 2023 •

edited

Loading

codecov-commenter commented Mar 31, 2023 •

edited

Loading

joshuarrrr Apr 17, 2023 •

edited

Loading