Skip to content

fix: sorting audit by progress regression on pagination #1886

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion backend/core/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,7 @@ def viewable_items(model, folder_id=None):
viewable_requirement_assessments = viewable_items(RequirementAssessment, folder_id)
controls_count = viewable_controls.count()
progress_avg = math.ceil(
mean([x.progress for x in viewable_compliance_assessments] or [0])
mean([x.get_progress() for x in viewable_compliance_assessments] or [0])
)
missed_eta_count = (
viewable_controls.filter(
Expand Down
5 changes: 2 additions & 3 deletions backend/core/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -3073,7 +3073,7 @@ def upsert_daily_metrics(self):
"total": total,
"per_status": per_status,
"per_result": per_result,
"progress_perc": self.progress,
"progress_perc": self.get_progress(),
"score": self.get_global_score(),
},
}
Expand Down Expand Up @@ -3684,8 +3684,7 @@ def assign_attributes(target, attributes):

return requirement_assessments

@property
def progress(self) -> int:
def get_progress(self) -> int:
requirement_assessments = list(
self.get_requirement_assessments(include_non_assessable=False)
)
Expand Down
2 changes: 1 addition & 1 deletion backend/core/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -988,7 +988,7 @@ class ComplianceAssessmentReadSerializer(AssessmentReadSerializer):
selected_implementation_groups = serializers.ReadOnlyField(
source="get_selected_implementation_groups"
)
progress = serializers.ReadOnlyField()
progress = serializers.ReadOnlyField(source="get_progress")
assets = FieldsRelatedField(many=True)

class Meta:
Expand Down
70 changes: 49 additions & 21 deletions backend/core/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,17 @@
from datetime import date, datetime, timedelta
from typing import Dict, Any, List, Tuple
import time
from dateutil import relativedelta
from django.db.models import F, Count, Q, ExpressionWrapper, FloatField
from django.db.models import (
F,
Count,
Q,
ExpressionWrapper,
FloatField,
Value,
)
from django.db.models.functions import Greatest, Coalesce


from collections import defaultdict
import pytz
from uuid import UUID
Expand Down Expand Up @@ -42,7 +51,6 @@
from django.views.decorators.vary import vary_on_cookie
from django.core.cache import cache

from django.db.models import F, Q

from django.apps import apps
from django.contrib.auth.models import Permission
Expand Down Expand Up @@ -177,7 +185,7 @@ class BaseModelViewSet(viewsets.ModelViewSet):
# )
# return None

def get_queryset(self):
def get_queryset(self) -> models.query.QuerySet:
"""the scope_folder_id query_param allows scoping the objects to retrieve"""
if not self.model:
return None
Expand Down Expand Up @@ -2433,7 +2441,7 @@ def my_assignments(self, request):
audits_count = audits.count()
if audits_count > 0:
for audit in audits:
sum += audit.progress
sum += audit.get_progress()
avg_progress = int(sum / audits.count())

controls = (
Expand Down Expand Up @@ -2637,7 +2645,7 @@ def import_domain(self, request):
url_path="import-dummy",
)
def import_dummy_domain(self, request):
domain_name = f"DEMO"
domain_name = "DEMO"
try:
dummy_fixture_path = (
Path(settings.BASE_DIR) / "fixtures" / "dummy-domain.bak"
Expand Down Expand Up @@ -4006,22 +4014,42 @@ class ComplianceAssessmentViewSet(BaseModelViewSet):
]
search_fields = ["name", "description", "ref_id"]

def list(self, request, *args, **kwargs):
response = super().list(request, *args, **kwargs)

ordering = request.query_params.get("ordering", "")
ordering_fields = [field.strip() for field in ordering.split(",") if field]

if any(field.lstrip("-") == "progress" for field in ordering_fields):
reverse = ordering_fields[0].startswith("-") # use only first 'progress'
results = sorted(
response.data["results"], # assumes paginated response
key=lambda x: x.get("progress", 0),
reverse=reverse,
def get_queryset(self):
qs = super().get_queryset()
ordering = self.request.query_params.get("ordering", "")

if any(
field in ordering
for field in (
"total_requirements",
"assessed_requirements",
"progress",
)
response.data["results"] = results

return response
):
qs = qs.annotate(
total_requirements=Count(
"requirement_assessments",
filter=Q(requirement_assessments__requirement__assessable=True),
distinct=True,
),
assessed_requirements=Count(
"requirement_assessments",
filter=Q(
~Q(
requirement_assessments__result=RequirementAssessment.Result.NOT_ASSESSED
),
requirement_assessments__requirement__assessable=True,
),
distinct=True,
),
progress=ExpressionWrapper(
F("assessed_requirements")
* 1.0
/ Greatest(Coalesce(F("total_requirements"), Value(0)), Value(1)),
output_field=FloatField(),
),
)
return qs

@method_decorator(cache_page(60 * LONG_CACHE_TTL))
@action(detail=False, name="Get status choices")
Expand Down
4 changes: 3 additions & 1 deletion backend/tprm/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ def metrics(self, request):
entry.update({"completion": completion})

review_progress = (
ea.compliance_assessment.progress if ea.compliance_assessment else 0
ea.compliance_assessment.get_progress()
if ea.compliance_assessment
else 0
)
entry.update({"review_progress": review_progress})
assessments_data.append(entry)
Expand Down
Loading