feat: VFolder trash bin

changes/835.feature.md

@@ -0,0 +1 @@
+Add vfolder purge API for permanent vfolder removal and change original vfolder delete API to update vfolder status only.

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

@@ -166,7 +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. This operation is irreversible!
+    """Delete the given virtual folder.
+    This operation can be retracted by
+    calling `recover()`.
 
     \b
     NAME: Name of a virtual folder.
@@ -180,6 +182,38 @@ def delete(name):
             sys.exit(ExitCode.FAILURE)
 
 
+@vfolder.command()
+@click.argument("name", type=str)
+def purge(name):
+    """Purge the given virtual folder. This operation is irreversible!
+
+    NAME: Name of a virtual folder.
+    """
+    with Session() as session:
+        try:
+            session.VFolder(name).purge()
+            print_done("Purged.")
+        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.
+
+    NAME: Name of a virtual folder.
+    """
+    with Session() as session:
+        try:
+            session.VFolder(name).recover()
+            print_done("Recovered.")
+        except Exception as e:
+            print_error(e)
+            sys.exit(ExitCode.FAILURE)
+
+
 @vfolder.command()
 @click.argument("old_name", type=str)
 @click.argument("new_name", type=str)
@@ -220,6 +254,7 @@ def info(name):
             print("- Number of files: {0}".format(result["numFiles"]))
             print("- Ownership Type: {0}".format(result["type"]))
             print("- Permission:", result["permission"])
+            print("- Status:", result["status"])
             print("- Usage Mode: {0}".format(result.get("usage_mode", "")))
             print("- Group ID: {0}".format(result["group"]))
             print("- User ID: {0}".format(result["user"]))

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

@@ -32,6 +32,7 @@
 _default_list_fields = (
     vfolder_fields["host"],
     vfolder_fields["name"],
+    vfolder_fields["status"],
     vfolder_fields["created_at"],
     vfolder_fields["creator"],
     vfolder_fields["group_id"],
@@ -238,6 +239,18 @@ async def delete(self):
         async with rqst.fetch():
             return {}
 
+    @api_function
+    async def purge(self):
+        rqst = Request("POST", "/folders/{0}/purge".format(self.name))
+        async with rqst.fetch():
+            return {}
+
+    @api_function
+    async def recover(self):
+        rqst = Request("POST", "/folders/{0}/recover".format(self.name))
+        async with rqst.fetch():
+            return {}
+
     @api_function
     async def rename(self, new_name):
         rqst = Request("POST", "/folders/{0}/rename".format(self.name))

src/ai/backend/client/output/fields.py

@@ -295,6 +295,7 @@
         FieldSpec("status"),
         FieldSpec("unmanaged_path"),
         FieldSpec("usage_mode"),
+        FieldSpec("status"),
         FieldSpec("permission"),
         FieldSpec("ownership_type"),
         FieldSpec("max_files"),