screen-locker/screen_locker/tests/test_manual_push.py
Krzysztof kuhy Rudnicki 79879263ba Support multiple workouts per day; fix the dead sync; ban silent failures
The workout log stored ONE workout per calendar day, so a second same-day
workout was silently dropped and could never earn credit.

Multiple workouts per day:
- workout_log.json: {date: entry} -> {date: [entry, ...]}. Legacy entries are
  wrapped on read (_log_io.load_workout_log) so their HMACs stay valid — no
  re-signing; every write normalizes the file, migrating it progressively.
- New write chokepoint (_log_mixin.write_signed_entry) APPENDS and dedups by a
  stable workout_id, returning RecordResult so callers can tell a new workout
  from a duplicate. Re-verifying the same workout is a no-op.
- count_weekly_workouts is anti-gaming: each VERIFIED workout counts
  individually; self-reported manual entries count at most once per day. Four
  real workouts in one day satisfy the week; four manual entries count as one.
- Reward: the day's first counted workout gets the base +2h; an additional
  same-day VERIFIED workout gets +1h; an additional manual gets nothing. The
  old "+1h when weekly_count > 4" gate is replaced — weekly volume is the
  banked bonus's job and shouldn't be paid twice.
- Fixed: the unlock screen labelled the +1h "#{weekly_count - 4}", which can
  render negative under the new rule. Removed the dead runnerup_manual type.
- Flutter: the manual budget counts distinct DAYS, matching the PC.

PC->phone sync (it had never worked once):
- push_pc_manuals pushed from a side-store written at log-time, so anything
  logged before that feature existed could never publish. _manual_push now
  derives the crdt log directly from workout_log.json — the single source of
  truth — covering manual AND verified runs. The record id is the workout's own
  workout_id (derived for legacy entries to match the phone's format) and the
  HLC comes from the entry's own timestamp, so a re-push is byte-identical and
  the repo never churns.
- The phone reads every kind (readMergedWorkoutPayloads) and lists the PC's
  workouts under "SYNCED FROM PC". The manual budget still sees manual-only, so
  a verified run can't consume a self-report slot.
- Settings claimed "Connected." whenever a token STRING existed. It now
  verifies against the API on open, so a revoked token reports 401 instead of
  showing a green lie.

Never fail silently:
- 30 swallowed exceptions across 19 files now log WARNING with the concrete
  cause AND consequence — plus the token guards in _workout_sync that returned
  [] in total silence, the exact bug that hid the dead sync for weeks.
- New pre-commit hook (scripts/check_silent_failures.py) fails any except that
  neither re-raises nor logs loudly. ruff's S110 only catches `except: pass`;
  the real pattern here was `except: log.info(); return []`. Documented in
  CLAUDE.md.

Verified on real data: the Jul 13 run (pulled from its actual TCX over ADB) now
counts alongside that day's manual squash, and all three workouts are published
to kuhyx/syncs.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Fv8ULVt3Q67GwCFbM7doHB
2026-07-17 09:22:31 +02:00

242 lines
9.0 KiB
Python

"""Tests for pushing the PC's workouts (from workout_log.json) to the sync repo."""
# pylint: disable=protected-access
from __future__ import annotations
from datetime import datetime, timezone
import json
from typing import TYPE_CHECKING
from unittest.mock import MagicMock, patch
from crdt_sync import GitHubSyncError
from screen_locker import _manual_push
from screen_locker._manual_push import (
PushResult,
_decode_log,
_encode_log,
_entry_wall_ms,
push_pc_workouts,
records_from_workout_log,
)
if TYPE_CHECKING:
from pathlib import Path
_MANUAL = {
"type": "manual_workout",
"source": "table tennis at Solec",
"start_time": "18:00",
"rpe": 6,
}
_RUN = {
"type": "runnerup_verified",
"source": "Running: 9.8 km in 55 min",
"distance_km": 9.8,
}
def _write_log(log_file: Path, data: dict) -> None:
log_file.write_text(json.dumps(data))
def _entry(workout_data: dict, ts: str, workout_id: str | None = None) -> dict:
entry: dict = {"timestamp": ts, "workout_data": workout_data}
if workout_id is not None:
entry["workout_id"] = workout_id
return entry
class TestEncodeDecodeLog:
"""The crdt log blob round-trips."""
def test_round_trips(self, tmp_path: Path) -> None:
log_file = tmp_path / "workout_log.json"
_write_log(
log_file, {"2026-07-13": [_entry(_RUN, "2026-07-13T10:00:00+00:00")]}
)
log = records_from_workout_log(log_file)
assert _decode_log(_encode_log(log)).keys() == log.keys()
class TestEntryWallMs:
"""The HLC clock is derived from the entry's own timestamp — stably."""
def test_uses_the_entry_timestamp(self) -> None:
expected = int(
datetime(2026, 7, 13, 12, tzinfo=timezone.utc).timestamp() * 1000
)
ms = _entry_wall_ms({"timestamp": "2026-07-13T12:00:00+00:00"}, "2026-07-13")
assert ms == expected
def test_unparsable_timestamp_falls_back_to_midnight(self) -> None:
ms = _entry_wall_ms({"timestamp": "not-a-time"}, "2026-07-13")
assert ms == _entry_wall_ms({"timestamp": "2026-07-13T00:00:00+00:00"}, "x")
def test_missing_timestamp_falls_back_to_midnight(self) -> None:
expected = int(datetime(2026, 7, 13, tzinfo=timezone.utc).timestamp() * 1000)
assert _entry_wall_ms({}, "2026-07-13") == expected
def test_fallback_is_stable_across_calls(self) -> None:
"""The fallback must not be 'now' — that would churn the repo."""
assert _entry_wall_ms({}, "2026-07-13") == _entry_wall_ms({}, "2026-07-13")
class TestRecordsFromWorkoutLog:
"""workout_log.json is the single source of truth for what gets pushed."""
def test_derives_a_record_per_counted_workout(self, tmp_path: Path) -> None:
log_file = tmp_path / "workout_log.json"
_write_log(
log_file,
{
"2026-07-13": [
_entry(_MANUAL, "2026-07-13T07:25:12+00:00"),
_entry(
_RUN,
"2026-07-13T23:10:00+00:00",
workout_id="runnerup_verified:2026-07-13",
),
]
},
)
log = records_from_workout_log(log_file)
assert set(log) == {"manual:2026-07-13T18:00", "runnerup_verified:2026-07-13"}
def test_payload_carries_kind_and_date(self, tmp_path: Path) -> None:
log_file = tmp_path / "workout_log.json"
_write_log(
log_file, {"2026-07-13": [_entry(_RUN, "2026-07-13T10:00:00+00:00")]}
)
payload, _hlc = records_from_workout_log(log_file)[
"runnerup_verified:2026-07-13"
].fields["payload"]
assert payload["kind"] == "runnerup_verified"
assert payload["date"] == "2026-07-13"
assert payload["distance_km"] == 9.8
def test_legacy_entry_without_workout_id_still_publishes(
self, tmp_path: Path
) -> None:
"""Entries predating workout_id get the id they would have had."""
log_file = tmp_path / "workout_log.json"
_write_log(
log_file, {"2026-07-13": [_entry(_MANUAL, "2026-07-13T07:25+00:00")]}
)
assert "manual:2026-07-13T18:00" in records_from_workout_log(log_file)
def test_uncounted_types_are_not_pushed(self, tmp_path: Path) -> None:
log_file = tmp_path / "workout_log.json"
_write_log(
log_file,
{"2026-07-13": [_entry({"type": "sick_day"}, "2026-07-13T07:00:00+00:00")]},
)
assert records_from_workout_log(log_file) == {}
def test_non_dict_workout_data_is_skipped(self, tmp_path: Path) -> None:
log_file = tmp_path / "workout_log.json"
_write_log(
log_file,
{
"2026-07-13": [
{"timestamp": "2026-07-13T07:00:00+00:00", "workout_data": "x"}
]
},
)
assert records_from_workout_log(log_file) == {}
def test_entry_without_derivable_id_is_skipped(self, tmp_path: Path) -> None:
"""A counted type with no id can't be deduped, so it isn't synced."""
log_file = tmp_path / "workout_log.json"
_write_log(
log_file, {"2026-07-13": [_entry(_MANUAL, "2026-07-13T07:00:00+00:00")]}
)
with patch("screen_locker._manual_push._derive_workout_id", return_value=None):
assert records_from_workout_log(log_file) == {}
def test_is_deterministic_across_calls(self, tmp_path: Path) -> None:
"""Same log → identical records+HLCs, so a re-push is a no-op."""
log_file = tmp_path / "workout_log.json"
_write_log(
log_file, {"2026-07-13": [_entry(_RUN, "2026-07-13T10:00:00+00:00")]}
)
assert _encode_log(records_from_workout_log(log_file)) == _encode_log(
records_from_workout_log(log_file)
)
class TestPushPcWorkouts:
"""Every outcome is reported — never a silent no-op."""
def test_no_token_reports_why(self, tmp_path: Path) -> None:
log_file = tmp_path / "workout_log.json"
_write_log(
log_file, {"2026-07-13": [_entry(_RUN, "2026-07-13T10:00:00+00:00")]}
)
with patch.object(_manual_push, "read_sync_token", return_value=None):
result = push_pc_workouts(log_file)
assert result == PushResult(pushed=False, record_count=0, reason=result.reason)
assert "no sync token" in result.reason
def test_empty_log_reports_why(self, tmp_path: Path) -> None:
log_file = tmp_path / "workout_log.json"
_write_log(log_file, {})
with patch.object(_manual_push, "read_sync_token", return_value="t"):
result = push_pc_workouts(log_file)
assert result.pushed is False
assert result.record_count == 0
assert "no counted workouts" in result.reason
def test_sync_error_reports_why(self, tmp_path: Path) -> None:
log_file = tmp_path / "workout_log.json"
_write_log(
log_file, {"2026-07-13": [_entry(_RUN, "2026-07-13T10:00:00+00:00")]}
)
with (
patch.object(_manual_push, "read_sync_token", return_value="t"),
patch.object(_manual_push, "GitHubSyncClient", MagicMock()),
patch.object(
_manual_push, "sync_log", side_effect=GitHubSyncError("403 forbidden")
),
):
result = push_pc_workouts(log_file)
assert result.pushed is False
assert result.record_count == 1
assert "403 forbidden" in result.reason
def test_successful_push_reports_count(self, tmp_path: Path) -> None:
log_file = tmp_path / "workout_log.json"
_write_log(
log_file,
{
"2026-07-13": [
_entry(_MANUAL, "2026-07-13T07:25:12+00:00"),
_entry(_RUN, "2026-07-13T23:10:00+00:00"),
]
},
)
fake_sync = MagicMock()
with (
patch.object(_manual_push, "read_sync_token", return_value="t"),
patch.object(_manual_push, "GitHubSyncClient", MagicMock()),
patch.object(_manual_push, "sync_log", fake_sync),
):
result = push_pc_workouts(log_file)
assert result == PushResult(pushed=True, record_count=2, reason="pushed")
assert fake_sync.call_count == 1
def test_pushes_runs_not_just_manuals(self, tmp_path: Path) -> None:
"""Regression: the phone must converge on the PC's runs too."""
log_file = tmp_path / "workout_log.json"
_write_log(
log_file, {"2026-07-12": [_entry(_RUN, "2026-07-12T10:00:00+00:00")]}
)
with (
patch.object(_manual_push, "read_sync_token", return_value="t"),
patch.object(_manual_push, "GitHubSyncClient", MagicMock()),
patch.object(_manual_push, "sync_log", MagicMock()) as fake_sync,
):
push_pc_workouts(log_file)
pushed = fake_sync.call_args.kwargs["local_log"]
assert "runnerup_verified:2026-07-12" in pushed