Extract user input preparation into codex-user-input (#61949)

## What changed

Move local attachment snapshotting and conversion from `UserInput` to model request content out of `codex-protocol` into a dedicated `codex-user-input` crate. Update core, the TUI, and the queue extension to use the new crate, replacing the `ResponseInputItem` conversion methods with `from_user_input`.

Move the associated attachment and message conversion tests alongside the implementation, preserving coverage for image positions, media labels, serialization, and error placeholders.

GitOrigin-RevId: 77d0f94a4cd4c2edc008b9e2e63a989995aab058
This commit is contained in:
Adam Perry @ OpenAI
2026-11-17 02:43:52 +00:00
committed by copyberry
parent ad161203cb
commit 5b3d2c7fce
24 changed files with 814 additions and 723 deletions
+15
View File
@@ -3093,6 +3093,7 @@ dependencies = [
"codex-test-binary-support",
"codex-thread-store",
"codex-tools",
"codex-user-input",
"codex-utils-absolute-path",
"codex-utils-audio",
"codex-utils-cache",
@@ -4765,6 +4766,7 @@ dependencies = [
"codex-protocol",
"codex-state",
"codex-thread-store",
"codex-user-input",
"codex-utils-absolute-path",
"core_test_support",
"pretty_assertions",
@@ -5294,6 +5296,7 @@ dependencies = [
"codex-state",
"codex-terminal-detection",
"codex-uds",
"codex-user-input",
"codex-utils-absolute-path",
"codex-utils-approval-presets",
"codex-utils-cargo-bin",
@@ -5391,6 +5394,18 @@ dependencies = [
"windows-sys 0.61.2",
]
[[package]]
name = "codex-user-input"
version = "0.0.0"
dependencies = [
"anyhow",
"codex-protocol",
"codex-utils-image",
"pretty_assertions",
"serde_json",
"tempfile",
]
[[package]]
name = "codex-user-verification"
version = "0.0.0"
+2
View File
@@ -118,6 +118,7 @@ members = [
"otel-trace-websocket",
"tcp-tunnel",
"tui",
"user-input",
"user-verification",
"tools",
"v8-poc",
@@ -339,6 +340,7 @@ codex-utils-sleep-inhibitor = { path = "utils/sleep-inhibitor" }
codex-utils-stream-parser = { path = "utils/stream-parser" }
codex-utils-string = { path = "utils/string" }
codex-utils-template = { path = "utils/template" }
codex-user-input = { path = "user-input" }
codex-user-verification = { path = "user-verification" }
codex-workload-identity = { path = "workload-identity" }
codex-windows-sandbox = { path = "windows-sandbox-rs" }
+1
View File
@@ -73,6 +73,7 @@ codex-state = { workspace = true }
codex-terminal-detection = { workspace = true }
codex-thread-store = { workspace = true }
codex-tools = { workspace = true }
codex-user-input = { workspace = true }
codex-utils-absolute-path = { workspace = true }
codex-utils-audio = { workspace = true }
codex-utils-cache = { workspace = true }
+7 -2
View File
@@ -56,11 +56,12 @@ use codex_protocol::models::AgentMessageInputContent;
use codex_protocol::models::BaseInstructions;
use codex_protocol::models::ContentItem;
use codex_protocol::models::ContentItemKind;
use codex_protocol::models::ResponseInputItem;
use codex_protocol::models::ResponseItem;
use codex_protocol::protocol::EventMsg;
use codex_protocol::user_input::UserInput;
use codex_rollout_trace::InferenceTraceContext;
use codex_user_input::LocalImagePreparation;
use codex_user_input::from_user_input;
use codex_utils_output_truncation::approx_token_count;
use tracing::error;
@@ -286,7 +287,11 @@ async fn run_compact_task_inner_impl(
sess.emit_turn_item_started(&turn_context, &compaction_item)
.await;
}
let initial_input_for_turn: ResponseInputItem = ResponseInputItem::from(input);
let initial_input_for_turn = from_user_input(
input,
LocalImagePreparation::Process,
&mut std::collections::HashMap::new(),
);
let mut history = sess.clone_history().await;
let input_goal_ids = UserGoalUpdate::message_ids(history.raw_items());
@@ -4,8 +4,8 @@
use super::*;
use crate::context_manager::ContextManager;
use codex_protocol::models::BaseInstructions;
use codex_protocol::models::ContentItem;
use codex_protocol::models::ResponseInputItem;
use codex_protocol::user_input::UserInput;
use codex_protocol_test_support::uuid_v7_item_id_generator_for_test;
use codex_utils_output_truncation::TruncationPolicy;
use pretty_assertions::assert_eq;
@@ -13,15 +13,17 @@ use pretty_assertions::assert_eq;
#[test]
fn history_sums_measured_and_unknown_file_audio() {
let mut history = ContextManager::new(uuid_v7_item_id_generator_for_test());
let item = ResponseInputItem::from(
["short", "unknown"]
.map(|file_id| UserInput::Audio {
let item = ResponseInputItem::Message {
role: "user".to_string(),
content: ["short", "unknown"]
.map(|file_id| ContentItem::InputAudio {
audio: AudioReference::File {
file_id: file_id.into(),
},
})
.to_vec(),
);
.into(),
phase: None,
};
history.record_items(
[&ResponseItem::from(item)],
TruncationPolicy::Tokens(10_000),
+3 -3
View File
@@ -390,8 +390,6 @@ use codex_protocol::config_types::Settings;
use codex_protocol::config_types::WindowsSandboxLevel;
use codex_protocol::mcp::ClientMcpExtensions;
use codex_protocol::mcp::OPENAI_STANDARD_FORM_INPUT_EXTENSION_ID;
use codex_protocol::models::LocalImagePreparation;
use codex_protocol::models::ResponseInputItem;
use codex_protocol::models::ResponseItem;
use codex_protocol::openai_models::ReasoningEffort as ReasoningEffortConfig;
use codex_protocol::protocol::ApplyPatchApprovalRequestEvent;
@@ -430,6 +428,8 @@ use codex_protocol::turn_input::TurnStartOptions;
use codex_protocol::user_input::UserInput;
use codex_skills_extension::HostSkillsService;
use codex_tools::ToolName;
use codex_user_input::LocalImagePreparation;
use codex_user_input::from_user_input;
use codex_utils_absolute_path::AbsolutePathBuf;
#[cfg(test)]
use codex_utils_stream_parser::ProposedPlanSegment;
@@ -4016,7 +4016,7 @@ impl Session {
input: Vec<UserInput>,
user_image_content_indices: &mut HashMap<usize, usize>,
) -> ResponseItem {
let mut item = ResponseItem::from(ResponseInputItem::from_user_input(
let mut item = ResponseItem::from(from_user_input(
input,
LocalImagePreparation::Defer,
user_image_content_indices,
@@ -4,6 +4,7 @@ use super::*;
use crate::McpRefreshReason;
use codex_mcp::McpResourceClient;
use codex_mcp::McpResourceClientCacheKey;
use codex_protocol::models::ResponseInputItem;
use pretty_assertions::assert_eq;
struct Recorder {
@@ -2092,11 +2092,15 @@ async fn responses_websocket_uses_incremental_create_on_prefix() {
let harness = websocket_harness(&server).await;
let mut client_session = harness.client.new_session();
let audio = ResponseItem::from(ResponseInputItem::from(vec![UserInput::Audio {
audio: AudioReference::File {
file_id: "file_audio".to_string(),
},
}]));
let audio = ResponseItem::from(ResponseInputItem::Message {
role: "user".to_string(),
content: vec![ContentItem::InputAudio {
audio: AudioReference::File {
file_id: "file_audio".to_string(),
},
}],
phase: None,
});
let prompt_one = prompt_with_input(vec![audio.clone()]);
let prompt_two = prompt_with_input(vec![
audio,
+1
View File
@@ -18,6 +18,7 @@ codex-core = { workspace = true }
codex-extension-api = { workspace = true }
codex-protocol = { workspace = true }
codex-thread-store = { workspace = true }
codex-user-input = { workspace = true }
serde_json = { workspace = true }
thiserror = { workspace = true }
tokio = { workspace = true, features = ["rt", "sync", "time"] }
+1 -1
View File
@@ -19,7 +19,6 @@ use codex_extension_api::ThreadLifecycleContributor;
use codex_extension_api::ThreadResumeInput;
use codex_protocol::ThreadId;
use codex_protocol::error::CodexErr;
use codex_protocol::models::snapshot_local_user_input;
use codex_protocol::protocol::AgentStatus;
use codex_protocol::protocol::Event;
use codex_protocol::protocol::EventMsg;
@@ -31,6 +30,7 @@ use codex_thread_store::MAX_QUEUE_ITEMS;
use codex_thread_store::QueueStore;
use codex_thread_store::QueuedUserSubmissionRecord;
use codex_thread_store::ThreadStoreError;
use codex_user_input::snapshot_local_user_input;
use thiserror::Error;
use tokio::sync::Mutex;
use tokio::sync::OwnedMutexGuard;
-1
View File
@@ -43,7 +43,6 @@ pub mod exec_output;
pub mod hooks;
pub mod items;
mod legacy_events;
pub mod local_media;
pub mod mcp;
pub mod mcp_approval_meta;
pub mod mcp_policy;
+10 -685
View File
@@ -5,7 +5,6 @@ use std::path::Path;
use std::sync::Arc;
use codex_utils_image::PromptImageMode;
use codex_utils_image::data_url_from_bytes;
use codex_utils_image::load_for_prompt_bytes;
use serde::Deserialize;
use serde::Deserializer;
@@ -14,7 +13,6 @@ use serde::ser::Serializer;
use serde_with::serde_as;
use ts_rs::TS;
use crate::local_media::audio_mime_for_path;
use crate::permissions::FileSystemAccessMode;
use crate::permissions::FileSystemPath;
use crate::permissions::FileSystemSandboxEntry;
@@ -25,7 +23,6 @@ use crate::permissions::LegacySandboxPolicyProjection;
use crate::permissions::NetworkSandboxPolicy;
use crate::permissions::RawFileSystemSandboxEntry;
use crate::protocol::SandboxPolicy;
use crate::user_input::UserInput;
use codex_utils_absolute_path::AbsolutePathBuf;
use codex_utils_image::ImageProcessingError;
use schemars::JsonSchema;
@@ -43,8 +40,6 @@ mod mcp_content;
use mcp_content::convert_mcp_content_to_items;
pub use crate::local_media::MAX_PROMPT_AUDIO_INPUT_BYTES;
pub use crate::local_media::snapshot_local_user_input;
pub use crate::permission_profile_snapshot::PermissionProfileSnapshot;
pub use crate::permission_profile_snapshot::ProfileWorkspaceRoot;
pub use configuration_update::ConfigurationReasoning;
@@ -1900,33 +1895,21 @@ fn should_serialize_reasoning_content(content: &Option<Vec<ReasoningItemContent>
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum LocalMediaKind {
Audio,
Image,
}
impl LocalMediaKind {
fn name(self) -> &'static str {
match self {
Self::Audio => "audio",
Self::Image => "image",
}
}
}
fn local_media_error_placeholder(
fn local_image_error_placeholder(
path: &std::path::Path,
error: impl std::fmt::Display,
media_kind: LocalMediaKind,
) -> ContentItem {
let media_name = media_kind.name();
let path = path.display();
ContentItem::InputText {
text: format!("Codex could not read the local {media_name} at `{path}`: {error}"),
text: format!("Codex could not read the local image at `{path}`: {error}"),
}
}
/// Maximum accepted decoded byte length for prompt audio inputs.
///
/// This matches the Responses API audio input limit.
pub const MAX_PROMPT_AUDIO_INPUT_BYTES: usize = 50 * 1024 * 1024;
pub const VIEW_IMAGE_TOOL_NAME: &str = "view_image";
const IMAGE_OPEN_TAG: &str = "<image>";
@@ -1938,7 +1921,6 @@ const AUDIO_OPEN_TAG: &str = "<audio>";
const AUDIO_CLOSE_TAG: &str = "</audio>";
const LOCAL_AUDIO_OPEN_TAG_PREFIX: &str = "<audio name=";
const LOCAL_AUDIO_OPEN_TAG_SUFFIX: &str = ">";
const LOCAL_AUDIO_CLOSE_TAG: &str = AUDIO_CLOSE_TAG;
pub fn image_open_tag_text() -> String {
IMAGE_OPEN_TAG.to_string()
@@ -2074,21 +2056,13 @@ pub fn local_image_content_items_with_label_number(
| ImageProcessingError::InvalidDataUrl { .. }
| ImageProcessingError::ImageTooLarge { .. }
| ImageProcessingError::ImageTooManyPixels { .. } => {
vec![local_media_error_placeholder(
path,
&err,
LocalMediaKind::Image,
)]
vec![local_image_error_placeholder(path, &err)]
}
ImageProcessingError::Decode { .. } if err.is_invalid_image() => {
vec![invalid_image_error_placeholder(path, &err)]
}
ImageProcessingError::Decode { .. } => {
vec![local_media_error_placeholder(
path,
&err,
LocalMediaKind::Image,
)]
vec![local_image_error_placeholder(path, &err)]
}
ImageProcessingError::UnsupportedImageFormat { mime } => {
vec![unsupported_image_error_placeholder(path, mime)]
@@ -2097,46 +2071,7 @@ pub fn local_image_content_items_with_label_number(
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LocalImagePreparation {
Process,
Defer,
}
fn unsupported_audio_error_placeholder(path: &std::path::Path) -> ContentItem {
ContentItem::InputText {
text: format!(
"Codex cannot attach audio at `{}`: unsupported audio format; use wav, mp3, m4a, webm, or ogg.",
path.display()
),
}
}
fn local_audio_content_items(
path: &std::path::Path,
file_bytes: &[u8],
label_number: usize,
) -> Vec<ContentItem> {
let Some(mime) = audio_mime_for_path(path) else {
return vec![unsupported_audio_error_placeholder(path)];
};
vec![
ContentItem::InputText {
text: local_audio_open_tag_text_with_path(label_number, path),
},
ContentItem::InputAudio {
audio: AudioReference::Inline {
audio_url: data_url_from_bytes(mime, file_bytes),
},
},
ContentItem::InputText {
text: LOCAL_AUDIO_CLOSE_TAG.to_string(),
},
]
}
fn local_image_content_items(
pub fn local_image_content_items(
path: &std::path::Path,
image_url: String,
label_number: Option<usize>,
@@ -2289,97 +2224,6 @@ pub enum ReasoningItemContent {
Text { text: String },
}
impl From<Vec<UserInput>> for ResponseInputItem {
fn from(items: Vec<UserInput>) -> Self {
Self::from_user_input(items, LocalImagePreparation::Process, &mut HashMap::new())
}
}
impl ResponseInputItem {
/// Records original user-input indices to image slots in the generated message content.
/// Inputs that do not produce an image, including failed local reads, have no entry.
pub fn from_user_input(
items: Vec<UserInput>,
local_image_preparation: LocalImagePreparation,
user_image_content_indices: &mut HashMap<usize, usize>,
) -> Self {
user_image_content_indices.clear();
let mut image_index = 0;
let mut audio_index = 0;
let mut content = Vec::new();
for (input_index, input) in items.into_iter().enumerate() {
let generated = match input {
UserInput::Text { text, .. } => vec![ContentItem::InputText { text }],
UserInput::Image { image, detail, .. } => {
image_index += 1;
let detail = detail.unwrap_or(DEFAULT_IMAGE_DETAIL);
vec![ContentItem::InputImage {
image,
detail: Some(detail),
}]
}
UserInput::LocalImage { path, detail, .. } => {
image_index += 1;
let detail = detail.unwrap_or(DEFAULT_IMAGE_DETAIL);
match std::fs::read(&path) {
Ok(file_bytes) => match local_image_preparation {
LocalImagePreparation::Process => {
local_image_content_items_with_label_number(
&path,
file_bytes,
Some(image_index),
detail,
)
}
LocalImagePreparation::Defer => local_image_content_items(
&path,
data_url_from_bytes("application/octet-stream", &file_bytes),
Some(image_index),
detail,
),
},
Err(err) => vec![local_media_error_placeholder(
&path,
err,
LocalMediaKind::Image,
)],
}
}
UserInput::Audio { audio } => {
audio_index += 1;
vec![ContentItem::InputAudio { audio }]
}
UserInput::LocalAudio { path } => {
audio_index += 1;
match std::fs::read(&path) {
Ok(file_bytes) => {
local_audio_content_items(&path, &file_bytes, audio_index)
}
Err(err) => vec![local_media_error_placeholder(
&path,
err,
LocalMediaKind::Audio,
)],
}
}
UserInput::Skill { .. } | UserInput::Mention { .. } => Vec::new(), // Tool bodies are injected later in core
};
// Local images add framing text, while mentions and skills add no content.
// Capture the image's actual slot before preparation replaces its reference.
for (offset, item) in generated.iter().enumerate() {
if matches!(item, ContentItem::InputImage { .. }) {
user_image_content_indices.insert(input_index, content.len() + offset);
}
}
content.extend(generated);
}
Self::Message {
role: "user".to_string(),
content,
phase: None,
}
}
}
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema, TS)]
pub struct SearchToolCallParams {
pub query: String,
@@ -2697,14 +2541,6 @@ mod tests {
use std::path::PathBuf;
use tempfile::tempdir;
// A tiny valid PNG (1x1) so image conversion tests don't depend on cross-crate
// file paths, which break under Bazel sandboxing.
const TINY_PNG_BYTES: &[u8] = &[
137, 80, 78, 71, 13, 10, 26, 10, 0, 0, 0, 13, 73, 72, 68, 82, 0, 0, 0, 1, 0, 0, 0, 1, 8, 6,
0, 0, 0, 31, 21, 196, 137, 0, 0, 0, 11, 73, 68, 65, 84, 120, 156, 99, 96, 0, 2, 0, 0, 5, 0,
1, 122, 94, 171, 63, 0, 0, 0, 0, 73, 69, 78, 68, 174, 66, 96, 130,
];
#[test]
fn base_instructions_preserve_provenance_and_accept_legacy_rollouts() -> Result<()> {
let legacy: BaseInstructions =
@@ -4164,231 +4000,6 @@ mod tests {
Ok(())
}
#[test]
fn serializes_image_user_input_without_tags() -> Result<()> {
let image_url = "data:image/png;base64,abc".to_string();
let item = ResponseInputItem::from(vec![UserInput::Image {
image: ImageReference::Inline {
image_url: image_url.clone(),
},
detail: None,
}]);
match item {
ResponseInputItem::Message { content, .. } => {
let expected = vec![ContentItem::InputImage {
image: ImageReference::Inline { image_url },
detail: Some(DEFAULT_IMAGE_DETAIL),
}];
assert_eq!(content, expected);
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
/// A file-backed user image must reach the Responses API without being resolved by Core.
#[test]
fn file_image_user_input_serializes_file_id() -> Result<()> {
let file_id = "file_123".to_string();
let item = ResponseInputItem::from(vec![UserInput::Image {
image: ImageReference::File {
file_id: file_id.clone(),
},
detail: None,
}]);
let expected = ResponseInputItem::Message {
role: "user".to_string(),
content: vec![ContentItem::InputImage {
image: ImageReference::File { file_id },
detail: Some(DEFAULT_IMAGE_DETAIL),
}],
phase: None,
};
assert_eq!(item, expected);
assert_eq!(
serde_json::to_value(item)?,
serde_json::json!({
"type": "message",
"role": "user",
"content": [{
"type": "input_image",
"file_id": "file_123",
"detail": "high"
}]
})
);
Ok(())
}
#[test]
fn serializes_audio_user_input_without_tags() -> Result<()> {
for (audio, wire) in [
(
AudioReference::Inline {
audio_url: "data:audio/wav;base64,abc".into(),
},
serde_json::json!({"type": "input_audio", "audio_url": "data:audio/wav;base64,abc"}),
),
(
AudioReference::File {
file_id: "file_audio".into(),
},
serde_json::json!({"type": "input_audio", "file_id": "file_audio"}),
),
] {
let input = UserInput::Audio {
audio: audio.clone(),
};
assert_eq!(
serde_json::from_value::<UserInput>(serde_json::to_value(&input)?)?,
input
);
let item = ResponseInputItem::from(vec![input]);
assert_eq!(
item,
ResponseInputItem::Message {
role: "user".into(),
content: vec![ContentItem::InputAudio { audio }],
phase: None,
}
);
assert_eq!(
serde_json::to_value(&item)?,
serde_json::json!({
"type": "message", "role": "user", "content": [wire],
})
);
assert_eq!(
serde_json::from_value::<ResponseInputItem>(serde_json::to_value(&item)?)?,
item
);
}
Ok(())
}
#[test]
fn serializes_local_audio_user_input_with_label_and_data_url() -> Result<()> {
let temp_dir = tempdir()?;
for (extension, mime) in [
("wav", "audio/wav"),
("mp3", "audio/mpeg"),
("m4a", "audio/mp4"),
("webm", "audio/webm"),
("ogg", "audio/ogg"),
] {
let audio_path = temp_dir.path().join(format!("sample.{extension}"));
std::fs::write(&audio_path, b"audio")?;
let item = ResponseInputItem::from(vec![UserInput::LocalAudio {
path: audio_path.clone(),
}]);
assert_eq!(
item,
ResponseInputItem::Message {
role: "user".to_string(),
content: vec![
ContentItem::InputText {
text: local_audio_open_tag_text_with_path(
/*label_number*/ 1,
&audio_path,
),
},
ContentItem::InputAudio {
audio: AudioReference::Inline {
audio_url: format!("data:{mime};base64,YXVkaW8=")
},
},
ContentItem::InputText {
text: audio_close_tag_text(),
},
],
phase: None,
}
);
}
Ok(())
}
#[test]
fn replaces_unsupported_local_audio_format_with_placeholder() -> Result<()> {
let temp_dir = tempdir()?;
let audio_path = temp_dir.path().join("sample.flac");
std::fs::write(&audio_path, b"audio")?;
let item = ResponseInputItem::from(vec![UserInput::LocalAudio {
path: audio_path.clone(),
}]);
assert_eq!(
item,
ResponseInputItem::Message {
role: "user".to_string(),
content: vec![ContentItem::InputText {
text: format!(
"Codex cannot attach audio at `{}`: unsupported audio format; use wav, mp3, m4a, webm, or ogg.",
audio_path.display()
),
}],
phase: None,
}
);
Ok(())
}
#[test]
fn replaces_unreadable_local_audio_with_placeholder() {
let audio_path = PathBuf::from("missing.wav");
let item = ResponseInputItem::from(vec![UserInput::LocalAudio { path: audio_path }]);
let ResponseInputItem::Message { content, .. } = item else {
panic!("expected message response");
};
let [ContentItem::InputText { text }] = content.as_slice() else {
panic!("expected local audio error placeholder");
};
assert!(
text.starts_with("Codex could not read the local audio at `missing.wav`: "),
"unexpected placeholder: {text}"
);
}
#[test]
fn image_user_input_preserves_requested_detail() -> Result<()> {
let image_url = "data:image/png;base64,abc".to_string();
let item = ResponseInputItem::from(vec![UserInput::Image {
image: ImageReference::Inline {
image_url: image_url.clone(),
},
detail: Some(ImageDetail::Original),
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(
content.first(),
Some(&ContentItem::InputImage {
image: ImageReference::Inline { image_url },
detail: Some(ImageDetail::Original),
})
);
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
#[test]
fn tool_search_call_roundtrips() -> Result<()> {
let parsed: ResponseItem = serde_json::from_str(
@@ -4560,164 +4171,6 @@ mod tests {
Ok(())
}
/// Image associations use original input and expanded content positions, so omitted inputs,
/// local-image framing, failed reads, and duplicate URLs cannot shift a later substitution.
#[test]
fn user_input_image_indices_survive_content_expansion() -> Result<()> {
let dir = tempdir()?;
let local_path = dir.path().join("local.png");
std::fs::write(&local_path, TINY_PNG_BYTES)?;
let inline_image = UserInput::Image {
image: ImageReference::Inline {
image_url: data_url_from_bytes("image/png", TINY_PNG_BYTES),
},
detail: None,
};
let inputs = vec![
UserInput::Text {
text: "compare images".to_string(),
text_elements: Vec::new(),
},
UserInput::Mention {
name: "app".to_string(),
path: "app://example".to_string(),
},
UserInput::Skill {
name: "skill".to_string(),
path: dir.path().join("SKILL.md"),
},
UserInput::LocalImage {
path: dir.path().join("missing.png"),
detail: None,
},
UserInput::LocalImage {
path: local_path,
detail: None,
},
inline_image.clone(),
inline_image,
];
for preparation in [LocalImagePreparation::Defer, LocalImagePreparation::Process] {
let mut indices = HashMap::new();
let item =
ResponseInputItem::from_user_input(inputs.clone(), preparation, &mut indices);
assert_eq!(indices, HashMap::from([(4, 3), (5, 5), (6, 6)]));
let ResponseInputItem::Message { content, .. } = item else {
panic!("expected a user message");
};
for content_index in indices.into_values() {
assert!(matches!(
content[content_index],
ContentItem::InputImage { .. }
));
}
}
Ok(())
}
#[test]
fn mixed_remote_and_local_images_share_label_sequence() -> Result<()> {
let image_url = "data:image/png;base64,abc".to_string();
let dir = tempdir()?;
let local_path = dir.path().join("local.png");
std::fs::write(&local_path, TINY_PNG_BYTES)?;
let item = ResponseInputItem::from(vec![
UserInput::Image {
image: ImageReference::Inline {
image_url: image_url.clone(),
},
detail: None,
},
UserInput::LocalImage {
path: local_path.clone(),
detail: None,
},
]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(
content.first(),
Some(&ContentItem::InputImage {
image: ImageReference::Inline { image_url },
detail: Some(DEFAULT_IMAGE_DETAIL),
})
);
assert_eq!(
content.get(1),
Some(&ContentItem::InputText {
text: local_image_open_tag_text_with_path(
/*label_number*/ 2,
&local_path
),
})
);
assert!(matches!(
content.get(2),
Some(ContentItem::InputImage { .. })
));
assert_eq!(
content.get(3),
Some(&ContentItem::InputText {
text: image_close_tag_text(),
})
);
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
#[test]
fn mixed_remote_and_local_audio_share_label_sequence() -> Result<()> {
let audio_url = "data:audio/wav;base64,abc".to_string();
let dir = tempdir()?;
let local_path = dir.path().join("local.mp3");
std::fs::write(&local_path, b"audio")?;
let item = ResponseInputItem::from(vec![
UserInput::Audio {
audio: AudioReference::Inline {
audio_url: audio_url.clone(),
},
},
UserInput::LocalAudio {
path: local_path.clone(),
},
]);
assert_eq!(
item,
ResponseInputItem::Message {
role: "user".to_string(),
content: vec![
ContentItem::InputAudio {
audio: AudioReference::Inline { audio_url }
},
ContentItem::InputText {
text: local_audio_open_tag_text_with_path(
/*label_number*/ 2,
&local_path,
),
},
ContentItem::InputAudio {
audio: AudioReference::Inline {
audio_url: "data:audio/mpeg;base64,YXVkaW8=".to_string()
}
},
ContentItem::InputText {
text: audio_close_tag_text(),
},
],
phase: None,
}
);
Ok(())
}
#[test]
fn local_image_open_tag_preserves_path() {
assert_eq!(
@@ -4728,132 +4181,4 @@ mod tests {
r#"<image name=[Image #1] path="/tmp/a&"<b>.png">"#
);
}
#[test]
fn local_image_user_input_preserves_requested_detail() -> Result<()> {
let dir = tempdir()?;
let local_path = dir.path().join("local.png");
std::fs::write(&local_path, TINY_PNG_BYTES)?;
let item = ResponseInputItem::from(vec![UserInput::LocalImage {
path: local_path,
detail: Some(ImageDetail::Original),
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert!(matches!(
content.get(1),
Some(ContentItem::InputImage {
detail: Some(ImageDetail::Original),
..
})
));
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
#[test]
fn local_image_read_error_adds_placeholder() -> Result<()> {
let dir = tempdir()?;
let missing_path = dir.path().join("missing-image.png");
let item = ResponseInputItem::from(vec![UserInput::LocalImage {
path: missing_path.clone(),
detail: None,
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(content.len(), 1);
match &content[0] {
ContentItem::InputText { text } => {
let display_path = missing_path.display().to_string();
assert!(
text.contains(&display_path),
"placeholder should mention missing path: {text}"
);
assert!(
text.contains("could not read"),
"placeholder should mention read issue: {text}"
);
}
other => panic!("expected placeholder text but found {other:?}"),
}
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
#[test]
fn local_image_non_image_adds_placeholder() -> Result<()> {
let dir = tempdir()?;
let json_path = dir.path().join("example.json");
std::fs::write(&json_path, br#"{"hello":"world"}"#)?;
let item = ResponseInputItem::from(vec![UserInput::LocalImage {
path: json_path.clone(),
detail: None,
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(content.len(), 1);
match &content[0] {
ContentItem::InputText { text } => {
assert!(
text.contains("unsupported image `application/json`"),
"placeholder should mention unsupported image MIME: {text}"
);
assert!(
text.contains(&json_path.display().to_string()),
"placeholder should mention path: {text}"
);
}
other => panic!("expected placeholder text but found {other:?}"),
}
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
#[test]
fn local_image_unsupported_image_format_adds_placeholder() -> Result<()> {
let dir = tempdir()?;
let svg_path = dir.path().join("example.svg");
std::fs::write(
&svg_path,
br#"<?xml version="1.0" encoding="UTF-8"?>
<svg xmlns="http://www.w3.org/2000/svg" width="1" height="1"></svg>"#,
)?;
let item = ResponseInputItem::from(vec![UserInput::LocalImage {
path: svg_path.clone(),
detail: None,
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(content.len(), 1);
let expected = format!(
"Codex cannot attach image at `{}`: unsupported image `image/svg+xml`.",
svg_path.display()
);
match &content[0] {
ContentItem::InputText { text } => assert_eq!(text, &expected),
other => panic!("expected placeholder text but found {other:?}"),
}
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
}
+2 -3
View File
@@ -33,8 +33,7 @@ pub enum UserInput {
#[ts(optional)]
detail: Option<ImageDetail>,
},
/// Local image path provided by the user. This will be converted to an
/// `Image` variant (base64 data URL) during request serialization.
/// Local image attachment provided by path.
LocalImage {
path: std::path::PathBuf,
#[serde(default, skip_serializing_if = "Option::is_none")]
@@ -46,7 +45,7 @@ pub enum UserInput {
#[serde(flatten)]
audio: AudioReference,
},
/// Local audio path converted to an `Audio` data URI during request serialization.
/// Local audio attachment provided by path.
LocalAudio { path: std::path::PathBuf },
/// Skill selected by the user (name + path to SKILL.md).
+1
View File
@@ -68,6 +68,7 @@ codex-terminal-detection = { workspace = true }
codex-worktree = { workspace = true }
codex-utils-approval-presets = { workspace = true }
codex-uds = { workspace = true }
codex-user-input = { workspace = true }
codex-utils-absolute-path = { workspace = true }
codex-utils-cli = { workspace = true }
codex-utils-elapsed = { workspace = true }
@@ -5,8 +5,8 @@
use super::*;
use codex_protocol::models::ImageDetail;
use codex_protocol::models::ImageReference;
use codex_protocol::models::snapshot_local_user_input;
use codex_protocol::user_input::UserInput as CoreUserInput;
use codex_user_input::snapshot_local_user_input;
use tokio::sync::oneshot;
static IMAGE_PREPARATION: tokio::sync::Mutex<()> = tokio::sync::Mutex::const_new(());
+6
View File
@@ -0,0 +1,6 @@
load("//:defs.bzl", "codex_rust_crate")
codex_rust_crate(
name = "user-input",
crate_name = "codex_user_input",
)
+23
View File
@@ -0,0 +1,23 @@
[package]
name = "codex-user-input"
version.workspace = true
edition.workspace = true
license.workspace = true
[lib]
doctest = false
name = "codex_user_input"
path = "src/lib.rs"
[lints]
workspace = true
[dependencies]
codex-protocol = { workspace = true }
codex-utils-image = { workspace = true }
[dev-dependencies]
anyhow = { workspace = true }
pretty_assertions = { workspace = true }
serde_json = { workspace = true }
tempfile = { workspace = true }
+13
View File
@@ -0,0 +1,13 @@
//! Captures user attachments and renders resolved input for model requests.
mod local_media;
mod message;
pub use local_media::audio_mime_for_path;
pub use local_media::snapshot_local_user_input;
pub use message::LocalImagePreparation;
pub use message::from_user_input;
#[cfg(test)]
#[path = "message_tests.rs"]
mod message_tests;
@@ -1,3 +1,5 @@
//! Reads bounded attachments from the client-facing host.
use std::io;
use std::io::Read;
use std::path::Path;
@@ -7,15 +9,11 @@ use codex_utils_image::PromptImageMode;
use codex_utils_image::data_url_from_bytes;
use codex_utils_image::load_for_prompt_bytes;
use crate::models::AudioReference;
use crate::models::ImageDetail;
use crate::models::ImageReference;
use crate::user_input::UserInput;
/// Maximum accepted decoded byte length for prompt audio inputs.
///
/// This matches the Responses API audio input limit.
pub const MAX_PROMPT_AUDIO_INPUT_BYTES: usize = 50 * 1024 * 1024;
use codex_protocol::models::AudioReference;
use codex_protocol::models::ImageDetail;
use codex_protocol::models::ImageReference;
use codex_protocol::models::MAX_PROMPT_AUDIO_INPUT_BYTES;
use codex_protocol::user_input::UserInput;
/// Snapshots local image and audio input into portable, validated data URLs.
pub fn snapshot_local_user_input(input: &mut UserInput) -> io::Result<()> {
@@ -48,11 +46,7 @@ pub fn snapshot_local_user_input(input: &mut UserInput) -> io::Result<()> {
},
};
}
UserInput::Text { .. }
| UserInput::Image { .. }
| UserInput::Audio { .. }
| UserInput::Skill { .. }
| UserInput::Mention { .. } => {}
_ => {}
}
Ok(())
}
@@ -77,7 +71,7 @@ fn read_bounded_local_media(path: &Path, max_bytes: usize, kind: &str) -> io::Re
Ok(bytes)
}
pub(crate) fn audio_mime_for_path(path: &Path) -> Option<&'static str> {
pub fn audio_mime_for_path(path: &Path) -> Option<&'static str> {
let extension = path.extension()?.to_str()?;
if extension.eq_ignore_ascii_case("wav") {
Some("audio/wav")
@@ -1,3 +1,5 @@
#![cfg(test)]
use super::*;
use anyhow::Result;
use pretty_assertions::assert_eq;
@@ -31,7 +33,7 @@ fn snapshots_local_image_user_input_with_requested_detail() -> Result<()> {
assert_eq!(
UserInput::Image {
image: crate::models::ImageReference::Inline {
image: codex_protocol::models::ImageReference::Inline {
image_url: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAC0lEQVR4nGNgAAIAAAUAAXpeqz8AAAAASUVORK5CYII="
.to_string(),
},
+160
View File
@@ -0,0 +1,160 @@
//! Converts user inputs to model content and records image positions for UI events.
use crate::local_media::audio_mime_for_path;
use codex_protocol::models::AudioReference;
use codex_protocol::models::ContentItem;
use codex_protocol::models::DEFAULT_IMAGE_DETAIL;
use codex_protocol::models::ResponseInputItem;
use codex_protocol::models::audio_close_tag_text;
use codex_protocol::models::local_audio_open_tag_text_with_path;
use codex_protocol::models::local_image_content_items;
use codex_protocol::models::local_image_content_items_with_label_number;
use codex_protocol::user_input::UserInput;
use codex_utils_image::data_url_from_bytes;
use std::collections::HashMap;
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum LocalMediaKind {
Audio,
Image,
}
impl LocalMediaKind {
fn name(self) -> &'static str {
match self {
Self::Audio => "audio",
Self::Image => "image",
}
}
}
fn local_media_error_placeholder(
path: &std::path::Path,
error: impl std::fmt::Display,
media_kind: LocalMediaKind,
) -> ContentItem {
let media_name = media_kind.name();
let path = path.display();
ContentItem::InputText {
text: format!("Codex could not read the local {media_name} at `{path}`: {error}"),
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LocalImagePreparation {
Process,
Defer,
}
fn unsupported_audio_error_placeholder(path: &std::path::Path) -> ContentItem {
ContentItem::InputText {
text: format!(
"Codex cannot attach audio at `{}`: unsupported audio format; use wav, mp3, m4a, webm, or ogg.",
path.display()
),
}
}
fn local_audio_content_items(
path: &std::path::Path,
file_bytes: &[u8],
label_number: usize,
) -> Vec<ContentItem> {
let Some(mime) = audio_mime_for_path(path) else {
return vec![unsupported_audio_error_placeholder(path)];
};
vec![
ContentItem::InputText {
text: local_audio_open_tag_text_with_path(label_number, path),
},
ContentItem::InputAudio {
audio: AudioReference::Inline {
audio_url: data_url_from_bytes(mime, file_bytes),
},
},
ContentItem::InputText {
text: audio_close_tag_text(),
},
]
}
pub fn from_user_input(
items: Vec<UserInput>,
local_image_preparation: LocalImagePreparation,
user_image_content_indices: &mut HashMap<usize, usize>,
) -> ResponseInputItem {
user_image_content_indices.clear();
let mut image_index = 0;
let mut audio_index = 0;
let mut content = Vec::new();
for (input_index, input) in items.into_iter().enumerate() {
let generated = match input {
UserInput::Text { text, .. } => vec![ContentItem::InputText { text }],
UserInput::Image { image, detail, .. } => {
image_index += 1;
let detail = detail.unwrap_or(DEFAULT_IMAGE_DETAIL);
vec![ContentItem::InputImage {
image,
detail: Some(detail),
}]
}
UserInput::LocalImage { path, detail, .. } => {
image_index += 1;
let detail = detail.unwrap_or(DEFAULT_IMAGE_DETAIL);
match std::fs::read(&path) {
Ok(file_bytes) => match local_image_preparation {
LocalImagePreparation::Process => {
local_image_content_items_with_label_number(
&path,
file_bytes,
Some(image_index),
detail,
)
}
LocalImagePreparation::Defer => local_image_content_items(
&path,
data_url_from_bytes("application/octet-stream", &file_bytes),
Some(image_index),
detail,
),
},
Err(err) => vec![local_media_error_placeholder(
&path,
err,
LocalMediaKind::Image,
)],
}
}
UserInput::Audio { audio } => {
audio_index += 1;
vec![ContentItem::InputAudio { audio }]
}
UserInput::LocalAudio { path } => {
audio_index += 1;
match std::fs::read(&path) {
Ok(file_bytes) => local_audio_content_items(&path, &file_bytes, audio_index),
Err(err) => vec![local_media_error_placeholder(
&path,
err,
LocalMediaKind::Audio,
)],
}
}
_ => Vec::new(), // Skills and mentions are injected later in core.
};
// Local images add framing text, while mentions and skills add no content.
// Capture the image's actual slot before preparation replaces its reference.
for (offset, item) in generated.iter().enumerate() {
if matches!(item, ContentItem::InputImage { .. }) {
user_image_content_indices.insert(input_index, content.len() + offset);
}
}
content.extend(generated);
}
ResponseInputItem::Message {
role: "user".to_string(),
content,
phase: None,
}
}
+537
View File
@@ -0,0 +1,537 @@
#![cfg(test)]
use crate::LocalImagePreparation;
use crate::from_user_input;
use anyhow::Result;
use codex_protocol::models::AudioReference;
use codex_protocol::models::ContentItem;
use codex_protocol::models::DEFAULT_IMAGE_DETAIL;
use codex_protocol::models::ImageDetail;
use codex_protocol::models::ImageReference;
use codex_protocol::models::ResponseInputItem;
use codex_protocol::models::audio_close_tag_text;
use codex_protocol::models::image_close_tag_text;
use codex_protocol::models::local_audio_open_tag_text_with_path;
use codex_protocol::models::local_image_open_tag_text_with_path;
use codex_protocol::user_input::UserInput;
use codex_utils_image::data_url_from_bytes;
use pretty_assertions::assert_eq;
use std::collections::HashMap;
use std::path::PathBuf;
use tempfile::tempdir;
// A tiny valid PNG (1x1) so image conversion tests don't depend on cross-crate
// file paths, which break under Bazel sandboxing.
const TINY_PNG_BYTES: &[u8] = &[
137, 80, 78, 71, 13, 10, 26, 10, 0, 0, 0, 13, 73, 72, 68, 82, 0, 0, 0, 1, 0, 0, 0, 1, 8, 6, 0,
0, 0, 31, 21, 196, 137, 0, 0, 0, 11, 73, 68, 65, 84, 120, 156, 99, 96, 0, 2, 0, 0, 5, 0, 1,
122, 94, 171, 63, 0, 0, 0, 0, 73, 69, 78, 68, 174, 66, 96, 130,
];
fn user_message(items: Vec<UserInput>) -> ResponseInputItem {
from_user_input(items, LocalImagePreparation::Process, &mut HashMap::new())
}
#[test]
fn serializes_image_user_input_without_tags() -> Result<()> {
let image_url = "data:image/png;base64,abc".to_string();
let item = user_message(vec![UserInput::Image {
image: ImageReference::Inline {
image_url: image_url.clone(),
},
detail: None,
}]);
match item {
ResponseInputItem::Message { content, .. } => {
let expected = vec![ContentItem::InputImage {
image: ImageReference::Inline { image_url },
detail: Some(DEFAULT_IMAGE_DETAIL),
}];
assert_eq!(content, expected);
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
/// A file-backed user image must reach the Responses API without being resolved by Core.
#[test]
fn file_image_user_input_serializes_file_id() -> Result<()> {
let file_id = "file_123".to_string();
let item = user_message(vec![UserInput::Image {
image: ImageReference::File {
file_id: file_id.clone(),
},
detail: None,
}]);
let expected = ResponseInputItem::Message {
role: "user".to_string(),
content: vec![ContentItem::InputImage {
image: ImageReference::File { file_id },
detail: Some(DEFAULT_IMAGE_DETAIL),
}],
phase: None,
};
assert_eq!(item, expected);
assert_eq!(
serde_json::to_value(item)?,
serde_json::json!({
"type": "message",
"role": "user",
"content": [{
"type": "input_image",
"file_id": "file_123",
"detail": "high"
}]
})
);
Ok(())
}
#[test]
fn serializes_audio_user_input_without_tags() -> Result<()> {
for (audio, wire) in [
(
AudioReference::Inline {
audio_url: "data:audio/wav;base64,abc".into(),
},
serde_json::json!({"type": "input_audio", "audio_url": "data:audio/wav;base64,abc"}),
),
(
AudioReference::File {
file_id: "file_audio".into(),
},
serde_json::json!({"type": "input_audio", "file_id": "file_audio"}),
),
] {
let input = UserInput::Audio {
audio: audio.clone(),
};
assert_eq!(
serde_json::from_value::<UserInput>(serde_json::to_value(&input)?)?,
input
);
let item = user_message(vec![input]);
assert_eq!(
item,
ResponseInputItem::Message {
role: "user".into(),
content: vec![ContentItem::InputAudio { audio }],
phase: None,
}
);
assert_eq!(
serde_json::to_value(&item)?,
serde_json::json!({
"type": "message", "role": "user", "content": [wire],
})
);
assert_eq!(
serde_json::from_value::<ResponseInputItem>(serde_json::to_value(&item)?)?,
item
);
}
Ok(())
}
#[test]
fn serializes_local_audio_user_input_with_label_and_data_url() -> Result<()> {
let temp_dir = tempdir()?;
for (extension, mime) in [
("wav", "audio/wav"),
("mp3", "audio/mpeg"),
("m4a", "audio/mp4"),
("webm", "audio/webm"),
("ogg", "audio/ogg"),
] {
let audio_path = temp_dir.path().join(format!("sample.{extension}"));
std::fs::write(&audio_path, b"audio")?;
let item = user_message(vec![UserInput::LocalAudio {
path: audio_path.clone(),
}]);
assert_eq!(
item,
ResponseInputItem::Message {
role: "user".to_string(),
content: vec![
ContentItem::InputText {
text: local_audio_open_tag_text_with_path(
/*label_number*/ 1,
&audio_path,
),
},
ContentItem::InputAudio {
audio: AudioReference::Inline {
audio_url: format!("data:{mime};base64,YXVkaW8=")
},
},
ContentItem::InputText {
text: audio_close_tag_text(),
},
],
phase: None,
}
);
}
Ok(())
}
#[test]
fn replaces_unsupported_local_audio_format_with_placeholder() -> Result<()> {
let temp_dir = tempdir()?;
let audio_path = temp_dir.path().join("sample.flac");
std::fs::write(&audio_path, b"audio")?;
let item = user_message(vec![UserInput::LocalAudio {
path: audio_path.clone(),
}]);
assert_eq!(
item,
ResponseInputItem::Message {
role: "user".to_string(),
content: vec![ContentItem::InputText {
text: format!(
"Codex cannot attach audio at `{}`: unsupported audio format; use wav, mp3, m4a, webm, or ogg.",
audio_path.display()
),
}],
phase: None,
}
);
Ok(())
}
#[test]
fn replaces_unreadable_local_audio_with_placeholder() {
let audio_path = PathBuf::from("missing.wav");
let item = user_message(vec![UserInput::LocalAudio { path: audio_path }]);
let ResponseInputItem::Message { content, .. } = item else {
panic!("expected message response");
};
let [ContentItem::InputText { text }] = content.as_slice() else {
panic!("expected local audio error placeholder");
};
assert!(
text.starts_with("Codex could not read the local audio at `missing.wav`: "),
"unexpected placeholder: {text}"
);
}
#[test]
fn image_user_input_preserves_requested_detail() -> Result<()> {
let image_url = "data:image/png;base64,abc".to_string();
let item = user_message(vec![UserInput::Image {
image: ImageReference::Inline {
image_url: image_url.clone(),
},
detail: Some(ImageDetail::Original),
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(
content.first(),
Some(&ContentItem::InputImage {
image: ImageReference::Inline { image_url },
detail: Some(ImageDetail::Original),
})
);
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
/// Image associations use original input and expanded content positions, so omitted inputs,
/// local-image framing, failed reads, and duplicate URLs cannot shift a later substitution.
#[test]
fn user_input_image_indices_survive_content_expansion() -> Result<()> {
let dir = tempdir()?;
let local_path = dir.path().join("local.png");
std::fs::write(&local_path, TINY_PNG_BYTES)?;
let inline_image = UserInput::Image {
image: ImageReference::Inline {
image_url: data_url_from_bytes("image/png", TINY_PNG_BYTES),
},
detail: None,
};
let inputs = vec![
UserInput::Text {
text: "compare images".to_string(),
text_elements: Vec::new(),
},
UserInput::Mention {
name: "app".to_string(),
path: "app://example".to_string(),
},
UserInput::Skill {
name: "skill".to_string(),
path: dir.path().join("SKILL.md"),
},
UserInput::LocalImage {
path: dir.path().join("missing.png"),
detail: None,
},
UserInput::LocalImage {
path: local_path,
detail: None,
},
inline_image.clone(),
inline_image,
];
for preparation in [LocalImagePreparation::Defer, LocalImagePreparation::Process] {
let mut indices = HashMap::new();
let item = from_user_input(inputs.clone(), preparation, &mut indices);
assert_eq!(indices, HashMap::from([(4, 3), (5, 5), (6, 6)]));
let ResponseInputItem::Message { content, .. } = item else {
panic!("expected a user message");
};
for content_index in indices.into_values() {
assert!(matches!(
content[content_index],
ContentItem::InputImage { .. }
));
}
}
Ok(())
}
#[test]
fn mixed_remote_and_local_images_share_label_sequence() -> Result<()> {
let image_url = "data:image/png;base64,abc".to_string();
let dir = tempdir()?;
let local_path = dir.path().join("local.png");
std::fs::write(&local_path, TINY_PNG_BYTES)?;
let item = user_message(vec![
UserInput::Image {
image: ImageReference::Inline {
image_url: image_url.clone(),
},
detail: None,
},
UserInput::LocalImage {
path: local_path.clone(),
detail: None,
},
]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(
content.first(),
Some(&ContentItem::InputImage {
image: ImageReference::Inline { image_url },
detail: Some(DEFAULT_IMAGE_DETAIL),
})
);
assert_eq!(
content.get(1),
Some(&ContentItem::InputText {
text: local_image_open_tag_text_with_path(/*label_number*/ 2, &local_path),
})
);
assert!(matches!(
content.get(2),
Some(ContentItem::InputImage { .. })
));
assert_eq!(
content.get(3),
Some(&ContentItem::InputText {
text: image_close_tag_text(),
})
);
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
#[test]
fn mixed_remote_and_local_audio_share_label_sequence() -> Result<()> {
let audio_url = "data:audio/wav;base64,abc".to_string();
let dir = tempdir()?;
let local_path = dir.path().join("local.mp3");
std::fs::write(&local_path, b"audio")?;
let item = user_message(vec![
UserInput::Audio {
audio: AudioReference::Inline {
audio_url: audio_url.clone(),
},
},
UserInput::LocalAudio {
path: local_path.clone(),
},
]);
assert_eq!(
item,
ResponseInputItem::Message {
role: "user".to_string(),
content: vec![
ContentItem::InputAudio {
audio: AudioReference::Inline { audio_url }
},
ContentItem::InputText {
text: local_audio_open_tag_text_with_path(/*label_number*/ 2, &local_path,),
},
ContentItem::InputAudio {
audio: AudioReference::Inline {
audio_url: "data:audio/mpeg;base64,YXVkaW8=".to_string()
}
},
ContentItem::InputText {
text: audio_close_tag_text(),
},
],
phase: None,
}
);
Ok(())
}
#[test]
fn local_image_user_input_preserves_requested_detail() -> Result<()> {
let dir = tempdir()?;
let local_path = dir.path().join("local.png");
std::fs::write(&local_path, TINY_PNG_BYTES)?;
let item = user_message(vec![UserInput::LocalImage {
path: local_path,
detail: Some(ImageDetail::Original),
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert!(matches!(
content.get(1),
Some(ContentItem::InputImage {
detail: Some(ImageDetail::Original),
..
})
));
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
#[test]
fn local_image_read_error_adds_placeholder() -> Result<()> {
let dir = tempdir()?;
let missing_path = dir.path().join("missing-image.png");
let item = user_message(vec![UserInput::LocalImage {
path: missing_path.clone(),
detail: None,
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(content.len(), 1);
match &content[0] {
ContentItem::InputText { text } => {
let display_path = missing_path.display().to_string();
assert!(
text.contains(&display_path),
"placeholder should mention missing path: {text}"
);
assert!(
text.contains("could not read"),
"placeholder should mention read issue: {text}"
);
}
other => panic!("expected placeholder text but found {other:?}"),
}
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
#[test]
fn local_image_non_image_adds_placeholder() -> Result<()> {
let dir = tempdir()?;
let json_path = dir.path().join("example.json");
std::fs::write(&json_path, br#"{"hello":"world"}"#)?;
let item = user_message(vec![UserInput::LocalImage {
path: json_path.clone(),
detail: None,
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(content.len(), 1);
match &content[0] {
ContentItem::InputText { text } => {
assert!(
text.contains("unsupported image `application/json`"),
"placeholder should mention unsupported image MIME: {text}"
);
assert!(
text.contains(&json_path.display().to_string()),
"placeholder should mention path: {text}"
);
}
other => panic!("expected placeholder text but found {other:?}"),
}
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}
#[test]
fn local_image_unsupported_image_format_adds_placeholder() -> Result<()> {
let dir = tempdir()?;
let svg_path = dir.path().join("example.svg");
std::fs::write(
&svg_path,
br#"<?xml version="1.0" encoding="UTF-8"?>
<svg xmlns="http://www.w3.org/2000/svg" width="1" height="1"></svg>"#,
)?;
let item = user_message(vec![UserInput::LocalImage {
path: svg_path.clone(),
detail: None,
}]);
match item {
ResponseInputItem::Message { content, .. } => {
assert_eq!(content.len(), 1);
let expected = format!(
"Codex cannot attach image at `{}`: unsupported image `image/svg+xml`.",
svg_path.display()
);
match &content[0] {
ContentItem::InputText { text } => assert_eq!(text, &expected),
other => panic!("expected placeholder text but found {other:?}"),
}
}
other => panic!("expected message response but got {other:?}"),
}
Ok(())
}