Commit d5bf98d
fix(cli): stop advertising unwired compression tuning env vars in banner (#1634)
## Description
The startup banner's `Performance Tuning` section reads
`HEADROOM_COMPRESSION_STABLE_AFTER_TURN` and
`HEADROOM_STALE_READ_COMPRESS_AFTER_TURNS` and prints them as active
tuning knobs. Neither is consumed anywhere else — not in the Python
compression path, and not in the packaged native code (verified by
scanning the shipped extension modules; `headroom` ships no env-reading
native lib and Kompress runs via ONNX). Setting either var changes the
banner but has zero effect on behavior, which actively misleads
operators trying to tune compression load.
Closes #
## Type of Change
- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] 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
- Removed the two unwired env vars from the banner's `Performance
Tuning` section, including the fallback hint that told users to "set"
them.
- Kept the embedding-sidecar line (`HEADROOM_EMBEDDING_SERVER_SOCKET`),
which is a real, consumed setting; the section now renders only when a
real tuning value is active and is empty otherwise.
- Added an Unreleased → Fixed CHANGELOG entry.
## Testing
- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [x] Type checking passes (`mypy headroom`)
- [ ] New tests added for new functionality
- [ ] Manual testing performed
### Test Output
```text
$ pytest tests/test_cli_proxy_improvements.py -q
48 passed in 5.04s
$ ruff check headroom/cli/proxy.py && ruff format --check headroom/cli/proxy.py
All checks passed! / 1 file already formatted
$ mypy headroom/cli/proxy.py
Success: no issues found in 1 source file
```
## Real Behavior Proof
- Environment: macOS, Python 3.10.18, branch off upstream/main @ 0.28.0
- Exact command / steps: grepped the entire package + shipped
`.so`/native modules for both env var names; only the banner referenced
them.
- Observed result: no consumer exists for either var; banner was the
sole reader. After the change the banner no longer claims they do
anything.
- Not tested: N/A — this removes a false claim; no behavior to exercise
beyond the existing CLI-invocation tests, which pass.
## 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
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [x] I have updated the CHANGELOG.md if applicable
## Additional Notes
No new test added: the fix deletes dead/misleading output rather than
adding logic; a banner-string assertion would be brittle. If you'd
rather *implement* these knobs than remove them (i.e. actually gate
Kompress on prefix-stable-after-N-turns), I'm happy to open a separate
feature PR instead — but as shipped they are pure no-ops, so this stops
the banner from lying today. N/A: "new tests added", "manual testing".
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: JerrettDavis <mxjerrett@gmail.com>1 parent 814ffa3 commit d5bf98d
2 files changed
Lines changed: 8 additions & 16 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
30 | 37 | | |
31 | 38 | | |
32 | 39 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1327 | 1327 | | |
1328 | 1328 | | |
1329 | 1329 | | |
1330 | | - | |
1331 | | - | |
1332 | 1330 | | |
1333 | 1331 | | |
1334 | 1332 | | |
1335 | 1333 | | |
1336 | | - | |
1337 | | - | |
1338 | | - | |
1339 | | - | |
1340 | | - | |
1341 | | - | |
1342 | | - | |
1343 | | - | |
1344 | | - | |
1345 | | - | |
1346 | 1334 | | |
1347 | 1335 | | |
1348 | 1336 | | |
1349 | 1337 | | |
1350 | 1338 | | |
1351 | | - | |
1352 | | - | |
1353 | | - | |
1354 | | - | |
| 1339 | + | |
1355 | 1340 | | |
1356 | 1341 | | |
1357 | 1342 | | |
| |||
0 commit comments