refactor: re-define vfolder delete status

changes/1892.feature.md

@@ -0,0 +1 @@
+Re-define vfolder delete status by adding `delete-pending`, `delete-error` vfolder status and set `delete-pending` as trash-bin status and `delete-complete` as hard-delete status.

src/ai/backend/client/cli/vfolder.py

@@ -166,9 +166,9 @@ def create(name, host, group, host_path, usage_mode, permission, quota, cloneabl
 @vfolder.command()
 @click.argument("name", type=str)
 def delete(name):
-    """Delete the given virtual folder.
+    """Delete the given virtual folder. The virtual folder will be under `delete-pending` status, which means trash-bin.
     This operation can be retracted by
-    calling `recover()`.
+    calling `restore()`.
 
     \b
     NAME: Name of a virtual folder.
@@ -198,17 +198,50 @@ def purge(name):
             sys.exit(ExitCode.FAILURE)
 
 
+@vfolder.command()
+@click.argument("name", type=str)
+def delete_trash(name):
+    """Delete the given virtual folder's real data. The virtual folder should be under `delete-pending` status, which means trash-bin.
+    This operation is irreversible!
+
+    NAME: Name of a virtual folder.
+    """
+    with Session() as session:
+        try:
+            session.VFolder(name).delete_trash()
+            print_done("Delete completed.")
+        except Exception as e:
+            print_error(e)
+            sys.exit(ExitCode.FAILURE)
+
+
 @vfolder.command()
 @click.argument("name", type=str)
 def recover(name):
-    """Recover the given virtual folder from deleted status.
+    """Restore the given virtual folder from deleted status, Deprecated since 24.03.1; use `restore`
+
+    NAME: Name of a virtual folder.
+    """
+    with Session() as session:
+        try:
+            session.VFolder(name).restore()
+            print_done("Restored.")
+        except Exception as e:
+            print_error(e)
+            sys.exit(ExitCode.FAILURE)
+
+
+@vfolder.command()
+@click.argument("name", type=str)
+def restore(name):
+    """Restore the given virtual folder from deleted status, from trash bin.
 
     NAME: Name of a virtual folder.
     """
     with Session() as session:
         try:
-            session.VFolder(name).recover()
-            print_done("Recovered.")
+            session.VFolder(name).restore()
+            print_done("Restored.")
         except Exception as e:
             print_error(e)
             sys.exit(ExitCode.FAILURE)

src/ai/backend/client/func/vfolder.py

@@ -1,6 +1,7 @@
 import asyncio
+import uuid
 from pathlib import Path
-from typing import Dict, Mapping, Optional, Sequence, Union
+from typing import Any, Dict, Mapping, Optional, Sequence, Union
 
 import aiohttp
 import janus
@@ -47,8 +48,9 @@ class ResponseFailed(Exception):
 
 
 class VFolder(BaseFunction):
-    def __init__(self, name: str):
+    def __init__(self, name: str, id: Optional[uuid.UUID] = None):
         self.name = name
+        self.id = id
 
     @api_function
     @classmethod
@@ -204,6 +206,15 @@ async def paginated_project_list(
             page_size=page_size,
         )
 
+    async def _get_id_by_name(self) -> uuid.UUID:
+        rqst = Request("GET", "/folders/_/id")
+        rqst.set_json({
+            "name": self.name,
+        })
+        async with rqst.fetch() as resp:
+            data = await resp.json()
+            return uuid.UUID(data["id"])
+
     @api_function
     @classmethod
     async def list_hosts(cls):
@@ -238,17 +249,47 @@ async def delete(self):
             return {}
 
     @api_function
-    async def purge(self):
-        rqst = Request("POST", "/folders/{0}/purge".format(self.name))
+    async def purge(self) -> Mapping[str, Any]:
+        if self.id is None:
+            vfolder_id = await self._get_id_by_name()
+            self.id = vfolder_id
+        rqst = Request("POST", "/folders/purge")
+        rqst.set_json({
+            "id": self.id.hex,
+        })
         async with rqst.fetch():
             return {}
 
-    @api_function
-    async def recover(self):
-        rqst = Request("POST", "/folders/{0}/recover".format(self.name))
+    async def _restore(self) -> Mapping[str, Any]:
+        if self.id is None:
+            vfolder_id = await self._get_id_by_name()
+            self.id = vfolder_id
+        rqst = Request("POST", "/folders/restore-from-trash-bin")
+        rqst.set_json({
+            "id": self.id.hex,
+        })
         async with rqst.fetch():
             return {}
 
+    @api_function
+    async def recover(self):
+        return await self._restore()
+
+    @api_function
+    async def restore(self):
+        return await self._restore()
+
+    @api_function
+    async def delete_trash(self) -> Mapping[str, Any]:
+        if self.id is None:
+            vfolder_id = await self._get_id_by_name()
+            self.id = vfolder_id
+        rqst = Request("POST", "/folders/delete-from-trash-bin")
+        rqst.set_json({
+            "id": self.id.hex,
+        })
+        return {}
+
     @api_function
     async def rename(self, new_name):
         rqst = Request("POST", "/folders/{0}/rename".format(self.name))