Fix #960: add endpoint to view queue content (#961)

* Fix #960: add endpoint to view queue content

* Fix text, but not root cause

* Fix root cause

* Rewrite dl queue fixture with @grahamalama suggestion

* Reduce amount of data in response

Author: leplatrem

jbi/router.py

@@ -75,6 +75,31 @@ async def bugzilla_webhook(
     return await execute_or_queue(webhook_request, queue, actions)
 
 
+@router.get(
+    "/dl_queue/",
+    dependencies=[Depends(api_key_auth)],
+)
+async def inspect_dl_queue(queue: Annotated[DeadLetterQueue, Depends(get_dl_queue)]):
+    """API for viewing queue content"""
+    bugs = await queue.retrieve()
+    results = []
+    for items in bugs.values():
+        async for item in items:
+            results.append(
+                item.model_dump(
+                    include={
+                        "identifier": True,
+                        "error": True,
+                        "payload": {
+                            "bug": {"id", "whiteboard", "product", "component"},
+                            "event": {"action", "time"},
+                        },
+                    }
+                )
+            )
+    return results
+
+
 @router.get(
     "/whiteboard_tags/",
     dependencies=[Depends(api_key_auth)],

tests/conftest.py

@@ -15,7 +15,7 @@
 from jbi import Operation, bugzilla, jira
 from jbi.environment import Settings
 from jbi.models import ActionContext
-from jbi.queue import DeadLetterQueue
+from jbi.queue import DeadLetterQueue, get_dl_queue
 
 
 class FilteredLogCaptureFixture(pytest.LogCaptureFixture):
@@ -76,8 +76,10 @@ def mocked_statsd():
 
 
 @pytest.fixture
-def app():
-    return jbi.app.app
+def app(dl_queue):
+    app = jbi.app.app
+    app.dependency_overrides[get_dl_queue] = lambda: dl_queue
+    return app
 
 
 @pytest.fixture
@@ -116,6 +118,11 @@ def mock_queue():
     return mock.MagicMock(spec=DeadLetterQueue)
 
 
+@pytest.fixture
+def dl_queue(tmp_path):
+    return DeadLetterQueue("file://" + str(tmp_path))
+
+
 @pytest.fixture(autouse=True)
 def mocked_bugzilla(request):
     if "no_mocked_bugzilla" in request.keywords:

tests/unit/test_environment.py

@@ -27,7 +27,7 @@ def test_sentry_dsn_no_url_string_raises():
 
 
 def dl_queue_dsn_allowed_schema(dsn):
-    Settings(dl_queue_dsn="file://tmp")
+    Settings(dl_queue_dsn="file://tmp/queue")
 
 
 @pytest.mark.parametrize("dsn", ["http://www.example.com", "foobar"])

tests/unit/test_router.py

@@ -23,6 +23,7 @@ def test_read_root(anon_client):
     "endpoint",
     [
         "/whiteboard_tags",
+        "/dl_queue/",
         "/jira_projects/",
         "/powered_by_jbi/",
         "/bugzilla_webhooks/",
@@ -74,6 +75,40 @@ def test_whiteboard_tags_filtered(authenticated_client):
     assert sorted(infos.keys()) == ["devtest"]
 
 
+@pytest.mark.asyncio
+async def test_dl_queue_endpoint(
+    dl_queue, authenticated_client, webhook_request_factory
+):
+    item = webhook_request_factory(event__time=datetime(1982, 5, 8, 9, 10))
+    exc = Exception("boom")
+    await dl_queue.track_failed(item, exc)
+
+    resp = authenticated_client.get("/dl_queue/")
+    results = resp.json()
+
+    [infos] = results
+    assert infos == {
+        "error": {
+            "description": "boom",
+            "details": "Exception: boom\n",
+            "type": "Exception",
+        },
+        "identifier": "1982-05-08 09:10:00+00:00-654321-create-error",
+        "payload": {
+            "bug": {
+                "component": "General",
+                "id": 654321,
+                "product": "JBI",
+                "whiteboard": "[devtest]",
+            },
+            "event": {
+                "action": "create",
+                "time": "1982-05-08T09:10:00+00:00",
+            },
+        },
+    }
+
+
 def test_powered_by_jbi(exclude_middleware, authenticated_client):
     resp = authenticated_client.get("/powered_by_jbi/")
     html = resp.text