rotom 1.5.0

OpenAI- and Anthropic-compatible local API gateway backed by OAuth providers.
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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
use crate::{
    Error, Result,
    codex::{
        convert::to_codex_request,
        cursor,
        events::{
            collect_output, collect_response_value, event_error, event_tool_call, finish_reason,
            is_done_event, normalize_incomplete_result_finish_reason,
            normalize_incomplete_result_response, response_has_usable_output, response_tool_calls,
            text_delta,
        },
        kiro, sse,
        upstream::{UpstreamProvider, adapter_for_provider},
    },
    config::{Credentials, Provider, now_unix},
    openai::response::{
        AssistantMessage, ChatChoice, ChatCompletionChunk, ChatCompletionResponse, chunk_finished,
        chunk_with_content, chunk_with_role, chunk_with_tool_call,
    },
};
use futures_util::{Stream, StreamExt};
use reqwest::{
    Client, Method, Response,
    header::{ACCEPT, CONTENT_TYPE, HeaderValue},
};
use serde_json::Value;
use std::pin::Pin;

/// Default upstream base URL for `Codex` response requests.
pub use crate::codex::upstream::DEFAULT_CODEX_BASE_URL;
pub use crate::codex::upstream::{
    ResponseCreationStrategy, ResponseResourceCapabilities, ResponseResourceCapability,
    codex_headers, grok_headers, resolve_codex_url, resolve_grok_responses_url,
};

#[derive(Clone)]
/// HTTP client wrapper for the `ChatGPT` `Codex` responses backend.
pub struct CodexClient {
    http: Client,
    base_url: String,
    provider: Provider,
}

impl CodexClient {
    /// Creates a Codex client with the provided HTTP client and backend base URL.
    #[must_use]
    pub fn new(http: Client, base_url: impl Into<String>) -> Self {
        Self {
            http,
            base_url: base_url.into(),
            provider: Provider::Codex,
        }
    }

    /// Creates an upstream client for the selected provider.
    #[must_use]
    pub fn new_for_provider(http: Client, provider: Provider) -> Self {
        let base_url = adapter_for_provider(provider).default_base_url();
        Self::new_for_provider_base_url(http, provider, base_url)
    }

    /// Creates an upstream client for the selected provider and base URL.
    #[must_use]
    pub fn new_for_provider_base_url(
        http: Client,
        provider: Provider,
        base_url: impl Into<String>,
    ) -> Self {
        Self {
            http,
            base_url: base_url.into(),
            provider,
        }
    }

    /// Returns the default upstream base URL used by the client.
    #[must_use]
    pub const fn default_base_url() -> &'static str {
        DEFAULT_CODEX_BASE_URL
    }

    /// Returns the configured upstream base URL.
    #[must_use]
    pub fn base_url(&self) -> &str {
        &self.base_url
    }

    /// Returns the upstream provider used by this client.
    #[must_use]
    pub const fn provider(&self) -> Provider {
        self.provider
    }

    /// Returns the provider's Responses resource lifecycle support matrix.
    #[must_use]
    pub fn response_resource_capabilities(&self) -> ResponseResourceCapabilities {
        self.upstream_provider().resource_capabilities()
    }

    /// Returns how this provider should create OpenAI-compatible response objects.
    #[must_use]
    pub fn response_creation_strategy(&self) -> ResponseCreationStrategy {
        self.upstream_provider().response_creation_strategy()
    }

    /// Sends a non-streaming chat completion request and collects the full response body.
    ///
    /// # Errors
    ///
    /// Returns an error when the upstream request fails or the Codex response
    /// stream cannot be collected into a final completion payload.
    pub async fn complete_chat(
        &self,
        request: crate::openai::types::ChatCompletionRequest,
        credentials: &Credentials,
    ) -> Result<ChatCompletionResponse> {
        if self.provider == Provider::Kiro {
            return self.complete_kiro_chat(request, credentials).await;
        }
        if self.provider == Provider::Cursor {
            return cursor::complete_chat(request, credentials).await;
        }

        let id = chat_completion_id();
        let created = now_unix();
        let model = request.model.clone();
        let response = self.send_chat(&request, credentials).await?;
        let output = collect_output(response).await?;

        let usage = output.usage;
        let message = AssistantMessage {
            role: "assistant",
            content: output.text,
            tool_calls: (!output.tool_calls.is_empty()).then_some(output.tool_calls),
            images: (!output.images.is_empty()).then_some(output.images),
        };

        Ok(ChatCompletionResponse {
            id,
            object: "chat.completion",
            created,
            model,
            choices: vec![ChatChoice {
                index: 0,
                message,
                finish_reason: output.finish_reason,
            }],
            usage,
        })
    }

    /// Sends a streaming chat completion request and yields OpenAI-compatible chunks.
    ///
    /// # Errors
    ///
    /// Returns an error when the upstream request fails before the response
    /// stream can be handed back to the caller.
    pub async fn stream_chat(
        &self,
        request: crate::openai::types::ChatCompletionRequest,
        credentials: &Credentials,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<ChatCompletionChunk>> + Send>>> {
        if self.provider == Provider::Kiro {
            return self.stream_kiro_chat(request, credentials).await;
        }
        if self.provider == Provider::Cursor {
            return Ok(cursor::stream_chat(request, credentials.clone()));
        }

        let id = chat_completion_id();
        let created = now_unix();
        let model = request.model.clone();
        let response = self.send_chat(&request, credentials).await?;
        let mut events = Box::pin(sse::json_events(Box::pin(response.bytes_stream())));

        let stream = async_stream::try_stream! {
            yield chunk_with_role(&id, created, &model);
            let mut finished = false;
            let mut tool_call_count = 0_u32;
            let mut seen_tool_call_ids = std::collections::HashSet::<String>::new();
            let mut saw_usable_output = false;

            while let Some(event) = events.next().await {
                let event = event?;
                if let Some(message) = event_error(&event) {
                    Err(Error::upstream(message))?;
                }
                if let Some(delta) = text_delta(&event) {
                    if !delta.is_empty() {
                        saw_usable_output = true;
                        yield chunk_with_content(&id, created, &model, delta);
                    }
                }
                if let Some(tool_call) = event_tool_call(&event) {
                    if seen_tool_call_ids.insert(tool_call.id.clone()) {
                        // The SSE stream can repeat tool calls across incremental and completed events.
                        yield chunk_with_tool_call(&id, created, &model, tool_call_count, tool_call);
                        tool_call_count += 1;
                        saw_usable_output = true;
                    }
                }
                if is_done_event(&event) {
                    // Some tool calls appear only on the terminal completed event.
                    for tool_call in response_tool_calls(&event) {
                        if seen_tool_call_ids.insert(tool_call.id.clone()) {
                            yield chunk_with_tool_call(&id, created, &model, tool_call_count, tool_call);
                            tool_call_count += 1;
                            saw_usable_output = true;
                        }
                    }
                    if event
                        .get("response")
                        .is_some_and(response_has_usable_output)
                    {
                        saw_usable_output = true;
                    }
                    finished = true;
                    let reason = if tool_call_count > 0 {
                        "tool_calls".to_owned()
                    } else {
                        normalize_incomplete_result_finish_reason(
                            finish_reason(&event),
                            saw_usable_output,
                        )
                    };
                    yield chunk_finished(&id, created, &model, &reason);
                    break;
                }
            }

            if !finished {
                yield chunk_finished(&id, created, &model, "stop");
            }
        };

        Ok(Box::pin(stream))
    }

    /// Sends a non-streaming Responses-style request body and returns the final response envelope.
    ///
    /// # Errors
    ///
    /// Returns an error when the upstream request fails or the response stream
    /// cannot be collected into one final response value.
    pub async fn complete_response(
        &self,
        request: Value,
        credentials: &Credentials,
    ) -> Result<Value> {
        if self.provider == Provider::Kiro {
            let response = self.send_kiro_body(&request, credentials).await?;
            return kiro::collect_response_value(response, request).await;
        }
        if self.provider == Provider::Cursor {
            return cursor::complete_response(&request, credentials).await;
        }

        let response = self.send_body(&request, credentials).await?;
        if response_is_json(&response) {
            let mut value = response.json::<Value>().await?;
            normalize_incomplete_result_response(&mut value);
            Ok(value)
        } else {
            collect_response_value(response).await
        }
    }

    /// Sends a streaming Responses-style request body and yields raw upstream JSON SSE events.
    ///
    /// # Errors
    ///
    /// Returns an error when the upstream request cannot be started.
    pub async fn stream_response(
        &self,
        request: Value,
        credentials: &Credentials,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<crate::codex::sse::JsonSseEvent>> + Send>>> {
        if self.provider == Provider::Kiro {
            let response = self.send_kiro_body(&request, credentials).await?;
            return Ok(kiro::response_event_stream(response, request));
        }
        if self.provider == Provider::Cursor {
            return Ok(cursor::response_event_stream(request, credentials.clone()));
        }

        let response = self.send_body(&request, credentials).await?;
        Ok(Box::pin(sse::json_named_events(Box::pin(
            response.bytes_stream(),
        ))))
    }

    /// Retrieves an upstream-stored Responses API object when the provider supports it.
    ///
    /// # Errors
    ///
    /// Returns an error when the provider does not expose retrieval or the
    /// upstream request fails.
    pub async fn retrieve_response(
        &self,
        response_id: &str,
        credentials: &Credentials,
    ) -> Result<Value> {
        let response = self
            .send_response_resource(Method::GET, response_id, credentials)
            .await?;
        response.json::<Value>().await.map_err(Into::into)
    }

    /// Deletes an upstream-stored Responses API object when the provider supports it.
    ///
    /// # Errors
    ///
    /// Returns an error when the provider does not expose deletion or the
    /// upstream request fails.
    pub async fn delete_response(
        &self,
        response_id: &str,
        credentials: &Credentials,
    ) -> Result<Value> {
        let response = self
            .send_response_resource(Method::DELETE, response_id, credentials)
            .await?;
        let status = response.status();
        let text = response.text().await?;
        if text.trim().is_empty() {
            Ok(serde_json::json!({
                "id": response_id,
                "object": "response",
                "deleted": status.is_success()
            }))
        } else {
            serde_json::from_str(&text).map_err(Into::into)
        }
    }

    async fn send_chat(
        &self,
        request: &crate::openai::types::ChatCompletionRequest,
        credentials: &Credentials,
    ) -> Result<Response> {
        self.send_body(&to_codex_request(request)?, credentials)
            .await
    }

    async fn complete_kiro_chat(
        &self,
        request: crate::openai::types::ChatCompletionRequest,
        credentials: &Credentials,
    ) -> Result<ChatCompletionResponse> {
        let id = chat_completion_id();
        let created = now_unix();
        let model = request.model.clone();
        let body = to_codex_request(&request)?;
        let response = self.send_kiro_body(&body, credentials).await?;
        let output = kiro::collect_chat_output(response, body).await?;

        let usage = output.usage;
        let message = AssistantMessage {
            role: "assistant",
            content: output.text,
            tool_calls: (!output.tool_calls.is_empty()).then_some(output.tool_calls),
            images: (!output.images.is_empty()).then_some(output.images),
        };

        Ok(ChatCompletionResponse {
            id,
            object: "chat.completion",
            created,
            model,
            choices: vec![ChatChoice {
                index: 0,
                message,
                finish_reason: output.finish_reason,
            }],
            usage,
        })
    }

    async fn stream_kiro_chat(
        &self,
        request: crate::openai::types::ChatCompletionRequest,
        credentials: &Credentials,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<ChatCompletionChunk>> + Send>>> {
        let id = chat_completion_id();
        let created = now_unix();
        let model = request.model.clone();
        let body = to_codex_request(&request)?;
        let response = self.send_kiro_body(&body, credentials).await?;
        let mut events = kiro::response_event_stream(response, body);

        let stream = async_stream::try_stream! {
            yield chunk_with_role(&id, created, &model);
            let mut finished = false;
            let mut tool_call_count = 0_u32;
            let mut seen_tool_call_ids = std::collections::HashSet::<String>::new();
            let mut saw_usable_output = false;

            while let Some(event) = events.next().await {
                let event = event?.value;
                if let Some(message) = event_error(&event) {
                    Err(Error::upstream(message))?;
                }
                if let Some(delta) = text_delta(&event) {
                    if !delta.is_empty() {
                        saw_usable_output = true;
                        yield chunk_with_content(&id, created, &model, delta);
                    }
                }
                if let Some(tool_call) = event_tool_call(&event) {
                    if seen_tool_call_ids.insert(tool_call.id.clone()) {
                        yield chunk_with_tool_call(&id, created, &model, tool_call_count, tool_call);
                        tool_call_count += 1;
                        saw_usable_output = true;
                    }
                }
                if is_done_event(&event) {
                    for tool_call in response_tool_calls(&event) {
                        if seen_tool_call_ids.insert(tool_call.id.clone()) {
                            yield chunk_with_tool_call(&id, created, &model, tool_call_count, tool_call);
                            tool_call_count += 1;
                            saw_usable_output = true;
                        }
                    }
                    if event
                        .get("response")
                        .is_some_and(response_has_usable_output)
                    {
                        saw_usable_output = true;
                    }
                    finished = true;
                    let reason = if tool_call_count > 0 {
                        "tool_calls".to_owned()
                    } else {
                        normalize_incomplete_result_finish_reason(
                            finish_reason(&event),
                            saw_usable_output,
                        )
                    };
                    yield chunk_finished(&id, created, &model, &reason);
                    break;
                }
            }

            if !finished {
                yield chunk_finished(&id, created, &model, "stop");
            }
        };

        Ok(Box::pin(stream))
    }

    async fn send_body(&self, body: &Value, credentials: &Credentials) -> Result<Response> {
        let mut upstream_body = body.clone();
        let upstream = self.upstream_provider();
        upstream.prepare_request(&mut upstream_body);
        crate::logging::trace_json("upstream.request", &upstream_body);
        let url = upstream.responses_url(&self.base_url);
        let response = self
            .http
            .post(&url)
            .headers(upstream.headers(credentials)?)
            .json(&upstream_body)
            .send()
            .await?;
        tracing::trace!(
            event = "upstream.response_started",
            url = %url,
            status = response.status().as_u16()
        );
        if response.status().is_success() {
            Ok(response)
        } else {
            Err(parse_error_response(response, upstream.provider()).await)
        }
    }

    async fn send_kiro_body(&self, body: &Value, credentials: &Credentials) -> Result<Response> {
        let upstream_body = kiro::to_kiro_payload(body, credentials)?;
        crate::logging::trace_json("upstream.kiro.request", &upstream_body);
        let url = kiro::kiro_endpoint_url(&self.base_url, credentials)?;
        let response = self
            .http
            .post(&url)
            .headers(kiro::kiro_headers(credentials)?)
            .json(&upstream_body)
            .send()
            .await?;
        tracing::trace!(
            event = "upstream.kiro.response_started",
            url = %url,
            status = response.status().as_u16()
        );
        if response.status().is_success() {
            Ok(response)
        } else {
            Err(parse_error_response(response, Provider::Kiro).await)
        }
    }

    async fn send_response_resource(
        &self,
        method: Method,
        response_id: &str,
        credentials: &Credentials,
    ) -> Result<Response> {
        let upstream = self.upstream_provider();
        let Some(url) = upstream.response_resource_url(&self.base_url, response_id) else {
            return Err(unsupported_response_resource(
                upstream.provider(),
                method.as_str(),
            ));
        };
        let mut headers = upstream.headers(credentials)?;
        headers.insert(ACCEPT, HeaderValue::from_static("application/json"));
        let response = self
            .http
            .request(method, &url)
            .headers(headers)
            .send()
            .await?;
        tracing::trace!(
            event = "upstream.response_resource_started",
            url = %url,
            status = response.status().as_u16()
        );
        if response.status().is_success() {
            Ok(response)
        } else {
            Err(parse_error_response(response, upstream.provider()).await)
        }
    }

    fn upstream_provider(&self) -> &'static dyn UpstreamProvider {
        adapter_for_provider(self.provider)
    }
}

fn unsupported_response_resource(provider: Provider, operation: &str) -> Error {
    Error::upstream_with_status(
        reqwest::StatusCode::NOT_IMPLEMENTED,
        format!(
            "{} upstream does not support Responses resource {operation}",
            provider.display_name()
        ),
    )
}

fn response_is_json(response: &Response) -> bool {
    response
        .headers()
        .get(CONTENT_TYPE)
        .and_then(|value| value.to_str().ok())
        .is_some_and(|value| value.starts_with("application/json"))
}

async fn parse_error_response(response: Response, provider: Provider) -> Error {
    let status = response.status();
    let text = response.text().await.unwrap_or_default();
    crate::logging::trace_text("upstream.codex.error_body", &text);
    // Prefer the structured upstream error message when the backend provides one.
    let message = serde_json::from_str::<Value>(&text)
        .ok()
        .and_then(|value| {
            value
                .pointer("/error/message")
                .or_else(|| value.pointer("/detail"))
                .or_else(|| value.pointer("/message"))
                .and_then(Value::as_str)
                .map(str::to_owned)
        })
        .unwrap_or(text);

    let downstream_status = if status.is_client_error() {
        status
    } else {
        reqwest::StatusCode::BAD_GATEWAY
    };

    Error::upstream_with_status(
        downstream_status,
        format!(
            "{} backend returned {status}: {message}",
            provider.display_name()
        ),
    )
}

#[must_use]
fn chat_completion_id() -> String {
    format!("chatcmpl-{}-{:08x}", now_unix(), rand::random::<u32>())
}

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

    #[test]
    fn selects_upstream_provider_adapter() {
        let http = Client::new();
        let codex = CodexClient::new_for_provider(http.clone(), Provider::Codex);
        let grok = CodexClient::new_for_provider(http, Provider::Grok);

        assert_eq!(codex.upstream_provider().provider(), Provider::Codex);
        assert_eq!(grok.upstream_provider().provider(), Provider::Grok);
        assert_eq!(
            codex.response_creation_strategy(),
            ResponseCreationStrategy::ChatCompatibility
        );
        assert_eq!(
            grok.response_creation_strategy(),
            ResponseCreationStrategy::NativeResponses
        );
    }
}