[Feature] Make JobLog Page Paginated (#403)

Co-authored-by: Tim Lorsbach <tim@lorsba.ch>
Reviewed-on: enviPath/enviPy#403

epapi/v1/endpoints/joblogs.py

@@ -0,0 +1,26 @@
+from django.conf import settings as s
+from ninja import Router
+from ninja_extra.pagination import paginate
+
+from epdb.models import JobLog
+from ..pagination import EnhancedPageNumberPagination
+from ..schemas import JobLogOutSchema
+
+router = Router()
+
+
+@router.get("/joblog/", response=EnhancedPageNumberPagination.Output[JobLogOutSchema])
+@paginate(
+    EnhancedPageNumberPagination,
+    page_size=s.API_PAGINATION_DEFAULT_PAGE_SIZE,
+)
+def list_all_joblogs(request):
+    """
+    List all JobLogs from reviewed packages.
+    """
+    current_user = request.user
+
+    if current_user.is_superuser:
+        return JobLog.objects.all().order_by("-created")
+    else:
+        return JobLog.objects.filter(user=current_user).order_by("-created")

epapi/v1/router.py

@@ -15,6 +15,7 @@ from .endpoints import (
     additional_information,
     settings,
     groups,
+    joblogs,
 )
 
 # Main router with authentication
@@ -37,6 +38,7 @@ router.add_router("", structure.router)
 router.add_router("", additional_information.router)
 router.add_router("", settings.router)
 router.add_router("", groups.router)
+router.add_router("", joblogs.router)
 
 if s.IUCLID_EXPORT_ENABLED:
     from epiuclid.api import router as iuclid_router

epapi/v1/schemas.py

@@ -1,7 +1,10 @@
-from ninja import FilterSchema, FilterLookup, Schema
+from datetime import datetime
 from typing import Annotated, Optional, List, Dict, Any
 from uuid import UUID
 
+from django.urls import reverse
+from ninja import Field, FilterSchema, FilterLookup, Schema
+
 
 # Filter schema for query parameters
 class ReviewStatusFilter(FilterSchema):
@@ -133,3 +136,23 @@ class GroupOutSchema(Schema):
     url: str = ""
     name: str
     description: str
+
+
+class SimpleUserOutSchema(Schema):
+    uuid: UUID
+    url: str
+    name: str = Field(alias="username")
+
+
+class JobLogOutSchema(Schema):
+    user: SimpleUserOutSchema
+    id: UUID = Field(alias="task_id")
+    url: str
+    name: str = Field(alias="job_name")
+    created: datetime = Field(alias="created")
+    status: str = Field(alias="status")
+    done: Optional[datetime] = Field(None, alias="done_at")
+
+    @staticmethod
+    def resolve_url(obj):
+        return reverse("job detail", kwargs={"job_uuid": obj.task_id})