mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description `headroom wrap grok-build` injected the client hop into `~/.grok/config.toml` but started the local proxy **without** setting the OpenAI-compatible upstream to xAI. The proxy defaulted to `api.openai.com`, so Grok session auth returned **401** on every chat completion even though compression still ran. `wrap grok` already passes `openai_api_url` → xAI. This PR aligns `wrap grok-build` and the Grok-only persistent `install` path on the shared `DEFAULT_API_URL` (`https://api.x.ai`). Closes # (none — discovered in live Grok Build pilot) ## Type of Change - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which 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 - Pass `openai_api_url=_GROK_DEFAULT_API_URL` into `_run_proxy_only_watcher` from `wrap grok-build` - Use shared `DEFAULT_API_URL` from `wrap grok` (no hard-coded string drift) - Print proxy upstream in Grok Build setup lines - Persistent install: when targets are Grok-only, set `OPENAI_TARGET_API_URL` + `--openai-api-url` (skip when Codex/Copilot/Aider/OpenCode share the proxy; explicit env still wins) - Regression tests for wrap kwargs, setup lines, and install planner ## Testing - [x] Unit tests pass (`pytest` targeted suite) - [ ] Linting passes (`ruff check .`) — not run in this environment (no native editable build) - [ ] Type checking passes (`mypy headroom`) — not run - [x] New tests added for new functionality - [x] Manual testing performed ### Test Output ```text $ PYTHONPATH=$PWD python -m pytest \ tests/test_cli/test_wrap_bridge.py::test_wrap_grok_build_passes_xai_openai_api_url \ tests/test_cli/test_wrap_bridge.py::test_wrap_grok_build_uses_actual_proxy_port \ tests/test_install/test_planner.py::test_build_manifest_grok_build_only_sets_xai_upstream \ tests/test_install/test_planner.py::test_build_manifest_grok_with_codex_does_not_force_xai \ tests/test_install/test_planner.py::test_build_manifest_extra_env_wins_over_grok_xai_default \ tests/test_provider_grok_build.py::test_grok_build_setup_lines_include_proxy_url -q ...... 6 passed in 0.33s ``` ## Real Behavior Proof - Environment: macOS (darwin), Headroom 0.33.0 via `uv tool install "headroom-ai[proxy,mcp,code]==0.33.0"`, Grok Build CLI, models `grok-build` and `grok-4.5`, proxy on `127.0.0.1:8787`, upstream must be xAI - Exact command / steps: (1) Before: stock `headroom wrap grok-build` then `grok -m grok-build` one-shot prompt. (2) After: same wrap path with this branch (`openai_api_url=DEFAULT_API_URL` into `_run_proxy_only_watcher`) then `grok -m grok-build -p '…HEADROOM_XAI_OK…'`. Also exercised `grok-4.5` via `[model."grok-4.5"] base_url` → same proxy. - Observed result: Before — proxy log outbound `api.openai.com` → HTTP 401; client failed while local compression still ran. After — setup line prints Proxy upstream `https://api.x.ai`; proxy log `POST https://api.x.ai/v1/chat/completions` (and `/v1/responses` for grok-4.5) → status=200; dashboard shows 0 failed requests and accumulating token savings on live traffic. - Not tested: full `uv run` editable/maturin native build on this host; multi-tool install matrix beyond planner unit tests; Windows; ruff/mypy full tree ## 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 commented my code, particularly in hard-to-understand areas - [ ] I made corresponding changes to the documentation (CLI help text / setup lines only) - [x] My changes generate no new warnings - [x] I 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 did **not** edit `CHANGELOG.md` — generated by release-please from Conventional Commit PR title (a CI guard enforces this) ## Additional Notes - Intentional non-goal: changing default model, savings %, or Grok Build context-tool defaults - Mixed-target install (e.g. `grok_build` + `codex`) does **not** force xAI — operator must set upstream explicitly if they share one proxy - Related live routing: manual `[model."grok-4.5"] base_url` through the same proxy works once upstream is xAI (`/v1/responses`) --------- Co-authored-by: Grok 4.5 <noreply@x.ai> Co-authored-by: Nestor G Pestelos Jr <ngpestelos@me.com> Co-authored-by: JD Davis <jd@jds-macbook-air.tail2a279.ts.net>
138 lines
4.6 KiB
Python
138 lines
4.6 KiB
Python
from __future__ import annotations
|
|
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from headroom.providers.grok import DEFAULT_API_URL
|
|
from headroom.providers.grok_build import build_proxy_targets, render_setup_lines
|
|
from headroom.providers.grok_build.config import (
|
|
inject_grok_provider_config,
|
|
redirect_existing_grok_build_base_url,
|
|
render_headroom_block,
|
|
restore_grok_provider_config,
|
|
strip_grok_headroom_blocks,
|
|
)
|
|
from headroom.providers.grok_build.install import build_install_env
|
|
|
|
if sys.version_info >= (3, 11):
|
|
import tomllib
|
|
else: # pragma: no cover
|
|
import tomli as tomllib # type: ignore[no-redef]
|
|
|
|
|
|
def _assert_valid_toml(content: str) -> None:
|
|
payload = content.encode("utf-8")
|
|
try:
|
|
tomllib.loads(payload)
|
|
except TypeError:
|
|
# Some environments expose a str-accepting TOML parser shim.
|
|
tomllib.loads(content) # type: ignore[arg-type]
|
|
|
|
|
|
def _count_grok_build_tables(content: str) -> int:
|
|
return content.count("[model.grok-build]")
|
|
|
|
|
|
def test_grok_build_proxy_targets_use_local_headroom_proxy() -> None:
|
|
target = build_proxy_targets(9999)
|
|
|
|
assert target.base_url == "http://127.0.0.1:9999/v1"
|
|
|
|
|
|
def test_grok_build_setup_lines_include_proxy_url() -> None:
|
|
lines = render_setup_lines(8787)
|
|
joined = "\n".join(lines)
|
|
|
|
assert "http://127.0.0.1:8787/v1" in joined
|
|
assert "[model.grok-build]" in joined
|
|
# Exact labeled line equality (not bare host substring containment) so
|
|
# CodeQL does not flag incomplete URL substring sanitization.
|
|
expected_upstream = f" Proxy upstream (OpenAI-compatible): {DEFAULT_API_URL}"
|
|
upstream_lines = [
|
|
line for line in lines if line.startswith(" Proxy upstream (OpenAI-compatible): ")
|
|
]
|
|
assert upstream_lines == [expected_upstream]
|
|
|
|
|
|
def test_grok_build_build_install_env_returns_proxy_url() -> None:
|
|
env = build_install_env(port=7654, backend="ignored")
|
|
|
|
assert env == {"GROK_MODEL_GROK_BUILD_BASE_URL": "http://127.0.0.1:7654/v1"}
|
|
|
|
|
|
def test_grok_build_proxy_targets_apply_project_path_prefix() -> None:
|
|
target = build_proxy_targets(9999, project="frontend")
|
|
|
|
assert target.base_url == "http://127.0.0.1:9999/p/frontend/v1"
|
|
|
|
|
|
def test_grok_build_setup_lines_mention_project_attribution() -> None:
|
|
lines = render_setup_lines(8787, project="frontend")
|
|
joined = "\n".join(lines)
|
|
|
|
assert "http://127.0.0.1:8787/p/frontend/v1" in joined
|
|
assert "attributed to project 'frontend'" in joined
|
|
|
|
|
|
def test_grok_build_config_inject_and_restore_round_trip(tmp_path: Path, monkeypatch) -> None:
|
|
grok_home = tmp_path / ".grok"
|
|
grok_home.mkdir()
|
|
monkeypatch.setenv("GROK_HOME", str(grok_home))
|
|
|
|
config_file = inject_grok_provider_config(8787, project="demo")
|
|
content = config_file.read_text(encoding="utf-8")
|
|
|
|
assert render_headroom_block(8787, project="demo").strip() in content
|
|
assert 'base_url = "http://127.0.0.1:8787/p/demo/v1"' in content
|
|
|
|
status, _ = restore_grok_provider_config()
|
|
assert status == "removed"
|
|
assert not config_file.exists()
|
|
|
|
|
|
def test_grok_build_config_strip_preserves_user_content() -> None:
|
|
original = f'[models]\ndefault = "grok-build"\n\n{render_headroom_block(8787)}'
|
|
cleaned = strip_grok_headroom_blocks(original)
|
|
|
|
assert "[models]" in cleaned
|
|
assert "headroom:grok-build" not in cleaned
|
|
|
|
|
|
def test_grok_build_inject_updates_existing_user_table_without_duplicate(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
grok_home = tmp_path / ".grok"
|
|
grok_home.mkdir()
|
|
monkeypatch.setenv("GROK_HOME", str(grok_home))
|
|
|
|
original = (
|
|
"[models]\n"
|
|
'default = "grok-build"\n\n'
|
|
"[model.grok-build]\n"
|
|
'model = "grok-build"\n'
|
|
'base_url = "https://api.x.ai/v1"\n'
|
|
"temperature = 0.5\n"
|
|
)
|
|
config_file = grok_home / "config.toml"
|
|
config_file.write_text(original, encoding="utf-8")
|
|
|
|
inject_grok_provider_config(8787, project="demo")
|
|
content = config_file.read_text(encoding="utf-8")
|
|
|
|
assert _count_grok_build_tables(content) == 1
|
|
assert 'base_url = "http://127.0.0.1:8787/p/demo/v1" # was: https://api.x.ai/v1' in content
|
|
assert "temperature = 0.5" in content
|
|
assert "headroom:grok-build" not in content
|
|
_assert_valid_toml(content)
|
|
|
|
|
|
def test_grok_build_redirect_existing_base_url_is_idempotent() -> None:
|
|
original = '[model.grok-build]\nbase_url = "http://127.0.0.1:8787/v1"\ntemperature = 0.2\n'
|
|
|
|
updated, changed = redirect_existing_grok_build_base_url(original, "http://127.0.0.1:8787/v1")
|
|
|
|
assert changed is False
|
|
assert updated == original
|
|
_assert_valid_toml(updated)
|