diet-guard/diet_guard/tests/test_sync_banks.py
Krzysztof kuhy Rudnicki e23f7ac3b4
Some checks are pending
pre-commit / pre-commit (push) Waiting to run
Tests / test (3.10) (push) Waiting to run
Tests / test (3.11) (push) Waiting to run
Tests / test (3.12) (push) Waiting to run
release-apk / release (APK) (push) Waiting to run
Push under a persisted per-install uuid, not a fixed role id
diet_guard pushed as "pc" (Python), "phone" (Android) and "desktop" (web).
A role constant collides the moment a second machine takes the same role,
and after a reinstall the new install inherits the previous one's CRDT
identity -- the same reasoning home_inventory already records for choosing a
uuid. Both halves now mint a uuid once and persist it: the PC in
~/.local/share/diet_guard/.device_id, the app under SharedPreferences
'crdt.nodeId' (the key todo and home_inventory already use).

The old constant survives as the legacy id and is passed to sync_log /
syncLog, so devices/<legacy>/ is skipped as this device's own. Without that
every tick would re-download and re-merge this device's own pre-migration
log as though a peer had written it -- idempotent under LWW, but hundreds of
KB, 96 times a day. It drops to None once that path is reclaimed; a test
covers both states, including a negative control proving the skip is the
legacy id's doing.

All four documents move together (food_log, food_bank, food_bank_manual,
budget), and the hist:<date> fields riding on the budget record are
untouched -- merge_record unions field names, so they relay through
unchanged.

The resolver lives in its own module (_device.py / sync_device_id.dart)
because _sync_merge needs it for HLC stamping too and importing _sync there
would be a cycle. Dart resolves it asynchronously at startup, before
LogStorageService.init(); currentSyncDeviceId falls back to the compile-time
role constant until then, so a too-early Hlc stamp gets a valid id rather
than crashing.

conftest redirects the new id file in the same change that introduces it --
without that a test mints a uuid into the real state dir and this machine's
live sync identity is decided by whichever test ran first. Verified by
checking ~/.local/share/diet_guard/ before and after: untouched.

Verified live, not just against mocks: the sync timer ran mid-change and
migrated this machine to f8f46da6. All 358 food_log records and all 100
food_bank records are present under the new path (0 missing vs devices/pc/),
and the new log's HLCs carry only its own id -- confirming it did not
re-merge the old path as a peer.

Python: 687 tests, 100% branch coverage. App: 518 tests, analyzer clean.
Pins bumped to crdt-sync-v0.6.0 / crdt_sync_dart-v0.7.0 (pyproject,
requirements.txt, .pre-commit-config.yaml, pubspec), and the new library is
installed into /usr/bin/python's user site-packages so the production timer
does not ImportError on its next tick.

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

248 lines
9.9 KiB
Python

"""Tests for the food bank's half of the sync tick.
Split out of ``test_sync.py`` to keep both files under the repo's 500-line
ceiling. Covers the derived bank (merged max-count-wins, with the log
authoritative for which foods exist) and the hand-curated bank (merged
last-writer-wins per food name).
"""
from __future__ import annotations
import json
from unittest.mock import patch
from diet_guard import _sync
from diet_guard._device import device_id
from diet_guard._estimator import Nutrition
from diet_guard._foodbank import lookup_food, read_food_bank
from diet_guard._foodbank_manual import add_manual_entry, read_manual_bank
from diet_guard._state import log_meal
from diet_guard._sync_merge import food_bank_to_log, manual_bank_to_log
from diet_guard.tests.test_sync import _mock_client, _write_token
class TestSyncFoodBank:
"""The log-derived food bank's cross-device merge."""
def test_the_local_bank_is_pushed(self) -> None:
_write_token()
# Through the log, not remember_food: run_sync rebuilds the derived
# bank from the merged log first, so a bank entry with no log entry
# behind it is (correctly) discarded before the push.
log_meal("apple", Nutrition(95, 0.5, 25, 0.3, 180, "manual"), 8)
client = _mock_client(devices=())
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
pushed = [call.args[0] for call in client.put_file_text.call_args_list]
assert f"diet-guard-sync/devices/{device_id()}/food_bank.json" in pushed
def test_a_food_the_phone_logged_reaches_the_gate(self) -> None:
"""The payoff: a food eaten on the phone autocompletes on the PC.
It arrives through the *log* (which merges first in the same tick),
and the bank rebuild picks it up -- membership follows the log, so
this is the path that actually delivers cross-device autocomplete.
"""
_write_token()
remote_log_json = json.dumps(
{
"2026-06-22": [
{
"id": "phone-skyr",
"time": "2026-06-22T09:00:00+02:00",
"desc": "Skyr",
"kcal": 120.0,
"protein_g": 20.0,
"carbs_g": 5.0,
"fat_g": 0.5,
"grams": 150.0,
"source": "manual",
},
],
},
)
client = _mock_client(
devices=("phone",),
files={"diet-guard-sync/devices/phone/food_log.json": remote_log_json},
)
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
found = lookup_food("Skyr")
assert found is not None
assert found.kcal == 120.0
def test_a_deleted_food_is_not_resurrected_by_a_peer(self) -> None:
"""Regression: a CRDT union never shrinks.
Without the log staying authoritative for membership, a peer's stale
copy of a food whose entries were all undone out-clocks the local
absence, gets written back AND re-pushed -- permanently un-deletable.
"""
_write_token()
# This device's log knows nothing of "skyr" (its entries were undone).
log_meal("apple", Nutrition(95, 0.5, 25, 0.3, 180, "manual"), 8)
remote = json.dumps(
{
rid: rec.to_dict()
for rid, rec in food_bank_to_log(
{"skyr": {"desc": "Skyr", "kcal": 120.0, "count": 3}},
).items()
},
)
client = _mock_client(
devices=("phone",),
files={"diet-guard-sync/devices/phone/food_bank.json": remote},
)
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
assert lookup_food("Skyr") is None
pushed = [
call.args[1]
for call in client.put_file_text.call_args_list
if call.args[0].endswith("food_bank.json")
]
assert pushed
assert "skyr" not in pushed[0]
def test_a_higher_remote_count_still_refines_a_known_food(self) -> None:
"""Membership defers to the log; content still takes the better count."""
_write_token()
log_meal("apple", Nutrition(95, 0.5, 25, 0.3, 180, "manual"), 8)
remote = json.dumps(
{
rid: rec.to_dict()
for rid, rec in food_bank_to_log(
{"apple": {"desc": "Apple", "kcal": 95.0, "count": 99}},
).items()
},
)
client = _mock_client(
devices=("phone",),
files={"diet-guard-sync/devices/phone/food_bank.json": remote},
)
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
assert read_food_bank()["apple"]["count"] == 99
def test_unparsable_remote_food_bank_is_skipped(self) -> None:
_write_token()
log_meal("apple", Nutrition(95, 0.5, 25, 0.3, 180, "manual"), 8)
client = _mock_client(
devices=("phone",),
files={"diet-guard-sync/devices/phone/food_bank.json": "{not json"},
)
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
assert lookup_food("apple") is not None
def test_nothing_pushed_when_no_device_has_a_bank(self) -> None:
_write_token()
client = _mock_client(devices=())
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
pushed = [call.args[0] for call in client.put_file_text.call_args_list]
assert f"diet-guard-sync/devices/{device_id()}/food_bank.json" not in pushed
class TestSyncManualBank:
"""The hand-curated food bank's cross-device merge."""
def test_nothing_pushed_when_no_device_has_curated_anything(self) -> None:
_write_token()
client = _mock_client(devices=())
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
pushed = [call.args[0] for call in client.put_file_text.call_args_list]
assert not any("food_bank_manual" in path for path in pushed)
def test_local_curated_entry_is_pushed(self) -> None:
_write_token()
add_manual_entry("Skyr", {"desc": "Skyr", "kcal": 120.0, "count": 0})
client = _mock_client(devices=())
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
pushed = [call.args[0] for call in client.put_file_text.call_args_list]
assert f"diet-guard-sync/devices/{device_id()}/food_bank_manual.json" in pushed
def test_a_remote_curated_entry_is_adopted_locally(self) -> None:
"""The point of the whole feature: a food added on the phone is usable
on the PC, in the gate's autocomplete, without ever being eaten."""
_write_token()
remote = json.dumps(
{
record_id: record.to_dict()
for record_id, record in manual_bank_to_log(
{
"skyr": {
"desc": "Skyr",
"kcal": 120.0,
"protein_g": 20.0,
"carbs_g": 5.0,
"fat_g": 0.5,
"grams": 150.0,
"count": 0,
"t": "2026-07-26T10:00:00+02:00",
},
},
).items()
},
)
client = _mock_client(
devices=("phone",),
files={"diet-guard-sync/devices/phone/food_bank_manual.json": remote},
)
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
assert "skyr" in read_manual_bank()
found = lookup_food("Skyr")
assert found is not None
assert found.kcal == 120.0
def test_a_newer_remote_edit_wins(self) -> None:
_write_token()
add_manual_entry("Skyr", {"desc": "Skyr", "kcal": 120.0, "count": 0})
remote = json.dumps(
{
record_id: record.to_dict()
for record_id, record in manual_bank_to_log(
{
"skyr": {
"desc": "Skyr",
"kcal": 999.0,
"count": 0,
"t": "2999-01-01T00:00:00+02:00",
},
},
).items()
},
)
client = _mock_client(
devices=("phone",),
files={"diet-guard-sync/devices/phone/food_bank_manual.json": remote},
)
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
assert read_manual_bank()["skyr"]["kcal"] == 999.0
def test_unparsable_remote_curated_bank_is_skipped(self) -> None:
_write_token()
add_manual_entry("Skyr", {"desc": "Skyr", "kcal": 120.0, "count": 0})
client = _mock_client(
devices=("phone",),
files={
"diet-guard-sync/devices/phone/food_bank_manual.json": "{not json",
},
)
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
assert read_manual_bank()["skyr"]["kcal"] == 120.0
def test_a_device_with_no_pushed_curated_bank_is_skipped(self) -> None:
_write_token()
add_manual_entry("Skyr", {"desc": "Skyr", "kcal": 120.0, "count": 0})
client = _mock_client(devices=("phone",))
with patch.object(_sync, "GitHubSyncClient", return_value=client):
_sync.run_sync()
assert read_manual_bank()["skyr"]["kcal"] == 120.0