default workspace

Signed-off-by: Hailong Cui <ihailong@amazon.com> fix test case Signed-off-by: Hailong Cui <ihailong@amazon.com> add test case Signed-off-by: Hailong Cui <ihailong@amazon.com> remove hide import Signed-off-by: Hailong Cui <ihailong@amazon.com>
ruanyl · Mar 8, 2024 · 023fa9b · 023fa9b
1 parent 568d414
commit 023fa9b
Show file tree

Hide file tree

Showing 12 changed files with 121 additions and 64 deletions.
diff --git a/src/core/public/index.ts b/src/core/public/index.ts
@@ -356,4 +356,4 @@ export { __osdBootstrap__ } from './osd_bootstrap';
 
 export { WorkspacesStart, WorkspacesSetup, WorkspacesService } from './workspace';
 
-export { WORKSPACE_TYPE, cleanWorkspaceId } from '../utils';
+export { WORKSPACE_TYPE, cleanWorkspaceId, DEFAULT_WORKSPACE_ID } from '../utils';
diff --git a/src/core/server/index.ts b/src/core/server/index.ts
@@ -354,7 +354,12 @@ export {
 } from './metrics';
 
 export { AppCategory, WorkspaceAttribute } from '../types';
-export { DEFAULT_APP_CATEGORIES, PUBLIC_WORKSPACE_ID, WORKSPACE_TYPE } from '../utils';
+export {
+  DEFAULT_APP_CATEGORIES,
+  PUBLIC_WORKSPACE_ID,
+  WORKSPACE_TYPE,
+  DEFAULT_WORKSPACE_ID,
+} from '../utils';
 
 export {
   SavedObject,

diff --git a/src/core/utils/constants.ts b/src/core/utils/constants.ts
@@ -8,3 +8,5 @@ export const WORKSPACE_TYPE = 'workspace';
 export const WORKSPACE_PATH_PREFIX = '/w';
 
 export const PUBLIC_WORKSPACE_ID = 'public';
+
+export const DEFAULT_WORKSPACE_ID = 'default';
diff --git a/src/core/utils/index.ts b/src/core/utils/index.ts
@@ -38,4 +38,9 @@ export {
 } from './context';
 export { DEFAULT_APP_CATEGORIES } from './default_app_categories';
 export { getWorkspaceIdFromUrl, formatUrlWithWorkspaceId, cleanWorkspaceId } from './workspace';
-export { WORKSPACE_PATH_PREFIX, PUBLIC_WORKSPACE_ID, WORKSPACE_TYPE } from './constants';
+export {
+  WORKSPACE_PATH_PREFIX,
+  PUBLIC_WORKSPACE_ID,
+  WORKSPACE_TYPE,
+  DEFAULT_WORKSPACE_ID,
+} from './constants';
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,29 +40,10 @@ describe('Header', () => {
       onRefresh: () => {},
       totalCount: 4,
       filteredCount: 2,
-      title: '',
     };
 
     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,
-      title: 'Saved Objectes',
-    };
-
-    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,15 +45,11 @@ export const Header = ({
   onImport,
   onRefresh,
   filteredCount,
-  hideImport,
-  title,
 }: {
   onExportAll: () => void;
   onImport: () => void;
   onRefresh: () => void;
   filteredCount: number;
-  hideImport?: boolean;
-  title: string;
 }) => (
   <Fragment>
     <EuiFlexGroup justifyContent="spaceBetween" alignItems="baseline">
@@ -86,21 +82,19 @@ export const Header = ({
               />
             </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="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/...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
@@ -63,6 +63,7 @@ import {
 import { Flyout, Relationships } from './components';
 import { SavedObjectWithMetadata } from '../../types';
 import { WorkspaceObject } from 'opensearch-dashboards/public';
+import { DEFAULT_WORKSPACE_ID } from '../../../../../core/public';
 import { TableProps } from './components/table';
 import { waitFor } from '@testing-library/dom';
 
@@ -647,7 +648,9 @@ describe('SavedObjectsTable', () => {
       );
       expect(component.state('selectedSavedObjects').length).toBe(0);
     });
+  });
 
+  describe('workspace filter', () => {
     it('show workspace filter when workspace turn on and not in any workspace', async () => {
       const applications = applicationServiceMock.createStartContract();
       applications.capabilities = {
@@ -690,9 +693,10 @@ describe('SavedObjectsTable', () => {
       expect(filters.length).toBe(2);
       expect(filters[0].field).toBe('type');
       expect(filters[1].field).toBe('workspaces');
-      expect(filters[1].options.length).toBe(2);
+      expect(filters[1].options.length).toBe(3);
       expect(filters[1].options[0].value).toBe('foo');
       expect(filters[1].options[1].value).toBe('bar');
+      expect(filters[1].options[2].value).toBe(DEFAULT_WORKSPACE_ID);
     });
 
     it('show workspace filter when workspace turn on and enter a workspace', async () => {
@@ -740,7 +744,8 @@ describe('SavedObjectsTable', () => {
       expect(wsFilter[0].options[0].value).toBe('foo');
     });
 
-    it('workspace exists in query options when workspace on', async () => {
+    it('workspace exists in find options when workspace on', async () => {
+      findObjectsMock.mockClear();
       const applications = applicationServiceMock.createStartContract();
       applications.capabilities = {
         navLinks: {},
@@ -777,17 +782,61 @@ describe('SavedObjectsTable', () => {
       // Ensure the state changes are reflected
       component.update();
 
-      waitFor(
-        () => {
-          expect(http.get).toHaveBeenCalledWith(
-            expect.stringMatching('/api/opensearch-dashboards/management/saved_objects/_find'),
-            expect.objectContaining({
-              workspaces: expect.arrayContaining(['workspace1']),
-            })
-          );
+      await waitFor(() => {
+        expect(findObjectsMock).toBeCalledWith(
+          http,
+          expect.objectContaining({
+            workspaces: expect.arrayContaining(['workspace1']),
+          })
+        );
+      });
+    });
+
+    it('workspace exists in find options when workspace on and not in any workspace', async () => {
+      findObjectsMock.mockClear();
+      const applications = applicationServiceMock.createStartContract();
+      applications.capabilities = {
+        navLinks: {},
+        management: {},
+        catalogue: {},
+        savedObjectsManagement: {
+          read: true,
+          edit: false,
+          delete: false,
         },
-        { timeout: 1000 }
-      );
+        workspaces: {
+          enabled: true,
+        },
+      };
+
+      const workspaceList: WorkspaceObject[] = [
+        {
+          id: 'workspace1',
+          name: 'foo',
+        },
+        {
+          id: 'workspace2',
+          name: 'bar',
+        },
+      ];
+      workspaces.workspaceList$.next(workspaceList);
+
+      const component = shallowRender({ applications, workspaces });
+
+      // Ensure all promises resolve
+      await new Promise((resolve) => process.nextTick(resolve));
+      // Ensure the state changes are reflected
+      component.update();
+
+      await waitFor(() => {
+        expect(findObjectsMock).toBeCalledWith(
+          http,
+          expect.objectContaining({
+            workspaces: expect.arrayContaining(['workspace1', 'default']),
+            workspacesSearchOperator: expect.stringMatching('OR'),
+          })
+        );
+      });
     });
   });
 });
diff --git a/.../saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx b/.../saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx
@@ -69,6 +69,7 @@ import {
   WorkspaceAttribute,
 } from 'src/core/public';
 import { Subscription } from 'rxjs';
+import { DEFAULT_WORKSPACE_ID } from '../../../../../core/public';
 import { RedirectAppLinks } from '../../../../opensearch_dashboards_react/public';
 import { IndexPatternsContract } from '../../../../data/public';
 import {
@@ -192,7 +193,7 @@ export class SavedObjectsTable extends Component<SavedObjectsTableProps, SavedOb
     } else {
       // application home
       if (!currentWorkspaceId) {
-        return availableWorkspaces?.map((ws) => ws.id);
+        return availableWorkspaces?.map((ws) => ws.id).concat(DEFAULT_WORKSPACE_ID);
       } else {
         return [currentWorkspaceId];
       }
@@ -201,10 +202,13 @@ export class SavedObjectsTable extends Component<SavedObjectsTableProps, SavedOb
 
   private get wsNameIdLookup() {
     const { availableWorkspaces } = this.state;
+    const workspaceNameIdMap = new Map<string, string>();
+    workspaceNameIdMap.set(DEFAULT_WORKSPACE_ID, DEFAULT_WORKSPACE_ID);
     // Assumption: workspace name is unique across the system
-    return availableWorkspaces?.reduce((map, ws) => {
+    availableWorkspaces?.reduce((map, ws) => {
       return map.set(ws.name, ws.id);
-    }, new Map<string, string>());
+    }, workspaceNameIdMap);
+    return workspaceNameIdMap;
   }
 
   private formatWorkspaceIdParams<T extends { workspaces?: string[] }>(
@@ -352,6 +356,13 @@ export class SavedObjectsTable extends Component<SavedObjectsTableProps, SavedOb
       findOptions.workspaces = workspaceIds;
     }
 
+    if (findOptions.workspaces) {
+      if (findOptions.workspaces.indexOf(DEFAULT_WORKSPACE_ID) !== -1) {
+        // search both saved objects with workspace and without workspace
+        findOptions.workspacesSearchOperator = 'OR';
+      }
+    }
+
     if (findOptions.type.length > 1) {
       findOptions.sortField = 'type';
     }
@@ -962,6 +973,14 @@ export class SavedObjectsTable extends Component<SavedObjectsTableProps, SavedOb
           };
         });
 
+      if (!currentWorkspaceId) {
+        wsFilterOptions.push({
+          name: DEFAULT_WORKSPACE_ID,
+          value: DEFAULT_WORKSPACE_ID,
+          view: `Default (${wsCounts[DEFAULT_WORKSPACE_ID] || 0})`,
+        });
+      }
+
       filters.push({
         type: 'field_value_selection',
         field: 'workspaces',
@@ -973,9 +992,6 @@ export class SavedObjectsTable extends Component<SavedObjectsTableProps, SavedOb
       });
     }
 
-    // workspace enable and no workspace is selected
-    const hideImport = workspaceEnabled && !currentWorkspaceId;
-
     return (
       <EuiPageContent horizontalPosition="center">
         {this.renderFlyout()}
@@ -987,8 +1003,6 @@ export class SavedObjectsTable extends Component<SavedObjectsTableProps, SavedOb
           onImport={this.showImportFlyout}
           onRefresh={this.refreshObjects}
           filteredCount={filteredItemCount}
-          hideImport={hideImport}
-          title={this.props.title}
         />
         <EuiSpacer size="xs" />
         <RedirectAppLinks application={applications}>

diff --git a/src/plugins/saved_objects_management/server/routes/find.ts b/src/plugins/saved_objects_management/server/routes/find.ts
@@ -67,6 +67,7 @@ export const registerFindRoute = (
           workspaces: schema.maybe(
             schema.oneOf([schema.string(), schema.arrayOf(schema.string())])
           ),
+          workspacesSearchOperator: schema.maybe(schema.string()),
         }),
       },
     },

diff --git a/src/plugins/saved_objects_management/server/routes/scroll_count.ts b/src/plugins/saved_objects_management/server/routes/scroll_count.ts
@@ -30,6 +30,7 @@
 
 import { schema } from '@osd/config-schema';
 import { IRouter, SavedObjectsFindOptions } from 'src/core/server';
+import { DEFAULT_WORKSPACE_ID } from '../../../../core/server';
 import { findAll } from '../lib';
 
 export const registerScrollForCountRoute = (router: IRouter) => {
@@ -69,6 +70,10 @@ export const registerScrollForCountRoute = (router: IRouter) => {
       if (requestHasWorkspaces) {
         counts.workspaces = {};
         findOptions.workspaces = req.body.workspaces;
+        if (findOptions.workspaces.indexOf(DEFAULT_WORKSPACE_ID) !== -1) {
+          // search both saved objects with workspace and without workspace
+          findOptions.workspacesSearchOperator = 'OR';
+        }
       }
 
       if (req.body.searchString) {
@@ -91,7 +96,7 @@ export const registerScrollForCountRoute = (router: IRouter) => {
           });
         }
         if (requestHasWorkspaces) {
-          const resultWorkspaces = result.workspaces || [];
+          const resultWorkspaces = result.workspaces || [DEFAULT_WORKSPACE_ID];
           resultWorkspaces.forEach((ws) => {
             counts.workspaces[ws] = counts.workspaces[ws] || 0;
             counts.workspaces[ws]++;

diff --git a/src/plugins/workspace/public/plugin.test.ts b/src/plugins/workspace/public/plugin.test.ts
@@ -133,7 +133,9 @@ describe('Workspace plugin', () => {
   it('#setup register workspace dropdown menu when setup', async () => {
     const setupMock = coreMock.createSetup();
     const workspacePlugin = new WorkspacePlugin();
-    await workspacePlugin.setup(setupMock);
+    await workspacePlugin.setup(setupMock, {
+      savedObjectsManagement: savedObjectsManagementPluginMock.createSetupContract(),
+    });
     expect(setupMock.chrome.registerCollapsibleNavHeader).toBeCalledTimes(1);
   });
 });