feat: reserved workspace customization (opensearch-project#202)

* hide delete button on workspace setting page for reserved workspaces Signed-off-by: yuye-aws <yuyezhu@amazon.com> * make reserved workspace name readonly Signed-off-by: yuye-aws <yuyezhu@amazon.com> --------- Signed-off-by: yuye-aws <yuyezhu@amazon.com>
wanglam · Sep 25, 2023 · 03b2452 · 03b2452
1 parent 25b9e5c
commit 03b2452
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 6 deletions.
diff --git a/src/plugins/workspace/public/components/workspace_updater/workspace_updater.tsx b/src/plugins/workspace/public/components/workspace_updater/workspace_updater.tsx
@@ -47,6 +47,7 @@ export const WorkspaceUpdater = () => {
   } = useOpenSearchDashboards<{ workspaceClient: WorkspaceClient }>();
 
   const currentWorkspace = useObservable(workspaces ? workspaces.currentWorkspace$ : of(null));
+  const hideDeleteButton = !!currentWorkspace?.reserved; // hide delete button for reserved workspace
   const [deleteWorkspaceModalVisible, setDeleteWorkspaceModalVisible] = useState(false);
   const [currentWorkspaceFormData, setCurrentWorkspaceFormData] = useState<WorkspaceFormData>(
     getFormDataFromWorkspace(currentWorkspace)
@@ -157,11 +158,15 @@ export const WorkspaceUpdater = () => {
         <EuiPageHeader
           restrictWidth
           pageTitle="Update Workspace"
-          rightSideItems={[
-            <EuiButton color="danger" onClick={() => setDeleteWorkspaceModalVisible(true)}>
-              Delete
-            </EuiButton>,
-          ]}
+          rightSideItems={
+            hideDeleteButton
+              ? []
+              : [
+                  <EuiButton color="danger" onClick={() => setDeleteWorkspaceModalVisible(true)}>
+                    Delete
+                  </EuiButton>,
+                ]
+          }
         />
         <EuiPageContent
           verticalPosition="center"

diff --git a/src/plugins/workspace/server/routes/index.ts b/src/plugins/workspace/server/routes/index.ts
@@ -17,8 +17,8 @@ import { IWorkspaceDBImpl, WorkspaceRoutePermissionItem } from '../types';
 export const WORKSPACES_API_BASE_URL = '/api/workspaces';
 
 const workspacePermissionMode = schema.oneOf([
-  schema.literal(WorkspacePermissionMode.Write),
   schema.literal(WorkspacePermissionMode.Read),
+  schema.literal(WorkspacePermissionMode.Write),
   schema.literal(WorkspacePermissionMode.LibraryRead),
   schema.literal(WorkspacePermissionMode.LibraryWrite),
   schema.literal(WorkspacePermissionMode.Management),
@@ -43,6 +43,7 @@ const workspaceAttributesSchema = schema.object({
   features: schema.maybe(schema.arrayOf(schema.string())),
   color: schema.maybe(schema.string()),
   icon: schema.maybe(schema.string()),
+  reserved: schema.maybe(schema.boolean()),
   defaultVISTheme: schema.maybe(schema.string()),
   permissions: schema.oneOf([workspacePermission, schema.arrayOf(workspacePermission)]),
 });

diff --git a/src/plugins/workspace/server/workspace_client.ts b/src/plugins/workspace/server/workspace_client.ts
@@ -44,6 +44,10 @@ const DUPLICATE_WORKSPACE_NAME_ERROR = i18n.translate('workspace.duplicate.name.
   defaultMessage: 'workspace name has already been used, try with a different name',
 });
 
+const RESERVED_WORKSPACE_NAME_ERROR = i18n.translate('workspace.reserved.name.error', {
+  defaultMessage: 'reserved workspace name cannot be changed',
+});
+
 export class WorkspaceClientWithSavedObject implements IWorkspaceDBImpl {
   private setupDep: CoreSetup;
   private logger: Logger;
@@ -338,6 +342,9 @@ export class WorkspaceClientWithSavedObject implements IWorkspaceDBImpl {
       const client = this.getSavedObjectClientsFromRequestDetail(requestDetail);
       const workspaceInDB: SavedObject<WorkspaceAttribute> = await client.get(WORKSPACE_TYPE, id);
       if (workspaceInDB.attributes.name !== attributes.name) {
+        if (workspaceInDB.attributes.reserved) {
+          throw new Error(RESERVED_WORKSPACE_NAME_ERROR);
+        }
         const existingWorkspaceRes = await this.getScopedClientWithoutPermission(
           requestDetail
         )?.find({