testsAndMisc/python_pkg/endurain_import/ledger.py
Krzysztof kuhy Rudnicki 558883f281 feat(endurain): self-hosted run viewer fed by RunnerUp WebDAV exports
Stands up Endurain behind the existing Caddy edge and imports RunnerUp
activities into it. Endurain is a VIEWER: screen-locker's workout gate still
reads the phone over adb and is untouched here, because a WebDAV drop folder is
spoofable by anything that can write to ~/cloud and must not become a
screen-unlock authority.

Primary path is phone -> WebDAV (existing dufs) -> ~/cloud/RunnerUp/ ->
importer -> Endurain, with an adb pull as fallback when a run has not been
uploaded yet. A systemd user timer runs the importer every 15 min.

Findings that shaped the implementation, each verified against the running
system rather than assumed:

- Endurain moved to Codeberg; the GitHub repo is a read-only mirror stale at
  v0.17.7 against v0.19.0. The image is pulled from Codeberg.
- postgres:18 moved PGDATA to /var/lib/postgresql/18/docker. Upstream's compose
  example still mounts the pre-18 path, which fails as an unexplained
  "container is unhealthy"; the real cause is only visible in docker logs.
- Endurain seeds a hardcoded admin/admin via an Alembic migration with no env
  override, and endurain.kuhy.duckdns.org already resolved publicly. Publishing
  is therefore a separate script that refuses to install the Caddy site while
  those credentials still work.
- Endurain performs NO duplicate detection, so the importer owns dedupe on two
  axes: a content hash, and an activity key that collapses the .gpx/.tcx pair
  RunnerUp writes for a single run (different bytes, same run).
- Ambiguous uploads (5xx/timeout) are never re-queued, since the activity may
  already have been committed; only definite 4xx rejections are staged for
  retry. The importer exits non-zero so the timer surfaces the problem.
- RunnerUp has no background sync at all, so every upload is a manual tap.
- Its WebDAV synchronizer needs HTTPS with a real cert (Android blocks
  cleartext at targetSdk 36; self-signed is broken upstream) and a URL with no
  trailing slash, and cannot MKCOL against dufs - so the inbox must pre-exist.

The phone gets a dufs credential scoped to /RunnerUp, verified unable to read
Keepass or gdrive_backups.

Verified: 52 tests at 100% branch coverage; the timer imports 4 real runs and
re-runs create zero duplicates; https://endurain.kuhy.duckdns.org serves 200
with a valid cert and the other edge sites are unaffected; screen-locker's
suite still passes 1090 tests at 100% coverage.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GbYEnfGnf1988cdFdGebot
2026-08-23 13:09:18 +02:00

135 lines
4.5 KiB
Python

"""Content-addressed record of what has already been imported.
Endurain has no duplicate detection: uploading the same file twice creates two
activities. The ledger is therefore the only thing standing between a re-run
and a duplicated activity history, and it keys on the file's SHA-256 rather
than its name so that the same run imports once even when it arrives by both
the WebDAV and adb routes under different filenames.
"""
from __future__ import annotations
from dataclasses import dataclass
from datetime import datetime, timezone
import hashlib
import json
from typing import TYPE_CHECKING, Any
if TYPE_CHECKING:
from pathlib import Path
_CHUNK = 1 << 20
# "RunnerUp", <timestamp>, <sport> -- the minimum for a parseable export name.
_MIN_NAME_PARTS = 3
class LedgerCorruptError(RuntimeError):
"""Raised when the on-disk ledger cannot be parsed."""
def activity_key(path: Path) -> str:
"""Return a stable identity for the *run*, independent of export format.
RunnerUp writes the same activity as both .gpx and .tcx
(RunnerUp_2026-08-22-23-51-04_Running.{gpx,tcx}). Those files have
different bytes, so a content hash sees two distinct files and Endurain --
which does no duplicate detection -- happily creates two activities for one
run. Keying on the stem collapses them.
The device model that RunnerUp's WebDAV synchronizer injects
(RunnerUp_Pixel_6a_<ts>_Running) is stripped too, so the same run arriving
over WebDAV and over adb resolves to one key.
"""
stem = path.stem
parts = stem.split("_")
if len(parts) >= _MIN_NAME_PARTS and parts[0] == "RunnerUp":
# Keep the trailing <timestamp>_<sport>; drop any model in between.
return f"RunnerUp_{parts[-2]}_{parts[-1]}"
return stem
def file_digest(path: Path) -> str:
"""Return the SHA-256 of ``path``, read incrementally."""
digest = hashlib.sha256()
with path.open("rb") as handle:
while chunk := handle.read(_CHUNK):
digest.update(chunk)
return digest.hexdigest()
@dataclass(frozen=True)
class Entry:
"""One successfully imported file."""
sha256: str
activity_key: str
filename: str
activity_id: int | None
uploaded_at: str
def as_dict(self) -> dict[str, Any]:
"""Return the JSON-serialisable form stored in the ledger."""
return {
"activity_key": self.activity_key,
"filename": self.filename,
"activity_id": self.activity_id,
"uploaded_at": self.uploaded_at,
}
class Ledger:
"""A JSON-backed set of imported content hashes.
Writes are atomic (temp file + replace) because the importer runs from a
systemd timer: a crash mid-write must not leave a truncated ledger, which
would look like "nothing has been imported" and duplicate the entire
history on the next run.
"""
def __init__(self, path: Path) -> None:
"""Open (or create) the ledger stored at ``path``."""
self._path = path
self._entries: dict[str, dict[str, Any]] = {}
self._load()
def _load(self) -> None:
if not self._path.exists():
return
try:
raw = json.loads(self._path.read_text())
except json.JSONDecodeError as exc:
# Fail closed: a corrupt ledger must stop the run, not silently
# re-import everything.
message = f"corrupt ledger at {self._path}: {exc}"
raise LedgerCorruptError(message) from exc
if isinstance(raw, dict):
self._entries = raw
def __contains__(self, sha256: str) -> bool:
"""True when a file with this digest has already been imported."""
return sha256 in self._entries
def has_activity(self, key: str) -> bool:
"""True when this run was imported already, in any export format."""
return any(entry.get("activity_key") == key for entry in self._entries.values())
def __len__(self) -> int:
"""Number of files recorded as imported."""
return len(self._entries)
def record(self, entry: Entry) -> None:
"""Add ``entry`` and flush to disk immediately."""
self._entries[entry.sha256] = entry.as_dict()
self._flush()
def _flush(self) -> None:
self._path.parent.mkdir(parents=True, exist_ok=True)
tmp = self._path.with_suffix(".tmp")
tmp.write_text(json.dumps(self._entries, indent=2, sort_keys=True))
tmp.replace(self._path)
def now_iso() -> str:
"""UTC timestamp for ledger entries."""
return datetime.now(timezone.utc).isoformat()