Implement GraphQL resolvers for project health metrics (#1577)

* Add project_health_metrics node and query

* Add health field to the ProjectNode that represents sll ProjectHealthMetrics objects of the project

* Add tests

* Update filtering and add fields to models

* Update filtering

* Update tests

* Save new boolean values

* Add boolean mapping

* Add query tests

* Merge migrations

* Update filtering, add migrations, and update scripts

* Update tests and queries

* Add test with filters

* Update filtering

* Update tests

* Merge migrations

* Revert unnecessary work and apply suggestions

* Remove has_no_recent_commits from project

* Add missing fields for FE query

* Remove project name from the test

* Clean migrations

* Update code

---------

Co-authored-by: Arkadii Yakovets <[email protected]>

Author: ahmedxgouda

backend/apps/owasp/graphql/nodes/project.py

@@ -9,7 +9,9 @@
 from apps.github.graphql.nodes.release import ReleaseNode
 from apps.github.graphql.nodes.repository import RepositoryNode
 from apps.owasp.graphql.nodes.common import GenericEntityNode
+from apps.owasp.graphql.nodes.project_health_metrics import ProjectHealthMetricsNode
 from apps.owasp.models.project import Project
+from apps.owasp.models.project_health_metrics import ProjectHealthMetrics
 
 RECENT_ISSUES_LIMIT = 5
 RECENT_RELEASES_LIMIT = 5
@@ -34,6 +36,15 @@
 class ProjectNode(GenericEntityNode):
     """Project node."""
 
+    @strawberry.field
+    def health_metrics(self, limit: int = 30) -> list[ProjectHealthMetricsNode]:
+        """Resolve project health metrics."""
+        return ProjectHealthMetrics.objects.filter(
+            project=self,
+        ).order_by(
+            "-nest_created_at",
+        )[:limit]
+
     @strawberry.field
     def issues_count(self) -> int:
         """Resolve issues count."""

backend/apps/owasp/graphql/nodes/project_health_metrics.py

@@ -0,0 +1,51 @@
+"""OWASP Project Health Metrics Node."""
+
+import strawberry
+import strawberry_django
+
+from apps.owasp.models.project_health_metrics import ProjectHealthMetrics
+
+
+@strawberry_django.type(
+    ProjectHealthMetrics,
+    fields=[
+        "contributors_count",
+        "forks_count",
+        "is_funding_requirements_compliant",
+        "is_leader_requirements_compliant",
+        "open_issues_count",
+        "open_pull_requests_count",
+        "recent_releases_count",
+        "score",
+        "stars_count",
+        "unanswered_issues_count",
+        "unassigned_issues_count",
+    ],
+)
+class ProjectHealthMetricsNode:
+    """Project health metrics node."""
+
+    @strawberry.field
+    def age_days(self) -> int:
+        """Resolve project age in days."""
+        return self.age_days
+
+    @strawberry.field
+    def last_commit_days(self) -> int:
+        """Resolve last commit age in days."""
+        return self.last_commit_days
+
+    @strawberry.field
+    def last_pull_request_days(self) -> int:
+        """Resolve last pull request age in days."""
+        return self.last_pull_request_days
+
+    @strawberry.field
+    def last_release_days(self) -> int:
+        """Resolve last release age in days."""
+        return self.last_release_days
+
+    @strawberry.field
+    def owasp_page_last_update_days(self) -> int:
+        """Resolve OWASP page last update age in days."""
+        return self.owasp_page_last_update_days

backend/apps/owasp/management/commands/owasp_update_project_health_metrics_scores.py

@@ -60,7 +60,12 @@ def handle(self, *args, **options):
             metric.score = score
             project_health_metrics.append(metric)
 
-        ProjectHealthMetrics.bulk_save(project_health_metrics, fields=["score"])
+        ProjectHealthMetrics.bulk_save(
+            project_health_metrics,
+            fields=[
+                "score",
+            ],
+        )
         self.stdout.write(
             self.style.SUCCESS("Updated projects health metrics score successfully.")
         )

backend/tests/apps/owasp/graphql/nodes/project_health_metrics_test.py

@@ -0,0 +1,69 @@
+"""Test cases for ProjectHealthMetricsNode."""
+
+import pytest
+
+from apps.owasp.graphql.nodes.project_health_metrics import ProjectHealthMetricsNode
+
+
+class TestProjectHealthMetricsNode:
+    def test_project_health_metrics_node_inheritance(self):
+        assert hasattr(ProjectHealthMetricsNode, "__strawberry_definition__")
+
+    def test_meta_configuration(self):
+        field_names = {
+            field.name for field in ProjectHealthMetricsNode.__strawberry_definition__.fields
+        }
+        expected_field_names = {
+            "age_days",
+            "contributors_count",
+            "forks_count",
+            "is_funding_requirements_compliant",
+            "is_leader_requirements_compliant",
+            "last_commit_days",
+            "last_pull_request_days",
+            "last_release_days",
+            "open_issues_count",
+            "open_pull_requests_count",
+            "owasp_page_last_update_days",
+            "recent_releases_count",
+            "score",
+            "stars_count",
+            "unanswered_issues_count",
+            "unassigned_issues_count",
+        }
+        assert expected_field_names.issubset(field_names)
+
+    def _get_field_by_name(self, name):
+        return next(
+            (
+                f
+                for f in ProjectHealthMetricsNode.__strawberry_definition__.fields
+                if f.name == name
+            ),
+            None,
+        )
+
+    @pytest.mark.parametrize(
+        ("field_name", "expected_type"),
+        [
+            ("age_days", int),
+            ("contributors_count", int),
+            ("forks_count", int),
+            ("is_funding_requirements_compliant", bool),
+            ("is_leader_requirements_compliant", bool),
+            ("last_commit_days", int),
+            ("last_pull_request_days", int),
+            ("last_release_days", int),
+            ("open_issues_count", int),
+            ("open_pull_requests_count", int),
+            ("owasp_page_last_update_days", int),
+            ("stars_count", int),
+            ("recent_releases_count", int),
+            ("unanswered_issues_count", int),
+            ("unassigned_issues_count", int),
+        ],
+    )
+    def test_field_types(self, field_name, expected_type):
+        field = self._get_field_by_name(field_name)
+        assert field is not None
+        assert field.type is expected_type

backend/tests/apps/owasp/graphql/nodes/project_test.py

@@ -6,6 +6,7 @@
 from apps.github.graphql.nodes.release import ReleaseNode
 from apps.github.graphql.nodes.repository import RepositoryNode
 from apps.owasp.graphql.nodes.project import ProjectNode
+from apps.owasp.graphql.nodes.project_health_metrics import ProjectHealthMetricsNode
 
 
 class TestProjectNode:
@@ -43,6 +44,11 @@ def _get_field_by_name(self, name):
             (f for f in ProjectNode.__strawberry_definition__.fields if f.name == name), None
         )
 
+    def test_resolve_health_metrics(self):
+        field = self._get_field_by_name("health_metrics")
+        assert field is not None
+        assert field.type.of_type is ProjectHealthMetricsNode
+
     def test_resolve_issues_count(self):
         field = self._get_field_by_name("issues_count")
         assert field is not None

backend/tests/apps/owasp/management/commands/owasp_update_project_health_metrics_scores_test.py

@@ -8,7 +8,7 @@
 from apps.owasp.models.project_health_metrics import ProjectHealthMetrics
 from apps.owasp.models.project_health_requirements import ProjectHealthRequirements
 
-EXPECTED_SCORE = 52.0
+EXPECTED_SCORE = 34.0
 
 
 class TestUpdateProjectHealthMetricsScoreCommand:
@@ -41,16 +41,16 @@ def test_handle_successful_update(self):
             "forks_count": (5, 6),
             "last_release_days": (5, 6),
             "last_commit_days": (5, 6),
-            "open_issues_count": (5, 6),
+            "open_issues_count": (7, 6),
             "open_pull_requests_count": (5, 6),
             "owasp_page_last_update_days": (5, 6),
             "last_pull_request_days": (5, 6),
             "recent_releases_count": (5, 6),
             "stars_count": (5, 6),
             "total_pull_requests_count": (5, 6),
             "total_releases_count": (5, 6),
-            "unanswered_issues_count": (5, 6),
-            "unassigned_issues_count": (5, 6),
+            "unanswered_issues_count": (7, 6),
+            "unassigned_issues_count": (7, 6),
         }
 
         # Create mock metrics with test data
@@ -73,7 +73,12 @@ def test_handle_successful_update(self):
         self.mock_requirements.assert_called_once()
 
         # Check if score was calculated correctly
-        self.mock_bulk_save.assert_called_once_with([mock_metric], fields=["score"])
+        self.mock_bulk_save.assert_called_once_with(
+            [mock_metric],
+            fields=[
+                "score",
+            ],
+        )
         assert mock_metric.score == EXPECTED_SCORE
         assert "Updated projects health metrics score successfully." in self.stdout.getvalue()
         assert "Updating score for project: Test Project" in self.stdout.getvalue()