File size: 7,725 Bytes
afa0cbf | 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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 | //! Controls RPC admission and draining for each connection.
//! Auth ownership changes reject queued work while started handlers finish cleanup.
use std::future::Future;
use codex_app_server_transport::ConnectionAuth;
use tokio::sync::Mutex;
use tokio_util::task::TaskTracker;
/// Per-connection gate for incoming messages and initialized RPC handler execution.
///
/// Closing the gate prevents queued handlers from starting while allowing
/// handlers that already acquired a token to finish.
#[derive(Debug)]
pub(crate) struct ConnectionRpcGate {
pub(crate) auth: Option<ConnectionAuth>,
accepting: Mutex<bool>,
tasks: TaskTracker,
}
impl ConnectionRpcGate {
pub(crate) fn new() -> Self {
let accepting = true;
Self {
auth: None,
accepting: Mutex::new(accepting),
tasks: TaskTracker::new(),
}
}
pub(crate) async fn run<F>(&self, future: F)
where
F: Future<Output = ()>,
{
let token = {
let accepting = self.accepting.lock().await;
if !*accepting || self.is_closed() {
return;
}
self.tasks.token()
};
future.await;
drop(token);
}
pub(crate) fn is_closed(&self) -> bool {
self.tasks.is_closed() || self.auth.as_ref().is_some_and(|auth| !auth.is_current())
}
pub(crate) async fn close(&self) {
let mut accepting = self.accepting.lock().await;
*accepting = false;
self.tasks.close();
}
pub(crate) async fn shutdown(&self) {
self.close().await;
self.tasks.wait().await;
}
#[cfg(test)]
async fn is_accepting(&self) -> bool {
*self.accepting.lock().await
}
#[cfg(test)]
fn inflight_count(&self) -> usize {
self.tasks.len()
}
}
impl Default for ConnectionRpcGate {
fn default() -> Self {
Self::new()
}
}
#[cfg(test)]
mod tests {
use super::*;
use pretty_assertions::assert_eq;
use std::sync::Arc;
use std::sync::atomic::AtomicBool;
use std::sync::atomic::Ordering;
use tokio::sync::oneshot;
use tokio::time::Duration;
use tokio::time::timeout;
#[tokio::test]
async fn run_executes_while_open() {
let gate = ConnectionRpcGate::new();
let ran = Arc::new(AtomicBool::new(/*v*/ false));
let ran_clone = Arc::clone(&ran);
gate.run(async move {
ran_clone.store(/*val*/ true, Ordering::Release);
})
.await;
assert!(ran.load(Ordering::Acquire));
}
#[tokio::test]
async fn run_drops_future_without_polling_after_close() {
let gate = ConnectionRpcGate::new();
gate.close().await;
let polled = Arc::new(AtomicBool::new(/*v*/ false));
let polled_clone = Arc::clone(&polled);
gate.run(async move {
polled_clone.store(/*val*/ true, Ordering::Release);
})
.await;
assert!(!polled.load(Ordering::Acquire));
assert!(!gate.is_accepting().await);
}
#[tokio::test]
async fn close_returns_while_started_run_remains_active() {
let gate = Arc::new(ConnectionRpcGate::new());
let (started_tx, started_rx) = oneshot::channel();
let (finish_tx, finish_rx) = oneshot::channel();
let gate_for_run = Arc::clone(&gate);
let run_task = tokio::spawn(async move {
gate_for_run
.run(async move {
started_tx.send(()).expect("receiver should be open");
let _ = finish_rx.await;
})
.await;
});
started_rx.await.expect("run should start");
gate.close().await;
assert!(!gate.is_accepting().await);
assert_eq!(gate.inflight_count(), 1);
finish_tx
.send(())
.expect("running future should be waiting");
run_task.await.expect("run task should complete");
gate.shutdown().await;
}
#[tokio::test]
async fn shutdown_waits_for_started_run_to_finish() {
let gate = Arc::new(ConnectionRpcGate::new());
let (started_tx, started_rx) = oneshot::channel();
let (finish_tx, finish_rx) = oneshot::channel();
let gate_for_run = Arc::clone(&gate);
let run_task = tokio::spawn(async move {
gate_for_run
.run(async move {
started_tx.send(()).expect("receiver should be open");
let _ = finish_rx.await;
})
.await;
});
started_rx.await.expect("run should start");
assert_eq!(gate.inflight_count(), 1);
let gate_for_shutdown = Arc::clone(&gate);
let shutdown_task = tokio::spawn(async move {
gate_for_shutdown.shutdown().await;
});
timeout(Duration::from_millis(/*millis*/ 50), shutdown_task)
.await
.expect_err("shutdown should wait for the running future");
finish_tx
.send(())
.expect("running future should be waiting");
run_task.await.expect("run task should complete");
gate.shutdown().await;
assert_eq!(gate.inflight_count(), 0);
}
#[tokio::test]
async fn shutdown_drops_late_runs_while_waiting_for_inflight_work() {
let gate = Arc::new(ConnectionRpcGate::new());
let (started_tx, started_rx) = oneshot::channel();
let (finish_tx, finish_rx) = oneshot::channel();
let gate_for_run = Arc::clone(&gate);
let run_task = tokio::spawn(async move {
gate_for_run
.run(async move {
started_tx.send(()).expect("receiver should be open");
let _ = finish_rx.await;
})
.await;
});
started_rx.await.expect("run should start");
let gate_for_shutdown = Arc::clone(&gate);
let shutdown_task = tokio::spawn(async move {
gate_for_shutdown.shutdown().await;
});
timeout(Duration::from_millis(/*millis*/ 50), shutdown_task)
.await
.expect_err("shutdown should wait for the running future");
let late_polled = Arc::new(AtomicBool::new(/*v*/ false));
let late_polled_clone = Arc::clone(&late_polled);
gate.run(async move {
late_polled_clone.store(/*val*/ true, Ordering::Release);
})
.await;
assert!(!late_polled.load(Ordering::Acquire));
finish_tx
.send(())
.expect("running future should still be waiting");
run_task.await.expect("run task should complete");
gate.shutdown().await;
assert_eq!(gate.inflight_count(), 0);
}
#[tokio::test]
async fn run_is_counted_before_handler_body_continues() {
let gate = Arc::new(ConnectionRpcGate::new());
let (entered_tx, entered_rx) = oneshot::channel();
let (continue_tx, continue_rx) = oneshot::channel();
let gate_for_run = Arc::clone(&gate);
let run_task = tokio::spawn(async move {
gate_for_run
.run(async move {
entered_tx.send(()).expect("receiver should be open");
let _ = continue_rx.await;
})
.await;
});
entered_rx.await.expect("handler body should be entered");
assert_eq!(gate.inflight_count(), 1);
continue_tx
.send(())
.expect("handler body should still be waiting");
run_task.await.expect("run task should complete");
assert_eq!(gate.inflight_count(), 0);
}
}
|