[Workspace]Add "All use case" option to workspace form #7318

wanglam · 2024-07-19T07:22:34Z

Description

The use case of workspace can only be one specific use case or all use case. This PR mainly includes below changes:

Modify multi use case selection to single and add "all use case" option
Avoid application been set to Inaccessible when workspace using all use case and application in any use case
Avoid nav group been hidden when workspace using all use case

Issues Resolved

#7319

Screenshot

Testing the changes

Check out branch and Run yarn osd boostrap
Add below config to the opensearch_dashboards.yml

workspace.enabled: true
uiSettings.overrides["home:useNewHomePage"]: true

Run yarn start --no-base-path and login with admin user
Go to workspace create page
Fill workspace unique name and select All use case
Click create workspace and it will jump to workspace detail page like below image

(The "all use case" will be selected and the left navigation will changed to all style)

Changelog

feat: [Workspace]Add "All use case" option to workspace form

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: Lin Wang <[email protected]>

codecov · 2024-07-19T07:40:11Z

Codecov Report

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

Project coverage is 67.53%. Comparing base (3bb4170) to head (35da0e0).

Files	Patch %	Lines
...rkspace/public/components/workspace_list/index.tsx	80.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7318      +/-   ##
==========================================
- Coverage   67.53%   67.53%   -0.01%     
==========================================
  Files        3504     3504              
  Lines       69412    69408       -4     
  Branches    11324    11325       +1     
==========================================
- Hits        46879    46872       -7     
- Misses      19773    19776       +3     
  Partials     2760     2760

Flag	Coverage Δ
Linux_1	`33.15% <95.00%> (-0.01%)`	⬇️
Linux_2	`55.46% <ø> (ø)`
Linux_3	`43.05% <ø> (-0.01%)`	⬇️
Linux_4	`34.76% <ø> (ø)`
Windows_1	`33.17% <95.00%> (-0.01%)`	⬇️
Windows_2	`55.41% <ø> (ø)`
Windows_3	`43.06% <ø> (ø)`
Windows_4	`34.76% <ø> (-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.

Hailong-am · 2024-07-19T08:27:51Z

src/plugins/workspace/public/utils.ts

+    useCaseId === ALL_USE_CASE_ID
+      ? useCases.reduce<string[]>((previous, { features }) => previous.concat(features ?? []), [])
+      : useCases.find(({ id }) => id === useCaseId)?.features ?? [];
+  return availableFeatures.includes(featureId);


if an app have not register to any use case, will it be visible/accesable in all use case?

Based current implementation, the all use case will match all features inside registered use cases. If an app not register to any use case, it still can be accessible if it match below conditions:

workspaceAvailability is outsideWorkspace

navLinkStatus equal hidden

chromeless equal true

for example, security analytics plugin have not finished the nav change, based on above conditions, it will be inaccessible when workspace is all use case. will that be an issue?

ruanyl · 2024-07-19T08:49:21Z

src/plugins/workspace/public/plugin.ts

@@ -122,6 +124,7 @@ export class WorkspacePlugin implements Plugin<{}, {}, WorkspacePluginSetupDeps>
          if (
            navGroup.type !== NavGroupType.SYSTEM &&
            currentWorkspace.features &&
+            getFirstUseCaseOfFeatureConfigs(currentWorkspace.features) !== ALL_USE_CASE_ID &&


Would be nice to have a comment on this logic

SuZhou-Joe · 2024-07-19T08:53:50Z

src/plugins/workspace/public/components/workspace_form/workspace_use_case.tsx

 import { WorkspaceUseCase as WorkspaceUseCaseObject } from '../../types';
 import { WorkspaceFormErrors } from './types';
 import './workspace_use_case.scss';

+import './workspace_use_case.scss';


Duplicate I suppose?

SuZhou-Joe · 2024-07-19T08:55:58Z

src/plugins/workspace/public/utils.ts

+    useCaseId === ALL_USE_CASE_ID
+      ? useCases.reduce<string[]>((previous, { features }) => previous.concat(features ?? []), [])
+      : useCases.find(({ id }) => id === useCaseId)?.features ?? [];
+  return availableFeatures.includes(featureId);


SuZhou-Joe · 2024-07-19T09:01:24Z

src/plugins/workspace/public/utils.ts

-    return useCase.features.includes(featureId);
-  }
-  return false;
+  const availableFeatures =


I thought we will just bypass all the features in all use case. Why do we change that?

Do you mean we don't need to check whether the application id exists in registered use cases? We add skip the feature verification logic outside for all use case workspace.

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

opensearch-trigger-bot · 2024-07-19T11:27:50Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-7318-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 5741fd7c262f4ace7d63dbc18c9549f8d35a92f7
# Push it to GitHub
git push --set-upstream origin backport/backport-7318-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-7318-to-2.x.

* Add all use case option Signed-off-by: Lin Wang <[email protected]> * Changeset file for PR #7318 created/updated * Changeset file for PR #7318 created/updated * Changeset file for PR #7318 created/updated * Fix use case selection Signed-off-by: Lin Wang <[email protected]> * All use case can accessible any app and add comment Signed-off-by: Lin Wang <[email protected]> * Remove duplicate style import Signed-off-by: Lin Wang <[email protected]> --------- 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 5741fd7) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Add all use case option * Changeset file for PR #7318 created/updated * Changeset file for PR #7318 created/updated * Changeset file for PR #7318 created/updated * Fix use case selection * All use case can accessible any app and add comment * Remove duplicate style import --------- (cherry picked from commit 5741fd7) 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>

Add all use case option

74c047a

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

github-actions bot added the seasoned-contributor label Jul 19, 2024

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

40d4118

wanglam changed the title ~~[Workspace]Add all use case option~~ [Workspace]Add all use case option to workspace form Jul 19, 2024

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

d7e5116

wanglam changed the title ~~[Workspace]Add all use case option to workspace form~~ [Workspace]Add "All use case" option to workspace form Jul 19, 2024

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

581975e

wanglam marked this pull request as ready for review July 19, 2024 08:14

wanglam requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, curq, bandinib-amzn, SuZhou-Joe, ruanyl, BionIT, xinruiba, zhyuanqi, mengweieric, LDrago27 and virajsanghvi as code owners July 19, 2024 08:14

Hailong-am reviewed Jul 19, 2024

View reviewed changes

ruanyl reviewed Jul 19, 2024

View reviewed changes

ruanyl previously approved these changes Jul 19, 2024

View reviewed changes

SuZhou-Joe reviewed Jul 19, 2024

View reviewed changes

SuZhou-Joe previously approved these changes Jul 19, 2024

View reviewed changes

wanglam added 3 commits July 19, 2024 17:59

Fix use case selection

d60341d

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

All use case can accessible any app and add comment

8edcc99

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

Remove duplicate style import

ba5e167

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

wanglam dismissed stale reviews from SuZhou-Joe and ruanyl via ba5e167 July 19, 2024 09:59

Merge branch 'main' into workspace-config-all-usecase

35da0e0

SuZhou-Joe approved these changes Jul 19, 2024

View reviewed changes

Hailong-am approved these changes Jul 19, 2024

View reviewed changes

ruanyl approved these changes Jul 19, 2024

View reviewed changes

ruanyl merged commit 5741fd7 into opensearch-project:main Jul 19, 2024
67 checks passed

ruanyl added backport 2.x workspace v2.16.0 labels Jul 19, 2024

opensearch-trigger-bot bot added the failed backport label Jul 19, 2024

yubonluo mentioned this pull request Jul 20, 2024

[Workspace] Refactor the UI of workspace picker #7045

Merged

7 tasks

SuZhou-Joe added backport 2.x and removed backport 2.x labels Jul 21, 2024

opensearch-trigger-bot bot mentioned this pull request Jul 21, 2024

[Backport 2.x] [Workspace]Add "All use case" option to workspace form #7338

Merged

AMoo-Miki removed the failed backport label Aug 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace]Add "All use case" option to workspace form #7318

[Workspace]Add "All use case" option to workspace form #7318

wanglam commented Jul 19, 2024 •

edited

Loading

codecov bot commented Jul 19, 2024 •

edited

Loading

Hailong-am Jul 19, 2024

SuZhou-Joe Jul 19, 2024

wanglam Jul 19, 2024

Hailong-am Jul 19, 2024

ruanyl Jul 19, 2024

SuZhou-Joe Jul 19, 2024

SuZhou-Joe Jul 19, 2024

SuZhou-Joe Jul 19, 2024

wanglam Jul 19, 2024

opensearch-trigger-bot bot commented Jul 19, 2024

[Workspace]Add "All use case" option to workspace form #7318

[Workspace]Add "All use case" option to workspace form #7318

Conversation

wanglam commented Jul 19, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Jul 19, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Jul 19, 2024

wanglam commented Jul 19, 2024 •

edited

Loading

codecov bot commented Jul 19, 2024 •

edited

Loading