[Multiple Datasource] Refactor data source menu and interface to allow cleaner selection of component and related configurations #6256

BionIT · 2024-03-24T22:17:29Z

Description

This change refactors data source menu and its interface to allow cleaner selection of respective data source component and related configurations

Issues Resolved

Fixes #6239

Screenshot

refactor2.mp4

Testing the changes

The following were performed in the recording:

enable data source plugin
change the code of search relevance to use the interface to mount data source selectable component, and it renders successfully
change the code of search relevance to use the interface to mount data source aggregated view component, and it renders successfully
change the code of search relevance to use the interface to mount data source view component, and it renders successfully

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

Signed-off-by: Lu Yu <nluyu@amazon.com>

codecov · 2024-03-24T22:31:07Z

Codecov Report

Attention: Patch coverage is 78.94737% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 67.35%. Comparing base (6c25f2d) to head (291f19e).

Files	Patch %	Lines
...c/components/data_source_menu/data_source_menu.tsx	84.61%	0 Missing and 2 partials ⚠️
...onents/data_source_menu/data_source_selectable.tsx	0.00%	1 Missing ⚠️
...rc/plugins/data_source_management/public/plugin.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6256      +/-   ##
==========================================
+ Coverage   67.34%   67.35%   +0.01%     
==========================================
  Files        3352     3353       +1     
  Lines       65082    65083       +1     
  Branches    10486    10483       -3     
==========================================
+ Hits        43831    43839       +8     
+ Misses      18699    18694       -5     
+ Partials     2552     2550       -2

Flag	Coverage Δ
Linux_1	`31.82% <ø> (ø)`
Linux_2	`55.57% <ø> (ø)`
Linux_3	`44.83% <78.94%> (+0.09%)`	⬆️
Linux_4	`35.03% <5.26%> (-0.01%)`	⬇️
Windows_1	`31.84% <ø> (ø)`
Windows_2	`55.53% <ø> (ø)`
Windows_3	`44.84% <78.94%> (+0.09%)`	⬆️
Windows_4	`35.03% <5.26%> (-0.01%)`	⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Lu Yu <nluyu@amazon.com>

AMoo-Miki · 2024-03-25T17:34:22Z

src/plugins/data_source_management/public/components/data_source_menu/data_source_menu.tsx

-    return null;
-  }
+export function DataSourceMenu<T>(props: DataSourceMenuProps<T>): ReactElement | null {
+  const { componentType, componentConfig } = props;


Any reason why we cannot simply made the type prop be type?
Also, is there a reason to have a bunch of props clubbed into config? To me, it feels natural not club them.

@AMoo-Miki , this was based on discussion with @ashwin-pc @Flyingliuhub @ZilongX @yujin-emma last week to group the configs specific to a component and use generic type for better readability which I think makes a lot of sense here. If we don't do that, all the configs to all components will need to the the prop for Data Source Menu. Also, this is similar to how TopNavMenu accepts the config https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx#L47

src/plugins/data_source_management/public/components/data_source_menu/types.ts

bandinib-amzn · 2024-03-25T18:24:56Z

src/plugins/data_source_management/public/components/data_source_menu/types.ts

+  setMenuMountPoint?: (menuMount: MountPoint | undefined) => void;
+  componentConfig: T;


same as above. Just for a sake of readability I guess

ZilongX · 2024-03-25T18:46:39Z

CHANGELOG.md

@@ -63,6 +63,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Workspace] Register a workspace dropdown menu at the top of left nav bar ([#6150](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6150))
 - [Multiple Datasource] Add icon in datasource table page to show the default datasource ([#6231](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6231))
 - [Multiple Datasource] Add TLS configuration for multiple data sources ([#6171](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6171))
+- [Multiple Datasource] Refactor data source menu and interface to allow cleaner selection of component and related configurations ([#6256](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6256))


Just a small trick to avoid potential changelog conflicts (since there are a lot..), instead of attaching the changelog entry as last line (L66 in this case), simply stuff it into the middle (say L64) would save the efforts to resolve changelog conflicts

Good to know, thanks!

ZilongX · 2024-03-25T18:48:58Z

...plugins/data_source_management/public/components/data_source_menu/data_source_selectable.tsx


 interface DataSourceSelectableProps {
  savedObjectsClient: SavedObjectsClientContract;
  notifications: ToastsStart;
-  onSelectedDataSource: (dataSource: DataSourceOption) => void;
+  onSelectedDataSources: (dataSources: DataSourceOption[]) => void;


any context of the renaming from onSelectedDataSource to onSelectedDataSources ? MDS drop down doesn't support multiple selected right ? (aka we can only select one data source at a time)

We are supporting multi select which is in another PR, thus changing it to selected data sources

Signed-off-by: Lu Yu <nluyu@amazon.com>

…w cleaner selection of component and related configurations (#6256) * refactor Signed-off-by: Lu Yu <nluyu@amazon.com> * refactor data source menu Signed-off-by: Lu Yu <nluyu@amazon.com> * add change log Signed-off-by: Lu Yu <nluyu@amazon.com> * move configs based on if it is required Signed-off-by: Lu Yu <nluyu@amazon.com> * move optional params below required Signed-off-by: Lu Yu <nluyu@amazon.com> --------- Signed-off-by: Lu Yu <nluyu@amazon.com> Co-authored-by: ZilongX <99905560+ZilongX@users.noreply.github.com> (cherry picked from commit 4f1884b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

…w cleaner selection of component and related configurations (#6256) (#6267) * refactor Signed-off-by: Lu Yu <nluyu@amazon.com> * refactor data source menu Signed-off-by: Lu Yu <nluyu@amazon.com> * add change log Signed-off-by: Lu Yu <nluyu@amazon.com> * move configs based on if it is required Signed-off-by: Lu Yu <nluyu@amazon.com> * move optional params below required Signed-off-by: Lu Yu <nluyu@amazon.com> --------- Signed-off-by: Lu Yu <nluyu@amazon.com> Co-authored-by: ZilongX <99905560+ZilongX@users.noreply.github.com> (cherry picked from commit 4f1884b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Lu Yu <nluyu@amazon.com>

BionIT added 2 commits March 22, 2024 23:45

refactor

47a3dc1

Signed-off-by: Lu Yu <nluyu@amazon.com>

refactor data source menu

e5f53b7

Signed-off-by: Lu Yu <nluyu@amazon.com>

BionIT requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, BSFishy, curq, bandinib-amzn, SuZhou-Joe, ruanyl and xinruiba as code owners March 24, 2024 22:17

github-actions bot added the seasoned-contributor label Mar 24, 2024

BionIT added 2 commits March 24, 2024 15:19

Merge branch 'main' into refactor2

4f6422b

add change log

34f263e

Signed-off-by: Lu Yu <nluyu@amazon.com>

move configs based on if it is required

6d807de

Signed-off-by: Lu Yu <nluyu@amazon.com>

AMoo-Miki reviewed Mar 25, 2024

View reviewed changes

bandinib-amzn previously approved these changes Mar 25, 2024

View reviewed changes

Merge branch 'main' into refactor2

5a2a8e5

xinruiba previously approved these changes Mar 25, 2024

View reviewed changes

ZilongX reviewed Mar 25, 2024

View reviewed changes

ZilongX self-requested a review March 25, 2024 20:57

ZilongX previously approved these changes Mar 25, 2024

View reviewed changes

move optional params below required

5a9206f

Signed-off-by: Lu Yu <nluyu@amazon.com>

BionIT dismissed stale reviews from ZilongX, xinruiba, and bandinib-amzn via 5a9206f March 25, 2024 22:40

bandinib-amzn approved these changes Mar 25, 2024

View reviewed changes

Merge branch 'main' into refactor2

291f19e

ZilongX self-requested a review March 25, 2024 23:02

ZilongX approved these changes Mar 25, 2024

View reviewed changes

xinruiba approved these changes Mar 26, 2024

View reviewed changes

BionIT merged commit 4f1884b into opensearch-project:main Mar 26, 2024
70 checks passed

BionIT added backport 2.x v2.14.0 multiple datasource multiple datasource project labels Mar 26, 2024

opensearch-trigger-bot bot mentioned this pull request Mar 26, 2024

[Backport 2.x] [Multiple Datasource] Refactor data source menu and interface to allow cleaner selection of component and related configurations #6267

Merged

BionIT mentioned this pull request Apr 9, 2024

[Meta] [2.14] Security, bug fix and enhancemanet for dashboards anywhere #5872

Closed

77 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Multiple Datasource] Refactor data source menu and interface to allow cleaner selection of component and related configurations #6256

[Multiple Datasource] Refactor data source menu and interface to allow cleaner selection of component and related configurations #6256

BionIT commented Mar 24, 2024 •

edited

codecov bot commented Mar 24, 2024 •

edited

AMoo-Miki Mar 25, 2024

BionIT Mar 25, 2024

bandinib-amzn Mar 25, 2024

ZilongX Mar 25, 2024

BionIT Mar 25, 2024

ZilongX Mar 25, 2024

BionIT Mar 25, 2024

		setMenuMountPoint?: (menuMount: MountPoint \| undefined) => void;
		componentConfig: T;

[Multiple Datasource] Refactor data source menu and interface to allow cleaner selection of component and related configurations #6256

[Multiple Datasource] Refactor data source menu and interface to allow cleaner selection of component and related configurations #6256

Conversation

BionIT commented Mar 24, 2024 • edited

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Mar 24, 2024 • edited

Codecov Report

AMoo-Miki Mar 25, 2024

Choose a reason for hiding this comment

BionIT Mar 25, 2024

Choose a reason for hiding this comment

bandinib-amzn Mar 25, 2024

Choose a reason for hiding this comment

ZilongX Mar 25, 2024

Choose a reason for hiding this comment

BionIT Mar 25, 2024

Choose a reason for hiding this comment

ZilongX Mar 25, 2024

Choose a reason for hiding this comment

BionIT Mar 25, 2024

Choose a reason for hiding this comment

BionIT commented Mar 24, 2024 •

edited

codecov bot commented Mar 24, 2024 •

edited