Skip to content

Improve dashboard metrics list #1967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 6, 2025
Merged

Improve dashboard metrics list #1967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2b0e912
Fix duplicated metrics
ahmedxgouda Aug 4, 2025
d73b3a8
Remove inactive projects metrics
ahmedxgouda Aug 4, 2025
cc9b6a4
Apply suggestions
ahmedxgouda Aug 4, 2025
848244e
Merge branch 'main' into dashboard/metrics-improvement
ahmedxgouda Aug 6, 2025
9ce072f
Update comment
arkid15r Aug 6, 2025
6d7d47a
Merge branch 'main' into dashboard/metrics-improvement
arkid15r Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions backend/apps/owasp/api/internal/ordering/project_health_metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""OWASP Project Health Metrics Ordering."""

from strawberry import auto
import strawberry
from strawberry_django import order_type

from apps.owasp.models.project_health_metrics import ProjectHealthMetrics
Expand All @@ -10,4 +10,10 @@
class ProjectHealthMetricsOrder:
"""Ordering for Project Health Metrics."""

score: auto
score: strawberry.auto

# We need to order by another field in case of equal scores
# to ensure unique metrics in pagination.
# The ORM returns random ordered query set if no order is specified.
# We don't do ordering in the model since we order already in the query.
project__name: strawberry.auto
Copy link
Collaborator

@arkid15r arkid15r Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason for having __ in the name?

Copy link
Collaborator Author

@ahmedxgouda ahmedxgouda Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

strawberry use these attributes in the order_by method. project_name is not an attribute of the metrics but it is an attribute of the project. And like we access nested attributes in django methods, strawberry does the same.

3 changes: 2 additions & 1 deletion backend/apps/owasp/models/project_health_metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,8 @@ def get_latest_health_metrics() -> models.QuerySet["ProjectHealthMetrics"]:
ProjectHealthMetrics.objects.filter(project=models.OuterRef("project"))
.order_by("-nest_created_at")
.values("nest_created_at")[:1]
)
),
project__is_active=True,
)

@staticmethod
Expand Down
7 changes: 3 additions & 4 deletions backend/tests/apps/owasp/api/internal/ordering/project_health_metrics_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,11 @@ def test_order_fields(self):
order_fields = {
field.name for field in ProjectHealthMetricsOrder.__strawberry_definition__.fields
}
expected_fields = {"score"}
expected_fields = {"score", "project__name"}
assert expected_fields == order_fields

def test_order_by(self):
"""Test ordering by score."""
order_instance = ProjectHealthMetricsOrder(
score="DESC",
)
order_instance = ProjectHealthMetricsOrder(score="DESC", project__name="ASC")
assert order_instance.score == "DESC"
assert order_instance.project__name == "ASC"
14 changes: 12 additions & 2 deletions frontend/src/app/projects/dashboard/metrics/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,12 @@ const MetricsPage: FC = () => {
variables: {
filters,
pagination: { offset: 0, limit: PAGINATION_LIMIT },
ordering,
ordering: [
ordering,
{
['project_Name']: 'ASC',
Copy link
Collaborator

@arkid15r arkid15r Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What naming convention was used here?

Copy link
Collaborator Author

@ahmedxgouda ahmedxgouda Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is automatically converted by strawberry. Since the attribute is project__name, it is handled like other attributes. Just first underscore removed and capitalize the second name.

Copy link
Collaborator

@arkid15r arkid15r Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how it works though. Let's merge it as is and improve sorting capabilities later.

},
],
},
})

Expand Down Expand Up @@ -246,7 +251,12 @@ const MetricsPage: FC = () => {
variables: {
filters,
pagination: newPagination,
ordering,
ordering: [
ordering,
{
['project_Name']: 'ASC',
},
],
},
updateQuery: (prev, { fetchMoreResult }) => {
if (!fetchMoreResult) return prev
Expand Down