-
Notifications
You must be signed in to change notification settings - Fork 181
Expand file tree
/
Copy pathrepository.py
More file actions
2385 lines (2189 loc) · 96 KB
/
Copy pathrepository.py
File metadata and controls
2385 lines (2189 loc) · 96 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import uuid
from collections.abc import Mapping, Sequence
from dataclasses import dataclass
from datetime import UTC, datetime
from typing import Any, cast
import sqlalchemy as sa
from sqlalchemy import exc as sa_exc
from sqlalchemy.dialects.postgresql import insert as pg_insert
from sqlalchemy.ext.asyncio import AsyncSession as SASession
from sqlalchemy.orm import contains_eager, selectinload
from ai.backend.common.bgtask.bgtask import BackgroundTaskManager
from ai.backend.common.contexts.user import current_user
from ai.backend.common.exception import BackendAIError
from ai.backend.common.identifier.vfolder import VFolderUUID
from ai.backend.common.metrics.metric import DomainType, LayerType
from ai.backend.common.resilience.policies.metrics import MetricArgs, MetricPolicy
from ai.backend.common.resilience.policies.retry import BackoffStrategy, RetryArgs, RetryPolicy
from ai.backend.common.resilience.resilience import Resilience
from ai.backend.common.types import (
QuotaScopeID,
VFolderHostPermission,
VFolderHostPermissionMap,
VFolderID,
)
from ai.backend.manager.data.agent.types import AgentStatus
from ai.backend.manager.data.group.types import ProjectResourceInfo
from ai.backend.manager.data.kernel.types import KernelStatus
from ai.backend.manager.data.permission.id import ObjectId, ScopeId
from ai.backend.manager.data.permission.types import (
EntityType,
OperationType,
RBACElementRef,
RBACElementType,
RelationType,
RoleSource,
ScopeType,
)
from ai.backend.manager.data.vfolder.dto import UserIdentity
from ai.backend.manager.data.vfolder.types import (
UserWithVFolderHostPermissions,
ValidatedVFolderInfo,
VFolderAccessInfo,
VFolderCreateParams,
VFolderData,
VFolderInvitationData,
VFolderListResult,
VFolderMountPermission,
VFolderPermissionData,
VFolderSearchResult,
)
from ai.backend.manager.errors.api import InvalidAPIParameters
from ai.backend.manager.errors.auth import AuthorizationFailed
from ai.backend.manager.errors.common import ObjectNotFound
from ai.backend.manager.errors.repository import (
ForeignKeyViolationError,
RepositoryIntegrityError,
)
from ai.backend.manager.errors.resource import ProjectNotFound
from ai.backend.manager.errors.storage import (
InsufficientStoragePermission,
VFolderDeletionNotAllowed,
VFolderFilterStatusFailed,
VFolderHasLinkedModelCard,
VFolderInvalidParameter,
VFolderNotFound,
VFolderOperationFailed,
)
from ai.backend.manager.errors.user import UserNotFound
from ai.backend.manager.models.agent import agents
from ai.backend.manager.models.group import GroupRow
from ai.backend.manager.models.kernel import kernels
from ai.backend.manager.models.keypair import KeyPairRow, keypairs
from ai.backend.manager.models.model_card.row import ModelCardRow
from ai.backend.manager.models.rbac_models.association_scopes_entities import (
AssociationScopesEntitiesRow,
)
from ai.backend.manager.models.rbac_models.permission.permission import PermissionRow
from ai.backend.manager.models.rbac_models.role import RoleRow
from ai.backend.manager.models.rbac_models.user_role import UserRoleRow
from ai.backend.manager.models.resource_policy import keypair_resource_policies
from ai.backend.manager.models.storage import StorageSessionManager
from ai.backend.manager.models.user import (
ACTIVE_USER_STATUSES,
UserRole,
UserRow,
UserStatus,
users,
)
from ai.backend.manager.models.utils import ExtendedAsyncSAEngine, execute_with_retry
from ai.backend.manager.models.vfolder import (
HARD_DELETED_VFOLDER_STATUSES,
VFolderCloneInfo,
VFolderDeletionInfo,
VFolderInvitationRow,
VFolderInvitationState,
VFolderOperationStatus,
VFolderOwnershipType,
VFolderPermission,
VFolderPermissionRow,
VFolderPermissionSetAlias,
VFolderRow,
VFolderStatusSet,
delete_vfolder_relation_rows,
ensure_host_permission_allowed,
ensure_quota_scope_accessible_by_user,
get_allowed_vfolder_hosts_by_group,
get_allowed_vfolder_hosts_by_user,
get_sessions_by_mounted_folder,
is_unmanaged,
query_accessible_vfolders,
vfolder_invitations,
vfolder_permissions,
vfolder_status_map,
vfolders,
)
from ai.backend.manager.models.vfolder.conditions import VFolderConditions
from ai.backend.manager.repositories.base import (
BatchQuerier,
IntegrityErrorCheck,
execute_batch_querier,
)
from ai.backend.manager.repositories.base.integrity import match_integrity_error
from ai.backend.manager.repositories.base.rbac.entity_creator import (
RBACEntityCreator,
execute_rbac_entity_creator,
)
from ai.backend.manager.repositories.base.rbac.entity_purger import (
RBACEntityPurger,
execute_rbac_entity_purger,
)
from ai.backend.manager.repositories.base.rbac.granter import (
RBACGranter,
execute_rbac_granter,
)
from ai.backend.manager.repositories.base.rbac.revoker import (
RBACRevoker,
execute_rbac_revoker,
)
from ai.backend.manager.repositories.base.updater import Updater, execute_updater
from ai.backend.manager.repositories.permission_controller.role_manager import (
RoleManager,
UserSystemRoleSpec,
)
from ai.backend.manager.repositories.vfolder.creators import VFolderCreatorSpec
from ai.backend.manager.repositories.vfolder.types import (
BulkVFolderPurgeResult,
ProjectVFolderSearchScope,
UserVFolderSearchScope,
VFolderPurgeFailure,
)
vfolder_repository_resilience = Resilience(
policies=[
MetricPolicy(MetricArgs(domain=DomainType.REPOSITORY, layer=LayerType.VFOLDER_REPOSITORY)),
RetryPolicy(
RetryArgs(
max_retries=10,
retry_delay=0.1,
backoff_strategy=BackoffStrategy.FIXED,
non_retryable_exceptions=(BackendAIError,),
)
),
]
)
@dataclass
class _VFolderWithLinkedModelCards:
"""A vfolder row paired with model card rows referencing it."""
vfolder_row: VFolderRow
model_card_rows: list[ModelCardRow]
class VfolderRepository:
_db: ExtendedAsyncSAEngine
_role_manager: RoleManager
def __init__(self, db: ExtendedAsyncSAEngine) -> None:
self._db = db
self._role_manager = RoleManager()
@vfolder_repository_resilience.apply()
async def get_by_id_validated(
self, vfolder_id: uuid.UUID, user_id: uuid.UUID, domain_name: str | None
) -> VFolderData:
"""
Get a VFolder by ID with ownership/permission validation.
Returns VFolderData if user has access.
Raises VFolderNotFound if vfolder doesn't exist or user has no access.
"""
async with self._db.begin_readonly_session() as session:
vfolder_row = await self._get_vfolder_by_id(session, vfolder_id)
if not vfolder_row:
raise VFolderNotFound()
if vfolder_row.user == user_id:
return self._vfolder_row_to_data(vfolder_row)
# Check access permissions
user_row = await session.scalar(sa.select(UserRow).where(UserRow.uuid == user_id))
if not user_row:
raise ObjectNotFound(object_name="User")
# Check if user has access to this vfolder
allowed_vfolder_types = ["user", "group"] # TODO: get from config
conn = await session.connection()
vfolder_dicts = await query_accessible_vfolders(
conn,
user_id,
allow_privileged_access=True,
user_role=user_row.role,
domain_name=domain_name,
allowed_vfolder_types=allowed_vfolder_types,
extra_vf_conds=(VFolderRow.id == vfolder_id),
)
if not vfolder_dicts:
raise VFolderNotFound()
return self._vfolder_row_to_data(vfolder_row)
@vfolder_repository_resilience.apply()
async def get_by_id(self, vfolder_id: uuid.UUID) -> VFolderData:
"""
Get a VFolder by ID without validation.
Returns VFolderData if found, None otherwise.
"""
async with self._db.begin_readonly_session_read_committed() as session:
vfolder_row = await self._get_vfolder_by_id(session, vfolder_id)
if not vfolder_row:
raise VFolderNotFound()
return self._vfolder_row_to_data(vfolder_row)
@vfolder_repository_resilience.apply()
async def get_row_by_id(self, vfolder_id: VFolderUUID) -> Mapping[str, Any]:
"""
Fetch a vfolder row as a plain mapping by UUID, without permission filtering.
For use only by the REST middleware; do not call from new code.
"""
async with self._db.begin_readonly_session_read_committed() as session:
vfolder_row = await self._get_vfolder_by_id(session, vfolder_id)
if not vfolder_row:
raise VFolderNotFound(extra_data=str(vfolder_id))
return {
"name": vfolder_row.name,
"id": vfolder_row.id,
"host": vfolder_row.host,
"quota_scope_id": vfolder_row.quota_scope_id,
"domain_name": vfolder_row.domain_name,
"usage_mode": vfolder_row.usage_mode,
"created_at": vfolder_row.created_at,
"last_used": vfolder_row.last_used,
"max_size": vfolder_row.max_size,
"max_files": vfolder_row.max_files,
"ownership_type": vfolder_row.ownership_type,
"user": str(vfolder_row.user) if vfolder_row.user else None,
"group": str(vfolder_row.group) if vfolder_row.group else None,
"creator": vfolder_row.creator,
"creator_id": vfolder_row.creator_id,
"user_email": None,
"group_name": None,
"is_owner": False,
"permission": vfolder_row.permission,
"unmanaged_path": vfolder_row.unmanaged_path,
"cloneable": vfolder_row.cloneable,
"status": vfolder_row.status,
"cur_size": vfolder_row.cur_size,
}
@vfolder_repository_resilience.apply()
async def batch_load_by_ids(self, ids: Sequence[uuid.UUID]) -> list[VFolderData | None]:
"""
Batch fetch vfolders by IDs without permission validation.
Returns a list with the same length and order as the input ids;
entries that are not found are ``None``. Intended for GraphQL
DataLoader use where the caller has already authorized access to a
parent entity that references these vfolder IDs.
"""
if not ids:
return []
async with self._db.begin_readonly_session() as session:
query = sa.select(VFolderRow).where(VFolderConditions.by_ids(ids)())
result = await session.execute(query)
rows_by_id = {row.id: self._vfolder_row_to_data(row) for row in result.scalars().all()}
return [rows_by_id.get(VFolderUUID(vfolder_id)) for vfolder_id in ids]
@vfolder_repository_resilience.apply()
async def get_allowed_vfolder_hosts(
self, user_uuid: uuid.UUID, group_uuid: uuid.UUID | None
) -> VFolderHostPermissionMap:
"""
Get the allowed VFolder hosts for a user.
"""
async with self._db.begin_readonly_session_read_committed() as db_session:
if group_uuid:
group_row: GroupRow | None = await db_session.scalar(
sa.select(GroupRow).where(GroupRow.id == group_uuid)
)
if group_row is None:
raise ProjectNotFound(f"Project with {group_uuid} not found.")
return group_row.allowed_vfolder_hosts
user_row: UserRow | None = await db_session.scalar(
sa.select(UserRow)
.where(UserRow.uuid == user_uuid)
.options(
selectinload(UserRow.main_keypair).selectinload(KeyPairRow.resource_policy_row)
)
)
if user_row is None:
raise UserNotFound(f"User with UUID {user_uuid} not found.")
if user_row.main_keypair is None:
raise ObjectNotFound(object_name="User keypair")
if user_row.main_keypair.resource_policy_row is None:
raise ObjectNotFound(object_name="User keypair resource policy")
return user_row.main_keypair.resource_policy_row.allowed_vfolder_hosts
@vfolder_repository_resilience.apply()
async def get_user_with_keypair_policy_vfolder_hosts(
self, user_uuid: uuid.UUID
) -> UserWithVFolderHostPermissions:
"""
Load user data together with the merged ``allowed_vfolder_hosts`` from
all of the user's active keypair resource policies.
A user can hold multiple keypairs, each pointing to its own keypair
resource policy. This method unions ``allowed_vfolder_hosts`` across
every active keypair so that the host-permission check reflects the
full set of hosts available to the user (rather than only the main
keypair).
Implementation note: a single LEFT OUTER JOIN is used (instead of an
ORM ``selectinload`` on ``UserRow.keypairs``) so that only the columns
needed for the host-permission check are loaded. This avoids loading
sensitive keypair columns such as ``secret_key`` and
``ssh_private_key``.
"""
async with self._db.begin_readonly_session_read_committed() as db_session:
stmt = (
sa.select(
UserRow.email,
UserRow.role,
UserRow.domain_name,
keypair_resource_policies.c.allowed_vfolder_hosts,
)
.select_from(UserRow)
.outerjoin(
KeyPairRow,
sa.and_(
KeyPairRow.user == UserRow.uuid,
KeyPairRow.is_active.is_(True),
),
)
.outerjoin(
keypair_resource_policies,
keypair_resource_policies.c.name == KeyPairRow.resource_policy,
)
.where(UserRow.uuid == user_uuid)
)
rows = (await db_session.execute(stmt)).all()
if not rows:
raise UserNotFound(f"User with UUID {user_uuid} not found.")
email, role, domain_name, _ = rows[0]
if role is None or domain_name is None:
raise UserNotFound(f"User with UUID {user_uuid} has invalid role or domain data.")
merged_hosts = VFolderHostPermissionMap()
for row in rows:
policy_hosts = row.allowed_vfolder_hosts
if policy_hosts is None:
continue
merged_hosts = VFolderHostPermissionMap(merged_hosts | policy_hosts)
return UserWithVFolderHostPermissions(
email=email,
role=role,
allowed_vfolder_hosts=merged_hosts,
)
@vfolder_repository_resilience.apply()
async def get_max_vfolder_count(
self, user_uuid: uuid.UUID, group_uuid: uuid.UUID | None
) -> int:
"""
Get the maximum VFolder count for a user or group.
"""
async with self._db.begin_readonly_session_read_committed() as db_session:
if group_uuid:
group_row: GroupRow | None = await db_session.scalar(
sa.select(GroupRow)
.where(GroupRow.id == group_uuid)
.options(selectinload(GroupRow.resource_policy_row))
)
if group_row is None:
raise ProjectNotFound(f"Project with {group_uuid} not found.")
return group_row.resource_policy_row.max_vfolder_count
user_row: UserRow | None = await db_session.scalar(
sa.select(UserRow)
.where(UserRow.uuid == user_uuid)
.options(selectinload(UserRow.resource_policy_row))
)
if user_row is None:
raise UserNotFound(f"User with UUID {user_uuid} not found.")
return user_row.resource_policy_row.max_vfolder_count
@vfolder_repository_resilience.apply()
async def list_accessible_vfolders(
self,
user_id: uuid.UUID,
user_role: UserRole,
domain_name: str,
allowed_vfolder_types: list[str],
extra_conditions: sa.sql.elements.ColumnElement[bool] | None = None,
) -> VFolderListResult:
"""
List all VFolders accessible to a user.
Returns VFolderListResult with access information.
"""
async with self._db.begin_readonly_session() as session:
conn = await session.connection()
vfolder_dicts = await query_accessible_vfolders(
conn,
user_id,
user_role=user_role,
domain_name=domain_name,
allowed_vfolder_types=allowed_vfolder_types,
extra_vf_conds=extra_conditions,
)
vfolder_access_infos = []
for vfolder_dict in vfolder_dicts:
vfolder_data = self._vfolder_dict_to_data(dict(vfolder_dict))
is_owner = vfolder_dict.get("is_owner", False)
permission = vfolder_dict.get("permission", VFolderPermission.READ_ONLY)
vfolder_access_infos.append(
VFolderAccessInfo(
vfolder_data=vfolder_data,
is_owner=is_owner,
effective_permission=permission,
)
)
return VFolderListResult(vfolders=vfolder_access_infos)
@vfolder_repository_resilience.apply()
async def resolve_vfolder_ids_by_names(self, names: Sequence[str]) -> dict[str, uuid.UUID]:
"""Look up vfolder UUIDs for a batch of names in a single query.
Returns only the names that match an existing row; the caller
decides what to do with any missing names (typically raise).
No access scoping or status filtering — callers (e.g. session-create
paths) are responsible for validating both user access and lifecycle
state of the resolved ids in their own downstream flow.
"""
if not names:
return {}
async with self._db.begin_readonly_session() as session:
rows = (
await session.execute(
sa.select(VFolderRow.name, VFolderRow.id).where(
VFolderRow.name.in_(list(names))
)
)
).all()
return {row.name: cast(uuid.UUID, row.id) for row in rows}
@vfolder_repository_resilience.apply()
async def create_vfolder_with_permission(
self, params: VFolderCreateParams, create_owner_permission: bool = False
) -> VFolderData:
"""
Create a new VFolder with the given parameters and optionally create owner permission.
Returns the created VFolderData.
"""
async with self._db.begin_session() as session:
# Determine scope based on ownership type
element_type: RBACElementType
scope_id: str
match params.ownership_type:
case VFolderOwnershipType.USER:
element_type = RBACElementType.USER
scope_id = str(params.user)
case VFolderOwnershipType.GROUP:
element_type = RBACElementType.PROJECT
scope_id = str(params.group)
# Create VFolderCreatorSpec from params
spec = VFolderCreatorSpec(
id=params.id,
name=params.name,
domain_name=params.domain_name,
quota_scope_id=params.quota_scope_id,
usage_mode=params.usage_mode,
permission=params.permission,
host=params.host,
creator=params.creator,
creator_id=params.creator_id,
ownership_type=params.ownership_type,
user=params.user,
group=params.group,
unmanaged_path=params.unmanaged_path,
cloneable=params.cloneable,
status=params.status,
)
# Use RBACEntityCreator for atomic entity + scope association creation
rbac_creator = RBACEntityCreator(
spec=spec,
element_type=RBACElementType.VFOLDER,
scope_ref=RBACElementRef(element_type=element_type, element_id=scope_id),
additional_scope_refs=[],
)
result = await execute_rbac_entity_creator(session, rbac_creator)
created_row = result.row
# Create owner permission if requested (legacy compatibility)
if create_owner_permission and params.user:
# Get user's role_id
user_role_id = await self._get_user_role_id(session, params.user)
# Insert VFolderPermissionRow for legacy compatibility
permission_insert = sa.insert(VFolderPermissionRow).values({
"user": params.user,
"vfolder": params.id.hex,
"permission": VFolderPermission.OWNER_PERM,
})
await session.execute(permission_insert)
# Add permission to user's role using RBACGranter (entity-as-scope)
granter = RBACGranter(
granted_entity_id=ObjectId(
entity_type=EntityType.VFOLDER,
entity_id=str(params.id),
),
granted_entity_scope_type=RBACElementType.VFOLDER,
target_scope_id=ScopeId(
scope_type=ScopeType.USER,
scope_id=str(params.user),
),
target_role_ids=[user_role_id],
operations=[OperationType.READ],
)
await execute_rbac_granter(session, granter)
return created_row.to_data()
@vfolder_repository_resilience.apply()
async def trash_vfolder(self, updater: Updater[VFolderRow]) -> VFolderData:
"""Soft-delete a single vfolder by setting its status to DELETE_PENDING.
Checks that no active sessions are mounting the vfolder before
proceeding. Uses ``execute_updater`` with PK-based WHERE; returns the
updated row or raises ``VFolderNotFound`` if no matching row exists.
"""
async with self._db.begin_session() as session:
# Pre-check: reject if any session is currently mounting this vfolder
vfolder_row = await self._get_vfolder_by_id(session, uuid.UUID(str(updater.pk_value)))
if vfolder_row is None:
raise VFolderNotFound()
mount_sessions = await get_sessions_by_mounted_folder(
session, VFolderID.from_row(vfolder_row)
)
if mount_sessions:
session_ids = [str(sid) for sid in mount_sessions]
raise VFolderDeletionNotAllowed(
"Cannot delete the vfolder. "
f"The vfolder(id: {vfolder_row.id}) is mounted on sessions(ids: {session_ids})."
)
# Expire the pre-loaded ORM identity so execute_updater's
# RETURNING clause produces a fresh row with updated status.
await session.refresh(vfolder_row)
session.expunge(vfolder_row)
result = await execute_updater(session, updater)
if result is None:
raise VFolderNotFound()
return self._vfolder_row_to_data(result.row)
@vfolder_repository_resilience.apply()
async def update_vfolder_attribute(self, updater: Updater[VFolderRow]) -> VFolderData:
"""
Update VFolder attributes.
Returns updated VFolderData.
"""
async with self._db.begin_session() as session:
result = await execute_updater(session, updater)
if result is None:
raise VFolderNotFound()
return self._vfolder_row_to_data(result.row)
@vfolder_repository_resilience.apply()
async def move_vfolders_to_trash(self, vfolder_ids: list[uuid.UUID]) -> list[VFolderData]:
"""
Move VFolders to trash.
"""
async with self._db.begin_session() as session:
vfolder_rows = []
for vfolder_id in vfolder_ids:
vfolder_row = await self._get_vfolder_by_id(session, vfolder_id)
if vfolder_row:
vfolder_rows.append(vfolder_row)
# Create deletion info for each vfolder
deletion_infos = []
for vfolder_row in vfolder_rows:
vfolder_id_obj = VFolderID(
quota_scope_id=vfolder_row.quota_scope_id,
folder_id=vfolder_row.id,
)
deletion_info = VFolderDeletionInfo(
vfolder_id=vfolder_id_obj,
host=vfolder_row.host,
unmanaged_path=vfolder_row.unmanaged_path,
)
deletion_infos.append(deletion_info)
# Note: initiate_vfolder_deletion requires storage_manager parameter
# This would need to be passed to the repository method or handled differently
# For now, we'll update the status directly instead of using the full deletion process
for vfolder_row in vfolder_rows:
mount_sessions = await get_sessions_by_mounted_folder(
session, VFolderID.from_row(vfolder_row)
)
if mount_sessions:
session_ids = [str(session_id) for session_id in mount_sessions]
raise VFolderDeletionNotAllowed(
"Cannot delete the vfolder. "
f"The vfolder(id: {vfolder_row.id}) is mounted on sessions(ids: {session_ids})."
)
vfolder_row.status = VFolderOperationStatus.DELETE_PENDING
await session.flush()
for row in vfolder_rows:
await session.refresh(row, attribute_names=["updated_at"])
return [self._vfolder_row_to_data(row) for row in vfolder_rows]
@vfolder_repository_resilience.apply()
async def restore_vfolders_from_trash(self, vfolder_ids: list[uuid.UUID]) -> list[VFolderData]:
"""
Restore VFolders from trash.
"""
async with self._db.begin_session() as session:
vfolder_rows = []
for vfolder_id in vfolder_ids:
vfolder_row = await self._get_vfolder_by_id(session, vfolder_id)
if vfolder_row:
vfolder_row.status = VFolderOperationStatus.READY
vfolder_rows.append(vfolder_row)
await session.flush()
for row in vfolder_rows:
await session.refresh(row, attribute_names=["updated_at"])
return [self._vfolder_row_to_data(row) for row in vfolder_rows]
async def _fetch_vfolders_with_linked_model_cards(
self,
session: SASession,
vfolder_ids: Sequence[uuid.UUID],
) -> list[_VFolderWithLinkedModelCards]:
"""Fetch vfolder rows together with model card rows that reference them.
Uses a single LEFT OUTER JOIN. Vfolders with no model card appear
once with an empty ``model_card_rows`` list; vfolder IDs not present
in the database are skipped.
"""
if not vfolder_ids:
return []
stmt = (
sa.select(VFolderRow, ModelCardRow)
.outerjoin(ModelCardRow, ModelCardRow.vfolder == VFolderRow.id)
.where(VFolderRow.id.in_(vfolder_ids))
)
rows = (await session.execute(stmt)).all()
grouped: dict[uuid.UUID, _VFolderWithLinkedModelCards] = {}
for vfolder_row, card_row in rows:
record = grouped.setdefault(
vfolder_row.id,
_VFolderWithLinkedModelCards(
vfolder_row=vfolder_row,
model_card_rows=[],
),
)
if card_row is not None:
record.model_card_rows.append(card_row)
return list(grouped.values())
@vfolder_repository_resilience.apply()
async def delete_vfolders_forever(
self,
vfolder_ids: list[uuid.UUID],
*,
cascade_model_card: bool = False,
) -> BulkVFolderPurgeResult:
"""
Delete VFolders forever with partial-success semantics.
Each vfolder is processed independently in the same transaction:
a vfolder with linked model card(s) becomes a failure (carrying
``VFolderHasLinkedModelCard``) when ``cascade_model_card`` is False;
otherwise the cards are deleted and the vfolder transitions to
``DELETE_ONGOING`` like any other success.
"""
result = BulkVFolderPurgeResult()
async with self._db.connect() as db_conn:
async with self._db.begin_session(db_conn) as db_session:
records = await self._fetch_vfolders_with_linked_model_cards(
db_session, vfolder_ids
)
cards_to_delete: list[ModelCardRow] = []
succeeded_ids: list[uuid.UUID] = []
succeeded_rows: list[VFolderRow] = []
for rec in records:
if rec.model_card_rows and not cascade_model_card:
result.failures.append(
VFolderPurgeFailure(
vfolder_id=rec.vfolder_row.id,
exception=VFolderHasLinkedModelCard(
f"VFolder {rec.vfolder_row.id} is referenced by "
f"{len(rec.model_card_rows)} model card(s); "
"delete the model card(s) first or set "
"cascade_model_card=True."
),
)
)
continue
cards_to_delete.extend(rec.model_card_rows)
succeeded_ids.append(rec.vfolder_row.id)
succeeded_rows.append(rec.vfolder_row)
if cards_to_delete:
for card in cards_to_delete:
await db_session.delete(card)
await db_session.flush()
if succeeded_ids:
delete_stmt = (
sa.update(VFolderRow)
.where(VFolderRow.id.in_(succeeded_ids))
.values(status=VFolderOperationStatus.DELETE_ONGOING)
)
await db_session.execute(delete_stmt)
# ``onupdate=now()`` on ``updated_at`` expires the
# column on the in-memory rows after the UPDATE;
# explicitly refresh so the subsequent conversion
# does not need a lazy SELECT (which would fail
# outside the greenlet bridge).
for row in succeeded_rows:
await db_session.refresh(row, attribute_names=["updated_at"])
succeeded_data = [self._vfolder_row_to_data(row) for row in succeeded_rows]
if succeeded_ids:
# Delete relation rows for succeeded vfolders only.
await delete_vfolder_relation_rows(db_conn, self._db.begin_session, succeeded_ids)
result.succeeded = succeeded_data
return result
@vfolder_repository_resilience.apply()
async def purge_vfolder(self, purger: RBACEntityPurger[VFolderRow]) -> VFolderData:
"""
Permanently delete a VFolder from DB.
Only VFolders with purgable status (DELETE_PENDING, DELETE_COMPLETE) can be purged.
Raises:
VFolderNotFound: If the vfolder doesn't exist.
VFolderFilterStatusFailed: If the vfolder status is not purgable.
VFolderHasLinkedModelCard: If a model card still references the vfolder.
"""
vfolder_uuid = cast(uuid.UUID, purger.pk_value)
async with self._db.begin_session() as session:
# Fetch vfolder first to validate status before purging.
vfolder_row = await self._get_vfolder_by_id(session, vfolder_uuid)
if vfolder_row is None:
raise VFolderNotFound(extra_data=str(vfolder_uuid))
if vfolder_row.status not in vfolder_status_map[VFolderStatusSet.PURGABLE]:
raise VFolderFilterStatusFailed
try:
await execute_rbac_entity_purger(session, purger)
except RepositoryIntegrityError as e:
match_integrity_error(
e,
[
IntegrityErrorCheck(
violation_type=ForeignKeyViolationError,
constraint_name="fk_model_cards_vfolder_vfolders",
error=VFolderHasLinkedModelCard(
f"VFolder {vfolder_uuid} cannot be purged: it is "
"still referenced by one or more model card(s). "
"Run delete-forever (with cascade if needed) "
"before purge."
),
),
],
)
return vfolder_row.to_data()
@vfolder_repository_resilience.apply()
async def get_vfolder_permissions(self, vfolder_id: uuid.UUID) -> list[VFolderPermissionData]:
"""
Get all permissions for a VFolder.
"""
async with self._db.begin_readonly_session_read_committed() as session:
query = sa.select(VFolderPermissionRow).where(
VFolderPermissionRow.vfolder == vfolder_id
)
result = await session.execute(query)
permission_rows = result.scalars().all()
return [
VFolderPermissionData(
id=row.id,
vfolder=row.vfolder,
user=row.user,
permission=row.permission or VFolderMountPermission.READ_ONLY,
)
for row in permission_rows
]
@vfolder_repository_resilience.apply()
async def create_vfolder_permission(
self,
vfolder_id: uuid.UUID,
user_id: uuid.UUID,
permission: VFolderPermission,
) -> VFolderPermissionData:
"""
Create a VFolder permission entry.
"""
async with self._db.begin_session() as session:
# Verify vfolder exists
vfolder_row = await self._get_vfolder_by_id(session, vfolder_id)
if vfolder_row is None:
raise VFolderNotFound()
# Get user's role_id
user_role_id = await self._get_user_role_id(session, user_id)
# Insert VFolderPermissionRow (legacy compatibility)
permission_id = uuid.uuid4()
insert_values = {
"id": permission_id,
"vfolder": vfolder_id,
"user": user_id,
"permission": permission,
}
query = sa.insert(VFolderPermissionRow).values(insert_values)
await session.execute(query)
# Grant permission to user's role using RBACGranter (entity-as-scope)
granter = RBACGranter(
granted_entity_id=ObjectId(
entity_type=EntityType.VFOLDER,
entity_id=str(vfolder_id),
),
granted_entity_scope_type=RBACElementType.VFOLDER,
target_scope_id=ScopeId(
scope_type=ScopeType.USER,
scope_id=str(user_id),
),
target_role_ids=[user_role_id],
operations=list(permission.to_rbac_operation()),
)
await execute_rbac_granter(session, granter)
return VFolderPermissionData(
id=permission_id,
vfolder=vfolder_id,
user=user_id,
permission=permission,
)
@vfolder_repository_resilience.apply()
async def delete_vfolder_permission(self, vfolder_id: uuid.UUID, user_id: uuid.UUID) -> None:
"""
Delete a VFolder permission entry.
"""
async with self._db.begin_session() as session:
# Get user's role_id
user_role_id = await self._get_user_role_id(session, user_id)
# Delete VFolderPermissionRow (legacy compatibility)
query = sa.delete(VFolderPermissionRow).where(
(VFolderPermissionRow.vfolder == vfolder_id)
& (VFolderPermissionRow.user == user_id)
)
await session.execute(query)
# Revoke permission from user's role using RBACRevoker
revoker = RBACRevoker(
entity_id=ObjectId(
entity_type=EntityType.VFOLDER,
entity_id=str(vfolder_id),
),
entity_scope_type=RBACElementType.VFOLDER,
target_role_ids=[user_role_id],
operations=None, # Revoke all operations
)
await execute_rbac_revoker(session, revoker)
@vfolder_repository_resilience.apply()
async def get_vfolder_invitations_by_vfolder(
self, vfolder_id: uuid.UUID
) -> list[VFolderInvitationData]:
"""
Get all invitations for a VFolder.
"""
async with self._db.begin_readonly_session_read_committed() as session:
query = (
sa.select(VFolderInvitationRow, UserRow.username)
.outerjoin(UserRow, UserRow.email == VFolderInvitationRow.inviter)
.where(VFolderInvitationRow.vfolder == vfolder_id)
)
result = await session.execute(query)
rows = result.all()
return [
VFolderInvitationData(
id=row.id,
vfolder=row.vfolder,
inviter=row.inviter or "",
inviter_username=inviter_username,
invitee=row.invitee,
permission=row.permission or VFolderMountPermission.READ_ONLY,
created_at=row.created_at or datetime.now(UTC),
modified_at=row.modified_at,
)
for row, inviter_username in rows
]
@vfolder_repository_resilience.apply()
async def count_vfolders_by_user(self, user_id: uuid.UUID) -> int:
"""
Count VFolders owned by a user (excluding hard deleted ones).
"""
async with self._db.begin_readonly_session_read_committed() as session:
query = (
sa.select(sa.func.count())
.select_from(VFolderRow)
.where(
(VFolderRow.user == user_id)
& (VFolderRow.status.not_in(HARD_DELETED_VFOLDER_STATUSES))
)
)
result = await session.scalar(query)
return result or 0
@vfolder_repository_resilience.apply()
async def count_vfolders_by_group(self, group_id: uuid.UUID) -> int:
"""
Count VFolders owned by a group (excluding hard deleted ones).
"""
async with self._db.begin_readonly_session_read_committed() as session:
query = (
sa.select(sa.func.count())
.select_from(VFolderRow)
.where(
(VFolderRow.group == group_id)
& (VFolderRow.status.not_in(HARD_DELETED_VFOLDER_STATUSES))
)
)
result = await session.scalar(query)
return result or 0
@vfolder_repository_resilience.apply()
async def check_vfolder_name_exists(
self,
name: str,
user_id: uuid.UUID,
user_role: UserRole,
domain_name: str,
allowed_vfolder_types: list[str],
) -> bool:
"""
Check if a VFolder with the given name already exists for the user.
"""
async with self._db.begin_readonly_session() as session:
# Use query_accessible_vfolders to check accessible folders
extra_vf_conds = sa.and_(
(VFolderRow.name == name),
(VFolderRow.status.not_in(HARD_DELETED_VFOLDER_STATUSES)),
)
conn = await session.connection()