Add a sunburst internal endpoint

api/internal/coverage/views.py

@@ -9,7 +9,7 @@
 import services.components as components_service
 from api.shared.mixins import RepoPropertyMixin
 from api.shared.permissions import RepositoryArtifactPermissions
-from api.shared.report.serializers import TreeSerializer
+from api.shared.report.serializers import SunburstSerializer, TreeSerializer
 from services.path import ReportPaths
 
 
@@ -67,3 +67,9 @@ def tree(self, request: HttpRequest, *args: Any, **kwargs: Any) -> Response:
         paths = self.get_object()
         serializer = TreeSerializer(paths.single_directory(), many=True)
         return Response(serializer.data)
+
+    @action(detail=False, methods=["get"], url_path="sunburst")
+    def sunburst(self, request: HttpRequest, *args: Any, **kwargs: Any) -> Response:
+        paths = self.get_object()
+        serializer = SunburstSerializer(paths.single_directory(), many=True)
+        return Response(serializer.data)

api/shared/report/serializers.py

@@ -2,7 +2,7 @@
 
 from rest_framework import serializers
 
-from services.path import Dir
+from services.path import Dir, File
 
 
 class TreeSerializer(serializers.Serializer):
@@ -14,7 +14,7 @@ class TreeSerializer(serializers.Serializer):
     partials = serializers.IntegerField()
     misses = serializers.IntegerField()
 
-    def to_representation(self, instance):
+    def to_representation(self, instance: Dir | File) -> dict:
         depth = self.context.get("depth", 1)
         max_depth = self.context.get("max_depth", math.inf)
         res = super().to_representation(instance)
@@ -29,3 +29,29 @@ def to_representation(self, instance):
                     },
                 ).data
         return res
+
+
+class SunburstSerializer(serializers.Serializer):
+    name = serializers.CharField()
+    full_path = serializers.CharField()
+    value = serializers.FloatField()
+
+    def to_representation(self, instance: Dir | File) -> dict:
+        depth = self.context.get("depth", 1)
+        max_depth = self.context.get("max_depth", math.inf)
+        res = super().to_representation(instance)
+
+        # Adjust the "value" field based on the instance type
+        if isinstance(instance, File):
+            res["value"] = instance.coverage
+        elif isinstance(instance, Dir):
+            if depth < max_depth:
+                res["children"] = SunburstSerializer(
+                    instance.children,
+                    many=True,
+                    context={
+                        "depth": depth + 1,
+                        "max_depth": max_depth,
+                    },
+                ).data
+        return res