[Workspace] Fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper #6669

SuZhou-Joe · 2024-04-29T06:05:59Z

Description

A new wrapper, workspace_ui_settings, has been introduced by workspace plugin. When a user attempts to access an invalid workspace, OSD will display plain JSON instead of a user-friendly web page. This PR primarily addresses the issue by adding a try catch wrapper to the client.get method.

Issues Resolved

Screenshot

Before fix

After fix

As well as an error log in OSD:

Testing the changes

Use the branch to bootstrap and enable workspace feature flag
Type an invalid url like http://localhost:5601/w/123/app/workspace_overview
An error page with error message saying: Saved object [workspace/123] not found should be found.

Changelog

fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper

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

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

codecov · 2024-04-29T06:19:43Z

Codecov Report

Attention: Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 67.79%. Comparing base (460428c) to head (39d74fb).
Report is 468 commits behind head on main.

Files with missing lines	Patch %	Lines
...ed_objects/workspace_ui_settings_client_wrapper.ts	85.71%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6669   +/-   ##
=======================================
  Coverage   67.79%   67.79%           
=======================================
  Files        3413     3413           
  Lines       66755    66760    +5     
  Branches    10861    10863    +2     
=======================================
+ Hits        45254    45258    +4     
  Misses      18857    18857           
- Partials     2644     2645    +1

Flag	Coverage Δ
Linux_1	`33.19% <87.50%> (+<0.01%)`	⬆️
Linux_2	`55.63% <ø> (ø)`
Linux_3	`45.24% <ø> (ø)`
Linux_4	`34.91% <ø> (ø)`
Windows_1	`33.21% <87.50%> (+<0.01%)`	⬆️
Windows_2	`55.59% <ø> (ø)`
Windows_3	`45.26% <ø> (ø)`
Windows_4	`34.91% <ø> (ø)`

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.

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

…gs_client_wrapper.ts Co-authored-by: Yulong Ruan <ruanyu1@gmail.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

wanglam · 2024-04-29T08:08:16Z

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

+        configObject.attributes = {
+          ...configObject.attributes,
+          ...(workspaceObject ? workspaceObject.attributes.uiSettings : {}),
+        };

        configObject.attributes = {


Seems the configObject.attributes has already been set above. Why we need to assign it again?

You are right, remove the useless assign.

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

…kspace_ui_settings wrapper (#6669) * fix: invalid workspace id Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * Changeset file for PR #6669 created/updated * Update src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts Co-authored-by: Yulong Ruan <ruanyu1@gmail.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update error message Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: type error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove useless code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: Yulong Ruan <ruanyu1@gmail.com> (cherry picked from commit 29a09b0) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…kspace_ui_settings wrapper (#6669) (#6672) * fix: invalid workspace id * Changeset file for PR #6669 created/updated * Update src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts * feat: update error message * fix: type error * feat: remove useless code --------- (cherry picked from commit 29a09b0) Signed-off-by: SuZhou-Joe <suzhou@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> Co-authored-by: Yulong Ruan <ruanyu1@gmail.com>

…kspace_ui_settings wrapper (opensearch-project#6669) * fix: invalid workspace id Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * Changeset file for PR opensearch-project#6669 created/updated * Update src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts Co-authored-by: Yulong Ruan <ruanyu1@gmail.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: update error message Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * fix: type error Signed-off-by: SuZhou-Joe <suzhou@amazon.com> * feat: remove useless code Signed-off-by: SuZhou-Joe <suzhou@amazon.com> --------- Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: Yulong Ruan <ruanyu1@gmail.com>

fix: invalid workspace id

74beb5c

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

SuZhou-Joe requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, curq, bandinib-amzn, ruanyl, BionIT and xinruiba as code owners April 29, 2024 06:06

github-actions bot added the seasoned-contributor label Apr 29, 2024

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

a2b4dc3

SuZhou-Joe added bug Something isn't working workspace v2.14.0 labels Apr 29, 2024

ruanyl reviewed Apr 29, 2024

View reviewed changes

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

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

SuZhou-Joe and others added 3 commits April 29, 2024 14:46

Update src/plugins/workspace/server/saved_objects/workspace_ui_settin…

e774260

…gs_client_wrapper.ts Co-authored-by: Yulong Ruan <ruanyu1@gmail.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

feat: update error message

51fa623

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

fix: type error

e15a2cf

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

wanglam reviewed Apr 29, 2024

View reviewed changes

feat: remove useless code

39d74fb

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

wanglam approved these changes Apr 29, 2024

View reviewed changes

ruanyl approved these changes Apr 29, 2024

View reviewed changes

Hailong-am approved these changes Apr 29, 2024

View reviewed changes

kavilla approved these changes Apr 29, 2024

View reviewed changes

kavilla added the backport 2.x label Apr 29, 2024

SuZhou-Joe merged commit 29a09b0 into opensearch-project:main Apr 29, 2024
69 checks passed

opensearch-trigger-bot bot mentioned this pull request Apr 29, 2024

[Backport 2.x] [Workspace] Fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper #6672

Merged

Hailong-am mentioned this pull request Apr 30, 2024

[Workspace] Add functional test for workspace overview page opensearch-project/opensearch-dashboards-functional-test#1246

Merged

1 task

AMoo-Miki added the in-next label Sep 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace] Fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper #6669

[Workspace] Fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper #6669

SuZhou-Joe commented Apr 29, 2024 •

edited

Loading

codecov bot commented Apr 29, 2024 •

edited

Loading

wanglam Apr 29, 2024

SuZhou-Joe Apr 29, 2024

[Workspace] Fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper #6669

[Workspace] Fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper #6669

Conversation

SuZhou-Joe commented Apr 29, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Before fix

After fix

Testing the changes

Changelog

Check List

codecov bot commented Apr 29, 2024 • edited Loading

Codecov Report

wanglam Apr 29, 2024

Choose a reason for hiding this comment

SuZhou-Joe Apr 29, 2024

Choose a reason for hiding this comment

SuZhou-Joe commented Apr 29, 2024 •

edited

Loading

codecov bot commented Apr 29, 2024 •

edited

Loading