mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 15:10:00 +08:00
## Description `resolve_learned_ttl()` re-read `HEADROOM_CACHE_TTL_LEARNED_PATH` on each call but cached the loaded table using only mtime. Two different files with the same mtime therefore shared one cached table. Switching from a 300-second file to an 1800-second file still returned 300; a controlled 600-second idle was then classified as cold. The same collision occurs when a relative path resolves under a different working directory. Include the absolute source path in the cache identity alongside mtime. A source change reloads the selected file; repeated reads of the same unchanged file remain cached. This completes the file-to-decision part of the TTL flow exercised by #4711 and #4710. ## Type of Change - [x] Bug fix (non-breaking change that fixes an issue) ## Changes Made - Cache the absolute source path only after a successful load, and reload when that path changes. - Keep missing files best-effort and ignore invalid table shapes on the new source. - Keep fixture initialization compatible with unpatched production code; the final test module replays its four behavioral failures on main. - Cover equal-mtime source switches and switch-back, relative paths across directories, a warm-prefix decision, and unchanged-file read-once behavior. ## Testing - [x] Relevant unit tests pass (`pytest`) - [x] Linting passes (`ruff check .`) - [x] Formatting passes (`ruff format --check .`) - [x] Type checking passes (original full-package mypy hook) - [x] Regression tests added - [x] Standalone runtime validation completed ### Test Output ```text Owner test file with new regressions on original production code: 4 failed, 32 passed pytest tests/test_cache tests/test_cold_prefix.py: 365 passed, 3 skipped Original pre-commit and commit-msg hooks: passed Whole-tree Ruff check and format --check: passed (1924 files) Original pre-push make ci-precheck: passed Rust workspace: 1749 passed, 3 ignored Native extension: built, installed and import-verified Critical Python: 177 passed, 8 skipped commitlint: passed ``` The three cache skips require optional spaCy/embedding models. Critical-suite skips require optional relevance models; the existing token-count approximation warning remains in that log. ## Real Behavior Proof - Environment: Windows 11, CPython 3.13.9, existing development venv; clean baseline `1da8930ab47a2fc5339ded97e5a41bfe6fc419eb`, patch `4b863c460828d095f4e00020a90d5dd3c00cf5c0`. `HEADROOM_OFFLINE=1`, `PYTHONPATH=.` for the selected checkout. Real local files, public APIs and controlled idle inputs; no provider credentials. - Exact command / steps: Run `python proof.py` from either checkout with the following identical script. Both before and after runs were outside pytest. ```python import json import os from pathlib import Path import tempfile from headroom.cache.ttl_estimator import write_learned from headroom.cache.ttl_observations import resolve_learned_ttl from headroom.cache.prefix_tracker import PrefixCacheTracker from headroom.transforms.cold_prefix import is_cold_prefix with tempfile.TemporaryDirectory() as directory: root = Path(directory) first, second = root / "first.json", root / "second.json" for path, ttl in ((first, 300), (second, 1800)): write_learned({"openai/fixture": {"ttl_seconds": ttl}}, str(path)) os.utime(path, ns=(1_700_000_000_000_000_000,) * 2) os.environ["HEADROOM_CACHE_TTL_LEARNED_PATH"] = str(first) initial = resolve_learned_ttl("openai", "fixture") os.environ["HEADROOM_CACHE_TTL_LEARNED_PATH"] = str(second) switched = resolve_learned_ttl("openai", "fixture") tracker = PrefixCacheTracker("openai") tracker._idle_seconds_at_fetch = 600 print(json.dumps({"same_mtime": first.stat().st_mtime == second.stat().st_mtime, "first_ttl": initial, "second_file_ttl": 1800, "resolved_after_switch": switched, "cold_at_600_seconds": is_cold_prefix(tracker, ttl_seconds=switched)})) ``` - Observed result: The genuine learned-table writer creates two files, whose mtimes are set equal. After selecting the second path, the resolver now returns 1800 instead of 300; the actual cold-prefix helper keeps a controlled 600-second idle warm. ```text Before: {"same_mtime": true, "first_ttl": 300, "second_file_ttl": 1800, "resolved_after_switch": 300, "cold_at_600_seconds": true} After: {"same_mtime": true, "first_ttl": 300, "second_file_ttl": 1800, "resolved_after_switch": 1800, "cold_at_600_seconds": false} ``` - Not tested: Live proxy/provider traffic, measured provider TTLs, billing or model quality, and the complete Python suite. The runtime proof verifies the local classification/file/CLI/decision behavior above; hosted CI is tracked separately. ## Runtime Rollout Safety - Rollout-managed feature(s): Existing optional TTL-learning/cold-prefix behavior; no new flag. - Minimum rollout channel: Normal release after maintainer review and CI qualification. - Stable/default behavior changed: The learned table follows its selected source file even when another source shares its timestamp. The existing mtime refresh, value validation and provider/model precedence remain intact. - Kill switch / disable path: Remove the optional learned file to use existing fallback TTLs; existing cold-recompaction flags control their callers. - Unsafe override required: No. - Qualification impact: Owner cache/cold-prefix tests and original local gates passed; hosted checks provide remote qualification. - Rollback path: Revert this commit. No dependency or storage-schema change. ## 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 added tests that prove the fix - [x] Relevant new and existing tests pass locally - [x] I did **not** edit `CHANGELOG.md` ## Additional Notes Implementation and local validation were completed with Codex assistance. The author reviewed the initial code and validation record; the fixture-only compatibility follow-up was checked with Codex. <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/headroomlabs-ai/headroom/pull/4727" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-devin-review-dark.svg?v=4"><img src="https://static.devin.ai/assets/gh-devin-review-light.svg?v=4" alt="Devin Review"></picture></a> <!-- devin-review-badge-end -->
210 lines
8.7 KiB
Python
210 lines
8.7 KiB
Python
"""Learned TTL files must remain a best-effort input to live requests."""
|
|
|
|
import json
|
|
import os
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
|
|
from headroom.cache import ttl_observations
|
|
from headroom.cache.prefix_tracker import PrefixCacheTracker
|
|
from headroom.transforms.cold_prefix import is_cold_prefix
|
|
|
|
|
|
@pytest.mark.parametrize("layout", ["filename", "nested", "absolute"])
|
|
def test_observation_path_records_each_turn(tmp_path, monkeypatch, layout):
|
|
monkeypatch.chdir(tmp_path)
|
|
path = {
|
|
"filename": "observations.jsonl",
|
|
"nested": "nested/observations.jsonl",
|
|
"absolute": str(tmp_path / "absolute" / "observations.jsonl"),
|
|
}[layout]
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_LEARN", "1")
|
|
monkeypatch.delenv("HEADROOM_STATELESS", raising=False)
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_OBS_PATH", path)
|
|
for miss in (False, True):
|
|
attribution = SimpleNamespace(reason="ttl_expiry" if miss else "hit", is_miss=miss)
|
|
ttl_observations.record_cache_observation(
|
|
provider="openai", model="fixture", attribution=attribution
|
|
)
|
|
|
|
with open(path, encoding="utf-8") as stream:
|
|
rows = [json.loads(line) for line in stream]
|
|
assert [row["is_miss"] for row in rows] == [False, True]
|
|
assert all(row["model"] == "fixture" for row in rows)
|
|
|
|
|
|
@pytest.mark.parametrize("stateless", [False, True])
|
|
def test_relative_observation_path_respects_write_gates(tmp_path, monkeypatch, stateless):
|
|
monkeypatch.chdir(tmp_path)
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_OBS_PATH", "observations.jsonl")
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_LEARN", "1" if stateless else "0")
|
|
monkeypatch.setenv("HEADROOM_STATELESS", "1" if stateless else "0")
|
|
ttl_observations.record_cache_observation(
|
|
provider="openai", model="fixture", attribution=SimpleNamespace()
|
|
)
|
|
assert not (tmp_path / "observations.jsonl").exists()
|
|
|
|
|
|
def test_observation_path_failure_still_does_not_raise(tmp_path, monkeypatch):
|
|
parent = tmp_path / "not-a-directory"
|
|
parent.write_bytes(b"keep")
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_OBS_PATH", str(parent / "observations.jsonl"))
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_LEARN", "1")
|
|
monkeypatch.delenv("HEADROOM_STATELESS", raising=False)
|
|
ttl_observations.record_cache_observation(
|
|
provider="openai", model="fixture", attribution=SimpleNamespace()
|
|
)
|
|
assert parent.read_bytes() == b"keep"
|
|
|
|
|
|
@pytest.mark.windows_newline
|
|
def test_observation_writer_pins_lf(tmp_path, monkeypatch):
|
|
import builtins
|
|
|
|
path = tmp_path / "observations.jsonl"
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_OBS_PATH", str(path))
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_LEARN", "1")
|
|
monkeypatch.delenv("HEADROOM_STATELESS", raising=False)
|
|
real_open = builtins.open
|
|
writes = []
|
|
|
|
def recording_open(*args, **kwargs):
|
|
if args[0] == str(path) and len(args) > 1 and args[1] == "a":
|
|
writes.append(kwargs.get("newline"))
|
|
return real_open(*args, **kwargs)
|
|
|
|
monkeypatch.setattr(builtins, "open", recording_open)
|
|
ttl_observations.record_cache_observation(
|
|
provider="openai", model="fixture", attribution=SimpleNamespace()
|
|
)
|
|
assert writes == ["\n"]
|
|
assert path.read_bytes().endswith(b"\n")
|
|
assert b"\r" not in path.read_bytes()
|
|
|
|
|
|
@pytest.fixture
|
|
def learned_file(tmp_path, monkeypatch):
|
|
path = tmp_path / "learned.json"
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_LEARNED_PATH", str(path))
|
|
monkeypatch.setattr(ttl_observations, "_learned_cache", None)
|
|
monkeypatch.setattr(ttl_observations, "_learned_mtime", -1.0)
|
|
monkeypatch.setattr(ttl_observations, "_learned_cache_path", None, raising=False)
|
|
return path
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"second_table, expected", [({"openai": 1800}, 1800), ({}, None), ([300], None)]
|
|
)
|
|
def test_learned_cache_follows_configured_path_with_equal_mtimes(
|
|
learned_file, monkeypatch, second_table, expected
|
|
):
|
|
learned_file.write_text(json.dumps({"openai": 300}), encoding="utf-8")
|
|
second = learned_file.with_name("other.json")
|
|
second.write_text(json.dumps(second_table), encoding="utf-8")
|
|
for path in (learned_file, second):
|
|
os.utime(path, ns=(1_700_000_000_000_000_000,) * 2)
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 300
|
|
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_LEARNED_PATH", str(second))
|
|
ttl = ttl_observations.resolve_learned_ttl("openai", "fixture")
|
|
assert ttl == expected
|
|
if expected is not None:
|
|
tracker = PrefixCacheTracker("openai")
|
|
tracker._idle_seconds_at_fetch = 600
|
|
assert not is_cold_prefix(tracker, ttl_seconds=ttl)
|
|
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_LEARNED_PATH", str(learned_file))
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 300
|
|
|
|
|
|
def test_relative_learned_path_tracks_its_current_directory(learned_file, tmp_path, monkeypatch):
|
|
first, second = tmp_path / "first", tmp_path / "second"
|
|
for directory, ttl in ((first, 300), (second, 1800)):
|
|
directory.mkdir()
|
|
path = directory / "learned.json"
|
|
path.write_text(json.dumps({"openai": ttl}), encoding="utf-8")
|
|
os.utime(path, ns=(1_700_000_000_000_000_000,) * 2)
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_LEARNED_PATH", "learned.json")
|
|
monkeypatch.chdir(first)
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 300
|
|
monkeypatch.chdir(second)
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 1800
|
|
|
|
|
|
def test_unchanged_learned_source_is_read_only_once(learned_file, monkeypatch):
|
|
import builtins
|
|
|
|
learned_file.write_text(json.dumps({"openai": 900}), encoding="utf-8")
|
|
real_open = builtins.open
|
|
reads = []
|
|
|
|
def recording_open(*args, **kwargs):
|
|
if os.fspath(args[0]) == str(learned_file):
|
|
reads.append(args[0])
|
|
return real_open(*args, **kwargs)
|
|
|
|
monkeypatch.setattr(builtins, "open", recording_open)
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 900
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 900
|
|
assert len(reads) == 1
|
|
|
|
|
|
def test_missing_switched_source_stays_best_effort(learned_file, monkeypatch):
|
|
learned_file.write_text(json.dumps({"openai": 900}), encoding="utf-8")
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 900
|
|
monkeypatch.setenv(
|
|
"HEADROOM_CACHE_TTL_LEARNED_PATH", str(learned_file.with_name("missing.json"))
|
|
)
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") is None
|
|
monkeypatch.setenv("HEADROOM_CACHE_TTL_LEARNED_PATH", str(learned_file))
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 900
|
|
|
|
|
|
@pytest.mark.parametrize("table", [[300], "not a table", 300, True])
|
|
def test_non_object_table_is_ignored_even_after_caching(learned_file, table):
|
|
learned_file.write_text(json.dumps(table))
|
|
for _ in range(2):
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") is None
|
|
|
|
|
|
@pytest.mark.parametrize("value", [float("nan"), float("inf"), -float("inf"), True, -30, 0])
|
|
@pytest.mark.parametrize("nested", [False, True])
|
|
def test_invalid_model_ttl_uses_valid_provider_fallback(learned_file, value, nested):
|
|
learned_file.write_text(
|
|
json.dumps(
|
|
{
|
|
"openai/fixture": {"ttl_seconds": value} if nested else value,
|
|
"openai": {"ttl_seconds": 900},
|
|
}
|
|
)
|
|
)
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 900
|
|
|
|
|
|
@pytest.mark.parametrize("value", [600, 600.75])
|
|
@pytest.mark.parametrize("nested", [False, True])
|
|
def test_valid_numeric_ttls_retain_integer_conversion(learned_file, value, nested):
|
|
learned_file.write_text(json.dumps({"openai": {"ttl_seconds": value} if nested else value}))
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 600
|
|
|
|
|
|
@pytest.mark.parametrize("value", [True, -30])
|
|
def test_invalid_provider_ttl_does_not_make_a_warm_prefix_cold(learned_file, value):
|
|
learned_file.write_text(json.dumps({"openai": value}))
|
|
tracker = PrefixCacheTracker("openai")
|
|
tracker._idle_seconds_at_fetch = 120.0
|
|
ttl = ttl_observations.resolve_learned_ttl("openai", "fixture")
|
|
assert ttl is None
|
|
assert not is_cold_prefix(tracker, ttl_seconds=ttl)
|
|
|
|
|
|
def test_corrected_file_is_reloaded_and_model_still_takes_precedence(learned_file):
|
|
learned_file.write_text('["wrong shape"]')
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") is None
|
|
old_mtime = learned_file.stat().st_mtime
|
|
learned_file.write_text(json.dumps({"openai/fixture": {"ttl_seconds": 600}, "openai": 900}))
|
|
os.utime(learned_file, (old_mtime + 2, old_mtime + 2))
|
|
assert ttl_observations.resolve_learned_ttl("openai", "fixture") == 600
|
|
assert ttl_observations.resolve_learned_ttl("openai", "other") == 900
|