sim-lib-openai-server 0.1.1

OpenAI-compatible gateway skeleton for SIM.
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
use std::sync::Arc;

use serde_json::{Map, Value, json};
use sim_kernel::{CapabilitySet, ContentId, Cx, DefaultFactory, Expr, NoopEvalPolicy};

use crate::{
    capabilities::OPENAI_GATEWAY_ADMIN_CAPABILITY,
    clock::{GatewayClock, SystemGatewayClock},
    codec_openai::gateway_event_data_packets,
    objects::{GatewayEvent, GatewayRequest, GatewayResponse, content_id_hex},
    routes::responses::{RESPONSE_RETRIEVAL_PREFIX, ResponseIdGenerators, ResponseRuntimeTargets},
    runtime::OpenAiPlanCache,
    server::GatewayRouteState,
    storage::{GatewayResponseObjectStore, GatewayStateStore, GatewayStore, StoredGatewayResponse},
};

use super::{
    errors::OpenAiRouteError, responses::execute_response_request_with_cache_runners_and_federation,
};

/// Route template for retrieving a stored response's event history.
pub const RESPONSE_EVENTS_ROUTE: &str = "/v1/responses/{id}/events";
/// Path suffix marking a response event-history request.
pub const RESPONSE_EVENTS_SUFFIX: &str = "/events";
/// Route template for the SIM inspection view of a stored response.
pub const RESPONSE_SIM_ROUTE: &str = "/v1/responses/{id}/sim";
/// Path suffix marking a SIM inspection request.
pub const RESPONSE_SIM_SUFFIX: &str = "/sim";
/// Route path for replaying a stored response's recorded event stream.
pub const SIM_REPLAY_PATH: &str = "/v1/sim/replay";
/// Route path for forking a stored response with a request patch.
pub const SIM_FORK_PATH: &str = "/v1/sim/fork";
/// Capability id granting access to SIM extension routes.
pub const SIM_EXTENSION_CAPABILITY: &str = "sim.extension";

type RouteResult<T> = std::result::Result<T, OpenAiRouteError>;

/// Handles `GET /v1/responses/{id}/events`, returning the stored event
/// history for the response id in the path.
pub fn handle_response_events(
    request: &GatewayRequest,
    state: &GatewayRouteState,
) -> GatewayResponse {
    let Some(response_id) = suffixed_response_id(request.path(), RESPONSE_EVENTS_SUFFIX) else {
        return OpenAiRouteError::not_found_kind("response", request.path()).into_response();
    };
    match state.store().lock() {
        Ok(store) => response_events(&*store, response_id),
        Err(err) => OpenAiRouteError::internal_message(format!("gateway store lock failed: {err}"))
            .into_response(),
    }
}

/// Handles `GET /v1/responses/{id}/sim`, returning the SIM inspection view of
/// a stored response; requires the admin or `sim.extension` capability.
pub fn handle_response_sim(request: &GatewayRequest, state: &GatewayRouteState) -> GatewayResponse {
    let Some(response_id) = suffixed_response_id(request.path(), RESPONSE_SIM_SUFFIX) else {
        return OpenAiRouteError::not_found_kind("response", request.path()).into_response();
    };
    if !has_sim_access(request) {
        return OpenAiRouteError::forbidden(
            "response SIM inspection requires openai-gateway.admin or sim.extension",
            "capability_denied",
        )
        .into_response();
    }
    match state.store().lock() {
        Ok(store) => response_sim(&*store, response_id),
        Err(err) => OpenAiRouteError::internal_message(format!("gateway store lock failed: {err}"))
            .into_response(),
    }
}

/// Handles `POST /v1/sim/replay`, replaying the stored event stream for the
/// `response_id` carried in the request body.
pub fn handle_sim_replay(request: &GatewayRequest, state: &GatewayRouteState) -> GatewayResponse {
    let object = match request_object(request.body()) {
        Ok(object) => object,
        Err(error) => return error.into_response(),
    };
    let response_id = match required_string(&object, "response_id") {
        Ok(response_id) => response_id.to_owned(),
        Err(error) => return error.into_response(),
    };
    match state.store().lock() {
        Ok(store) => replay_response(&*store, &response_id),
        Err(err) => OpenAiRouteError::internal_message(format!("gateway store lock failed: {err}"))
            .into_response(),
    }
}

/// Handles `POST /v1/sim/fork`, re-running a stored response's request with a
/// JSON `patch` applied and recording the result as a child response.
pub fn handle_sim_fork(request: &GatewayRequest, state: &GatewayRouteState) -> GatewayResponse {
    let object = match request_object(request.body()) {
        Ok(object) => object,
        Err(error) => return error.into_response(),
    };
    let response_id = match required_string(&object, "response_id") {
        Ok(response_id) => response_id.to_owned(),
        Err(error) => return error.into_response(),
    };
    let patch = match object.get("patch").and_then(Value::as_object) {
        Some(patch) => patch.clone(),
        None => return OpenAiRouteError::missing_required("patch").into_response(),
    };
    let mut clock = SystemGatewayClock;
    let seed = clock.now_ms().unwrap_or(1).saturating_add(1_000_000);
    let mut ids = ResponseIdGenerators::deterministic(seed);
    let targets = ResponseRuntimeTargets::with_federation(state.runners(), state.federation());
    let capabilities = match state.keys().effective_capabilities(request) {
        Ok(capabilities) => capabilities,
        Err(err) => {
            return OpenAiRouteError::internal_message(format!(
                "gateway key capability lookup failed: {err}"
            ))
            .into_response();
        }
    };
    match state.store().lock() {
        Ok(mut store) => fork_response(
            &mut *store,
            &mut ids,
            &mut clock,
            &response_id,
            patch,
            targets,
            &capabilities,
        )
        .unwrap_or_else(OpenAiRouteError::into_response),
        Err(err) => OpenAiRouteError::internal_message(format!("gateway store lock failed: {err}"))
            .into_response(),
    }
}

/// Returns the stored event history for `response_id` as an OpenAI-style
/// `list` JSON response, or an error response if the response is unknown.
pub fn response_events<S>(store: &S, response_id: &str) -> GatewayResponse
where
    S: GatewayResponseObjectStore + GatewayStore,
{
    stored_events(store, response_id)
        .map(|(record, events)| {
            GatewayResponse::json(
                200,
                event_history_json(&record, &events)
                    .to_string()
                    .into_bytes(),
            )
        })
        .unwrap_or_else(OpenAiRouteError::into_response)
}

/// Returns the SIM inspection view of a stored response (request, run, events,
/// and content ids) as JSON, or an error response if the response is unknown.
pub fn response_sim<S>(store: &S, response_id: &str) -> GatewayResponse
where
    S: GatewayResponseObjectStore + GatewayStore,
{
    stored_events(store, response_id)
        .and_then(|(record, events)| sim_json(store, &record, &events))
        .map(|value| GatewayResponse::json(200, value.to_string().into_bytes()))
        .unwrap_or_else(OpenAiRouteError::into_response)
}

fn replay_response<S>(store: &S, response_id: &str) -> GatewayResponse
where
    S: GatewayResponseObjectStore + GatewayStore,
{
    stored_events(store, response_id)
        .map(|(record, events)| {
            GatewayResponse::json(
                200,
                json!({
                    "object": "sim.replay",
                    "response_id": record.response_id(),
                    "data": events_json(&record, &events),
                    "stream": data_stream_json(&events),
                })
                .to_string()
                .into_bytes(),
            )
        })
        .unwrap_or_else(OpenAiRouteError::into_response)
}

fn fork_response<S, C>(
    store: &mut S,
    ids: &mut ResponseIdGenerators,
    clock: &mut C,
    parent_response_id: &str,
    patch: Map<String, Value>,
    targets: ResponseRuntimeTargets<'_>,
    capabilities: &CapabilitySet,
) -> RouteResult<GatewayResponse>
where
    S: GatewayStore + GatewayResponseObjectStore + GatewayStateStore,
    C: GatewayClock,
{
    let parent = store
        .response_object(parent_response_id)
        .ok_or_else(|| OpenAiRouteError::not_found(parent_response_id))?;
    let source_request_id = parent.request_content_id.clone().ok_or_else(|| {
        OpenAiRouteError::bad_request(
            "stored response has no request ledger for fork",
            Some("response_id"),
            "missing_request_ledger",
        )
    })?;
    let source_request = store.request(&source_request_id).ok_or_else(|| {
        OpenAiRouteError::bad_request(
            "stored response request is unavailable",
            Some("response_id"),
            "missing_request",
        )
    })?;
    let forked_request = forked_request(&source_request, patch)?;
    let (mut cx, seat) = Cx::new_seated(Arc::new(NoopEvalPolicy), Arc::new(DefaultFactory));
    for capability in capabilities.iter() {
        seat.grant(&mut cx, capability.clone());
    }
    let mut cache = OpenAiPlanCache::new();
    let execution = execute_response_request_with_cache_runners_and_federation(
        &mut cx,
        store,
        &mut cache,
        ids,
        clock,
        &forked_request,
        targets,
    );
    if !(200..300).contains(&execution.response().status()) {
        return Ok(execution.response().clone());
    }
    let response_id = execution
        .response_id()
        .ok_or_else(|| OpenAiRouteError::internal_message("fork did not produce a response id"))?
        .to_owned();
    if let Some(mut record) = store.response_object(&response_id) {
        record.parent_response_id = Some(parent_response_id.to_owned());
        store
            .put_response_object(record)
            .map_err(OpenAiRouteError::internal)?;
    }
    let request_content_id = execution.request_content_id().ok_or_else(|| {
        OpenAiRouteError::internal_message("fork did not produce a request content id")
    })?;
    let request_id = store
        .request(request_content_id)
        .and_then(|request| request.id().map(str::to_owned));
    Ok(GatewayResponse::json(
        200,
        json!({
            "object": "sim.fork",
            "parent_response_id": parent_response_id,
            "response_id": response_id,
            "request_id": request_id,
            "source_request_content_id": content_id_hex(&source_request_id),
            "request_content_id": content_id_hex(request_content_id),
            "response": response_body_json(execution.response())?,
        })
        .to_string()
        .into_bytes(),
    ))
}

fn stored_events<S>(
    store: &S,
    response_id: &str,
) -> RouteResult<(StoredGatewayResponse, Vec<GatewayEvent>)>
where
    S: GatewayResponseObjectStore + GatewayStore,
{
    let record = store
        .response_object(response_id)
        .ok_or_else(|| OpenAiRouteError::not_found(response_id))?;
    let events = record
        .event_content_ids
        .iter()
        .map(|id| {
            store.event(id).ok_or_else(|| {
                OpenAiRouteError::internal_message(format!(
                    "stored event is missing for response {response_id}: {}",
                    content_id_hex(id)
                ))
            })
        })
        .collect::<RouteResult<Vec<_>>>()?;
    Ok((record, events))
}

fn event_history_json(record: &StoredGatewayResponse, events: &[GatewayEvent]) -> Value {
    json!({
        "object": "list",
        "response_id": record.response_id(),
        "data": events_json(record, events),
    })
}

fn events_json(record: &StoredGatewayResponse, events: &[GatewayEvent]) -> Vec<Value> {
    record
        .event_content_ids
        .iter()
        .zip(events)
        .map(|(content_id, event)| event_json(content_id, event))
        .collect()
}

fn data_stream_json(events: &[GatewayEvent]) -> Vec<Value> {
    gateway_event_data_packets(events)
        .iter()
        .map(|packet| expr_json(&packet.to_expr()))
        .collect()
}

fn event_json(content_id: &ContentId, event: &GatewayEvent) -> Value {
    json!({
        "id": event.id(),
        "object": "response.event",
        "type": format!("response.{}", event.kind().name.as_ref()),
        "event": event.kind().name.as_ref(),
        "run_id": event.run_id(),
        "sequence": event.sequence(),
        "created_at": event.created_at_ms(),
        "content_id": content_id_hex(content_id),
        "payload": expr_json(event.payload()),
    })
}

fn sim_json<S>(
    store: &S,
    record: &StoredGatewayResponse,
    events: &[GatewayEvent],
) -> RouteResult<Value>
where
    S: GatewayStore,
{
    let request = record
        .request_content_id
        .as_ref()
        .and_then(|id| store.request(id));
    let run = record.run_content_id.as_ref().and_then(|id| store.run(id));
    Ok(json!({
        "object": "sim.gateway.response",
        "response_id": record.response_id(),
        "parent_response_id": record.parent_response_id.as_deref(),
        "response_content_id": content_id_hex(record.content_id()),
        "request_content_id": record.request_content_id.as_ref().map(content_id_hex),
        "run_content_id": record.run_content_id.as_ref().map(content_id_hex),
        "event_content_ids": record.event_content_ids.iter().map(content_id_hex).collect::<Vec<_>>(),
        "request": request.as_ref().map(|request| expr_json(&request.to_expr())),
        "run": run.as_ref().map(|run| expr_json(&run.to_expr())),
        "events": events.iter().map(|event| expr_json(&event.to_expr())).collect::<Vec<_>>(),
        "response": response_body_json(record.response())?,
    }))
}

fn forked_request(
    source: &GatewayRequest,
    patch: Map<String, Value>,
) -> RouteResult<GatewayRequest> {
    let mut object = request_object(source.body())?;
    for (key, value) in patch {
        object.insert(key, value);
    }
    object.insert("store".to_owned(), Value::Bool(true));
    object.insert("stream".to_owned(), Value::Bool(false));
    let body = serde_json::to_vec(&Value::Object(object)).map_err(|err| {
        OpenAiRouteError::internal_message(format!("failed to encode fork request: {err}"))
    })?;
    Ok(GatewayRequest::new(
        source.method().to_owned(),
        source.path().to_owned(),
        source.headers().to_vec(),
        body,
    ))
}

use crate::routes::request_json::request_object;

fn required_string<'a>(object: &'a Map<String, Value>, name: &'static str) -> RouteResult<&'a str> {
    object
        .get(name)
        .and_then(Value::as_str)
        .ok_or_else(|| OpenAiRouteError::missing_required(name))
}

fn response_body_json(response: &GatewayResponse) -> RouteResult<Value> {
    serde_json::from_slice(response.body()).map_err(|err| {
        OpenAiRouteError::internal_message(format!("gateway response body is not JSON: {err}"))
    })
}

fn has_sim_access(request: &GatewayRequest) -> bool {
    request.headers().iter().any(|(name, value)| {
        (name.eq_ignore_ascii_case("x-sim-capability")
            || name.eq_ignore_ascii_case("x-sim-capabilities"))
            && value.split([',', ' ']).any(is_sim_capability)
    })
}

fn is_sim_capability(capability: &str) -> bool {
    let capability = capability.trim();
    capability == OPENAI_GATEWAY_ADMIN_CAPABILITY
        || capability == SIM_EXTENSION_CAPABILITY
        || capability.starts_with("sim.extension.")
}

fn suffixed_response_id<'a>(path: &'a str, suffix: &str) -> Option<&'a str> {
    let rest = path.strip_prefix(RESPONSE_RETRIEVAL_PREFIX)?;
    let response_id = rest.strip_suffix(suffix)?;
    (!response_id.is_empty() && !response_id.contains('/')).then_some(response_id)
}

fn expr_json(expr: &Expr) -> Value {
    match expr {
        Expr::Nil => Value::Null,
        Expr::Bool(value) => Value::Bool(*value),
        Expr::String(value) => Value::String(value.clone()),
        Expr::Number(value) => Value::String(format!("{value:?}")),
        Expr::Symbol(symbol) => Value::String(symbol.name.as_ref().to_owned()),
        Expr::Bytes(bytes) => Value::String(bytes_hex(bytes)),
        Expr::List(values) | Expr::Vector(values) | Expr::Set(values) | Expr::Block(values) => {
            Value::Array(values.iter().map(expr_json).collect())
        }
        Expr::Map(entries) => {
            let mut object = Map::new();
            for (key, value) in entries {
                object.insert(expr_key(key), expr_json(value));
            }
            Value::Object(object)
        }
        other => Value::String(format!("{other:?}")),
    }
}

fn expr_key(expr: &Expr) -> String {
    match expr {
        Expr::String(value) => value.clone(),
        Expr::Symbol(symbol) => symbol.name.as_ref().to_owned(),
        _ => format!("{expr:?}"),
    }
}

fn bytes_hex(bytes: &[u8]) -> String {
    const HEX: &[u8; 16] = b"0123456789abcdef";
    let mut output = String::with_capacity(bytes.len() * 2);
    for byte in bytes {
        output.push(char::from(HEX[usize::from(byte >> 4)]));
        output.push(char::from(HEX[usize::from(byte & 0x0f)]));
    }
    output
}