codex/codex-rs/core/src/realtime_conversation_tests.rs

use super::AGENT_FINAL_MESSAGE_PREFIX;
use super::HANDOFF_STREAM_TRUNCATION_MARKER;
use super::RealtimeHandoffState;
use super::RealtimeInputTaskExit;
use super::RealtimeOutbound;
use super::RealtimePendingOutbound;
use super::RealtimeSessionKind;
use super::RealtimeStreamedItem;
use super::classify_realtime_input_error;
use super::classify_realtime_input_error_with_pending;
use super::prepare_realtime_start;
use super::realtime_delegation_from_handoff;
use super::realtime_request_headers;
use super::realtime_text_from_handoff_request;
use super::wrap_realtime_delegation_input;
use crate::context::RealtimeDelegationSource;
use async_channel::bounded;
use codex_api::ApiError;
use codex_api::RealtimeEventParser;
use codex_login::CodexAuth;
use codex_model_provider_info::ModelProviderInfo;
use codex_protocol::models::MessagePhase;
use codex_protocol::protocol::CodexResponseHandoffMode;
use codex_protocol::protocol::ConversationStartParams;
use codex_protocol::protocol::ConversationTextParams;
use codex_protocol::protocol::ConversationTextRole;
use codex_protocol::protocol::RealtimeConversationVersion;
use codex_protocol::protocol::RealtimeHandoffRequested;
use codex_protocol::protocol::RealtimeOutputModality;
use codex_protocol::protocol::RealtimeTranscriptEntry;
use pretty_assertions::assert_eq;
use std::collections::BTreeMap;
use std::sync::Arc;
use std::time::Instant;
use test_case::test_case;
use tokio::sync::Mutex;

#[tokio::test]
async fn prepared_realtime_routing_follows_selected_api_key_and_explicit_overrides() {
    for (api_key, base_url, realtime_base_url, expected_url, expected_fedramp_header) in [
        ("legacy-key", None, None, "https://api.openai.com/v1", None),
        (
            "sk-proj-fedramp-synthetic-test-key",
            None,
            None,
            "https://gov.api.openai.com/v1",
            Some("true"),
        ),
        (
            "sk-svcacct-fedramp-synthetic-test-key",
            None,
            None,
            "https://gov.api.openai.com/v1",
            Some("true"),
        ),
        (
            "sk-proj-fedramp-synthetic-test-key",
            Some("https://proxy.example/v1"),
            None,
            "https://proxy.example/v1",
            Some("true"),
        ),
        (
            "sk-svcacct-fedramp-synthetic-test-key",
            Some("https://proxy.example/v1"),
            Some("wss://realtime.example/v1"),
            "wss://realtime.example/v1",
            Some("true"),
        ),
    ] {
        let (sess, _turn, _events) =
            crate::session::tests::make_session_and_context_with_auth_and_config_and_rx(
                CodexAuth::from_api_key("sk-proj-fedramp-ambient-test-key"),
                Vec::new(),
                |config| {
                    config.model_provider = ModelProviderInfo {
                        experimental_bearer_token: Some(api_key.into()),
                        ..ModelProviderInfo::create_openai_provider(base_url.map(str::to_string))
                    };
                    config.experimental_realtime_ws_base_url =
                        realtime_base_url.map(str::to_string);
                },
            )
            .await;
        let prepared = prepare_realtime_start(
            &sess,
            ConversationStartParams {
                client_managed_handoffs: false,
                delegation_ack_filler: None,
                flush_transcript_tail_on_session_end: false,
                codex_responses_as_items: false,
                codex_response_item_prefix: None,
                codex_response_handoff_mode: CodexResponseHandoffMode::Thinking,
                backend_reasoning_status: false,
                codex_response_handoff_channel_prefixes: None,
                model: None,
                output_modality: RealtimeOutputModality::Audio,
                include_startup_context: false,
                initial_items: Vec::new(),
                realtime_start_instructions: None,
                realtime_end_instructions: None,
                prompt: None,
                realtime_session_id: None,
                voice_session_id: None,
                transport: None,
                version: Some(RealtimeConversationVersion::V1),
                voice: None,
            },
        )
        .await
        .expect("realtime startup should prepare without connecting");
        assert_eq!(prepared.api_provider.base_url, expected_url);
        let headers = prepared.extra_headers.expect("realtime request headers");
        assert_eq!(
            headers[http::header::AUTHORIZATION]
                .to_str()
                .expect("authorization should be ASCII"),
            format!("Bearer {api_key}")
        );
        assert_eq!(
            headers
                .get("X-OpenAI-Fedramp")
                .and_then(|value| value.to_str().ok()),
            expected_fedramp_header
        );
    }
}

/// Hold old input cleanup open while a successor tries to claim the connection.
#[tokio::test]
async fn natural_close_finishes_before_successor_and_ignores_old_identity() {
    use super::ConversationState;
    use super::RealtimeConversationEnd;
    use super::RealtimeHandoffAdmission;
    use codex_protocol::protocol::Event;
    use codex_protocol::protocol::EventMsg;
    use codex_protocol::protocol::RealtimeConversationStartedEvent;
    use codex_protocol::protocol::RealtimeConversationVersion;
    use std::sync::atomic::AtomicBool;
    use tokio::sync::oneshot;
    use tokio_util::sync::CancellationToken;

    let (sess, _turn, events) = crate::session::tests::make_session_and_context_with_rx().await;
    let old_identity = Arc::new(AtomicBool::new(true));
    let stop_token = CancellationToken::new();
    let input_stop = stop_token.clone();
    let (entered, cleaning_up) = oneshot::channel();
    let (release, released) = oneshot::channel();
    let input_task = tokio::spawn(async move {
        input_stop.cancelled().await;
        entered.send(()).unwrap();
        released.await.unwrap();
    });
    let handoff = RealtimeHandoffState {
        output_tx: bounded(1).0,
        last_output: Arc::new(Mutex::new(None)),
        stream: Arc::new(Mutex::new(Default::default())),
        client_managed_handoffs: false,
        codex_responses_as_items: false,
        codex_response_item_prefix: None,
        backend_reasoning_status: false,
        codex_response_handoff_mode: CodexResponseHandoffMode::Thinking,
        codex_response_handoff_channel_prefixes: Arc::new(BTreeMap::new()),
        session_kind: RealtimeSessionKind::V1,
        event_parser: RealtimeEventParser::V1,
    };
    let connection = |identity, input_task, stop_token, session: &str| ConversationState {
        session_id: Some(session.to_owned()),
        sub_id: session.to_owned(),
        audio_tx: bounded(1).0,
        text_tx: bounded(1).0,
        session_kind: RealtimeSessionKind::V1,
        handoff: handoff.clone(),
        input_task,
        fanout_task: None,
        realtime_active: identity,
        route_handoffs: Arc::new(RealtimeHandoffAdmission::new()),
        stop_token,
    };
    sess.conversation.state.lock().await.conversation = Some(connection(
        Arc::clone(&old_identity),
        input_task,
        stop_token,
        "A",
    ));
    let close = sess.conversation.finish_if_active(
        &sess,
        &old_identity,
        "A".to_owned(),
        RealtimeConversationEnd::TransportClosed,
    );
    tokio::pin!(close);
    assert!(futures::poll!(&mut close).is_pending());
    cleaning_up.await.unwrap();

    // This is the same state publication boundary used by start_inner.
    let successor = async {
        sess.conversation.state.lock().await.conversation = Some(connection(
            Arc::new(AtomicBool::new(true)),
            tokio::spawn(async {}),
            CancellationToken::new(),
            "B",
        ));
        sess.send_event_raw(Event {
            id: "B".to_owned(),
            msg: EventMsg::RealtimeConversationStarted(RealtimeConversationStartedEvent {
                realtime_session_id: Some("B".to_owned()),
                version: RealtimeConversationVersion::V3,
            }),
        })
        .await;
    };
    tokio::pin!(successor);
    assert!(futures::poll!(&mut successor).is_pending());
    release.send(()).unwrap();
    close.await;
    successor.await;
    sess.conversation
        .finish_if_active(
            &sess,
            &old_identity,
            "A".to_owned(),
            RealtimeConversationEnd::TransportClosed,
        )
        .await;
    let observed = std::iter::from_fn(|| events.try_recv().ok())
        .filter_map(|event| match event.msg {
            EventMsg::RealtimeConversationClosed(_) => Some((event.id, "closed")),
            EventMsg::RealtimeConversationStarted(_) => Some((event.id, "started")),
            _ => None,
        })
        .collect::<Vec<_>>();
    assert_eq!(
        observed,
        vec![("A".to_owned(), "closed"), ("B".to_owned(), "started")]
    );
    assert_eq!(
        sess.conversation
            .state
            .lock()
            .await
            .conversation
            .as_ref()
            .unwrap()
            .session_id
            .as_deref(),
        Some("B")
    );
    sess.conversation.shutdown().await.unwrap();
}

#[test]
fn prefers_handoff_input_transcript_over_active_transcript() {
    let handoff = RealtimeHandoffRequested {
        handoff_id: "handoff_1".to_string(),
        item_id: "item_1".to_string(),
        input_transcript: "ignored".to_string(),
        active_transcript: vec![
            RealtimeTranscriptEntry {
                role: "user".to_string(),
                text: "hello".to_string(),
            },
            RealtimeTranscriptEntry {
                role: "assistant".to_string(),
                text: "hi there".to_string(),
            },
        ],
    };
    assert_eq!(
        realtime_text_from_handoff_request(&handoff),
        Some("ignored".to_string())
    );
}

#[test]
fn extracts_text_from_handoff_request_active_transcript_if_input_missing() {
    let handoff = RealtimeHandoffRequested {
        handoff_id: "handoff_1".to_string(),
        item_id: "item_1".to_string(),
        input_transcript: String::new(),
        active_transcript: vec![RealtimeTranscriptEntry {
            role: "user".to_string(),
            text: "hello".to_string(),
        }],
    };
    assert_eq!(
        realtime_text_from_handoff_request(&handoff),
        Some("user: hello".to_string())
    );
}

#[test]
fn wraps_handoff_with_transcript_delta() {
    let handoff = RealtimeHandoffRequested {
        handoff_id: "handoff_1".to_string(),
        item_id: "item_1".to_string(),
        input_transcript: "delegate this".to_string(),
        active_transcript: vec![
            RealtimeTranscriptEntry {
                role: "user".to_string(),
                text: "hello".to_string(),
            },
            RealtimeTranscriptEntry {
                role: "assistant".to_string(),
                text: "hi there".to_string(),
            },
        ],
    };
    assert_eq!(
        realtime_delegation_from_handoff(&handoff),
        Some(
            "<realtime_delegation>\n  <input>delegate this</input>\n  <transcript_delta>user: hello\nassistant: hi there</transcript_delta>\n</realtime_delegation>"
                .to_string()
        )
    );
}

#[test]
fn extracts_text_from_handoff_request_input_transcript_if_messages_missing() {
    let handoff = RealtimeHandoffRequested {
        handoff_id: "handoff_1".to_string(),
        item_id: "item_1".to_string(),
        input_transcript: "ignored".to_string(),
        active_transcript: vec![],
    };
    assert_eq!(
        realtime_text_from_handoff_request(&handoff),
        Some("ignored".to_string())
    );
}

#[test]
fn ignores_empty_handoff_request_input_transcript() {
    let handoff = RealtimeHandoffRequested {
        handoff_id: "handoff_1".to_string(),
        item_id: "item_1".to_string(),
        input_transcript: String::new(),
        active_transcript: vec![],
    };
    assert_eq!(realtime_text_from_handoff_request(&handoff), None);
}

#[test]
fn wraps_realtime_delegation_input() {
    assert_eq!(
        wrap_realtime_delegation_input(
            "hello",
            /*transcript_delta*/ None,
            RealtimeDelegationSource::Handoff,
        ),
        "<realtime_delegation>\n  <input>hello</input>\n</realtime_delegation>"
    );
}

#[test]
fn wraps_realtime_delegation_input_with_xml_escaping() {
    assert_eq!(
        wrap_realtime_delegation_input(
            "use a < b && c > d",
            Some("saw <that>"),
            RealtimeDelegationSource::Handoff,
        ),
        "<realtime_delegation>\n  <input>use a &lt; b &amp;&amp; c &gt; d</input>\n  <transcript_delta>saw &lt;that&gt;</transcript_delta>\n</realtime_delegation>"
    );
}

#[test]
fn wraps_realtime_delegation_input_with_xml_escaping_without_transcript() {
    assert_eq!(
        wrap_realtime_delegation_input(
            "use a < b && c > d",
            /*transcript_delta*/ None,
            RealtimeDelegationSource::Handoff,
        ),
        "<realtime_delegation>\n  <input>use a &lt; b &amp;&amp; c &gt; d</input>\n</realtime_delegation>"
    );
}

#[test]
fn bounds_realtime_delegation_fields_and_keeps_latest_transcript() {
    let input = format!("start{}input-end", "x".repeat(8 * 1024));
    let transcript = format!("transcript-start{}latest", "y".repeat(8 * 1024));
    let rendered = wrap_realtime_delegation_input(
        &input,
        Some(&transcript),
        RealtimeDelegationSource::Handoff,
    );

    assert!(rendered.len() < 9 * 1024);
    assert!(rendered.contains("<input>start"));
    assert!(!rendered.contains("input-end"));
    assert!(!rendered.contains("transcript-start"));
    assert!(rendered.contains("latest</transcript_delta>"));
}

#[test]
fn classifies_outbound_api_failures_as_transport_loss() {
    for pending_outbound in [
        RealtimePendingOutbound::Text(ConversationTextParams {
            text: "retry me".to_string(),
            role: ConversationTextRole::User,
        }),
        RealtimePendingOutbound::Handoff(RealtimeOutbound::StandaloneHandoff {
            text: "retry this handoff".to_string(),
            phase: Some(MessagePhase::FinalAnswer),
        }),
    ] {
        let exit = classify_realtime_input_error_with_pending(
            ApiError::Stream("failed to send realtime request".to_string()).into(),
            Some(Box::new(pending_outbound.clone())),
        );
        let RealtimeInputTaskExit::TransportLost {
            err: ApiError::Stream(_),
            pending_outbound: Some(actual_pending_outbound),
        } = exit
        else {
            panic!("outbound API failure should preserve pending output for reconnect");
        };
        assert_eq!(*actual_pending_outbound, pending_outbound);
    }

    assert!(matches!(
        classify_realtime_input_error(anyhow::anyhow!("input channel closed")),
        RealtimeInputTaskExit::Terminal
    ));
}

#[tokio::test]
async fn clears_active_handoff_explicitly() {
    let (tx, _rx) = bounded(1);
    let state = RealtimeHandoffState {
        output_tx: tx,
        last_output: Arc::new(Mutex::new(None)),
        stream: Arc::new(Mutex::new(Default::default())),
        client_managed_handoffs: false,
        codex_responses_as_items: false,
        codex_response_item_prefix: None,
        backend_reasoning_status: false,
        codex_response_handoff_mode: CodexResponseHandoffMode::Thinking,
        codex_response_handoff_channel_prefixes: Arc::new(BTreeMap::new()),
        session_kind: RealtimeSessionKind::V1,
        event_parser: RealtimeEventParser::V1,
    };

    state.stream.lock().await.active_handoff = Some("handoff_1".to_string());
    assert_eq!(
        state.stream.lock().await.active_handoff.clone(),
        Some("handoff_1".to_string())
    );

    state.stream.lock().await.active_handoff = None;
    assert_eq!(state.stream.lock().await.active_handoff.clone(), None);
}

#[test_case(None, true; "legacy")]
#[test_case(Some(MessagePhase::FinalAnswer), true; "final_answer")]
#[test_case(Some(MessagePhase::Commentary), false; "commentary")]
#[test_case(Some(MessagePhase::PartialAnswer), false; "partial_answer")]
fn streamed_handoff_preserves_a_bounded_final_tail(
    phase: Option<MessagePhase>,
    expect_final_prefix: bool,
) {
    let mut item = RealtimeStreamedItem {
        handoff_id: "handoff_1".to_string(),
        phase,
        bem_channel_parser: None,
        prefix_final_message: true,
        sent_bytes: 0,
        buffered_text: String::new(),
        tail_text: String::new(),
        truncated: false,
        last_flush_at: Instant::now(),
        flush_scheduled: false,
    };
    item.push_text(&format!("HEAD{}TAIL", "x".repeat(/*n*/ 5_000)));

    let first = item
        .drain_stream_chunk()
        .expect("oversized output should retain a streamable head");
    let final_chunk = item
        .drain_final_chunk()
        .expect("oversized output should retain a final tail");
    let output = format!("{first}{final_chunk}");

    assert!(output.len() <= 4_000);
    let prefix = if expect_final_prefix {
        AGENT_FINAL_MESSAGE_PREFIX
    } else {
        ""
    };
    assert!(output.starts_with(&format!("{prefix}HEAD")));
    assert!(output.contains(HANDOFF_STREAM_TRUNCATION_MARKER));
    assert!(output.ends_with("TAIL"));
}

#[test]
fn streamed_v3_handoff_omits_the_final_message_prefix() {
    let mut item = RealtimeStreamedItem {
        handoff_id: "handoff_1".to_string(),
        phase: Some(MessagePhase::FinalAnswer),
        bem_channel_parser: None,
        prefix_final_message: false,
        sent_bytes: 0,
        buffered_text: String::new(),
        tail_text: String::new(),
        truncated: false,
        last_flush_at: Instant::now(),
        flush_scheduled: false,
    };
    item.push_text("done");

    assert_eq!(item.drain_final_chunk(), Some("done".to_string()));
}

#[test]
fn uses_quicksilver_alpha_header_for_realtime_v1() {
    let headers = realtime_request_headers(
        Some("session_1"),
        /*voice_session_id*/ None,
        Some("sk-test"),
        RealtimeEventParser::V1,
        "codex_work_desktop",
    )
    .expect("headers")
    .expect("headers");

    assert_eq!(
        headers
            .get("openai-alpha")
            .and_then(|value| value.to_str().ok()),
        Some("quicksilver=v1")
    );
}

#[test]
fn omits_quicksilver_alpha_header_for_realtime_v2() {
    let headers = realtime_request_headers(
        Some("session_1"),
        /*voice_session_id*/ None,
        Some("sk-test"),
        RealtimeEventParser::RealtimeV2,
        "codex_work_desktop",
    )
    .expect("headers")
    .expect("headers");

    assert!(headers.get("openai-alpha").is_none());
}

#[test]
fn uses_frameless_alpha_header_for_realtime_v3() {
    let headers = realtime_request_headers(
        Some("session_1"),
        /*voice_session_id*/ None,
        Some("sk-test"),
        RealtimeEventParser::FramelessBidi,
        "codex_work_desktop",
    )
    .expect("headers")
    .expect("headers");

    assert_eq!(
        headers
            .get("openai-alpha")
            .and_then(|value| value.to_str().ok()),
        Some("quicksilver=v2")
    );
}

#[test]
fn realtime_headers_include_only_non_default_originator() {
    let default_originator = codex_login::default_client::originator();
    for (originator, expected_header) in [
        ("codex_work_desktop", Some("codex_work_desktop")),
        (default_originator.value.as_str(), None),
    ] {
        let headers = realtime_request_headers(
            Some("session_1"),
            /*voice_session_id*/ None,
            Some("sk-test"),
            RealtimeEventParser::RealtimeV2,
            originator,
        )
        .expect("headers")
        .expect("headers");

        assert_eq!(
            headers
                .get("originator")
                .and_then(|value| value.to_str().ok()),
            expected_header
        );
    }
}

#[test]
fn realtime_headers_keep_realtime_and_voice_session_ids_distinct() {
    let headers = realtime_request_headers(
        Some("realtime_session_1"),
        Some("voice_session_1"),
        /*api_key*/ None,
        RealtimeEventParser::RealtimeV2,
        "codex_work_desktop",
    )
    .expect("headers")
    .expect("headers");

    assert!(!headers.contains_key(http::header::AUTHORIZATION));
    assert!(!headers.contains_key("X-OpenAI-Fedramp"));
    assert_eq!(
        headers
            .get("x-session-id")
            .and_then(|value| value.to_str().ok()),
        Some("realtime_session_1")
    );
    assert_eq!(
        headers
            .get("voice-session-id")
            .and_then(|value| value.to_str().ok()),
        Some("voice_session_1")
    );
}