[Workspace]Add create workspace page #6179

wanglam · 2024-03-18T08:06:39Z

Description

This PR is for adding workspace create page. All code changes are under workspace plugin folder. Will register a new workspace create application. This application allow user create workspace from the user interface.

Issues Resolved

closes #6181

Screenshot

Testing the changes

Clone the latest code and run yarn osd bootstrap
Modify config/opensearch_dashboards.yml add workspace.enabled: true
Run yarn start --no-base-path
Visit workspace create page
Input name, description, color and features
Click Create workspace button
The workspace will be created, will redirect to http://localhost:5601/app/w/<workspace_id>/workspace_overview

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 <wonglam@amazon.com>

codecov · 2024-03-18T08:20:08Z

Codecov Report

Attention: Patch coverage is 92.57143% with 13 lines in your changes are missing coverage. Please review.

Project coverage is 67.42%. Comparing base (4f1884b) to head (41e7201).

Files	Patch %	Lines
...ic/components/workspace_form/use_workspace_form.ts	90.38%	3 Missing and 2 partials ⚠️
...components/workspace_creator/workspace_creator.tsx	88.88%	0 Missing and 2 partials ⚠️
...components/workspace_form/workspace_bottom_bar.tsx	77.77%	0 Missing and 2 partials ⚠️
...ents/workspace_form/workspace_feature_selector.tsx	93.93%	1 Missing and 1 partial ⚠️
src/plugins/workspace/public/plugin.ts	33.33%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6179      +/-   ##
==========================================
+ Coverage   67.35%   67.42%   +0.07%     
==========================================
  Files        3353     3362       +9     
  Lines       65083    65258     +175     
  Branches    10483    10524      +41     
==========================================
+ Hits        43837    44001     +164     
- Misses      18695    18700       +5     
- Partials     2551     2557       +6

Flag	Coverage Δ
Linux_1	`32.06% <92.57%> (+0.23%)`	⬆️
Linux_2	`55.57% <ø> (ø)`
Linux_3	`44.84% <ø> (+<0.01%)`	⬆️
Linux_4	`35.03% <ø> (ø)`
Windows_1	`32.08% <92.57%> (+0.23%)`	⬆️
Windows_2	`55.53% <ø> (ø)`
Windows_3	`44.84% <ø> (ø)`
Windows_4	`35.03% <ø> (ø)`

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.

Signed-off-by: Lin Wang <wonglam@amazon.com>

…eate-page Signed-off-by: Lin Wang <wonglam@amazon.com>

Flyingliuhub · 2024-03-20T17:32:25Z

src/plugins/workspace/common/constants.ts

+export const WORKSPACE_LIST_APP_ID = 'workspace_list';
+export const WORKSPACE_UPDATE_APP_ID = 'workspace_update';
+export const WORKSPACE_OVERVIEW_APP_ID = 'workspace_overview';
+// These features will be checked and disabled in checkbox on default.


Can you give more detail about comments here? I'm a little bit lost here based on the comment here. thanks

The user needs to select which features will be enabled when creating or updating workspace. The enabled features will be list on the left navigation. The workspace overview and workspace update should be selected by default which means every workspace should have these two pages.

Flyingliuhub · 2024-03-20T17:39:58Z

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

+      try {
+        result = await workspaceClient.create(data);
+      } catch (error) {
+        notifications?.toasts.addDanger({


Can we add tests for cover error handling, such as server errors or unexpected responses here. thanks

Flyingliuhub · 2024-03-20T20:12:34Z

src/plugins/workspace/public/components/workspace_form/use_workspace_form.ts

+        };
+      }
+      if (!isValidNameOrDescription(formData.name)) {
+        currentFormErrors = {


Do we have test cover for not valid name or description with errors? Thanks

Flyingliuhub · 2024-03-20T20:17:18Z

src/plugins/workspace/common/constants.ts

+export const WORKSPACE_UPDATE_APP_ID = 'workspace_update';
+export const WORKSPACE_OVERVIEW_APP_ID = 'workspace_overview';
+// These features will be checked and disabled in checkbox on default.
+export const DEFAULT_CHECKED_FEATURES_IDS = [WORKSPACE_UPDATE_APP_ID, WORKSPACE_OVERVIEW_APP_ID];


DEFAULT_CHECKED_FEATURES_IDS, I'm assuming that you want to mention here by selected, like DEFAULT_SELECTED_FEATURES_IDS, right? Thanks

I think we can rename to it.

Flyingliuhub · 2024-03-20T20:27:58Z

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

+      })}
+      onCancel={closeCancelModal}
+      onConfirm={() => application?.navigateToApp(WORKSPACE_LIST_APP_ID)}
+      cancelButtonText={i18n.translate('workspace.form.cancelButtonText.', {


Is workspace.form.cancelButtonText. or workspace.form.cancelButtonText?

Should remove ., thank you.

Signed-off-by: Lin Wang <wonglam@amazon.com>

…eate-page Signed-off-by: Lin Wang <wonglam@amazon.com>

Signed-off-by: Lin Wang <wonglam@amazon.com>

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

…eate-page Signed-off-by: Lin Wang <wonglam@amazon.com>

* Add workspace create page Signed-off-by: Lin Wang <wonglam@amazon.com> * Add change log for create workspace Signed-off-by: Lin Wang <wonglam@amazon.com> * Address PR comments Signed-off-by: Lin Wang <wonglam@amazon.com> * Update annotation for default selected features ids Signed-off-by: Lin Wang <wonglam@amazon.com> * Address PR comments Signed-off-by: Lin Wang <wonglam@amazon.com> * Add unit tests for unselected single feature Signed-off-by: Lin Wang <wonglam@amazon.com> --------- Signed-off-by: Lin Wang <wonglam@amazon.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit f5896b8) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

* Add workspace create page Signed-off-by: Lin Wang <wonglam@amazon.com> * Add change log for create workspace Signed-off-by: Lin Wang <wonglam@amazon.com> * Address PR comments Signed-off-by: Lin Wang <wonglam@amazon.com> * Update annotation for default selected features ids Signed-off-by: Lin Wang <wonglam@amazon.com> * Address PR comments Signed-off-by: Lin Wang <wonglam@amazon.com> * Add unit tests for unselected single feature Signed-off-by: Lin Wang <wonglam@amazon.com> --------- Signed-off-by: Lin Wang <wonglam@amazon.com> Signed-off-by: SuZhou-Joe <suzhou@amazon.com> Co-authored-by: SuZhou-Joe <suzhou@amazon.com> (cherry picked from commit f5896b8) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Add workspace create page

89bdd43

Signed-off-by: Lin Wang <wonglam@amazon.com>

github-actions bot added the first-time-contributor label Mar 18, 2024

wanglam changed the title ~~[WORKSPACE]Add workspace create page~~ [Workspace]Add workspace create page Mar 18, 2024

wanglam marked this pull request as ready for review March 18, 2024 09:01

wanglam requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, BSFishy, curq, bandinib-amzn, SuZhou-Joe, ruanyl and BionIT as code owners March 18, 2024 09:01

wanglam changed the title ~~[Workspace]Add workspace create page~~ [Workspace]Add create workspace page Mar 18, 2024

wanglam added 2 commits March 18, 2024 17:05

Add change log for create workspace

ef47225

Signed-off-by: Lin Wang <wonglam@amazon.com>

Merge remote-tracking branch 'origin/main' into feat-add-workspace-cr…

16faa06

…eate-page Signed-off-by: Lin Wang <wonglam@amazon.com>

Flyingliuhub reviewed Mar 20, 2024

View reviewed changes

wanglam and others added 4 commits March 22, 2024 14:49

Address PR comments

f8dd0b8

Signed-off-by: Lin Wang <wonglam@amazon.com>

Merge remote-tracking branch 'origin/main' into feat-add-workspace-cr…

7441b2c

…eate-page Signed-off-by: Lin Wang <wonglam@amazon.com>

Add unit tests for unselected single feature

fae3a34

Signed-off-by: Lin Wang <wonglam@amazon.com>

Merge branch 'main' into feat-add-workspace-create-page

e5f53f0

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

SuZhou-Joe previously approved these changes Mar 25, 2024

View reviewed changes

Flyingliuhub previously approved these changes Mar 25, 2024

View reviewed changes

Merge remote-tracking branch 'origin/main' into feat-add-workspace-cr…

41e7201

…eate-page Signed-off-by: Lin Wang <wonglam@amazon.com>

wanglam dismissed stale reviews from Flyingliuhub and SuZhou-Joe via 41e7201 March 26, 2024 00:44

ruanyl approved these changes Mar 26, 2024

View reviewed changes

Flyingliuhub approved these changes Mar 26, 2024

View reviewed changes

SuZhou-Joe merged commit f5896b8 into opensearch-project:main Mar 26, 2024
70 checks passed

This was referenced Mar 26, 2024

[Workspace] Add update workspace page #6269

Open

[Workspace] Add update workspace page #6270

Merged

SuZhou-Joe added backport 2.x v2.14.0 labels Apr 16, 2024

opensearch-trigger-bot bot added the failed backport label Apr 16, 2024

SuZhou-Joe removed backport 2.x failed backport labels Apr 16, 2024

opensearch-project deleted a comment from opensearch-trigger-bot bot Apr 16, 2024

SuZhou-Joe added backport 2.x and removed backport 2.x labels Apr 16, 2024

opensearch-trigger-bot bot added the failed backport label Apr 16, 2024

SuZhou-Joe added backport 2.x and removed failed backport labels Apr 17, 2024

opensearch-project deleted a comment from opensearch-trigger-bot bot Apr 17, 2024

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

[Backport 2.x] [Workspace]Add create workspace page #6511

Merged

gaobinlong mentioned this pull request Apr 18, 2024

[FEATURE] Functional tests for workspace create and update page opensearch-project/opensearch-dashboards-functional-test#1220

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace]Add create workspace page #6179

[Workspace]Add create workspace page #6179

wanglam commented Mar 18, 2024 •

edited by SuZhou-Joe

codecov bot commented Mar 18, 2024 •

edited

Flyingliuhub Mar 20, 2024

wanglam Mar 21, 2024

Flyingliuhub Mar 20, 2024

Flyingliuhub Mar 20, 2024

Flyingliuhub Mar 20, 2024

wanglam Mar 21, 2024

Flyingliuhub Mar 20, 2024

wanglam Mar 21, 2024

[Workspace]Add create workspace page #6179

[Workspace]Add create workspace page #6179

Conversation

wanglam commented Mar 18, 2024 • edited by SuZhou-Joe

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Mar 18, 2024 • edited

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

wanglam commented Mar 18, 2024 •

edited by SuZhou-Joe

codecov bot commented Mar 18, 2024 •

edited