File size: 7,860 Bytes
ea39c0e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | //! Only confirmed conflicts permit replay; ambiguous registration results remain terminal.
use std::sync::Arc;
use std::sync::atomic::AtomicUsize;
use std::sync::atomic::Ordering;
use std::time::Duration;
use codex_api::AuthProvider;
use codex_http_client::RouteAwareRequestError;
use http::HeaderMap;
use pretty_assertions::assert_eq;
use tokio::io::AsyncBufReadExt;
use tokio::io::AsyncReadExt;
use tokio::io::AsyncWriteExt;
use tokio::io::BufReader;
use tokio::net::TcpListener;
use tokio::sync::Notify;
use tokio::time::advance;
use tokio::time::sleep;
use tokio::time::timeout;
use tokio_util::task::AbortOnDropHandle;
use tracing::instrument::WithSubscriber;
use tracing_subscriber::prelude::*;
use super::EnvironmentRegistryClient;
use super::ExecServerError;
use crate::NoiseChannelIdentity;
const ENVIRONMENT_ID: &str = "registration-retry-test";
const CONFLICT_BODY: &str =
r#"{"error":{"code":"registration_conflict","message":"registration unavailable"}}"#;
const ERROR_BODY: &str =
r#"{"error":{"code":"registration_denied","message":"registration unavailable"}}"#;
const SUCCESS_BODY: &str = r#"{"environment_id":"registration-retry-test","url":"ws://localhost/relay","security_profile":"noise_hybrid_ik_v1","executor_registration_id":"committed-registration"}"#;
#[derive(Debug, Default)]
struct RegistrationAuthProvider {
calls: AtomicUsize,
}
impl AuthProvider for RegistrationAuthProvider {
fn add_auth_headers(&self, _headers: &mut HeaderMap) {}
fn resolve_auth_headers(&self) -> codex_api::AuthHeadersFuture<'_> {
self.calls.fetch_add(1, Ordering::Relaxed);
Box::pin(async { Ok(HeaderMap::new()) })
}
}
struct RetryObserved(Arc<Notify>);
impl<S: tracing::Subscriber> tracing_subscriber::Layer<S> for RetryObserved {
fn on_event(&self, event: &tracing::Event<'_>, _: tracing_subscriber::layer::Context<'_, S>) {
if event.metadata().target() == "codex_exec_server::remote::registration_retry"
&& event.metadata().fields().field("retry_attempt").is_some()
{
self.0.notify_one();
}
}
}
#[test_case::test_case(200, "not JSON", Duration::ZERO; "malformed_success")]
#[test_case::test_case(200, SUCCESS_BODY, Duration::from_secs(60); "committed_success_body_timeout")]
#[test_case::test_case(503, CONFLICT_BODY, Duration::ZERO; "confirmed_conflict_backoff_is_cancellable")]
#[test_case::test_case(503, CONFLICT_BODY, Duration::from_secs(60); "conflict_code_not_received")]
#[test_case::test_case(503, "not JSON", Duration::ZERO; "malformed_unavailable")]
#[test_case::test_case(503, "{}", Duration::ZERO; "missing_conflict_code")]
#[test_case::test_case(503, ERROR_BODY, Duration::ZERO; "different_error_code")]
#[test_case::test_case(502, CONFLICT_BODY, Duration::ZERO; "gateway_error")]
#[test_case::test_case(408, CONFLICT_BODY, Duration::ZERO; "request_timeout")]
#[test_case::test_case(429, CONFLICT_BODY, Duration::ZERO; "too_many_requests")]
#[test_case::test_case(401, ERROR_BODY, Duration::from_secs(60); "unauthorized_stalled_body")]
#[test_case::test_case(403, ERROR_BODY, Duration::from_secs(60); "forbidden_stalled_body")]
#[test_case::test_case(404, ERROR_BODY, Duration::from_secs(60); "environment_deleted_stalled_body")]
#[test_case::test_case(401, ERROR_BODY, Duration::from_millis(50); "delayed_unauthorized_details")]
#[test_case::test_case(403, ERROR_BODY, Duration::from_millis(50); "delayed_forbidden_details")]
#[test_case::test_case(404, ERROR_BODY, Duration::from_millis(50); "delayed_error_details")]
#[tokio::test]
async fn registration_requires_a_confirmed_conflict_before_replay(
status: u16,
body: &'static str,
body_delay: Duration,
) -> anyhow::Result<()> {
let listener = TcpListener::bind("127.0.0.1:0").await?;
let registry_url = format!("http://{}", listener.local_addr()?);
let _server = AbortOnDropHandle::new(tokio::spawn(async move {
let (mut stream, _) = listener.accept().await?;
// Drain the complete request before responding so unread bytes cannot cause a reset.
let mut reader = BufReader::new(&mut stream);
let mut content_length = 0;
loop {
let mut line = String::new();
anyhow::ensure!(reader.read_line(&mut line).await? > 0, "missing headers");
if line == "\r\n" {
break;
}
if let Some((name, value)) = line.split_once(':')
&& name.eq_ignore_ascii_case("content-length")
{
content_length = value.trim().parse::<usize>()?;
}
}
anyhow::ensure!(content_length <= 16_384, "registration request too large");
reader.read_exact(&mut vec![0; content_length]).await?;
drop(reader);
let headers = format!(
"HTTP/1.1 {status} Registration Result\r\nContent-Type: application/json\r\nContent-Length: {}\r\n\r\n",
body.len()
);
stream.write_all(headers.as_bytes()).await?;
sleep(body_delay).await;
stream.write_all(body.as_bytes()).await?;
std::future::pending::<()>().await;
anyhow::Ok(())
}));
let auth = Arc::new(RegistrationAuthProvider::default());
let mut client = EnvironmentRegistryClient::new(registry_url, auth.clone())?;
client.connect_timeout = Duration::from_millis(500);
let key = NoiseChannelIdentity::generate()?.public_key();
let retry = Arc::new(Notify::new());
let subscriber = tracing_subscriber::registry().with(RetryObserved(retry.clone()));
let mut registration = Box::pin(
client
.register_environment_with_retry(ENVIRONMENT_ID, &key)
.with_subscriber(subscriber),
);
if status == 503 && body == CONFLICT_BODY && body_delay.is_zero() {
timeout(Duration::from_secs(1), async {
tokio::select! {
_ = retry.notified() => anyhow::Ok(()),
_ = &mut registration => anyhow::bail!("a confirmed conflict must enter backoff"),
}
})
.await??;
// The retry event fires in the same poll that enters backoff, without a timing guess.
drop(registration);
tokio::time::pause();
advance(Duration::from_secs(60)).await;
tokio::task::yield_now().await;
assert_eq!(auth.calls.load(Ordering::Relaxed), 1);
return Ok(());
}
let error = timeout(Duration::from_secs(1), registration)
.await?
.expect_err("an unconfirmed registration outcome must not be replayed");
assert_eq!(auth.calls.load(Ordering::Relaxed), 1);
match error {
ExecServerError::Json(_) if status == 200 && body_delay.is_zero() => {}
ExecServerError::EnvironmentRegistryRequest(RouteAwareRequestError::Timeout)
if status == 200 && body_delay > client.connect_timeout => {}
ExecServerError::EnvironmentRegistryAuth(message) if matches!(status, 401 | 403) => {
if body_delay < client.connect_timeout {
assert!(message.ends_with(": registration unavailable"));
}
}
ExecServerError::EnvironmentRegistryHttp {
status: actual,
code,
message,
} if !matches!(status, 200 | 401 | 403) => {
let expected_code = match (body_delay < client.connect_timeout, body) {
(true, ERROR_BODY) => Some("registration_denied"),
(true, CONFLICT_BODY) => Some("registration_conflict"),
_ => None,
};
assert_eq!((actual.as_u16(), code.as_deref()), (status, expected_code));
if expected_code.is_some() {
assert_eq!(message, "registration unavailable");
}
}
_ => anyhow::bail!("unexpected registration failure kind"),
}
Ok(())
}
|