feat: add delete history command

Author: janezicmatej

.env.example.prod

@@ -37,6 +37,12 @@ ALLOWED_ORIGINS=csv,includehttp
 # into swagger
 # INJECT_SWAGGER_X_API_KEY_HEADER_AUTH=true
 
+# History older than this many rounds will get dropped. There are 960 round
+# each day so 30 * 960 = 28800 means there will be 30 days of history kept.
+# You can comment this out to never delete history. In this case it is suggested
+# to also comment out the delte_history service from docker compose.
+HISTORY_KEEP_ROUNDS = 28800
+
 # project related
 
 # CONFIG_MODULE: one of: flare, songbird, coston2, coston

docker-compose.yaml

@@ -51,5 +51,14 @@ services:
       django:
         condition: service_healthy
 
+  delete-history:
+    <<: *django
+    command: python manage.py delete_history
+    depends_on:
+      db:
+        condition: service_healthy
+      django:
+        condition: service_healthy
+
 volumes:
   pg_data:

fsp/management/__init__.py

@@ -0,0 +1,33 @@
+import time
+
+from django.conf import settings
+from django.core.management.base import BaseCommand
+from django.db import transaction
+
+from fdc.models import AttestationResult
+from fsp.epoch import VotingEpoch
+from fsp.models import ProtocolMessageRelayed
+from ftso.models import FeedResult, RandomResult
+
+
+class Command(BaseCommand):
+    def handle(self, *args, **options):
+        history_rounds: int | None = settings.HISTORY_KEEP_ROUNDS
+        if history_rounds is None:
+            return
+
+        while True:
+            time.sleep(600)
+
+            voting_epoch_now = VotingEpoch.now().n
+            voting_round = VotingEpoch(voting_epoch_now - history_rounds)
+
+            with transaction.atomic():
+                AttestationResult.objects.filter(
+                    voting_round_id__lt=voting_round
+                ).delete()
+                FeedResult.objects.filter(voting_round_id__lt=voting_round).delete()
+                RandomResult.objects.filter(voting_round_id__lt=voting_round).delete()
+                ProtocolMessageRelayed.objects.filter(
+                    voting_round_id__lt=voting_round
+                ).delete()

fsp/management/commands/__init__.py

@@ -170,4 +170,10 @@
 
 # END OF DEPENDENCY SETTINGS
 
+_HISTORY_KEEP_ROUNDS = os.environ.get("HISTORY_KEEP_ROUNDS", "")
+try:
+    HISTORY_KEEP_ROUNDS = int(_HISTORY_KEEP_ROUNDS)
+except ValueError:
+    HISTORY_KEEP_ROUNDS = None
+
 CONFIG_MODULE = os.environ.get("CONFIG_MODULE", None)