feat: compute was_on_time at complete_instance
This commit is contained in:
@@ -35,6 +35,7 @@ from .dao_instances import (
|
|||||||
EVENT_UNCOMPLETED,
|
EVENT_UNCOMPLETED,
|
||||||
CompletionEventRecord,
|
CompletionEventRecord,
|
||||||
CompletionEventsDao,
|
CompletionEventsDao,
|
||||||
|
QuestInstanceRecord,
|
||||||
QuestInstancesDao,
|
QuestInstancesDao,
|
||||||
)
|
)
|
||||||
from .db import NestQuestDatabase
|
from .db import NestQuestDatabase
|
||||||
@@ -64,6 +65,59 @@ def _stamp_occurred_at(now: datetime.datetime | None) -> str:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _completion_moment(
|
||||||
|
now: datetime.datetime | None,
|
||||||
|
today: datetime.date | None,
|
||||||
|
) -> tuple[datetime.date, datetime.time]:
|
||||||
|
"""Return the HA-local completion date and wall-clock time.
|
||||||
|
|
||||||
|
``today`` is the calendar date when the caller threaded one (Feature
|
||||||
|
07 style). ``now`` supplies the clock time; a timezone-aware value
|
||||||
|
is read as HA-local wall clock (hour/minute/second as given), not
|
||||||
|
converted. When ``today`` is omitted the date comes from ``now``.
|
||||||
|
When both are omitted the UTC clock used for occurred_at is the
|
||||||
|
fallback — host ``date.today()`` is never the authority.
|
||||||
|
"""
|
||||||
|
if now is None:
|
||||||
|
moment = datetime.datetime.now(datetime.timezone.utc)
|
||||||
|
else:
|
||||||
|
if not isinstance(now, datetime.datetime):
|
||||||
|
raise ValueError(f"now must be a datetime, got {now!r}")
|
||||||
|
moment = now
|
||||||
|
if today is None:
|
||||||
|
completion_date = moment.date()
|
||||||
|
else:
|
||||||
|
completion_date = today
|
||||||
|
completion_time = datetime.time(
|
||||||
|
moment.hour, moment.minute, moment.second
|
||||||
|
)
|
||||||
|
return completion_date, completion_time
|
||||||
|
|
||||||
|
|
||||||
|
def _was_on_time(
|
||||||
|
instance: QuestInstanceRecord,
|
||||||
|
now: datetime.datetime | None,
|
||||||
|
today: datetime.date | None,
|
||||||
|
) -> bool:
|
||||||
|
"""Return whether the completion moment is on time for ``instance``.
|
||||||
|
|
||||||
|
On ``due_date`` before ``due_time`` is on time; on ``due_date``
|
||||||
|
after ``due_time``, or any later date, is late. With no
|
||||||
|
``due_time``, on time if the completion date equals ``due_date``
|
||||||
|
(or is earlier); late if after ``due_date``.
|
||||||
|
"""
|
||||||
|
completion_date, completion_time = _completion_moment(now, today)
|
||||||
|
due_date = datetime.date.fromisoformat(instance.due_date)
|
||||||
|
if completion_date < due_date:
|
||||||
|
return True
|
||||||
|
if completion_date > due_date:
|
||||||
|
return False
|
||||||
|
if instance.due_time is None:
|
||||||
|
return True
|
||||||
|
due_time = datetime.datetime.strptime(instance.due_time, "%H:%M").time()
|
||||||
|
return completion_time <= due_time
|
||||||
|
|
||||||
|
|
||||||
class _TaskReentrantLock:
|
class _TaskReentrantLock:
|
||||||
"""Shared connection lock the owning task may re-enter."""
|
"""Shared connection lock the owning task may re-enter."""
|
||||||
|
|
||||||
@@ -278,11 +332,10 @@ async def complete_instance(
|
|||||||
append run under one connection lock so a concurrent complete
|
append run under one connection lock so a concurrent complete
|
||||||
cannot double-append.
|
cannot double-append.
|
||||||
|
|
||||||
``was_on_time`` is recorded as True — a placeholder until the
|
``was_on_time`` is computed from the HA-local completion moment
|
||||||
on-time task computes it from ``now`` / ``today`` against the
|
(threaded ``now`` / ``today``) against the instance ``due_date``
|
||||||
instance due_date and optional due_time. ``today`` is accepted so
|
and optional ``due_time``. Host ``date.today()`` is never the
|
||||||
callers can thread the HA-local date through without a signature
|
authority.
|
||||||
change; it is unused here.
|
|
||||||
"""
|
"""
|
||||||
instance_id = _validate_int_id(instance_id, "instance_id")
|
instance_id = _validate_int_id(instance_id, "instance_id")
|
||||||
actor_source, actor_user_id, actor_child_id = _validate_actor(
|
actor_source, actor_user_id, actor_child_id = _validate_actor(
|
||||||
@@ -312,7 +365,7 @@ async def complete_instance(
|
|||||||
actor_source=actor_source,
|
actor_source=actor_source,
|
||||||
actor_user_id=actor_user_id,
|
actor_user_id=actor_user_id,
|
||||||
actor_child_id=actor_child_id,
|
actor_child_id=actor_child_id,
|
||||||
was_on_time=True,
|
was_on_time=_was_on_time(instance, now, today),
|
||||||
now=now,
|
now=now,
|
||||||
)
|
)
|
||||||
return "done"
|
return "done"
|
||||||
|
|||||||
@@ -687,6 +687,116 @@ def test_complete_instance_concurrent_second_call_is_noop(tmp_path) -> None:
|
|||||||
_run(_main())
|
_run(_main())
|
||||||
|
|
||||||
|
|
||||||
|
def _ha_local(day: datetime.date, hour: int, minute: int = 0) -> datetime.datetime:
|
||||||
|
return datetime.datetime(
|
||||||
|
day.year, day.month, day.day, hour, minute, 0,
|
||||||
|
tzinfo=datetime.timezone.utc,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_complete_instance_on_due_date_before_due_time_is_on_time(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, child, instance):
|
||||||
|
due_date = datetime.date.fromisoformat(instance.due_date)
|
||||||
|
instance = await QuestInstancesDao(database).upsert(
|
||||||
|
instance.definition_id,
|
||||||
|
child.id,
|
||||||
|
instance.due_date,
|
||||||
|
_now_stamp(),
|
||||||
|
window=instance.window,
|
||||||
|
due_time="12:00",
|
||||||
|
)
|
||||||
|
await complete_instance(
|
||||||
|
database,
|
||||||
|
instance.id,
|
||||||
|
actor_source="user",
|
||||||
|
actor_user_id="user-1",
|
||||||
|
now=_ha_local(due_date, 11, 0),
|
||||||
|
today=due_date,
|
||||||
|
)
|
||||||
|
rows = await CompletionEventsDao(database).list_by_instance(
|
||||||
|
instance.id
|
||||||
|
)
|
||||||
|
assert rows[0].was_on_time is True
|
||||||
|
|
||||||
|
_with_db(tmp_path, "ontime-before-due-time.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_complete_instance_on_due_date_after_due_time_is_late(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, child, instance):
|
||||||
|
due_date = datetime.date.fromisoformat(instance.due_date)
|
||||||
|
instance = await QuestInstancesDao(database).upsert(
|
||||||
|
instance.definition_id,
|
||||||
|
child.id,
|
||||||
|
instance.due_date,
|
||||||
|
_now_stamp(),
|
||||||
|
window=instance.window,
|
||||||
|
due_time="12:00",
|
||||||
|
)
|
||||||
|
await complete_instance(
|
||||||
|
database,
|
||||||
|
instance.id,
|
||||||
|
actor_source="user",
|
||||||
|
actor_user_id="user-1",
|
||||||
|
now=_ha_local(due_date, 12, 1),
|
||||||
|
today=due_date,
|
||||||
|
)
|
||||||
|
rows = await CompletionEventsDao(database).list_by_instance(
|
||||||
|
instance.id
|
||||||
|
)
|
||||||
|
assert rows[0].was_on_time is False
|
||||||
|
|
||||||
|
_with_db(tmp_path, "late-after-due-time.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_complete_instance_no_due_time_on_due_date_is_on_time(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, child, instance):
|
||||||
|
due_date = datetime.date.fromisoformat(instance.due_date)
|
||||||
|
assert instance.due_time is None
|
||||||
|
await complete_instance(
|
||||||
|
database,
|
||||||
|
instance.id,
|
||||||
|
actor_source="user",
|
||||||
|
actor_user_id="user-1",
|
||||||
|
now=_ha_local(due_date, 23, 59),
|
||||||
|
today=due_date,
|
||||||
|
)
|
||||||
|
rows = await CompletionEventsDao(database).list_by_instance(
|
||||||
|
instance.id
|
||||||
|
)
|
||||||
|
assert rows[0].was_on_time is True
|
||||||
|
|
||||||
|
_with_db(tmp_path, "ontime-no-due-time.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_complete_instance_no_due_time_after_due_date_is_late(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, child, instance):
|
||||||
|
due_date = datetime.date.fromisoformat(instance.due_date)
|
||||||
|
later = due_date + datetime.timedelta(days=1)
|
||||||
|
assert instance.due_time is None
|
||||||
|
await complete_instance(
|
||||||
|
database,
|
||||||
|
instance.id,
|
||||||
|
actor_source="user",
|
||||||
|
actor_user_id="user-1",
|
||||||
|
now=_ha_local(later, 8, 0),
|
||||||
|
today=later,
|
||||||
|
)
|
||||||
|
rows = await CompletionEventsDao(database).list_by_instance(
|
||||||
|
instance.id
|
||||||
|
)
|
||||||
|
assert rows[0].was_on_time is False
|
||||||
|
|
||||||
|
_with_db(tmp_path, "late-after-due-date.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# uncomplete_instance: append uncompleted, no-op if already open
|
# uncomplete_instance: append uncompleted, no-op if already open
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
|
|||||||
Reference in New Issue
Block a user