ФУНКЦИИ - МЕЖПРОЕКТНАЯ КОММУНИКАЦИЯ: API мониторинга хранилища воркспейса

plane-src/apps/api/plane/app/urls/workspace.py

@@ -36,6 +36,7 @@ from plane.app.views import (
     UserRecentVisitViewSet,
     WorkspaceHomePreferenceViewSet,
     WorkspaceStickyViewSet,
+    WorkspaceStorageSummaryEndpoint,
     WorkspaceUserPreferenceViewSet,
 )
 
@@ -257,6 +258,11 @@ urlpatterns = [
         WorkspaceStickyViewSet.as_view({"get": "retrieve", "patch": "partial_update", "delete": "destroy"}),
         name="workspace-sticky",
     ),
+    path(
+        "workspaces/<str:slug>/storage/summary/",
+        WorkspaceStorageSummaryEndpoint.as_view(),
+        name="workspace-storage-summary",
+    ),
     # User Preference
     path(
         "workspaces/<str:slug>/sidebar-preferences/",

plane-src/apps/api/plane/app/views/__init__.py

@@ -83,6 +83,7 @@ from .workspace.module import WorkspaceModulesEndpoint
 from .workspace.cycle import WorkspaceCyclesEndpoint
 from .workspace.quick_link import QuickLinkViewSet
 from .workspace.sticky import WorkspaceStickyViewSet
+from .workspace.storage import WorkspaceStorageSummaryEndpoint
 
 from .state.base import StateViewSet, IntakeStateEndpoint
 from .view.base import (

plane-src/apps/api/plane/app/views/workspace/storage.py

@@ -0,0 +1,121 @@
+# Copyright (c) 2023-present Plane Software, Inc. and contributors
+# SPDX-License-Identifier: AGPL-3.0-only
+# See the LICENSE file for details.
+
+from datetime import timedelta
+
+from django.db.models import Sum
+from django.utils import timezone
+from rest_framework import status
+from rest_framework.response import Response
+
+from plane.app.permissions import ROLE, allow_permission
+from plane.app.views.base import BaseAPIView
+from plane.db.models import FileAsset, Project, StoredBlob, Workspace
+
+
+def _int_size(value):
+    return int(value or 0)
+
+
+def _sum_asset_size(queryset):
+    return _int_size(queryset.aggregate(total=Sum("size")).get("total"))
+
+
+def _sum_blob_size(blob_ids):
+    if not blob_ids:
+        return 0
+
+    return _int_size(StoredBlob.objects.filter(id__in=blob_ids).aggregate(total=Sum("size")).get("total"))
+
+
+def _dedup_savings(logical_size, physical_size):
+    return max(_int_size(logical_size) - _int_size(physical_size), 0)
+
+
+class WorkspaceStorageSummaryEndpoint(BaseAPIView):
+    @allow_permission(allowed_roles=[ROLE.ADMIN], level="WORKSPACE")
+    def get(self, request, slug):
+        workspace = Workspace.objects.get(slug=slug)
+        stale_cutoff = timezone.now() - timedelta(days=1)
+
+        active_assets = FileAsset.objects.filter(workspace=workspace, is_uploaded=True)
+        active_blob_ids = list(active_assets.exclude(blob__isnull=True).values_list("blob_id", flat=True).distinct())
+
+        workspace_logical_size = _sum_asset_size(active_assets)
+        workspace_physical_size = _sum_blob_size(active_blob_ids)
+
+        failed_uploads = FileAsset.all_objects.filter(
+            workspace=workspace,
+            is_uploaded=False,
+            deleted_at__isnull=True,
+        )
+        stale_unuploaded = failed_uploads.filter(created_at__lt=stale_cutoff)
+        soft_deleted_assets = FileAsset.all_objects.filter(workspace=workspace, deleted_at__isnull=False)
+        orphaned_blobs = StoredBlob.objects.filter(workspace=workspace, status=StoredBlob.Status.ORPHANED)
+        missing_blobs = StoredBlob.objects.filter(workspace=workspace, status=StoredBlob.Status.MISSING)
+        uploaded_without_blob = active_assets.filter(blob__isnull=True)
+
+        project_rows = []
+        projects = Project.objects.filter(workspace=workspace).order_by("name")
+        for project in projects:
+            project_assets = active_assets.filter(project=project)
+            project_blob_ids = list(
+                project_assets.exclude(blob__isnull=True).values_list("blob_id", flat=True).distinct()
+            )
+            project_logical_size = _sum_asset_size(project_assets)
+            project_physical_size = _sum_blob_size(project_blob_ids)
+            project_failed_uploads = failed_uploads.filter(project=project)
+            project_soft_deleted = soft_deleted_assets.filter(project=project)
+            project_uploaded_without_blob = uploaded_without_blob.filter(project=project)
+
+            project_rows.append(
+                {
+                    "id": str(project.id),
+                    "name": project.name,
+                    "identifier": project.identifier,
+                    "file_count": project_assets.count(),
+                    "blob_count": len(project_blob_ids),
+                    "logical_size": project_logical_size,
+                    "physical_size": project_physical_size,
+                    "dedup_savings": _dedup_savings(project_logical_size, project_physical_size),
+                    "failed_upload_count": project_failed_uploads.count(),
+                    "failed_upload_size": _sum_asset_size(project_failed_uploads),
+                    "soft_deleted_count": project_soft_deleted.count(),
+                    "soft_deleted_size": _sum_asset_size(project_soft_deleted),
+                    "uploaded_without_blob_count": project_uploaded_without_blob.count(),
+                }
+            )
+
+        data = {
+            "workspace": {
+                "id": str(workspace.id),
+                "name": workspace.name,
+                "slug": workspace.slug,
+                "upload_file_size_limit_enabled": workspace.storage_file_size_limit_enabled,
+                "upload_file_size_limit": workspace.storage_file_size_limit,
+            },
+            "summary": {
+                "file_count": active_assets.count(),
+                "blob_count": len(active_blob_ids),
+                "logical_size": workspace_logical_size,
+                "physical_size": workspace_physical_size,
+                "dedup_savings": _dedup_savings(workspace_logical_size, workspace_physical_size),
+                "uploaded_without_blob_count": uploaded_without_blob.count(),
+            },
+            "diagnostics": {
+                "failed_upload_count": failed_uploads.count(),
+                "failed_upload_size": _sum_asset_size(failed_uploads),
+                "stale_unuploaded_count": stale_unuploaded.count(),
+                "stale_unuploaded_size": _sum_asset_size(stale_unuploaded),
+                "soft_deleted_count": soft_deleted_assets.count(),
+                "soft_deleted_size": _sum_asset_size(soft_deleted_assets),
+                "orphaned_blob_count": orphaned_blobs.count(),
+                "orphaned_blob_size": _sum_blob_size(list(orphaned_blobs.values_list("id", flat=True))),
+                "missing_blob_count": missing_blobs.count(),
+                "missing_blob_size": _sum_blob_size(list(missing_blobs.values_list("id", flat=True))),
+            },
+            "projects": project_rows,
+        }
+
+        return Response(data, status=status.HTTP_200_OK)