Files
Aether/apps/aether-gateway/src/execution_runtime/response_header_rules.rs
T

211 lines
7.3 KiB
Rust
Raw Normal View History

2026-05-06 01:29:42 +08:00
use std::collections::BTreeMap;
use std::time::Duration;
2026-05-06 01:29:42 +08:00
use aether_contracts::ExecutionPlan;
use serde_json::{Map, Value};
use tracing::warn;
use crate::{AppState, GatewayError};
const RESPONSE_HEADER_RULES_KEY: &str = "response_header_rules";
const RESPONSE_HEADER_RULES_CAMEL_KEY: &str = "responseHeaderRules";
const PROVIDER_RESPONSE_HEADERS_CONTEXT_KEY: &str = "provider_response_headers";
2026-08-14 09:28:07 +08:00
const PROVIDER_REQUEST_STARTED_AT_UNIX_MS_CONTEXT_KEY: &str = "provider_request_started_at_unix_ms";
const PROVIDER_REQUEST_ORDER_ID_CONTEXT_KEY: &str = "provider_request_order_id";
const PROVIDER_RESPONSE_HEADERS_OBSERVED_AT_UNIX_MS_CONTEXT_KEY: &str =
"provider_response_headers_observed_at_unix_ms";
2026-05-06 01:29:42 +08:00
const RESPONSE_HEADER_RULE_PROTECTED_KEYS: &[&str] = &["content-length"];
const RESPONSE_HEADER_RULES_CACHE_TTL: Duration = Duration::from_secs(5);
2026-05-06 01:29:42 +08:00
fn endpoint_response_header_rules_from_config(config: Option<&Value>) -> Option<&Value> {
let config = config?.as_object()?;
config
.get(RESPONSE_HEADER_RULES_KEY)
.or_else(|| config.get(RESPONSE_HEADER_RULES_CAMEL_KEY))
.filter(|value| !value.is_null())
}
async fn read_endpoint_response_header_rules(state: &AppState, endpoint_id: &str) -> Option<Value> {
let endpoint_id = endpoint_id.trim();
if endpoint_id.is_empty() {
return None;
}
let endpoint_id = endpoint_id.to_string();
let endpoint_id_for_load = endpoint_id.clone();
2026-05-06 01:29:42 +08:00
match state
.endpoint_response_header_rules_cache
.get_or_load(endpoint_id, RESPONSE_HEADER_RULES_CACHE_TTL, || async {
state
.read_provider_catalog_endpoints_by_ids(std::slice::from_ref(&endpoint_id_for_load))
.await
.map(|endpoints| {
endpoints.into_iter().next().and_then(|endpoint| {
endpoint_response_header_rules_from_config(endpoint.config.as_ref())
.cloned()
})
})
})
2026-05-06 01:29:42 +08:00
.await
{
Ok(rules) => rules,
2026-05-06 01:29:42 +08:00
Err(err) => {
warn!(
event_name = "response_header_rules_endpoint_read_failed",
log_type = "ops",
endpoint_id = %endpoint_id_for_load,
2026-05-06 01:29:42 +08:00
error = ?err,
"gateway failed to read endpoint response header rules; skipping response header edits"
);
None
}
}
}
pub(crate) async fn apply_endpoint_response_header_rules(
state: &AppState,
plan: &ExecutionPlan,
headers: &mut BTreeMap<String, String>,
response_body: Option<&Value>,
) -> Result<(), GatewayError> {
let Some(rules) = read_endpoint_response_header_rules(state, plan.endpoint_id.as_str()).await
else {
return Ok(());
};
if !rules.is_array() {
warn!(
event_name = "response_header_rules_invalid_shape",
log_type = "ops",
endpoint_id = %plan.endpoint_id,
"gateway skipped endpoint response header rules because response_header_rules is not an array"
);
return Ok(());
}
let empty_body = Value::Null;
let body = response_body.unwrap_or(&empty_body);
if !crate::provider_transport::apply_local_header_rules(
headers,
Some(&rules),
RESPONSE_HEADER_RULE_PROTECTED_KEYS,
body,
response_body,
) {
return Err(GatewayError::Internal(
"response_header_rules 应用失败".to_string(),
));
}
Ok(())
}
pub(crate) fn attach_provider_response_headers_to_report_context(
report_context: Option<Value>,
provider_headers: &BTreeMap<String, String>,
2026-08-14 09:28:07 +08:00
provider_request_started_at_unix_ms: u64,
provider_response_headers_observed_at_unix_ms: u64,
provider_request_order_id: &str,
2026-05-06 01:29:42 +08:00
) -> Option<Value> {
let provider_headers = serde_json::to_value(provider_headers).ok()?;
let mut object = match report_context {
Some(Value::Object(object)) => object,
Some(other) => Map::from_iter([("seed".to_string(), other)]),
None => Map::new(),
};
2026-08-14 09:28:07 +08:00
let observation_is_absent = !object.contains_key(PROVIDER_RESPONSE_HEADERS_CONTEXT_KEY)
&& !object.contains_key(PROVIDER_REQUEST_STARTED_AT_UNIX_MS_CONTEXT_KEY)
&& !object.contains_key(PROVIDER_RESPONSE_HEADERS_OBSERVED_AT_UNIX_MS_CONTEXT_KEY)
&& !object.contains_key(PROVIDER_REQUEST_ORDER_ID_CONTEXT_KEY);
if observation_is_absent {
object.insert(
PROVIDER_RESPONSE_HEADERS_CONTEXT_KEY.to_string(),
provider_headers,
);
object.insert(
PROVIDER_REQUEST_STARTED_AT_UNIX_MS_CONTEXT_KEY.to_string(),
Value::from(provider_request_started_at_unix_ms),
);
object.insert(
PROVIDER_RESPONSE_HEADERS_OBSERVED_AT_UNIX_MS_CONTEXT_KEY.to_string(),
Value::from(provider_response_headers_observed_at_unix_ms),
);
object.insert(
PROVIDER_REQUEST_ORDER_ID_CONTEXT_KEY.to_string(),
Value::from(provider_request_order_id),
);
}
2026-05-06 01:29:42 +08:00
Some(Value::Object(object))
}
2026-08-14 09:28:07 +08:00
#[cfg(test)]
mod tests {
use super::*;
use serde_json::json;
#[test]
fn provider_response_observation_is_first_write_wins() {
let first_headers =
BTreeMap::from([("x-codex-primary-used-percent".to_string(), "10".to_string())]);
let second_headers =
BTreeMap::from([("x-codex-primary-used-percent".to_string(), "20".to_string())]);
let report_context = attach_provider_response_headers_to_report_context(
Some(json!("seed-value")),
&first_headers,
100,
200,
"observation-1",
);
let report_context = attach_provider_response_headers_to_report_context(
report_context,
&second_headers,
300,
400,
"observation-2",
)
.expect("report context should exist");
assert_eq!(report_context["seed"], json!("seed-value"));
assert_eq!(
report_context["provider_response_headers"]["x-codex-primary-used-percent"],
json!("10")
);
assert_eq!(
report_context["provider_request_started_at_unix_ms"],
json!(100)
);
assert_eq!(
report_context["provider_response_headers_observed_at_unix_ms"],
json!(200)
);
assert_eq!(
report_context["provider_request_order_id"],
json!("observation-1")
);
}
#[test]
fn provider_response_observation_does_not_complete_a_partial_triplet() {
let report_context = attach_provider_response_headers_to_report_context(
Some(json!({"provider_response_headers": {"x-existing": "1"}})),
&BTreeMap::from([("x-new".to_string(), "2".to_string())]),
300,
400,
"observation-2",
)
.expect("report context should exist");
assert_eq!(
report_context["provider_response_headers"]["x-existing"],
json!("1")
);
assert!(report_context
.get("provider_request_started_at_unix_ms")
.is_none());
assert!(report_context
.get("provider_response_headers_observed_at_unix_ms")
.is_none());
assert!(report_context.get("provider_request_order_id").is_none());
}
}