Fix #956: add default UTC timezone to queue items (#957)

Author: leplatrem

jbi/bugzilla/models.py

@@ -1,16 +1,41 @@
 import datetime
 import logging
-from typing import Optional, TypedDict
+from typing import Any, Optional, TypedDict
 from urllib.parse import ParseResult, urlparse
 
-from pydantic import BaseModel, TypeAdapter
+from pydantic import (
+    AwareDatetime,
+    BaseModel,
+    TypeAdapter,
+    ValidationError,
+    ValidationInfo,
+    ValidatorFunctionWrapHandler,
+)
+from pydantic.functional_validators import WrapValidator
+from typing_extensions import Annotated
 
 logger = logging.getLogger(__name__)
 JIRA_HOSTNAMES = ("jira", "atlassian")
 
 BugId = TypedDict("BugId", {"id": Optional[int]})
 
 
+def maybe_add_timezone(
+    v: Any, handler: ValidatorFunctionWrapHandler, info: ValidationInfo
+):
+    if isinstance(v, str):
+        try:
+            return handler(v)
+        except ValidationError:
+            return handler(v + "+00:00")
+    assert isinstance(v, datetime.datetime), "must be a datetime here"
+    v = v.replace(tzinfo=datetime.timezone.utc)
+    return v
+
+
+SmartAwareDatetime = Annotated[AwareDatetime, WrapValidator(maybe_add_timezone)]
+
+
 class WebhookUser(BaseModel, frozen=True):
     """Bugzilla User Object"""
 
@@ -31,7 +56,7 @@ class WebhookEvent(BaseModel, frozen=True):
     """Bugzilla Event Object"""
 
     action: str
-    time: datetime.datetime
+    time: SmartAwareDatetime
     user: Optional[WebhookUser] = None
     changes: Optional[list[WebhookEventChange]] = None
     target: Optional[str] = None
@@ -50,7 +75,7 @@ class WebhookComment(BaseModel, frozen=True):
     id: Optional[int] = None
     number: Optional[int] = None
     is_private: Optional[bool] = None
-    creation_time: Optional[datetime.datetime] = None
+    creation_time: Optional[SmartAwareDatetime] = None
 
 
 class Bug(BaseModel, frozen=True):

tests/unit/jira/test_queue.py

@@ -1,3 +1,4 @@
+import json
 from datetime import datetime, timedelta
 
 import pytest
@@ -207,6 +208,24 @@ async def test_get_invalid_json(backend: QueueBackend, queue_item_factory):
         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()
+    dump["payload"]["event"]["time"] = "2024-04-18T12:46:54"
+
+    queue_dir = backend.location / "666"
+    queue_dir.mkdir()
+    corrupt_file_path = queue_dir / f"{item.identifier}.json"
+    corrupt_file_path.write_text(json.dumps(dump))
+
+    items = backend.get(666)
+    item = await anext(items)
+
+    assert item.timestamp.tzname() == "UTC", "default timezone added"
+    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(
     backend: QueueBackend, queue_item_factory