Implement the "Clear Events" function

CHANGELOG.md

@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
 - Add date filters in the Log page
 - Upgrade to cronsim 2.3
 - Add support for the $BODY placeholder in webhook payloads (#708)
+- Implement the "Clear Events" function
 
 ### Bug Fixes
 - Fix the handling of TooManyRedirects exceptions

hc/front/tests/test_clear_events.py

@@ -0,0 +1,67 @@
+from django.utils.timezone import now
+from hc.api.models import Check, Ping
+from hc.test import BaseTestCase
+
+
+class ClearEventsTestCase(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.check = Check.objects.create(project=self.project)
+        self.check.last_ping = now()
+        self.check.n_pings = 1
+        self.check.save()
+
+        Ping.objects.create(owner=self.check, n=1)
+
+        self.clear_url = f"/checks/{self.check.code}/clear_events/"
+        self.redirect_url = f"/checks/{self.check.code}/details/"
+
+    def test_it_works(self):
+        self.client.login(username="alice@example.org", password="password")
+        r = self.client.post(self.clear_url)
+        self.assertRedirects(r, self.redirect_url)
+
+        self.check.refresh_from_db()
+        self.assertIsNone(self.check.last_ping)
+        self.assertFalse(self.check.ping_set.exists())
+
+    def test_team_access_works(self):
+        # Logging in as bob, not alice. Bob has team access so this
+        # should work.
+        self.client.login(username="bob@example.org", password="password")
+        r = self.client.post(self.clear_url)
+        self.assertRedirects(r, self.redirect_url)
+
+        self.check.refresh_from_db()
+        self.assertIsNone(self.check.last_ping)
+
+    def test_it_handles_bad_uuid(self):
+        self.client.login(username="alice@example.org", password="password")
+        r = self.client.post("/checks/not-uuid/clear_events/")
+        self.assertEqual(r.status_code, 404)
+
+    def test_it_checks_owner(self):
+        self.client.login(username="charlie@example.org", password="password")
+        r = self.client.post(self.clear_url)
+        self.assertEqual(r.status_code, 404)
+
+    def test_it_handles_missing_uuid(self):
+        # Valid UUID but there is no check for it:
+        url = "/checks/6837d6ec-fc08-4da5-a67f-08a9ed1ccf62/clear_events/"
+
+        self.client.login(username="alice@example.org", password="password")
+        r = self.client.post(url)
+        self.assertEqual(r.status_code, 404)
+
+    def test_it_rejects_get(self):
+        self.client.login(username="alice@example.org", password="password")
+        r = self.client.get(self.clear_url)
+        self.assertEqual(r.status_code, 405)
+
+    def test_it_requires_rw_access(self):
+        self.bobs_membership.role = "r"
+        self.bobs_membership.save()
+
+        self.client.login(username="bob@example.org", password="password")
+        r = self.client.post(self.clear_url)
+        self.assertEqual(r.status_code, 403)

hc/front/tests/test_remove_check.py

@@ -6,8 +6,8 @@ class RemoveCheckTestCase(BaseTestCase):
     def setUp(self):
         super().setUp()
         self.check = Check.objects.create(project=self.project)
-        self.remove_url = "/checks/%s/remove/" % self.check.code
-        self.redirect_url = "/projects/%s/checks/" % self.project.code
+        self.remove_url = f"/checks/{self.check.code}/remove/"
+        self.redirect_url = f"/projects/{self.project.code}/checks/"
 
     def test_it_works(self):
         self.client.login(username="alice@example.org", password="password")
@@ -47,11 +47,6 @@ class RemoveCheckTestCase(BaseTestCase):
         r = self.client.get(self.remove_url)
         self.assertEqual(r.status_code, 405)
 
-    def test_it_allows_cross_team_access(self):
-        self.client.login(username="bob@example.org", password="password")
-        r = self.client.post(self.remove_url)
-        self.assertRedirects(r, self.redirect_url)
-
     def test_it_requires_rw_access(self):
         self.bobs_membership.role = "r"
         self.bobs_membership.save()

hc/front/urls.py

@@ -10,6 +10,7 @@ check_urls = [
     path("pause/", views.pause, name="hc-pause"),
     path("resume/", views.resume, name="hc-resume"),
     path("remove/", views.remove_check, name="hc-remove-check"),
+    path("clear_events/", views.clear_events, name="hc-clear-events"),
     path("log/", views.log, name="hc-log"),
     path("status/", views.status_single, name="hc-status-single"),
     path("last_ping/", views.ping_details, name="hc-last-ping"),

hc/front/views.py

@@ -7,7 +7,9 @@ import re
 from secrets import token_urlsafe
 import sqlite3
 import sys
+from typing import Tuple
 from urllib.parse import urlencode, urlparse
+from uuid import UUID
 
 from cron_descriptor import ExpressionDescriptor
 from cronsim import CronSim, CronSimError
@@ -19,6 +21,7 @@ from django.core.exceptions import PermissionDenied
 from django.db.models import Count, F
 from django.http import (
     Http404,
+    HttpRequest,
     HttpResponse,
     HttpResponseBadRequest,
     HttpResponseForbidden,
@@ -88,7 +91,7 @@ def _tags_statuses(checks):
     return tags, num_down
 
 
-def _get_check_for_user(request, code):
+def _get_check_for_user(request: HttpRequest, code: UUID) -> Tuple[Check, bool]:
     """Return specified check if current user has access to it."""
 
     assert request.user.is_authenticated
@@ -104,7 +107,7 @@ def _get_check_for_user(request, code):
     return check, membership.is_rw
 
 
-def _get_rw_check_for_user(request, code):
+def _get_rw_check_for_user(request: HttpRequest, code: UUID) -> Check:
     check, rw = _get_check_for_user(request, code)
     if not rw:
         raise PermissionDenied
@@ -676,7 +679,7 @@ def resume(request, code):
 
 @require_POST
 @login_required
-def remove_check(request, code):
+def remove_check(request: HttpRequest, code: UUID) -> HttpResponse:
     check = _get_rw_check_for_user(request, code)
 
     project = check.project
@@ -684,6 +687,26 @@ def remove_check(request, code):
     return redirect("hc-checks", project.code)
 
 
+@require_POST
+@login_required
+def clear_events(request: HttpRequest, code: UUID) -> HttpResponse:
+    check = _get_rw_check_for_user(request, code)
+
+    check.status = "new"
+    check.last_ping = None
+    check.last_start = None
+    check.last_duration = None
+    check.has_confirmation_link = False
+    check.alert_after = None
+    check.save()
+
+    check.ping_set.all().delete()
+    check.notification_set.all().delete()
+    check.flip_set.all().delete()
+
+    return redirect("hc-details", code)
+
+
 def _get_events(check, page_limit, start=None, end=None):
     pings = check.visible_pings.order_by("-id")
     if start and end:

templates/front/clear_events_modal.html

@@ -0,0 +1,23 @@
+<div id="clear-events-modal" class="modal">
+    <div class="modal-dialog">
+        <form action="{% url 'hc-clear-events' check.code %}" method="post">
+            {% csrf_token %}
+            <div class="modal-content">
+                <div class="modal-header">
+                    <button type="button" class="close" data-dismiss="modal">&times;</button>
+                    <h4>Clear Events for  <span class="remove-check-name">{{ check.name_then_code }}</span></h4>
+                </div>
+                <div class="modal-body">
+                    <p>You are about to clear all logged pings and notifications for the check
+                        <strong class="remove-check-name">{{ check.name_then_code }}</strong>.
+                    </p>
+                    <p>Are you sure?</p>
+                </div>
+                <div class="modal-footer">
+                    <button type="button" class="btn btn-default" data-dismiss="modal">Cancel</button>
+                    <button type="submit" class="btn btn-danger">Clear Events</button>
+                </div>
+            </div>
+        </form>
+    </div>
+</div>

templates/front/details.html

@@ -256,6 +256,10 @@
                     Transfer<span class="hidden-sm hidden-xs"> to Another Project</span>&hellip;
                 </button>
                 &nbsp;
+                <button
+                    data-toggle="modal"
+                    data-target="#clear-events-modal"
+                    class="btn btn-sm btn-remove">Clear Events</button>
                 <button
                     data-toggle="modal"
                     data-target="#remove-check-modal"
@@ -316,6 +320,7 @@
 {% include "front/update_timeout_modal.html" %}
 {% include "front/show_usage_modal.html" %}
 {% include "front/remove_check_modal.html" %}
+{% include "front/clear_events_modal.html" %}
 {% include "front/filtering_rules_modal.html" %}
 {% include "front/copy_modal.html" %}