diet-guard/diet_guard/tests/test_sync_backend.py
Krzysztof kuhy Rudnicki c7371d7e0d perf(gate): unfreeze "Fetch from sync" and bound the interactive timeout
The button ran a full sync tick inline on the Tk thread, so the fullscreen
lock was dead for its whole duration -- ~18-27s measured against the live
remote, and unbounded in the worst case.

Two changes, and the second is what makes the first cheap:

* the pull moves to a daemon worker thread, with the result marshalled back
  through a queue polled on the Tk thread. The worker touches no widget, by
  construction: Tcl is not thread-safe and that includes `after`. Polling
  also makes the completion path testable with no thread at all.
* the button now runs the *narrow* pull. Its question is identical to the
  gate's -- "did a peer log this slot?" -- and `_reconcile_after_fetch`
  reads only `due_slots()`, so the budget and food banks it used to fetch
  were never consulted here. The full tick still runs after the window
  closes. Measured 84ms against the live remote.

Narrowing also shrinks the write race from tens of seconds to imperceptible:
the pull persists its merge, so a meal logged mid-fetch could be overwritten
by a snapshot taken before it. A second click while a fetch is in flight is
now ignored, which is the reentrancy guard and the race fix in one.

That guard started out as a disabled button, which is how it surfaced a
latent bug worth recording: the fetch button widget is never stored on
`GateWidgets`, so `self._widgets.fetch_button` did not exist and the disable
was a silent no-op -- hidden because the suppression tuple included
`AttributeError`. Coverage would have reported 100% on a guard that did
nothing. Guarding on `_fetch_result` needs no widget at all.

Also adds `INTERACTIVE_TIMEOUT_SECONDS = 2.0` for the paths a user waits on.
`SYNC_TIMEOUT_SECONDS` only ever reached GitHub: crdt_sync v0.6.0's
`firebase_client_for` takes no timeout, so Firebase used its 15s default and
one hung session refresh stalled the lock window -- the journal has five such
refresh failures in five days. Verified to fail closed to the local decision.

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

161 lines
6.0 KiB
Python

"""Tests for which backend a sync tick runs against.
Split out of ``test_sync.py`` to keep both files under the repo's 500-line
cap. Covers the Firebase/GitHub cutover seam (``_remote_client``) and which
credentials a run actually requires (``_client_for_run``).
"""
from __future__ import annotations
from pathlib import Path
from types import SimpleNamespace
from crdt_sync import ConfigError
import pytest
from diet_guard import _sync, _sync_client
class TestRemoteClient:
"""Which backend a sync tick runs against during the cutover."""
def test_stays_on_github_without_firebase_config(
self, monkeypatch: pytest.MonkeyPatch
) -> None:
"""An unconfigured machine must not reach the network at all."""
monkeypatch.setattr(
_sync_client, "CONFIG_FILE", Path("/nonexistent/firebase.json")
)
github = object()
assert _sync_client._remote_client(github) is github
def test_mirrors_to_github_when_configured(
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
"""Configured: Firebase is primary, GitHub keeps receiving writes."""
config = tmp_path / "firebase.json"
config.write_text("{}", encoding="utf-8")
monkeypatch.setattr(_sync_client, "CONFIG_FILE", config)
monkeypatch.setattr(
_sync_client, "mirror_client_for", lambda _app, client: ("mirror", client)
)
github = object()
assert _sync_client._remote_client(github) == ("mirror", github)
def test_falls_back_when_firebase_is_unusable(
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
"""A broken Firebase must degrade to GitHub, never fail the tick."""
config = tmp_path / "firebase.json"
config.write_text("{}", encoding="utf-8")
monkeypatch.setattr(_sync_client, "CONFIG_FILE", config)
def _boom(*_args: object, **_kwargs: object) -> None:
message = "no password"
raise ConfigError(message)
monkeypatch.setattr(_sync_client, "mirror_client_for", _boom)
github = object()
assert _sync_client._remote_client(github) is github
class TestClientForRun:
"""Which credentials a run actually requires."""
def test_syncs_without_a_pat_when_firebase_is_configured(
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
"""A Firebase-only machine must sync, not fail for a missing PAT.
Requiring the token before ever constructing Firebase left the Python
half unable to sync at all on a device that had moved to Firebase --
the "Firebase-only device" fix had only ever touched the Dart side.
"""
config = tmp_path / "firebase.json"
config.write_text("{}", encoding="utf-8")
monkeypatch.setattr(_sync_client, "CONFIG_FILE", config)
monkeypatch.setattr(
_sync_client, "SYNC_TOKEN_FILE", tmp_path / "absent_sync_token"
)
monkeypatch.setattr(
_sync_client, "firebase_client_for", lambda app: ("firebase", app)
)
assert _sync_client._client_for_run() == ("firebase", "diet_guard")
def test_unusable_firebase_config_becomes_a_sync_error(
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
"""An unusable Firebase config must fail *closed*, not raise.
``ConfigError`` subclasses ``Exception`` directly, not
``RemoteSyncError``, so letting it out of here escapes every caller's
catch tuple and raises a traceback out of the gate's fail-closed
"Fetch from sync" button -- reintroducing, by a different exception,
exactly the failure the ``RemoteSyncError`` swap was made to stop.
This branch is reached precisely when the config file exists but is
unusable and no PAT is present.
"""
config = tmp_path / "firebase.json"
config.write_text("{}", encoding="utf-8")
monkeypatch.setattr(_sync_client, "CONFIG_FILE", config)
monkeypatch.setattr(_sync_client, "SYNC_TOKEN_FILE", tmp_path / "absent_token")
def _boom(*_args: object, **_kwargs: object) -> None:
message = "no password"
raise ConfigError(message)
monkeypatch.setattr(_sync_client, "firebase_client_for", _boom)
with pytest.raises(_sync.SyncError):
_sync_client._client_for_run()
def test_still_fails_when_neither_backend_is_configured(
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
"""No PAT *and* no Firebase is the genuine "nothing is set up" case."""
monkeypatch.setattr(
_sync_client, "CONFIG_FILE", tmp_path / "absent_firebase.json"
)
monkeypatch.setattr(
_sync_client, "SYNC_TOKEN_FILE", tmp_path / "absent_sync_token"
)
with pytest.raises(_sync.SyncError):
_sync_client._client_for_run()
class TestInteractiveTimeout:
"""The short per-request budget for paths the user is waiting on."""
def test_tightens_every_backend_half(self) -> None:
"""A mirrored client must bound both halves, not just the primary."""
client = SimpleNamespace(
primary=SimpleNamespace(_timeout_seconds=15.0),
mirror=SimpleNamespace(_timeout_seconds=10.0),
)
_sync_client._apply_timeout(client, 2.0)
assert client.primary._timeout_seconds == 2.0
assert client.mirror._timeout_seconds == 2.0
def test_a_client_without_the_attribute_is_left_alone(self) -> None:
"""Never invent a setting on a backend that does not read one."""
client = SimpleNamespace()
_sync_client._apply_timeout(client, 2.0)
assert not hasattr(client, "_timeout_seconds")
def test_a_bare_client_is_tightened_directly(self) -> None:
"""Not every backend is mirrored; the unwrapped case must work too."""
client = SimpleNamespace(_timeout_seconds=15.0)
_sync_client._apply_timeout(client, 2.0)
assert client._timeout_seconds == 2.0