Add frontend-required info to code references spec

Author: emyller

api/projects/code_references/models.py

@@ -2,17 +2,14 @@
 from django.db import models
 from django.db.models.expressions import Func
 
-from projects.code_references.types import JSONCodeReference
+from projects.code_references.types import JSONCodeReference, VCSProvider
 
 
 class FeatureFlagCodeReferencesScan(models.Model):
     """
     A scan of feature flag code references in a repository
     """
 
-    class Providers(models.TextChoices):
-        GITHUB = "github", "GitHub"
-
     project = models.ForeignKey(
         "projects.Project",
         on_delete=models.CASCADE,
@@ -24,8 +21,8 @@ class Providers(models.TextChoices):
 
     vcs_provider = models.CharField(
         max_length=50,
-        choices=Providers.choices,
-        default=Providers.GITHUB,  # TODO: Remove when adding other providers
+        choices=VCSProvider.choices,
+        default=VCSProvider.GITHUB,  # TODO: Remove when adding other providers
     )
     revision = models.CharField(max_length=100)
     code_references = models.JSONField[list[JSONCodeReference]](default=list)

api/projects/code_references/serializers.py

@@ -4,6 +4,7 @@
 from projects.code_references.types import (
     CodeReference,
     FeatureFlagCodeReferences,
+    VCSProvider,
 )
 
 
@@ -17,9 +18,11 @@ class _CodeReferenceSubmitSerializer(_BaseCodeReferenceSerializer):
 
 
 class _CodeReferenceDetailSerializer(_BaseCodeReferenceSerializer):
-    permalink = serializers.URLField()
     scanned_at = serializers.DateTimeField()
+    vcs_provider = serializers.ChoiceField(choices=VCSProvider.choices)
+    repository_url = serializers.URLField()
     revision = serializers.CharField()
+    permalink = serializers.URLField()
 
 
 class FeatureFlagCodeReferencesScanSerializer(

api/projects/code_references/types.py

@@ -2,6 +2,12 @@
 from datetime import datetime
 from typing import TypedDict
 
+from django.db.models import TextChoices
+
+
+class VCSProvider(TextChoices):
+    GITHUB = "github", "GitHub"
+
 
 class JSONCodeReference(TypedDict):
     feature_name: str
@@ -12,6 +18,8 @@ class JSONCodeReference(TypedDict):
 @dataclass
 class CodeReference:
     scanned_at: datetime
+    vcs_provider: VCSProvider
+    repository_url: str
     revision: str
     feature_name: str
     file_path: str

api/projects/code_references/views.py

@@ -19,6 +19,7 @@
 from projects.code_references.types import (
     CodeReference,
     FeatureFlagCodeReferences,
+    VCSProvider,
 )
 
 
@@ -92,17 +93,20 @@ def _get_code_references(self) -> list[CodeReference]:
 
         return [
             CodeReference(
+                scanned_at=scan.created_at,
+                vcs_provider=scan.vcs_provider,
+                repository_url=scan.repository_url,
+                revision=scan.revision,
                 feature_name=feature.name,
                 file_path=reference["file_path"],
                 line_number=reference["line_number"],
                 permalink=self._get_permalink(
+                    provider=scan.vcs_provider,
                     repository_url=scan.repository_url,
                     revision=scan.revision,
                     file_path=reference["file_path"],
                     line_number=reference["line_number"],
                 ),
-                scanned_at=scan.created_at,
-                revision=scan.revision,
             )
             for scan in last_scans_of_each_repository
             for reference in scan.code_references
@@ -111,6 +115,7 @@ def _get_code_references(self) -> list[CodeReference]:
 
     def _get_permalink(
         self,
+        provider: VCSProvider,
         repository_url: str,
         revision: str,
         file_path: str,

api/tests/unit/projects/code_references/test_unit_projects_code_references_views.py

@@ -192,6 +192,8 @@ def test_FeatureCodeReferencesDetailAPIView__responds_200_with_code_references_f
     assert response.data["last_scanned_at"] == "2099-01-02T11:00:00Z"
     assert len(references := response.data["code_references"]) == 3
     assert references[0]["scanned_at"] == "2099-01-01T10:00:00Z"
+    assert references[0]["vcs_provider"] == "github"
+    assert references[0]["repository_url"] == "https://github.flagsmith.com/backend/"
     assert references[0]["revision"] == "backend-1"
     assert references[1]["scanned_at"] == "2099-01-02T11:00:00Z"
     assert references[0]["file_path"] == "backend/file1.py"
@@ -200,13 +202,17 @@ def test_FeatureCodeReferencesDetailAPIView__responds_200_with_code_references_f
         "https://github.flagsmith.com/backend/blob/backend-1/backend/file1.py#L20"
     )
     assert references[1]["scanned_at"] == "2099-01-02T11:00:00Z"
+    assert references[1]["vcs_provider"] == "github"
+    assert references[1]["repository_url"] == "https://github.flagsmith.com/frontend/"
     assert references[1]["revision"] == "frontend-2"
     assert references[1]["file_path"] == "frontend/file1.js"
     assert references[1]["line_number"] == 12
     assert references[1]["permalink"] == (
         "https://github.flagsmith.com/frontend/blob/frontend-2/frontend/file1.js#L12"
     )
     assert references[2]["scanned_at"] == "2099-01-02T11:00:00Z"
+    assert references[2]["vcs_provider"] == "github"
+    assert references[2]["repository_url"] == "https://github.flagsmith.com/frontend/"
     assert references[2]["revision"] == "frontend-2"
     assert references[2]["file_path"] == "frontend/file2.js"
     assert references[2]["line_number"] == 5