fix: Allow querying for reviews with neither reviewed/unreviewed. (#1040)

Author: dermotduffy

custom_components/frigate/api.py

@@ -133,7 +133,7 @@ async def async_get_reviews(
         after: float | None = None,
         before: float | None = None,
         limit: int | None = None,
-        reviewed: bool = False,
+        reviewed: bool | None = None,
         decode_json: bool = True,
     ) -> list[dict[str, Any]]:
         """Get review items from the API."""
@@ -145,7 +145,7 @@ async def async_get_reviews(
             "after": after,
             "before": before,
             "limit": limit,
-            "reviewed": int(reviewed),
+            "reviewed": int(reviewed) if reviewed is not None else None,
         }
 
         return cast(

custom_components/frigate/ws_api.py

@@ -249,7 +249,7 @@ async def ws_get_reviews(
                 msg.get("after"),
                 msg.get("before"),
                 msg.get("limit"),
-                msg.get("reviewed", False),
+                msg.get("reviewed"),
                 decode_json=False,
             ),
         )

tests/test_api.py

@@ -928,10 +928,10 @@ async def test_async_get_classification_model_classes_api_error(
     assert result == []
 
 
-async def test_async_get_reviews(
+async def test_async_get_reviews_unreviewed(
     aiohttp_session: aiohttp.ClientSession, aiohttp_server: Any
 ) -> None:
-    """Test async_get_reviews."""
+    """Test async_get_reviews with reviewed=False (unreviewed only)."""
     reviews_in = [
         {
             "id": "1735000000.123456-abc123",
@@ -978,6 +978,82 @@ async def reviews_handler(request: web.Request) -> web.Response:
     )
 
 
+async def test_async_get_reviews_reviewed(
+    aiohttp_session: aiohttp.ClientSession, aiohttp_server: Any
+) -> None:
+    """Test async_get_reviews with reviewed=True (reviewed only)."""
+    reviews_in = [
+        {
+            "id": "1735000000.123456-abc123",
+            "camera": "front_door",
+            "start_time": 1735000000.0,
+            "end_time": 1735000060.0,
+            "severity": "alert",
+            "thumb_path": "/media/frigate/clips/review/thumb.webp",
+            "data": {"detections": ["person"], "objects": ["person"]},
+        }
+    ]
+
+    async def reviews_handler(request: web.Request) -> web.Response:
+        """Reviews handler."""
+        _assert_request_params(
+            request,
+            {
+                "cameras": "test_camera",
+                "reviewed": "1",
+            },
+        )
+        return web.json_response(reviews_in)
+
+    server = await start_frigate_server(
+        aiohttp_server, [web.get("/api/review", reviews_handler)]
+    )
+
+    frigate_client = FrigateApiClient(str(server.make_url("/")), aiohttp_session)
+    assert reviews_in == await frigate_client.async_get_reviews(
+        cameras=["test_camera"],
+        reviewed=True,
+    )
+
+
+async def test_async_get_reviews_no_filter(
+    aiohttp_session: aiohttp.ClientSession, aiohttp_server: Any
+) -> None:
+    """Test async_get_reviews with reviewed=None (all reviews, no filter)."""
+    reviews_in = [
+        {
+            "id": "1735000000.123456-abc123",
+            "camera": "front_door",
+            "start_time": 1735000000.0,
+            "end_time": 1735000060.0,
+            "severity": "alert",
+            "thumb_path": "/media/frigate/clips/review/thumb.webp",
+            "data": {"detections": ["person"], "objects": ["person"]},
+        }
+    ]
+
+    async def reviews_handler(request: web.Request) -> web.Response:
+        """Reviews handler - should NOT have 'reviewed' param."""
+        # Verify 'reviewed' is NOT in the query params
+        assert "reviewed" not in request.query
+        _assert_request_params(
+            request,
+            {
+                "cameras": "test_camera",
+            },
+        )
+        return web.json_response(reviews_in)
+
+    server = await start_frigate_server(
+        aiohttp_server, [web.get("/api/review", reviews_handler)]
+    )
+
+    frigate_client = FrigateApiClient(str(server.make_url("/")), aiohttp_session)
+    assert reviews_in == await frigate_client.async_get_reviews(
+        cameras=["test_camera"],
+    )
+
+
 async def test_async_set_reviews_viewed(
     aiohttp_session: aiohttp.ClientSession, aiohttp_server: Any
 ) -> None:

tests/test_ws_api.py

@@ -657,8 +657,10 @@ async def test_unload_unsubscribes_from_events(
             response = await ws_client.receive_json()
 
 
-async def test_get_reviews_success(hass: HomeAssistant, hass_ws_client: Any) -> None:
-    """Test retrieving reviews successfully."""
+async def test_get_reviews_unreviewed_success(
+    hass: HomeAssistant, hass_ws_client: Any
+) -> None:
+    """Test retrieving unreviewed reviews (reviewed=False)."""
 
     mock_client = create_mock_frigate_client()
     await setup_mock_frigate_config_entry(hass, client=mock_client)
@@ -698,6 +700,80 @@ async def test_get_reviews_success(hass: HomeAssistant, hass_ws_client: Any) ->
     assert response["result"] == reviews_success
 
 
+async def test_get_reviews_reviewed_success(
+    hass: HomeAssistant, hass_ws_client: Any
+) -> None:
+    """Test retrieving reviewed reviews (reviewed=True)."""
+
+    mock_client = create_mock_frigate_client()
+    await setup_mock_frigate_config_entry(hass, client=mock_client)
+
+    ws_client = await hass_ws_client()
+    reviews_json = {
+        "id": 1,
+        "type": "frigate/reviews/get",
+        "instance_id": TEST_FRIGATE_INSTANCE_ID,
+        "cameras": [TEST_CAMERA],
+        "reviewed": True,
+    }
+
+    reviews_success = {"reviews": "data"}
+    mock_client.async_get_reviews = AsyncMock(return_value=reviews_success)
+    await ws_client.send_json(reviews_json)
+
+    response = await ws_client.receive_json()
+    mock_client.async_get_reviews.assert_called_with(
+        [TEST_CAMERA],
+        None,
+        None,
+        None,
+        None,
+        None,
+        None,
+        True,
+        decode_json=False,
+    )
+    assert response["success"]
+    assert response["result"] == reviews_success
+
+
+async def test_get_reviews_no_filter_success(
+    hass: HomeAssistant, hass_ws_client: Any
+) -> None:
+    """Test retrieving all reviews (no reviewed filter)."""
+
+    mock_client = create_mock_frigate_client()
+    await setup_mock_frigate_config_entry(hass, client=mock_client)
+
+    ws_client = await hass_ws_client()
+    reviews_json = {
+        "id": 1,
+        "type": "frigate/reviews/get",
+        "instance_id": TEST_FRIGATE_INSTANCE_ID,
+        "cameras": [TEST_CAMERA],
+        # No "reviewed" field - should pass None to the API
+    }
+
+    reviews_success = {"reviews": "data"}
+    mock_client.async_get_reviews = AsyncMock(return_value=reviews_success)
+    await ws_client.send_json(reviews_json)
+
+    response = await ws_client.receive_json()
+    mock_client.async_get_reviews.assert_called_with(
+        [TEST_CAMERA],
+        None,
+        None,
+        None,
+        None,
+        None,
+        None,
+        None,  # No reviewed filter
+        decode_json=False,
+    )
+    assert response["success"]
+    assert response["result"] == reviews_success
+
+
 async def test_get_reviews_instance_not_found(
     hass: HomeAssistant, hass_ws_client: Any
 ) -> None: