Merge pull request #824 from roflcoopter/feature/timezone-corrections

unified timezone handling

Author: roflcoopter

tests/components/webserver/api/v1/test_events.py

@@ -26,15 +26,23 @@ def prepare_and_mock(self, get_db_session: sessionmaker[Session]):
             session.execute(
                 insert(Motion).values(
                     camera_identifier="test",
-                    start_time=datetime.datetime(2024, 6, 22, 1, 0, 0),
-                    end_time=datetime.datetime(2024, 6, 22, 1, 1, 0),
+                    start_time=datetime.datetime(
+                        2024, 6, 22, 1, 0, 0, tzinfo=datetime.timezone.utc
+                    ),
+                    end_time=datetime.datetime(
+                        2024, 6, 22, 1, 1, 0, tzinfo=datetime.timezone.utc
+                    ),
                 )
             )
             session.execute(
                 insert(Motion).values(
                     camera_identifier="test",
-                    start_time=datetime.datetime(2024, 6, 22, 3, 0, 0),
-                    end_time=datetime.datetime(2024, 6, 22, 3, 1, 0),
+                    start_time=datetime.datetime(
+                        2024, 6, 22, 3, 0, 0, tzinfo=datetime.timezone.utc
+                    ),
+                    end_time=datetime.datetime(
+                        2024, 6, 22, 3, 1, 0, tzinfo=datetime.timezone.utc
+                    ),
                 )
             )
             session.execute(
@@ -43,7 +51,9 @@ def prepare_and_mock(self, get_db_session: sessionmaker[Session]):
                     domain="face_recognition",
                     snapshot_path="test",
                     data={"label": "test", "confidence": 0.5},
-                    created_at=datetime.datetime(2024, 6, 22, 1, 0, 0),
+                    created_at=datetime.datetime(
+                        2024, 6, 22, 1, 0, 0, tzinfo=datetime.timezone.utc
+                    ),
                 )
             )
             session.execute(
@@ -52,7 +62,9 @@ def prepare_and_mock(self, get_db_session: sessionmaker[Session]):
                     domain="face_recognition",
                     snapshot_path="test",
                     data={"label": "test", "confidence": 0.5},
-                    created_at=datetime.datetime(2024, 6, 22, 23, 0, 0),
+                    created_at=datetime.datetime(
+                        2024, 6, 22, 23, 0, 0, tzinfo=datetime.timezone.utc
+                    ),
                 )
             )
             session.commit()

tests/domains/camera/test_fragmenter.py

@@ -146,4 +146,6 @@ def test_extract_extinf_number():
 def test_extract_program_date_time() -> None:
     """Test _extract_program_date_time."""
     date_time_tag = _extract_program_date_time(PLAYLIST_CONTENT, "1723111156.m4s")
-    assert date_time_tag == datetime.datetime(2024, 8, 8, 9, 59, 16, 199000)
+    assert date_time_tag == datetime.datetime(
+        2024, 8, 8, 9, 59, 16, 199000, tzinfo=datetime.timezone.utc
+    )

tests/domains/camera/test_recorder.py

@@ -2,6 +2,7 @@
 from __future__ import annotations
 
 import datetime
+import time
 from collections.abc import Callable
 from typing import TYPE_CHECKING, Literal
 from unittest.mock import MagicMock, Mock, patch
@@ -31,29 +32,47 @@ def get_db_session_recordings(get_db_session: Callable[[], Session]):
         session.execute(
             insert(Recordings).values(
                 camera_identifier="test1",
-                start_time=datetime.datetime(2023, 3, 1, 23, 30),  # 23:30 UTC March 1
-                adjusted_start_time=datetime.datetime(2023, 3, 1, 23, 30),
-                end_time=datetime.datetime(2023, 3, 2, 0, 30),  # 00:30 UTC March 2
+                start_time=datetime.datetime(
+                    2023, 3, 1, 23, 30, tzinfo=datetime.timezone.utc
+                ),  # 23:30 UTC March 1
+                adjusted_start_time=datetime.datetime(
+                    2023, 3, 1, 23, 30, tzinfo=datetime.timezone.utc
+                ),
+                end_time=datetime.datetime(
+                    2023, 3, 2, 0, 30, tzinfo=datetime.timezone.utc
+                ),  # 00:30 UTC March 2
                 thumbnail_path="test",
             )
         )
         # Mid-day recording
         session.execute(
             insert(Recordings).values(
                 camera_identifier="test1",
-                start_time=datetime.datetime(2023, 3, 2, 12, 0),  # 12:00 UTC March 2
-                adjusted_start_time=datetime.datetime(2023, 3, 2, 12, 0),
-                end_time=datetime.datetime(2023, 3, 2, 13, 0),  # 13:00 UTC March 2
+                start_time=datetime.datetime(
+                    2023, 3, 2, 12, 0, tzinfo=datetime.timezone.utc
+                ),  # 12:00 UTC March 2
+                adjusted_start_time=datetime.datetime(
+                    2023, 3, 2, 12, 0, tzinfo=datetime.timezone.utc
+                ),
+                end_time=datetime.datetime(
+                    2023, 3, 2, 13, 0, tzinfo=datetime.timezone.utc
+                ),  # 13:00 UTC March 2
                 thumbnail_path="test",
             )
         )
         # Recording near day boundary
         session.execute(
             insert(Recordings).values(
                 camera_identifier="test1",
-                start_time=datetime.datetime(2023, 3, 2, 22, 45),  # 22:45 UTC March 2
-                adjusted_start_time=datetime.datetime(2023, 3, 2, 22, 45),
-                end_time=datetime.datetime(2023, 3, 2, 23, 45),  # 23:45 UTC March 2
+                start_time=datetime.datetime(
+                    2023, 3, 2, 22, 45, tzinfo=datetime.timezone.utc
+                ),  # 22:45 UTC March 2
+                adjusted_start_time=datetime.datetime(
+                    2023, 3, 2, 22, 45, tzinfo=datetime.timezone.utc
+                ),
+                end_time=datetime.datetime(
+                    2023, 3, 2, 23, 45, tzinfo=datetime.timezone.utc
+                ),  # 23:45 UTC March 2
                 thumbnail_path="test",
             )
         )
@@ -201,12 +220,16 @@ def test_delete_recording(
         """Test delete_recording."""
         mock_delete_recording.return_value = []
         recorder_base = Recorder(vis, MagicMock(), MockCamera())
-        result = recorder_base.delete_recording()
+        result = recorder_base.delete_recording(
+            datetime.timedelta(seconds=time.localtime().tm_gmtoff)
+        )
         assert result is False
 
         mock_delete_recording.return_value = [
             MagicMock(spec=Recordings),
             MagicMock(spec=Recordings),
         ]
-        result = recorder_base.delete_recording()
+        result = recorder_base.delete_recording(
+            datetime.timedelta(seconds=time.localtime().tm_gmtoff)
+        )
         assert result is True

tests/helpers/test__init__.py

@@ -1,5 +1,6 @@
 """Test helpers module."""
 from contextlib import nullcontext
+from datetime import datetime, timedelta, timezone
 
 import pytest
 
@@ -81,3 +82,102 @@ def test_convert_letterboxed_bbox(
         assert converted_bbox == expected
     if message:
         assert str(exception.value) == message
+
+
+def test_basic_conversion_zero_offset():
+    """Test with zero UTC offset."""
+    date = "2024-01-01"
+    utc_offset = timedelta(hours=0)
+
+    time_from, time_to = helpers.daterange_to_utc(date, utc_offset)
+
+    assert time_from == datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=timezone.utc)
+    assert time_to == datetime(2024, 1, 1, 23, 59, 59, 999999, tzinfo=timezone.utc)
+
+
+def test_positive_utc_offset():
+    """Test with positive UTC offset (e.g., UTC+5)."""
+    date = "2024-01-01"
+    utc_offset = timedelta(hours=5)
+
+    time_from, time_to = helpers.daterange_to_utc(date, utc_offset)
+
+    # With UTC+5, the UTC time should be 5 hours earlier
+    assert time_from == datetime(2023, 12, 31, 19, 0, 0, 0, tzinfo=timezone.utc)
+    assert time_to == datetime(2024, 1, 1, 18, 59, 59, 999999, tzinfo=timezone.utc)
+
+
+def test_negative_utc_offset():
+    """Test with negative UTC offset (e.g., UTC-5)."""
+    date = "2024-01-01"
+    utc_offset = timedelta(hours=-5)
+
+    time_from, time_to = helpers.daterange_to_utc(date, utc_offset)
+
+    # With UTC-5, the UTC time should be 5 hours later
+    assert time_from == datetime(2024, 1, 1, 5, 0, 0, 0, tzinfo=timezone.utc)
+    assert time_to == datetime(2024, 1, 2, 4, 59, 59, 999999, tzinfo=timezone.utc)
+
+
+def test_fractional_hour_offset():
+    """Test with UTC offset including minutes."""
+    date = "2024-01-01"
+    utc_offset = timedelta(hours=5, minutes=30)  # UTC+5:30 (like India)
+
+    time_from, time_to = helpers.daterange_to_utc(date, utc_offset)
+
+    assert time_from == datetime(2023, 12, 31, 18, 30, 0, 0, tzinfo=timezone.utc)
+    assert time_to == datetime(2024, 1, 1, 18, 29, 59, 999999, tzinfo=timezone.utc)
+
+
+def test_year_boundary():
+    """Test date at year boundary with offset that crosses the year."""
+    date = "2024-01-01"
+    utc_offset = timedelta(hours=2)
+
+    time_from, time_to = helpers.daterange_to_utc(date, utc_offset)
+
+    assert time_from == datetime(2023, 12, 31, 22, 0, 0, 0, tzinfo=timezone.utc)
+    assert time_to == datetime(2024, 1, 1, 21, 59, 59, 999999, tzinfo=timezone.utc)
+
+
+def test_invalid_date_format():
+    """Test that invalid date format raises ValueError."""
+    date = "2024/01/01"  # Wrong format
+    utc_offset = timedelta(hours=0)
+
+    with pytest.raises(ValueError):
+        helpers.daterange_to_utc(date, utc_offset)
+
+
+def test_leap_year_date():
+    """Test with February 29th on a leap year."""
+    date = "2024-02-29"  # 2024 is a leap year
+    utc_offset = timedelta(hours=0)
+
+    time_from, time_to = helpers.daterange_to_utc(date, utc_offset)
+
+    assert time_from == datetime(2024, 2, 29, 0, 0, 0, 0, tzinfo=timezone.utc)
+    assert time_to == datetime(2024, 2, 29, 23, 59, 59, 999999, tzinfo=timezone.utc)
+
+
+def test_extreme_offset():
+    """Test with maximum possible UTC offset."""
+    date = "2024-01-01"
+    utc_offset = timedelta(hours=14)  # Maximum UTC offset (UTC+14)
+
+    time_from, time_to = helpers.daterange_to_utc(date, utc_offset)
+
+    assert time_from == datetime(2023, 12, 31, 10, 0, 0, 0, tzinfo=timezone.utc)
+    assert time_to == datetime(2024, 1, 1, 9, 59, 59, 999999, tzinfo=timezone.utc)
+
+
+def test_microsecond_precision():
+    """Test that microsecond precision is maintained."""
+    date = "2024-01-01"
+    utc_offset = timedelta(hours=0)
+
+    time_from, time_to = helpers.daterange_to_utc(date, utc_offset)
+
+    assert time_from.microsecond == 0
+    assert time_to.microsecond == 999999

viseron/components/storage/models.py

@@ -33,7 +33,10 @@ class UTCDateTime(types.TypeDecorator):
 
     def process_bind_param(self, value, _dialect):
         """Remove timezone info from datetime."""
+        # Only allow UTC datetimes
         if isinstance(value, datetime.datetime):
+            if value.tzinfo is None:
+                raise ValueError("Only UTC datetimes are allowed")
             return value.replace(tzinfo=None)
         return value
 

viseron/components/storage/queries.py

@@ -318,9 +318,9 @@ def get_time_period_fragments(
     now=None,
 ):
     """Return a list of files for the requested time period."""
-    start = datetime.datetime.utcfromtimestamp(start_timestamp)
+    start = datetime.datetime.fromtimestamp(start_timestamp, tz=datetime.timezone.utc)
     if end_timestamp:
-        end = datetime.datetime.utcfromtimestamp(end_timestamp)
+        end = datetime.datetime.fromtimestamp(end_timestamp, tz=datetime.timezone.utc)
     else:
         end = now if now else utcnow()
 

viseron/components/webserver/api/v1/events.py

@@ -22,6 +22,7 @@
 from viseron.domains.license_plate_recognition.const import (
     DOMAIN as LICENSE_PLATE_RECOGNITION_DOMAIN,
 )
+from viseron.helpers import daterange_to_utc
 
 if TYPE_CHECKING:
     from sqlalchemy.orm import Session
@@ -76,8 +77,12 @@ def _motion_events(
         time_to: int,
     ) -> list:
         """Select motion events from database."""
-        time_from_datetime = datetime.datetime.fromtimestamp(time_from)
-        time_to_datetime = datetime.datetime.fromtimestamp(time_to)
+        time_from_datetime = datetime.datetime.fromtimestamp(
+            time_from, tz=datetime.timezone.utc
+        )
+        time_to_datetime = datetime.datetime.fromtimestamp(
+            time_to, tz=datetime.timezone.utc
+        )
         with get_session() as session:
             stmt = (
                 select(Motion)
@@ -120,8 +125,12 @@ def _object_event(
         time_to: int,
     ):
         """Select object events from database."""
-        time_from_datetime = datetime.datetime.fromtimestamp(time_from)
-        time_to_datetime = datetime.datetime.fromtimestamp(time_to)
+        time_from_datetime = datetime.datetime.fromtimestamp(
+            time_from, tz=datetime.timezone.utc
+        )
+        time_to_datetime = datetime.datetime.fromtimestamp(
+            time_to, tz=datetime.timezone.utc
+        )
         with get_session() as session:
             stmt = (
                 select(Objects)
@@ -156,8 +165,12 @@ def _recording_events(
         time_to: int,
     ) -> list:
         """Select recording events from database."""
-        time_from_datetime = datetime.datetime.fromtimestamp(time_from)
-        time_to_datetime = datetime.datetime.fromtimestamp(time_to)
+        time_from_datetime = datetime.datetime.fromtimestamp(
+            time_from, tz=datetime.timezone.utc
+        )
+        time_to_datetime = datetime.datetime.fromtimestamp(
+            time_to, tz=datetime.timezone.utc
+        )
         with get_session() as session:
             stmt = (
                 select(Recordings)
@@ -203,8 +216,12 @@ def _post_processor_events(
         time_to: int,
     ) -> list:
         """Select post processor events from database."""
-        time_from_datetime = datetime.datetime.fromtimestamp(time_from)
-        time_to_datetime = datetime.datetime.fromtimestamp(time_to)
+        time_from_datetime = datetime.datetime.fromtimestamp(
+            time_from, tz=datetime.timezone.utc
+        )
+        time_to_datetime = datetime.datetime.fromtimestamp(
+            time_to, tz=datetime.timezone.utc
+        )
         with get_session() as session:
             stmt = (
                 select(PostProcessorResults)
@@ -253,14 +270,10 @@ async def get_events(
             )
             return
 
-        # Get start of day in utc
+        # Convert local start of day to UTC
         if "date" in self.request_arguments:
-            _time_from = (
-                datetime.datetime.strptime(self.request_arguments["date"], "%Y-%m-%d")
-                - self.utc_offset
-            )
-            _time_to = _time_from + datetime.timedelta(
-                hours=23, minutes=59, seconds=59, milliseconds=999999
+            _time_from, _time_to = daterange_to_utc(
+                self.request_arguments["date"], self.utc_offset
             )
             time_from = _time_from.timestamp()
             time_to = _time_to.timestamp()

viseron/components/webserver/api/v1/hls.py

@@ -20,7 +20,7 @@
     generate_playlist,
     get_available_timespans,
 )
-from viseron.helpers import utcnow
+from viseron.helpers import daterange_to_utc, utcnow
 from viseron.helpers.fixed_size_dict import FixedSizeDict
 from viseron.helpers.validators import request_argument_no_value
 
@@ -185,13 +185,13 @@ async def get_available_timespans(
             )
             return
 
-        # Get start of day in utc
+        # Convert local start of day to UTC
         if "date" in self.request_arguments:
-            time_from = (
-                datetime.datetime.strptime(self.request_arguments["date"], "%Y-%m-%d")
-                - self.utc_offset
-            ).timestamp()
-            time_to = time_from + 86400
+            _time_from, _time_to = daterange_to_utc(
+                self.request_arguments["date"], self.utc_offset
+            )
+            time_from = _time_from.timestamp()
+            time_to = _time_to.timestamp()
         else:
             time_from = self.request_arguments["time_from"]
             time_to = self.request_arguments["time_to"]