Add time resolution to date prefix of generate_unique_id

Author: soxofaan

CHANGELOG.md

@@ -21,6 +21,7 @@ and start a new "In Progress" section above it.
 
 ## In progress
 
+- Add time resolution to date prefix of `generate_unique_id()`
 
 ## 0.122.0
 

openeo_driver/utils.py

@@ -334,14 +334,20 @@ def get_package_versions(packages: List[str], na_value="n/a") -> dict:
     return version_info
 
 
-def generate_unique_id(prefix: Optional[str] = None, date_prefix: bool = True) -> str:
+def generate_unique_id(prefix: Optional[str] = None, *, date_prefix: Union[bool, str] = True) -> str:
     """
     Generate a random, unique identifier, to be used as job id, request id
     correlation id, error id, ...
+
+    :param date_prefix: enable a date/time based prefix
+        (e.g. so that alphabetical ordering implies temporal ordering)
+        Can be boolean, or string template to be used with `strftime`
     """
     id = uuid.uuid4().hex
     if date_prefix:
-        date_repr = datetime.datetime.now(datetime.timezone.utc).strftime("%y%m%d")
+        if not isinstance(date_prefix, str):
+            date_prefix = "%y%m%d%H%M%S"
+        date_repr = datetime.datetime.now(datetime.timezone.utc).strftime(date_prefix)
         id = f"{date_repr}{id[len(date_repr):]}"
     if prefix:
         id = f"{prefix}-{id}"

tests/test_utils.py

@@ -1,5 +1,6 @@
 import re
 import typing
+from unittest import mock
 
 import pytest
 import time_machine
@@ -278,16 +279,33 @@ def test_get_package_versions_na():
     }
 
 
-def test_generate_unique_id():
+@pytest.fixture
+def generate_unique_id_mock() -> str:
+    """Fixture to fix the UUID used in `generate_unique_id`"""
+    # TODO: make this more reusable
+    with mock.patch("openeo_driver.utils.uuid") as uuid:
+        fake_uuid = "0123456789abcdef0123456789abcdef"
+        uuid.uuid4.return_value.hex = fake_uuid
+        yield fake_uuid
+
+
+def test_generate_unique_id_basics():
     assert re.match("^[0-9a-f]{32}$", generate_unique_id())
     assert re.match("^j-[0-9a-f]{32}$", generate_unique_id("j"))
 
 
-def test_generate_unique_id_date_prefix():
-    with time_machine.travel("2022-12-14T12:34:56Z"):
-        job_id = generate_unique_id("j")
-        assert re.match("^j-[0-9a-f]{32}$", generate_unique_id("j"))
-        assert job_id.startswith("j-221214")
+@pytest.mark.parametrize(
+    ["date_prefix", "expected"],
+    [
+        (False, "j-0123456789abcdef0123456789abcdef"),
+        (True, "j-191227070809cdef0123456789abcdef"),
+        ("%Y%m", "j-2019126789abcdef0123456789abcdef"),
+        ("d%y%m%d-T%H%M-", "j-d191227-T0708-ef0123456789abcdef"),
+    ],
+)
+def test_generate_unique_id_date_prefix(generate_unique_id_mock, date_prefix, expected):
+    with time_machine.travel("2019-12-27T07:08:09Z"):
+        assert generate_unique_id("j", date_prefix=date_prefix) == expected
 
 
 def test_filter_supported_kwargs_basic():