[Workspace]Remove collaborators in workspace creation page and refactor with getDisplayedType #8520

wanglam · 2024-10-08T03:51:51Z

Description

This PR updates below for collaborators in workspace creation page and workspace setting page.

Remove collaborators tab in workspace creation page
Redirect to collaborators tab in workspace setting page after workspace created
Use getDisplayedType generate displayed types in collaborators table

Screenshot

Testing the changes

Clone branch code and run yarn osd bootstrap --single-version loose
Add below configs in config/opensearch_dashboards.yml

savedObjects.permission.enabled: true
workspace.enabled: true
uiSettings:
  overrides:
    'home:useNewHomePage': true
opensearchDashboards.dashboardAdmin.users: ['admin']

Run yarn start --no-base-path
Login with admin user and go to workspace create page by bottom left menu
The "Add collaborators" section should bd removed
Fill the workspace name and data sources, click "Create workspace" button
It should redirect to collaborators tab in workspace setting page
Add collaborators the types should be displayed as expected

Changelog

feat: [Workspace]Remove collaborators in workspace creation 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

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

codecov · 2024-10-08T04:19:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.96%. Comparing base (794757d) to head (8e852af).
Report is 81 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8520   +/-   ##
=======================================
  Coverage   60.95%   60.96%           
=======================================
  Files        3777     3777           
  Lines       89641    89639    -2     
  Branches    14046    14049    +3     
=======================================
+ Hits        54643    54646    +3     
+ Misses      31584    31583    -1     
+ Partials     3414     3410    -4

Flag	Coverage Δ
Linux_1	`29.09% <100.00%> (+<0.01%)`	⬆️
Linux_2	`56.27% <ø> (ø)`
Linux_3	`37.75% <ø> (+<0.01%)`	⬆️
Linux_4	`29.92% <ø> (ø)`
Windows_1	`29.10% <100.00%> (+<0.01%)`	⬆️
Windows_2	`56.23% <ø> (ø)`
Windows_3	`37.75% <ø> (ø)`
Windows_4	`29.92% <ø> (ø)`

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-09T04:39:40Z

src/plugins/workspace/public/components/workspace_creator/workspace_creator.tsx

@@ -177,7 +167,7 @@ export const WorkspaceCreator = (props: WorkspaceCreatorProps) => {
              savedObjects={savedObjects}
              onSubmit={handleWorkspaceFormSubmit}
              operationType={WorkspaceOperationType.Create}
-              permissionEnabled={isPermissionEnabled}
+              permissionEnabled={false}


Can we remove this props instead of giving false. I think this permissionEnabled props is not needed any more right?

You're right, let's remove the permissionEnabled property. I met a unit tests failed without this property before. But seems all the unit tests can be passed now. Let me remove this property.

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

Hailong-am · 2024-10-09T08:06:58Z

src/plugins/workspace/public/components/workspace_creator/workspace_creator.tsx

                newWorkspaceId,
-                http.basePath
+                DetailTab.Collaborators


do we need to check permission enabled?

Good point, I think we should check this. Let me add a fallback logic here.

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

wanglam · 2024-10-10T05:40:09Z

Hi @SuZhou-Joe @Hailong-am , I've refactor the type column in the collaborator table. Feel free to help me take a look. Thank you.

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

opensearch-trigger-bot · 2024-10-11T09:37:08Z

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-8520-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 fcc18fb2033f7216ca51854900946339d53bc772
# Push it to GitHub
git push --set-upstream origin backport/backport-8520-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-8520-to-2.x.

…or with getDisplayedType (#8520) * Remove workspace collaborators section in workspace creation Signed-off-by: Lin Wang <[email protected]> * Redirect to workspace detail collaborators tab after workspace created Signed-off-by: Lin Wang <[email protected]> * Changeset file for PR #8520 created/updated * Add getDisplayedType in default collaborator types Signed-off-by: Lin Wang <[email protected]> * Update detail type to ReactNode Signed-off-by: Lin Wang <[email protected]> * Add learn more link Signed-off-by: Lin Wang <[email protected]> * Remove permissionEnabled passed in WorkspaceCreatorForm Signed-off-by: Lin Wang <[email protected]> * Redirect to use case landing page if permission not enabled Signed-off-by: Lin Wang <[email protected]> * Use getDisplayedType and render — for empty Signed-off-by: Lin Wang <[email protected]> * Fix incorrect unit tests Signed-off-by: Lin Wang <[email protected]> * Assign current user as workspace admin 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 fcc18fb) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…or with getDisplayedType (#8520) (#8560) * Remove workspace collaborators section in workspace creation * Redirect to workspace detail collaborators tab after workspace created * Changeset file for PR #8520 created/updated * Add getDisplayedType in default collaborator types * Update detail type to ReactNode * Add learn more link * Remove permissionEnabled passed in WorkspaceCreatorForm * Redirect to use case landing page if permission not enabled * Use getDisplayedType and render — for empty * Fix incorrect unit tests * Assign current user as workspace admin --------- (cherry picked from commit fcc18fb) 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>

…or with getDisplayedType (opensearch-project#8520) * Remove workspace collaborators section in workspace creation Signed-off-by: Lin Wang <[email protected]> * Redirect to workspace detail collaborators tab after workspace created Signed-off-by: Lin Wang <[email protected]> * Changeset file for PR opensearch-project#8520 created/updated * Add getDisplayedType in default collaborator types Signed-off-by: Lin Wang <[email protected]> * Update detail type to ReactNode Signed-off-by: Lin Wang <[email protected]> * Add learn more link Signed-off-by: Lin Wang <[email protected]> * Remove permissionEnabled passed in WorkspaceCreatorForm Signed-off-by: Lin Wang <[email protected]> * Redirect to use case landing page if permission not enabled Signed-off-by: Lin Wang <[email protected]> * Use getDisplayedType and render — for empty Signed-off-by: Lin Wang <[email protected]> * Fix incorrect unit tests Signed-off-by: Lin Wang <[email protected]> * Assign current user as workspace admin 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>

wanglam added 2 commits October 8, 2024 11:30

Remove workspace collaborators section in workspace creation

60ea375

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

Redirect to workspace detail collaborators tab after workspace created

c9bb7f6

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

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

opensearch-changeset-bot bot and others added 2 commits October 8, 2024 03:52

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

2d601c7

Add getDisplayedType in default collaborator types

b8b979e

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

wanglam marked this pull request as ready for review October 8, 2024 05:54

SuZhou-Joe reviewed Oct 9, 2024

View reviewed changes

SuZhou-Joe previously approved these changes Oct 9, 2024

View reviewed changes

Remove permissionEnabled passed in WorkspaceCreatorForm

69c9794

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

wanglam dismissed SuZhou-Joe’s stale review via 69c9794 October 9, 2024 05:56

SuZhou-Joe previously approved these changes Oct 9, 2024

View reviewed changes

Hailong-am reviewed Oct 9, 2024

View reviewed changes

Redirect to use case landing page if permission not enabled

9f96825

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

wanglam dismissed SuZhou-Joe’s stale review via 9f96825 October 9, 2024 08:42

Use getDisplayedType and render — for empty

4750e3e

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

wanglam changed the title ~~[Workspace]Remove collaborators in workspace creation page~~ [Workspace]Remove collaborators in workspace creation page and refactor with getDisplayedType Oct 9, 2024

Fix incorrect unit tests

f858f71

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

wanglam added 2 commits October 11, 2024 14:57

Assign current user as workspace admin

8255e82

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

Merge branch 'main' into remove-collaborators-in-workspace-creation

471c2a6

SuZhou-Joe previously approved these changes Oct 11, 2024

View reviewed changes

Merge branch 'main' into remove-collaborators-in-workspace-creation

8e852af

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

wanglam dismissed SuZhou-Joe’s stale review via 8e852af October 11, 2024 08:35

SuZhou-Joe approved these changes Oct 11, 2024

View reviewed changes

Hailong-am approved these changes Oct 11, 2024

View reviewed changes

Hailong-am merged commit fcc18fb into opensearch-project:main Oct 11, 2024
67 of 68 checks passed

opensearch-trigger-bot bot added the failed backport label Oct 11, 2024

SuZhou-Joe added backport 2.x and removed failed backport backport 2.x labels Oct 11, 2024

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

[Backport 2.x] [Workspace]Remove collaborators in workspace creation page and refactor with getDisplayedType #8560

Merged

ananzh added the v2.18.0 label Oct 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace]Remove collaborators in workspace creation page and refactor with getDisplayedType #8520

[Workspace]Remove collaborators in workspace creation page and refactor with getDisplayedType #8520

wanglam commented Oct 8, 2024 •

edited

Loading

codecov bot commented Oct 8, 2024 •

edited

Loading

SuZhou-Joe Oct 9, 2024 •

edited

Loading

wanglam Oct 9, 2024

Hailong-am Oct 9, 2024

wanglam Oct 9, 2024

wanglam commented Oct 10, 2024

opensearch-trigger-bot bot commented Oct 11, 2024

[Workspace]Remove collaborators in workspace creation page and refactor with getDisplayedType #8520

[Workspace]Remove collaborators in workspace creation page and refactor with getDisplayedType #8520

Conversation

wanglam commented Oct 8, 2024 • edited Loading

Description

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Oct 8, 2024 • edited Loading

Codecov Report

SuZhou-Joe Oct 9, 2024 • edited Loading

Choose a reason for hiding this comment

wanglam Oct 9, 2024

Choose a reason for hiding this comment

Hailong-am Oct 9, 2024

Choose a reason for hiding this comment

wanglam Oct 9, 2024

Choose a reason for hiding this comment

wanglam commented Oct 10, 2024

opensearch-trigger-bot bot commented Oct 11, 2024

wanglam commented Oct 8, 2024 •

edited

Loading

codecov bot commented Oct 8, 2024 •

edited

Loading

SuZhou-Joe Oct 9, 2024 •

edited

Loading