Skip to main content

codex_helper_core/proxy/
mod.rs

1use std::collections::HashMap;
2use std::sync::{Arc, Mutex};
3use std::time::Duration;
4
5use reqwest::Client;
6use tokio::sync::watch;
7
8mod admin;
9mod api_responses;
10mod attempt_execution;
11mod attempt_failures;
12mod attempt_health;
13mod attempt_request;
14mod attempt_response;
15mod attempt_selection;
16mod attempt_target;
17mod attempt_transport;
18mod auth_resolution;
19mod classify;
20mod client_identity;
21mod codex_failure;
22mod codex_relay_capabilities;
23mod codex_relay_evidence;
24mod codex_relay_live_smoke;
25mod codex_relay_probe;
26mod codex_relay_target;
27mod concurrency_limits;
28mod control_plane;
29mod control_plane_manifest;
30mod control_plane_routes;
31mod control_plane_service;
32mod entrypoint;
33mod failure_summary;
34mod headers;
35mod healthcheck_api;
36mod http_debug;
37mod models_compat;
38mod openai_images;
39mod passive_health;
40mod persisted_registry_api;
41mod profile_defaults;
42mod provider_evidence;
43mod provider_execution;
44mod provider_orchestration;
45mod providers_api;
46mod reasoning_guard;
47mod request_body;
48mod request_context;
49mod request_continuity;
50mod request_encoding;
51mod request_failures;
52mod request_observer;
53mod request_preparation;
54mod request_routing;
55mod response_finalization;
56mod response_fixer;
57mod response_semantics;
58mod responses_websocket;
59mod retry;
60mod route_affinity;
61mod route_attempts;
62mod route_executor_runtime;
63mod route_metadata;
64mod route_provenance;
65mod route_target_selection;
66mod route_unavailability;
67mod router_setup;
68mod routing_plan;
69mod runtime_admin_api;
70mod runtime_config;
71mod selected_upstream_request;
72mod service_core;
73mod session_overrides;
74mod stations_api;
75mod stream;
76mod target_builder;
77#[cfg(test)]
78mod tests;
79
80use crate::filter::RequestFilter;
81use crate::host_local::HostLocalSessionHistoryMode;
82use crate::lb::LbState;
83use crate::state::{ProviderBalanceSnapshot, ProxyState};
84use crate::usage_providers::UsageProviderRefreshSummary;
85
86pub use self::admin::{
87    admin_base_url_from_proxy_base_url, admin_loopback_addr_for_proxy_port,
88    admin_port_for_proxy_port, local_admin_base_url_for_proxy_port, local_proxy_base_url,
89};
90pub use self::api_responses::{ProfilesResponse, ReloadResult, RuntimeStatusResponse};
91pub use self::codex_relay_capabilities::{
92    CodexRelayCapabilitiesObserved, CodexRelayCapabilitiesRequest, CodexRelayCapabilitiesResponse,
93    CodexRelayCapabilityMismatch, CodexRelayContinuityDiagnostics,
94    CodexRelayContinuityDomainSummary,
95};
96pub use self::codex_relay_evidence::{
97    CodexRelayEvidenceEntry, CodexRelayEvidenceFilters, CodexRelayEvidenceKind,
98    codex_relay_evidence_path, read_recent_codex_relay_evidence,
99};
100pub use self::codex_relay_live_smoke::{
101    CODEX_RELAY_LIVE_SMOKE_ACK, CodexRelayLiveSmokeCase, CodexRelayLiveSmokeConfidence,
102    CodexRelayLiveSmokeOutcome, CodexRelayLiveSmokeRequest, CodexRelayLiveSmokeResponse,
103    CodexRelayLiveSmokeResult, CodexRelayLiveSmokeSideEffect,
104};
105pub use self::codex_relay_probe::{
106    CodexRelayProbeClient, CodexRelayProbeConfidence, CodexRelayProbeKind, CodexRelayProbeResult,
107    CodexRelayProbeSideEffect, CodexRelayProbeSpec, CodexRelayProbeSupport,
108    classify_codex_relay_probe_response,
109};
110use self::concurrency_limits::ConcurrencyLimiter;
111pub use self::entrypoint::handle_proxy;
112pub use self::persisted_registry_api::PersistedRoutingUpsertRequest;
113pub use self::router_setup::{
114    admin_listener_router, proxy_only_router, proxy_only_router_with_admin_base_url, router,
115};
116use self::runtime_config::RuntimeConfig;
117
118pub const ADMIN_TOKEN_ENV_VAR: &str = "CODEX_HELPER_ADMIN_TOKEN";
119pub const ADMIN_TOKEN_HEADER: &str = "x-codex-helper-admin-token";
120pub const CLIENT_NAME_HEADER: &str = "x-codex-helper-client-name";
121pub const ADMIN_PORT_OFFSET: u16 = 1000;
122
123#[cfg(test)]
124const AUTH_FILE_CACHE_MIN_CHECK_INTERVAL: Duration = Duration::from_millis(20);
125#[cfg(not(test))]
126const AUTH_FILE_CACHE_MIN_CHECK_INTERVAL: Duration = Duration::from_millis(800);
127
128#[cfg(test)]
129fn codex_auth_json_value(key: &str) -> Option<String> {
130    auth_resolution::codex_auth_json_value(key)
131}
132
133#[cfg(test)]
134fn claude_settings_env_value(key: &str) -> Option<String> {
135    auth_resolution::claude_settings_env_value(key)
136}
137
138/// Generic proxy service; currently used by both Codex and Claude.
139#[derive(Clone)]
140pub struct ProxyService {
141    pub client: Client,
142    config: Arc<RuntimeConfig>,
143    pub service_name: &'static str,
144    lb_states: Arc<Mutex<HashMap<String, LbState>>>,
145    concurrency_limiter: Arc<ConcurrencyLimiter>,
146    filter: RequestFilter,
147    state: Arc<ProxyState>,
148    shutdown_tx: Option<watch::Sender<bool>>,
149    host_local_session_history_mode: HostLocalSessionHistoryMode,
150}
151
152#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
153pub struct ProviderBalanceRefreshResponse {
154    pub service_name: String,
155    pub refresh: UsageProviderRefreshSummary,
156    pub provider_balances: HashMap<String, Vec<ProviderBalanceSnapshot>>,
157}
158
159#[derive(Debug, Clone)]
160pub struct ProxyControlError {
161    status: axum::http::StatusCode,
162    message: String,
163}
164
165impl ProxyControlError {
166    pub fn new(status: axum::http::StatusCode, message: impl Into<String>) -> Self {
167        Self {
168            status,
169            message: message.into(),
170        }
171    }
172
173    pub fn status(&self) -> axum::http::StatusCode {
174        self.status
175    }
176
177    pub fn message(&self) -> &str {
178        self.message.as_str()
179    }
180
181    pub fn into_http_error(self) -> (axum::http::StatusCode, String) {
182        (self.status, self.message)
183    }
184}
185
186impl std::fmt::Display for ProxyControlError {
187    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
188        write!(f, "status={}, {}", self.status, self.message)
189    }
190}
191
192impl std::error::Error for ProxyControlError {}
193
194impl From<(axum::http::StatusCode, String)> for ProxyControlError {
195    fn from((status, message): (axum::http::StatusCode, String)) -> Self {
196        Self::new(status, message)
197    }
198}