fix(BA-515): Let the vfolder REST API accept vfolder UUIDs as intended (

#3451)

Co-authored-by: octodog <[email protected]>
Co-authored-by: Sanghun Lee <[email protected]>
Co-authored-by: Sion Kang <[email protected]>

changes/3451.fix.md

@@ -0,0 +1 @@
+Fix a mis-implementation that has prevented using UUIDs to indicate an exact vfolder when invoking the vfolder REST API

src/ai/backend/manager/api/exceptions.py

@@ -12,7 +12,8 @@
 from __future__ import annotations
 
 import json
-from typing import Any, Dict, Mapping, Optional, Union, cast
+from collections.abc import Mapping, Sequence
+from typing import TYPE_CHECKING, Any, Optional, Union, cast
 
 from aiohttp import web
 
@@ -21,6 +22,9 @@
 
 from ..exceptions import AgentError
 
+if TYPE_CHECKING:
+    from ai.backend.manager.api.vfolder import VFolderRow
+
 
 class BackendError(web.HTTPError):
     """
@@ -247,7 +251,10 @@ class TooManySessionsMatched(BackendError, web.HTTPNotFound):
     error_title = "Too many sessions matched."
 
     def __init__(
-        self, extra_msg: Optional[str] = None, extra_data: Optional[Dict[str, Any]] = None, **kwargs
+        self,
+        extra_msg: Optional[str] = None,
+        extra_data: Optional[dict[str, Any]] = None,
+        **kwargs,
     ):
         if extra_data is not None and (matches := extra_data.get("matches", None)) is not None:
             serializable_matches = [
@@ -288,7 +295,21 @@ class VFolderCreationFailed(BackendError, web.HTTPBadRequest):
 
 class TooManyVFoldersFound(BackendError, web.HTTPNotFound):
     error_type = "https://api.backend.ai/probs/too-many-vfolders"
-    error_title = "There are two or more matching vfolders."
+    error_title = "Multiple vfolders found for the operation for a single vfolder."
+
+    def __init__(self, matched_rows: Sequence[VFolderRow]) -> None:
+        serialized_matches = [
+            {
+                "id": row["id"],
+                "host": row["host"],
+                "user": row["user_email"],
+                "user_id": row["user"],
+                "group": row["group_name"],
+                "group_id": row["group"],
+            }
+            for row in matched_rows
+        ]
+        super().__init__(extra_data={"matches": serialized_matches})
 
 
 class VFolderNotFound(ObjectNotFound):