Fix #963: Remove unused code (#964)

* Move listing to queue class

* Remove unused list(bug_id)

* Remove unused list_all()

Author: leplatrem

jbi/queue.py

@@ -31,7 +31,7 @@
 from functools import lru_cache
 from json import JSONDecodeError
 from pathlib import Path
-from typing import Any, AsyncIterator, List, Optional
+from typing import Any, AsyncIterator, Optional
 from urllib.parse import ParseResult, urlparse
 
 import dockerflow.checks
@@ -125,24 +125,6 @@ def get(self, bug_id: int) -> AsyncIterator[QueueItem]:
         """
         pass
 
-    @abstractmethod
-    async def list(self, bug_id: int) -> List[str]:
-        """Report a summary of all of the items in the queue for a bug
-
-        Returns:
-            a dict bug id, list of item identifier
-        """
-        pass
-
-    @abstractmethod
-    async def list_all(self) -> dict[int, List[str]]:
-        """Report a summary of all of the items in the queue
-
-        Returns:
-            a dict bug id, list of item identifiers
-        """
-        pass
-
     @abstractmethod
     async def get_all(self) -> dict[int, AsyncIterator[QueueItem]]:
         """Retrieve all items in the queue, grouped by bug
@@ -207,19 +189,6 @@ async def remove(self, bug_id: int, identifier: str):
             bug_dir.rmdir()
             logger.debug("Removed directory for bug %s", bug_id)
 
-    async def list(self, bug_id: int) -> List[str]:
-        bug_dir = self.location / str(bug_id)
-        return [path.stem for path in sorted(bug_dir.glob("*.json"))]
-
-    async def list_all(self) -> dict[int, List[str]]:
-        item_data: dict[int, List[str]] = {}
-        for filesystem_object in self.location.iterdir():
-            if filesystem_object.is_dir():
-                bug_id = int(filesystem_object.name)
-                item_ids = await self.list(bug_id=bug_id)
-                item_data[bug_id] = item_ids
-        return item_data
-
     async def get(self, bug_id: int) -> AsyncIterator[QueueItem]:
         folder = self.location / str(bug_id)
         if not folder.is_dir():
@@ -322,12 +291,6 @@ async def retrieve(self) -> dict[int, AsyncIterator[QueueItem]]:
         """
         return await self.backend.get_all()
 
-    async def list(self, bug_id: int) -> List[str]:
-        return await self.backend.list(bug_id=bug_id)
-
-    async def list_all(self) -> dict[int, List[str]]:
-        return await self.backend.list_all()
-
     async def size(self, bug_id=None):
         return await self.backend.size(bug_id=bug_id)
 

tests/unit/jira/test_queue.py

@@ -42,7 +42,7 @@ def test_filebackend_ping_fails(caplog, tmp_path):
 
 
 @pytest.mark.asyncio
-async def test_remove_last_item(backend: QueueBackend, queue_item_factory):
+async def test_backend_remove_last_item(backend: QueueBackend, queue_item_factory):
     """When we remove the last item for a bug, we also remove it's key from the
     backend"""
 
@@ -56,7 +56,7 @@ async def test_remove_last_item(backend: QueueBackend, queue_item_factory):
 
 
 @pytest.mark.asyncio
-async def test_clear(backend: QueueBackend, queue_item_factory):
+async def test_backend_clear(backend: QueueBackend, queue_item_factory):
     item_1 = queue_item_factory(payload__bug__id=123)
     item_2 = queue_item_factory(payload__bug__id=456)
 
@@ -69,7 +69,9 @@ async def test_clear(backend: QueueBackend, queue_item_factory):
 
 
 @pytest.mark.asyncio
-async def test_put_maintains_sorted_order(backend: QueueBackend, queue_item_factory):
+async def test_backend_put_maintains_sorted_order(
+    backend: QueueBackend, queue_item_factory
+):
     now = datetime.now()
     item_1 = queue_item_factory(payload__event__time=now + timedelta(minutes=1))
     item_2 = queue_item_factory(payload__event__time=now + timedelta(minutes=2))
@@ -86,40 +88,7 @@ async def test_put_maintains_sorted_order(backend: QueueBackend, queue_item_fact
 
 
 @pytest.mark.asyncio
-async def test_backend_list(backend: QueueBackend, queue_item_factory):
-    item = queue_item_factory(payload__bug__id=123)
-    await backend.put(item)
-    await backend.put(queue_item_factory(payload__bug__id=456))
-
-    [identifier] = await backend.list(123)
-    assert item.identifier == identifier
-
-
-@pytest.mark.asyncio
-async def test_backend_list_all(backend: QueueBackend, queue_item_factory):
-    for bug_id in (123, 123, 456, 456):
-        await backend.put(queue_item_factory(payload__bug__id=bug_id))
-
-    all_items = await backend.list_all()
-    assert len(all_items) == 2
-
-    for items in all_items.values():
-        assert len(items) == 2
-
-
-@pytest.mark.asyncio
-async def test_list_by_bug(backend: QueueBackend, queue_item_factory):
-    item_1 = queue_item_factory(payload__bug__id=123)
-    item_2 = queue_item_factory(payload__bug__id=456)
-
-    await backend.put(item_1)
-    await backend.put(item_2)
-    [identifier] = await backend.list(bug_id=123)
-    assert identifier == item_1.identifier
-
-
-@pytest.mark.asyncio
-async def test_list_ordering(backend: QueueBackend, queue_item_factory):
+async def test_backend_get_ordering(backend: QueueBackend, queue_item_factory):
     now = datetime.now()
     item_1 = queue_item_factory(payload__event__time=now + timedelta(minutes=1))
     item_2 = queue_item_factory(payload__event__time=now + timedelta(minutes=2))
@@ -131,13 +100,15 @@ async def test_list_ordering(backend: QueueBackend, queue_item_factory):
     await backend.put(item_3)
     await backend.put(item_4)
 
-    item_metadata = await backend.list(bug_id=item_1.payload.bug.id)
+    item_metadata = [
+        item.identifier async for item in backend.get(bug_id=item_1.payload.bug.id)
+    ]
     exptected_id_order = [item.identifier for item in [item_1, item_2, item_3, item_4]]
     assert exptected_id_order == item_metadata
 
 
 @pytest.mark.asyncio
-async def test_get_all(backend: QueueBackend, queue_item_factory):
+async def test_backend_get_all(backend: QueueBackend, queue_item_factory):
     now = datetime.now()
     item_1 = queue_item_factory(
         payload__bug__id=123, payload__event__time=now + timedelta(minutes=1)
@@ -164,7 +135,7 @@ async def test_get_all(backend: QueueBackend, queue_item_factory):
 
 
 @pytest.mark.asyncio
-async def test_get_all_invalid_json(backend: QueueBackend, queue_item_factory):
+async def test_backend_get_all_invalid_json(backend: QueueBackend, queue_item_factory):
     item_1 = queue_item_factory()
     await backend.put(item_1)
 
@@ -179,7 +150,7 @@ async def test_get_all_invalid_json(backend: QueueBackend, queue_item_factory):
 
 
 @pytest.mark.asyncio
-async def test_get_all_payload_doesnt_match_schema(
+async def test_backend_get_all_payload_doesnt_match_schema(
     backend: QueueBackend, queue_item_factory
 ):
     item_1 = queue_item_factory()
@@ -196,7 +167,7 @@ async def test_get_all_payload_doesnt_match_schema(
 
 
 @pytest.mark.asyncio
-async def test_get_invalid_json(backend: QueueBackend, queue_item_factory):
+async def test_backend_get_invalid_json(backend: QueueBackend, queue_item_factory):
     corrupt_file_dir = backend.location / "999"
     corrupt_file_dir.mkdir()
     corrupt_file_path = corrupt_file_dir / "xxx.json"
@@ -207,8 +178,7 @@ async def test_get_invalid_json(backend: QueueBackend, queue_item_factory):
     with pytest.raises(QueueItemRetrievalError):
         await anext(items)
 
-
-@pytest.mark.asyncio
+        
 async def test_get_missing_timezone(backend: QueueBackend, queue_item_factory):
     item = queue_item_factory.build(payload__bug__id=666)
     dump = item.model_dump()
@@ -226,8 +196,7 @@ async def test_get_missing_timezone(backend: QueueBackend, queue_item_factory):
     assert "2024-04-18T12:46:54Z" in item.model_dump_json(), "timezone put in dump"
 
 
-@pytest.mark.asyncio
-async def test_get_payload_doesnt_match_schema(
+async def test_backend_get_payload_doesnt_match_schema(
     backend: QueueBackend, queue_item_factory
 ):
     # this is invalid, as whiteboard should be a string
@@ -348,25 +317,3 @@ async def test_done(queue: DeadLetterQueue, queue_item_factory):
 
     await queue.done(item)
     assert await queue.backend.size() == 0
-
-
-@pytest.mark.asyncio
-async def test_queue_list(queue: DeadLetterQueue, queue_item_factory):
-    item = queue_item_factory(payload__bug__id=123)
-    await queue.backend.put(item)
-    await queue.backend.put(queue_item_factory(payload__bug__id=456))
-
-    [identifier] = await queue.list(123)
-    assert item.identifier == identifier
-
-
-@pytest.mark.asyncio
-async def test_queue_list_all(queue: DeadLetterQueue, queue_item_factory):
-    for bug_id in (123, 123, 456, 456):
-        await queue.backend.put(queue_item_factory(payload__bug__id=bug_id))
-
-    all_items = await queue.list_all()
-    assert len(all_items) == 2
-
-    for items in all_items.values():
-        assert len(items) == 2