From 0feb86817f3a6e16af27b8182fd1f32b9532f77f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Farge?= <fr.farge96@gmail.com>
Date: Sat, 4 Jul 2020 15:23:15 +0200
Subject: [PATCH] Clean unfinished audits (#210)

* add audit parameters on audit __str__

* add task to clean unfinished audits

* add clean unfinished audits to populate-periodic-tasks
---
 backend/audits/tasks.py                             | 13 +++++++++++++
 backend/audits/views.py                             |  4 ++--
 .../management/commands/populate-periodic-tasks.py  |  8 ++++++++
 3 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/backend/audits/tasks.py b/backend/audits/tasks.py
index e72a32591..745b6f79b 100644
--- a/backend/audits/tasks.py
+++ b/backend/audits/tasks.py
@@ -298,6 +298,19 @@ def clean_old_audit_statuses():
             statuses.filter(status=AvailableStatuses.RUNNING.value).delete()
 
 
+@shared_task
+def clean_unfinished_audits():
+    """some audits may never finish and end up stuck in a loop. we need to remove those"""
+    finished_statuses = (AvailableStatuses.ERROR.value, AvailableStatuses.SUCCESS.value)
+    for audit in Audit.objects.prefetch_related("audit_status_history"):
+        if (
+            audit.audit_status_history.order_by("created_at").last().status
+            not in finished_statuses
+        ):
+            print(f"Deleting {audit.uuid}: {audit}")
+            audit.delete()
+
+
 @shared_task
 def get_wpt_audit_configurations(wpt_instance_url="https://webpagetest.org"):
     """gets all the available locations from WPT"""
diff --git a/backend/audits/views.py b/backend/audits/views.py
index 9d901d251..23db586ec 100644
--- a/backend/audits/views.py
+++ b/backend/audits/views.py
@@ -39,7 +39,7 @@ def request_audit(request, project_uuid):
                 AuditStatusHistory.objects.create(
                     audit=audit,
                     status=AvailableStatuses.REQUESTED.value,
-                    details="Audit created in database",
+                    details="Audit manually requested",
                 )
                 created_audits.append(audit)
 
@@ -49,7 +49,7 @@ def request_audit(request, project_uuid):
                 AuditStatusHistory.objects.create(
                     audit=audit,
                     status=AvailableStatuses.REQUESTED.value,
-                    details="Audit created in database",
+                    details="Audit manually requested",
                 )
                 created_audits.append(audit)
 
diff --git a/backend/core/management/commands/populate-periodic-tasks.py b/backend/core/management/commands/populate-periodic-tasks.py
index 27cc05ef1..9d0caf6a8 100644
--- a/backend/core/management/commands/populate-periodic-tasks.py
+++ b/backend/core/management/commands/populate-periodic-tasks.py
@@ -12,6 +12,9 @@ def handle(self, *args, **options):
         schedule_2, _ = CrontabSchedule.objects.get_or_create(
             minute="0", hour="2", day_of_week="*", day_of_month="*", month_of_year="*"
         )
+        schedule_3, _ = CrontabSchedule.objects.get_or_create(
+            minute="0", hour="3", day_of_week="*", day_of_month="*", month_of_year="*"
+        )
         schedule_7, _ = CrontabSchedule.objects.get_or_create(
             minute="0", hour="7", day_of_week="*", day_of_month="*", month_of_year="*"
         )
@@ -49,6 +52,11 @@ def handle(self, *args, **options):
             name="clean old audits statuses",
             task="audits.tasks.clean_old_audit_statuses",
         )
+        PeriodicTask.objects.create(
+            crontab=schedule_3,
+            name="clean unfinished audits",
+            task="audits.tasks.clean_unfinished_audits",
+        )
 
         schedule_seconds, _ = IntervalSchedule.objects.get_or_create(
             every=1, period=IntervalSchedule.SECONDS