[workspace]Fix/UI of assets table #8519

Qxisylolo · 2024-10-08T01:50:17Z

Description

This pr addresses the UI of assets table by:

Show a couple of workspace names + a badge "+ N more" showing a popover with the rest of the list of the workspaces（To adjust UI and unstable workspace name length, only one workspace name will he shown）
Add "database" icon for the assets of the type "Data source"
Add "Gear" icon to the config type assets
Is there are no workspaces, show mdash in the table cell

Screenshot

Changelog

fix: adds badge when there are more than one workspaces and updates the icon

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

codecov · 2024-10-09T07:44:15Z

Codecov Report

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

Project coverage is 60.92%. Comparing base (608911e) to head (8b9dc6e).
Report is 47 commits behind head on main.

Files with missing lines	Patch %	Lines
...c/components/workspace_column/workspace_column.tsx	92.85%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8519      +/-   ##
==========================================
+ Coverage   60.85%   60.92%   +0.06%     
==========================================
  Files        3802     3808       +6     
  Lines       91062    91190     +128     
  Branches    14376    14399      +23     
==========================================
+ Hits        55419    55554     +135     
+ Misses      32104    32083      -21     
- Partials     3539     3553      +14

Flag	Coverage Δ
Linux_1	`29.00% <92.85%> (-0.02%)`	⬇️
Linux_2	`56.38% <ø> (-0.01%)`	⬇️
Linux_3	`38.01% <ø> (+0.14%)`	⬆️
Linux_4	`29.01% <ø> (+0.01%)`	⬆️
Windows_1	`29.03% <92.85%> (+<0.01%)`	⬆️
Windows_2	`56.34% <ø> (-0.01%)`	⬇️
Windows_3	`38.01% <ø> (+0.14%)`	⬆️
Windows_4	`29.01% <ø> (+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.

SuZhou-Joe · 2024-11-12T04:06:16Z

...lugins/saved_objects_management/public/management_section/objects_table/components/table.tsx

@@ -283,13 +298,71 @@ export class Table extends PureComponent<TableProps, TableState> {
        'data-test-subj': 'updated-at',
        render: (updatedAt: string) => updatedAt && moment(updatedAt).format(dateFormat),
      } as EuiTableFieldDataColumnType<SavedObjectWithMetadata<any>>,
-      ...columnRegistry.getAll().map((column) => {


We are not supposed to delete the columnRegistry here, it is an extension point for other plugins to register their customized column.

Thanks for the comment, already updated

Signed-off-by: Qxisylolo <[email protected]>

SuZhou-Joe · 2024-11-19T05:11:47Z

...lugins/saved_objects_management/public/management_section/objects_table/components/table.tsx

@@ -224,7 +223,7 @@ export class Table extends PureComponent<TableProps, TableState> {
            <EuiToolTip position="top" content={getSavedObjectLabel(type)}>
              <EuiIcon
                aria-label={getSavedObjectLabel(type)}
-                type={object.meta.icon || 'apps'}
+                type={object.type === 'config' ? 'gear' : object.meta.icon || 'app'}


Why don't we just changed the meta.icon?

Thanks for all the comments, updated.

SuZhou-Joe · 2024-11-19T05:17:33Z

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

+                panelPaddingSize="s"
+                data-test-subj="workspace-column-popover"
+              >
+                {workspaceNames?.slice(1).map((ws) => (


The ws may be undefined, shall we filter those workspace out?

SuZhou-Joe · 2024-11-19T05:25:59Z

src/plugins/workspace/public/components/workspace_column/workspace_colum.test.tsx

+    expect(getByTestId('workspace-column-popover')).toBeInTheDocument();
+    expect(getByText('foo')).toBeInTheDocument();
+    expect(getByText('bar')).toBeInTheDocument();


Nit: we could use findByText or findByTestId for such kind of assertion, those commands have retry mechanism out of the box.

Signed-off-by: Qxisylolo <[email protected]>

SuZhou-Joe · 2024-11-28T09:58:04Z

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

+    setShowBadgePopover(false);
+  };
+
+  if (workspaceNames) {


Suggested change

if (workspaceNames) {

if (workspaceNames?.length) {

thanks for comment, updated

Signed-off-by: Qxisylolo <[email protected]>

Hailong-am · 2024-12-19T07:17:05Z

...ins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx

@@ -109,7 +109,6 @@ import { DataPublicPluginStart } from '../../../../../plugins/data/public';
 import { DuplicateObject } from '../types';
 import { formatWorkspaceIdParams } from '../../utils';
 import { NavigationPublicPluginStart } from '../../../../navigation/public';
-import { WorkspaceObject } from '../../../../workspaces/public';


why this import been removed?

Thanks for spotting the error already reverted.

Seems it should import from core now:

import { WorkspaceObject } from '../../../../../core/public';

This import is correct, sorry I haven't made a double check. already updated

No problem, I guess the export location was changed in another PR, thanks for fixing this.

Hailong-am · 2024-12-19T07:17:18Z

...aved_objects_management/public/management_section/objects_table/saved_objects_table.test.tsx

@@ -637,7 +637,6 @@ describe('SavedObjectsTable', () => {
        { force: true }
      );
      expect(component.state('selectedSavedObjects').length).toBe(0);
-      expect(notifications.toasts.addDanger).not.toHaveBeenCalled();


any reason to remove this assertion?

Thanks for spotting the error, I think it is an accidental delete. already reverted.

Signed-off-by: Qxisylolo <[email protected]>

* fix/UI_of_assets_table Signed-off-by: Qxisylolo <[email protected]> * fix/the_UI_of_assets_table, add tests Signed-off-by: Qxisylolo <[email protected]> * use workspaceNameIdLookup Signed-off-by: Qxisylolo <[email protected]> * delete comment Signed-off-by: Qxisylolo <[email protected]> * use workspace column Signed-off-by: Qxisylolo <[email protected]> * Changeset file for PR #8519 created/updated * use gear icon Signed-off-by: Qxisylolo <[email protected]> * use gear icon Signed-off-by: Qxisylolo <[email protected]> * new update Signed-off-by: Qxisylolo <[email protected]> * revert deleted line Signed-off-by: Qxisylolo <[email protected]> * correct import Signed-off-by: Qxisylolo <[email protected]> --------- Signed-off-by: Qxisylolo <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit 6e851ff) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

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

opensearch-changeset-bot bot added a commit to Qxisylolo/OpenSearch-Dashboards that referenced this pull request Oct 8, 2024

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

f4e1520

Qxisylolo marked this pull request as ready for review October 8, 2024 02:11

SuZhou-Joe added the workspace label Oct 9, 2024

ruanyl added the backport 2.x label Oct 29, 2024

Qxisylolo force-pushed the fix/UI_of_assets_table branch from 1c905bc to 746db1c Compare October 31, 2024 07:30

opensearch-changeset-bot bot added a commit to Qxisylolo/OpenSearch-Dashboards that referenced this pull request Oct 31, 2024

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

223dd7d

SuZhou-Joe reviewed Nov 12, 2024

View reviewed changes

Qxisylolo added 5 commits November 19, 2024 11:33

fix/UI_of_assets_table

4947b00

Signed-off-by: Qxisylolo <[email protected]>

fix/the_UI_of_assets_table, add tests

13be456

Signed-off-by: Qxisylolo <[email protected]>

use workspaceNameIdLookup

22e868d

Signed-off-by: Qxisylolo <[email protected]>

delete comment

d4ce21c

Signed-off-by: Qxisylolo <[email protected]>

use workspace column

ef28e15

Signed-off-by: Qxisylolo <[email protected]>

Qxisylolo force-pushed the fix/UI_of_assets_table branch from 223dd7d to ef28e15 Compare November 19, 2024 03:34

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

636a6d2

SuZhou-Joe reviewed Nov 19, 2024

View reviewed changes

Qxisylolo added 2 commits November 19, 2024 17:20

use gear icon

1f8c391

Signed-off-by: Qxisylolo <[email protected]>

use gear icon

06a6080

Signed-off-by: Qxisylolo <[email protected]>

SuZhou-Joe reviewed Nov 28, 2024

View reviewed changes

new update

63243bb

Signed-off-by: Qxisylolo <[email protected]>

ruanyl previously approved these changes Dec 18, 2024

View reviewed changes

Hailong-am reviewed Dec 19, 2024

View reviewed changes

Qxisylolo dismissed ruanyl’s stale review via bc3e2b1 December 24, 2024 06:10

revert deleted line

9c91505

Signed-off-by: Qxisylolo <[email protected]>

Qxisylolo force-pushed the fix/UI_of_assets_table branch from 937fc4e to 9c91505 Compare December 24, 2024 06:23

SuZhou-Joe previously approved these changes Dec 24, 2024

View reviewed changes

correct import

8b9dc6e

Signed-off-by: Qxisylolo <[email protected]>

Qxisylolo dismissed SuZhou-Joe’s stale review via 8b9dc6e December 24, 2024 08:14

ruanyl approved these changes Dec 24, 2024

View reviewed changes

Hailong-am approved these changes Dec 24, 2024

View reviewed changes

Hailong-am merged commit 6e851ff into opensearch-project:main Dec 24, 2024
69 checks passed

opensearch-trigger-bot bot mentioned this pull request Dec 24, 2024

[Backport 2.x] [workspace]Fix/UI of assets table #9121

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[workspace]Fix/UI of assets table #8519

[workspace]Fix/UI of assets table #8519

Qxisylolo commented Oct 8, 2024 •

edited

Loading

codecov bot commented Oct 9, 2024 •

edited

Loading

SuZhou-Joe Nov 12, 2024

Qxisylolo Nov 19, 2024

SuZhou-Joe Nov 19, 2024

Qxisylolo Nov 19, 2024

SuZhou-Joe Nov 19, 2024

SuZhou-Joe Nov 19, 2024

SuZhou-Joe Nov 28, 2024

Qxisylolo Dec 3, 2024

Hailong-am Dec 19, 2024

Qxisylolo Dec 24, 2024

ruanyl Dec 24, 2024

Qxisylolo Dec 24, 2024

ruanyl Dec 24, 2024

Hailong-am Dec 19, 2024

Qxisylolo Dec 24, 2024 •

edited

Loading

[workspace]Fix/UI of assets table #8519

[workspace]Fix/UI of assets table #8519

Conversation

Qxisylolo commented Oct 8, 2024 • edited Loading

Description

Screenshot

Changelog

Check List

codecov bot commented Oct 9, 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

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

Qxisylolo Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

Qxisylolo commented Oct 8, 2024 •

edited

Loading

codecov bot commented Oct 9, 2024 •

edited

Loading

Qxisylolo Dec 24, 2024 •

edited

Loading