[Workspace] introducing workspace level ui settings #6510

ruanyl · 2024-04-17T10:10:04Z

When getting ui settings within a workspace, it will combine the workspace ui settings with the global ui settings and workspace ui settings have higher priority if the same setting was defined in both places

When updating ui settings within a workspace, it will update the workspace ui settings, the global ui settings will remain unchanged.

Description

Issues Resolved

#6509

Screenshot

Testing the changes

Changelog

feat: introducing workspace ui settings which allow users to customize ui settings for each individual workspace.

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

github-actions · 2024-04-17T10:10:37Z

ℹ️ Manual Changeset Creation Reminder

Please ensure manual commit for changeset file 6510.yml under folder changelogs/fragments to complete this PR.

If you want to use the available OpenSearch Changeset Bot App to avoid manual creation of changeset file you can install it in your forked repository following this link.

For more information about formatting of changeset files, please visit OpenSearch Auto Changeset and Release Notes Tool.

github-actions · 2024-04-17T10:18:25Z

❌ Changeset File Not Added Yet

Please ensure manual commit for changeset file 6510.yml under folder changelogs/fragments to complete this PR. File still missing.

When getting ui settings within a workspace, it will combine the workspace ui settings with the global ui settings and workspace ui settings have higher priority if the same setting was defined in both places When updating ui settings within a workspace, it will update the workspace ui settings, the global ui settings will remain unchanged. Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

yujin-emma · 2024-04-18T00:30:23Z

...ugins/workspace/server/saved_objects/integration_tests/workspace_ui_settings_wrapper.test.ts

could you please resolve the license header issue as it suggested

Thanks, updated ;)

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

BionIT

1 question, not a blocker

BionIT · 2024-04-18T05:19:31Z

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

+       * the global ui settings will remain unchanged.
+       */
+      if (type === 'config' && requestWorkspaceId) {
+        const configObject = await wrapperOptions.client.get<Record<string, any>>(


is wrapperOptions the default saved object client?

Not sure if I get the question, what are referring by default saved object client?

Yes, want to understand what does wrapperOptions mean. I assume it is saved object client

@BionIT yes, it's saved object client. Basically, it's a saved object client which will go through the wrappers after the current wrapper.

github-actions · 2024-04-19T11:25:42Z

❌ Invalid Prefix For Manual Changeset Creation

Invalid description prefix. Found "feat". Only "skip" entry option is permitted for manual commit of changeset files.

If you were trying to skip the changelog entry, please use the "skip" entry option in the ##Changelog section of your PR description.

github-actions · 2024-04-22T08:31:53Z

❌ Invalid Prefix For Manual Changeset Creation

Invalid description prefix. Found "Introducing workspace ui settings which allow users to customize ui settings for each individual workspace". Only "skip" entry option is permitted for manual commit of changeset files.

If you were trying to skip the changelog entry, please use the "skip" entry option in the ##Changelog section of your PR description.

github-actions · 2024-04-22T08:35:13Z

❌ Invalid Prefix For Manual Changeset Creation

Invalid description prefix. Found "feat". Only "skip" entry option is permitted for manual commit of changeset files.

If you were trying to skip the changelog entry, please use the "skip" entry option in the ##Changelog section of your PR description.

github-actions · 2024-04-22T08:40:52Z

❌ Invalid Prefix For Manual Changeset Creation

Invalid description prefix. Found "feat". Only "skip" entry option is permitted for manual commit of changeset files.

If you were trying to skip the changelog entry, please use the "skip" entry option in the ##Changelog section of your PR description.

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

codecov · 2024-04-22T09:16:19Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.69%. Comparing base (d2d410b) to head (3d3a940).
Report is 508 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #6510       +/-   ##
===========================================
+ Coverage   32.93%   62.69%   +29.76%     
===========================================
  Files        2260     2086      -174     
  Lines       45769    40905     -4864     
  Branches     7200     7490      +290     
===========================================
+ Hits        15075    25647    +10572     
+ Misses      29984    13595    -16389     
- Partials      710     1663      +953

Flag	Coverage Δ
Linux_1	`?`
Windows_2	`55.60% <ø> (?)`
Windows_3	`45.20% <ø> (?)`

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.

When getting ui settings within a workspace, it will combine the workspace ui settings with the global ui settings and workspace ui settings have higher priority if the same setting was defined in both places When updating ui settings within a workspace, it will update the workspace ui settings, the global ui settings will remain unchanged. --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com> (cherry picked from commit cc6a668) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ct#6510) When getting ui settings within a workspace, it will combine the workspace ui settings with the global ui settings and workspace ui settings have higher priority if the same setting was defined in both places When updating ui settings within a workspace, it will update the workspace ui settings, the global ui settings will remain unchanged. --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

When getting ui settings within a workspace, it will combine the workspace ui settings with the global ui settings and workspace ui settings have higher priority if the same setting was defined in both places When updating ui settings within a workspace, it will update the workspace ui settings, the global ui settings will remain unchanged. --------- (cherry picked from commit cc6a668) Signed-off-by: Yulong Ruan <ruanyl@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>

…ct#6510) When getting ui settings within a workspace, it will combine the workspace ui settings with the global ui settings and workspace ui settings have higher priority if the same setting was defined in both places When updating ui settings within a workspace, it will update the workspace ui settings, the global ui settings will remain unchanged. --------- Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

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

github-actions bot added the repeat-contributor label Apr 17, 2024

github-actions bot added the failed changeset label Apr 17, 2024

ruanyl force-pushed the feature/introducing-workspace-ui-settings branch from 76eda01 to 31b68f8 Compare April 17, 2024 10:19

yujin-emma reviewed Apr 18, 2024

View reviewed changes

ruanyl added 2 commits April 18, 2024 10:17

add license header

a609d21

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

Merge branch 'main' into feature/introducing-workspace-ui-settings

b028827

SuZhou-Joe added the workspace label Apr 18, 2024

BionIT previously approved these changes Apr 18, 2024

View reviewed changes

Merge branch 'main' into feature/introducing-workspace-ui-settings

937b2a2

Merge branch 'main' into feature/introducing-workspace-ui-settings

362983f

fix linter

3d3a940

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

ruanyl dismissed BionIT’s stale review via 3d3a940 April 22, 2024 08:45

BionIT approved these changes Apr 23, 2024

View reviewed changes

SuZhou-Joe approved these changes Apr 23, 2024

View reviewed changes

ruanyl merged commit cc6a668 into opensearch-project:main Apr 23, 2024
67 checks passed

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

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

[Backport 2.x] [Workspace] introducing workspace level ui settings #6616

Merged

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workspace] introducing workspace level ui settings #6510

[Workspace] introducing workspace level ui settings #6510

ruanyl commented Apr 17, 2024 •

edited

Loading

github-actions bot commented Apr 17, 2024

github-actions bot commented Apr 17, 2024

yujin-emma Apr 18, 2024

ruanyl Apr 18, 2024

BionIT left a comment

BionIT Apr 18, 2024

ruanyl Apr 18, 2024

BionIT Apr 22, 2024

ruanyl Apr 23, 2024

github-actions bot commented Apr 19, 2024

github-actions bot commented Apr 22, 2024

github-actions bot commented Apr 22, 2024

github-actions bot commented Apr 22, 2024

codecov bot commented Apr 22, 2024 •

edited

Loading

[Workspace] introducing workspace level ui settings #6510

[Workspace] introducing workspace level ui settings #6510

Conversation

ruanyl commented Apr 17, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

github-actions bot commented Apr 17, 2024

ℹ️ Manual Changeset Creation Reminder

github-actions bot commented Apr 17, 2024

❌ Changeset File Not Added Yet

yujin-emma Apr 18, 2024

Choose a reason for hiding this comment

ruanyl Apr 18, 2024

Choose a reason for hiding this comment

BionIT left a comment

Choose a reason for hiding this comment

BionIT Apr 18, 2024

Choose a reason for hiding this comment

ruanyl Apr 18, 2024

Choose a reason for hiding this comment

BionIT Apr 22, 2024

Choose a reason for hiding this comment

ruanyl Apr 23, 2024

Choose a reason for hiding this comment

github-actions bot commented Apr 19, 2024

❌ Invalid Prefix For Manual Changeset Creation

github-actions bot commented Apr 22, 2024

❌ Invalid Prefix For Manual Changeset Creation

github-actions bot commented Apr 22, 2024

❌ Invalid Prefix For Manual Changeset Creation

github-actions bot commented Apr 22, 2024

❌ Invalid Prefix For Manual Changeset Creation

codecov bot commented Apr 22, 2024 • edited Loading

Codecov Report

ruanyl commented Apr 17, 2024 •

edited

Loading

codecov bot commented Apr 22, 2024 •

edited

Loading