From f4f561fd88b9d503f20d986461598a567b3ed29f Mon Sep 17 00:00:00 2001 From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com> Date: Wed, 18 Nov 2026 08:23:59 -0600 Subject: [PATCH] don't crash review maintainer when a manual event ends with no active segment The review maintainer read the label of every manual event message before checking its state, so an end message, which carries no label, raised a KeyError and killed the review process when the camera had no active segment. This happened when a recordings or enabled toggle, a completed manual event, or audio closed the segment of a still-open indefinite event, and on every plate expiry on dedicated LPR cameras with detections disabled. With the process dead, no review items were created and alert/detection-only retention deleted all new recordings until restart. End messages with no active segment now drop the event from the indefinite events and are otherwise ignored. --- frigate/review/maintainer.py | 7 ++++ frigate/test/test_review_flow.py | 64 ++++++++++++++++++++++++++++++-- 2 files changed, 67 insertions(+), 4 deletions(-) diff --git a/frigate/review/maintainer.py b/frigate/review/maintainer.py index f7a665c6db..dc92ab0d54 100644 --- a/frigate/review/maintainer.py +++ b/frigate/review/maintainer.py @@ -1007,6 +1007,13 @@ class ReviewSegmentMaintainer(threading.Thread): ) ) elif topic == DetectionTypeEnum.api: + # the event's segment has already ended + if manual_info["state"] == ManualEventState.end: + self.indefinite_events[camera].pop( + manual_info["event_id"], None + ) + continue + severity = self.get_manual_event_severity( camera, manual_info["label"] ) diff --git a/frigate/test/test_review_flow.py b/frigate/test/test_review_flow.py index ebf7b981b7..314775161a 100644 --- a/frigate/test/test_review_flow.py +++ b/frigate/test/test_review_flow.py @@ -862,20 +862,41 @@ class TestSplitDetectionLabels(ReviewFlowTestCase): class TestManualEvents(ReviewFlowTestCase): def manual_event( - self, event_id: str, frame_time: float, sub_label: str | None = None + self, + event_id: str, + frame_time: float, + sub_label: str | None = None, + state: ManualEventState = ManualEventState.complete, ) -> tuple[str, tuple[Any, ...]]: - """Build a completed manual event as published by the object processor.""" + """Build a manual event as published by the object processor.""" return ( DetectionTypeEnum.api.value, ( CAMERA, frame_time, { - "state": ManualEventState.complete, + "state": state, "label": "person", "sub_label": sub_label, "event_id": event_id, - "end_time": frame_time + 5, + "end_time": ( + frame_time + 5 if state == ManualEventState.complete else None + ), + }, + ), + ) + + def end_event(self, event_id: str, end_time: float) -> tuple[str, tuple[Any, ...]]: + """Build the end message the events API publishes, which has no label.""" + return ( + DetectionTypeEnum.api.value, + ( + CAMERA, + end_time, + { + "state": ManualEventState.end, + "event_id": event_id, + "end_time": end_time, }, ), ) @@ -900,6 +921,41 @@ class TestManualEvents(ReviewFlowTestCase): self.assertCountEqual(data["objects"], ["dog", "person-verified", "person"]) self.assertEqual(data["sub_labels"], ["Bob"]) + def test_ending_event_after_its_segment_closed_is_ignored(self) -> None: + self.feed_messages(self.manual_event("m1", 1, state=ManualEventState.start)) + self.maintainer.config_subscriber.check_for_updates.side_effect = [ + {"record": [CAMERA]} + ] + self.feed() + self.maintainer.config_subscriber.check_for_updates.side_effect = None + self.feed_messages(self.end_event("m1", 20), self.manual_event("m2", 30)) + + self.assertEqual(self.non_update_summary(), [("end", "alert")]) + segment = self.maintainer.active_review_segments[CAMERA] + self.assertEqual(segment.detections, {"m2": "person"}) + + def test_ending_event_after_its_segment_ended_early_clears_it(self) -> None: + # a completed event ends the indefinite event's segment early + self.feed_messages( + self.manual_event("m1", 1, state=ManualEventState.start), + self.manual_event("m2", 2), + ) + self.feed((8, []), (8 + self.alert_cutoff, [])) + self.assertIsNone(self.maintainer.active_review_segments.get(CAMERA)) + + self.feed_messages( + self.end_event("m1", 100), + self.manual_event("m3", 200, state=ManualEventState.start), + self.end_event("m3", 210), + ) + self.feed((210 + self.alert_cutoff + 1, [])) + + self.assertEqual(self.maintainer.indefinite_events[CAMERA], {}) + self.assertIsNone(self.maintainer.active_review_segments.get(CAMERA)) + self.assertEqual( + self.non_update_summary(), [("end", "alert"), ("end", "alert")] + ) + if __name__ == "__main__": unittest.main()