fix: restore removed graphene fields and set them deprecated (#1677)

changes/1677.fix.md

@@ -0,0 +1 @@
+Restore removed graphene fields of resource policies and set them deprecated.

src/ai/backend/manager/models/resource_policy.py

@@ -28,6 +28,7 @@
 )
 from .keypair import keypairs
 from .user import UserRole
+from .utils import deprecation_reason_msg, description_msg
 
 if TYPE_CHECKING:
     from .gql import GraphQueryContext
@@ -57,6 +58,34 @@
 )
 
 
+def user_max_vfolder_count(required: bool = False):
+    return graphene.Int(
+        required=required,
+        description=description_msg("24.03.1", "Limitation of the number of user vfolders."),
+    )
+
+
+def user_max_quota_scope_size(required: bool = False):
+    return BigInt(
+        required=required,
+        description=description_msg("24.03.1", "Limitation of the quota size of user vfolders."),
+    )
+
+
+def project_max_vfolder_count(required: bool = False):
+    return graphene.Int(
+        required=required,
+        description=description_msg("24.03.1", "Limitation of the number of project vfolders."),
+    )
+
+
+def project_max_quota_scope_size(required: bool = False):
+    return BigInt(
+        required=required,
+        description=description_msg("24.03.1", "Limitation of the quota size of project vfolders."),
+    )
+
+
 keypair_resource_policies = sa.Table(
     "keypair_resource_policies",
     mapper_registry.metadata,
@@ -143,6 +172,10 @@ class KeyPairResourcePolicy(graphene.ObjectType):
     idle_timeout = BigInt()
     allowed_vfolder_hosts = graphene.JSONString()
 
+    max_vfolder_count = graphene.Int(deprecation_reason=deprecation_reason_msg("23.09.4"))
+    max_vfolder_size = BigInt(deprecation_reason=deprecation_reason_msg("23.09.4"))
+    max_quota_scope_size = BigInt(deprecation_reason=deprecation_reason_msg("23.09.4"))
+
     @classmethod
     def from_row(
         cls,
@@ -290,6 +323,9 @@ class CreateKeyPairResourcePolicyInput(graphene.InputObjectType):
     max_containers_per_session = graphene.Int(required=True)
     idle_timeout = BigInt(required=True)
     allowed_vfolder_hosts = graphene.JSONString(required=False)
+    max_vfolder_count = graphene.Int(deprecation_reason=deprecation_reason_msg("23.09.4"))
+    max_vfolder_size = BigInt(deprecation_reason=deprecation_reason_msg("23.09.4"))
+    max_quota_scope_size = BigInt(deprecation_reason=deprecation_reason_msg("23.09.4"))
 
 
 class ModifyKeyPairResourcePolicyInput(graphene.InputObjectType):
@@ -300,6 +336,9 @@ class ModifyKeyPairResourcePolicyInput(graphene.InputObjectType):
     max_containers_per_session = graphene.Int(required=False)
     idle_timeout = BigInt(required=False)
     allowed_vfolder_hosts = graphene.JSONString(required=False)
+    max_vfolder_count = graphene.Int(deprecation_reason=deprecation_reason_msg("23.09.4"))
+    max_vfolder_size = BigInt(deprecation_reason=deprecation_reason_msg("23.09.4"))
+    max_quota_scope_size = BigInt(deprecation_reason=deprecation_reason_msg("23.09.4"))
 
 
 class CreateKeyPairResourcePolicy(graphene.Mutation):
@@ -407,9 +446,9 @@ class UserResourcePolicy(graphene.ObjectType):
     id = graphene.ID(required=True)
     name = graphene.String(required=True)
     created_at = GQLDateTime(required=True)
-    max_vfolder_count = graphene.Int()
-    max_vfolder_size = BigInt(deprecation_reason="Deprecated since 23.09.1")
-    max_quota_scope_size = BigInt()
+    max_vfolder_count = user_max_vfolder_count()
+    max_quota_scope_size = user_max_quota_scope_size()
+    max_vfolder_size = BigInt(deprecation_reason=deprecation_reason_msg("23.09.1"))
 
     @classmethod
     def from_row(
@@ -424,7 +463,6 @@ def from_row(
             name=row.name,
             created_at=row.created_at,
             max_vfolder_count=row.max_vfolder_count,
-            max_vfolder_size=row.max_quota_scope_size,  # aliased field
             max_quota_scope_size=row.max_quota_scope_size,
         )
 
@@ -482,13 +520,13 @@ async def batch_load_by_user(
 
 
 class CreateUserResourcePolicyInput(graphene.InputObjectType):
-    max_vfolder_count = graphene.Int()
-    max_quota_scope_size = BigInt()
+    max_vfolder_count = user_max_vfolder_count()
+    max_quota_scope_size = user_max_quota_scope_size()
 
 
 class ModifyUserResourcePolicyInput(graphene.InputObjectType):
-    max_vfolder_count = graphene.Int()
-    max_quota_scope_size = BigInt()
+    max_vfolder_count = user_max_vfolder_count()
+    max_quota_scope_size = user_max_quota_scope_size()
 
 
 class CreateUserResourcePolicy(graphene.Mutation):
@@ -585,9 +623,9 @@ class ProjectResourcePolicy(graphene.ObjectType):
     id = graphene.ID(required=True)
     name = graphene.String(required=True)
     created_at = GQLDateTime(required=True)
-    max_vfolder_count = graphene.Int()
-    max_vfolder_size = BigInt(deprecation_reason="Deprecated since 23.09.1")
-    max_quota_scope_size = BigInt()
+    max_vfolder_count = project_max_vfolder_count()
+    max_quota_scope_size = project_max_quota_scope_size()
+    max_vfolder_size = BigInt(deprecation_reason=deprecation_reason_msg("23.09.1"))
 
     @classmethod
     def from_row(
@@ -660,13 +698,13 @@ async def batch_load_by_project(
 
 
 class CreateProjectResourcePolicyInput(graphene.InputObjectType):
-    max_vfolder_count = graphene.Int()
-    max_quota_scope_size = BigInt()
+    max_vfolder_count = project_max_vfolder_count()
+    max_quota_scope_size = project_max_quota_scope_size()
 
 
 class ModifyProjectResourcePolicyInput(graphene.InputObjectType):
-    max_vfolder_count = graphene.Int()
-    max_quota_scope_size = BigInt()
+    max_vfolder_count = project_max_vfolder_count()
+    max_quota_scope_size = project_max_quota_scope_size()
 
 
 class CreateProjectResourcePolicy(graphene.Mutation):

src/ai/backend/manager/models/utils.py

@@ -362,3 +362,17 @@ def agg_to_array(column: sa.Column) -> sa.sql.functions.Function:
 
 def is_db_retry_error(e: Exception) -> bool:
     return isinstance(e, DBAPIError) and getattr(e.orig, "pgcode", None) == "40001"
+
+
+def description_msg(version: str, detail: str | None = None) -> str:
+    val = f"Added since {version}."
+    if detail:
+        val = f"{val} {detail}"
+    return val
+
+
+def deprecation_reason_msg(version: str, detail: str | None = None) -> str:
+    val = f"Deprecated since {version}."
+    if detail:
+        val = f"{val} {detail}"
+    return val