feat: update workspace settings page UI

src/core/public/index.ts

@@ -354,6 +354,8 @@ export { WorkspacesStart, WorkspacesSetup, WorkspacesService } from './workspace
 
 export {
   WorkspacePermissionMode,
+  OptionIdToWorkspacePermissionModesMap,
+  PermissionModeId,
   PUBLIC_WORKSPACE_ID,
   MANAGEMENT_WORKSPACE_ID,
   WORKSPACE_TYPE,

src/core/utils/constants.ts

@@ -14,6 +14,23 @@ export enum WorkspacePermissionMode {
   LibraryWrite = 'library_write',
 }
 
+export enum PermissionModeId {
+  Read = 'read',
+  ReadAndWrite = 'read+write',
+  Admin = 'admin',
+}
+
+export const OptionIdToWorkspacePermissionModesMap: {
+  [key: string]: WorkspacePermissionMode[];
+} = {
+  [PermissionModeId.Read]: [WorkspacePermissionMode.LibraryRead, WorkspacePermissionMode.Read],
+  [PermissionModeId.ReadAndWrite]: [
+    WorkspacePermissionMode.LibraryWrite,
+    WorkspacePermissionMode.Read,
+  ],
+  [PermissionModeId.Admin]: [WorkspacePermissionMode.LibraryWrite, WorkspacePermissionMode.Write],
+};
+
 export const PUBLIC_WORKSPACE_ID = 'public';
 
 export const MANAGEMENT_WORKSPACE_ID = 'management';

src/core/utils/index.ts

@@ -40,6 +40,8 @@ export { DEFAULT_APP_CATEGORIES } from './default_app_categories';
 export {
   WORKSPACE_PATH_PREFIX,
   WorkspacePermissionMode,
+  PermissionModeId,
+  OptionIdToWorkspacePermissionModesMap,
   PUBLIC_WORKSPACE_ID,
   MANAGEMENT_WORKSPACE_ID,
   WORKSPACE_TYPE,

src/plugins/workspace/public/components/workspace_creator/index.tsx

@@ -4,4 +4,3 @@
  */
 
 export { WorkspaceCreator } from './workspace_creator';
-export { WorkspacePermissionSetting } from './workspace_permission_setting_panel';

src/plugins/workspace/public/components/workspace_creator/types.ts

@@ -0,0 +1,69 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { App, WorkspacePermissionMode } from '../../../../../core/public';
+
+export interface WorkspaceFeature extends Pick<App, 'dependencies'> {
+  id: string;
+  name: string;
+}
+
+export interface WorkspaceFeatureGroup {
+  name: string;
+  features: WorkspaceFeature[];
+}
+export interface WorkspaceFormSubmitData {
+  name: string;
+  description?: string;
+  features?: string[];
+  color?: string;
+  icon?: string;
+  defaultVISTheme?: string;
+  permissions: WorkspacePermissionSetting[];
+}
+
+export interface WorkspaceFormData extends WorkspaceFormSubmitData {
+  id: string;
+  reserved?: boolean;
+}
+
+export type WorkspaceFormErrors = Omit<
+  { [key in keyof WorkspaceFormData]?: string },
+  'permissions'
+> & {
+  userPermissions?: string[];
+  groupPermissions?: string[];
+};
+
+export enum WorkspacePermissionItemType {
+  User = 'user',
+  Group = 'group',
+}
+
+export interface UserPermissionSetting {
+  type: WorkspacePermissionItemType.User;
+  userId: string;
+  modes: WorkspacePermissionMode[];
+}
+
+export interface GroupPermissionSetting {
+  type: WorkspacePermissionItemType.Group;
+  group: string;
+  modes: WorkspacePermissionMode[];
+}
+
+export type WorkspacePermissionSetting = UserPermissionSetting | GroupPermissionSetting;
+
+// when editing, attributes could be undefined in workspace form
+export type WorkspaceFormEditingData = Partial<
+  Omit<WorkspaceFormSubmitData, 'permissions'> & {
+    userPermissions: Array<Partial<UserPermissionSetting>>;
+    groupPermissions: Array<Partial<GroupPermissionSetting>>;
+  }
+>;
+
+export type UserOrGroupPermissionEditingData = Array<
+  Partial<{ id: string; modes: WorkspacePermissionMode[] }>
+>;

src/plugins/workspace/public/components/workspace_creator/utils.test.ts

@@ -0,0 +1,227 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {
+  isValidWorkspacePermissionSetting,
+  getErrorsCount,
+  getUserAndGroupPermissions,
+  getUnsavedChangesCount,
+  getPermissionModeId,
+  getPermissionErrors,
+} from './utils';
+import {
+  UserPermissionSetting,
+  WorkspaceFormErrors,
+  WorkspacePermissionItemType,
+  WorkspacePermissionSetting,
+} from './types';
+import { WorkspacePermissionMode, PermissionModeId } from '../../../../../core/public';
+
+describe('isValidWorkspacePermissionSetting', () => {
+  it('should return true with valid user permission setting', () => {
+    expect(
+      isValidWorkspacePermissionSetting({
+        type: WorkspacePermissionItemType.User,
+        userId: 'test user id',
+        modes: [WorkspacePermissionMode.Write, WorkspacePermissionMode.LibraryWrite],
+      })
+    ).toBe(true);
+  });
+
+  it('should return true with valid group permission setting', () => {
+    expect(
+      isValidWorkspacePermissionSetting({
+        type: WorkspacePermissionItemType.Group,
+        group: 'test group id',
+        modes: [WorkspacePermissionMode.Write, WorkspacePermissionMode.LibraryWrite],
+      })
+    ).toBe(true);
+  });
+
+  it('should return false with empty permission modes', () => {
+    expect(
+      isValidWorkspacePermissionSetting({
+        type: WorkspacePermissionItemType.User,
+        userId: 'test user id',
+        modes: [],
+      })
+    ).toBe(false);
+  });
+
+  it('should return false with incorrect permission type (expect user)', () => {
+    expect(
+      isValidWorkspacePermissionSetting({
+        type: WorkspacePermissionItemType.Group,
+        userId: 'test user id',
+        modes: [],
+      } as any)
+    ).toBe(false);
+  });
+
+  it('should return false with incorrect permission type 2 (expect group)', () => {
+    expect(
+      isValidWorkspacePermissionSetting({
+        type: WorkspacePermissionItemType.User,
+        group: 'test user id',
+        modes: [],
+      } as any)
+    ).toBe(false);
+  });
+});
+
+describe('getErrorsCount', () => {
+  it('should return error count in name, description and permissions', () => {
+    const workspaceFormErrors: WorkspaceFormErrors = {
+      name: 'test name error',
+      description: 'test description error',
+      userPermissions: ['test user permission error 1'],
+      groupPermissions: ['test group permission error 1', 'test group permission error 2'],
+    };
+    expect(getErrorsCount(workspaceFormErrors)).toBe(5);
+  });
+});
+
+describe('getUserAndGroupPermissions', () => {
+  it('should split user and group permissions from all permissions', () => {
+    const permissions = [
+      { modes: [] },
+      { userId: 'test user id 1' },
+      { group: 'test group id 1' },
+      { type: WorkspacePermissionItemType.User, userId: 'test user id 2', modes: [] },
+      { type: WorkspacePermissionItemType.Group, group: 'test group id 2', modes: [] },
+      { type: WorkspacePermissionItemType.Group, group: 'test group id 3', modes: [] },
+    ];
+    expect(getUserAndGroupPermissions(permissions)).toStrictEqual([
+      [{ id: 'test user id 2', modes: [] }],
+      [
+        { id: 'test group id 2', modes: [] },
+        { id: 'test group id 3', modes: [] },
+      ],
+    ]);
+  });
+});
+
+describe('getUnsavedChangesCount', () => {
+  it('should return number of unsaved changes in workspace metadata', () => {
+    const initialFormData = {
+      id: 'test workspace id',
+      name: 'test workspace name',
+      description: 'test workspace description',
+      permissions: [],
+    };
+    const currentFormData = {
+      name: 'changed workspace name',
+      description: 'changed workspace description',
+    };
+    expect(getUnsavedChangesCount(initialFormData, currentFormData)).toBe(2);
+  });
+
+  it('should return number of unsaved changes in workspace features', () => {
+    const initialFormData = {
+      id: 'test workspace id',
+      name: 'test workspace name',
+      permissions: [],
+      features: ['feature 1', 'feature 2', 'feature 3'],
+    };
+    const currentFormData = {
+      name: 'test workspace name',
+      features: ['feature 1', 'feature 2', 'feature 4'],
+    };
+    // 1 deleted feature and 1 added feature
+    expect(getUnsavedChangesCount(initialFormData, currentFormData)).toBe(2);
+  });
+
+  it('should return number of unsaved changes in workspace permissions', () => {
+    const initialFormData = {
+      id: 'test workspace id',
+      name: 'test workspace name',
+      permissions: [
+        {
+          userId: 'test user id 1',
+          type: WorkspacePermissionItemType.User,
+          modes: [WorkspacePermissionMode.LibraryRead, WorkspacePermissionMode.Read],
+        },
+        {
+          group: 'test group id',
+          type: WorkspacePermissionItemType.Group,
+          modes: [WorkspacePermissionMode.LibraryRead, WorkspacePermissionMode.Read],
+        },
+      ] as WorkspacePermissionSetting[],
+    };
+    const currentFormData = {
+      name: 'test workspace name',
+      userPermissions: [
+        {
+          userId: 'test user id 1',
+          type: WorkspacePermissionItemType.User,
+          modes: [WorkspacePermissionMode.LibraryWrite, WorkspacePermissionMode.Write],
+        },
+      ] as UserPermissionSetting[],
+      groupPermissions: [],
+    };
+    // 1 deleted permission and 1 edited permission
+    expect(getUnsavedChangesCount(initialFormData, currentFormData)).toBe(false);
+  });
+});
+
+describe('getPermissionModeId', () => {
+  it('should return Read with empty permission', () => {
+    expect(getPermissionModeId([])).toBe(PermissionModeId.Read);
+  });
+
+  it('should return Read with [LibraryRead, Read]', () => {
+    expect(
+      getPermissionModeId([WorkspacePermissionMode.LibraryRead, WorkspacePermissionMode.Read])
+    ).toBe(PermissionModeId.Read);
+  });
+
+  it('should return ReadAndWrite with [LibraryWrite, Read],', () => {
+    expect(
+      getPermissionModeId([WorkspacePermissionMode.LibraryWrite, WorkspacePermissionMode.Read])
+    ).toBe(PermissionModeId.ReadAndWrite);
+  });
+
+  it('should return ReadAndWrite with [LibraryWrite, Read]', () => {
+    expect(
+      getPermissionModeId([WorkspacePermissionMode.LibraryWrite, WorkspacePermissionMode.Write])
+    ).toBe(PermissionModeId.Admin);
+  });
+});
+
+describe('getPermissionErrors', () => {
+  it('should get permission errors for both users and groups', () => {
+    const permissions = [
+      {},
+      { type: WorkspacePermissionItemType.User },
+      {
+        type: WorkspacePermissionItemType.User,
+        modes: [WorkspacePermissionMode.LibraryRead, WorkspacePermissionMode.Read],
+      },
+      {
+        type: WorkspacePermissionItemType.Group,
+        modes: [WorkspacePermissionMode.LibraryRead, WorkspacePermissionMode.Read],
+      },
+      {
+        userId: 'test user id',
+        type: WorkspacePermissionItemType.User,
+        modes: [WorkspacePermissionMode.LibraryRead, WorkspacePermissionMode.Read],
+      },
+      {
+        group: 'test group id',
+        type: WorkspacePermissionItemType.Group,
+        modes: [WorkspacePermissionMode.LibraryRead, WorkspacePermissionMode.Read],
+      },
+    ];
+    const expectedPermissionErrors = [
+      'Invalid type',
+      'Invalid permission modes',
+      'Invalid userId',
+      'Invalid user group',
+    ];
+    expect(getPermissionErrors(permissions)).toEqual(
+      expect.arrayContaining(expectedPermissionErrors)
+    );
+  });
+});