Files
hermes-agent/tests/hermes_cli/test_codex_token_writethrough.py
kshitijk4poor ca6b189a7c fix(codex): both transaction locks wait out the endpoint; adopt only a complete pair
Review follow-ups on the refresh transaction:
- `_provider_state_transaction` takes a `timeout_seconds` applied to BOTH the
  active and the root lock. The refresh passes max(default, refresh timeout
  + 5 s); before, only the profile lock used that budget and root's lock kept
  the 15 s default, so the waiting profile raised TimeoutError instead of
  adopting whenever the peer's POST ran long. The regression test now holds
  the endpoint past the lock floor and fails without the passthrough.
- Peer adoption requires a stored access token as well as a rotated refresh
  token; an incomplete stored pair falls through to the refresh.
- `_save_codex_tokens` keeps its body: the per-path lock is reentrant, so the
  refresh calls it inside the open transaction (as the CLI-recovery path
  already did) instead of a split-out helper.
2026-09-14 20:38:07 +05:30

148 lines
6.1 KiB
Python

"""Codex OAuth refresh writes back to the store the grant was resolved FROM (#87503).
Codex refresh tokens are single-use with rotation-family reuse detection: a profile that refreshed
a root-borrowed grant must land the rotated chain in root — singleton AND ``credential_pool`` —
or root keeps the consumed refresh token and the next reader gets the whole family revoked.
Token values are synthetic placeholders.
"""
import json
import threading
from pathlib import Path
import httpx
import pytest
from hermes_cli import auth, auth_codex
def _pair(prefix: str) -> dict:
return {"access_token": f"{prefix}-at", "refresh_token": f"{prefix}-rt"}
def _write(path: Path, store: dict) -> None:
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(json.dumps(store), encoding="utf-8")
def _read(path: Path) -> dict:
return json.loads(path.read_text(encoding="utf-8"))
@pytest.fixture
def profile_env(tmp_path, monkeypatch):
"""Global root at tmp/.hermes, active profile at tmp/.hermes/profiles/work (real on-disk layout)."""
monkeypatch.setattr(Path, "home", lambda: tmp_path)
monkeypatch.setenv("LOCALAPPDATA", str(tmp_path)) # Windows resolves the native root from here
root = tmp_path / ".hermes"
profile = root / "profiles" / "work"
profile.mkdir(parents=True)
monkeypatch.setenv("HERMES_HOME", str(profile))
return profile / "auth.json", root / "auth.json"
def test_profile_refresh_of_root_grant_writes_through_to_root(profile_env):
profile_path, root_path = profile_env
_write(root_path, {
"version": 1,
"providers": {"openai-codex": {"auth_mode": "chatgpt", "tokens": _pair("old")}},
"credential_pool": {"openai-codex": [
{"provider": "openai-codex", "source": "device_code", **_pair("old")}]},
})
_write(profile_path, {"version": 1, "providers": {}})
rotated = _pair("new")
auth._save_codex_tokens(rotated, last_refresh="2026-08-16T00:00:00Z", write_through=True)
root = _read(root_path)
assert root["providers"]["openai-codex"]["tokens"] == rotated
assert root["credential_pool"]["openai-codex"][0]["refresh_token"] == rotated["refresh_token"]
assert root["credential_pool"]["openai-codex"][0]["access_token"] == rotated["access_token"]
# A profile copy would shadow root and disable the write-through on the next refresh (#74339).
assert "openai-codex" not in _read(profile_path).get("providers", {})
def test_profile_owned_grant_stays_local(profile_env):
profile_path, root_path = profile_env
_write(profile_path, {
"version": 1,
"providers": {"openai-codex": {"auth_mode": "chatgpt", "tokens": _pair("prof")}},
})
_write(root_path, {"version": 1, "providers": {}})
rotated = _pair("next")
auth._save_codex_tokens(rotated, last_refresh="2026-08-16T00:00:00Z", write_through=True)
assert _read(profile_path)["providers"]["openai-codex"]["tokens"] == rotated
assert "openai-codex" not in _read(root_path).get("providers", {})
# A fresh login under a profile that was borrowing root's grant is the profile's own account,
# never a rewrite of root's.
_write(profile_path, {"version": 1, "providers": {}})
_write(root_path, {"version": 1, "providers": {"openai-codex": {"auth_mode": "chatgpt", "tokens": _pair("root")}}})
auth._save_codex_tokens(_pair("login"))
assert _read(profile_path)["providers"]["openai-codex"]["tokens"] == _pair("login")
assert _read(root_path)["providers"]["openai-codex"]["tokens"] == _pair("root")
class _RotatingEndpoint:
"""Token endpoint that rotates ``old-rt`` once and rejects any replay of a consumed token."""
def __init__(self, hold_seconds: float):
self.hold_seconds = hold_seconds
self.seen: list = []
self._guard = threading.Lock()
def __enter__(self):
return self
def __exit__(self, *exc):
return False
def post(self, url, *, headers=None, data=None):
import time
with self._guard:
replay = data["refresh_token"] in self.seen
self.seen.append(data["refresh_token"])
time.sleep(self.hold_seconds) # a concurrent refresher must wait on the lock, not overlap
if replay:
return httpx.Response(400, json={"error": "refresh_token_reused"})
return httpx.Response(200, json={"access_token": "new-at", "refresh_token": "new-rt"})
def test_concurrent_refreshes_of_shared_root_grant_submit_old_token_once(profile_env, monkeypatch):
"""Two refreshers holding the same stale pre-read pair: the second re-reads ROOT under its lock,
sees the peer's rotated pair and adopts it instead of replaying the single-use token."""
profile_path, root_path = profile_env
_write(root_path, {
"version": 1,
"providers": {"openai-codex": {"auth_mode": "chatgpt", "tokens": _pair("old")}},
})
_write(profile_path, {"version": 1, "providers": {}})
endpoint = _RotatingEndpoint(hold_seconds=1.5) # longer than the lock floor (1 s)
monkeypatch.setattr(auth_codex, "_codex_http_client", lambda **kw: endpoint)
# The waiter must outlive the peer's endpoint call on BOTH locks: with the default lock
# timeout shorter than the POST, the second profile would raise TimeoutError instead of adopt.
monkeypatch.setattr(auth._auth_store_lock.__wrapped__, "__defaults__", (1.0,))
monkeypatch.setattr(auth_codex, "AUTH_LOCK_TIMEOUT_SECONDS", 1.0)
results, errors = {}, {}
def _refresh(name):
try:
results[name] = auth._refresh_codex_auth_tokens(_pair("old"), timeout_seconds=1.0)
except Exception as exc: # pragma: no cover - surfaced via the assertion below
errors[name] = exc
workers = [threading.Thread(target=_refresh, args=(n,)) for n in ("a", "b")]
for w in workers:
w.start()
for w in workers:
w.join(timeout=10)
assert errors == {}
assert endpoint.seen == ["old-rt"]
assert results == {"a": _pair("new"), "b": _pair("new")}
assert _read(root_path)["providers"]["openai-codex"]["tokens"] == _pair("new")
assert "openai-codex" not in _read(profile_path).get("providers", {})