File size: 12,300 Bytes
854994d | 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 | use crate::auth::SharedAuthProvider;
use crate::endpoint::session::EndpointSession;
use crate::error::ApiError;
use crate::images::ImageEditRequest;
use crate::images::ImageGenerationRequest;
use crate::images::ImageResponse;
use crate::provider::Provider;
use codex_client::HttpTransport;
use codex_client::RequestTelemetry;
use http::HeaderMap;
use http::Method;
use serde::Serialize;
use serde_json::to_value;
use std::sync::Arc;
const X_CODEX_IMAGEGEN_REQUEST_ID_HEADER: &str = "x-codex-imagegen-request-id";
pub struct ImagesClient<T: HttpTransport> {
session: EndpointSession<T>,
}
impl<T: HttpTransport> ImagesClient<T> {
pub fn new(transport: T, provider: Provider, auth: SharedAuthProvider) -> Self {
Self {
session: EndpointSession::new(transport, provider, auth),
}
}
pub fn with_telemetry(self, request: Option<Arc<dyn RequestTelemetry>>) -> Self {
Self {
session: self.session.with_request_telemetry(request),
}
}
pub async fn generate(
&self,
request: &ImageGenerationRequest,
extra_headers: HeaderMap,
) -> Result<(ImageResponse, Option<String>), ApiError> {
self.post_image_request(
"images/generations",
request,
extra_headers,
"image generation",
)
.await
}
pub async fn edit(
&self,
request: &ImageEditRequest,
extra_headers: HeaderMap,
) -> Result<(ImageResponse, Option<String>), ApiError> {
self.post_image_request("images/edits", request, extra_headers, "image edit")
.await
}
async fn post_image_request<R: Serialize>(
&self,
path: &str,
request: &R,
extra_headers: HeaderMap,
operation: &str,
) -> Result<(ImageResponse, Option<String>), ApiError> {
let body = to_value(request)
.map_err(|e| ApiError::Stream(format!("failed to encode {operation} request: {e}")))?;
let resp = self
.session
.execute(Method::POST, path, extra_headers, Some(body))
.await?;
let imagegen_request_id = resp
.headers
.get(X_CODEX_IMAGEGEN_REQUEST_ID_HEADER)
.and_then(|value| value.to_str().ok())
.filter(|request_id| !request_id.is_empty())
.map(str::to_string);
let response = serde_json::from_slice(&resp.body)
.map_err(|e| ApiError::Stream(format!("failed to decode {operation} response: {e}")))?;
Ok((response, imagegen_request_id))
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::auth::AuthProvider;
use crate::images::ImageBackground;
use crate::images::ImageData;
use crate::images::ImageQuality;
use crate::images::ImageUrl;
use crate::provider::RetryConfig;
use codex_client::Request;
use codex_client::RequestBody;
use codex_client::Response;
use codex_client::StreamResponse;
use codex_client::TransportError;
use http::StatusCode;
use pretty_assertions::assert_eq;
use serde_json::json;
use std::sync::Mutex;
use std::time::Duration;
#[derive(Clone, Default)]
struct DummyAuth;
impl AuthProvider for DummyAuth {
fn add_auth_headers(&self, _headers: &mut HeaderMap) {}
}
#[derive(Clone)]
struct CapturingTransport {
last_request: Arc<Mutex<Option<Request>>>,
response_body: Arc<Vec<u8>>,
response_headers: HeaderMap,
}
impl CapturingTransport {
fn new(response_body: Vec<u8>) -> Self {
Self::with_response_headers(response_body, HeaderMap::new())
}
fn with_response_headers(response_body: Vec<u8>, response_headers: HeaderMap) -> Self {
Self {
last_request: Arc::new(Mutex::new(None)),
response_body: Arc::new(response_body),
response_headers,
}
}
}
impl HttpTransport for CapturingTransport {
async fn execute(&self, req: Request) -> Result<Response, TransportError> {
*self.last_request.lock().expect("lock request store") = Some(req);
Ok(Response {
status: StatusCode::OK,
headers: self.response_headers.clone(),
body: self.response_body.as_ref().clone().into(),
})
}
async fn stream(&self, _req: Request) -> Result<StreamResponse, TransportError> {
Err(TransportError::Build("stream should not run".to_string()))
}
}
fn provider() -> Provider {
Provider {
name: "test".to_string(),
base_url: "https://example.com/api/codex".to_string(),
query_params: None,
headers: HeaderMap::new(),
retry: RetryConfig {
max_attempts: 1,
base_delay: Duration::from_millis(1),
retry_429: false,
retry_5xx: true,
retry_transport: true,
},
stream_idle_timeout: Duration::from_secs(1),
}
}
fn response_body() -> Vec<u8> {
serde_json::to_vec(&json!({
"created": 1778832973u64,
"background": "opaque",
"data": [{"b64_json": "REDACT"}],
"output_format": "png",
"quality": "medium",
"size": "1024x1536",
"usage": {
"input_tokens": 1474,
"input_tokens_details": {
"image_tokens": 1457,
"text_tokens": 17,
},
"output_tokens": 1372,
"output_tokens_details": {
"image_tokens": 1372,
"text_tokens": 0,
},
"total_tokens": 2846,
}
}))
.expect("serialize response")
}
fn expected_response() -> ImageResponse {
ImageResponse {
created: 1778832973,
background: Some(ImageBackground::Opaque),
data: vec![ImageData {
b64_json: "REDACT".to_string(),
generation_id: None,
}],
quality: Some(ImageQuality::Medium),
size: Some("1024x1536".to_string()),
}
}
fn captured_request(transport: &CapturingTransport) -> Request {
transport
.last_request
.lock()
.expect("lock request store")
.clone()
.expect("request should be captured")
}
#[tokio::test]
async fn generate_posts_typed_request_and_parses_image_response() {
let mut response_headers = HeaderMap::new();
response_headers.insert(
X_CODEX_IMAGEGEN_REQUEST_ID_HEADER,
http::HeaderValue::from_static("req-imagegen-123"),
);
response_headers.insert(
"x-request-id",
http::HeaderValue::from_static("req-outer-456"),
);
let transport =
CapturingTransport::with_response_headers(response_body(), response_headers);
let client = ImagesClient::new(transport.clone(), provider(), Arc::new(DummyAuth));
let (response, imagegen_request_id) = client
.generate(
&ImageGenerationRequest {
prompt: "a red fox in a field".to_string(),
background: Some(ImageBackground::Opaque),
model: "gpt-image-1.5".to_string(),
n: None,
quality: Some(ImageQuality::Medium),
size: Some("1024x1536".to_string()),
},
HeaderMap::new(),
)
.await
.expect("image generation request should succeed");
assert_eq!(response, expected_response());
assert_eq!(imagegen_request_id.as_deref(), Some("req-imagegen-123"));
let request = captured_request(&transport);
assert_eq!(
request.url,
"https://example.com/api/codex/images/generations"
);
assert_eq!(
request.body.as_ref().and_then(RequestBody::json),
Some(&json!({
"prompt": "a red fox in a field",
"background": "opaque",
"model": "gpt-image-1.5",
"quality": "medium",
"size": "1024x1536",
}))
);
}
#[tokio::test]
async fn preserves_distinct_generation_ids_on_image_data() {
let body = serde_json::to_vec(&json!({
"created": 1,
"data": [
{"b64_json": "first", "generation_id": "gen-first"},
{"b64_json": "second", "generation_id": "gen-second"},
{"b64_json": "legacy"}
]
}))
.expect("serialize response");
let transport = CapturingTransport::new(body);
let client = ImagesClient::new(transport, provider(), Arc::new(DummyAuth));
let (response, _) = client
.generate(
&ImageGenerationRequest {
prompt: "test".to_string(),
background: None,
model: "gpt-image-2".to_string(),
n: None,
quality: None,
size: None,
},
HeaderMap::new(),
)
.await
.expect("image response should parse");
assert_eq!(
response
.data
.iter()
.map(|image| image.generation_id.as_deref())
.collect::<Vec<_>>(),
vec![Some("gen-first"), Some("gen-second"), None]
);
}
#[tokio::test]
async fn edit_posts_typed_request_and_parses_image_response() {
let transport = CapturingTransport::new(response_body());
let client = ImagesClient::new(transport.clone(), provider(), Arc::new(DummyAuth));
let (response, imagegen_request_id) = client
.edit(
&ImageEditRequest {
images: vec![ImageUrl {
image_url: "data:image/png;base64,Zm9v".to_string(),
}],
prompt: "add a red hat".to_string(),
background: None,
model: "gpt-image-1.5".to_string(),
n: None,
quality: None,
size: None,
},
HeaderMap::new(),
)
.await
.expect("image edit request should succeed");
assert_eq!(response, expected_response());
assert_eq!(imagegen_request_id, None);
let request = captured_request(&transport);
assert_eq!(request.url, "https://example.com/api/codex/images/edits");
assert_eq!(
request.body.as_ref().and_then(RequestBody::json),
Some(&json!({
"images": [{"image_url": "data:image/png;base64,Zm9v"}],
"prompt": "add a red hat",
"model": "gpt-image-1.5",
}))
);
}
#[tokio::test]
async fn image_response_requires_image_data() {
let transport = CapturingTransport::new(
serde_json::to_vec(&json!({"created": 1778832973u64})).expect("serialize response"),
);
let client = ImagesClient::new(transport, provider(), Arc::new(DummyAuth));
let error = client
.generate(
&ImageGenerationRequest {
prompt: "a red fox in a field".to_string(),
background: None,
model: "gpt-image-1.5".to_string(),
n: None,
quality: None,
size: None,
},
HeaderMap::new(),
)
.await
.expect_err("image response without data should fail");
let ApiError::Stream(message) = error else {
panic!("expected image response decode error");
};
assert!(
message.starts_with("failed to decode image generation response: missing field `data`"),
"{message}"
);
}
}
|