[Multiple Datasource] Handle form values(request payload) if the selected type is available in the authentication registry. #6049

xinruiba · 2024-03-06T00:17:38Z

Description

Render credential form for registered from AuthMethod

“Create DataSource” and "Submit Change" Button enable / disable

Issues Resolved

Partially fixes #5692, #5838

Screenshot

AuthCredentialFieldSubmit.mov

Testing the changes

Test steps in this video:

Enable MD
Navigate to the DataSource creation page:
- Ensured that the Registered Auth Option appears under the creation form.
- Confirmed that the "Create data source" button is initially disabled when some fields are empty.
- Validated that the "Create data source" button becomes enabled when all fields are filled.
Proceed to the DataSource Edit page:
- Verified that the "Registered Auth" option appears under the edition form.
- Ensured that the "Save changes" button is initially disabled when some fields are empty.
- Confirmed that the "Save changes" button becomes enabled when all fields are filled.

Additionally, E2E tests have been conducted, and the request payload has been verified as correct for registered Auth Types.

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

…taSource creation and dataSource edition Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

codecov · 2024-03-06T00:31:04Z

Codecov Report

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

Project coverage is 67.11%. Comparing base (9f3a689) to head (a93ac4b).

Files	Patch %	Lines
...omponents/validation/datasource_form_validation.ts	50.00%	1 Missing and 4 partials ⚠️
...components/create_form/create_data_source_form.tsx	75.00%	0 Missing and 2 partials ⚠️
...rce/components/edit_form/edit_data_source_form.tsx	50.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6049      +/-   ##
==========================================
+ Coverage   67.09%   67.11%   +0.01%     
==========================================
  Files        3322     3322              
  Lines       64238    64258      +20     
  Branches    10321    10329       +8     
==========================================
+ Hits        43101    43126      +25     
+ Misses      18621    18610      -11     
- Partials     2516     2522       +6

Flag	Coverage Δ
Linux_1	`31.63% <ø> (ø)`
Linux_2	`55.20% <ø> (ø)`
Linux_3	`44.67% <70.37%> (+<0.01%)`	⬆️
Linux_4	`35.10% <16.66%> (-0.01%)`	⬇️
Windows_1	`31.68% <ø> (+0.02%)`	⬆️
Windows_2	`55.17% <ø> (ø)`
Windows_3	`44.69% <70.37%> (+0.01%)`	⬆️
Windows_4	`35.10% <16.66%> (-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.

…ined in untils.ts Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

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

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

…changes enable / disable control and unit test cases Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

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

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

src/plugins/data_source_management/public/types.ts

Flyingliuhub · 2024-03-08T00:26:15Z

Testing the changes: @xinruiba Can you add detail in this section? Thanks

xinruiba · 2024-03-08T01:04:59Z

Testing the changes: @xinruiba Can you add detail in this section? Thanks

@Flyingliuhub Thanks for the comment, details added.

bandinib-amzn · 2024-03-08T03:10:10Z

CHANGELOG.md

@@ -24,7 +24,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Multiple Datasource] Refactoring create and edit form to use authentication registry ([#6002](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6002))
 - [Multiple Datasource] Expose a few properties for customize the appearance of the data source selector component ([#6057](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6057))
 - [Multiple Datasource] Create data source menu component able to be mount to nav bar ([#6082](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6082))
-
+- [Multiple Datasource] Send registered authentication credentials during the dataSource creation and editing processes ([#6049](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6049))


I would say something simpler, e.g. "Handle form values(request payload) if the selected type is available in the authentication registry." or something like that. Same for PR title.

Thanks for the comment~
Will using the suggested title.

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

bandinib-amzn · 2024-03-08T03:26:00Z

...ement/public/components/edit_data_source/components/edit_form/edit_data_source_form.test.tsx

+      setTimeout(() => {
+        updateInputFieldAndBlur(component, descriptionFieldIdentifier, '');
+        expect(
+          // @ts-ignore


why do we need //@ts-ignore?

Good catch, will remove it.

...ement/public/components/edit_data_source/components/edit_form/edit_data_source_form.test.tsx

bandinib-amzn · 2024-03-08T03:35:01Z

Please update with rebase.

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

…cted type is available in the authentication registry. (#6049) * [Token Exchange Unification] Send registered crendentail field for dataSource creation and dataSource edition Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Add unit test for extractRegisteredAuthTypeCredentials newly defined in untils.ts Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] add more test cases for util.ts Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Add test cases for datasource creation form and datasource edition form Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [Token Exchange Unification + UT] Button create-data-source and save-changes enable / disable control and unit test cases Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update changelog file Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Addressing comments Signed-off-by: Xinrui Bai <xinruiba@amazon.com> --------- Signed-off-by: Xinrui Bai <xinruiba@amazon.com> (cherry picked from commit 6f4d814) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

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

…cted type is available in the authentication registry. (#6049) (#6099) * [Token Exchange Unification] Send registered crendentail field for dataSource creation and dataSource edition Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Add unit test for extractRegisteredAuthTypeCredentials newly defined in untils.ts Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] add more test cases for util.ts Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [UT] Add test cases for datasource creation form and datasource edition form Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * [Token Exchange Unification + UT] Button create-data-source and save-changes enable / disable control and unit test cases Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Update changelog file Signed-off-by: Xinrui Bai <xinruiba@amazon.com> * Addressing comments Signed-off-by: Xinrui Bai <xinruiba@amazon.com> --------- Signed-off-by: Xinrui Bai <xinruiba@amazon.com> (cherry picked from commit 6f4d814) 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>

[Token Exchange Unification] Send registered crendentail field for da…

dfd7d1d

…taSource creation and dataSource edition Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

github-actions bot added the valued-contributor label Mar 6, 2024

xinruiba and others added 6 commits March 6, 2024 01:26

[UT] Add unit test for extractRegisteredAuthTypeCredentials newly def…

2a3003e

…ined in untils.ts Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

[UT] add more test cases for util.ts

ef3f1eb

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

[UT] Add test cases for datasource creation form and datasource editi…

4373151

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

[Token Exchange Unification + UT] Button create-data-source and save-…

8d5ccb7

…changes enable / disable control and unit test cases Signed-off-by: Xinrui Bai <xinruiba@amazon.com>

Merge branch 'main' into xinrui_Token_Exchange_DataSourceSubmit

769051c

Merge branch 'main' into xinrui_Token_Exchange_DataSourceSubmit

7ba6252

xinruiba changed the title ~~[Token Exchange Unification] Send registered credential field for dataSource creation and edition~~ [Token Exchange Unification] Send registered credentials while dataSource creation and edition Mar 7, 2024

xinruiba changed the title ~~[Token Exchange Unification] Send registered credentials while dataSource creation and edition~~ [MD] Token Exchange Unification: Send registered credentials while dataSource creation and edition Mar 7, 2024

xinruiba changed the title ~~[MD] Token Exchange Unification: Send registered credentials while dataSource creation and edition~~ [MD] Token Exchange Unification: send registered auth credentials during dataSource creation and edition Mar 7, 2024

xinruiba changed the title ~~[MD] Token Exchange Unification: send registered auth credentials during dataSource creation and edition~~ [Multiple Datasource] send registered auth credentials during dataSource creation and edition process Mar 7, 2024

xinruiba changed the title ~~[Multiple Datasource] send registered auth credentials during dataSource creation and edition process~~ [Multiple Datasource] Send registered authentication credentials during the dataSource creation and editing processes Mar 7, 2024

Update changelog file

5216e53

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

xinruiba added the backport 2.x label Mar 7, 2024

xinruiba marked this pull request as ready for review March 7, 2024 02:10

xinruiba requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, kristenTian, zhongnansu, manasvinibs, ZilongX, Flyingliuhub and BSFishy as code owners March 7, 2024 02:10

xinruiba requested review from curq, bandinib-amzn, SuZhou-Joe, ruanyl and BionIT as code owners March 7, 2024 02:10

BionIT reviewed Mar 7, 2024

View reviewed changes

...management/public/components/edit_data_source/components/edit_form/edit_data_source_form.tsx Show resolved Hide resolved

src/plugins/data_source_management/public/types.ts Show resolved Hide resolved

xinruiba added the multiple datasource multiple datasource project label Mar 7, 2024

Merge branch 'main' into xinrui_Token_Exchange_DataSourceSubmit

702f592

bandinib-amzn added the v2.13.0 label Mar 8, 2024

Merge branch 'main' into xinrui_Token_Exchange_DataSourceSubmit

aaca03e

bandinib-amzn reviewed Mar 8, 2024

View reviewed changes

Merge branch 'main' into xinrui_Token_Exchange_DataSourceSubmit

2c03bf5

xinruiba changed the title ~~[Multiple Datasource] Send registered authentication credentials during the dataSource creation and editing processes~~ [Multiple Datasource] Handle form values(request payload) if the selected type is available in the authentication registry. Mar 8, 2024

Addressing comments

a93ac4b

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

bandinib-amzn approved these changes Mar 8, 2024

View reviewed changes

yujin-emma approved these changes Mar 8, 2024

View reviewed changes

Flyingliuhub approved these changes Mar 8, 2024

View reviewed changes

Flyingliuhub merged commit 6f4d814 into opensearch-project:main Mar 8, 2024
68 checks passed

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

[Backport 2.x] [Multiple Datasource] Handle form values(request payload) if the selected type is available in the authentication registry. #6099

Merged

xinruiba deleted the xinrui_Token_Exchange_DataSourceSubmit branch March 9, 2024 00:53

tianleh reviewed Mar 9, 2024

View reviewed changes

src/plugins/data_source_management/public/components/utils.ts Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Multiple Datasource] Handle form values(request payload) if the selected type is available in the authentication registry. #6049

[Multiple Datasource] Handle form values(request payload) if the selected type is available in the authentication registry. #6049

xinruiba commented Mar 6, 2024 •

edited

Loading

codecov bot commented Mar 6, 2024 •

edited

Loading

Flyingliuhub commented Mar 8, 2024 •

edited

Loading

xinruiba commented Mar 8, 2024 •

edited

Loading

bandinib-amzn Mar 8, 2024

xinruiba Mar 8, 2024

bandinib-amzn Mar 8, 2024

xinruiba Mar 8, 2024

bandinib-amzn commented Mar 8, 2024

[Multiple Datasource] Handle form values(request payload) if the selected type is available in the authentication registry. #6049

[Multiple Datasource] Handle form values(request payload) if the selected type is available in the authentication registry. #6049

Conversation

xinruiba commented Mar 6, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Mar 6, 2024 • edited Loading

Codecov Report

Flyingliuhub commented Mar 8, 2024 • edited Loading

xinruiba commented Mar 8, 2024 • edited Loading

bandinib-amzn Mar 8, 2024

Choose a reason for hiding this comment

xinruiba Mar 8, 2024

Choose a reason for hiding this comment

bandinib-amzn Mar 8, 2024

Choose a reason for hiding this comment

xinruiba Mar 8, 2024

Choose a reason for hiding this comment

bandinib-amzn commented Mar 8, 2024

xinruiba commented Mar 6, 2024 •

edited

Loading

codecov bot commented Mar 6, 2024 •

edited

Loading

Flyingliuhub commented Mar 8, 2024 •

edited

Loading

xinruiba commented Mar 8, 2024 •

edited

Loading