//! Utilities for truncating large chunks of output while preserving a prefix //! and suffix on UTF-8 boundaries, and helpers for line/token‑based truncation //! used across the core crate. use codex_protocol::models::FunctionCallOutputContentItem; use codex_protocol::openai_models::TruncationMode; use codex_protocol::openai_models::TruncationPolicyConfig; use codex_protocol::protocol::TruncationPolicy as ProtocolTruncationPolicy; const APPROX_BYTES_PER_TOKEN: usize = 4; #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum TruncationPolicy { Bytes(usize), Tokens(usize), } impl From for ProtocolTruncationPolicy { fn from(value: TruncationPolicy) -> Self { match value { TruncationPolicy::Bytes(bytes) => Self::Bytes(bytes), TruncationPolicy::Tokens(tokens) => Self::Tokens(tokens), } } } impl From for TruncationPolicy { fn from(config: TruncationPolicyConfig) -> Self { match config.mode { TruncationMode::Bytes => Self::Bytes(config.limit as usize), TruncationMode::Tokens => Self::Tokens(config.limit as usize), } } } impl TruncationPolicy { /// Returns a token budget derived from this policy. /// /// - For `Tokens`, this is the explicit token limit. /// - For `Bytes`, this is an approximate token budget using the global /// bytes-per-token heuristic. pub fn token_budget(&self) -> usize { match self { TruncationPolicy::Bytes(bytes) => { usize::try_from(approx_tokens_from_byte_count(*bytes)).unwrap_or(usize::MAX) } TruncationPolicy::Tokens(tokens) => *tokens, } } /// Returns a byte budget derived from this policy. /// /// - For `Bytes`, this is the explicit byte limit. /// - For `Tokens`, this is an approximate byte budget using the global /// bytes-per-token heuristic. pub fn byte_budget(&self) -> usize { match self { TruncationPolicy::Bytes(bytes) => *bytes, TruncationPolicy::Tokens(tokens) => approx_bytes_for_tokens(*tokens), } } } impl std::ops::Mul for TruncationPolicy { type Output = Self; fn mul(self, multiplier: f64) -> Self::Output { match self { TruncationPolicy::Bytes(bytes) => { TruncationPolicy::Bytes((bytes as f64 * multiplier).ceil() as usize) } TruncationPolicy::Tokens(tokens) => { TruncationPolicy::Tokens((tokens as f64 * multiplier).ceil() as usize) } } } } pub(crate) fn formatted_truncate_text(content: &str, policy: TruncationPolicy) -> String { if content.len() <= policy.byte_budget() { return content.to_string(); } let total_lines = content.lines().count(); let result = truncate_text(content, policy); format!("Total output lines: {total_lines}\n\n{result}") } pub(crate) fn truncate_text(content: &str, policy: TruncationPolicy) -> String { match policy { TruncationPolicy::Bytes(_) => truncate_with_byte_estimate(content, policy), TruncationPolicy::Tokens(_) => { let (truncated, _) = truncate_with_token_budget(content, policy); truncated } } } pub(crate) fn formatted_truncate_text_content_items_with_policy( items: &[FunctionCallOutputContentItem], policy: TruncationPolicy, ) -> (Vec, Option) { let text_segments = items .iter() .filter_map(|item| match item { FunctionCallOutputContentItem::InputText { text } => Some(text.as_str()), FunctionCallOutputContentItem::InputImage { .. } => None, }) .collect::>(); if text_segments.is_empty() { return (items.to_vec(), None); } let mut combined = String::new(); for text in &text_segments { if !combined.is_empty() { combined.push('\n'); } combined.push_str(text); } if combined.len() <= policy.byte_budget() { return (items.to_vec(), None); } let mut out = vec![FunctionCallOutputContentItem::InputText { text: formatted_truncate_text(&combined, policy), }]; out.extend(items.iter().filter_map(|item| match item { FunctionCallOutputContentItem::InputImage { image_url, detail } => { Some(FunctionCallOutputContentItem::InputImage { image_url: image_url.clone(), detail: *detail, }) } FunctionCallOutputContentItem::InputText { .. } => None, })); (out, Some(approx_token_count(&combined))) } /// Globally truncate function output items to fit within the given /// truncation policy's budget, preserving as many text/image items as /// possible and appending a summary for any omitted text items. pub(crate) fn truncate_function_output_items_with_policy( items: &[FunctionCallOutputContentItem], policy: TruncationPolicy, ) -> Vec { let mut out: Vec = Vec::with_capacity(items.len()); let mut remaining_budget = match policy { TruncationPolicy::Bytes(_) => policy.byte_budget(), TruncationPolicy::Tokens(_) => policy.token_budget(), }; let mut omitted_text_items = 0usize; for it in items { match it { FunctionCallOutputContentItem::InputText { text } => { if remaining_budget == 0 { omitted_text_items += 1; continue; } let cost = match policy { TruncationPolicy::Bytes(_) => text.len(), TruncationPolicy::Tokens(_) => approx_token_count(text), }; if cost <= remaining_budget { out.push(FunctionCallOutputContentItem::InputText { text: text.clone() }); remaining_budget = remaining_budget.saturating_sub(cost); } else { let snippet_policy = match policy { TruncationPolicy::Bytes(_) => TruncationPolicy::Bytes(remaining_budget), TruncationPolicy::Tokens(_) => TruncationPolicy::Tokens(remaining_budget), }; let snippet = truncate_text(text, snippet_policy); if snippet.is_empty() { omitted_text_items += 1; } else { out.push(FunctionCallOutputContentItem::InputText { text: snippet }); } remaining_budget = 0; } } FunctionCallOutputContentItem::InputImage { image_url, detail } => { out.push(FunctionCallOutputContentItem::InputImage { image_url: image_url.clone(), detail: *detail, }); } } } if omitted_text_items > 0 { out.push(FunctionCallOutputContentItem::InputText { text: format!("[omitted {omitted_text_items} text items ...]"), }); } out } /// Truncate the middle of a UTF-8 string to at most `max_tokens` tokens, /// preserving the beginning and the end. Returns the possibly truncated string /// and `Some(original_token_count)` if truncation occurred; otherwise returns /// the original string and `None`. fn truncate_with_token_budget(s: &str, policy: TruncationPolicy) -> (String, Option) { if s.is_empty() { return (String::new(), None); } let max_tokens = policy.token_budget(); let byte_len = s.len(); if max_tokens > 0 && byte_len <= approx_bytes_for_tokens(max_tokens) { return (s.to_string(), None); } let truncated = truncate_with_byte_estimate(s, policy); let approx_total_usize = approx_token_count(s); let approx_total = u64::try_from(approx_total_usize).unwrap_or(u64::MAX); if truncated == s { (truncated, None) } else { (truncated, Some(approx_total)) } } /// Truncate a string using a byte budget derived from the token budget, without /// performing any real tokenization. This keeps the logic purely byte-based and /// uses a bytes placeholder in the truncated output. fn truncate_with_byte_estimate(s: &str, policy: TruncationPolicy) -> String { if s.is_empty() { return String::new(); } let total_chars = s.chars().count(); let max_bytes = policy.byte_budget(); if max_bytes == 0 { // No budget to show content; just report that everything was truncated. let marker = format_truncation_marker( policy, removed_units_for_source(policy, s.len(), total_chars), ); return marker; } if s.len() <= max_bytes { return s.to_string(); } let total_bytes = s.len(); let (left_budget, right_budget) = split_budget(max_bytes); let (removed_chars, left, right) = split_string(s, left_budget, right_budget); let marker = format_truncation_marker( policy, removed_units_for_source(policy, total_bytes.saturating_sub(max_bytes), removed_chars), ); assemble_truncated_output(left, right, &marker) } fn split_string(s: &str, beginning_bytes: usize, end_bytes: usize) -> (usize, &str, &str) { if s.is_empty() { return (0, "", ""); } let len = s.len(); let tail_start_target = len.saturating_sub(end_bytes); let mut prefix_end = 0usize; let mut suffix_start = len; let mut removed_chars = 0usize; let mut suffix_started = false; for (idx, ch) in s.char_indices() { let char_end = idx + ch.len_utf8(); if char_end <= beginning_bytes { prefix_end = char_end; continue; } if idx >= tail_start_target { if !suffix_started { suffix_start = idx; suffix_started = true; } continue; } removed_chars = removed_chars.saturating_add(1); } if suffix_start < prefix_end { suffix_start = prefix_end; } let before = &s[..prefix_end]; let after = &s[suffix_start..]; (removed_chars, before, after) } fn format_truncation_marker(policy: TruncationPolicy, removed_count: u64) -> String { match policy { TruncationPolicy::Tokens(_) => format!("…{removed_count} tokens truncated…"), TruncationPolicy::Bytes(_) => format!("…{removed_count} chars truncated…"), } } fn split_budget(budget: usize) -> (usize, usize) { let left = budget / 2; (left, budget - left) } fn removed_units_for_source( policy: TruncationPolicy, removed_bytes: usize, removed_chars: usize, ) -> u64 { match policy { TruncationPolicy::Tokens(_) => approx_tokens_from_byte_count(removed_bytes), TruncationPolicy::Bytes(_) => u64::try_from(removed_chars).unwrap_or(u64::MAX), } } fn assemble_truncated_output(prefix: &str, suffix: &str, marker: &str) -> String { let mut out = String::with_capacity(prefix.len() + marker.len() + suffix.len() + 1); out.push_str(prefix); out.push_str(marker); out.push_str(suffix); out } pub(crate) fn approx_token_count(text: &str) -> usize { let len = text.len(); len.saturating_add(APPROX_BYTES_PER_TOKEN.saturating_sub(1)) / APPROX_BYTES_PER_TOKEN } pub(crate) fn approx_bytes_for_tokens(tokens: usize) -> usize { tokens.saturating_mul(APPROX_BYTES_PER_TOKEN) } pub(crate) fn approx_tokens_from_byte_count(bytes: usize) -> u64 { let bytes_u64 = bytes as u64; bytes_u64.saturating_add((APPROX_BYTES_PER_TOKEN as u64).saturating_sub(1)) / (APPROX_BYTES_PER_TOKEN as u64) } pub(crate) fn approx_tokens_from_byte_count_i64(bytes: i64) -> i64 { if bytes <= 0 { return 0; } let bytes = usize::try_from(bytes).unwrap_or(usize::MAX); i64::try_from(approx_tokens_from_byte_count(bytes)).unwrap_or(i64::MAX) } #[cfg(test)] #[path = "truncate_tests.rs"] mod tests;