[Workspace]Fix error toasts in sample data page #8842

wanglam · 2024-11-11T08:00:56Z

Description

This PR addresses the issue of error toasts appearing on the sample data page when installing or uninstalling sample data. The root cause was that the user did not have permission to update UI settings at the workspace level. The changes in this PR include:

Remove saved objects first when uninstalling sample data.
Disable the behavior of updating the default index pattern UI setting for non workspace admin when installing or uninstalling sample data inside a workspace.

Screenshot

No UI Changes

Testing the changes

Clone the branch and run yarn osd bootstrap --single-version loose.

Add the following configurations to config/opensearch_dashboards.yml:

savedObjects.permission.enabled: true
workspace.enabled: true
uiSettings:
  overrides:
    'home:useNewHomePage': true

Run yarn start --no-base-path.
Log in with the admin user and create a new workspace named "test1".
Visit the sample data page of the "test1" workspace.
Click the "Add data" and "Remove" buttons on the sample data cards to ensure you can install and uninstall sample data without any issues.
Create a new user with the "admin" backend_role in the "Internal users" page.
Assign the "Read and write" access level to the new user inside the "test1" workspace.
Open an incognito window and log in with the new user.
Visit the sample data page of the "test1" workspace and click the "Add data" button. Verify that no error toasts appear.
Switch back to the admin user tab, visit the same workspace, and set the "flights" sample data as the default index pattern in the index patterns page.
Switch to the new user tab and click the "Remove" button on the "flights" sample data card. Verify that an error toast appears, similar to the provided screenshot.

13. Click the "Remove" buttons on other sample data cards and ensure no error toasts appear. 14. Switch to the admin user tab and set the new user as an "Admin" of the "test1" workspace. 15. Switch to the new user tab and click the "Remove" button on the "flights" sample data card. Verify that no error toasts appear. 16. Test with the workspace disabled (for regression testing): - Remove the newly added configurations. - Visit the home page and click the "Add sample data" button. - Click the "Add data" buttons. Sample data should be installed without error toasts. - Click the "Remove" buttons. Sample data should be uninstalled without error toasts.

Changelog

fix: [Workspace]Fix error toasts in sample data page

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

codecov · 2024-11-11T08:32:03Z

Codecov Report

Attention: Patch coverage is 85.71429% with 2 lines in your changes missing coverage. Please review.

Project coverage is 60.85%. Comparing base (fe616e7) to head (5a1fc83).
Report is 5 commits behind head on main.

Files with missing lines	Patch %	Lines
...me/server/services/sample_data/routes/uninstall.ts	75.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8842      +/-   ##
==========================================
+ Coverage   60.84%   60.85%   +0.01%     
==========================================
  Files        3808     3808              
  Lines       91193    91199       +6     
  Branches    14408    14409       +1     
==========================================
+ Hits        55485    55503      +18     
+ Misses      32165    32153      -12     
  Partials     3543     3543

Flag	Coverage Δ
Linux_1	`29.03% <ø> (ø)`
Linux_2	`56.38% <ø> (ø)`
Linux_3	`37.90% <ø> (ø)`
Linux_4	`29.02% <85.71%> (+0.02%)`	⬆️
Windows_1	`29.04% <ø> (ø)`
Windows_2	`56.34% <ø> (ø)`
Windows_3	`37.90% <ø> (ø)`
Windows_4	`29.02% <85.71%> (+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-11-28T09:21:07Z

src/plugins/home/public/application/sample_data_client.js

@@ -41,11 +41,16 @@ export async function listSampleDataSets(dataSourceId) {
  return await getServices().http.get(sampleDataUrl, { query });
 }

+const isWorkspaceEnabled = () => {


I am thinking if it is workspaceEnabled or permissionControlEnabled.

SuZhou-Joe · 2024-11-28T09:27:51Z

src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts

@@ -144,6 +148,59 @@ export class WorkspaceUiSettingsClientWrapper {
      return wrapperOptions.client.update(type, id, attributes, options);
    };

+    const deleteUiSettingsWithWorkspace = async (


Suggested change

const deleteUiSettingsWithWorkspace = async (

const deleteWithDefaultIndexPatternCheck = async (

Hailong-am · 2024-11-29T07:54:18Z

src/plugins/home/public/application/sample_data_client.js

 export async function installSampleDataSet(id, sampleDataDefaultIndex, dataSourceId) {
  const query = buildQuery(dataSourceId);
  await getServices().http.post(`${sampleDataUrl}/${id}`, { query });

-  if (getServices().uiSettings.isDefault('defaultIndex')) {
+  if (!isWorkspaceEnabled() && getServices().uiSettings.isDefault('defaultIndex')) {


can we add a unit test to cover this condition check?

src/plugins/home/public/application/sample_data_client.js

src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts

src/plugins/home/server/services/sample_data/routes/uninstall.ts

src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts

Signed-off-by: Lin Wang <[email protected]>

* Set default index pattern when workspace disabled Signed-off-by: Lin Wang <[email protected]> * Move saved objects first to avoid partial deleted Signed-off-by: Lin Wang <[email protected]> * Skip ui setting update for non workspace admin Signed-off-by: Lin Wang <[email protected]> * Add UT for sample_data_client Signed-off-by: Lin Wang <[email protected]> * Changeset file for PR #8842 created/updated --------- Signed-off-by: Lin Wang <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit af429b6) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Set default index pattern when workspace disabled * Move saved objects first to avoid partial deleted * Skip ui setting update for non workspace admin * Add UT for sample_data_client * Changeset file for PR #8842 created/updated --------- (cherry picked from commit af429b6) Signed-off-by: Lin Wang <[email protected]> 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>

) * Set default index pattern when workspace disabled Signed-off-by: Lin Wang <[email protected]> * Move saved objects first to avoid partial deleted Signed-off-by: Lin Wang <[email protected]> * Skip ui setting update for non workspace admin Signed-off-by: Lin Wang <[email protected]> * Add UT for sample_data_client Signed-off-by: Lin Wang <[email protected]> * Changeset file for PR opensearch-project#8842 created/updated --------- Signed-off-by: Lin Wang <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Signed-off-by: Federico Silva <[email protected]>

github-actions bot added the distinguished-contributor label Nov 11, 2024

opensearch-changeset-bot bot added a commit to wanglam/OpenSearch-Dashboards that referenced this pull request Nov 11, 2024

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

f199290

wanglam marked this pull request as ready for review November 11, 2024 09:25

SuZhou-Joe previously approved these changes Nov 12, 2024

View reviewed changes

SuZhou-Joe added the backport 2.x label Nov 12, 2024

SuZhou-Joe added the workspace label Nov 12, 2024

wanglam marked this pull request as draft November 21, 2024 06:03

wanglam dismissed SuZhou-Joe’s stale review via 9119767 November 22, 2024 04:10

wanglam marked this pull request as ready for review November 22, 2024 06:28

wanglam requested a review from SuZhou-Joe November 22, 2024 10:05

SuZhou-Joe reviewed Nov 28, 2024

View reviewed changes

Hailong-am reviewed Nov 29, 2024

View reviewed changes

SuZhou-Joe previously approved these changes Dec 2, 2024

View reviewed changes

ruanyl reviewed Dec 2, 2024

View reviewed changes

src/plugins/home/server/services/sample_data/routes/uninstall.ts Outdated Show resolved Hide resolved

src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts Outdated Show resolved Hide resolved

wanglam dismissed SuZhou-Joe’s stale review via 02ddf54 December 4, 2024 03:43

wanglam marked this pull request as draft December 4, 2024 03:44

wanglam added 3 commits December 4, 2024 11:47

Set default index pattern when workspace disabled

126e404

Signed-off-by: Lin Wang <[email protected]>

Move saved objects first to avoid partial deleted

93f4f22

Signed-off-by: Lin Wang <[email protected]>

Skip ui setting update for non workspace admin

c1b9545

Signed-off-by: Lin Wang <[email protected]>

wanglam force-pushed the fix-default-index-setting-for-non-workspace-admin branch from 02ddf54 to c1b9545 Compare December 4, 2024 03:48

wanglam and others added 2 commits December 4, 2024 14:00

Add UT for sample_data_client

b9ffc93

Signed-off-by: Lin Wang <[email protected]>

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

5a1fc83

wanglam marked this pull request as ready for review December 4, 2024 08:07

wanglam requested review from ruanyl, SuZhou-Joe and Hailong-am December 4, 2024 08:07

ruanyl approved these changes Dec 5, 2024

View reviewed changes

Hailong-am approved these changes Dec 5, 2024

View reviewed changes

Hailong-am merged commit af429b6 into opensearch-project:main Dec 6, 2024
69 checks passed

opensearch-trigger-bot bot mentioned this pull request Dec 6, 2024

[Backport 2.x] [Workspace]Fix error toasts in sample data page #9015

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace]Fix error toasts in sample data page #8842

[Workspace]Fix error toasts in sample data page #8842

wanglam commented Nov 11, 2024 •

edited

Loading

codecov bot commented Nov 11, 2024 •

edited

Loading

SuZhou-Joe Nov 28, 2024

SuZhou-Joe Nov 28, 2024

Hailong-am Nov 29, 2024

	const deleteUiSettingsWithWorkspace = async (
	const deleteWithDefaultIndexPatternCheck = async (

[Workspace]Fix error toasts in sample data page #8842

[Workspace]Fix error toasts in sample data page #8842

Conversation

wanglam commented Nov 11, 2024 • edited Loading

Description

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Nov 11, 2024 • edited Loading

Codecov Report

SuZhou-Joe Nov 28, 2024

Choose a reason for hiding this comment

SuZhou-Joe Nov 28, 2024

Choose a reason for hiding this comment

Hailong-am Nov 29, 2024

Choose a reason for hiding this comment

wanglam commented Nov 11, 2024 •

edited

Loading

codecov bot commented Nov 11, 2024 •

edited

Loading