headroom/tests/test_proxy/test_cc_switch_reconciler.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

165 lines
5.3 KiB
Python
Raw Normal View History

feat(proxy): cc-switch reconciler — keep Headroom in the request path alongside cc-switch (#1030) ## Description [cc-switch](https://github.com/farion1231/cc-switch) is a desktop provider manager for Claude Code and other coding agents; when a Claude Code provider is selected, it writes that provider's endpoint and token into `~/.claude/settings.json`. This PR adds an opt-in reconciler so Headroom can stay in Claude Code's request path when cc-switch rewrites that file during provider switches. The reconciler captures third-party Anthropic-compatible upstream URLs, points Claude back at the local Headroom proxy, and leaves official/empty OAuth settings direct unless explicitly opted in. This update also hardens the watcher so rapid settings rewrites that share the same float-second mtime are still detected. ## Type of Change - [x] Bug fix (non-breaking change that fixes an issue) - [x] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - Added an opt-in `HEADROOM_CC_SWITCH_RECONCILE=1` watcher for cc-switch direct-injection mode. - Added loopback-only `GET/PUT /admin/upstream` runtime upstream inspection and override endpoints. - Preserved token/model settings while rewriting only `env.ANTHROPIC_BASE_URL` back to the local Headroom proxy. - Switched reconciler change detection from float-second `st_mtime` to nanosecond `st_mtime_ns` so rapid provider switches are not missed. - Added pytest coverage for capture/rewrite behavior, official-provider defaults, route-official opt-in, loop safety, enabled flags, and the same-float-mtime provider-switch case. ## Testing - [ ] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check .`) - [x] Type checking passes (`mypy headroom`) - [x] New tests added for new functionality - [ ] Manual testing performed ### Test Output ```text python -m pytest tests/test_proxy/test_cc_switch_reconciler.py 12 passed in 0.17s python -m ruff check . All checks passed! python -m mypy headroom Success: no issues found in 359 source files python -m pytest 7 failed, 5996 passed, 492 skipped, 5814 warnings in 396.41s ``` ## Real Behavior Proof - Environment: macOS, branch `feat/cc-switch-reconciler`, Python 3.13.3. - Exact command / steps: Ran the focused reconciler pytest file, full repository ruff check, full `mypy headroom`, and full pytest from the local PR branch. - Observed result: All 12 reconciler tests passed, including the rapid provider-switch case where two writes share the same float mtime but differ by nanoseconds. Full `ruff check .` and `mypy headroom` passed. Full pytest completed with 7 failures outside the cc-switch reconciler test file. - Not tested: Live cc-switch plus Claude Code end-to-end switch. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] I have updated the CHANGELOG.md if applicable ## Screenshots (if applicable) N/A. ## Additional Notes Documentation and CHANGELOG updates are not included in this PR. The reconciler remains opt-in and off by default. --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-17 21:41:16 +08:00
"""Tests for the cc-switch reconciler.
The reconciler keeps Headroom in the request path while cc-switch overwrites
``~/.claude/settings.json`` on every provider switch. See
``headroom/proxy/cc_switch_reconciler.py``.
"""
from __future__ import annotations
import json
import os
import pytest
from headroom.proxy.cc_switch_reconciler import CCSwitchReconciler
PROXY = "http://127.0.0.1:8787"
DEFAULT = "https://api.anthropic.com"
def _make(tmp_path):
captured: list[str] = []
sf = tmp_path / "settings.json"
r = CCSwitchReconciler(
proxy_url=PROXY,
default_upstream=DEFAULT,
set_upstream=captured.append,
path=sf,
)
return r, sf, captured
def _write(sf, obj):
sf.write_text(json.dumps(obj))
os.utime(sf, None)
def test_third_party_captured_and_base_url_rewritten(tmp_path):
r, sf, captured = _make(tmp_path)
_write(
sf,
{
"env": {
"ANTHROPIC_BASE_URL": "https://api.deepseek.com/anthropic",
"ANTHROPIC_AUTH_TOKEN": "sk-x",
"ANTHROPIC_MODEL": "deepseek",
}
},
)
assert r.tick() is True
env = json.loads(sf.read_text())["env"]
# base_url repointed to Headroom; token + model preserved verbatim.
assert env["ANTHROPIC_BASE_URL"] == PROXY
assert env["ANTHROPIC_AUTH_TOKEN"] == "sk-x"
assert env["ANTHROPIC_MODEL"] == "deepseek"
# Real endpoint captured as the upstream.
assert captured[-1] == "https://api.deepseek.com/anthropic"
assert r.current_upstream == "https://api.deepseek.com/anthropic"
def test_no_rewrite_loop(tmp_path):
r, sf, _ = _make(tmp_path)
_write(sf, {"env": {"ANTHROPIC_BASE_URL": "https://api.deepseek.com/anthropic"}})
assert r.tick() is True
# Already pointing at Headroom now -> must be a no-op (no infinite loop).
assert r.tick() is False
def test_switching_provider_recaptures(tmp_path):
r, sf, captured = _make(tmp_path)
_write(
sf,
{
"env": {
"ANTHROPIC_BASE_URL": "https://api.deepseek.com/anthropic",
"ANTHROPIC_AUTH_TOKEN": "sk-d",
}
},
)
assert r.tick() is True
_write(
sf,
{
"env": {
"ANTHROPIC_BASE_URL": "https://api.kimi.com/anthropic",
"ANTHROPIC_AUTH_TOKEN": "sk-k",
}
},
)
assert r.tick() is True
assert captured[-1] == "https://api.kimi.com/anthropic"
assert json.loads(sf.read_text())["env"]["ANTHROPIC_AUTH_TOKEN"] == "sk-k"
def test_same_float_mtime_provider_switch_recaptures(tmp_path):
r, sf, captured = _make(tmp_path)
base_ns = 1_700_000_000_000_000_000
_write(sf, {"env": {"ANTHROPIC_BASE_URL": "https://api.deepseek.com/anthropic"}})
os.utime(sf, ns=(base_ns, base_ns))
assert r.tick() is True
_write(sf, {"env": {"ANTHROPIC_BASE_URL": "https://api.kimi.com/anthropic"}})
os.utime(sf, ns=(base_ns + 1, base_ns + 1))
assert sf.stat().st_mtime == float(base_ns / 1_000_000_000)
assert r.tick() is True
assert captured[-1] == "https://api.kimi.com/anthropic"
def test_official_left_direct_by_default(tmp_path, monkeypatch):
monkeypatch.delenv("HEADROOM_CC_SWITCH_ROUTE_OFFICIAL", raising=False)
r, sf, _ = _make(tmp_path)
_write(sf, {"env": {}})
# Empty env = "Claude Official" (OAuth). Default: leave it direct.
assert r.tick() is False
assert json.loads(sf.read_text())["env"] == {}
def test_official_routed_when_opted_in(tmp_path, monkeypatch):
monkeypatch.setenv("HEADROOM_CC_SWITCH_ROUTE_OFFICIAL", "1")
r, sf, captured = _make(tmp_path)
_write(sf, {"env": {}})
assert r.tick() is True
assert json.loads(sf.read_text())["env"]["ANTHROPIC_BASE_URL"] == PROXY
assert captured[-1] == DEFAULT
def test_missing_file_is_noop(tmp_path):
r, _, _ = _make(tmp_path) # path does not exist yet
assert r.tick() is False
def test_non_string_base_url_does_not_crash(tmp_path):
r, sf, captured = _make(tmp_path)
# A hand-edited / malformed file with a non-string base_url must not raise
# (would otherwise blow up on .rstrip() and spam the watcher loop).
_write(sf, {"env": {"ANTHROPIC_BASE_URL": 1234}})
assert r.tick() is False # treated as empty -> left direct
assert captured == []
def test_transient_invalid_json_retries_next_tick(tmp_path):
r, sf, captured = _make(tmp_path)
# Mid-write garbage: read/parse fails, mtime must NOT be consumed.
sf.write_text("{not valid json")
os.utime(sf, ns=(1_700_000_000_000_000_000, 1_700_000_000_000_000_000))
assert r.tick() is False
assert r._last_mtime_ns is None # broken state not marked processed
# File repaired at the SAME mtime: next tick must still process it.
sf.write_text(json.dumps({"env": {"ANTHROPIC_BASE_URL": "https://api.deepseek.com/anthropic"}}))
os.utime(sf, ns=(1_700_000_000_000_000_000, 1_700_000_000_000_000_000))
assert r.tick() is True
assert captured[-1] == "https://api.deepseek.com/anthropic"
@pytest.mark.parametrize(
"val,expected",
[("1", True), ("true", True), ("on", True), ("0", False), ("", False)],
)
def test_enabled_flag(monkeypatch, val, expected):
from headroom.proxy.cc_switch_reconciler import reconciler_enabled
monkeypatch.setenv("HEADROOM_CC_SWITCH_RECONCILE", val)
assert reconciler_enabled() is expected