add workspace filter into saved objects page (opensearch-project#76)

* add workspace filter into saved objects page Signed-off-by: Hailong Cui <[email protected]> * workspace filter Signed-off-by: Hailong Cui <[email protected]> * managment workspace filter Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> Saved objects page change (opensearch-project#123) * hide import for application home page Signed-off-by: Hailong Cui <[email protected]> * add workpspace into gotoApp link Signed-off-by: Hailong Cui <[email protected]> * remove special logic for management workspace Signed-off-by: Hailong Cui <[email protected]> * variable name change and more UTs Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> filters Signed-off-by: Hailong Cui <[email protected]> remove copy related Signed-off-by: Hailong Cui <[email protected]> revert index pattern chagne Signed-off-by: Hailong Cui <[email protected]>
Hailong-am · Oct 9, 2023 · 27b8e37 · 27b8e37
1 parent c05b434
commit 27b8e37
Show file tree

Hide file tree

Showing 19 changed files with 331 additions and 35 deletions.
diff --git a/src/core/public/utils/index.ts b/src/core/public/utils/index.ts
@@ -31,3 +31,4 @@
 export { shareWeakReplay } from './share_weak_replay';
 export { Sha256 } from './crypto';
 export { MountWrapper, mountReactNode } from './mount';
+export { WORKSPACE_PATH_PREFIX, WORKSPACE_TYPE } from '../../utils';
diff --git a/src/core/types/saved_objects.ts b/src/core/types/saved_objects.ts
@@ -115,6 +115,7 @@ export interface SavedObject<T = unknown> {
   originId?: string;
   /** Workspaces that this saved object exists in. */
   workspaces?: string[];
+  permissions?: Permissions;
 }
 
 export interface SavedObjectError {

diff --git a/src/core/utils/constants.ts b/src/core/utils/constants.ts
@@ -4,3 +4,5 @@
  */
 
 export const WORKSPACE_TYPE = 'workspace';
+
+export const WORKSPACE_PATH_PREFIX = '/w';
diff --git a/src/core/utils/index.ts b/src/core/utils/index.ts
@@ -37,4 +37,4 @@ export {
   IContextProvider,
 } from './context';
 export { DEFAULT_APP_CATEGORIES } from './default_app_categories';
-export { WORKSPACE_TYPE } from './constants';
+export { WORKSPACE_TYPE, WORKSPACE_PATH_PREFIX } from './constants';
diff --git a/src/plugins/saved_objects_management/public/lib/get_saved_object_counts.ts b/src/plugins/saved_objects_management/public/lib/get_saved_object_counts.ts
@@ -34,13 +34,14 @@ export interface SavedObjectCountOptions {
   typesToInclude: string[];
   namespacesToInclude?: string[];
   searchString?: string;
+  workspaces?: string[];
 }
 
 export async function getSavedObjectCounts(
   http: HttpStart,
   options: SavedObjectCountOptions
-): Promise<Record<string, number>> {
-  return await http.post<Record<string, number>>(
+): Promise<Record<string, Record<string, number>>> {
+  return await http.post<Record<string, Record<string, number>>>(
     `/api/opensearch-dashboards/management/saved_objects/scroll/counts`,
     { body: JSON.stringify(options) }
   );

diff --git a/src/plugins/saved_objects_management/public/lib/parse_query.test.ts b/src/plugins/saved_objects_management/public/lib/parse_query.test.ts
@@ -39,6 +39,8 @@ describe('getQueryText', () => {
           return [{ value: 'lala' }, { value: 'lolo' }];
         } else if (field === 'namespaces') {
           return [{ value: 'default' }];
+        } else if (field === 'workspaces') {
+          return [{ value: 'workspaces' }];
         }
         return [];
       },
@@ -47,6 +49,7 @@ describe('getQueryText', () => {
       queryText: 'foo bar',
       visibleTypes: 'lala',
       visibleNamespaces: 'default',
+      visibleWorkspaces: 'workspaces',
     });
   });
 });
diff --git a/src/plugins/saved_objects_management/public/lib/parse_query.ts b/src/plugins/saved_objects_management/public/lib/parse_query.ts
@@ -33,12 +33,15 @@ import { Query } from '@elastic/eui';
 interface ParsedQuery {
   queryText?: string;
   visibleTypes?: string[];
+  visibleNamespaces?: string[];
+  visibleWorkspaces?: string[];
 }
 
 export function parseQuery(query: Query): ParsedQuery {
   let queryText: string | undefined;
   let visibleTypes: string[] | undefined;
   let visibleNamespaces: string[] | undefined;
+  let visibleWorkspaces: string[] | undefined;
 
   if (query) {
     if (query.ast.getTermClauses().length) {
@@ -53,11 +56,15 @@ export function parseQuery(query: Query): ParsedQuery {
     if (query.ast.getFieldClauses('namespaces')) {
       visibleNamespaces = query.ast.getFieldClauses('namespaces')[0].value as string[];
     }
+    if (query.ast.getFieldClauses('workspaces')) {
+      visibleWorkspaces = query.ast.getFieldClauses('workspaces')[0].value as string[];
+    }
   }
 
   return {
     queryText,
     visibleTypes,
     visibleNamespaces,
+    visibleWorkspaces,
   };
 }
diff --git a/...t/public/management_section/objects_table/__snapshots__/saved_objects_table.test.tsx.snap b/...t/public/management_section/objects_table/__snapshots__/saved_objects_table.test.tsx.snap
diff --git a/...ved_objects_management/public/management_section/objects_table/components/header.test.tsx b/...ved_objects_management/public/management_section/objects_table/components/header.test.tsx
@@ -40,10 +40,28 @@ describe('Header', () => {
       onRefresh: () => {},
       totalCount: 4,
       filteredCount: 2,
+      hideImport: false,
     };
 
     const component = shallow(<Header {...props} />);
 
     expect(component).toMatchSnapshot();
   });
 });
+
+describe('Header - workspace enabled', () => {
+  it('should hide `Import` button for application home state', () => {
+    const props = {
+      onExportAll: () => {},
+      onImport: () => {},
+      onRefresh: () => {},
+      totalCount: 4,
+      filteredCount: 2,
+      hideImport: true,
+    };
+
+    const component = shallow(<Header {...props} />);
+
+    expect(component.find('EuiButtonEmpty[data-test-subj="importObjects"]').exists()).toBe(false);
+  });
+});
diff --git a/...ns/saved_objects_management/public/management_section/objects_table/components/header.tsx b/...ns/saved_objects_management/public/management_section/objects_table/components/header.tsx
@@ -45,11 +45,13 @@ export const Header = ({
   onImport,
   onRefresh,
   filteredCount,
+  hideImport = false,
 }: {
   onExportAll: () => void;
   onImport: () => void;
   onRefresh: () => void;
   filteredCount: number;
+  hideImport: boolean;
 }) => (
   <Fragment>
     <EuiFlexGroup justifyContent="spaceBetween" alignItems="baseline">
@@ -82,19 +84,21 @@ export const Header = ({
               />
             </EuiButtonEmpty>
           </EuiFlexItem>
-          <EuiFlexItem grow={false}>
-            <EuiButtonEmpty
-              size="s"
-              iconType="importAction"
-              data-test-subj="importObjects"
-              onClick={onImport}
-            >
-              <FormattedMessage
-                id="savedObjectsManagement.objectsTable.header.importButtonLabel"
-                defaultMessage="Import"
-              />
-            </EuiButtonEmpty>
-          </EuiFlexItem>
+          {!hideImport && (
+            <EuiFlexItem grow={false}>
+              <EuiButtonEmpty
+                size="s"
+                iconType="importAction"
+                data-test-subj="importObjects"
+                onClick={onImport}
+              >
+                <FormattedMessage
+                  id="savedObjectsManagement.objectsTable.header.importButtonLabel"
+                  defaultMessage="Import"
+                />
+              </EuiButtonEmpty>
+            </EuiFlexItem>
+          )}
           <EuiFlexItem grow={false}>
             <EuiButtonEmpty size="s" iconType="refresh" onClick={onRefresh}>
               <FormattedMessage

diff --git a/...aved_objects_management/public/management_section/objects_table/components/table.test.tsx b/...aved_objects_management/public/management_section/objects_table/components/table.test.tsx
@@ -37,6 +37,7 @@ import { actionServiceMock } from '../../../services/action_service.mock';
 import { columnServiceMock } from '../../../services/column_service.mock';
 import { SavedObjectsManagementAction } from '../../..';
 import { Table, TableProps } from './table';
+import { WorkspaceAttribute } from 'opensearch-dashboards/public';
 
 const defaultProps: TableProps = {
   basePath: httpServiceMock.createSetupContract().basePath,
@@ -115,6 +116,36 @@ describe('Table', () => {
     expect(component).toMatchSnapshot();
   });
 
+  it('should render gotoApp link correctly for workspace', () => {
+    const item = {
+      id: 'dashboard-1',
+      type: 'dashboard',
+      workspaces: ['ws-1'],
+      attributes: {},
+      references: [],
+      meta: {
+        title: `My-Dashboard-test`,
+        icon: 'indexPatternApp',
+        editUrl: '/management/opensearch-dashboards/objects/savedDashboards/dashboard-1',
+        inAppUrl: {
+          path: '/app/dashboards#/view/dashboard-1',
+          uiCapabilitiesPath: 'dashboard.show',
+        },
+      },
+    };
+    const props = {
+      ...defaultProps,
+      availableWorkspaces: [{ id: 'ws-1', name: 'My workspace' } as WorkspaceAttribute],
+      items: [item],
+    };
+    const component = shallowWithI18nProvider(<Table {...props} />);
+
+    const table = component.find('EuiBasicTable');
+    const columns = table.prop('columns') as any[];
+    const content = columns[1].render('My-Dashboard-test', item);
+    expect(content.props.href).toEqual('/w/ws-1/app/dashboards#/view/dashboard-1');
+  });
+
   it('should handle query parse error', () => {
     const onQueryChangeMock = jest.fn();
     const customizedProps = {

diff --git a/...ins/saved_objects_management/public/management_section/objects_table/components/table.tsx b/...ins/saved_objects_management/public/management_section/objects_table/components/table.tsx
@@ -28,7 +28,7 @@
  * under the License.
  */
 
-import { IBasePath } from 'src/core/public';
+import { IBasePath, WorkspaceAttribute } from 'src/core/public';
 import React, { PureComponent, Fragment } from 'react';
 import moment from 'moment';
 import {
@@ -56,6 +56,7 @@ import {
   SavedObjectsManagementAction,
   SavedObjectsManagementColumnServiceStart,
 } from '../../../services';
+import { WORKSPACE_PATH_PREFIX } from '../../../../../../core/public/utils';
 
 export interface TableProps {
   basePath: IBasePath;
@@ -83,6 +84,7 @@ export interface TableProps {
   onShowRelationships: (object: SavedObjectWithMetadata) => void;
   canGoInApp: (obj: SavedObjectWithMetadata) => boolean;
   dateFormat: string;
+  availableWorkspaces?: WorkspaceAttribute[];
 }
 
 interface TableState {
@@ -177,8 +179,11 @@ export class Table extends PureComponent<TableProps, TableState> {
       columnRegistry,
       namespaceRegistry,
       dateFormat,
+      availableWorkspaces,
     } = this.props;
 
+    const visibleWsIds = availableWorkspaces?.map((ws) => ws.id) || [];
+
     const pagination = {
       pageIndex,
       pageSize,
@@ -226,13 +231,20 @@ export class Table extends PureComponent<TableProps, TableState> {
         sortable: false,
         'data-test-subj': 'savedObjectsTableRowTitle',
         render: (title: string, object: SavedObjectWithMetadata) => {
-          const { path = '' } = object.meta.inAppUrl || {};
+          let { path = '' } = object.meta.inAppUrl || {};
           const canGoInApp = this.props.canGoInApp(object);
           if (!canGoInApp) {
             return <EuiText size="s">{title || getDefaultTitle(object)}</EuiText>;
           }
+          if (object.workspaces?.length) {
+            // first workspace login user have permission
+            const [workspaceId] = object.workspaces.filter((wsId) => visibleWsIds.includes(wsId));
+            path = workspaceId ? `${WORKSPACE_PATH_PREFIX}/${workspaceId}${path}` : path;
+          }
           return (
-            <EuiLink href={basePath.prepend(path)}>{title || getDefaultTitle(object)}</EuiLink>
+            <EuiLink href={basePath.prepend(path, { withoutWorkspace: true })}>
+              {title || getDefaultTitle(object)}
+            </EuiLink>
           );
         },
       } as EuiTableFieldDataColumnType<SavedObjectWithMetadata<any>>,

diff --git a/...d_objects_management/public/management_section/objects_table/saved_objects_table.test.tsx b/...d_objects_management/public/management_section/objects_table/saved_objects_table.test.tsx
@@ -48,6 +48,7 @@ import {
   notificationServiceMock,
   savedObjectsServiceMock,
   applicationServiceMock,
+  workspacesServiceMock,
 } from '../../../../../core/public/mocks';
 import { dataPluginMock } from '../../../../data/public/mocks';
 import { serviceRegistryMock } from '../../services/service_registry.mock';
@@ -102,6 +103,7 @@ describe('SavedObjectsTable', () => {
   let notifications: ReturnType<typeof notificationServiceMock.createStartContract>;
   let savedObjects: ReturnType<typeof savedObjectsServiceMock.createStartContract>;
   let search: ReturnType<typeof dataPluginMock.createStartContract>['search'];
+  let workspaces: ReturnType<typeof workspacesServiceMock.createStartContract>;
 
   const shallowRender = (overrides: Partial<SavedObjectsTableProps> = {}) => {
     return (shallowWithI18nProvider(
@@ -121,6 +123,7 @@ describe('SavedObjectsTable', () => {
     notifications = notificationServiceMock.createStartContract();
     savedObjects = savedObjectsServiceMock.createStartContract();
     search = dataPluginMock.createStartContract().search;
+    workspaces = workspacesServiceMock.createStartContract();
 
     const applications = applicationServiceMock.createStartContract();
     applications.capabilities = {
@@ -154,6 +157,7 @@ describe('SavedObjectsTable', () => {
       savedObjectsClient: savedObjects.client,
       indexPatterns: dataPluginMock.createStartContract().indexPatterns,
       http,
+      workspaces,
       overlays,
       notifications,
       applications,