feat: add filter in admin

can filter on
 - env
 - command
 - is_spamming_sentry

Author: Kl0ven

controller/sentry/admin.py

@@ -19,6 +19,7 @@
 from django_object_actions import DjangoObjectActions, takes_instance_or_queryset
 
 from controller.sentry.choices import EventType, MetricType
+from controller.sentry.filters import IsSpammingListFilter
 from controller.sentry.forms import BumpForm, MetricForm
 from controller.sentry.inlines import AppEventInline, ProjectEventInline
 from controller.sentry.mixins import ChartMixin, PrettyTypeMixin, ProjectLinkMixin
@@ -181,6 +182,8 @@ class AppAdmin(
         "celery_collect_metrics",
     ]
 
+    list_filter = ["env", "command", IsSpammingListFilter]
+
     search_fields = ["reference", "project__sentry_project_slug", "env", "command"]
     ordering = search_fields
 

controller/sentry/filters.py

@@ -0,0 +1,55 @@
+"""Filters."""
+
+from typing import TYPE_CHECKING
+
+from django.contrib import admin
+from django.utils.translation import gettext_lazy as _
+
+from controller.sentry.choices import EventType
+
+if TYPE_CHECKING:  # pragma: no cover
+    from django.contrib.admin import ModelAdmin
+    from django.db.models import QuerySet
+    from django.http import HttpRequest
+
+    from controller.sentry.models import App
+
+
+class IsSpammingListFilter(admin.SimpleListFilter):
+    """Is Spamming filter."""
+
+    title = _("Spamming Sentry")
+
+    parameter_name = "spamming"
+
+    def lookups(self, request: "HttpRequest", model_admin: "ModelAdmin") -> tuple:
+        """Lookup.
+
+        Args:
+            request (HttpRequest): The request
+            model_admin (ModelAdmin): The admin
+
+        Returns:
+            tuple: The lookup field
+        """
+        return (
+            ("yes", _("Yes")),
+            ("no", _("No")),
+        )
+
+    def queryset(self, request: "HttpRequest", queryset: "QuerySet[App]") -> "QuerySet[App]":
+        """Return the filtered queryset.
+
+        Args:
+            request (HttpRequest): The request
+            queryset (QuerySet[App]): The queryset
+
+        Returns:
+            QuerySet[App]: The filtered queryset
+        """
+        if (value := self.value()) is None:
+            return queryset
+
+        event_type = EventType.FIRING if value == "no" else EventType.DISCARD
+
+        return queryset.filter(project__last_event__type=event_type)

controller/sentry/migrations/0013_project_last_event.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.1.6 on 2023-02-14 16:03
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("sentry", "0012_project_detection_result"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="project",
+            name="last_event",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="+",
+                to="sentry.event",
+            ),
+        ),
+    ]

controller/sentry/models.py

@@ -35,6 +35,7 @@ class Project(models.Model):
 
     detection_param = models.JSONField(default=partial(settings_default_value, "DEFAULT_SPIKE_DETECTION_PARAM"))
     detection_result = models.JSONField(blank=True, null=True)
+    last_event = models.ForeignKey("Event", null=True, blank=True, on_delete=models.SET_NULL, related_name="+")
 
     def __str__(self) -> str:
         """Return Project string."""

controller/sentry/tasks.py

@@ -161,3 +161,6 @@ def perform_detect(sentry_id) -> None:
         previous_signal = signal
 
     Event.objects.bulk_create(events)
+    if events:
+        project.last_event = events[-1]
+        project.save()

controller/sentry/tests/test_admin.py

@@ -9,6 +9,7 @@
 
 from controller.sentry.admin import AppAdmin
 from controller.sentry.choices import EventType
+from controller.sentry.filters import IsSpammingListFilter
 from controller.sentry.forms import BumpForm, MetricForm
 from controller.sentry.inlines import AppEventInline, ProjectEventInline
 from controller.sentry.models import App, Event, Project
@@ -456,3 +457,39 @@ def test_project_chart(super_call: Mock, admin_with_user):
     super_call.assert_called_once_with(request, project.sentry_id, "", None)
 
     assert response.context_data == expected_context
+
+
+@pytest.mark.parametrize("user_group", ["Developer"])
+@pytest.mark.admin_site(model_class=App)
+def test_app_filter(admin_with_user):
+    site, request = admin_with_user
+
+    project = Project.objects.create(sentry_id="123")
+    event = Event.objects.create(project=project, type=EventType.DISCARD, timestamp=timezone.now())
+    project.last_event = event
+    project.save()
+    app_discard = App.objects.create(reference="app_discard", project=project)
+
+    project = Project.objects.create(sentry_id="456")
+    event = Event.objects.create(project=project, type=EventType.FIRING, timestamp=timezone.now())
+    project.last_event = event
+    project.save()
+    app_firing = App.objects.create(reference="app_firing", project=project)
+
+    App.objects.create(reference="app_without")
+
+    filter_yes = IsSpammingListFilter(None, {"spamming": "yes"}, App, site)
+    filter_no = IsSpammingListFilter(None, {"spamming": "no"}, App, site)
+    filter_none = IsSpammingListFilter(None, {}, App, site)
+
+    assert filter_yes.lookups(request, site) == (("yes", "Yes"), ("no", "No"))
+
+    assert list(filter_yes.queryset(request, App.objects.all())) == list(
+        App.objects.filter(reference=app_discard.reference)
+    )
+
+    assert list(filter_no.queryset(request, App.objects.all())) == list(
+        App.objects.filter(reference=app_firing.reference)
+    )
+
+    assert list(filter_none.queryset(request, App.objects.all())) == list(App.objects.all())

controller/sentry/tests/test_tasks.py

@@ -185,6 +185,49 @@ 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.last_event == project.events.last()
+    assert project.detection_result == dump
+
+
+@patch("controller.sentry.tasks.PaginatedSentryClient")
+@patch("controller.sentry.tasks.SpikesDetector")
+@pytest.mark.django_db
+def test_perform_detect_no_new(spike_detector_mock: MagicMock, client_mock: MagicMock):
+    sentry_id = "123"
+    project = Project(sentry_id=sentry_id)
+    project.save()
+
+    event = Event(project=project, type=EventType.DISCARD, timestamp=parser.parse("2023-02-01T17:00:00Z"))
+    event.save()
+
+    result = object()
+    client_mock.return_value.get_stats.return_value = result
+
+    detector: MagicMock = spike_detector_mock.from_project.return_value
+    dump = {"test": "a"}
+    detector.compute_sentry.return_value = (
+        OrderedDict(
+            [
+                ("2023-02-01T15:00:00Z", 0),
+                ("2023-02-01T16:00:00Z", 1),
+                ("2023-02-01T17:00:00Z", 0),
+            ]
+        ),
+        dump,
+    )
+
+    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)
+
+    detector.compute_sentry.assert_called_once_with(result)
+
+    project.refresh_from_db()
+    assert project.events.exclude(reference=event.reference).count() == 0
+    assert project.last_event is None
     assert project.detection_result == dump
 
 

docs/references/sentry.rst

@@ -23,6 +23,7 @@ Submodules
    sentry/choices
    sentry/detector
    sentry/exceptions
+   sentry/filters
    sentry/forms
    sentry/inlines
    sentry/mixins

docs/references/sentry/filters.rst

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