Hide/Show authentication method in multi data source plugin based on configuration #5916

xinruiba · 2024-02-22T02:01:20Z

Description

PR to hide/Show authentication method in multi data source plugin based on configuration

Please check more details under #5694

Issues Resolved

#5694

Screenshot

AuthTypeRegistry.mov

Testing the changes

New test cases added.

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

…ass value to dataSourceManagement root mount Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

…with AuthRegistray and providing data source options from AuthRegistry Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

codecov · 2024-02-22T02:15:28Z

Codecov Report

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

Project coverage is 67.02%. Comparing base (6d5560e) to head (6d7463e).
Report is 4 commits behind head on main.

❗ Current head 6d7463e differs from pull request most recent head 39f77b9. Consider uploading reports for the commit 39f77b9 to get more accurate results

Files	Patch %	Lines
...rc/plugins/data_source_management/public/plugin.ts	42.85%	1 Missing and 3 partials ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5916   +/-   ##
=======================================
  Coverage   67.01%   67.02%           
=======================================
  Files        3310     3307    -3     
  Lines       63647    63650    +3     
  Branches    10165    10171    +6     
=======================================
+ Hits        42656    42664    +8     
+ Misses      18522    18514    -8     
- Partials     2469     2472    +3

Flag	Coverage Δ
Linux_1	`35.21% <ø> (ø)`
Linux_2	`55.09% <ø> (ø)`
Linux_3	`43.68% <89.47%> (-0.70%)`	⬇️
Linux_4	`35.21% <52.17%> (+<0.01%)`	⬆️
Windows_1	`35.24% <ø> (ø)`
Windows_2	`55.06% <ø> (ø)`
Windows_3	`43.70% <89.47%> (-0.70%)`	⬇️
Windows_4	`35.21% <52.17%> (+<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.

…ce creation page Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

…s no more than 1 Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

…ct NoAuth option. Also update credentialField data type Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

src/plugins/data_source/server/index.ts

...components/create_data_source_wizard/components/create_form/create_data_source_form.test.tsx

Flyingliuhub · 2024-02-26T22:12:37Z

src/plugins/data_source_management/public/components/utils.test.ts

+      });
+    });
+
+    test('default auth method is NoAuth when no auth options configured', () => {


I thought that will nothing return, and gray out. so we changed the plan to show NoAuth

@bandinib-amzn and I have a further discussion, when there are no option enabled, the UX will looks like this:

bandinib-amzn · 2024-02-26T23:17:53Z

Can we update this text as well?

If NoAuthentication.enabled: true

Enter the authentication details to access the endpoint. If no authentication is required, select No authentication

If NoAuthentication.enabled: false

Enter the authentication details to access the endpoint.

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

xinruiba · 2024-02-27T01:27:48Z

Synced with @bandinib-amzn offline, when NoAuth type not been supported, the page will looks like this:

...components/create_data_source_wizard/components/create_form/create_data_source_form.test.tsx

...blic/components/create_data_source_wizard/components/create_form/create_data_source_form.tsx

…e default message in datasorurce creation form ---> auth type section Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

xinruiba · 2024-02-27T23:13:24Z

Test failure not looks like related to this change.

…configuration (#5916) * [AuthType Config] Add EnabledAuthType configuration in yml file and pass value to dataSourceManagement root mount Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthType Config] provide default auth types when types array is empty Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard - DataSourceCreationForm] Integrate auth cofig with AuthRegistray and providing data source options from AuthRegistry Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] Support default selected auth type in datasource creation page Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] SDisable auth option selector when auth options no more than 1 Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] clear credential attribute every time use select NoAuth option. Also update credentialField data type Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update yml file to disable config Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update change.md file Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Fix broken test cases Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Add more unit tests Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update unit test and handle scenario when no options enabled Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update description of unit test case Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update unit test cases to resolve comment Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Snapshot auth option super selector for unit test. Also upate the default message in datasorurce creation form ---> auth type section Signed-off-by: Xinrui Bai <xinruiba@amazon.com> --------- Signed-off-by: Xinrui Bai <xinruiba@amazon.com> (cherry picked from commit 20b6c5a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

…configuration (opensearch-project#5916) * [AuthType Config] Add EnabledAuthType configuration in yml file and pass value to dataSourceManagement root mount Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthType Config] provide default auth types when types array is empty Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard - DataSourceCreationForm] Integrate auth cofig with AuthRegistray and providing data source options from AuthRegistry Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] Support default selected auth type in datasource creation page Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] SDisable auth option selector when auth options no more than 1 Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] clear credential attribute every time use select NoAuth option. Also update credentialField data type Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update yml file to disable config Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update change.md file Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Fix broken test cases Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Add more unit tests Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update unit test and handle scenario when no options enabled Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update description of unit test case Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update unit test cases to resolve comment Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Snapshot auth option super selector for unit test. Also upate the default message in datasorurce creation form ---> auth type section Signed-off-by: Xinrui Bai <xinruiba@amazon.com> --------- Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

…configuration (#5916) (#5976) * [AuthType Config] Add EnabledAuthType configuration in yml file and pass value to dataSourceManagement root mount Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthType Config] provide default auth types when types array is empty Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard - DataSourceCreationForm] Integrate auth cofig with AuthRegistray and providing data source options from AuthRegistry Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] Support default selected auth type in datasource creation page Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] SDisable auth option selector when auth options no more than 1 Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] clear credential attribute every time use select NoAuth option. Also update credentialField data type Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update yml file to disable config Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update change.md file Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Fix broken test cases Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Add more unit tests Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update unit test and handle scenario when no options enabled Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update description of unit test case Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update unit test cases to resolve comment Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Snapshot auth option super selector for unit test. Also upate the default message in datasorurce creation form ---> auth type section Signed-off-by: Xinrui Bai <xinruiba@amazon.com> --------- Signed-off-by: Xinrui Bai <xinruiba@amazon.com> (cherry picked from commit 20b6c5a) 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>

…configuration (opensearch-project#5916) * [AuthType Config] Add EnabledAuthType configuration in yml file and pass value to dataSourceManagement root mount Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthType Config] provide default auth types when types array is empty Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard - DataSourceCreationForm] Integrate auth cofig with AuthRegistray and providing data source options from AuthRegistry Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] Support default selected auth type in datasource creation page Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] SDisable auth option selector when auth options no more than 1 Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [AuthRegistry Onboard] clear credential attribute every time use select NoAuth option. Also update credentialField data type Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update yml file to disable config Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update change.md file Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Fix broken test cases Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Add more unit tests Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update unit test and handle scenario when no options enabled Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update description of unit test case Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] update unit test cases to resolve comment Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Snapshot auth option super selector for unit test. Also upate the default message in datasorurce creation form ---> auth type section Signed-off-by: Xinrui Bai <xinruiba@amazon.com> --------- Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

xinruiba added 3 commits February 20, 2024 00:40

[AuthType Config] Add EnabledAuthType configuration in yml file and p…

333987f

…ass value to dataSourceManagement root mount Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

[AuthType Config] provide default auth types when types array is empty

5327710

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

[AuthRegistry Onboard - DataSourceCreationForm] Integrate auth cofig …

cc91319

…with AuthRegistray and providing data source options from AuthRegistry Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

github-actions bot added the repeat-contributor label Feb 22, 2024

xinruiba and others added 10 commits February 23, 2024 00:12

[AuthRegistry Onboard] Support default selected auth type in datasour…

0339047

…ce creation page Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

[AuthRegistry Onboard] SDisable auth option selector when auth option…

9b138fe

…s no more than 1 Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

[AuthRegistry Onboard] clear credential attribute every time use sele…

f0b4c88

…ct NoAuth option. Also update credentialField data type Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

Merge branch 'opensearch-project:main' into xinrui_AuthMethod_Config

c6bb34c

Update yml file to disable config

1ebd2e2

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

Update change.md file

91e734e

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

[UT] Fix broken test cases

fc0369e

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

Merge branch 'main' into xinrui_AuthMethod_Config

2bf8abe

[UT] Add more unit tests

f0201ef

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

Merge branch 'main' into xinrui_AuthMethod_Config

ae1b8c8

xinruiba marked this pull request as ready for review February 23, 2024 19:45

xinruiba requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, kristenTian, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, BSFishy and curq as code owners February 23, 2024 19:45

Merge branch 'opensearch-project:main' into xinrui_AuthMethod_Config

246b1d3

Flyingliuhub reviewed Feb 26, 2024

View reviewed changes

src/plugins/data_source/server/index.ts Show resolved Hide resolved

Flyingliuhub reviewed Feb 26, 2024

View reviewed changes

...components/create_data_source_wizard/components/create_form/create_data_source_form.test.tsx Show resolved Hide resolved

Flyingliuhub reviewed Feb 26, 2024

View reviewed changes

xinruiba and others added 2 commits February 26, 2024 16:24

Merge branch 'main' into xinrui_AuthMethod_Config

551f87a

[UT] update unit test and handle scenario when no options enabled

c2da4e2

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

xinruiba dismissed ZilongX’s stale review via c2da4e2 February 27, 2024 01:08

xinruiba added 2 commits February 27, 2024 01:17

[UT] update description of unit test case

8f2c75a

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

[UT] update unit test cases to resolve comment

6d7463e

Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

Merge branch 'main' into xinrui_AuthMethod_Config

f11cebf

Flyingliuhub previously approved these changes Feb 27, 2024

View reviewed changes

Merge branch 'main' into xinrui_AuthMethod_Config

b0b1918

xinruiba dismissed Flyingliuhub’s stale review via b0b1918 February 27, 2024 19:07

bandinib-amzn reviewed Feb 27, 2024

View reviewed changes

...components/create_data_source_wizard/components/create_form/create_data_source_form.test.tsx Outdated Show resolved Hide resolved

...blic/components/create_data_source_wizard/components/create_form/create_data_source_form.tsx Outdated Show resolved Hide resolved

xinruiba and others added 3 commits February 27, 2024 21:26

[UT] Snapshot auth option super selector for unit test. Also upate th…

9d39598

…e default message in datasorurce creation form ---> auth type section Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

Merge branch 'main' into xinrui_AuthMethod_Config

070195d

Merge branch 'main' into xinrui_AuthMethod_Config

39f77b9

Flyingliuhub approved these changes Feb 27, 2024

View reviewed changes

bandinib-amzn approved these changes Feb 28, 2024

View reviewed changes

bandinib-amzn added the multiple datasource multiple datasource project label Feb 28, 2024

bandinib-amzn merged commit 20b6c5a into opensearch-project:main Feb 28, 2024
17 checks passed

opensearch-trigger-bot bot mentioned this pull request Feb 28, 2024

[Backport 2.x] Hide/Show authentication method in multi data source plugin based on configuration #5976

Merged

Flyingliuhub mentioned this pull request Mar 13, 2024

[DOC] Update multiple data sources exiting documents to include the recently changes opensearch-project/documentation-website#6667

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Hide/Show authentication method in multi data source plugin based on configuration #5916

Hide/Show authentication method in multi data source plugin based on configuration #5916

xinruiba commented Feb 22, 2024 •

edited

Loading

codecov bot commented Feb 22, 2024 •

edited

Loading

Flyingliuhub Feb 26, 2024

xinruiba Feb 27, 2024

bandinib-amzn commented Feb 26, 2024

xinruiba commented Feb 27, 2024 •

edited

Loading

xinruiba commented Feb 27, 2024

Hide/Show authentication method in multi data source plugin based on configuration #5916

Hide/Show authentication method in multi data source plugin based on configuration #5916

Conversation

xinruiba commented Feb 22, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Feb 22, 2024 • edited Loading

Codecov Report

Flyingliuhub Feb 26, 2024

Choose a reason for hiding this comment

xinruiba Feb 27, 2024

Choose a reason for hiding this comment

bandinib-amzn commented Feb 26, 2024

xinruiba commented Feb 27, 2024 • edited Loading

xinruiba commented Feb 27, 2024

xinruiba commented Feb 22, 2024 •

edited

Loading

codecov bot commented Feb 22, 2024 •

edited

Loading

xinruiba commented Feb 27, 2024 •

edited

Loading