superfluid 0.1.2

The superfluid daemon: durable session store (WAL, verbatim token spans, epochs), generation runtime over Link W, and the native session API
Documentation
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
//! api-web.

use std::sync::Arc;

use axum::extract::ws::{Message, WebSocket, WebSocketUpgrade};
use axum::extract::State;
use axum::http::{HeaderMap, StatusCode};
use axum::response::sse::{Event, KeepAlive, Sse};
use axum::response::IntoResponse;
use axum::routing::{get, post};
use axum::{Json, Router};
use tokio_stream::wrappers::ReceiverStream;
use tokio_stream::StreamExt;

use crate::api::{handle_web, serve_requests, EventMsg, Request, Response, Sink};
use crate::{Daemon, DaemonError, EventBody};

#[derive(Clone)]
struct WebState {
    daemon: Arc<Daemon>,
    token: Arc<String>,
    origins: Arc<Vec<String>>,
    fim_bucket: Arc<std::sync::Mutex<crate::completion_bucket::TokenBucket>>,
}

fn ct_eq(a: &str, b: &str) -> bool {
    let (a, b) = (a.as_bytes(), b.as_bytes());
    if a.len() != b.len() {
        return false;
    }
    let mut diff = 0u8;
    for i in 0..a.len() {
        diff |= a[i] ^ b[i];
    }
    diff == 0
}

fn header_values<'a>(headers: &'a HeaderMap, name: &str) -> Vec<&'a str> {
    headers
        .get_all(name)
        .iter()
        .map(|v| v.to_str().unwrap_or(""))
        .collect()
}

fn bearer_tokens(headers: &HeaderMap) -> Vec<&str> {
    header_values(headers, "authorization")
        .into_iter()
        .map(|v| v.strip_prefix("Bearer ").unwrap_or(""))
        .collect()
}

fn all_match(presented: &[&str], token: &str) -> bool {
    !presented.is_empty() && presented.iter().all(|t| ct_eq(t, token))
}

fn origins_allowed(state: &WebState, headers: &HeaderMap) -> bool {
    header_values(headers, "origin")
        .iter()
        .all(|origin| state.origins.iter().any(|o| o == origin))
}

fn authorize(state: &WebState, headers: &HeaderMap) -> Result<(), (StatusCode, &'static str)> {
    if !all_match(&bearer_tokens(headers), &state.token) {
        return Err((StatusCode::UNAUTHORIZED, "bad or missing bearer token"));
    }
    if !origins_allowed(state, headers) {
        return Err((StatusCode::FORBIDDEN, "origin not allowed"));
    }
    if !all_match(&header_values(headers, "x-superfluid-csrf"), &state.token) {
        return Err((StatusCode::FORBIDDEN, "missing or bad CSRF token"));
    }
    Ok(())
}

async fn rpc(
    State(state): State<WebState>,
    headers: HeaderMap,
    Json(req): Json<Request>,
) -> axum::response::Response {
    if let Err((code, msg)) = authorize(&state, &headers) {
        return (code, Json(Response::Err { message: msg.into() })).into_response();
    }
    if matches!(req, Request::Complete { .. }) {
        let cfg = state.daemon.completion_bucket();
        let taken = state
            .fim_bucket
            .lock()
            .expect("api-web fim bucket")
            .try_take(cfg, std::time::Instant::now());
        if let Err(wait) = taken {
            state.daemon.note_completion_throttled();
            let secs = crate::completion_bucket::retry_after_secs(wait);
            let body = Response::Throttled {
                retry_after_ms: crate::completion_bucket::retry_after_ms(wait),
            };
            return (
                StatusCode::TOO_MANY_REQUESTS,
                [(axum::http::header::RETRY_AFTER, secs.to_string())],
                Json(body),
            )
                .into_response();
        }
    }
    let resp = handle_web(&state.daemon, req);
    (StatusCode::OK, Json(resp)).into_response()
}

async fn health() -> impl IntoResponse {
    StatusCode::OK
}

#[derive(serde::Deserialize)]
struct StreamReq {
    session: u64,
    max_tokens: u32,
    #[serde(default)]
    provisional: bool,
}

async fn stream(
    State(state): State<WebState>,
    headers: HeaderMap,
    Json(req): Json<StreamReq>,
) -> axum::response::Response {
    if let Err((code, msg)) = authorize(&state, &headers) {
        return (code, Json(Response::Err { message: msg.into() })).into_response();
    }
    let (tx, rx) = tokio::sync::mpsc::channel::<serde_json::Value>(256);
    let daemon = Arc::clone(&state.daemon);
    let max_tokens = req.max_tokens;
    let session = req.session;
    let bus = daemon.bus();
    let sub_id = if req.provisional {
        let mut sub = bus.subscribe(session, true);
        let rx_bus = sub.take_receiver();
        let tx_p = tx.clone();
        tokio::task::spawn_blocking(move || {
            while let Ok(msg) = rx_bus.recv() {
                if let crate::bus::BusMsg::Provisional { channel, text } = msg {
                    if tx_p
                        .blocking_send(serde_json::json!({"provisional": {"channel": channel, "text": text}}))
                        .is_err()
                    {
                        break;
                    }
                }
            }
        });
        Some((sub.session, sub.id))
    } else {
        None
    };
    let bus_end = Arc::clone(&daemon);
    tokio::task::spawn_blocking(move || {
        let _closed = crate::keepalive::cancel_when_closed(&daemon, session, &tx);
        let tx2 = tx.clone();
        let out = daemon.generate_streaming(session, max_tokens, move |ev| {
            let msg: EventMsg = ev.clone().into();
            let carry = matches!(
                &ev.body,
                EventBody::Generated { .. }
                    | EventBody::ToolUse { .. }
                    | EventBody::ToolResult { .. }
                    | EventBody::ToolParseFailure { .. }
            );
            if carry {
                tx2.blocking_send(serde_json::json!({ "committed": msg }))
                    .map_err(|_| DaemonError::Protocol("generation consumer gone"))?;
            }
            Ok(())
        });
        if let Some((s, id)) = sub_id {
            bus_end.bus().unsubscribe(s, id);
        }
        match out {
            Ok(o) => {
                let _ = tx.blocking_send(serde_json::json!({
                    "done": {"tokens_generated": o.tokens_generated, "finish": o.finish, "warm_prefix": o.warm_prefix}
                }));
            }
            Err(e) => {
                let _ = tx.blocking_send(serde_json::json!({"error": e.to_string()}));
            }
        }
    });
    let body = ReceiverStream::new(rx)
        .map(|v| Event::default().data(v.to_string()))
        .chain(tokio_stream::once(Event::default().data("[DONE]")))
        .map(Ok::<_, std::convert::Infallible>);
    Sse::new(body).keep_alive(KeepAlive::default()).into_response()
}

const WS_INBOUND_QUEUE: usize = 32;
const WS_INBOUND_BYTES: usize = 64 << 20;

type QueuedRequest = (Result<Request, String>, tokio::sync::OwnedSemaphorePermit);

const WS_OUTBOUND_BYTES: usize = 16 << 20;

#[derive(Default)]
struct OutBudget {
    state: std::sync::Mutex<(usize, bool)>,
    freed: std::sync::Condvar,
    turn: std::sync::Mutex<()>,
}

impl OutBudget {
    fn reserve(&self, len: usize) -> bool {
        let mut st = self.state.lock().expect("ws budget");
        while !st.1 && st.0 > 0 && st.0 + len > WS_OUTBOUND_BYTES {
            st = self.freed.wait(st).expect("ws budget");
        }
        if st.1 {
            return false;
        }
        st.0 += len;
        true
    }

    fn release(&self, len: usize) {
        let mut st = self.state.lock().expect("ws budget");
        st.0 = st.0.saturating_sub(len);
        self.freed.notify_all();
    }

    fn close(&self) {
        self.state.lock().expect("ws budget").1 = true;
        self.freed.notify_all();
    }
}

struct CloseOnDrop(Arc<OutBudget>);

impl Drop for CloseOnDrop {
    fn drop(&mut self) {
        self.0.close();
    }
}

const WS_PROTOCOL: &str = "superfluid.v1";
const WS_TOKEN_PREFIX: &str = "superfluid.token.";

fn offered_protocols(headers: &HeaderMap) -> Vec<String> {
    headers
        .get_all(axum::http::header::SEC_WEBSOCKET_PROTOCOL)
        .iter()
        .filter_map(|v| v.to_str().ok())
        .flat_map(|v| v.split(','))
        .map(|p| p.trim().to_string())
        .filter(|p| !p.is_empty())
        .collect()
}

fn authorize_ws(state: &WebState, headers: &HeaderMap) -> Result<(), (StatusCode, &'static str)> {
    let offered = offered_protocols(headers);
    let presented: Vec<&str> = bearer_tokens(headers)
        .into_iter()
        .chain(
            offered
                .iter()
                .filter_map(|p| p.strip_prefix(WS_TOKEN_PREFIX)),
        )
        .collect();
    if !all_match(&presented, &state.token) {
        return Err((StatusCode::UNAUTHORIZED, "bad or missing bearer token"));
    }
    if header_values(headers, "origin").is_empty() {
        return Err((
            StatusCode::FORBIDDEN,
            "missing Origin (required on /web/ws)",
        ));
    }
    if !origins_allowed(state, headers) {
        return Err((StatusCode::FORBIDDEN, "origin not allowed"));
    }
    if !offered.is_empty() && !offered.iter().any(|p| p == WS_PROTOCOL) {
        return Err((StatusCode::BAD_REQUEST, "offer the superfluid.v1 subprotocol"));
    }
    Ok(())
}

async fn ws(
    State(state): State<WebState>,
    headers: HeaderMap,
    upgrade: WebSocketUpgrade,
) -> axum::response::Response {
    if let Err((code, msg)) = authorize_ws(&state, &headers) {
        return (code, Json(Response::Err { message: msg.into() })).into_response();
    }
    let daemon = Arc::clone(&state.daemon);
    upgrade
        .protocols([WS_PROTOCOL])
        .on_upgrade(move |socket| ws_session(socket, daemon))
}

async fn ws_session(mut socket: WebSocket, daemon: Arc<Daemon>) {
    let (out_tx, mut out_rx) = tokio::sync::mpsc::channel::<String>(256);
    let budget = Arc::new(OutBudget::default());
    let _closer = CloseOnDrop(Arc::clone(&budget));
    let producer_budget = Arc::clone(&budget);
    let (req_tx, mut req_rx) = tokio::sync::mpsc::channel::<QueuedRequest>(WS_INBOUND_QUEUE);
    let inbound = Arc::new(tokio::sync::Semaphore::new(WS_INBOUND_BYTES));
    let sink: Sink = Arc::new(move |msg: &Response| {
        let _turn = producer_budget.turn.lock().expect("ws producer turn");
        let text = serde_json::to_string(msg)
            .map_err(|_| DaemonError::Protocol("unserializable api-web response"))?;
        let len = text.len();
        if !producer_budget.reserve(len) {
            return Err(DaemonError::Protocol("websocket closed"));
        }
        out_tx.blocking_send(text).map_err(|_| {
            producer_budget.release(len);
            DaemonError::Protocol("websocket closed")
        })
    });
    let loop_sink = Arc::clone(&sink);
    let spawned = std::thread::Builder::new()
        .name("superfluid-web-ws".into())
        .spawn(move || {
            let cancels = daemon.cancel_registry();
            let active = daemon.active_registry();
            let err_sink = Arc::clone(&loop_sink);
            let requests = std::iter::from_fn(move || loop {
                match req_rx.blocking_recv().map(|(item, _permit)| item) {
                    Some(Ok(req)) => return Some(Ok(req)),
                    Some(Err(message)) => {
                        if err_sink(&Response::Err { message }).is_err() {
                            return None;
                        }
                    }
                    None => return None,
                }
            });
            let _ = serve_requests(requests, loop_sink, daemon, &cancels, &active);
        });
    drop(sink);
    if spawned.is_err() {
        return;
    }
    let mut slot: Option<tokio::sync::mpsc::Permit<'_, QueuedRequest>> = None;
    let mut pending: Option<(Result<Request, String>, u32)> = None;
    loop {
        tokio::select! {
            permit = inbound.clone().acquire_many_owned(pending.as_ref().map_or(0, |p| p.1)),
                if pending.is_some() => {
                let Ok(permit) = permit else { break };
                let (item, _) = pending.take().expect("guarded");
                slot.take().expect("slot precedes the read").send((item, permit));
            }
            reserved = req_tx.reserve(), if slot.is_none() && pending.is_none() => match reserved {
                Ok(p) => slot = Some(p),
                Err(_) => break,
            },
            frame = socket.recv(), if slot.is_some() && pending.is_none() => {
                let (parsed, len) = match frame {
                    Some(Ok(Message::Text(t))) => {
                        (serde_json::from_str::<Request>(t.as_str()), t.len())
                    }
                    Some(Ok(Message::Binary(b))) => {
                        (serde_json::from_slice::<Request>(&b), b.len())
                    }
                    Some(Ok(Message::Ping(_) | Message::Pong(_))) => continue,
                    Some(Ok(Message::Close(_)) | Err(_)) | None => break,
                };
                let item = parsed.map_err(|e| format!("invalid request frame: {e}"));
                pending = Some((item, len.clamp(1, WS_INBOUND_BYTES) as u32));
            }
            out = out_rx.recv() => {
                let Some(text) = out else { break };
                let len = text.len();
                let sent = socket.send(Message::Text(text.into())).await;
                budget.release(len);
                if sent.is_err() {
                    break;
                }
            }
        }
    }
    let _ = futures_util::SinkExt::close(&mut socket).await;
    drop(slot);
    drop(req_tx);
}

pub fn serve_blocking(
    listener: std::net::TcpListener,
    daemon: Arc<Daemon>,
    token: String,
    origins: Vec<String>,
) -> std::io::Result<()> {
    let rt = tokio::runtime::Runtime::new()?;
    rt.block_on(async move {
        listener.set_nonblocking(true)?;
        let listener = tokio::net::TcpListener::from_std(listener)?;
        let app = Router::new()
            .route("/web/rpc", post(rpc))
            .route("/web/stream", post(stream))
            .route("/web/ws", get(ws))
            .route("/web/health", get(health))
            .with_state(WebState {
                fim_bucket: Arc::new(std::sync::Mutex::new(
                    crate::completion_bucket::TokenBucket::new(
                        daemon.completion_bucket(),
                        std::time::Instant::now(),
                    ),
                )),
                daemon,
                token: Arc::new(token),
                origins: Arc::new(origins),
            });
        axum::serve(listener, app).await
    })
}

pub fn mint_token(path: &std::path::Path) -> std::io::Result<String> {
    let mut buf = [0u8; 32];
    {
        use std::io::Read;
        std::fs::File::open("/dev/urandom")?.read_exact(&mut buf)?;
    }
    let token: String = buf.iter().map(|b| format!("{b:02x}")).collect();
    let mut o = std::fs::OpenOptions::new();
    o.create(true).write(true).truncate(true);
    #[cfg(unix)]
    {
        use std::os::unix::fs::OpenOptionsExt;
        o.mode(0o600);
    }
    use std::io::Write;
    let mut f = o.open(path)?;
    #[cfg(unix)]
    {
        use std::os::unix::fs::PermissionsExt;
        f.set_permissions(std::fs::Permissions::from_mode(0o600))?;
    }
    f.write_all(token.as_bytes())?;
    Ok(token)
}

#[cfg(test)]
mod token_tests {
    #[cfg(unix)]
    #[test]
    fn mint_token_forces_owner_only_even_over_a_pre_existing_file() {
        use std::os::unix::fs::PermissionsExt;
        let dir = std::env::temp_dir().join(format!("superfluid-tok-{}", std::process::id()));
        std::fs::create_dir_all(&dir).unwrap();
        let path = dir.join("web-token");
        std::fs::write(&path, b"old").unwrap();
        std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o644)).unwrap();
        let _tok = super::mint_token(&path).unwrap();
        let mode = std::fs::metadata(&path).unwrap().permissions().mode() & 0o777;
        assert_eq!(mode, 0o600, "token file must be owner-only after mint");
    }
}

#[cfg(test)]
mod budget_tests {
    use super::*;

    #[test]
    fn outbound_budget_backpressures_and_closes() {
        let b = Arc::new(OutBudget::default());
        assert!(
            b.reserve(WS_OUTBOUND_BYTES * 2),
            "an oversized frame alone passes"
        );
        b.release(WS_OUTBOUND_BYTES * 2);
        assert!(b.reserve(WS_OUTBOUND_BYTES - 1));
        let waiter = {
            let b = Arc::clone(&b);
            std::thread::spawn(move || b.reserve(2))
        };
        std::thread::sleep(std::time::Duration::from_millis(50));
        assert!(!waiter.is_finished(), "over budget: the producer waits");
        b.release(WS_OUTBOUND_BYTES - 1);
        assert!(waiter.join().unwrap(), "released bytes let it through");
        let waiter = {
            let b = Arc::clone(&b);
            std::thread::spawn(move || b.reserve(WS_OUTBOUND_BYTES))
        };
        std::thread::sleep(std::time::Duration::from_millis(50));
        drop(CloseOnDrop(Arc::clone(&b)));
        assert!(!waiter.join().unwrap(), "a closed socket fails the wait");
    }
}