Update code

Author: arkid15r

backend/apps/owasp/api/internal/views/project_health_metrics.py

@@ -1,34 +1,36 @@
 """Views for OWASP project health metrics."""
 
-import re
-
-from django.http import FileResponse, HttpResponseBadRequest, HttpResponseNotFound
+from django.http import FileResponse, Http404
 from django.views.decorators.http import require_GET
 
+from apps.owasp.models.project import Project
+from apps.owasp.models.project_health_metrics import ProjectHealthMetrics
 from apps.owasp.utils.pdf import generate_latest_metrics_pdf, generate_metrics_overview_pdf
 
 
 @require_GET
-def generate_overview_pdf(_request):
+def generate_overview_pdf(request):  # noqa: ARG001
     """Generate a PDF overview of OWASP project health metrics."""
     return FileResponse(
-        generate_metrics_overview_pdf(),
+        generate_metrics_overview_pdf(ProjectHealthMetrics.get_stats()),
         as_attachment=True,
         filename="owasp_project_health_metrics_overview.pdf",
     )
 
 
 @require_GET
-def generate_project_health_metrics_pdf(_request, project_key: str):
+def generate_project_health_metrics_pdf(request, project_key: str):  # noqa: ARG001
     """Generate and return a PDF report of project health metrics."""
-    if not re.match(r"^[a-zA-Z0-9_-]+$", project_key):
-        return HttpResponseBadRequest("Invalid project key")
+    if not (project := Project.objects.filter(key=f"www-project-{project_key}").first()):
+        raise Http404
 
-    if pdf := generate_latest_metrics_pdf(project_key):
+    if pdf := generate_latest_metrics_pdf(
+        ProjectHealthMetrics.get_latest_health_metrics().filter(project=project).first()
+    ):
         return FileResponse(
             pdf,
             as_attachment=True,
             filename=f"{project_key}_health_metrics_report.pdf",
         )
 
-    return HttpResponseNotFound("No health metrics found for this project")
+    raise Http404

backend/apps/owasp/utils/pdf.py

@@ -7,6 +7,7 @@
 from reportlab.pdfgen.canvas import Canvas
 from reportlab.platypus import Table, TableStyle
 
+from apps.owasp.api.internal.nodes.project_health_stats import ProjectHealthStatsNode
 from apps.owasp.models.project_health_metrics import ProjectHealthMetrics
 
 
@@ -29,15 +30,16 @@ def create_table(data, col_widths="*"):
     )
 
 
-def generate_metrics_overview_pdf() -> BytesIO:
+def generate_metrics_overview_pdf(metrics_stats: ProjectHealthStatsNode) -> BytesIO:
     """Generate a PDF overview of project health metrics.
 
+    Args:
+        metrics_stats: The project health stats node.
+
     Returns:
         BytesIO: PDF content as bytes.
 
     """
-    metrics_stats = ProjectHealthMetrics.get_stats()
-
     buffer = BytesIO()
     canvas = Canvas(buffer)
     canvas.setFont("Helvetica", 12)
@@ -84,22 +86,16 @@ def generate_metrics_overview_pdf() -> BytesIO:
     return buffer
 
 
-def generate_latest_metrics_pdf(project_key: str) -> BytesIO | None:
+def generate_latest_metrics_pdf(metrics: ProjectHealthMetrics) -> BytesIO | None:
     """Generate a PDF report of the latest health metrics for a project.
 
     Args:
-        project_key (str): The key of the OWASP project.
+        metrics (ProjectHealthMetrics): The project health metrics.
 
     Returns:
         BytesIO: A buffer containing the generated PDF report.
 
     """
-    metrics = (
-        ProjectHealthMetrics.get_latest_health_metrics()
-        .filter(project__key=f"www-project-{project_key}")
-        .first()
-    )
-
     if not metrics:
         return None
 
@@ -176,4 +172,5 @@ def generate_latest_metrics_pdf(project_key: str) -> BytesIO | None:
     pdf.showPage()
     pdf.save()
     buffer.seek(0)
+
     return buffer

backend/tests/apps/owasp/utils/pdf_test.py

@@ -65,7 +65,7 @@ def test_generate_overview_pdf(
             ),
         )
         mock_get_stats.return_value = metrics_stats
-        generate_metrics_overview_pdf()
+        generate_metrics_overview_pdf(metrics_stats)
         mock_bytes_io.assert_called_once()
         mock_canvas.assert_called_once_with(mock_bytes_io.return_value)
         canvas = mock_canvas.return_value
@@ -95,18 +95,21 @@ def test_generate_detailed_pdf(
     ):
         metrics = MagicMock(
             age_days=30,
+            age_days_requirement=365,
             contributors_count=20,
             forks_count=15,
             is_funding_requirements_compliant=True,
             is_leader_requirements_compliant=True,
             last_commit_days=5,
             last_commit_days_requirement=7,
             last_pull_request_days=2,
+            last_pull_request_days_requirement=30,
             last_release_days=10,
             last_release_days_requirement=14,
             open_issues_count=10,
             open_pull_requests_count=3,
             owasp_page_last_update_days=20,
+            owasp_page_last_update_days_requirement=90,
             project=MagicMock(name="Test Project", key="www-project-test"),
             recent_releases_count=1,
             score=85.0,
@@ -117,10 +120,7 @@ def test_generate_detailed_pdf(
             unanswered_issues_count=2,
             unassigned_issues_count=5,
         )
-        mock_get_latest_health_metrics.return_value.filter.return_value.first.return_value = (
-            metrics
-        )
-        generate_latest_metrics_pdf("test")
+        generate_latest_metrics_pdf(metrics)
         mock_bytes_io.assert_called_once()
         mock_canvas.assert_called_once_with(mock_bytes_io.return_value, pagesize=letter)
         canvas = mock_canvas.return_value

frontend/src/app/projects/dashboard/metrics/[projectKey]/page.tsx

@@ -68,7 +68,7 @@ const ProjectHealthMetricsDetails: FC = () => {
               <h1 className="text-2xl font-bold">{metricsLatest.projectName}</h1>
               <MetricsPDFButton
                 path={`${projectKey}/pdf`}
-                fileName={`${projectKey}-health-metrics.pdf`}
+                fileName={`${projectKey}-health-metrics`}
               />
             </div>
             <div className="flex items-center gap-2">

frontend/src/app/projects/dashboard/page.tsx

@@ -98,10 +98,7 @@ const ProjectsDashboardPage: FC = () => {
     <>
       <div className="mb-4 flex items-center justify-start">
         <h1 className="font-semibold">Project Health Dashboard Overview</h1>
-        <MetricsPDFButton
-          path="overview/pdf"
-          fileName="owasp-project-health-metrics-overview.pdf"
-        />
+        <MetricsPDFButton path="overview/pdf" fileName="owasp-project-health-metrics-overview" />
       </div>
       <div className="mt-4 grid grid-cols-1 gap-4 md:grid-cols-3">
         {projectsCardsItems.map((item) => (

frontend/src/server/fetchMetricsPDF.ts

@@ -1,5 +1,6 @@
 import { handleAppError } from 'app/global-error'
 import { API_URL } from 'utils/credentials'
+
 export const fetchMetricsPDF = async (path: string, fileName: string): Promise<void> => {
   const response = await fetch(`${API_URL}owasp/project-health-metrics/${path}`, {
     method: 'GET',
@@ -20,7 +21,7 @@ export const fetchMetricsPDF = async (path: string, fileName: string): Promise<v
     const url = window.URL.createObjectURL(blob)
     const link = document.createElement('a')
     link.href = url
-    link.setAttribute('download', `${fileName}_${new Date().toISOString().split('T')[0]}.pdf`)
+    link.setAttribute('download', `${fileName}-${new Date().toISOString().split('T')[0]}.pdf`)
     document.body.appendChild(link)
     link.click()
     document.body.removeChild(link)