enhance grouping for context menus #3169

sikhote · 2023-01-02T00:03:24Z

Note: Commits will be signed off as final step.

Description

Lowers the minimum children count to 2, allowing for smaller groups within context menus
Adds a separator between groups
Add documentation and some variable renaming for clarity
Adds an option to the embedded panel component to remove borders and padding

Issues Resolved

Check List

ashwin-pc

The main change seems fine. Have some questions around the other changes that arent directly related to the PR title. Also since you dabbled quite deep into UI actions and context menus, can you add documentation to the UI Actions readme too? Currently it does not discuss anything about your change or why its needed. Lets make sure that the next person using context menus and UI actions does not have to do the deep dive you did.

ashwin-pc · 2023-03-13T19:55:55Z

config/opensearch_dashboards.yml

+opensearch.hosts: ["https://localhost:9200"]
+opensearch.username: "admin" # Default username on the docker image
+opensearch.password: "admin" # Default password on the docker image
+opensearch.ssl.verificationMode: none


Can you remove this from the PR. We should not be making changes to the YML unless necessary

Removed for final cleanup.

ashwin-pc · 2023-03-13T19:56:18Z

package.json

@@ -11,7 +11,7 @@
    "dashboarding"
  ],
  "private": true,
-  "version": "3.0.0",
+  "version": "2.3.0",


Can you remove this change?

Removed for final cleanup.

ashwin-pc · 2023-03-13T19:56:29Z

src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts

@@ -81,7 +81,7 @@ export interface EmbeddableFactory<
   * Returns a display name for this type of embeddable. Used in "Create new... " options
   * in the add panel for containers.
   */
-  getDisplayName(): string;
+  getDisplayName(): JSX.Element | string;


Why is this change necessary?

The getDisplayName changes are all related to allowing the names to also accept JSX, rather than just strings. In some situations we can now pass icons into the title, enhancing functionality.

ashwin-pc · 2023-03-13T20:01:27Z

src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx

+  isRetained?: boolean;
+  isBorderless?: boolean;


Did we agree on this change? The source issue only talks about context menus. This changes how the embeddable can be used and the API of embeddables. I would not club this change with this PR. Can we open a separate issue to decide on it first and then make the change?

FYI, i'm not against the feature, but rather, I want to document the new API better so that others are aware of it. e.g. I have no idea what isRetained signifies unless i see this PR.

I have not spoken with anyone about these changes. The isBorderless prop is helpful in order to display the embeddable panel without any extra styling, which is not desired in our upcoming feature. The isRetained prop prevents the embeddable from being destroyed—I will rename it to isDestroyPrevented, which might be a better name—my goal with the naming is to allow the default to be false. I will also add a comment above the prop for explanation.

As for grouping these changes together—for our feature, all of these changes are needed together. I generally find it ok to group changes, but please let me know if it is required to split them into multiple PRs.

ashwin-pc · 2023-03-13T20:02:04Z

src/plugins/ui_actions/public/actions/action.ts

@@ -92,7 +92,7 @@ export interface Action<Context extends BaseContext = {}, T = ActionType>
   * Returns a title to be displayed to the user.
   * @param context
   */
-  getDisplayName(context: ActionExecutionContext<Context>): string;
+  getDisplayName(context: ActionExecutionContext<Context>): JSX.Element | string;


Again, why is this not a string anymore?

ashwin-pc · 2023-03-13T20:11:44Z

src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx

+
+    // Reference to the last group...groups are provided in array order of
+    // parent to children (or outer to inner)
+    let parentPanelId = '';
+
    if (action.grouping) {
      for (let i = 0; i < action.grouping.length; i++) {
        const group = action.grouping[i];
-        currentPanel = group.id;
-        if (!panels[currentPanel]) {
+        const groupId = group.id;
+
+        if (!panels[groupId]) {
          const name = group.getDisplayName ? group.getDisplayName(context) : group.id;
-          panels[currentPanel] = {
-            id: currentPanel,
+
+          // Create panel for group
+          panels[groupId] = {
+            id: groupId,
            title: name,
            items: [],
            _level: i,
            _icon: group.getIconType ? group.getIconType(context) : 'empty',
          };
-          if (parentPanel) {
-            panels[parentPanel].items!.push({
+
+          // If there are multiple groups and this is not the first group,
+          // then add an item to the parent panel relating to this group
+          if (parentPanelId) {
+            panels[parentPanelId].items!.push({
              name,
-              panel: currentPanel,
+              panel: groupId,
              icon: group.getIconType ? group.getIconType(context) : 'empty',
              _order: group.order || 0,
              _title: group.getDisplayName ? group.getDisplayName(context) : '',
            });
          }
        }
-        parentPanel = currentPanel;
+
+        // Save the current panel, because this will be used for adding items
+        // to it from later groups in the array
+        parentPanelId = groupId;
      }
    }
-    panels[parentPanel || 'mainMenu'].items!.push({
+
+    // If grouping exists, parentPanelId will be the most-inner group,
+    // otherwise use the mainMenu panel.
+    // Add item for action to this most-inner panel or mainMenu.
+    panels[parentPanelId || 'mainMenu'].items!.push({


Did anything change here functionally?

Overall, for this file, yes. We now have borders separating groups, which was a TODO before. There is also some rewrite to make things more readable and with comments to document what is happening, since this functionality is a bit difficult to follow, even with the comments.

ashwin-pc · 2023-03-13T20:12:49Z

src/plugins/ui_actions/public/types.ts

@@ -65,7 +65,7 @@ export interface TriggerContextMapping {
  [VISUALIZE_GEO_FIELD_TRIGGER]: VisualizeFieldContext;
 }

-const DEFAULT_ACTION = '';
+export const DEFAULT_ACTION = '';


No issue with this export, just curious why it was needed since you arent using it anywhere in the PR.

Removed as it's no longer needed—when i first started working with the actions I did not know how to add in types for new actions, but I figured that out since 👍

ashwin-pc · 2023-03-13T20:16:51Z

src/plugins/ui_actions/public/context_menu/build_eui_context_menu_panels.tsx

+    // If the panel is a root-level panel, such as a group-based panel,
+    // then create mainMenu item for this panel
    if (panel._level === 0) {
-      // TODO: Add separator line here once it is available in EUI.
-      // See https://github.com/elastic/eui/pull/4018
-      if (panel.items.length > 3) {
+      // Add separator with unique key if needed
+      if (panels.mainMenu.items.length) {
+        panels.mainMenu.items.push({ isSeparator: true, key: `${panel.id}separator` });
+      }
+
+      // If a panel has more than one child, then allow item's to be grouped
+      // and link to it in the mainMenu. Otherwise, flatten the group.
+      if (panel.items.length > 1) {


Can you add a unit test for this?

Yes, will add this soon and comment here when completed 👍

Test added ✅

codecov-commenter · 2023-03-20T23:36:29Z

Codecov Report

Merging #3169 (129af78) into main (99a88e3) will decrease coverage by 0.03%.
The diff coverage is 76.92%.

📣 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    #3169      +/-   ##
==========================================
- Coverage   66.47%   66.45%   -0.03%     
==========================================
  Files        3209     3210       +1     
  Lines       61617    61679      +62     
  Branches     9504     9524      +20     
==========================================
+ Hits        40961    40989      +28     
- Misses      18384    18404      +20     
- Partials     2272     2286      +14

Flag	Coverage Δ
Linux	`66.40% <76.92%> (-0.03%)`	⬇️
Windows	`66.40% <76.92%> (-0.02%)`	⬇️

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

Impacted Files	Coverage Δ
...s/embeddable/public/lib/panel/embeddable_panel.tsx	`63.44% <0.00%> (-0.69%)`	⬇️
...ugins/ui_actions/public/actions/action_internal.ts	`47.36% <ø> (ø)`
src/plugins/ui_actions/public/index.ts	`100.00% <ø> (ø)`
...lic/context_menu/build_eui_context_menu_panels.tsx	`75.60% <90.90%> (+16.35%)`	⬆️

... and 42 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.

sikhote · 2023-04-04T03:23:30Z

@ashwin-pc I had responded to all comments (some were duplicates). Please let me know if you have any other feedback, thank you.

P.S. I will add in commit sign-offs as a final step.

joshuarrrr · 2023-04-10T21:56:05Z

@sikhote Some of your commits are missing the sign-off, so DCO won't pass. Can you either squash them or rebase with the signatures?

EDIT - saw your note up top. This PR will also need a changelog entry.

sikhote · 2023-04-17T20:27:59Z

Will do both of those soon 👍

… and show filter (opensearch-project#2656) * Create filter registry for saved object management to make filters extensible Signed-off-by: Craig Perkins <[email protected]> * WIP on making fetchCounts generic Signed-off-by: Craig Perkins <[email protected]> * First step at making scroll_counts generic Signed-off-by: Craig Perkins <[email protected]> * Work on getting other filter counts with same object count endpoint Signed-off-by: Craig Perkins <[email protected]> * Get tenant count options to display Signed-off-by: Craig Perkins <[email protected]> * Extend find to work with namespaces for saved objects Signed-off-by: Craig Perkins <[email protected]> * Add missing filterFields Signed-off-by: Craig Perkins <[email protected]> * Update jest tests Signed-off-by: Craig Perkins <[email protected]> * Update saved_objects_table snapshot Signed-off-by: Craig Perkins <[email protected]> * Append index to id to make unique Signed-off-by: Craig Perkins <[email protected]> * Add semi-colon Signed-off-by: Craig Perkins <[email protected]> * Fix saved objects table tests with new id scheme Signed-off-by: Craig Perkins <[email protected]> * Only append idx on config type to ensure Advanced Settings have a unique id across tenants Signed-off-by: Craig Perkins <[email protected]> * Remove itemsClone in favor of showing only Advanced Settings of current tenant Signed-off-by: Craig Perkins <[email protected]> * Revert snapshots in table.test.tsx Signed-off-by: Craig Perkins <[email protected]> * Add additional parse_query test Signed-off-by: Craig Perkins <[email protected]> * Add comma Signed-off-by: Craig Perkins <[email protected]> * Create namespaceRegistry to decouple security dashboards plugin and osd core Signed-off-by: Craig Perkins <[email protected]> * Add ability to register an alias Signed-off-by: Craig Perkins <[email protected]> * Update parse query and add to CHANGELOG Signed-off-by: Craig Perkins <[email protected]> * Remove commented out code Signed-off-by: Craig Perkins <[email protected]> * Address code review comments Signed-off-by: Craig Perkins <[email protected]> * Override i18n if alias is regitered Signed-off-by: Craig Perkins <[email protected]> Signed-off-by: Craig Perkins <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Signed-off-by: David Sinclair <[email protected]>

…ls to not destroy on unmount Signed-off-by: David Sinclair <[email protected]>

Signed-off-by: David Sinclair <[email protected]>

…h-project#2638) x-pack references in the code are removed as per the given files in opensearch-project#2517 Issue Resolved: opensearch-project#2517 Signed-off-by: vimal K <[email protected]> Signed-off-by: David Sinclair <[email protected]>

…-project#2681)" (opensearch-project#2694) This reverts commit 887093d. Now that downstream plugins and projects are unblocked from builds, we want to make these changes following our standard processes and automated checks Signed-off-by: Josh Romero <[email protected]> Signed-off-by: Josh Romero <[email protected]> Signed-off-by: David Sinclair <[email protected]>

…-project#2538) * Add MD design documents, including high level design, user stories, client management detailed design Signed-off-by: Su <[email protected]> Signed-off-by: David Sinclair <[email protected]>

* Adds helper functions, @osd/cross-platform, to work around the differences of platforms Signed-off-by: Miki <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Signed-off-by: Kristen Tian <[email protected]> Signed-off-by: Kristen Tian <[email protected]> Signed-off-by: David Sinclair <[email protected]>

…PRs (opensearch-project#2726) Signed-off-by: Miki <[email protected]> Signed-off-by: Miki <[email protected]> Signed-off-by: David Sinclair <[email protected]>

* Enable visbuilder by default Signed-off-by: Ashwin P Chandran <[email protected]> * Adds changelog entry Signed-off-by: Ashwin P Chandran <[email protected]> Signed-off-by: Ashwin P Chandran <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Fixes a small typo in TSVB README.md file. Issue: n/a Signed-off-by: Kawika Avilla <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Ran npx browserslist@latest --update-db to update caniuse package so the integration tests will pass. Issue: n/a Will be fixed in: opensearch-project#2329 Signed-off-by: Kawika Avilla <[email protected]> Signed-off-by: David Sinclair <[email protected]>

…nsearch-project#3533) Bump vega from 5.22.1 to 5.23.0. This will also bump vega-function from 5.13.0 to 5.13.1. Issue Resolved: opensearch-project#3526 opensearch-project#3525 Signed-off-by: Anan Zhuang <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Enable the downloading of Darwin for running the command `yarn opensearch snapshot`. Darwin is not officially supported but snapshots are being built here: https://build.ci.opensearch.org/job/distribution-build-opensearch/ Issue resolved: opensearch-project#2944 Signed-off-by: Kawika Avilla <[email protected]> Co-authored-by: Josh Romero <[email protected]> Signed-off-by: David Sinclair <[email protected]>

* Follow-up from opensearch-project#3018 Signed-off-by: Tommy Markley <[email protected]> Signed-off-by: David Sinclair <[email protected]>

* Improved typings Passing this first param to `CoreSetup` generic would set a proper type to `depsStart` returned from `core.getStartServices()` Signed-off-by: Aleksandar Djindjic <[email protected]> * Nit - rename example deps prop Signed-off-by: Josh Romero <[email protected]> --------- Signed-off-by: Aleksandar Djindjic <[email protected]> Signed-off-by: Josh Romero <[email protected]> Co-authored-by: Josh Romero <[email protected]> Co-authored-by: Miki <[email protected]> Signed-off-by: David Sinclair <[email protected]>

…istence (opensearch-project#3495) * Add metric to metric, bucket to bucket aggregation persistance Signed-off-by: abbyhu2000 <[email protected]> * Add logics to avoid exceeding the max count for each schema field Signed-off-by: abbyhu2000 <[email protected]> * Add changelog entry Signed-off-by: abbyhu2000 <[email protected]> * addressing comments Signed-off-by: abbyhu2000 <[email protected]> * Add unit tests for functions in use_persisted_agg_params Signed-off-by: abbyhu2000 <[email protected]> * rewrite unit tests to test the entire functionality Signed-off-by: abbyhu2000 <[email protected]> --------- Signed-off-by: abbyhu2000 <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> Signed-off-by: David Sinclair <[email protected]>

* docker dev set up folder Signed-off-by: abbyhu2000 <[email protected]> * add curl commands to set up and copy the files Signed-off-by: abbyhu2000 <[email protected]> * changelog changes Signed-off-by: abbyhu2000 <[email protected]> * addressing comments Signed-off-by: abbyhu2000 <[email protected]> * add docker link to the developer guide Signed-off-by: abbyhu2000 <[email protected]> * Add notes on docker desktop Signed-off-by: abbyhu2000 <[email protected]> * publish the docker image to docker hub Signed-off-by: abbyhu2000 <[email protected]> * add docker exec as another option Signed-off-by: abbyhu2000 <[email protected]> --------- Signed-off-by: abbyhu2000 <[email protected]> Signed-off-by: David Sinclair <[email protected]>

…rch-project#3514) * ci: reduce redundancy by using matrix strategy on Windows and Linux workflows (opensearch-project#3514) * update CHANGELOG.md (opensearch-project#3514) * ci: fix overriding matrix for Linux x86 (opensearch-project#3514) * ci: update os checks in preparation for darwin (opensearch-project#3514) Signed-off-by: Julian Labatut <[email protected]> Co-authored-by: Miki <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Signed-off-by: Josh Romero <[email protected]> Signed-off-by: David Sinclair <[email protected]>

* feat: add json worker and language implement in dashboards Signed-off-by: suzhou <[email protected]> --------- Signed-off-by: suzhou <[email protected]> Co-authored-by: Anan Zhuang <[email protected]> Co-authored-by: Josh Romero <[email protected]> Signed-off-by: David Sinclair <[email protected]>

* adds ui actions explorer Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme Signed-off-by: Ashwin P Chandran <[email protected]> * updates UI actions readme again Signed-off-by: Ashwin P Chandran <[email protected]> * cleans up developer examples view Signed-off-by: Ashwin P Chandran <[email protected]> * adds changelog Signed-off-by: Ashwin P Chandran <[email protected]> --------- Signed-off-by: Ashwin P Chandran <[email protected]> Signed-off-by: David Sinclair <[email protected]>

opensearch-project#3619) Issue Resolved: opensearch-project#3618 Signed-off-by: Anan Zhuang <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Signed-off-by: David Sinclair <[email protected]>

sikhote · 2023-04-24T04:08:32Z

Closing for a signed off PR

https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3924/commits

sikhote requested a review from a team as a code owner January 2, 2023 00:03

sikhote marked this pull request as draft January 2, 2023 22:38

jackiehanyang mentioned this pull request Jan 25, 2023

[Feature Anywhere] Framework for plugin registration #2916

Closed

sikhote mentioned this pull request Feb 20, 2023

add dashboard context menus opensearch-project/alerting-dashboards-plugin#490

Merged

5 tasks

sikhote marked this pull request as ready for review March 12, 2023 23:48

ashwin-pc self-assigned this Mar 13, 2023

ashwin-pc requested changes Mar 13, 2023

View reviewed changes

joshuarrrr added feature-anywhere v2.8.0 labels Mar 23, 2023

lezzago mentioned this pull request Mar 23, 2023

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

Closed

23 tasks

sikhote mentioned this pull request Mar 27, 2023

Add dashboard context option integration opensearch-project/alerting-dashboards-plugin#509

Merged

5 tasks

cwperks and others added 15 commits April 23, 2023 21:00

enhance grouping for context menus

e23dd44

Signed-off-by: David Sinclair <[email protected]>

cleanup

9a55d27

Signed-off-by: David Sinclair <[email protected]>

add comments

6c237e2

Signed-off-by: David Sinclair <[email protected]>

allow getDisplayName to return JSX, create option for embeddable pane…

5f30822

…ls to not destroy on unmount Signed-off-by: David Sinclair <[email protected]>

cleanup

5cd5e57

Signed-off-by: David Sinclair <[email protected]>

add option to remove border from embedded panel

9b15430

Signed-off-by: David Sinclair <[email protected]>

pr comment adjustments

af17b75

Signed-off-by: David Sinclair <[email protected]>

[MD] Add design documents of multiple data source feature (opensearch…

bd54143

…-project#2538) * Add MD design documents, including high level design, user stories, client management detailed design Signed-off-by: Su <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Adds @osd/cross-platform (opensearch-project#2703)

11379c4

* Adds helper functions, @osd/cross-platform, to work around the differences of platforms Signed-off-by: Miki <[email protected]> Signed-off-by: David Sinclair <[email protected]>

[MD]Update MD data source documentation link (opensearch-project#2693)

73c0ae3

Signed-off-by: Kristen Tian <[email protected]> Signed-off-by: Kristen Tian <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Add Skip-Changelog label to skip changelog verification on certain …

dc1f8e3

…PRs (opensearch-project#2726) Signed-off-by: Miki <[email protected]> Signed-off-by: Miki <[email protected]> Signed-off-by: David Sinclair <[email protected]>

kavilla and others added 15 commits April 23, 2023 21:00

[Docs] fix typo in TSVB README (opensearch-project#3518)

e3bd98b

Fixes a small typo in TSVB README.md file. Issue: n/a Signed-off-by: Kawika Avilla <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Simplifies re2 upgrade instructions (opensearch-project#3328)

f2ce0ae

* Follow-up from opensearch-project#3018 Signed-off-by: Tommy Markley <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Chore: add 1.3.9 release notes (opensearch-project#3613)

e027a83

Signed-off-by: Josh Romero <[email protected]> Signed-off-by: David Sinclair <[email protected]>

Use mirrors to download Node.js binaries to escape sporadic 404 errors (

c6dd84a

opensearch-project#3619) Issue Resolved: opensearch-project#3618 Signed-off-by: Anan Zhuang <[email protected]> Signed-off-by: David Sinclair <[email protected]>

add test of building context menus with groups

110a0ba

Signed-off-by: David Sinclair <[email protected]>

add changelog entry

449c2a6

Signed-off-by: David Sinclair <[email protected]>

sikhote force-pushed the enhance-grouping-for-context-menus branch from 129af78 to 449c2a6 Compare April 24, 2023 04:01

sikhote requested review from ananzh, kavilla, seanneumann, AMoo-Miki, joshuarrrr, abbyhu2000, zengyan-amazon, kristenTian, zhongnansu and manasvinibs as code owners April 24, 2023 04:01

sikhote closed this Apr 24, 2023

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

enhance grouping for context menus #3169

enhance grouping for context menus #3169

sikhote commented Jan 2, 2023 •

edited

Loading

ashwin-pc left a comment

ashwin-pc Mar 13, 2023

sikhote Apr 3, 2023

ashwin-pc Mar 13, 2023

sikhote Apr 3, 2023

ashwin-pc Mar 13, 2023

sikhote Apr 3, 2023

ashwin-pc Mar 13, 2023

sikhote Apr 3, 2023

ashwin-pc Mar 13, 2023

ashwin-pc Mar 13, 2023

sikhote Apr 3, 2023

ashwin-pc Mar 13, 2023

sikhote Apr 3, 2023

ashwin-pc Mar 13, 2023

sikhote Apr 3, 2023

sikhote Apr 4, 2023

codecov-commenter commented Mar 20, 2023 •

edited

Loading

sikhote commented Apr 4, 2023

joshuarrrr commented Apr 10, 2023 •

edited

Loading

sikhote commented Apr 17, 2023

sikhote commented Apr 24, 2023 •

edited

Loading

enhance grouping for context menus #3169

enhance grouping for context menus #3169

Conversation

sikhote commented Jan 2, 2023 • edited Loading

Description

Issues Resolved

Check List

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Mar 20, 2023 • edited Loading

Codecov Report

sikhote commented Apr 4, 2023

joshuarrrr commented Apr 10, 2023 • edited Loading

sikhote commented Apr 17, 2023

sikhote commented Apr 24, 2023 • edited Loading

sikhote commented Jan 2, 2023 •

edited

Loading

codecov-commenter commented Mar 20, 2023 •

edited

Loading

joshuarrrr commented Apr 10, 2023 •

edited

Loading

sikhote commented Apr 24, 2023 •

edited

Loading