fix: don't fail if sentry doesn't return stats

Author: Kl0ven

controller/sentry/detector.py

@@ -4,6 +4,7 @@
 from copy import copy
 from statistics import mean, stdev
 
+from controller.sentry.exceptions import SentryNoOutcomeException
 from controller.sentry.models import Project
 
 
@@ -79,13 +80,16 @@ def compute_sentry(self, stats: dict) -> tuple[OrderedDict, dict[str, list]]:
         Returns:
             OrderedDict: Annotated signal
             dict[str, list]: Full algorithm results
+
+        Raises:
+            SentryNoOutcomeException: When there is no series with accepted outcome
         """
         series = next(
             (group["series"]["sum(quantity)"] for group in stats["groups"] if group["by"]["outcome"] == "accepted"),
             None,
         )
         if series is None:
-            raise ValueError("No series with accepted outcome")
+            raise SentryNoOutcomeException("No series with accepted outcome")
 
         signal, avg_filter, std_filter = self.compute(series)
 

controller/sentry/exceptions.py

@@ -0,0 +1,9 @@
+"""Exceptions."""
+
+
+class SentryException(Exception):
+    """All sentry related Exception."""
+
+
+class SentryNoOutcomeException(Exception):
+    """Exception Raised when sentry doesn't return any stats."""

controller/sentry/tasks.py

@@ -12,6 +12,7 @@
 
 from controller.sentry.choices import EventType
 from controller.sentry.detector import SpikesDetector
+from controller.sentry.exceptions import SentryNoOutcomeException
 from controller.sentry.models import App, Event, Project
 from controller.sentry.webservices.sentry import PaginatedSentryClient
 
@@ -133,7 +134,10 @@ def perform_detect(sentry_id) -> None:
 
     stats = client.get_stats(project.sentry_id)
     detector = SpikesDetector.from_project(project)
-    res, dump = detector.compute_sentry(stats)
+    try:
+        res, dump = detector.compute_sentry(stats)
+    except SentryNoOutcomeException:
+        return
 
     project.detection_result = dump
     project.save()

controller/sentry/tests/test_detector.py

@@ -3,6 +3,7 @@
 import pytest
 
 from controller.sentry.detector import SpikesDetector
+from controller.sentry.exceptions import SentryNoOutcomeException
 from controller.sentry.models import Project
 
 
@@ -41,5 +42,5 @@ def test_spike_detector_empty():
     assert detector.threshold == project.detection_param["threshold"]
     assert detector.influence == project.detection_param["influence"]
 
-    with pytest.raises(ValueError):
+    with pytest.raises(SentryNoOutcomeException):
         detector.compute_sentry({"groups": []})

controller/sentry/tests/test_tasks.py

@@ -8,6 +8,7 @@
 from django.utils import timezone
 
 from controller.sentry.choices import EventType
+from controller.sentry.exceptions import SentryNoOutcomeException
 from controller.sentry.models import App, Event, Project
 from controller.sentry.tasks import (
     close_window,
@@ -185,3 +186,27 @@ def test_perform_detect(spike_detector_mock: MagicMock, client_mock: MagicMock):
     project.refresh_from_db()
     assert project.events.exclude(reference=event.reference).count() == 2
     assert project.detection_result == dump
+
+
+@patch("controller.sentry.tasks.PaginatedSentryClient")
+@patch("controller.sentry.tasks.SpikesDetector")
+@pytest.mark.django_db
+def test_perform_detect_no_data(spike_detector_mock: MagicMock, client_mock: MagicMock):
+    sentry_id = "123"
+    project = Project(sentry_id=sentry_id)
+    project.save()
+
+    detector: MagicMock = spike_detector_mock.from_project.return_value
+    dump = {"test": "a"}
+    detector.compute_sentry.side_effect = SentryNoOutcomeException
+
+    perform_detect(sentry_id)
+
+    client_mock.assert_called_once_with()
+    client_mock.return_value.get_stats.assert_called_once_with(sentry_id)
+
+    spike_detector_mock.from_project.assert_called_once_with(project)
+
+    project.refresh_from_db()
+    assert project.events.count() == 0
+    assert project.detection_result is None

docs/how_does_it_work.rst

@@ -46,7 +46,7 @@ If you still reach your sentry quotas, you can enable the panic mode. This mode
 
 
 Smart Features
--------------
+--------------
 Every hour the controller fetch every project stats on Sentry. Using this stats we can detect misbehaving apps.
 For each misbehaving we create one :class:`event <controller.sentry.models.Event>` when the surge in transaction starts and one when it's end.
 

docs/references/sentry.rst

@@ -22,11 +22,12 @@ Submodules
    sentry/auth
    sentry/choices
    sentry/detector
+   sentry/exceptions
    sentry/forms
    sentry/inlines
    sentry/mixins
    sentry/models
    sentry/serializers
    sentry/tasks
    sentry/utils
-   sentry/views
+   sentry/views

docs/references/sentry/exceptions.rst

@@ -0,0 +1,7 @@
+Exceptions
+==========
+
+.. automodule:: controller.sentry.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance: