mirror of
https://github.com/kuhyx/utils.git
synced 2026-11-19 10:54:34 +01:00
Some checks are pending
dependency freshness / dependencies on newest stable (push) Waiting to run
file length / file-length (push) Waiting to run
md-naming / markdown naming convention (push) Waiting to run
palette drift / palette (push) Waiting to run
repo-contract / repo contract (push) Waiting to run
shared gate tests / gate unit tests (push) Waiting to run
sickdays pre-commit / pre-commit (push) Waiting to run
sickdays tests / test (push) Waiting to run
A sick day may keep some lockers active: a locker stands down iff the day is sick and the locker is not in that day's keep set. New record field `keep` = [sorted, de-duplicated locker ids, hlc]. - add/remove write state, actor and keep on one tick (keep=[] on a clear), so a stale keep cannot survive a clear + re-add. - set_kept_lockers re-stamps only keep and actor; state keeps its clock, so a keep edit never re-asserts sick over a concurrent clear. Ticks are issued after every clock already on the record (clock-skew safe). - Reading: no keep (0.1.0) or keep older than state -> keep nothing; malformed keep -> every locker kept (fail closed, logged); unknown ids ignored. - API: stands_down, kept_lockers, set_kept_lockers, add_sick_day(keep=), SickDay.keep, LOCKER_* / LOCKERS. is_sick_day unchanged. - CLI: add --keep, keep DAY [LOCKER ...], list shows keep, check --locker. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PAhbNszs5JKdtnD4uBi3xp
72 lines
2.5 KiB
Python
72 lines
2.5 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki
|
|
"""Append-only, HMAC-signed trail of every add, remove, keep edit and import.
|
|
|
|
Nothing reads this to make a decision -- the CRDT log is the truth. It
|
|
exists so "when did I mark that day, and from which device" is answerable
|
|
later, and so a hand-edited line is detectable rather than invisible.
|
|
|
|
Signing is best-effort, as in freedays: with no key the line is written
|
|
unsigned, because an unsigned audit line is a much smaller problem than a
|
|
sick day that could not be taken because a key file was missing.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import UTC, datetime
|
|
import json
|
|
import logging
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
from sickdays._day import to_iso
|
|
from sickdays._hmac import generate_key, sign
|
|
from sickdays._paths import Paths, resolve_paths
|
|
|
|
if TYPE_CHECKING:
|
|
from datetime import date
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
|
|
def record_event(
|
|
action: str,
|
|
day: date,
|
|
*,
|
|
actor: str,
|
|
keep: frozenset[str] | None = None,
|
|
paths: Paths | None = None,
|
|
) -> None:
|
|
"""Append one signed line describing a change to the pool.
|
|
|
|
Args:
|
|
action: ``"add"``, ``"remove"``, ``"keep"`` or ``"import"``.
|
|
day: The day that changed.
|
|
actor: The device id that made the change.
|
|
keep: The day's kept lockers after the change, recorded (sorted)
|
|
for an add or a keep edit; omitted from the line when ``None``.
|
|
paths: Where the trail and its signing key live.
|
|
"""
|
|
resolved = resolve_paths(paths)
|
|
entry: dict[str, Any] = {
|
|
"action": action,
|
|
"day": to_iso(day),
|
|
"actor": actor,
|
|
"at": datetime.now(tz=UTC).isoformat(),
|
|
}
|
|
if keep is not None:
|
|
entry["keep"] = sorted(keep)
|
|
key_target = resolved.hmac_key
|
|
if not key_target.exists():
|
|
# First run on this machine: generating the key here means the trail
|
|
# is signed from its first line, with no setup step to skip.
|
|
generate_key(key_target)
|
|
entry["hmac"] = sign(entry, key_file=key_target)
|
|
target = resolved.audit
|
|
try:
|
|
target.parent.mkdir(parents=True, exist_ok=True)
|
|
with target.open("a", encoding="utf-8") as handle:
|
|
handle.write(json.dumps(entry, sort_keys=True) + "\n")
|
|
except OSError as exc:
|
|
# The change is already committed to the log; an unwritable trail
|
|
# must never be the reason it fails.
|
|
_logger.warning("could not append to the sick-day audit trail: %s", exc)
|