Add set default datasource #6186

zhyuanqi · 2024-03-18T21:19:22Z

Description

Add the default datasource. So after customer sets the datasource, this will store in the Kibana config
For overview default datasource, it should have feature below:

[Done]Customer can set default datasource and it would be saved in the Kibana file under config.
[Done]Once customer sets a datasource as default, they cannot undefault the datasource

Issues Resolved

#6058

Screenshot

Screen.Recording.2024-03-18.at.2.17.02.PM.mov

Testing the changes

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

bandinib-amzn · 2024-03-18T21:33:40Z

Looks like there are some lint issues (see Build and test / Build and Verify on Linux CI). Can you fix those please?

codecov · 2024-03-18T21:33:45Z

Codecov Report

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

Project coverage is 67.25%. Comparing base (daccae7) to head (df11696).

Files	Patch %	Lines
...rce/components/edit_form/edit_data_source_form.tsx	66.66%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6186   +/-   ##
=======================================
  Coverage   67.24%   67.25%           
=======================================
  Files        3345     3345           
  Lines       64826    64840   +14     
  Branches    10432    10435    +3     
=======================================
+ Hits        43595    43606   +11     
- Misses      18689    18690    +1     
- Partials     2542     2544    +2

Flag	Coverage Δ
Linux_1	`31.64% <ø> (ø)`
Linux_2	`55.45% <ø> (ø)`
Linux_3	`44.74% <92.85%> (+0.02%)`	⬆️
Linux_4	`35.05% <ø> (ø)`
Windows_1	`31.67% <ø> (ø)`
Windows_2	`55.41% <ø> (ø)`
Windows_3	`44.75% <92.85%> (+0.02%)`	⬆️
Windows_4	`35.05% <ø> (ø)`

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.

bandinib-amzn · 2024-03-18T21:36:58Z

...ugins/data_source_management/public/components/edit_data_source/components/header/header.tsx

+  const setDefaultAriaLabel = i18n.translate(
+    'dataSourcesManagement.editDataSource.setDefaultDataSource',
+    {
+      defaultMessage: 'Set as default Data Source.',
+    }
+  );


nit: Set as default data source

...ugins/data_source_management/public/components/edit_data_source/components/header/header.tsx

bandinib-amzn · 2024-03-18T21:40:45Z

...ugins/data_source_management/public/components/edit_data_source/components/header/header.tsx

@@ -144,6 +174,8 @@ export const Header = ({
      {/* Right side buttons */}
      <EuiFlexItem grow={false}>
        <EuiFlexGroup alignItems="baseline" gutterSize="m" responsive={false}>
+          {/* Test defaultn button */}


nit: spelling mistake

Will change it

bandinib-amzn · 2024-03-18T21:44:07Z

Is this option only going to be on edit screen? What about while creating data source? Can we set default data source while creating data source? Just to avoid multiple clicks and rendering multiple forms to set default data source.

BionIT · 2024-03-18T21:56:42Z

CHANGELOG.md

@@ -117,6 +117,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Discover] Enhanced the data source selector with added sorting functionality ([#5609](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/5609))
 - [Multiple Datasource] Add datasource picker component and use it in devtools and tutorial page when multiple datasource is enabled ([#5756](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5756))
 - [Multiple Datasource] Add datasource picker to import saved object flyout when multiple data source is enabled ([#5781](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5781))
+- [Multiple Datasource] Add default functionality for customer to choose default datasource ([#6058](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/6058))


we should put the change log in the unreleased enhancement section above, this section is for previous 2.12 release

BionIT · 2024-03-18T21:58:00Z

...management/public/components/edit_data_source/components/edit_form/edit_data_source_form.tsx

+  }
+
+  isDefault =  () => {
+    return this.props.isDefault;


looks like this function only exists to return the prop, then do we need it? Can we just use the prop value?

BionIT · 2024-03-18T21:59:00Z

...ugins/data_source_management/public/components/edit_data_source/components/header/header.tsx

+  const setDefaultAriaLabel = i18n.translate(
+    'dataSourcesManagement.editDataSource.setDefaultDataSource',
+    {
+      defaultMessage: 'Set as default Data Source.',
+    }
+  );


BionIT · 2024-03-18T22:01:45Z

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

@@ -128,7 +135,9 @@ export const EditDataSource: React.FunctionComponent<RouteComponentProps<{ id: s
          <EditDataSourceForm


can we add tests for this component?

ananzh · 2024-03-18T23:40:35Z

CHANGELOG.md

@@ -12,6 +12,9 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

 - Support dynamic CSP rules to mitigate Clickjacking https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5641
 - [CVE-2020-36604] Employ a patched version of hoek `6.1.3` ([#6148](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6148))
+- [CVE-2023-45857] Bump `axios` from `0.27.2` to `1.6.1` ([#5470](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5470))


changelog updates should not contain other PRs. probably just need a rebase.

seraphjiang · 2024-03-19T00:57:50Z

[P1]The first create datasource should be auto choice as default datasource

[P1] If customer deletes a datasource, clients side should check if it is the default datasource, if it is, it would randomly choose a datasource as default datasouce. If no remaining datasource, the defaultDataSource in Config is none.

@zhyuanqi
this should be out of scope for this PR. could we remove from PR's description. we may track in the meta issue

zhyuanqi · 2024-03-19T03:25:12Z

Is this option only going to be on edit screen? What about while creating data source? Can we set default data source while creating data source? Just to avoid multiple clicks and rendering multiple forms to set default data source.

Currently, we don't support set default data source while creating data source. I believe it is the same as index pattern as they don't support set as default during creation. Maybe we can add this in the feature

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

ZilongX · 2024-03-19T16:52:43Z

LGTM, just curious - [Done]Once customer sets a datasource as default, they cannot undefault the datasource feels like the set default datasource operation being a one shot thing then if customer can not undefault, so would the default update being out of scope of this PR or that's designed on purpose ?

ZilongX · 2024-03-19T16:53:08Z

meanwhile picking up the latest from main and re-running all the checks

zhyuanqi · 2024-03-19T16:58:06Z

LGTM, just curious - [Done]Once customer sets a datasource as default, they cannot undefault the datasource feels like the set default datasource operation being a one shot thing then if customer can not undefault, so would the default update being out of scope of this PR or that's designed on purpose ?

So we always want customer to have a default datasource. Although customer can not undefault datasource, they can default other datasource in order to undefault the previous one.
We will have two new features about default coming up for next release as

The first create datasource should be auto choice as default datasource
If customer deletes a datasource, clients side should check if it is the default datasource, if it is, it would randomly choose a datasource as default datasouce. If no remaining datasource, the defaultDataSource in Config is none.

* Add set default datasource Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * Fix typo Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * change on this.props.isDefault Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * add unit test Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * set data_source to false Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * add more unit test Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * fix lint error Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * edit one more unit test Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * Fix another typo Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> --------- Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> Co-authored-by: ZilongX <99905560+ZilongX@users.noreply.github.com> (cherry picked from commit d2347ca) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

* Add set default datasource Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * Fix typo Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * change on this.props.isDefault Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * add unit test Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * set data_source to false Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * add more unit test Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * fix lint error Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * edit one more unit test Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * Fix another typo Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> --------- Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> Co-authored-by: ZilongX <99905560+ZilongX@users.noreply.github.com> (cherry picked from commit d2347ca) 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>

zhyuanqi 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 BionIT as code owners March 18, 2024 21:19

github-actions bot added the first-time-contributor label Mar 18, 2024

bandinib-amzn reviewed Mar 18, 2024

View reviewed changes

BionIT reviewed Mar 18, 2024

View reviewed changes

ananzh reviewed Mar 18, 2024

View reviewed changes

zhongnansu added the multiple datasource multiple datasource project label Mar 19, 2024

zhyuanqi added 3 commits March 19, 2024 03:48

Add set default datasource

1823eaa

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

Fix typo

813d4f3

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

change on this.props.isDefault

4d0bb20

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

add unit test

2e66cf9

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

zhyuanqi force-pushed the zhyuanqi-setdefault branch from 05fb380 to 2e66cf9 Compare March 19, 2024 03:55

set data_source to false

68eb710

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

BionIT previously approved these changes Mar 19, 2024

View reviewed changes

add more unit test

898ecea

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

zhyuanqi dismissed BionIT’s stale review via 898ecea March 19, 2024 05:49

zhyuanqi and others added 4 commits March 19, 2024 06:01

fix lint error

4029b73

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

edit one more unit test

c5e076b

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

Fix another typo

b96bba8

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

Merge branch 'main' into zhyuanqi-setdefault

df11696

ZilongX added the backport 2.x label Mar 19, 2024

xinruiba approved these changes Mar 19, 2024

View reviewed changes

BionIT approved these changes Mar 19, 2024

View reviewed changes

Flyingliuhub approved these changes Mar 19, 2024

View reviewed changes

Flyingliuhub merged commit d2347ca into opensearch-project:main Mar 19, 2024
71 checks passed

Flyingliuhub added the v2.13.0 label Mar 19, 2024

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

[Backport 2.x] Add set default datasource #6200

Merged

BionIT mentioned this pull request Mar 27, 2024

[Multiple Datasource] With default data source rendered in the data source component, we need to let consumers know which default data source id is used #6276

Closed

2 tasks

zhyuanqi mentioned this pull request Apr 3, 2024

[Enhancement][UX] Option to set data source as default data source. #5868

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add set default datasource #6186

Add set default datasource #6186

zhyuanqi commented Mar 18, 2024 •

edited

Loading

bandinib-amzn commented Mar 18, 2024

codecov bot commented Mar 18, 2024 •

edited

Loading

bandinib-amzn Mar 18, 2024

zhyuanqi Mar 18, 2024

BionIT Mar 18, 2024

bandinib-amzn Mar 18, 2024

zhyuanqi Mar 18, 2024

bandinib-amzn commented Mar 18, 2024

BionIT Mar 18, 2024

zhyuanqi Mar 18, 2024

BionIT Mar 18, 2024

xinruiba Mar 18, 2024

BionIT Mar 18, 2024

BionIT Mar 18, 2024

zhyuanqi Mar 19, 2024

ananzh Mar 18, 2024

zhyuanqi Mar 18, 2024

seraphjiang commented Mar 19, 2024

zhyuanqi commented Mar 19, 2024 •

edited

Loading

ZilongX commented Mar 19, 2024 •

edited

Loading

ZilongX commented Mar 19, 2024

zhyuanqi commented Mar 19, 2024

		@@ -128,7 +135,9 @@ export const EditDataSource: React.FunctionComponent<RouteComponentProps<{ id: s
		<EditDataSourceForm

Add set default datasource #6186

Add set default datasource #6186

Conversation

zhyuanqi commented Mar 18, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

bandinib-amzn commented Mar 18, 2024

codecov bot commented Mar 18, 2024 • edited Loading

Codecov Report

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

bandinib-amzn commented Mar 18, 2024

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

seraphjiang commented Mar 19, 2024

zhyuanqi commented Mar 19, 2024 • edited Loading

ZilongX commented Mar 19, 2024 • edited Loading

ZilongX commented Mar 19, 2024

zhyuanqi commented Mar 19, 2024

zhyuanqi commented Mar 18, 2024 •

edited

Loading

codecov bot commented Mar 18, 2024 •

edited

Loading

zhyuanqi commented Mar 19, 2024 •

edited

Loading

ZilongX commented Mar 19, 2024 •

edited

Loading