[Workspace] Add Workspace filter to saved objects management page (#6458

) * Add workspace filter into saved objects page (#211) * Add workspace column/filter into saved objects page Signed-off-by: Hailong Cui <[email protected]> fix failed test case Signed-off-by: Hailong Cui <[email protected]> move workspace column to its own folder Signed-off-by: Hailong Cui <[email protected]> * default workspace Signed-off-by: Hailong Cui <[email protected]> fix test case Signed-off-by: Hailong Cui <[email protected]> add test case Signed-off-by: Hailong Cui <[email protected]> remove hide import Signed-off-by: Hailong Cui <[email protected]> * address review comments Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> * replace default workspace with public workspace (#322) Signed-off-by: Hailong Cui <[email protected]> * Add workspace filter Signed-off-by: Hailong Cui <[email protected]> * revert query params change Signed-off-by: Hailong Cui <[email protected]> * udpate test case name to more clear Signed-off-by: Hailong Cui <[email protected]> * support public workspace Signed-off-by: Hailong Cui <[email protected]> * Add changelog Signed-off-by: Hailong Cui <[email protected]> * update fetchExportByTypeAndSearch parameter Co-authored-by: SuZhou-Joe <[email protected]> Signed-off-by: Hailong Cui <[email protected]> * remove virtrual public workspace Signed-off-by: Hailong Cui <[email protected]> * update comments Signed-off-by: Hailong Cui <[email protected]> * fix public workspace query when permission is not enabled Signed-off-by: Hailong Cui <[email protected]> * home dashboards/listing page only show public workspace data Signed-off-by: Hailong Cui <[email protected]> * Add more test case Signed-off-by: Hailong Cui <[email protected]> --------- Signed-off-by: Hailong Cui <[email protected]> Signed-off-by: SuZhou-Joe <[email protected]> Co-authored-by: SuZhou-Joe <[email protected]> (cherry picked from commit 9408e49) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md
opensearch-project · Apr 22, 2024 · a79cda6 · a79cda6
1 parent b9a2da8
commit a79cda6
Show file tree

Hide file tree

Showing 18 changed files with 569 additions and 38 deletions.
diff --git a/src/core/public/index.ts b/src/core/public/index.ts
@@ -94,7 +94,13 @@ export type { Logos } from '../common';
 export { PackageInfo, EnvironmentMode } from '../server/types';
 /** @interal */
 export { CoreContext, CoreSystem } from './core_system';
-export { DEFAULT_APP_CATEGORIES, WORKSPACE_TYPE, cleanWorkspaceId } from '../utils';
+export {
+  DEFAULT_APP_CATEGORIES,
+  WORKSPACE_TYPE,
+  cleanWorkspaceId,
+  PUBLIC_WORKSPACE_ID,
+  PUBLIC_WORKSPACE_NAME,
+} from '../utils';
 export {
   AppCategory,
   UiSettingsParams,

diff --git a/src/core/server/index.ts b/src/core/server/index.ts
@@ -355,7 +355,12 @@ export {
 } from './metrics';
 
 export { AppCategory, WorkspaceAttribute } from '../types';
-export { DEFAULT_APP_CATEGORIES, WORKSPACE_TYPE } from '../utils';
+export {
+  DEFAULT_APP_CATEGORIES,
+  PUBLIC_WORKSPACE_ID,
+  PUBLIC_WORKSPACE_NAME,
+  WORKSPACE_TYPE,
+} from '../utils';
 
 export {
   SavedObject,

diff --git a/src/core/utils/constants.ts b/src/core/utils/constants.ts
@@ -3,6 +3,18 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { i18n } from '@osd/i18n';
+
 export const WORKSPACE_TYPE = 'workspace';
 
 export const WORKSPACE_PATH_PREFIX = '/w';
+
+/**
+ * public workspace has parity with global tenant,
+ * it includes saved objects with `public` as its workspace or without any workspce info
+ */
+export const PUBLIC_WORKSPACE_ID = 'public';
+
+export const PUBLIC_WORKSPACE_NAME = i18n.translate('workspaces.public.workspace.default.name', {
+  defaultMessage: 'Global workspace',
+});
diff --git a/src/core/utils/index.ts b/src/core/utils/index.ts
@@ -37,5 +37,10 @@ export {
   IContextProvider,
 } from './context';
 export { DEFAULT_APP_CATEGORIES } from './default_app_categories';
-export { WORKSPACE_PATH_PREFIX, WORKSPACE_TYPE } from './constants';
+export {
+  WORKSPACE_PATH_PREFIX,
+  WORKSPACE_TYPE,
+  PUBLIC_WORKSPACE_ID,
+  PUBLIC_WORKSPACE_NAME,
+} from './constants';
 export { getWorkspaceIdFromUrl, formatUrlWithWorkspaceId, cleanWorkspaceId } from './workspace';
diff --git a/src/plugins/saved_objects_management/public/lib/fetch_export_by_type_and_search.ts b/src/plugins/saved_objects_management/public/lib/fetch_export_by_type_and_search.ts
@@ -28,19 +28,24 @@
  * under the License.
  */
 
-import { HttpStart } from 'src/core/public';
+import { HttpStart, SavedObjectsBaseOptions } from 'src/core/public';
+import { formatWorkspaceIdParams } from '../utils';
 
 export async function fetchExportByTypeAndSearch(
   http: HttpStart,
   types: string[],
   search: string | undefined,
-  includeReferencesDeep: boolean = false
+  includeReferencesDeep: boolean = false,
+  workspaces: SavedObjectsBaseOptions['workspaces']
 ): Promise<Blob> {
   return http.post('/api/saved_objects/_export', {
-    body: JSON.stringify({
-      type: types,
-      search,
-      includeReferencesDeep,
-    }),
+    body: JSON.stringify(
+      formatWorkspaceIdParams({
+        workspaces,
+        type: types,
+        search,
+        includeReferencesDeep,
+      })
+    ),
   });
 }
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