Add an API for cfbot to get the needed data

Author: JelteF

pgcommitfest/commitfest/apiv1.py

@@ -1,22 +1,26 @@
 from django.http import (
     HttpResponse,
 )
+from django.shortcuts import get_object_or_404
 
 import json
 from datetime import date, datetime, timedelta, timezone
 
 from .models import (
     CommitFest,
+    Patch,
+    PatchOnCommitFest,
 )
 
 
 def datetime_serializer(obj):
-    if isinstance(obj, date):
-        return obj.isoformat()
-
+    # datetime must be checked before date, since datetime is a subclass of date
     if isinstance(obj, datetime):
         return obj.replace(tzinfo=timezone.utc).isoformat()
 
+    if isinstance(obj, date):
+        return obj.isoformat()
+
     if hasattr(obj, "to_json"):
         return obj.to_json()
 
@@ -44,3 +48,70 @@ def commitfestst_that_need_ci(request):
     del cfs["final"]
 
     return api_response({"commitfests": cfs})
+
+
+def commitfest_patches(request, cfid):
+    """Return all patches for a commitfest.
+
+    This endpoint provides the data that cfbot previously scraped from the
+    commitfest HTML page.
+    """
+    cf = get_object_or_404(CommitFest, pk=cfid)
+
+    pocs = (
+        PatchOnCommitFest.objects.filter(commitfest=cf)
+        .select_related("patch")
+        .prefetch_related("patch__authors")
+        .order_by("patch__id")
+    )
+
+    patches = []
+    for poc in pocs:
+        patch = poc.patch
+        authors = [f"{a.first_name} {a.last_name}" for a in patch.authors.all()]
+        patches.append(
+            {
+                "id": patch.id,
+                "name": patch.name,
+                "status": poc.statusstring,
+                "authors": authors,
+                "last_email_time": patch.lastmail,
+            }
+        )
+
+    return api_response(
+        {
+            "commitfest_id": cf.id,
+            "patches": patches,
+        }
+    )
+
+
+def patch_threads(request, patch_id):
+    """Return thread information for a patch.
+
+    This endpoint provides the data that cfbot previously scraped from the
+    patch HTML page to construct thread URLs.
+    """
+    patch = get_object_or_404(Patch, pk=patch_id)
+
+    threads = []
+    for thread in patch.mailthread_set.all():
+        latest_attachment = thread.mailthreadattachment_set.first()
+        threads.append(
+            {
+                "messageid": thread.messageid,
+                "subject": thread.subject,
+                "latest_message_id": thread.latestmsgid,
+                "latest_message_time": thread.latestmessage,
+                "has_attachment": latest_attachment is not None,
+            }
+        )
+
+    return api_response(
+        {
+            "patch_id": patch.id,
+            "name": patch.name,
+            "threads": threads,
+        }
+    )

pgcommitfest/commitfest/tests/test_apiv1.py

@@ -1,7 +1,14 @@
 import json
+from datetime import datetime, timezone
 
 import pytest
 
+from pgcommitfest.commitfest.models import (
+    MailThread,
+    Patch,
+    PatchOnCommitFest,
+)
+
 pytestmark = pytest.mark.django_db
 
 
@@ -44,3 +51,112 @@ def test_needs_ci_endpoint(client, commitfests):
     }
 
     assert data == expected
+
+
+def test_commitfest_patches_endpoint(client, open_cf, alice, bob):
+    """Test the /api/v1/commitfests/<id>/patches endpoint."""
+    # Create test patches
+    patch1 = Patch.objects.create(name="Add feature X")
+    patch1.authors.add(alice)
+    patch1.lastmail = datetime(2025, 1, 15, 10, 30, 0, tzinfo=timezone.utc)
+    patch1.save()
+
+    patch2 = Patch.objects.create(name="Fix bug Y")
+    patch2.authors.add(alice, bob)
+    patch2.save()
+
+    # Link patches to commitfest
+    PatchOnCommitFest.objects.create(
+        patch=patch1,
+        commitfest=open_cf,
+        enterdate=datetime.now(),
+        status=PatchOnCommitFest.STATUS_REVIEW,
+    )
+    PatchOnCommitFest.objects.create(
+        patch=patch2,
+        commitfest=open_cf,
+        enterdate=datetime.now(),
+        status=PatchOnCommitFest.STATUS_AUTHOR,
+    )
+
+    response = client.get(f"/api/v1/commitfests/{open_cf.id}/patches")
+
+    assert response.status_code == 200
+    assert response["Content-Type"] == "application/json"
+    assert response["Access-Control-Allow-Origin"] == "*"
+
+    data = json.loads(response.content)
+
+    assert data["commitfest_id"] == open_cf.id
+    assert len(data["patches"]) == 2
+
+    # Patches are ordered by id
+    p1 = data["patches"][0]
+    assert p1["id"] == patch1.id
+    assert p1["name"] == "Add feature X"
+    assert p1["status"] == "Needs review"
+    assert p1["authors"] == ["Alice Anderson"]
+    assert p1["last_email_time"] == "2025-01-15T10:30:00+00:00"
+
+    p2 = data["patches"][1]
+    assert p2["id"] == patch2.id
+    assert p2["name"] == "Fix bug Y"
+    assert p2["status"] == "Waiting on Author"
+    assert sorted(p2["authors"]) == ["Alice Anderson", "Bob Brown"]
+    assert p2["last_email_time"] is None
+
+
+def test_commitfest_patches_endpoint_not_found(client, commitfests):
+    """Test the patches endpoint returns 404 for non-existent commitfest."""
+    response = client.get("/api/v1/commitfests/99999/patches")
+    assert response.status_code == 404
+
+
+def test_patch_threads_endpoint(client, open_cf, alice):
+    """Test the /api/v1/patches/<id>/threads endpoint."""
+    patch = Patch.objects.create(name="Test patch")
+    patch.authors.add(alice)
+
+    PatchOnCommitFest.objects.create(
+        patch=patch,
+        commitfest=open_cf,
+        enterdate=datetime.now(),
+        status=PatchOnCommitFest.STATUS_REVIEW,
+    )
+
+    # Create mail threads
+    thread1 = MailThread.objects.create(
+        messageid="abc123@example.com",
+        subject="[PATCH] Test patch v1",
+        firstmessage=datetime(2025, 1, 10, 9, 0, 0, tzinfo=timezone.utc),
+        firstauthor="alice@example.com",
+        latestmessage=datetime(2025, 1, 12, 14, 30, 0, tzinfo=timezone.utc),
+        latestauthor="bob@example.com",
+        latestsubject="Re: [PATCH] Test patch v1",
+        latestmsgid="def456@example.com",
+    )
+    patch.mailthread_set.add(thread1)
+
+    response = client.get(f"/api/v1/patches/{patch.id}/threads")
+
+    assert response.status_code == 200
+    assert response["Content-Type"] == "application/json"
+
+    data = json.loads(response.content)
+
+    assert data["patch_id"] == patch.id
+    assert data["name"] == "Test patch"
+    assert len(data["threads"]) == 1
+
+    t = data["threads"][0]
+    assert t["messageid"] == "abc123@example.com"
+    assert t["subject"] == "[PATCH] Test patch v1"
+    assert t["latest_message_id"] == "def456@example.com"
+    assert t["latest_message_time"] == "2025-01-12T14:30:00+00:00"
+    assert t["has_attachment"] is False
+
+
+def test_patch_threads_endpoint_not_found(client, commitfests):
+    """Test the threads endpoint returns 404 for non-existent patch."""
+    response = client.get("/api/v1/patches/99999/threads")
+    assert response.status_code == 404

pgcommitfest/urls.py

@@ -17,6 +17,8 @@
 urlpatterns = [
     re_path(r"^$", views.home),
     re_path(r"^api/v1/commitfests/needs_ci$", apiv1.commitfestst_that_need_ci),
+    re_path(r"^api/v1/commitfests/(\d+)/patches$", apiv1.commitfest_patches),
+    re_path(r"^api/v1/patches/(\d+)/threads$", apiv1.patch_threads),
     re_path(r"^help/$", views.help),
     re_path(r"^commitfest_history/$", views.commitfest_history),
     re_path(r"^me/$", views.me_legacy_redirect),