2026-04-06 12:48:33 -07:00
|
|
|
"""Tests for WebSocket HTTP fallback in the OpenAI handler.
|
|
|
|
|
|
|
|
|
|
When the upstream WebSocket connection to OpenAI fails (HTTP 500),
|
|
|
|
|
the proxy should transparently fall back to HTTP POST streaming
|
|
|
|
|
and relay SSE events over the client WebSocket.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
|
|
|
|
import asyncio
|
|
|
|
|
import json
|
2026-04-16 23:38:00 +07:00
|
|
|
from types import SimpleNamespace
|
|
|
|
|
|
|
|
|
|
import httpx
|
2026-04-06 12:48:33 -07:00
|
|
|
|
|
|
|
|
|
|
|
|
|
class FakeWebSocket:
|
|
|
|
|
"""Minimal WebSocket mock for testing."""
|
|
|
|
|
|
|
|
|
|
def __init__(self):
|
|
|
|
|
self.sent_texts: list[str] = []
|
|
|
|
|
self.closed = False
|
|
|
|
|
|
|
|
|
|
async def send_text(self, data: str) -> None:
|
|
|
|
|
self.sent_texts.append(data)
|
|
|
|
|
|
|
|
|
|
async def close(self, code: int = 1000, reason: str = "") -> None:
|
|
|
|
|
self.closed = True
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class FakeStreamResponse:
|
|
|
|
|
"""Mock httpx streaming response."""
|
|
|
|
|
|
fix(proxy): restore Codex usage headers on WS and streaming SSE transports (#577) (#794)
## Description
Codex's subscription/rate-limit window (the `x-codex-*` headers) was
being
**stripped on every transport Codex actually uses**, so session/weekly
usage
never reached the Codex CLI's own `/status` display, Headroom
`/stats`/dashboard,
or any consumer that sniffs the client-facing handshake. This PR
restores it on
**both** the WebSocket and streaming-SSE paths — the two halves of #577
— in one
place.
Fixes #577
**Supersedes #582 and #590.** This PR incorporates #582's SSE fix
(carried verbatim
with a `Co-authored-by` trailer) and additionally forwards the window
onto the client
`101` on the WS path, which #582/#590's capture-only WS code cannot do.
Both can be
closed as superseded once this merges — GitHub closing keywords only
auto-close
issues (hence `Fixes #577` above), not PRs, so #582/#590 need a manual
close.
### WebSocket (`gpt-5.4+`)
OpenAI delivers `x-codex-*` **only** on the upstream WS handshake
response, never
in data frames. `handle_openai_responses_ws` accepted the client WS
*before* it
connected upstream and never read `upstream.response.headers`, so the
window was
dropped. This reorders the handler to **connect upstream first**,
extract the
`x-codex-*` subset, then **accept the client WS with those headers
attached** to
the `101`, and refresh the Python state for `/stats` parity.
### Streaming SSE (incorporated from #582, @m16khb)
Codex CLI almost always streams. `streaming.py` neither captured
`x-codex-*` into
`CodexRateLimitState` nor forwarded it — the forwarded-header filter
matched only
the substring `"ratelimit"`, which `x-codex-*` does not contain. This
calls
`update_from_headers()` **before** the `>=400` early-return (so a
streaming 429/5xx
still refreshes the window, matching the non-streaming handlers) and
widens the
forward filter to pass `x-codex-*`.
> Credit: the SSE fix is @m16khb's work from #582, carried here verbatim
with a
> `Co-authored-by` trailer so the maintainer gets a single PR covering
both
> transports. This supersedes #582/#590's **WS** capture (which only
writes
> `/stats`); the connect-before-accept reorder additionally forwards the
window to
> the client `101`, which capture-only cannot do. #590's optional
snapshot
> persistence is intentionally left out (separable; hot-path sync write;
doesn't
> help the `101`-sniff consumers).
## 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
- `openai.py`: add `_extract_codex_handshake_headers()` (strictly
`x-codex-*`, via
`raw_items()` to avoid `MultipleValuesError`; never
`set-cookie`/`authorization`).
- `openai.py`: reorder `handle_openai_responses_ws` — connect-only retry
loop runs
before `accept()`; `accept(headers=...)` carries the forwarded window;
first
client frame read afterward. HTTP fallback preserved; it now also
refreshes
`/stats` from the HTTP response headers.
- `streaming.py`: capture `x-codex-*` on all statuses + widen the
forwarded-header
filter (from #582).
### Diff-size note
The bulk of the `openai.py` line count is **whitespace-only
relocation**: the relay
block dedents one level out of the old per-attempt `async with`. Logical
change is
~290 lines. **Review with `?w=1`.** In API-key mode the handshake
carries no
`x-codex-*`, so the accept-header list is empty and the path behaves
exactly as
before — the fix only activates for ChatGPT-subscription auth.
## Testing
- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual testing performed
- WS: `test_ws_connect_happens_before_accept`,
`test_ws_forwards_codex_headers_to_client_accept`
(only `x-codex-*` forwarded; `set-cookie`/`authorization` excluded;
`/stats` refreshed),
`test_ws_connect_failure_falls_back_to_http`,
`test_ws_first_frame_timeout_after_connect_closes_upstream`.
- Fallback: `test_fallback_refreshes_codex_rate_limit_state`.
- SSE:
`test_codex_rate_limit_headers_captured_and_forwarded_in_streaming`,
`test_codex_rate_limit_captured_on_streaming_429` (from #582).
- Wire-level e2e: `tests/e2e_ws_codex_usage_headers.py` boots the real
proxy + fake
upstream + real `websockets` client and reads the client `101` — closes
the gap
the unit tests stub (that uvicorn/starlette actually write
`accept(headers=...)`).
## Test Output
```
$ uv run pytest tests/test_proxy_streaming_ratelimit_headers.py \
tests/test_ws_http_fallback.py \
tests/test_openai_codex_ws_lifecycle.py \
tests/test_openai_codex_ws_timings.py \
tests/test_codex_rate_limits.py -q
63 passed in 0.83s
$ .venv/bin/python tests/e2e_ws_codex_usage_headers.py
[codex-hdr-e2e] client 101 headers:
x-codex-primary-used-percent: 42
x-codex-primary-window-minutes: 300
x-codex-secondary-used-percent: 7
x-codex-secondary-window-minutes: 10080
[codex-hdr-e2e] /stats reflects codex window (primary-used=42)
=== CODEX-HDR E2E ALL GREEN ===
$ uv run ruff check . && uv run ruff format --check <touched files>
All checks passed!
```
## 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
- [x] My changes generate no new warnings
- [x] 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
- [ ] I have updated the CHANGELOG.md if applicable
## Additional Notes
- **Why connect-before-accept (not capture-only).** Once `accept()`
sends the `101`,
headers can no longer be added; the `x-codex-*` window only exists after
we connect
upstream. Capturing into Python state (as #582/#590's WS code does)
fixes `/stats`
but not the Codex CLI's native display or any `101`-sniffing consumer —
those need
the headers *on the client handshake*, which requires the reorder.
- **Security.** Forwarding is filtered strictly to `x-codex-*`;
`set-cookie`,
`authorization`, and all other upstream headers are never forwarded to
the client
(asserted by both the unit test and the e2e).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
## Contract Schemas
Per maintainer request: a JSON Schema (draft 2020-12) artifact
enshrining the OpenAI
interaction expectations this changeset relies on, so drift is
detectable later.
Committed following the repo's parity convention:
- schema:
`tests/parity/fixtures/codex_openai_contracts/codex-openai-interaction.schema.json`
- test: `tests/test_codex_openai_contract_parity.py` binds the schema to
the **live code**
in both directions, so drift fails CI rather than living only in this
description -
every declared `x-codex-*` header must be consumed by
`parse_codex_rate_limits`, and
`_extract_codex_handshake_headers` must forward exactly the declared
subset and never
`set-cookie`/`authorization`. No new dependency (does not pull in
`jsonschema`).
It covers, as `$defs`:
- `WSUpstreamHandshakeResponse` / `StreamingUpstreamResponseHeaders` -
the upstream
`x-codex-*` header family (full superset, with per-header wire pattern +
the parsed
semantic type) the WS and SSE captures read. Source of truth:
`parse_codex_rate_limits`.
- `ClientForwardedHandshakeHeaders` - the WS-101 **allow/deny**
contract: only
`x-codex-*` may be forwarded; `set-cookie`/`authorization` are
explicitly forbidden
(`propertyNames` + `not`).
- `ClientForwardedStreamingHeaders` - the wider SSE forward set
(`*ratelimit*` OR `x-codex*`).
- `WSClientRequestFrame` / `WSRelayEvent` / `HTTPFallbackRequestBody` -
the WS frame
envelopes and the unwrapped HTTP-fallback POST body.
- `CodexRateLimitStatsOutput` - the headroom `/stats` shape the parity
tests assert.
Validated with `jsonschema` (Draft202012 `check_schema` passes; positive
instances from
the e2e validate; negative instances - a leaked `set-cookie`, a fallback
body still
carrying a top-level `type` - are correctly rejected).
<details>
<summary><code>codex-openai-interaction.schema.json</code> (draft
2020-12)</summary>
```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/chopratejas/headroom/contracts/codex-openai-interaction.schema.json",
"title": "Codex <-> OpenAI interaction contracts (PR #794)",
"description": "Enshrines the OpenAI interaction expectations this changeset depends on, so drift is detectable. Header values are transported as strings on the wire; the `x-headroom-parsed-type` annotation on each records the semantic type the parser (headroom/subscription/codex_rate_limits.py) coerces them to. Sources: codex_rate_limits.parse_codex_rate_limits (header family + gating), openai._extract_codex_handshake_headers (WS-101 forward filter), streaming.py (SSE forward filter).",
"$defs": {
"OpenAICodexWindowHeaders": {
"title": "x-codex-*-{primary,secondary} window headers",
"description": "A rolling rate-limit/subscription window. A window is materialized iff its `*-used-percent` header is present and numeric; `*-window-minutes` and `*-reset-at` are optional. `primary` and `secondary` are independent and either may be absent.",
"type": "object",
"properties": {
"x-codex-primary-used-percent": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$",
"x-headroom-parsed-type": "float (0-100, NaN-guarded)",
"description": "Percent of the primary window consumed. Gates creation of the primary window."
},
"x-codex-primary-window-minutes": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int",
"description": "Primary window size in minutes."
},
"x-codex-primary-reset-at": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int (Unix epoch seconds)",
"description": "Absolute reset time of the primary window."
},
"x-codex-secondary-used-percent": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$",
"x-headroom-parsed-type": "float (0-100, NaN-guarded)",
"description": "Percent of the secondary window consumed. Gates creation of the secondary window."
},
"x-codex-secondary-window-minutes": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int"
},
"x-codex-secondary-reset-at": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int (Unix epoch seconds)"
}
},
"additionalProperties": true
},
"OpenAICodexCreditsHeaders": {
"title": "x-codex-credits-* headers",
"description": "OpenAI credits balance. A credits snapshot is materialized iff `x-codex-credits-has-credits` is present; `unlimited` defaults to false; `balance` is optional.",
"type": "object",
"properties": {
"x-codex-credits-has-credits": {
"type": "string",
"pattern": "^(?:[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[01])$",
"x-headroom-parsed-type": "bool (true|false|1|0, case-insensitive)",
"description": "Gates creation of the credits snapshot."
},
"x-codex-credits-unlimited": {
"type": "string",
"pattern": "^(?:[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[01])$",
"x-headroom-parsed-type": "bool (defaults false when absent/unparseable)"
},
"x-codex-credits-balance": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Free-form server string, e.g. \"$5.00\"."
}
},
"additionalProperties": true
},
"OpenAICodexMetaHeaders": {
"title": "x-codex meta headers",
"type": "object",
"properties": {
"x-codex-limit-name": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Active limit/model label, e.g. \"gpt-5.2-codex-sonic\"."
},
"x-codex-promo-message": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Server announcement. Also gates snapshot creation when present."
}
},
"additionalProperties": true
},
"OpenAICodexRateLimitHeaders": {
"title": "Full x-codex-* header family OpenAI may emit",
"description": "Superset of every x-codex-* header headroom reads. parse_codex_rate_limits returns a snapshot iff at least one of: a primary window, a secondary window, a credits snapshot, or a non-empty promo message is present; otherwise null (treated as a non-Codex response). All members are individually optional.",
"type": "object",
"allOf": [
{ "$ref": "#/$defs/OpenAICodexWindowHeaders" },
{ "$ref": "#/$defs/OpenAICodexCreditsHeaders" },
{ "$ref": "#/$defs/OpenAICodexMetaHeaders" }
],
"additionalProperties": true
},
"WSUpstreamHandshakeResponse": {
"title": "OpenAI WS handshake (101) response headers consumed by the WS fix",
"description": "On the Codex WebSocket transport the x-codex-* window is delivered ONLY on the upstream handshake response (never in data frames). handle_openai_responses_ws reads upstream.response.headers here. This is the contract the connect-before-accept reorder depends on: if OpenAI ever moves these headers off the handshake (e.g. into a frame), the WS half of the fix goes stale.",
"$ref": "#/$defs/OpenAICodexRateLimitHeaders"
},
"StreamingUpstreamResponseHeaders": {
"title": "OpenAI streaming/HTTP response headers consumed by the SSE fix",
"description": "On the streaming SSE/HTTP transport the same x-codex-* headers ride the HTTP response. streaming.py captures them on ALL statuses (including >=400) via update_from_headers, and forwards a wider set to the client (see ClientForwardedStreamingHeaders).",
"$ref": "#/$defs/OpenAICodexRateLimitHeaders"
},
"ClientForwardedHandshakeHeaders": {
"title": "Headers forwarded onto the CLIENT-facing WS 101 (allow/deny contract)",
"description": "_extract_codex_handshake_headers forwards ONLY headers whose (lowercased) name starts with `x-codex-`. Every other upstream handshake header - notably set-cookie and authorization - MUST NOT appear on the client 101. Enforced by propertyNames below and asserted by the unit tests + tests/e2e_ws_codex_usage_headers.py.",
"type": "object",
"propertyNames": {
"pattern": "^[Xx]-[Cc][Oo][Dd][Ee][Xx]-"
},
"not": {
"anyOf": [
{ "required": ["set-cookie"] },
{ "required": ["Set-Cookie"] },
{ "required": ["authorization"] },
{ "required": ["Authorization"] }
]
},
"additionalProperties": { "type": "string" }
},
"ClientForwardedStreamingHeaders": {
"title": "Headers forwarded to the client on the streaming SSE path",
"description": "streaming.py forwards a header iff `\"ratelimit\" in name.lower()` OR `name.lower().startswith(\"x-codex\")`. This is a SUPERSET of the WS allow-list: it additionally passes generic *ratelimit* headers (e.g. the Anthropic streaming path) which do not contain the x-codex prefix.",
"type": "object",
"propertyNames": {
"pattern": "(?:[Rr][Aa][Tt][Ee][Ll][Ii][Mm][Ii][Tt])|^[Xx]-[Cc][Oo][Dd][Ee][Xx]"
},
"additionalProperties": { "type": "string" }
},
"WSClientRequestFrame": {
"title": "Client -> proxy WS data frame (Responses API over WS)",
"description": "Codex sends the request as a response.create envelope. The HTTP fallback unwraps `.response` for the POST body, forces stream=true, and strips any top-level `type`. A flattened variant (no envelope, fields at top level) is also tolerated by the fallback.",
"type": "object",
"properties": {
"type": { "const": "response.create" },
"response": {
"type": "object",
"properties": {
"model": { "type": "string", "description": "e.g. gpt-5.4" },
"input": {
"description": "String prompt or Responses-API structured input array.",
"type": ["string", "array"]
},
"stream": { "type": "boolean" }
},
"required": ["model"],
"additionalProperties": true
}
},
"required": ["type", "response"],
"additionalProperties": true
},
"WSRelayEvent": {
"title": "proxy -> client WS data frame (relayed Responses API event)",
"description": "SSE `data:` payloads relayed verbatim as WS text frames. `[DONE]` sentinels are dropped (not relayed). Every relayed event is a JSON object carrying a `type`. response.completed additionally carries usage under `response.usage`. anyOf (not oneOf): an error event also satisfies the looser lifecycle shape, which is fine.",
"anyOf": [
{
"title": "lifecycle event",
"type": "object",
"properties": {
"type": {
"type": "string",
"examples": [
"response.created",
"response.output_item.added",
"response.completed"
]
},
"response": { "type": "object", "additionalProperties": true }
},
"required": ["type"],
"additionalProperties": true
},
{
"title": "error event",
"type": "object",
"properties": {
"type": { "const": "error" },
"error": {
"type": "object",
"properties": { "message": { "type": "string" } },
"required": ["message"],
"additionalProperties": true
}
},
"required": ["type", "error"],
"additionalProperties": true
}
]
},
"HTTPFallbackRequestBody": {
"title": "proxy -> OpenAI HTTP POST body on WS->HTTP fallback",
"description": "Derived from WSClientRequestFrame: the inner `.response` object, with `stream` forced to true and any top-level `type` removed.",
"type": "object",
"properties": {
"model": { "type": "string" },
"stream": { "const": true },
"input": { "type": ["string", "array"] }
},
"required": ["model", "stream"],
"not": { "required": ["type"] },
"additionalProperties": true
},
"CodexRateLimitStatsOutput": {
"title": "headroom /stats output for the codex tracker (CodexRateLimitSnapshot.to_dict)",
"description": "Internal (headroom-emitted) shape produced from the headers above; the WS and SSE update_from_headers parity tests assert this is refreshed. Included so drift in our own surface is also caught.",
"type": "object",
"properties": {
"limit_id": { "const": "codex" },
"limit_name": { "type": ["string", "null"] },
"primary": { "$ref": "#/$defs/CodexWindowDict" },
"secondary": { "$ref": "#/$defs/CodexWindowDict" },
"credits": {
"oneOf": [
{ "type": "null" },
{
"type": "object",
"properties": {
"has_credits": { "type": "boolean" },
"unlimited": { "type": "boolean" },
"balance": { "type": ["string", "null"] }
},
"required": ["has_credits", "unlimited", "balance"],
"additionalProperties": false
}
]
},
"promo_message": { "type": ["string", "null"] },
"captured_at": { "type": "number", "description": "Unix epoch seconds (float)." }
},
"required": ["limit_id", "limit_name", "primary", "secondary", "credits", "promo_message", "captured_at"],
"additionalProperties": false
},
"CodexWindowDict": {
"oneOf": [
{ "type": "null" },
{
"type": "object",
"properties": {
"used_percent": { "type": "number" },
"window_minutes": { "type": ["integer", "null"] },
"window_label": { "type": "string", "description": "e.g. \"5h\", \"7d\"-style label; \"unknown\" when window_minutes is null." },
"resets_at": { "type": ["integer", "null"], "description": "Unix epoch seconds." },
"seconds_until_reset": { "type": ["integer", "null"] }
},
"required": ["used_percent", "window_minutes", "window_label", "resets_at", "seconds_until_reset"],
"additionalProperties": false
}
]
}
}
}
```
</details>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: m16khb <m16khb@gmail.com>
2026-06-09 22:55:53 +02:00
|
|
|
def __init__(
|
|
|
|
|
self,
|
|
|
|
|
status_code: int = 200,
|
|
|
|
|
sse_events: list[str] | None = None,
|
|
|
|
|
headers: dict[str, str] | None = None,
|
|
|
|
|
):
|
2026-04-06 12:48:33 -07:00
|
|
|
self.status_code = status_code
|
|
|
|
|
self._events = sse_events or []
|
fix(proxy): restore Codex usage headers on WS and streaming SSE transports (#577) (#794)
## Description
Codex's subscription/rate-limit window (the `x-codex-*` headers) was
being
**stripped on every transport Codex actually uses**, so session/weekly
usage
never reached the Codex CLI's own `/status` display, Headroom
`/stats`/dashboard,
or any consumer that sniffs the client-facing handshake. This PR
restores it on
**both** the WebSocket and streaming-SSE paths — the two halves of #577
— in one
place.
Fixes #577
**Supersedes #582 and #590.** This PR incorporates #582's SSE fix
(carried verbatim
with a `Co-authored-by` trailer) and additionally forwards the window
onto the client
`101` on the WS path, which #582/#590's capture-only WS code cannot do.
Both can be
closed as superseded once this merges — GitHub closing keywords only
auto-close
issues (hence `Fixes #577` above), not PRs, so #582/#590 need a manual
close.
### WebSocket (`gpt-5.4+`)
OpenAI delivers `x-codex-*` **only** on the upstream WS handshake
response, never
in data frames. `handle_openai_responses_ws` accepted the client WS
*before* it
connected upstream and never read `upstream.response.headers`, so the
window was
dropped. This reorders the handler to **connect upstream first**,
extract the
`x-codex-*` subset, then **accept the client WS with those headers
attached** to
the `101`, and refresh the Python state for `/stats` parity.
### Streaming SSE (incorporated from #582, @m16khb)
Codex CLI almost always streams. `streaming.py` neither captured
`x-codex-*` into
`CodexRateLimitState` nor forwarded it — the forwarded-header filter
matched only
the substring `"ratelimit"`, which `x-codex-*` does not contain. This
calls
`update_from_headers()` **before** the `>=400` early-return (so a
streaming 429/5xx
still refreshes the window, matching the non-streaming handlers) and
widens the
forward filter to pass `x-codex-*`.
> Credit: the SSE fix is @m16khb's work from #582, carried here verbatim
with a
> `Co-authored-by` trailer so the maintainer gets a single PR covering
both
> transports. This supersedes #582/#590's **WS** capture (which only
writes
> `/stats`); the connect-before-accept reorder additionally forwards the
window to
> the client `101`, which capture-only cannot do. #590's optional
snapshot
> persistence is intentionally left out (separable; hot-path sync write;
doesn't
> help the `101`-sniff consumers).
## 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
- `openai.py`: add `_extract_codex_handshake_headers()` (strictly
`x-codex-*`, via
`raw_items()` to avoid `MultipleValuesError`; never
`set-cookie`/`authorization`).
- `openai.py`: reorder `handle_openai_responses_ws` — connect-only retry
loop runs
before `accept()`; `accept(headers=...)` carries the forwarded window;
first
client frame read afterward. HTTP fallback preserved; it now also
refreshes
`/stats` from the HTTP response headers.
- `streaming.py`: capture `x-codex-*` on all statuses + widen the
forwarded-header
filter (from #582).
### Diff-size note
The bulk of the `openai.py` line count is **whitespace-only
relocation**: the relay
block dedents one level out of the old per-attempt `async with`. Logical
change is
~290 lines. **Review with `?w=1`.** In API-key mode the handshake
carries no
`x-codex-*`, so the accept-header list is empty and the path behaves
exactly as
before — the fix only activates for ChatGPT-subscription auth.
## Testing
- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual testing performed
- WS: `test_ws_connect_happens_before_accept`,
`test_ws_forwards_codex_headers_to_client_accept`
(only `x-codex-*` forwarded; `set-cookie`/`authorization` excluded;
`/stats` refreshed),
`test_ws_connect_failure_falls_back_to_http`,
`test_ws_first_frame_timeout_after_connect_closes_upstream`.
- Fallback: `test_fallback_refreshes_codex_rate_limit_state`.
- SSE:
`test_codex_rate_limit_headers_captured_and_forwarded_in_streaming`,
`test_codex_rate_limit_captured_on_streaming_429` (from #582).
- Wire-level e2e: `tests/e2e_ws_codex_usage_headers.py` boots the real
proxy + fake
upstream + real `websockets` client and reads the client `101` — closes
the gap
the unit tests stub (that uvicorn/starlette actually write
`accept(headers=...)`).
## Test Output
```
$ uv run pytest tests/test_proxy_streaming_ratelimit_headers.py \
tests/test_ws_http_fallback.py \
tests/test_openai_codex_ws_lifecycle.py \
tests/test_openai_codex_ws_timings.py \
tests/test_codex_rate_limits.py -q
63 passed in 0.83s
$ .venv/bin/python tests/e2e_ws_codex_usage_headers.py
[codex-hdr-e2e] client 101 headers:
x-codex-primary-used-percent: 42
x-codex-primary-window-minutes: 300
x-codex-secondary-used-percent: 7
x-codex-secondary-window-minutes: 10080
[codex-hdr-e2e] /stats reflects codex window (primary-used=42)
=== CODEX-HDR E2E ALL GREEN ===
$ uv run ruff check . && uv run ruff format --check <touched files>
All checks passed!
```
## 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
- [x] My changes generate no new warnings
- [x] 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
- [ ] I have updated the CHANGELOG.md if applicable
## Additional Notes
- **Why connect-before-accept (not capture-only).** Once `accept()`
sends the `101`,
headers can no longer be added; the `x-codex-*` window only exists after
we connect
upstream. Capturing into Python state (as #582/#590's WS code does)
fixes `/stats`
but not the Codex CLI's native display or any `101`-sniffing consumer —
those need
the headers *on the client handshake*, which requires the reorder.
- **Security.** Forwarding is filtered strictly to `x-codex-*`;
`set-cookie`,
`authorization`, and all other upstream headers are never forwarded to
the client
(asserted by both the unit test and the e2e).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
## Contract Schemas
Per maintainer request: a JSON Schema (draft 2020-12) artifact
enshrining the OpenAI
interaction expectations this changeset relies on, so drift is
detectable later.
Committed following the repo's parity convention:
- schema:
`tests/parity/fixtures/codex_openai_contracts/codex-openai-interaction.schema.json`
- test: `tests/test_codex_openai_contract_parity.py` binds the schema to
the **live code**
in both directions, so drift fails CI rather than living only in this
description -
every declared `x-codex-*` header must be consumed by
`parse_codex_rate_limits`, and
`_extract_codex_handshake_headers` must forward exactly the declared
subset and never
`set-cookie`/`authorization`. No new dependency (does not pull in
`jsonschema`).
It covers, as `$defs`:
- `WSUpstreamHandshakeResponse` / `StreamingUpstreamResponseHeaders` -
the upstream
`x-codex-*` header family (full superset, with per-header wire pattern +
the parsed
semantic type) the WS and SSE captures read. Source of truth:
`parse_codex_rate_limits`.
- `ClientForwardedHandshakeHeaders` - the WS-101 **allow/deny**
contract: only
`x-codex-*` may be forwarded; `set-cookie`/`authorization` are
explicitly forbidden
(`propertyNames` + `not`).
- `ClientForwardedStreamingHeaders` - the wider SSE forward set
(`*ratelimit*` OR `x-codex*`).
- `WSClientRequestFrame` / `WSRelayEvent` / `HTTPFallbackRequestBody` -
the WS frame
envelopes and the unwrapped HTTP-fallback POST body.
- `CodexRateLimitStatsOutput` - the headroom `/stats` shape the parity
tests assert.
Validated with `jsonschema` (Draft202012 `check_schema` passes; positive
instances from
the e2e validate; negative instances - a leaked `set-cookie`, a fallback
body still
carrying a top-level `type` - are correctly rejected).
<details>
<summary><code>codex-openai-interaction.schema.json</code> (draft
2020-12)</summary>
```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/chopratejas/headroom/contracts/codex-openai-interaction.schema.json",
"title": "Codex <-> OpenAI interaction contracts (PR #794)",
"description": "Enshrines the OpenAI interaction expectations this changeset depends on, so drift is detectable. Header values are transported as strings on the wire; the `x-headroom-parsed-type` annotation on each records the semantic type the parser (headroom/subscription/codex_rate_limits.py) coerces them to. Sources: codex_rate_limits.parse_codex_rate_limits (header family + gating), openai._extract_codex_handshake_headers (WS-101 forward filter), streaming.py (SSE forward filter).",
"$defs": {
"OpenAICodexWindowHeaders": {
"title": "x-codex-*-{primary,secondary} window headers",
"description": "A rolling rate-limit/subscription window. A window is materialized iff its `*-used-percent` header is present and numeric; `*-window-minutes` and `*-reset-at` are optional. `primary` and `secondary` are independent and either may be absent.",
"type": "object",
"properties": {
"x-codex-primary-used-percent": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$",
"x-headroom-parsed-type": "float (0-100, NaN-guarded)",
"description": "Percent of the primary window consumed. Gates creation of the primary window."
},
"x-codex-primary-window-minutes": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int",
"description": "Primary window size in minutes."
},
"x-codex-primary-reset-at": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int (Unix epoch seconds)",
"description": "Absolute reset time of the primary window."
},
"x-codex-secondary-used-percent": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$",
"x-headroom-parsed-type": "float (0-100, NaN-guarded)",
"description": "Percent of the secondary window consumed. Gates creation of the secondary window."
},
"x-codex-secondary-window-minutes": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int"
},
"x-codex-secondary-reset-at": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int (Unix epoch seconds)"
}
},
"additionalProperties": true
},
"OpenAICodexCreditsHeaders": {
"title": "x-codex-credits-* headers",
"description": "OpenAI credits balance. A credits snapshot is materialized iff `x-codex-credits-has-credits` is present; `unlimited` defaults to false; `balance` is optional.",
"type": "object",
"properties": {
"x-codex-credits-has-credits": {
"type": "string",
"pattern": "^(?:[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[01])$",
"x-headroom-parsed-type": "bool (true|false|1|0, case-insensitive)",
"description": "Gates creation of the credits snapshot."
},
"x-codex-credits-unlimited": {
"type": "string",
"pattern": "^(?:[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[01])$",
"x-headroom-parsed-type": "bool (defaults false when absent/unparseable)"
},
"x-codex-credits-balance": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Free-form server string, e.g. \"$5.00\"."
}
},
"additionalProperties": true
},
"OpenAICodexMetaHeaders": {
"title": "x-codex meta headers",
"type": "object",
"properties": {
"x-codex-limit-name": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Active limit/model label, e.g. \"gpt-5.2-codex-sonic\"."
},
"x-codex-promo-message": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Server announcement. Also gates snapshot creation when present."
}
},
"additionalProperties": true
},
"OpenAICodexRateLimitHeaders": {
"title": "Full x-codex-* header family OpenAI may emit",
"description": "Superset of every x-codex-* header headroom reads. parse_codex_rate_limits returns a snapshot iff at least one of: a primary window, a secondary window, a credits snapshot, or a non-empty promo message is present; otherwise null (treated as a non-Codex response). All members are individually optional.",
"type": "object",
"allOf": [
{ "$ref": "#/$defs/OpenAICodexWindowHeaders" },
{ "$ref": "#/$defs/OpenAICodexCreditsHeaders" },
{ "$ref": "#/$defs/OpenAICodexMetaHeaders" }
],
"additionalProperties": true
},
"WSUpstreamHandshakeResponse": {
"title": "OpenAI WS handshake (101) response headers consumed by the WS fix",
"description": "On the Codex WebSocket transport the x-codex-* window is delivered ONLY on the upstream handshake response (never in data frames). handle_openai_responses_ws reads upstream.response.headers here. This is the contract the connect-before-accept reorder depends on: if OpenAI ever moves these headers off the handshake (e.g. into a frame), the WS half of the fix goes stale.",
"$ref": "#/$defs/OpenAICodexRateLimitHeaders"
},
"StreamingUpstreamResponseHeaders": {
"title": "OpenAI streaming/HTTP response headers consumed by the SSE fix",
"description": "On the streaming SSE/HTTP transport the same x-codex-* headers ride the HTTP response. streaming.py captures them on ALL statuses (including >=400) via update_from_headers, and forwards a wider set to the client (see ClientForwardedStreamingHeaders).",
"$ref": "#/$defs/OpenAICodexRateLimitHeaders"
},
"ClientForwardedHandshakeHeaders": {
"title": "Headers forwarded onto the CLIENT-facing WS 101 (allow/deny contract)",
"description": "_extract_codex_handshake_headers forwards ONLY headers whose (lowercased) name starts with `x-codex-`. Every other upstream handshake header - notably set-cookie and authorization - MUST NOT appear on the client 101. Enforced by propertyNames below and asserted by the unit tests + tests/e2e_ws_codex_usage_headers.py.",
"type": "object",
"propertyNames": {
"pattern": "^[Xx]-[Cc][Oo][Dd][Ee][Xx]-"
},
"not": {
"anyOf": [
{ "required": ["set-cookie"] },
{ "required": ["Set-Cookie"] },
{ "required": ["authorization"] },
{ "required": ["Authorization"] }
]
},
"additionalProperties": { "type": "string" }
},
"ClientForwardedStreamingHeaders": {
"title": "Headers forwarded to the client on the streaming SSE path",
"description": "streaming.py forwards a header iff `\"ratelimit\" in name.lower()` OR `name.lower().startswith(\"x-codex\")`. This is a SUPERSET of the WS allow-list: it additionally passes generic *ratelimit* headers (e.g. the Anthropic streaming path) which do not contain the x-codex prefix.",
"type": "object",
"propertyNames": {
"pattern": "(?:[Rr][Aa][Tt][Ee][Ll][Ii][Mm][Ii][Tt])|^[Xx]-[Cc][Oo][Dd][Ee][Xx]"
},
"additionalProperties": { "type": "string" }
},
"WSClientRequestFrame": {
"title": "Client -> proxy WS data frame (Responses API over WS)",
"description": "Codex sends the request as a response.create envelope. The HTTP fallback unwraps `.response` for the POST body, forces stream=true, and strips any top-level `type`. A flattened variant (no envelope, fields at top level) is also tolerated by the fallback.",
"type": "object",
"properties": {
"type": { "const": "response.create" },
"response": {
"type": "object",
"properties": {
"model": { "type": "string", "description": "e.g. gpt-5.4" },
"input": {
"description": "String prompt or Responses-API structured input array.",
"type": ["string", "array"]
},
"stream": { "type": "boolean" }
},
"required": ["model"],
"additionalProperties": true
}
},
"required": ["type", "response"],
"additionalProperties": true
},
"WSRelayEvent": {
"title": "proxy -> client WS data frame (relayed Responses API event)",
"description": "SSE `data:` payloads relayed verbatim as WS text frames. `[DONE]` sentinels are dropped (not relayed). Every relayed event is a JSON object carrying a `type`. response.completed additionally carries usage under `response.usage`. anyOf (not oneOf): an error event also satisfies the looser lifecycle shape, which is fine.",
"anyOf": [
{
"title": "lifecycle event",
"type": "object",
"properties": {
"type": {
"type": "string",
"examples": [
"response.created",
"response.output_item.added",
"response.completed"
]
},
"response": { "type": "object", "additionalProperties": true }
},
"required": ["type"],
"additionalProperties": true
},
{
"title": "error event",
"type": "object",
"properties": {
"type": { "const": "error" },
"error": {
"type": "object",
"properties": { "message": { "type": "string" } },
"required": ["message"],
"additionalProperties": true
}
},
"required": ["type", "error"],
"additionalProperties": true
}
]
},
"HTTPFallbackRequestBody": {
"title": "proxy -> OpenAI HTTP POST body on WS->HTTP fallback",
"description": "Derived from WSClientRequestFrame: the inner `.response` object, with `stream` forced to true and any top-level `type` removed.",
"type": "object",
"properties": {
"model": { "type": "string" },
"stream": { "const": true },
"input": { "type": ["string", "array"] }
},
"required": ["model", "stream"],
"not": { "required": ["type"] },
"additionalProperties": true
},
"CodexRateLimitStatsOutput": {
"title": "headroom /stats output for the codex tracker (CodexRateLimitSnapshot.to_dict)",
"description": "Internal (headroom-emitted) shape produced from the headers above; the WS and SSE update_from_headers parity tests assert this is refreshed. Included so drift in our own surface is also caught.",
"type": "object",
"properties": {
"limit_id": { "const": "codex" },
"limit_name": { "type": ["string", "null"] },
"primary": { "$ref": "#/$defs/CodexWindowDict" },
"secondary": { "$ref": "#/$defs/CodexWindowDict" },
"credits": {
"oneOf": [
{ "type": "null" },
{
"type": "object",
"properties": {
"has_credits": { "type": "boolean" },
"unlimited": { "type": "boolean" },
"balance": { "type": ["string", "null"] }
},
"required": ["has_credits", "unlimited", "balance"],
"additionalProperties": false
}
]
},
"promo_message": { "type": ["string", "null"] },
"captured_at": { "type": "number", "description": "Unix epoch seconds (float)." }
},
"required": ["limit_id", "limit_name", "primary", "secondary", "credits", "promo_message", "captured_at"],
"additionalProperties": false
},
"CodexWindowDict": {
"oneOf": [
{ "type": "null" },
{
"type": "object",
"properties": {
"used_percent": { "type": "number" },
"window_minutes": { "type": ["integer", "null"] },
"window_label": { "type": "string", "description": "e.g. \"5h\", \"7d\"-style label; \"unknown\" when window_minutes is null." },
"resets_at": { "type": ["integer", "null"], "description": "Unix epoch seconds." },
"seconds_until_reset": { "type": ["integer", "null"] }
},
"required": ["used_percent", "window_minutes", "window_label", "resets_at", "seconds_until_reset"],
"additionalProperties": false
}
]
}
}
}
```
</details>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: m16khb <m16khb@gmail.com>
2026-06-09 22:55:53 +02:00
|
|
|
self.headers = headers or {}
|
2026-04-06 12:48:33 -07:00
|
|
|
|
|
|
|
|
async def aiter_text(self):
|
|
|
|
|
for event in self._events:
|
|
|
|
|
yield event
|
|
|
|
|
|
|
|
|
|
async def aiter_bytes(self):
|
|
|
|
|
yield b"error body"
|
|
|
|
|
|
|
|
|
|
async def __aenter__(self):
|
|
|
|
|
return self
|
|
|
|
|
|
|
|
|
|
async def __aexit__(self, *args):
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class FakeHttpClient:
|
|
|
|
|
"""Mock httpx.AsyncClient with stream support."""
|
|
|
|
|
|
|
|
|
|
def __init__(self, response: FakeStreamResponse):
|
|
|
|
|
self._response = response
|
|
|
|
|
|
|
|
|
|
def stream(self, method, url, **kwargs):
|
|
|
|
|
return self._response
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _make_handler():
|
|
|
|
|
"""Create a minimal OpenAIHandlerMixin-like object."""
|
|
|
|
|
from headroom.proxy.handlers.openai import OpenAIHandlerMixin
|
|
|
|
|
|
|
|
|
|
obj = object.__new__(OpenAIHandlerMixin)
|
|
|
|
|
obj.OPENAI_API_URL = "https://api.openai.com"
|
|
|
|
|
obj.http_client = None
|
2026-04-16 23:38:00 +07:00
|
|
|
obj.config = SimpleNamespace(
|
|
|
|
|
retry_max_attempts=3,
|
|
|
|
|
retry_base_delay_ms=0,
|
|
|
|
|
retry_max_delay_ms=0,
|
|
|
|
|
)
|
2026-04-06 12:48:33 -07:00
|
|
|
return obj
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class TestWsHttpFallback:
|
|
|
|
|
def test_fallback_relays_sse_events(self):
|
|
|
|
|
"""HTTP fallback should relay SSE data lines as WS text messages."""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
sse_lines = [
|
|
|
|
|
'event: response.created\ndata: {"type":"response.created","response":{"id":"r1"}}\n\n',
|
|
|
|
|
'event: response.output_item.added\ndata: {"type":"response.output_item.added"}\n\n',
|
|
|
|
|
'event: response.completed\ndata: {"type":"response.completed"}\n\n',
|
|
|
|
|
"data: [DONE]\n\n",
|
|
|
|
|
]
|
|
|
|
|
response = FakeStreamResponse(200, sse_lines)
|
|
|
|
|
handler.http_client = FakeHttpClient(response)
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "hi"}
|
|
|
|
|
first_msg_raw = json.dumps({"type": "response.create", "response": body})
|
|
|
|
|
|
|
|
|
|
asyncio.run(
|
|
|
|
|
handler._ws_http_fallback(
|
|
|
|
|
ws, body, first_msg_raw, {"Authorization": "Bearer test"}, "req_1"
|
|
|
|
|
)
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
assert len(ws.sent_texts) == 3 # 3 data events, [DONE] skipped
|
|
|
|
|
assert '"response.created"' in ws.sent_texts[0]
|
|
|
|
|
assert '"response.output_item.added"' in ws.sent_texts[1]
|
|
|
|
|
assert '"response.completed"' in ws.sent_texts[2]
|
|
|
|
|
assert ws.closed
|
|
|
|
|
|
|
|
|
|
def test_fallback_sends_error_on_non_200(self):
|
|
|
|
|
"""HTTP fallback should send error event on non-200 response."""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
response = FakeStreamResponse(status_code=401)
|
|
|
|
|
handler.http_client = FakeHttpClient(response)
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "hi"}
|
|
|
|
|
asyncio.run(
|
|
|
|
|
handler._ws_http_fallback(
|
|
|
|
|
ws, body, json.dumps(body), {"Authorization": "Bearer bad"}, "req_2"
|
|
|
|
|
)
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
assert len(ws.sent_texts) == 1
|
|
|
|
|
event = json.loads(ws.sent_texts[0])
|
|
|
|
|
assert event["type"] == "error"
|
|
|
|
|
assert "401" in event["error"]["message"]
|
|
|
|
|
|
|
|
|
|
def test_fallback_sets_stream_true(self):
|
fix: B1 — retire ICM, RollingWindow, scoring, relevance + dependents
Phase B step 1 of the live-zone-only realignment. Removes ~10K LOC of
"drop messages from history" machinery that became unreachable after
PR-A1 made `/v1/messages` a passthrough on the proxy. Live-zone-only
compression (PR-B2..B7) operates on content blocks within messages;
message-list mutation no longer happens in the pipeline.
Python deletes:
- headroom/transforms/intelligent_context.py (1077 LOC)
- headroom/transforms/rolling_window.py (395 LOC)
- headroom/transforms/progressive_summarizer.py (508 LOC)
- headroom/transforms/scoring.py (459 LOC)
- headroom/transforms/tool_crusher.py (338 LOC)
- 5 corresponding tests/test_transforms/* and tests/test_proxy_intelligent_context.py
Rust deletes:
- crates/headroom-core/src/context/* (manager, config, workspace,
candidate, ccr_drop, strategy/, mod) + safety.rs replaced
- crates/headroom-core/src/scoring/* (mod, score, scorer, traits, weights)
- MessageScorerComparator from crates/headroom-parity (PR #338/#343
becomes deletable; sunk cost stays sunk)
- 13 message_scorer fixtures + record_message_scorer.py
Rust adds (move + rewrite):
- crates/headroom-core/src/transforms/safety.rs — `tool_pair_indices`
preserves the OpenAI/Anthropic tool_use ↔ tool_result pairing rule
the live-zone dispatcher (PR-B2) needs. No IcmConfig dependency.
Surface refactors:
- HeadroomConfig: drop `tool_crusher`, `rolling_window`,
`intelligent_context` fields; hoist `output_buffer_tokens` to top
level (used by client.py).
- ProxyConfig: drop `intelligent_context*` fields.
- `headroom wrap` proxy server: retire IntelligentContextManager
and RollingWindow imports + branch; pipeline is CacheAligner →
ContentRouter (smart_routing) or CacheAligner → SmartCrusher
(legacy).
- CLI: drop `--no-intelligent-context`, `--no-intelligent-scoring`,
`--no-compress-first` flags.
- LangChain memory integration: rename `_apply_rolling_window` →
`_apply_compression`, drop RollingWindowConfig dep. Threshold is
now advisory — B6 will rework the contract.
- TransformPipeline.create_pipeline now takes only cache_aligner_config.
- headroom/__init__.py + headroom/transforms/__init__.py: strip
exports of deleted symbols.
Bug fixes uncovered by full pytest sweep:
- providers/copilot/wrap.py: `environ or os.environ` collapsed
empty-dict to falsy → callers passing `environ={}` accidentally
pulled from os.environ. Use `environ if environ is not None else
os.environ`.
Test correctness fixes:
- _DummyAnthropicHandler._retry_request gains **_kwargs to match
the real handler signature post-A8.
- test_ws_http_fallback extracts JSON from `content=` (post-A3
byte-faithful) rather than the obsolete `json=` kwarg.
- test_ccr_response_handler_extra fixture joins SSE events with
`\n\n` per spec (post-A8 byte-buffer parser requirement).
- test_proxy_responses_phase_preservation: capture via direct
handler attached to the named logger, so the assertion is
order-independent (proxy `_setup_file_logging` flips
`headroom.propagate=False` once any earlier test triggers it).
- conftest.py autouse fixture resets `headroom.propagate=True`
before each test as a defensive measure for the same pollution.
- test_wrap_copilot_translated_backend_still_requires_byok:
monkeypatch.delenv every provider key so the BYOK error
actually fires.
- test_native_installers: skip when system bash < 4.3 (macOS ships 3.2).
- TestGeminiEmbedContent / TestGeminiBatchEmbedContents:
pytest.mark.skip — proxy currently has no :embedContent route;
feature gap, not regression.
Acceptance:
- cargo build --workspace + cargo clippy + cargo fmt --check: green.
- cargo test --workspace --exclude headroom-py: 777 passed.
- pytest: 4892 passed, 240 skipped, 0 failed.
- git grep returns only intentional comments referencing the deletion.
Per-PR-B1 plan: REALIGNMENT/04-phase-B-live-zone.md.
2026-05-02 12:23:17 -07:00
|
|
|
"""HTTP fallback should force stream=True in request body.
|
|
|
|
|
|
|
|
|
|
After PR-A3 (byte-faithful Python forwarders) the fallback sends
|
|
|
|
|
the request body as raw bytes via `content=`, not via the `json=`
|
|
|
|
|
kwarg. The test extracts the posted JSON from the captured bytes.
|
|
|
|
|
"""
|
2026-04-06 12:48:33 -07:00
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
captured_kwargs: dict = {}
|
|
|
|
|
|
|
|
|
|
class CapturingClient:
|
|
|
|
|
def stream(self, method, url, **kwargs):
|
|
|
|
|
captured_kwargs.update(kwargs)
|
|
|
|
|
return FakeStreamResponse(200, ["data: [DONE]\n\n"])
|
|
|
|
|
|
|
|
|
|
handler.http_client = CapturingClient()
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "test", "stream": False}
|
|
|
|
|
asyncio.run(handler._ws_http_fallback(ws, body, json.dumps(body), {}, "req_3"))
|
|
|
|
|
|
fix: B1 — retire ICM, RollingWindow, scoring, relevance + dependents
Phase B step 1 of the live-zone-only realignment. Removes ~10K LOC of
"drop messages from history" machinery that became unreachable after
PR-A1 made `/v1/messages` a passthrough on the proxy. Live-zone-only
compression (PR-B2..B7) operates on content blocks within messages;
message-list mutation no longer happens in the pipeline.
Python deletes:
- headroom/transforms/intelligent_context.py (1077 LOC)
- headroom/transforms/rolling_window.py (395 LOC)
- headroom/transforms/progressive_summarizer.py (508 LOC)
- headroom/transforms/scoring.py (459 LOC)
- headroom/transforms/tool_crusher.py (338 LOC)
- 5 corresponding tests/test_transforms/* and tests/test_proxy_intelligent_context.py
Rust deletes:
- crates/headroom-core/src/context/* (manager, config, workspace,
candidate, ccr_drop, strategy/, mod) + safety.rs replaced
- crates/headroom-core/src/scoring/* (mod, score, scorer, traits, weights)
- MessageScorerComparator from crates/headroom-parity (PR #338/#343
becomes deletable; sunk cost stays sunk)
- 13 message_scorer fixtures + record_message_scorer.py
Rust adds (move + rewrite):
- crates/headroom-core/src/transforms/safety.rs — `tool_pair_indices`
preserves the OpenAI/Anthropic tool_use ↔ tool_result pairing rule
the live-zone dispatcher (PR-B2) needs. No IcmConfig dependency.
Surface refactors:
- HeadroomConfig: drop `tool_crusher`, `rolling_window`,
`intelligent_context` fields; hoist `output_buffer_tokens` to top
level (used by client.py).
- ProxyConfig: drop `intelligent_context*` fields.
- `headroom wrap` proxy server: retire IntelligentContextManager
and RollingWindow imports + branch; pipeline is CacheAligner →
ContentRouter (smart_routing) or CacheAligner → SmartCrusher
(legacy).
- CLI: drop `--no-intelligent-context`, `--no-intelligent-scoring`,
`--no-compress-first` flags.
- LangChain memory integration: rename `_apply_rolling_window` →
`_apply_compression`, drop RollingWindowConfig dep. Threshold is
now advisory — B6 will rework the contract.
- TransformPipeline.create_pipeline now takes only cache_aligner_config.
- headroom/__init__.py + headroom/transforms/__init__.py: strip
exports of deleted symbols.
Bug fixes uncovered by full pytest sweep:
- providers/copilot/wrap.py: `environ or os.environ` collapsed
empty-dict to falsy → callers passing `environ={}` accidentally
pulled from os.environ. Use `environ if environ is not None else
os.environ`.
Test correctness fixes:
- _DummyAnthropicHandler._retry_request gains **_kwargs to match
the real handler signature post-A8.
- test_ws_http_fallback extracts JSON from `content=` (post-A3
byte-faithful) rather than the obsolete `json=` kwarg.
- test_ccr_response_handler_extra fixture joins SSE events with
`\n\n` per spec (post-A8 byte-buffer parser requirement).
- test_proxy_responses_phase_preservation: capture via direct
handler attached to the named logger, so the assertion is
order-independent (proxy `_setup_file_logging` flips
`headroom.propagate=False` once any earlier test triggers it).
- conftest.py autouse fixture resets `headroom.propagate=True`
before each test as a defensive measure for the same pollution.
- test_wrap_copilot_translated_backend_still_requires_byok:
monkeypatch.delenv every provider key so the BYOK error
actually fires.
- test_native_installers: skip when system bash < 4.3 (macOS ships 3.2).
- TestGeminiEmbedContent / TestGeminiBatchEmbedContents:
pytest.mark.skip — proxy currently has no :embedContent route;
feature gap, not regression.
Acceptance:
- cargo build --workspace + cargo clippy + cargo fmt --check: green.
- cargo test --workspace --exclude headroom-py: 777 passed.
- pytest: 4892 passed, 240 skipped, 0 failed.
- git grep returns only intentional comments referencing the deletion.
Per-PR-B1 plan: REALIGNMENT/04-phase-B-live-zone.md.
2026-05-02 12:23:17 -07:00
|
|
|
posted = json.loads(captured_kwargs["content"])
|
|
|
|
|
assert posted["stream"] is True
|
2026-04-06 12:48:33 -07:00
|
|
|
|
|
|
|
|
def test_fallback_unwraps_response_create_envelope(self):
|
|
|
|
|
"""HTTP fallback should unwrap WS response.create wrapper for HTTP POST."""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
captured_kwargs: dict = {}
|
|
|
|
|
|
|
|
|
|
class CapturingClient:
|
|
|
|
|
def stream(self, method, url, **kwargs):
|
|
|
|
|
captured_kwargs.update(kwargs)
|
|
|
|
|
return FakeStreamResponse(200, ["data: [DONE]\n\n"])
|
|
|
|
|
|
|
|
|
|
handler.http_client = CapturingClient()
|
|
|
|
|
|
|
|
|
|
# WS sends wrapped format: {"type": "response.create", "response": {...}}
|
|
|
|
|
inner = {
|
|
|
|
|
"model": "gpt-5.4",
|
|
|
|
|
"input": [{"role": "user", "content": [{"type": "input_text", "text": "hi"}]}],
|
|
|
|
|
}
|
|
|
|
|
ws_msg = {"type": "response.create", "response": inner}
|
|
|
|
|
asyncio.run(handler._ws_http_fallback(ws, ws_msg, json.dumps(ws_msg), {}, "req_unwrap"))
|
|
|
|
|
|
fix: B1 — retire ICM, RollingWindow, scoring, relevance + dependents
Phase B step 1 of the live-zone-only realignment. Removes ~10K LOC of
"drop messages from history" machinery that became unreachable after
PR-A1 made `/v1/messages` a passthrough on the proxy. Live-zone-only
compression (PR-B2..B7) operates on content blocks within messages;
message-list mutation no longer happens in the pipeline.
Python deletes:
- headroom/transforms/intelligent_context.py (1077 LOC)
- headroom/transforms/rolling_window.py (395 LOC)
- headroom/transforms/progressive_summarizer.py (508 LOC)
- headroom/transforms/scoring.py (459 LOC)
- headroom/transforms/tool_crusher.py (338 LOC)
- 5 corresponding tests/test_transforms/* and tests/test_proxy_intelligent_context.py
Rust deletes:
- crates/headroom-core/src/context/* (manager, config, workspace,
candidate, ccr_drop, strategy/, mod) + safety.rs replaced
- crates/headroom-core/src/scoring/* (mod, score, scorer, traits, weights)
- MessageScorerComparator from crates/headroom-parity (PR #338/#343
becomes deletable; sunk cost stays sunk)
- 13 message_scorer fixtures + record_message_scorer.py
Rust adds (move + rewrite):
- crates/headroom-core/src/transforms/safety.rs — `tool_pair_indices`
preserves the OpenAI/Anthropic tool_use ↔ tool_result pairing rule
the live-zone dispatcher (PR-B2) needs. No IcmConfig dependency.
Surface refactors:
- HeadroomConfig: drop `tool_crusher`, `rolling_window`,
`intelligent_context` fields; hoist `output_buffer_tokens` to top
level (used by client.py).
- ProxyConfig: drop `intelligent_context*` fields.
- `headroom wrap` proxy server: retire IntelligentContextManager
and RollingWindow imports + branch; pipeline is CacheAligner →
ContentRouter (smart_routing) or CacheAligner → SmartCrusher
(legacy).
- CLI: drop `--no-intelligent-context`, `--no-intelligent-scoring`,
`--no-compress-first` flags.
- LangChain memory integration: rename `_apply_rolling_window` →
`_apply_compression`, drop RollingWindowConfig dep. Threshold is
now advisory — B6 will rework the contract.
- TransformPipeline.create_pipeline now takes only cache_aligner_config.
- headroom/__init__.py + headroom/transforms/__init__.py: strip
exports of deleted symbols.
Bug fixes uncovered by full pytest sweep:
- providers/copilot/wrap.py: `environ or os.environ` collapsed
empty-dict to falsy → callers passing `environ={}` accidentally
pulled from os.environ. Use `environ if environ is not None else
os.environ`.
Test correctness fixes:
- _DummyAnthropicHandler._retry_request gains **_kwargs to match
the real handler signature post-A8.
- test_ws_http_fallback extracts JSON from `content=` (post-A3
byte-faithful) rather than the obsolete `json=` kwarg.
- test_ccr_response_handler_extra fixture joins SSE events with
`\n\n` per spec (post-A8 byte-buffer parser requirement).
- test_proxy_responses_phase_preservation: capture via direct
handler attached to the named logger, so the assertion is
order-independent (proxy `_setup_file_logging` flips
`headroom.propagate=False` once any earlier test triggers it).
- conftest.py autouse fixture resets `headroom.propagate=True`
before each test as a defensive measure for the same pollution.
- test_wrap_copilot_translated_backend_still_requires_byok:
monkeypatch.delenv every provider key so the BYOK error
actually fires.
- test_native_installers: skip when system bash < 4.3 (macOS ships 3.2).
- TestGeminiEmbedContent / TestGeminiBatchEmbedContents:
pytest.mark.skip — proxy currently has no :embedContent route;
feature gap, not regression.
Acceptance:
- cargo build --workspace + cargo clippy + cargo fmt --check: green.
- cargo test --workspace --exclude headroom-py: 777 passed.
- pytest: 4892 passed, 240 skipped, 0 failed.
- git grep returns only intentional comments referencing the deletion.
Per-PR-B1 plan: REALIGNMENT/04-phase-B-live-zone.md.
2026-05-02 12:23:17 -07:00
|
|
|
posted = json.loads(captured_kwargs["content"])
|
2026-04-06 12:48:33 -07:00
|
|
|
# Should be the inner response, not the wrapper
|
|
|
|
|
assert "type" not in posted # no "response.create" type field
|
|
|
|
|
assert posted["model"] == "gpt-5.4"
|
|
|
|
|
assert posted["stream"] is True
|
|
|
|
|
assert "input" in posted
|
|
|
|
|
|
2026-04-16 23:38:00 +07:00
|
|
|
def test_fallback_strips_top_level_response_create_type(self):
|
|
|
|
|
"""HTTP fallback should strip top-level response.create metadata."""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
captured_kwargs: dict = {}
|
|
|
|
|
|
|
|
|
|
class CapturingClient:
|
|
|
|
|
def stream(self, method, url, **kwargs):
|
|
|
|
|
captured_kwargs.update(kwargs)
|
|
|
|
|
return FakeStreamResponse(200, ["data: [DONE]\n\n"])
|
|
|
|
|
|
|
|
|
|
handler.http_client = CapturingClient()
|
|
|
|
|
|
|
|
|
|
body = {"type": "response.create", "model": "gpt-5.4", "input": "hi"}
|
|
|
|
|
asyncio.run(handler._ws_http_fallback(ws, body, json.dumps(body), {}, "req_type_strip"))
|
|
|
|
|
|
fix: B1 — retire ICM, RollingWindow, scoring, relevance + dependents
Phase B step 1 of the live-zone-only realignment. Removes ~10K LOC of
"drop messages from history" machinery that became unreachable after
PR-A1 made `/v1/messages` a passthrough on the proxy. Live-zone-only
compression (PR-B2..B7) operates on content blocks within messages;
message-list mutation no longer happens in the pipeline.
Python deletes:
- headroom/transforms/intelligent_context.py (1077 LOC)
- headroom/transforms/rolling_window.py (395 LOC)
- headroom/transforms/progressive_summarizer.py (508 LOC)
- headroom/transforms/scoring.py (459 LOC)
- headroom/transforms/tool_crusher.py (338 LOC)
- 5 corresponding tests/test_transforms/* and tests/test_proxy_intelligent_context.py
Rust deletes:
- crates/headroom-core/src/context/* (manager, config, workspace,
candidate, ccr_drop, strategy/, mod) + safety.rs replaced
- crates/headroom-core/src/scoring/* (mod, score, scorer, traits, weights)
- MessageScorerComparator from crates/headroom-parity (PR #338/#343
becomes deletable; sunk cost stays sunk)
- 13 message_scorer fixtures + record_message_scorer.py
Rust adds (move + rewrite):
- crates/headroom-core/src/transforms/safety.rs — `tool_pair_indices`
preserves the OpenAI/Anthropic tool_use ↔ tool_result pairing rule
the live-zone dispatcher (PR-B2) needs. No IcmConfig dependency.
Surface refactors:
- HeadroomConfig: drop `tool_crusher`, `rolling_window`,
`intelligent_context` fields; hoist `output_buffer_tokens` to top
level (used by client.py).
- ProxyConfig: drop `intelligent_context*` fields.
- `headroom wrap` proxy server: retire IntelligentContextManager
and RollingWindow imports + branch; pipeline is CacheAligner →
ContentRouter (smart_routing) or CacheAligner → SmartCrusher
(legacy).
- CLI: drop `--no-intelligent-context`, `--no-intelligent-scoring`,
`--no-compress-first` flags.
- LangChain memory integration: rename `_apply_rolling_window` →
`_apply_compression`, drop RollingWindowConfig dep. Threshold is
now advisory — B6 will rework the contract.
- TransformPipeline.create_pipeline now takes only cache_aligner_config.
- headroom/__init__.py + headroom/transforms/__init__.py: strip
exports of deleted symbols.
Bug fixes uncovered by full pytest sweep:
- providers/copilot/wrap.py: `environ or os.environ` collapsed
empty-dict to falsy → callers passing `environ={}` accidentally
pulled from os.environ. Use `environ if environ is not None else
os.environ`.
Test correctness fixes:
- _DummyAnthropicHandler._retry_request gains **_kwargs to match
the real handler signature post-A8.
- test_ws_http_fallback extracts JSON from `content=` (post-A3
byte-faithful) rather than the obsolete `json=` kwarg.
- test_ccr_response_handler_extra fixture joins SSE events with
`\n\n` per spec (post-A8 byte-buffer parser requirement).
- test_proxy_responses_phase_preservation: capture via direct
handler attached to the named logger, so the assertion is
order-independent (proxy `_setup_file_logging` flips
`headroom.propagate=False` once any earlier test triggers it).
- conftest.py autouse fixture resets `headroom.propagate=True`
before each test as a defensive measure for the same pollution.
- test_wrap_copilot_translated_backend_still_requires_byok:
monkeypatch.delenv every provider key so the BYOK error
actually fires.
- test_native_installers: skip when system bash < 4.3 (macOS ships 3.2).
- TestGeminiEmbedContent / TestGeminiBatchEmbedContents:
pytest.mark.skip — proxy currently has no :embedContent route;
feature gap, not regression.
Acceptance:
- cargo build --workspace + cargo clippy + cargo fmt --check: green.
- cargo test --workspace --exclude headroom-py: 777 passed.
- pytest: 4892 passed, 240 skipped, 0 failed.
- git grep returns only intentional comments referencing the deletion.
Per-PR-B1 plan: REALIGNMENT/04-phase-B-live-zone.md.
2026-05-02 12:23:17 -07:00
|
|
|
posted = json.loads(captured_kwargs["content"])
|
2026-04-16 23:38:00 +07:00
|
|
|
assert posted["model"] == "gpt-5.4"
|
|
|
|
|
assert posted["stream"] is True
|
|
|
|
|
assert "type" not in posted
|
|
|
|
|
|
2026-04-06 12:48:33 -07:00
|
|
|
def test_fallback_handles_http_exception(self):
|
|
|
|
|
"""HTTP fallback should send error event when HTTP request fails."""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
|
|
|
|
|
class FailingClient:
|
|
|
|
|
def stream(self, method, url, **kwargs):
|
|
|
|
|
raise ConnectionError("upstream unreachable")
|
|
|
|
|
|
|
|
|
|
handler.http_client = FailingClient()
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "test"}
|
|
|
|
|
asyncio.run(handler._ws_http_fallback(ws, body, json.dumps(body), {}, "req_4"))
|
|
|
|
|
|
|
|
|
|
assert len(ws.sent_texts) == 1
|
|
|
|
|
event = json.loads(ws.sent_texts[0])
|
|
|
|
|
assert event["type"] == "error"
|
|
|
|
|
assert "unreachable" in event["error"]["message"]
|
|
|
|
|
|
2026-04-16 23:38:00 +07:00
|
|
|
def test_fallback_retries_connect_timeout(self):
|
|
|
|
|
"""HTTP fallback should retry transient connect timeouts."""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
attempts = {"count": 0}
|
|
|
|
|
|
|
|
|
|
class FlakyClient:
|
|
|
|
|
def stream(self, method, url, **kwargs):
|
|
|
|
|
attempts["count"] += 1
|
|
|
|
|
if attempts["count"] == 1:
|
|
|
|
|
raise httpx.ConnectTimeout("timed out")
|
|
|
|
|
return FakeStreamResponse(200, ['data: {"type":"response.completed"}\n\n'])
|
|
|
|
|
|
|
|
|
|
handler.http_client = FlakyClient()
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "test"}
|
|
|
|
|
asyncio.run(handler._ws_http_fallback(ws, body, json.dumps(body), {}, "req_retry"))
|
|
|
|
|
|
|
|
|
|
assert attempts["count"] == 2
|
|
|
|
|
assert len(ws.sent_texts) == 1
|
|
|
|
|
assert json.loads(ws.sent_texts[0])["type"] == "response.completed"
|
|
|
|
|
|
2026-04-06 12:48:33 -07:00
|
|
|
def test_fallback_routes_chatgpt_auth_to_chatgpt_domain(self):
|
|
|
|
|
"""ChatGPT session auth should route to chatgpt.com, not api.openai.com."""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
captured_url = {}
|
|
|
|
|
|
|
|
|
|
class CapturingClient:
|
|
|
|
|
def stream(self, method, url, **kwargs):
|
|
|
|
|
captured_url["url"] = url
|
|
|
|
|
return FakeStreamResponse(200, ["data: [DONE]\n\n"])
|
|
|
|
|
|
|
|
|
|
handler.http_client = CapturingClient()
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "test"}
|
|
|
|
|
# ChatGPT session auth includes this header
|
|
|
|
|
headers = {
|
|
|
|
|
"Authorization": "Bearer chatgpt-session-token",
|
|
|
|
|
"ChatGPT-Account-ID": "acct_abc123",
|
|
|
|
|
}
|
|
|
|
|
asyncio.run(handler._ws_http_fallback(ws, body, json.dumps(body), headers, "req_5"))
|
|
|
|
|
|
|
|
|
|
assert "chatgpt.com" in captured_url["url"]
|
|
|
|
|
assert "api.openai.com" not in captured_url["url"]
|
|
|
|
|
|
fix(proxy): skip Responses memory tools for ChatGPT auth (#1579)
## Description
Fix ChatGPT/Codex session-auth Responses proxy handling so the ChatGPT
backend always receives an explicit `store=false`, while keeping
Responses memory tools limited to the regular API-key path where stored
responses are supported.
## 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
- Detect ChatGPT auth before Responses memory-tool injection and force
`store=false` for ChatGPT-auth Responses payloads.
- Skip Responses memory tools and transparent memory-tool continuation
handling for ChatGPT auth across HTTP, WebSocket first frames, WebSocket
follow-up `response.create` frames, and WS-to-HTTP fallback.
- Preserve API-key behavior after the current main merge: API-key
requests that explicitly set `store=false` skip Responses memory tools,
while API-key requests that receive injected memory tools are forced to
`store=true` for continuation support.
- Address Copilot formatter comments by making
`_allow_responses_memory_tools` call sites formatter-stable.
## Testing
- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual testing performed
### Test Output
```text
$ uv run --extra dev ruff format --check headroom/proxy/handlers/openai.py
1 file already formatted
$ uv run --extra dev ruff check headroom/proxy/handlers/openai.py tests/test_openai_codex_routing.py tests/test_openai_codex_ws_timings.py tests/test_ws_http_fallback.py
All checks passed!
$ uv run --extra dev python -m pytest -q tests/test_openai_codex_routing.py tests/test_openai_codex_ws_timings.py tests/test_ws_http_fallback.py
37 passed in 0.34s
```
## Real Behavior Proof
- Environment: Local checkout of `fix/codex-store-false-memory-tools`
using `uv run --extra dev`.
- Exact command / steps: Ran the focused formatter, lint, and pytest
commands listed in `Testing`.
- Observed result: Formatting is stable, lint passes, and the focused
OpenAI/Codex routing and fallback tests pass.
- Not tested: Full test suite, `mypy headroom`, and a fresh live ChatGPT
backend probe after the formatter-only follow-up. The original PR
validation recorded that valid ChatGPT subscription backend requests
return `200` with `store=false`, while identical `store=true` or omitted
`store` requests return `400 Store must be set to false`.
## 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
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] 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
- [ ] I have updated the CHANGELOG.md if applicable
## Screenshots (if applicable)
N/A.
## Additional Notes
- Post-deploy monitoring terms: `Responses: forced store=false for
ChatGPT auth`, `WS Responses: forced store=false for ChatGPT auth`,
`chatgpt_store_false`, `Memory: forced store=true for Responses memory
tool continuation`, and upstream 400s containing `Store must be set to
false`.
- Expected healthy signals: ChatGPT-auth Responses requests keep
`store=false` and no longer fail with `Store must be set to false`;
API-key memory-tool flows still inject memory tools and can continue via
`previous_response_id`.
- Rollback trigger: any increase in ChatGPT-auth 400s, API-key
memory-tool continuation failures, or missing memory tool injection on
API-key Responses requests.
---------
Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
2026-07-16 04:52:01 +08:00
|
|
|
def test_fallback_chatgpt_auth_forces_store_false(self):
|
|
|
|
|
"""ChatGPT Responses backend requires explicit store=false."""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
captured_kwargs: dict = {}
|
|
|
|
|
|
|
|
|
|
class CapturingClient:
|
|
|
|
|
def stream(self, method, url, **kwargs):
|
|
|
|
|
captured_kwargs.update(kwargs)
|
|
|
|
|
return FakeStreamResponse(200, ["data: [DONE]\n\n"])
|
|
|
|
|
|
|
|
|
|
handler.http_client = CapturingClient()
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "test", "store": True}
|
|
|
|
|
headers = {
|
|
|
|
|
"Authorization": "Bearer chatgpt-session-token",
|
|
|
|
|
"ChatGPT-Account-ID": "acct_abc123",
|
|
|
|
|
}
|
|
|
|
|
asyncio.run(handler._ws_http_fallback(ws, body, json.dumps(body), headers, "req_store"))
|
|
|
|
|
|
|
|
|
|
posted = json.loads(captured_kwargs["content"])
|
|
|
|
|
assert posted["store"] is False
|
|
|
|
|
assert posted["stream"] is True
|
|
|
|
|
|
2026-04-06 12:48:33 -07:00
|
|
|
def test_fallback_routes_api_key_to_openai(self):
|
|
|
|
|
"""API key auth should route to api.openai.com."""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
captured_url = {}
|
|
|
|
|
|
|
|
|
|
class CapturingClient:
|
|
|
|
|
def stream(self, method, url, **kwargs):
|
|
|
|
|
captured_url["url"] = url
|
|
|
|
|
return FakeStreamResponse(200, ["data: [DONE]\n\n"])
|
|
|
|
|
|
|
|
|
|
handler.http_client = CapturingClient()
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "test"}
|
|
|
|
|
# API key auth — no ChatGPT-Account-ID header
|
|
|
|
|
headers = {"Authorization": "Bearer sk-abc123"}
|
|
|
|
|
asyncio.run(handler._ws_http_fallback(ws, body, json.dumps(body), headers, "req_6"))
|
|
|
|
|
|
|
|
|
|
assert "api.openai.com" in captured_url["url"]
|
fix(proxy): restore Codex usage headers on WS and streaming SSE transports (#577) (#794)
## Description
Codex's subscription/rate-limit window (the `x-codex-*` headers) was
being
**stripped on every transport Codex actually uses**, so session/weekly
usage
never reached the Codex CLI's own `/status` display, Headroom
`/stats`/dashboard,
or any consumer that sniffs the client-facing handshake. This PR
restores it on
**both** the WebSocket and streaming-SSE paths — the two halves of #577
— in one
place.
Fixes #577
**Supersedes #582 and #590.** This PR incorporates #582's SSE fix
(carried verbatim
with a `Co-authored-by` trailer) and additionally forwards the window
onto the client
`101` on the WS path, which #582/#590's capture-only WS code cannot do.
Both can be
closed as superseded once this merges — GitHub closing keywords only
auto-close
issues (hence `Fixes #577` above), not PRs, so #582/#590 need a manual
close.
### WebSocket (`gpt-5.4+`)
OpenAI delivers `x-codex-*` **only** on the upstream WS handshake
response, never
in data frames. `handle_openai_responses_ws` accepted the client WS
*before* it
connected upstream and never read `upstream.response.headers`, so the
window was
dropped. This reorders the handler to **connect upstream first**,
extract the
`x-codex-*` subset, then **accept the client WS with those headers
attached** to
the `101`, and refresh the Python state for `/stats` parity.
### Streaming SSE (incorporated from #582, @m16khb)
Codex CLI almost always streams. `streaming.py` neither captured
`x-codex-*` into
`CodexRateLimitState` nor forwarded it — the forwarded-header filter
matched only
the substring `"ratelimit"`, which `x-codex-*` does not contain. This
calls
`update_from_headers()` **before** the `>=400` early-return (so a
streaming 429/5xx
still refreshes the window, matching the non-streaming handlers) and
widens the
forward filter to pass `x-codex-*`.
> Credit: the SSE fix is @m16khb's work from #582, carried here verbatim
with a
> `Co-authored-by` trailer so the maintainer gets a single PR covering
both
> transports. This supersedes #582/#590's **WS** capture (which only
writes
> `/stats`); the connect-before-accept reorder additionally forwards the
window to
> the client `101`, which capture-only cannot do. #590's optional
snapshot
> persistence is intentionally left out (separable; hot-path sync write;
doesn't
> help the `101`-sniff consumers).
## 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
- `openai.py`: add `_extract_codex_handshake_headers()` (strictly
`x-codex-*`, via
`raw_items()` to avoid `MultipleValuesError`; never
`set-cookie`/`authorization`).
- `openai.py`: reorder `handle_openai_responses_ws` — connect-only retry
loop runs
before `accept()`; `accept(headers=...)` carries the forwarded window;
first
client frame read afterward. HTTP fallback preserved; it now also
refreshes
`/stats` from the HTTP response headers.
- `streaming.py`: capture `x-codex-*` on all statuses + widen the
forwarded-header
filter (from #582).
### Diff-size note
The bulk of the `openai.py` line count is **whitespace-only
relocation**: the relay
block dedents one level out of the old per-attempt `async with`. Logical
change is
~290 lines. **Review with `?w=1`.** In API-key mode the handshake
carries no
`x-codex-*`, so the accept-header list is empty and the path behaves
exactly as
before — the fix only activates for ChatGPT-subscription auth.
## Testing
- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual testing performed
- WS: `test_ws_connect_happens_before_accept`,
`test_ws_forwards_codex_headers_to_client_accept`
(only `x-codex-*` forwarded; `set-cookie`/`authorization` excluded;
`/stats` refreshed),
`test_ws_connect_failure_falls_back_to_http`,
`test_ws_first_frame_timeout_after_connect_closes_upstream`.
- Fallback: `test_fallback_refreshes_codex_rate_limit_state`.
- SSE:
`test_codex_rate_limit_headers_captured_and_forwarded_in_streaming`,
`test_codex_rate_limit_captured_on_streaming_429` (from #582).
- Wire-level e2e: `tests/e2e_ws_codex_usage_headers.py` boots the real
proxy + fake
upstream + real `websockets` client and reads the client `101` — closes
the gap
the unit tests stub (that uvicorn/starlette actually write
`accept(headers=...)`).
## Test Output
```
$ uv run pytest tests/test_proxy_streaming_ratelimit_headers.py \
tests/test_ws_http_fallback.py \
tests/test_openai_codex_ws_lifecycle.py \
tests/test_openai_codex_ws_timings.py \
tests/test_codex_rate_limits.py -q
63 passed in 0.83s
$ .venv/bin/python tests/e2e_ws_codex_usage_headers.py
[codex-hdr-e2e] client 101 headers:
x-codex-primary-used-percent: 42
x-codex-primary-window-minutes: 300
x-codex-secondary-used-percent: 7
x-codex-secondary-window-minutes: 10080
[codex-hdr-e2e] /stats reflects codex window (primary-used=42)
=== CODEX-HDR E2E ALL GREEN ===
$ uv run ruff check . && uv run ruff format --check <touched files>
All checks passed!
```
## 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
- [x] My changes generate no new warnings
- [x] 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
- [ ] I have updated the CHANGELOG.md if applicable
## Additional Notes
- **Why connect-before-accept (not capture-only).** Once `accept()`
sends the `101`,
headers can no longer be added; the `x-codex-*` window only exists after
we connect
upstream. Capturing into Python state (as #582/#590's WS code does)
fixes `/stats`
but not the Codex CLI's native display or any `101`-sniffing consumer —
those need
the headers *on the client handshake*, which requires the reorder.
- **Security.** Forwarding is filtered strictly to `x-codex-*`;
`set-cookie`,
`authorization`, and all other upstream headers are never forwarded to
the client
(asserted by both the unit test and the e2e).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
## Contract Schemas
Per maintainer request: a JSON Schema (draft 2020-12) artifact
enshrining the OpenAI
interaction expectations this changeset relies on, so drift is
detectable later.
Committed following the repo's parity convention:
- schema:
`tests/parity/fixtures/codex_openai_contracts/codex-openai-interaction.schema.json`
- test: `tests/test_codex_openai_contract_parity.py` binds the schema to
the **live code**
in both directions, so drift fails CI rather than living only in this
description -
every declared `x-codex-*` header must be consumed by
`parse_codex_rate_limits`, and
`_extract_codex_handshake_headers` must forward exactly the declared
subset and never
`set-cookie`/`authorization`. No new dependency (does not pull in
`jsonschema`).
It covers, as `$defs`:
- `WSUpstreamHandshakeResponse` / `StreamingUpstreamResponseHeaders` -
the upstream
`x-codex-*` header family (full superset, with per-header wire pattern +
the parsed
semantic type) the WS and SSE captures read. Source of truth:
`parse_codex_rate_limits`.
- `ClientForwardedHandshakeHeaders` - the WS-101 **allow/deny**
contract: only
`x-codex-*` may be forwarded; `set-cookie`/`authorization` are
explicitly forbidden
(`propertyNames` + `not`).
- `ClientForwardedStreamingHeaders` - the wider SSE forward set
(`*ratelimit*` OR `x-codex*`).
- `WSClientRequestFrame` / `WSRelayEvent` / `HTTPFallbackRequestBody` -
the WS frame
envelopes and the unwrapped HTTP-fallback POST body.
- `CodexRateLimitStatsOutput` - the headroom `/stats` shape the parity
tests assert.
Validated with `jsonschema` (Draft202012 `check_schema` passes; positive
instances from
the e2e validate; negative instances - a leaked `set-cookie`, a fallback
body still
carrying a top-level `type` - are correctly rejected).
<details>
<summary><code>codex-openai-interaction.schema.json</code> (draft
2020-12)</summary>
```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/chopratejas/headroom/contracts/codex-openai-interaction.schema.json",
"title": "Codex <-> OpenAI interaction contracts (PR #794)",
"description": "Enshrines the OpenAI interaction expectations this changeset depends on, so drift is detectable. Header values are transported as strings on the wire; the `x-headroom-parsed-type` annotation on each records the semantic type the parser (headroom/subscription/codex_rate_limits.py) coerces them to. Sources: codex_rate_limits.parse_codex_rate_limits (header family + gating), openai._extract_codex_handshake_headers (WS-101 forward filter), streaming.py (SSE forward filter).",
"$defs": {
"OpenAICodexWindowHeaders": {
"title": "x-codex-*-{primary,secondary} window headers",
"description": "A rolling rate-limit/subscription window. A window is materialized iff its `*-used-percent` header is present and numeric; `*-window-minutes` and `*-reset-at` are optional. `primary` and `secondary` are independent and either may be absent.",
"type": "object",
"properties": {
"x-codex-primary-used-percent": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$",
"x-headroom-parsed-type": "float (0-100, NaN-guarded)",
"description": "Percent of the primary window consumed. Gates creation of the primary window."
},
"x-codex-primary-window-minutes": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int",
"description": "Primary window size in minutes."
},
"x-codex-primary-reset-at": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int (Unix epoch seconds)",
"description": "Absolute reset time of the primary window."
},
"x-codex-secondary-used-percent": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$",
"x-headroom-parsed-type": "float (0-100, NaN-guarded)",
"description": "Percent of the secondary window consumed. Gates creation of the secondary window."
},
"x-codex-secondary-window-minutes": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int"
},
"x-codex-secondary-reset-at": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int (Unix epoch seconds)"
}
},
"additionalProperties": true
},
"OpenAICodexCreditsHeaders": {
"title": "x-codex-credits-* headers",
"description": "OpenAI credits balance. A credits snapshot is materialized iff `x-codex-credits-has-credits` is present; `unlimited` defaults to false; `balance` is optional.",
"type": "object",
"properties": {
"x-codex-credits-has-credits": {
"type": "string",
"pattern": "^(?:[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[01])$",
"x-headroom-parsed-type": "bool (true|false|1|0, case-insensitive)",
"description": "Gates creation of the credits snapshot."
},
"x-codex-credits-unlimited": {
"type": "string",
"pattern": "^(?:[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[01])$",
"x-headroom-parsed-type": "bool (defaults false when absent/unparseable)"
},
"x-codex-credits-balance": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Free-form server string, e.g. \"$5.00\"."
}
},
"additionalProperties": true
},
"OpenAICodexMetaHeaders": {
"title": "x-codex meta headers",
"type": "object",
"properties": {
"x-codex-limit-name": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Active limit/model label, e.g. \"gpt-5.2-codex-sonic\"."
},
"x-codex-promo-message": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Server announcement. Also gates snapshot creation when present."
}
},
"additionalProperties": true
},
"OpenAICodexRateLimitHeaders": {
"title": "Full x-codex-* header family OpenAI may emit",
"description": "Superset of every x-codex-* header headroom reads. parse_codex_rate_limits returns a snapshot iff at least one of: a primary window, a secondary window, a credits snapshot, or a non-empty promo message is present; otherwise null (treated as a non-Codex response). All members are individually optional.",
"type": "object",
"allOf": [
{ "$ref": "#/$defs/OpenAICodexWindowHeaders" },
{ "$ref": "#/$defs/OpenAICodexCreditsHeaders" },
{ "$ref": "#/$defs/OpenAICodexMetaHeaders" }
],
"additionalProperties": true
},
"WSUpstreamHandshakeResponse": {
"title": "OpenAI WS handshake (101) response headers consumed by the WS fix",
"description": "On the Codex WebSocket transport the x-codex-* window is delivered ONLY on the upstream handshake response (never in data frames). handle_openai_responses_ws reads upstream.response.headers here. This is the contract the connect-before-accept reorder depends on: if OpenAI ever moves these headers off the handshake (e.g. into a frame), the WS half of the fix goes stale.",
"$ref": "#/$defs/OpenAICodexRateLimitHeaders"
},
"StreamingUpstreamResponseHeaders": {
"title": "OpenAI streaming/HTTP response headers consumed by the SSE fix",
"description": "On the streaming SSE/HTTP transport the same x-codex-* headers ride the HTTP response. streaming.py captures them on ALL statuses (including >=400) via update_from_headers, and forwards a wider set to the client (see ClientForwardedStreamingHeaders).",
"$ref": "#/$defs/OpenAICodexRateLimitHeaders"
},
"ClientForwardedHandshakeHeaders": {
"title": "Headers forwarded onto the CLIENT-facing WS 101 (allow/deny contract)",
"description": "_extract_codex_handshake_headers forwards ONLY headers whose (lowercased) name starts with `x-codex-`. Every other upstream handshake header - notably set-cookie and authorization - MUST NOT appear on the client 101. Enforced by propertyNames below and asserted by the unit tests + tests/e2e_ws_codex_usage_headers.py.",
"type": "object",
"propertyNames": {
"pattern": "^[Xx]-[Cc][Oo][Dd][Ee][Xx]-"
},
"not": {
"anyOf": [
{ "required": ["set-cookie"] },
{ "required": ["Set-Cookie"] },
{ "required": ["authorization"] },
{ "required": ["Authorization"] }
]
},
"additionalProperties": { "type": "string" }
},
"ClientForwardedStreamingHeaders": {
"title": "Headers forwarded to the client on the streaming SSE path",
"description": "streaming.py forwards a header iff `\"ratelimit\" in name.lower()` OR `name.lower().startswith(\"x-codex\")`. This is a SUPERSET of the WS allow-list: it additionally passes generic *ratelimit* headers (e.g. the Anthropic streaming path) which do not contain the x-codex prefix.",
"type": "object",
"propertyNames": {
"pattern": "(?:[Rr][Aa][Tt][Ee][Ll][Ii][Mm][Ii][Tt])|^[Xx]-[Cc][Oo][Dd][Ee][Xx]"
},
"additionalProperties": { "type": "string" }
},
"WSClientRequestFrame": {
"title": "Client -> proxy WS data frame (Responses API over WS)",
"description": "Codex sends the request as a response.create envelope. The HTTP fallback unwraps `.response` for the POST body, forces stream=true, and strips any top-level `type`. A flattened variant (no envelope, fields at top level) is also tolerated by the fallback.",
"type": "object",
"properties": {
"type": { "const": "response.create" },
"response": {
"type": "object",
"properties": {
"model": { "type": "string", "description": "e.g. gpt-5.4" },
"input": {
"description": "String prompt or Responses-API structured input array.",
"type": ["string", "array"]
},
"stream": { "type": "boolean" }
},
"required": ["model"],
"additionalProperties": true
}
},
"required": ["type", "response"],
"additionalProperties": true
},
"WSRelayEvent": {
"title": "proxy -> client WS data frame (relayed Responses API event)",
"description": "SSE `data:` payloads relayed verbatim as WS text frames. `[DONE]` sentinels are dropped (not relayed). Every relayed event is a JSON object carrying a `type`. response.completed additionally carries usage under `response.usage`. anyOf (not oneOf): an error event also satisfies the looser lifecycle shape, which is fine.",
"anyOf": [
{
"title": "lifecycle event",
"type": "object",
"properties": {
"type": {
"type": "string",
"examples": [
"response.created",
"response.output_item.added",
"response.completed"
]
},
"response": { "type": "object", "additionalProperties": true }
},
"required": ["type"],
"additionalProperties": true
},
{
"title": "error event",
"type": "object",
"properties": {
"type": { "const": "error" },
"error": {
"type": "object",
"properties": { "message": { "type": "string" } },
"required": ["message"],
"additionalProperties": true
}
},
"required": ["type", "error"],
"additionalProperties": true
}
]
},
"HTTPFallbackRequestBody": {
"title": "proxy -> OpenAI HTTP POST body on WS->HTTP fallback",
"description": "Derived from WSClientRequestFrame: the inner `.response` object, with `stream` forced to true and any top-level `type` removed.",
"type": "object",
"properties": {
"model": { "type": "string" },
"stream": { "const": true },
"input": { "type": ["string", "array"] }
},
"required": ["model", "stream"],
"not": { "required": ["type"] },
"additionalProperties": true
},
"CodexRateLimitStatsOutput": {
"title": "headroom /stats output for the codex tracker (CodexRateLimitSnapshot.to_dict)",
"description": "Internal (headroom-emitted) shape produced from the headers above; the WS and SSE update_from_headers parity tests assert this is refreshed. Included so drift in our own surface is also caught.",
"type": "object",
"properties": {
"limit_id": { "const": "codex" },
"limit_name": { "type": ["string", "null"] },
"primary": { "$ref": "#/$defs/CodexWindowDict" },
"secondary": { "$ref": "#/$defs/CodexWindowDict" },
"credits": {
"oneOf": [
{ "type": "null" },
{
"type": "object",
"properties": {
"has_credits": { "type": "boolean" },
"unlimited": { "type": "boolean" },
"balance": { "type": ["string", "null"] }
},
"required": ["has_credits", "unlimited", "balance"],
"additionalProperties": false
}
]
},
"promo_message": { "type": ["string", "null"] },
"captured_at": { "type": "number", "description": "Unix epoch seconds (float)." }
},
"required": ["limit_id", "limit_name", "primary", "secondary", "credits", "promo_message", "captured_at"],
"additionalProperties": false
},
"CodexWindowDict": {
"oneOf": [
{ "type": "null" },
{
"type": "object",
"properties": {
"used_percent": { "type": "number" },
"window_minutes": { "type": ["integer", "null"] },
"window_label": { "type": "string", "description": "e.g. \"5h\", \"7d\"-style label; \"unknown\" when window_minutes is null." },
"resets_at": { "type": ["integer", "null"], "description": "Unix epoch seconds." },
"seconds_until_reset": { "type": ["integer", "null"] }
},
"required": ["used_percent", "window_minutes", "window_label", "resets_at", "seconds_until_reset"],
"additionalProperties": false
}
]
}
}
}
```
</details>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: m16khb <m16khb@gmail.com>
2026-06-09 22:55:53 +02:00
|
|
|
|
fix(proxy/openai): propagate provider usage on the Responses WS->HTTP fallback (#2988)
## Description
When Codex uses the OpenAI Responses WebSocket endpoint through Headroom
and the upstream WebSocket is rejected, Headroom falls back to HTTPS
POST/SSE. On that fallback the dashboard reported zero or tiny input
tokens for a large request, and invalid savings:
```json
{ "input_tokens_original": 3, "input_tokens_optimized": 0,
"output_tokens": 246, "tokens_saved": 31052, "savings_percent": 33233.33 }
```
## Root cause
`_ws_http_fallback` (openai.py) relays the SSE `data:` events to the
client but never parses the terminal `response.completed` event for
usage. The non-fallback WS path accumulates
`_extract_responses_usage(event)` into the session totals on every
`response.completed` frame (openai.py ~8182); the fallback path did not.
So `ws_input_tokens_total` stayed at the small local count, and the
session-end RequestLog computed `optimized_tokens =
residual_input_tokens = 0`, leaving `tokens_saved >
input_tokens_original` and `savings_percent` far above 100%.
## Fix
`_ws_http_fallback` now parses each relayed `response.completed` line
with the existing `_extract_responses_usage` and returns the accumulated
`(input, output, cache_read, cache_write, uncached)` provider usage. The
caller folds it into the WS session totals, so the session-end outcome
uses the authoritative provider wire-token count -- bringing the
fallback to parity with the non-fallback WS path. SSE relay behaviour is
otherwise unchanged.
Fixes #2957
## Type of Change
- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)
## Changes Made
- `headroom/proxy/handlers/openai.py` (`_ws_http_fallback`): accumulate
usage from `response.completed` SSE lines (both the main relay loop and
the buffer flush) and return the `(input, output, cache_read,
cache_write, uncached)` tuple from every exit path; the WS handler
caller adds it to `ws_input_tokens_total` / `ws_output_tokens_total` /
cache / uncached totals before the session-end RequestLog.
- `tests/test_ws_http_fallback.py`: the fallback returns the provider
usage from a `response.completed` event
(input/output/cache_read/uncached), and returns all-zeros when no
completed event arrives.
## Testing
- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check`)
- [x] Type checking passes (`mypy`)
- [x] New tests added
### Test Output
```text
tests/test_ws_http_fallback.py 13 passed (11 existing + 2 new)
# uvx ruff@0.15.22 check -> All checks passed!
# uvx mypy@1.20.2 headroom/proxy/handlers/openai.py -> Success: no issues found in 1 source file
```
## Real Behavior Proof
- Environment: Windows 11, Python 3.12.11, project venv, pytest 9.1.1,
ruff 0.15.22 and mypy 1.20.2 via uvx.
- Exact command / steps: drove `_ws_http_fallback` with the existing
WS/stream mocks, feeding an SSE `response.completed` carrying
`usage.input_tokens=31055`, `output_tokens=246`,
`input_tokens_details.cached_tokens=20000`. The method now returns
`(31055, 246, 20000, ..., 11055)`; a stream with no completed event
returns all zeros. The existing 11 relay/routing/retry tests are
unchanged (they ignore the new return value).
- Observed result: the fallback surfaces the provider's real input
usage, so the WS session-end outcome records the actual input tokens
instead of 0, and savings percentages stay within a meaningful range.
- Not tested: a live Codex WS session that triggers the upstream-WS
rejection and HTTP fallback end to end (needs a real upstream refusing
the WS). The usage-propagation contract is verified at the fallback
boundary with the same mocks the existing fallback tests use.
## Runtime Rollout Safety
- Rollout-managed feature(s): none. The OpenAI Responses WS-to-HTTP
fallback is always-on transport behavior, not rollout-channel-gated.
- Minimum rollout channel: N/A (no rollout-managed behavior).
- Stable/default behavior changed: yes, as a bug fix. On the WS-to-HTTP
fallback the session-end outcome now records the provider's real
input/output/cache usage from `response.completed` instead of leaving
`ws_input_tokens_total` at 0 (which produced >100% savings). SSE relay
to the client is unchanged.
- Kill switch / disable path: N/A. This corrects accounting only; there
is no behavioral toggle and no user-facing surface beyond the recorded
outcome numbers.
- Unsafe override required: no.
- Qualification impact: fallback-path token accounting now matches the
non-fallback WS path and the HTTP Responses path (all three use
`_extract_responses_usage`); savings percentages return to a valid
range.
- Rollback path: revert this PR; the fallback returns to reporting zero
input usage on this path.
## 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
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective
- [x] New and existing unit tests pass locally with my changes
- [x] I did **not** edit `CHANGELOG.md`: it is generated by
release-please from my Conventional Commit PR title
## Additional Notes
The fix reuses the already-present `_extract_responses_usage` (same
parser the non-fallback WS path and HTTP Responses path use), so
cache-read/write and uncached accounting stay consistent across all
three transports.
Co-authored-by: JD Davis <mxjerrett@gmail.com>
2026-08-17 03:34:39 +05:30
|
|
|
def test_fallback_returns_provider_usage_from_completed_event(self):
|
|
|
|
|
"""The fallback must surface the provider's input usage (#2957).
|
|
|
|
|
|
|
|
|
|
Otherwise the WS session-end outcome records input_tokens=0 for a large
|
|
|
|
|
request and savings percentages blow past 100.
|
|
|
|
|
"""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
completed = {
|
|
|
|
|
"type": "response.completed",
|
|
|
|
|
"response": {
|
|
|
|
|
"usage": {
|
|
|
|
|
"input_tokens": 31055,
|
|
|
|
|
"output_tokens": 246,
|
|
|
|
|
"input_tokens_details": {"cached_tokens": 20000},
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
sse_lines = [
|
|
|
|
|
'data: {"type":"response.created","response":{"id":"r1"}}\n\n',
|
|
|
|
|
f"data: {json.dumps(completed)}\n\n",
|
|
|
|
|
"data: [DONE]\n\n",
|
|
|
|
|
]
|
|
|
|
|
handler.http_client = FakeHttpClient(FakeStreamResponse(200, sse_lines))
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "big context"}
|
|
|
|
|
usage = asyncio.run(handler._ws_http_fallback(ws, body, json.dumps(body), {}, "req_usage"))
|
|
|
|
|
|
|
|
|
|
input_tokens, output_tokens, cache_read, _cache_write, uncached = usage
|
|
|
|
|
assert input_tokens == 31055
|
|
|
|
|
assert output_tokens == 246
|
|
|
|
|
assert cache_read == 20000
|
|
|
|
|
assert uncached == 31055 - 20000
|
|
|
|
|
|
|
|
|
|
def test_fallback_returns_zero_usage_without_completed_event(self):
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
handler.http_client = FakeHttpClient(
|
|
|
|
|
FakeStreamResponse(200, ['data: {"type":"response.created"}\n\n', "data: [DONE]\n\n"])
|
|
|
|
|
)
|
|
|
|
|
usage = asyncio.run(
|
|
|
|
|
handler._ws_http_fallback(
|
|
|
|
|
ws, {"model": "gpt-5.4", "input": "hi"}, json.dumps({"input": "hi"}), {}, "req_none"
|
|
|
|
|
)
|
|
|
|
|
)
|
|
|
|
|
assert usage == (0, 0, 0, 0, 0)
|
|
|
|
|
|
fix(proxy): restore Codex usage headers on WS and streaming SSE transports (#577) (#794)
## Description
Codex's subscription/rate-limit window (the `x-codex-*` headers) was
being
**stripped on every transport Codex actually uses**, so session/weekly
usage
never reached the Codex CLI's own `/status` display, Headroom
`/stats`/dashboard,
or any consumer that sniffs the client-facing handshake. This PR
restores it on
**both** the WebSocket and streaming-SSE paths — the two halves of #577
— in one
place.
Fixes #577
**Supersedes #582 and #590.** This PR incorporates #582's SSE fix
(carried verbatim
with a `Co-authored-by` trailer) and additionally forwards the window
onto the client
`101` on the WS path, which #582/#590's capture-only WS code cannot do.
Both can be
closed as superseded once this merges — GitHub closing keywords only
auto-close
issues (hence `Fixes #577` above), not PRs, so #582/#590 need a manual
close.
### WebSocket (`gpt-5.4+`)
OpenAI delivers `x-codex-*` **only** on the upstream WS handshake
response, never
in data frames. `handle_openai_responses_ws` accepted the client WS
*before* it
connected upstream and never read `upstream.response.headers`, so the
window was
dropped. This reorders the handler to **connect upstream first**,
extract the
`x-codex-*` subset, then **accept the client WS with those headers
attached** to
the `101`, and refresh the Python state for `/stats` parity.
### Streaming SSE (incorporated from #582, @m16khb)
Codex CLI almost always streams. `streaming.py` neither captured
`x-codex-*` into
`CodexRateLimitState` nor forwarded it — the forwarded-header filter
matched only
the substring `"ratelimit"`, which `x-codex-*` does not contain. This
calls
`update_from_headers()` **before** the `>=400` early-return (so a
streaming 429/5xx
still refreshes the window, matching the non-streaming handlers) and
widens the
forward filter to pass `x-codex-*`.
> Credit: the SSE fix is @m16khb's work from #582, carried here verbatim
with a
> `Co-authored-by` trailer so the maintainer gets a single PR covering
both
> transports. This supersedes #582/#590's **WS** capture (which only
writes
> `/stats`); the connect-before-accept reorder additionally forwards the
window to
> the client `101`, which capture-only cannot do. #590's optional
snapshot
> persistence is intentionally left out (separable; hot-path sync write;
doesn't
> help the `101`-sniff consumers).
## 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
- `openai.py`: add `_extract_codex_handshake_headers()` (strictly
`x-codex-*`, via
`raw_items()` to avoid `MultipleValuesError`; never
`set-cookie`/`authorization`).
- `openai.py`: reorder `handle_openai_responses_ws` — connect-only retry
loop runs
before `accept()`; `accept(headers=...)` carries the forwarded window;
first
client frame read afterward. HTTP fallback preserved; it now also
refreshes
`/stats` from the HTTP response headers.
- `streaming.py`: capture `x-codex-*` on all statuses + widen the
forwarded-header
filter (from #582).
### Diff-size note
The bulk of the `openai.py` line count is **whitespace-only
relocation**: the relay
block dedents one level out of the old per-attempt `async with`. Logical
change is
~290 lines. **Review with `?w=1`.** In API-key mode the handshake
carries no
`x-codex-*`, so the accept-header list is empty and the path behaves
exactly as
before — the fix only activates for ChatGPT-subscription auth.
## Testing
- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`)
- [x] New tests added for new functionality
- [x] Manual testing performed
- WS: `test_ws_connect_happens_before_accept`,
`test_ws_forwards_codex_headers_to_client_accept`
(only `x-codex-*` forwarded; `set-cookie`/`authorization` excluded;
`/stats` refreshed),
`test_ws_connect_failure_falls_back_to_http`,
`test_ws_first_frame_timeout_after_connect_closes_upstream`.
- Fallback: `test_fallback_refreshes_codex_rate_limit_state`.
- SSE:
`test_codex_rate_limit_headers_captured_and_forwarded_in_streaming`,
`test_codex_rate_limit_captured_on_streaming_429` (from #582).
- Wire-level e2e: `tests/e2e_ws_codex_usage_headers.py` boots the real
proxy + fake
upstream + real `websockets` client and reads the client `101` — closes
the gap
the unit tests stub (that uvicorn/starlette actually write
`accept(headers=...)`).
## Test Output
```
$ uv run pytest tests/test_proxy_streaming_ratelimit_headers.py \
tests/test_ws_http_fallback.py \
tests/test_openai_codex_ws_lifecycle.py \
tests/test_openai_codex_ws_timings.py \
tests/test_codex_rate_limits.py -q
63 passed in 0.83s
$ .venv/bin/python tests/e2e_ws_codex_usage_headers.py
[codex-hdr-e2e] client 101 headers:
x-codex-primary-used-percent: 42
x-codex-primary-window-minutes: 300
x-codex-secondary-used-percent: 7
x-codex-secondary-window-minutes: 10080
[codex-hdr-e2e] /stats reflects codex window (primary-used=42)
=== CODEX-HDR E2E ALL GREEN ===
$ uv run ruff check . && uv run ruff format --check <touched files>
All checks passed!
```
## 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
- [x] My changes generate no new warnings
- [x] 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
- [ ] I have updated the CHANGELOG.md if applicable
## Additional Notes
- **Why connect-before-accept (not capture-only).** Once `accept()`
sends the `101`,
headers can no longer be added; the `x-codex-*` window only exists after
we connect
upstream. Capturing into Python state (as #582/#590's WS code does)
fixes `/stats`
but not the Codex CLI's native display or any `101`-sniffing consumer —
those need
the headers *on the client handshake*, which requires the reorder.
- **Security.** Forwarding is filtered strictly to `x-codex-*`;
`set-cookie`,
`authorization`, and all other upstream headers are never forwarded to
the client
(asserted by both the unit test and the e2e).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
## Contract Schemas
Per maintainer request: a JSON Schema (draft 2020-12) artifact
enshrining the OpenAI
interaction expectations this changeset relies on, so drift is
detectable later.
Committed following the repo's parity convention:
- schema:
`tests/parity/fixtures/codex_openai_contracts/codex-openai-interaction.schema.json`
- test: `tests/test_codex_openai_contract_parity.py` binds the schema to
the **live code**
in both directions, so drift fails CI rather than living only in this
description -
every declared `x-codex-*` header must be consumed by
`parse_codex_rate_limits`, and
`_extract_codex_handshake_headers` must forward exactly the declared
subset and never
`set-cookie`/`authorization`. No new dependency (does not pull in
`jsonschema`).
It covers, as `$defs`:
- `WSUpstreamHandshakeResponse` / `StreamingUpstreamResponseHeaders` -
the upstream
`x-codex-*` header family (full superset, with per-header wire pattern +
the parsed
semantic type) the WS and SSE captures read. Source of truth:
`parse_codex_rate_limits`.
- `ClientForwardedHandshakeHeaders` - the WS-101 **allow/deny**
contract: only
`x-codex-*` may be forwarded; `set-cookie`/`authorization` are
explicitly forbidden
(`propertyNames` + `not`).
- `ClientForwardedStreamingHeaders` - the wider SSE forward set
(`*ratelimit*` OR `x-codex*`).
- `WSClientRequestFrame` / `WSRelayEvent` / `HTTPFallbackRequestBody` -
the WS frame
envelopes and the unwrapped HTTP-fallback POST body.
- `CodexRateLimitStatsOutput` - the headroom `/stats` shape the parity
tests assert.
Validated with `jsonschema` (Draft202012 `check_schema` passes; positive
instances from
the e2e validate; negative instances - a leaked `set-cookie`, a fallback
body still
carrying a top-level `type` - are correctly rejected).
<details>
<summary><code>codex-openai-interaction.schema.json</code> (draft
2020-12)</summary>
```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/chopratejas/headroom/contracts/codex-openai-interaction.schema.json",
"title": "Codex <-> OpenAI interaction contracts (PR #794)",
"description": "Enshrines the OpenAI interaction expectations this changeset depends on, so drift is detectable. Header values are transported as strings on the wire; the `x-headroom-parsed-type` annotation on each records the semantic type the parser (headroom/subscription/codex_rate_limits.py) coerces them to. Sources: codex_rate_limits.parse_codex_rate_limits (header family + gating), openai._extract_codex_handshake_headers (WS-101 forward filter), streaming.py (SSE forward filter).",
"$defs": {
"OpenAICodexWindowHeaders": {
"title": "x-codex-*-{primary,secondary} window headers",
"description": "A rolling rate-limit/subscription window. A window is materialized iff its `*-used-percent` header is present and numeric; `*-window-minutes` and `*-reset-at` are optional. `primary` and `secondary` are independent and either may be absent.",
"type": "object",
"properties": {
"x-codex-primary-used-percent": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$",
"x-headroom-parsed-type": "float (0-100, NaN-guarded)",
"description": "Percent of the primary window consumed. Gates creation of the primary window."
},
"x-codex-primary-window-minutes": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int",
"description": "Primary window size in minutes."
},
"x-codex-primary-reset-at": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int (Unix epoch seconds)",
"description": "Absolute reset time of the primary window."
},
"x-codex-secondary-used-percent": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$",
"x-headroom-parsed-type": "float (0-100, NaN-guarded)",
"description": "Percent of the secondary window consumed. Gates creation of the secondary window."
},
"x-codex-secondary-window-minutes": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int"
},
"x-codex-secondary-reset-at": {
"type": "string",
"pattern": "^\\d+$",
"x-headroom-parsed-type": "int (Unix epoch seconds)"
}
},
"additionalProperties": true
},
"OpenAICodexCreditsHeaders": {
"title": "x-codex-credits-* headers",
"description": "OpenAI credits balance. A credits snapshot is materialized iff `x-codex-credits-has-credits` is present; `unlimited` defaults to false; `balance` is optional.",
"type": "object",
"properties": {
"x-codex-credits-has-credits": {
"type": "string",
"pattern": "^(?:[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[01])$",
"x-headroom-parsed-type": "bool (true|false|1|0, case-insensitive)",
"description": "Gates creation of the credits snapshot."
},
"x-codex-credits-unlimited": {
"type": "string",
"pattern": "^(?:[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[01])$",
"x-headroom-parsed-type": "bool (defaults false when absent/unparseable)"
},
"x-codex-credits-balance": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Free-form server string, e.g. \"$5.00\"."
}
},
"additionalProperties": true
},
"OpenAICodexMetaHeaders": {
"title": "x-codex meta headers",
"type": "object",
"properties": {
"x-codex-limit-name": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Active limit/model label, e.g. \"gpt-5.2-codex-sonic\"."
},
"x-codex-promo-message": {
"type": "string",
"x-headroom-parsed-type": "str (empty -> null)",
"description": "Server announcement. Also gates snapshot creation when present."
}
},
"additionalProperties": true
},
"OpenAICodexRateLimitHeaders": {
"title": "Full x-codex-* header family OpenAI may emit",
"description": "Superset of every x-codex-* header headroom reads. parse_codex_rate_limits returns a snapshot iff at least one of: a primary window, a secondary window, a credits snapshot, or a non-empty promo message is present; otherwise null (treated as a non-Codex response). All members are individually optional.",
"type": "object",
"allOf": [
{ "$ref": "#/$defs/OpenAICodexWindowHeaders" },
{ "$ref": "#/$defs/OpenAICodexCreditsHeaders" },
{ "$ref": "#/$defs/OpenAICodexMetaHeaders" }
],
"additionalProperties": true
},
"WSUpstreamHandshakeResponse": {
"title": "OpenAI WS handshake (101) response headers consumed by the WS fix",
"description": "On the Codex WebSocket transport the x-codex-* window is delivered ONLY on the upstream handshake response (never in data frames). handle_openai_responses_ws reads upstream.response.headers here. This is the contract the connect-before-accept reorder depends on: if OpenAI ever moves these headers off the handshake (e.g. into a frame), the WS half of the fix goes stale.",
"$ref": "#/$defs/OpenAICodexRateLimitHeaders"
},
"StreamingUpstreamResponseHeaders": {
"title": "OpenAI streaming/HTTP response headers consumed by the SSE fix",
"description": "On the streaming SSE/HTTP transport the same x-codex-* headers ride the HTTP response. streaming.py captures them on ALL statuses (including >=400) via update_from_headers, and forwards a wider set to the client (see ClientForwardedStreamingHeaders).",
"$ref": "#/$defs/OpenAICodexRateLimitHeaders"
},
"ClientForwardedHandshakeHeaders": {
"title": "Headers forwarded onto the CLIENT-facing WS 101 (allow/deny contract)",
"description": "_extract_codex_handshake_headers forwards ONLY headers whose (lowercased) name starts with `x-codex-`. Every other upstream handshake header - notably set-cookie and authorization - MUST NOT appear on the client 101. Enforced by propertyNames below and asserted by the unit tests + tests/e2e_ws_codex_usage_headers.py.",
"type": "object",
"propertyNames": {
"pattern": "^[Xx]-[Cc][Oo][Dd][Ee][Xx]-"
},
"not": {
"anyOf": [
{ "required": ["set-cookie"] },
{ "required": ["Set-Cookie"] },
{ "required": ["authorization"] },
{ "required": ["Authorization"] }
]
},
"additionalProperties": { "type": "string" }
},
"ClientForwardedStreamingHeaders": {
"title": "Headers forwarded to the client on the streaming SSE path",
"description": "streaming.py forwards a header iff `\"ratelimit\" in name.lower()` OR `name.lower().startswith(\"x-codex\")`. This is a SUPERSET of the WS allow-list: it additionally passes generic *ratelimit* headers (e.g. the Anthropic streaming path) which do not contain the x-codex prefix.",
"type": "object",
"propertyNames": {
"pattern": "(?:[Rr][Aa][Tt][Ee][Ll][Ii][Mm][Ii][Tt])|^[Xx]-[Cc][Oo][Dd][Ee][Xx]"
},
"additionalProperties": { "type": "string" }
},
"WSClientRequestFrame": {
"title": "Client -> proxy WS data frame (Responses API over WS)",
"description": "Codex sends the request as a response.create envelope. The HTTP fallback unwraps `.response` for the POST body, forces stream=true, and strips any top-level `type`. A flattened variant (no envelope, fields at top level) is also tolerated by the fallback.",
"type": "object",
"properties": {
"type": { "const": "response.create" },
"response": {
"type": "object",
"properties": {
"model": { "type": "string", "description": "e.g. gpt-5.4" },
"input": {
"description": "String prompt or Responses-API structured input array.",
"type": ["string", "array"]
},
"stream": { "type": "boolean" }
},
"required": ["model"],
"additionalProperties": true
}
},
"required": ["type", "response"],
"additionalProperties": true
},
"WSRelayEvent": {
"title": "proxy -> client WS data frame (relayed Responses API event)",
"description": "SSE `data:` payloads relayed verbatim as WS text frames. `[DONE]` sentinels are dropped (not relayed). Every relayed event is a JSON object carrying a `type`. response.completed additionally carries usage under `response.usage`. anyOf (not oneOf): an error event also satisfies the looser lifecycle shape, which is fine.",
"anyOf": [
{
"title": "lifecycle event",
"type": "object",
"properties": {
"type": {
"type": "string",
"examples": [
"response.created",
"response.output_item.added",
"response.completed"
]
},
"response": { "type": "object", "additionalProperties": true }
},
"required": ["type"],
"additionalProperties": true
},
{
"title": "error event",
"type": "object",
"properties": {
"type": { "const": "error" },
"error": {
"type": "object",
"properties": { "message": { "type": "string" } },
"required": ["message"],
"additionalProperties": true
}
},
"required": ["type", "error"],
"additionalProperties": true
}
]
},
"HTTPFallbackRequestBody": {
"title": "proxy -> OpenAI HTTP POST body on WS->HTTP fallback",
"description": "Derived from WSClientRequestFrame: the inner `.response` object, with `stream` forced to true and any top-level `type` removed.",
"type": "object",
"properties": {
"model": { "type": "string" },
"stream": { "const": true },
"input": { "type": ["string", "array"] }
},
"required": ["model", "stream"],
"not": { "required": ["type"] },
"additionalProperties": true
},
"CodexRateLimitStatsOutput": {
"title": "headroom /stats output for the codex tracker (CodexRateLimitSnapshot.to_dict)",
"description": "Internal (headroom-emitted) shape produced from the headers above; the WS and SSE update_from_headers parity tests assert this is refreshed. Included so drift in our own surface is also caught.",
"type": "object",
"properties": {
"limit_id": { "const": "codex" },
"limit_name": { "type": ["string", "null"] },
"primary": { "$ref": "#/$defs/CodexWindowDict" },
"secondary": { "$ref": "#/$defs/CodexWindowDict" },
"credits": {
"oneOf": [
{ "type": "null" },
{
"type": "object",
"properties": {
"has_credits": { "type": "boolean" },
"unlimited": { "type": "boolean" },
"balance": { "type": ["string", "null"] }
},
"required": ["has_credits", "unlimited", "balance"],
"additionalProperties": false
}
]
},
"promo_message": { "type": ["string", "null"] },
"captured_at": { "type": "number", "description": "Unix epoch seconds (float)." }
},
"required": ["limit_id", "limit_name", "primary", "secondary", "credits", "promo_message", "captured_at"],
"additionalProperties": false
},
"CodexWindowDict": {
"oneOf": [
{ "type": "null" },
{
"type": "object",
"properties": {
"used_percent": { "type": "number" },
"window_minutes": { "type": ["integer", "null"] },
"window_label": { "type": "string", "description": "e.g. \"5h\", \"7d\"-style label; \"unknown\" when window_minutes is null." },
"resets_at": { "type": ["integer", "null"], "description": "Unix epoch seconds." },
"seconds_until_reset": { "type": ["integer", "null"] }
},
"required": ["used_percent", "window_minutes", "window_label", "resets_at", "seconds_until_reset"],
"additionalProperties": false
}
]
}
}
}
```
</details>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: m16khb <m16khb@gmail.com>
2026-06-09 22:55:53 +02:00
|
|
|
def test_fallback_refreshes_codex_rate_limit_state(self, monkeypatch):
|
|
|
|
|
"""A successful fallback refreshes Codex /stats from response headers.
|
|
|
|
|
|
|
|
|
|
The fallback can't forward headers onto the (already-accepted) client
|
|
|
|
|
101, but it should still keep Python /stats in sync so the gauge does
|
|
|
|
|
not go stale when the WS upgrade fails and we drop to HTTP.
|
|
|
|
|
"""
|
|
|
|
|
handler = _make_handler()
|
|
|
|
|
ws = FakeWebSocket()
|
|
|
|
|
captured: dict[str, dict[str, str]] = {}
|
|
|
|
|
|
|
|
|
|
class _FakeState:
|
|
|
|
|
def update_from_headers(self, hdrs):
|
|
|
|
|
captured["headers"] = dict(hdrs)
|
|
|
|
|
|
|
|
|
|
import headroom.subscription.codex_rate_limits as crl
|
|
|
|
|
|
|
|
|
|
monkeypatch.setattr(crl, "get_codex_rate_limit_state", lambda: _FakeState())
|
|
|
|
|
|
|
|
|
|
response = FakeStreamResponse(
|
|
|
|
|
200,
|
|
|
|
|
['data: {"type":"response.completed"}\n\n', "data: [DONE]\n\n"],
|
|
|
|
|
headers={
|
|
|
|
|
"x-codex-primary-used-percent": "42",
|
|
|
|
|
"content-type": "text/event-stream",
|
|
|
|
|
},
|
|
|
|
|
)
|
|
|
|
|
handler.http_client = FakeHttpClient(response)
|
|
|
|
|
|
|
|
|
|
body = {"model": "gpt-5.4", "input": "hi"}
|
|
|
|
|
asyncio.run(handler._ws_http_fallback(ws, body, json.dumps(body), {}, "req_capture"))
|
|
|
|
|
|
|
|
|
|
assert captured["headers"]["x-codex-primary-used-percent"] == "42"
|