Refactor workspace datasource association #8545

ruanyl · 2024-10-10T10:46:10Z

Description

This PR refactored the data source management page to include:

Added a button to page header to associate data source to current workspace
Added a table action set default data source when inside a workspace
Added a table action to dissociate data source from the current workspace

Screen.Recording.2024-10-10.at.18.43.16.mov

Issues Resolved

Screenshot

Testing the changes

Changelog

feat: refactor data source list page to include data source association features for workspace

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

…t page Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

…een dissociated Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

codecov · 2024-10-10T11:07:08Z

Codecov Report

Attention: Patch coverage is 49.50980% with 103 lines in your changes missing coverage. Please review.

Project coverage is 60.93%. Comparing base (91fd6d3) to head (3d1f537).
Report is 10 commits behind head on main.

Files with missing lines	Patch %	Lines
...ion/manage_direct_query_data_connections_table.tsx	38.33%	25 Missing and 12 partials ⚠️
...components/data_source_table/data_source_table.tsx	54.90%	18 Missing and 5 partials ⚠️
src/plugins/workspace/server/workspace_client.ts	0.00%	16 Missing ⚠️
...ata_source_association/data_source_association.tsx	70.73%	5 Missing and 7 partials ⚠️
src/plugins/workspace/public/workspace_client.ts	0.00%	9 Missing ⚠️
src/plugins/workspace/server/routes/index.ts	25.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8545      +/-   ##
==========================================
- Coverage   60.93%   60.93%   -0.01%     
==========================================
  Files        3771     3777       +6     
  Lines       89541    89845     +304     
  Branches    14017    14082      +65     
==========================================
+ Hits        54563    54745     +182     
- Misses      31567    31668     +101     
- Partials     3411     3432      +21

Flag	Coverage Δ
Linux_1	`29.15% <53.76%> (+0.13%)`	⬆️
Linux_2	`56.28% <ø> (+<0.01%)`	⬆️
Linux_3	`37.80% <45.94%> (+0.05%)`	⬆️
Linux_4	`29.94% <ø> (+0.02%)`	⬆️
Windows_1	`29.16% <53.76%> (+0.13%)`	⬆️
Windows_2	`56.23% <ø> (+<0.01%)`	⬆️
Windows_3	`37.81% <45.94%> (+0.05%)`	⬆️
Windows_4	`29.94% <ø> (+0.02%)`	⬆️

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.

SuZhou-Joe · 2024-10-11T07:30:53Z

src/core/public/workspace/types.ts

+  error?: string;
+}
+
+export interface IWorkspaceClient {


I guess we may need a TODO here to add other methods of client.

Yes, those should be refactored as well

wanglam · 2024-10-11T07:59:13Z

src/core/public/workspace/types.ts

+}
+
+export interface WorkspaceUI {
+  DataSourceAssociation: (props: DataSourceAssociationProps) => JSX.Element;


Nit: How about use typeof DataSourceAssociation here?

Here is interface definition in core, DataSourceAssociation is the implementation in workspace plugin, so it should be the other way around.

wanglam · 2024-10-11T08:17:59Z

...urces_components/direct_query_data_connection/manage_direct_query_data_connections_table.tsx

+
+  const isDashboardAdmin = !!application?.capabilities?.dashboards?.isDashboardAdmin;
+  const canAssociateDataSource =
+    !!currentWorkspace && !currentWorkspace.readonly && isDashboardAdmin;


Nit: Since we already check isDashboardAdmin at the end, do we need to check if workspace readonly here?

src/plugins/workspace/server/workspace_client.ts

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

* refactor: add data source association button to data source management page Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * feat: add action button to dissociate data source from data source table Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * Changeset file for PR #8545 created/updated * fix: automatically set a default data source if default data source been dissociated Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * feat: implement bulk dissociate in data source management page Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * fix lint Signed-off-by: Yulong Ruan <ruanyl@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit fc03639) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* refactor: add data source association button to data source management page * feat: add action button to dissociate data source from data source table * Changeset file for PR #8545 created/updated * fix: automatically set a default data source if default data source been dissociated * feat: implement bulk dissociate in data source management page * fix lint --------- (cherry picked from commit fc03639) Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

* refactor: add data source association button to data source management page Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * feat: add action button to dissociate data source from data source table Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * Changeset file for PR opensearch-project#8545 created/updated * fix: automatically set a default data source if default data source been dissociated Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * feat: implement bulk dissociate in data source management page Signed-off-by: Yulong Ruan <ruanyl@amazon.com> * fix lint Signed-off-by: Yulong Ruan <ruanyl@amazon.com> --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

ruanyl added 2 commits October 10, 2024 12:51

refactor: add data source association button to data source managemen…

f3246bf

…t page Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

feat: add action button to dissociate data source from data source table

251ad2d

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

github-actions bot added the all-star-contributor label Oct 10, 2024

opensearch-changeset-bot bot and others added 2 commits October 10, 2024 10:46

Changeset file for PR opensearch-project#8545 created/updated

dc77275

fix: automatically set a default data source if default data source b…

1d43771

…een dissociated Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

SuZhou-Joe reviewed Oct 11, 2024

View reviewed changes

SuZhou-Joe added backport 2.x workspace labels Oct 11, 2024

wanglam reviewed Oct 11, 2024

View reviewed changes

Hailong-am reviewed Oct 11, 2024

View reviewed changes

src/plugins/workspace/server/workspace_client.ts Show resolved Hide resolved

feat: implement bulk dissociate in data source management page

f28ec3a

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

SuZhou-Joe previously approved these changes Oct 12, 2024

View reviewed changes

fix lint

3d1f537

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

ruanyl dismissed SuZhou-Joe’s stale review via 3d1f537 October 12, 2024 01:55

Hailong-am approved these changes Oct 12, 2024

View reviewed changes

wanglam approved these changes Oct 12, 2024

View reviewed changes

SuZhou-Joe approved these changes Oct 12, 2024

View reviewed changes

ruanyl merged commit fc03639 into opensearch-project:main Oct 12, 2024
67 of 68 checks passed

opensearch-trigger-bot bot mentioned this pull request Oct 12, 2024

[Backport 2.x] Refactor workspace datasource association #8571

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor workspace datasource association #8545

Refactor workspace datasource association #8545

ruanyl commented Oct 10, 2024

codecov bot commented Oct 10, 2024 •

edited

Loading

SuZhou-Joe Oct 11, 2024

ruanyl Oct 11, 2024

wanglam Oct 11, 2024

ruanyl Oct 11, 2024

wanglam Oct 11, 2024

ruanyl Oct 11, 2024

Refactor workspace datasource association #8545

Refactor workspace datasource association #8545

Conversation

ruanyl commented Oct 10, 2024

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Oct 10, 2024 • edited Loading

Codecov Report

SuZhou-Joe Oct 11, 2024

Choose a reason for hiding this comment

ruanyl Oct 11, 2024

Choose a reason for hiding this comment

wanglam Oct 11, 2024

Choose a reason for hiding this comment

ruanyl Oct 11, 2024

Choose a reason for hiding this comment

wanglam Oct 11, 2024

Choose a reason for hiding this comment

ruanyl Oct 11, 2024

Choose a reason for hiding this comment

codecov bot commented Oct 10, 2024 •

edited

Loading