Skip to main content

switchyard_llm_client/
run.rs

1// SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2// SPDX-License-Identifier: Apache-2.0
3
4//! Drive a libsy algorithm to completion, making the model calls it offloads.
5//!
6//! [`switchyard_libsy::Algorithm::run_stream`] is the whole libsy API: it yields a stream of
7//! steps and expects its consumer to serve every offloaded model call. [`run()`] is that
8//! consumer — it drives the stream with [`switchyard_libsy::drive`], hands routing-time calls to
9//! a [`RoutedLlmClient`], and serves the terminal routing outcome.
10//!
11//! libsy owns the stream mechanics; what this module adds is per-target request preparation,
12//! ordered candidate fallback, and the `libsy.client_call` span around each candidate. Each
13//! completion candidate exhausts its backend retry budget before fallback advances. Routing
14//! calls stop on the first candidate's failure unless the algorithm enables error recovery.
15//! A timeout stops completion calls.
16//!
17//! A Responses continuation can refer to state through `previous_response_id` or `conversation`.
18//! [`ClientRouter`] sends native Responses state back to its provider; for Chat or Anthropic
19//! targets it retains the canonical history needed to materialize the continuation.
20
21use std::collections::{HashMap, HashSet};
22use std::sync::Arc;
23use std::time::Instant;
24
25use futures::{StreamExt, TryStreamExt, stream};
26use http::StatusCode;
27use parking_lot::Mutex;
28use serde_json::{Value, json};
29use switchyard_libsy::{
30    Algorithm, AnswerSummary, Call, CallDecision, LibsyError, OutcomeMetadata, Result,
31    RoutingOutcome, RuntimeModels, drive,
32};
33use switchyard_protocol::{
34    AggLlmResponse, LlmClientError, LlmResponse, LlmResponseChunk, LlmResponseStream, Message,
35    ModelId, Request, Response, ResponseAccumulator, RoutedDecisionClient, RoutedLlmClient,
36    RoutingFallbackReason, Usage, WireFormat,
37};
38use switchyard_translation::prepare_request_for_target;
39
40use crate::observation::{ModelCallObservation, RunObservation, RunObserver};
41use crate::{metrics, observability};
42
43/// Run one request to completion, serving every offloaded model call with `client`.
44///
45/// Returns the model selected by the algorithm and the final [`Response`]. `observer`, when
46/// present, receives metadata for the routing outcome, each completed routing or answer call,
47/// and the routing overhead.
48///
49/// `clients` resolves each offloaded call to the client for the target the algorithm
50/// selected — an algorithm may route among targets served by different providers, so this is
51/// a per-call lookup, not one client for the whole run. Use
52/// [`ClientRouter::single`](ClientRouter::single) when one client serves every target.
53///
54/// Routing calls are buffered; client failures stop the request unless the call enables recovery.
55/// Once routing completes, non-timeout failures may try the outcome's ordered fallback candidates.
56pub async fn run(
57    algorithm: Arc<dyn Algorithm>,
58    clients: ClientRouter,
59    request: Request,
60    models: Arc<RuntimeModels>,
61    observer: Option<RunObserver>,
62) -> Result<(ModelId, Response)> {
63    let algorithm_name = algorithm.name().to_string();
64    let run_started = Instant::now();
65    let routing_clients = clients.clone();
66    // This says if we have an observer, put Some(..) in routing_observations.
67    // No observer means we don't want any routing_observations.
68    let routing_observations = observer.as_ref().map(|_| Arc::new(Mutex::new(Vec::new())));
69    let outcome = match clients.stored_state_owner(&request) {
70        Some(owner) => Ok(continue_on(owner, &algorithm_name, request)),
71        None => {
72            drive(Arc::clone(&algorithm), request, models, {
73                let routing_observations = routing_observations.clone();
74                move |call| serve(routing_clients.clone(), call, routing_observations.clone())
75            })
76            .await
77        }
78    };
79    let answered_model = outcome
80        .as_ref()
81        .ok()
82        .and_then(|outcome| outcome.response.as_ref())
83        .and_then(Response::served_model);
84    emit_routing_observations(&observer, &routing_observations, answered_model);
85    let outcome = outcome?;
86    let overhead = run_started.elapsed();
87    metrics::record_routing_overhead(&algorithm_name, overhead);
88
89    let selected_model_id = outcome.selected_model_id()?.clone();
90    if let Some(observer) = &observer
91        && let Some(metadata) = outcome.metadata
92    {
93        observer(RunObservation::Outcome(metadata));
94    }
95    let result = if let Some(response) = outcome.response {
96        let result = clients.remember_state_owner(&outcome.request, response);
97        let served_model = result
98            .as_ref()
99            .ok()
100            .and_then(Response::served_model)
101            .unwrap_or(&selected_model_id);
102        let served_model = clients.provider_model(served_model).clone();
103        metrics::observe_routed_request(&algorithm_name, &served_model, None, result)
104    } else {
105        let observe = |observation| {
106            if let Some(observer) = &observer {
107                observer(RunObservation::AnswerCall(observation));
108            }
109        };
110        call_first_available(
111            &clients,
112            &algorithm_name,
113            &outcome.request,
114            outcome.fallback_request.as_ref(),
115            &outcome.candidate_requests,
116            &outcome.selected_model_ids,
117            &observe,
118        )
119        .await
120        .and_then(|(request, response)| clients.remember_state_owner(request, response))
121    };
122    if let Some(observer) = &observer {
123        observer(RunObservation::RoutingOverhead(overhead));
124    }
125    let mut response = result?;
126    if algorithm.tracks_answers()
127        && let Some(session) = session_id(&outcome.request)
128    {
129        response = report_answer(algorithm, session, response).await;
130    }
131    Ok((selected_model_id, response))
132}
133
134fn session_id(request: &Request) -> Option<String> {
135    let session = request.metadata.as_ref()?.session_id.as_deref()?;
136    (!session.is_empty()).then(|| session.to_string())
137}
138
139/// Reports the served answer to the algorithm; a stream reports it before its final chunk
140/// so the client cannot send its next request first.
141async fn report_answer(
142    algorithm: Arc<dyn Algorithm>,
143    session: String,
144    mut response: Response,
145) -> Response {
146    let stream = match response.llm_response {
147        LlmResponse::Agg(aggregate) => {
148            algorithm
149                .observe_answer(&session, AnswerSummary::of(&aggregate))
150                .await;
151            response.llm_response = LlmResponse::Agg(aggregate);
152            return response;
153        }
154        LlmResponse::Stream(stream) => stream,
155    };
156    algorithm
157        .observe_answer(&session, AnswerSummary { final_reply: false })
158        .await;
159    let report = (algorithm, session, Some(ResponseAccumulator::new()));
160    response.llm_response = LlmResponse::Stream(Box::pin(stream::unfold(
161        (stream, report),
162        |(mut stream, (algorithm, session, mut accumulator))| async move {
163            let item = stream.next().await?;
164            let failed = match &item {
165                Err(_) => true,
166                Ok(event) => event
167                    .normalized()
168                    .iter()
169                    .any(|chunk| matches!(chunk, LlmResponseChunk::StreamError { .. })),
170            };
171            if failed {
172                accumulator = None;
173                algorithm
174                    .observe_answer(&session, AnswerSummary { final_reply: false })
175                    .await;
176            }
177            let mut stopped = false;
178            if let (Ok(event), Some(answer)) = (&item, accumulator.as_mut()) {
179                for chunk in event.normalized() {
180                    stopped |= matches!(chunk, LlmResponseChunk::MessageStop { .. });
181                    answer.push(chunk.clone());
182                }
183            }
184            if stopped && let Some(answer) = accumulator.take() {
185                let answer = AnswerSummary::of(&answer.finish());
186                algorithm.observe_answer(&session, answer).await;
187            }
188            Some((item, (stream, (algorithm, session, accumulator))))
189        },
190    )));
191    response
192}
193
194/// Run an algorithm to a routing decision without serving its terminal completion.
195///
196/// Routing-time calls are served normally. The returned request is prepared only for the selected
197/// target; use [`run`] to execute selected and fallback candidates.
198pub async fn decide(
199    algorithm: Arc<dyn Algorithm>,
200    clients: ClientRouter,
201    request: Request,
202    models: Arc<RuntimeModels>,
203) -> Result<RoutingOutcome> {
204    let routing_clients = clients.clone();
205    let mut outcome = match clients.stored_state_owner(&request) {
206        Some(owner) => continue_on(owner, algorithm.name(), request),
207        None => {
208            drive(algorithm, request, models, move |call| {
209                serve(routing_clients.clone(), call, None)
210            })
211            .await?
212        }
213    };
214    let selected_model_id = outcome.selected_model_id()?.clone();
215    outcome.request = clients.prepare_completion_request(outcome.request, &selected_model_id);
216    outcome.response = outcome
217        .response
218        .map(|response| clients.remember_state_owner(&outcome.request, response))
219        .transpose()?;
220    Ok(outcome)
221}
222
223#[tracing::instrument(
224    name = "libsy.decision_client_call",
225    skip_all,
226    fields(algorithm = %call.algorithm, selected_model = %call.model, outcome = tracing::field::Empty),
227)]
228async fn serve_decision(
229    clients: &ClientRouter,
230    call: CallDecision,
231    observations: &Option<Arc<Mutex<Vec<RunObservation>>>>,
232) -> Result<()> {
233    let client = clients.route_decision(&call.model);
234    let model = call.model.clone();
235    let request = call.request.clone();
236    call.respond(async {
237        let started = Instant::now();
238        let result = async { client?.call(request).await }.await;
239        tracing::Span::current().record("outcome", if result.is_ok() { "ok" } else { "error" });
240        if let Some(observations) = observations {
241            observations
242                .lock()
243                .push(RunObservation::DecisionCall(ModelCallObservation {
244                    selected_model: model.clone(),
245                    is_success: result.is_ok(),
246                    duration: started.elapsed(),
247                    usage: result.as_ref().ok().map(|response| response.usage.clone()),
248                }));
249        }
250        result.map_err(|error| LibsyError::client_call(model, error))
251    })
252    .await
253}
254
255/// Emits completed routing calls after the outcome reveals whether one response became the answer.
256fn emit_routing_observations(
257    observer: &Option<RunObserver>,
258    observations: &Option<Arc<Mutex<Vec<RunObservation>>>>,
259    answered_model: Option<&ModelId>,
260) {
261    let (Some(observer), Some(observations)) = (observer, observations) else {
262        return;
263    };
264    let mut answer_observed = false;
265    for observation in observations.lock().drain(..) {
266        observer(match observation {
267            RunObservation::LlmCall(call)
268                if !answer_observed && answered_model == Some(&call.selected_model) =>
269            {
270                answer_observed = true;
271                RunObservation::AnswerCall(call)
272            }
273            observation => observation,
274        });
275    }
276}
277
278/// Serve one offloaded call and fulfill its promise.
279///
280/// LLM failures stop the run unless the call enables recovery. Decision results,
281/// including client failures, go back to the algorithm for its routing policy.
282async fn serve(
283    clients: ClientRouter,
284    call: Call,
285    observations: Option<Arc<Mutex<Vec<RunObservation>>>>,
286) -> Result<()> {
287    let call = match call {
288        Call::Model(call) => *call,
289        Call::Decision(call) => return serve_decision(&clients, *call, &observations).await,
290    };
291    let observe = |observation| {
292        if let Some(observations) = &observations {
293            observations
294                .lock()
295                .push(RunObservation::LlmCall(observation));
296        }
297    };
298    let target = call.models.first().cloned().ok_or(LibsyError::NoTargets)?;
299    let request = clients.prepare_routing_request(call.request.clone(), &target);
300    let algorithm = call.algorithm.clone();
301    let candidates = call.models.len();
302    call.respond(call_one(
303        &clients,
304        &target,
305        request,
306        &algorithm,
307        &observe,
308        0,
309        candidates,
310        CallPhase::Routing,
311    ))
312    .await
313}
314
315/// Try candidates in order until one succeeds or a failure stops fallback.
316async fn call_first_available<'a>(
317    clients: &ClientRouter,
318    algorithm: &str,
319    request: &'a Request,
320    fallback_request: Option<&'a Request>,
321    candidate_requests: &'a HashMap<ModelId, Request>,
322    models: &[ModelId],
323    observe: &(dyn Fn(ModelCallObservation) + Send + Sync),
324) -> Result<(&'a Request, Response)> {
325    for (index, target) in models.iter().enumerate() {
326        let request = candidate_requests
327            .get(target)
328            .unwrap_or(match fallback_request {
329                Some(fallback) if index > 0 => fallback,
330                _ => request,
331            });
332        let prepared = clients.prepare_completion_request(request.clone(), target);
333        match call_one(
334            clients,
335            target,
336            prepared,
337            algorithm,
338            observe,
339            index,
340            models.len(),
341            CallPhase::Completion,
342        )
343        .await
344        {
345            Ok(response) => return Ok((request, response)),
346            Err(error) if index + 1 == models.len() => return Err(error),
347            Err(error)
348                if clients.rate_limit_fallback_disabled.contains(target)
349                    && matches!(&error, LibsyError::ClientCall {
350                        source: LlmClientError::UpstreamHttp { status, .. }, ..
351                    } if *status == StatusCode::TOO_MANY_REQUESTS) =>
352            {
353                return Err(error);
354            }
355            Err(error) => match fallback_reason(&error, fallback_request.is_none()) {
356                Some(reason) => tracing::info!(
357                    from = %target,
358                    to = %models[index + 1],
359                    reason = reason.as_str(),
360                    "model call failed; trying next candidate"
361                ),
362                None => return Err(error),
363            },
364        }
365    }
366    Err(LibsyError::NoTargets)
367}
368
369/// The stage of the Switchyard run in which a model call was issued.
370///
371/// A routing-phase call may still supply the final answer. This is deliberately
372/// distinct from the `routing`/`answer` role assigned after the outcome is known.
373#[derive(Clone, Copy)]
374enum CallPhase {
375    Routing,
376    Completion,
377}
378
379impl CallPhase {
380    const fn as_str(self) -> &'static str {
381        match self {
382            Self::Routing => "routing",
383            Self::Completion => "completion",
384        }
385    }
386}
387
388/// Call one candidate model and record its observation and span.
389#[allow(clippy::too_many_arguments)]
390#[tracing::instrument(
391    target = "libsy",
392    name = "libsy.client_call",
393    skip_all,
394    fields(
395        algorithm = algorithm,
396        switchyard.algorithm = algorithm,
397        switchyard.candidate = index + 1,
398        switchyard.candidate_count = count,
399        switchyard.call_phase = phase.as_str(),
400        selected_model = %clients.provider_model(model_id),
401        selected_target = %model_id,
402        otel.kind = "client",
403        otel.name = %format_args!("chat {}", clients.provider_model(model_id)),
404        openinference.span.kind = "LLM",
405        gen_ai.operation.name = "chat",
406        gen_ai.request.model = %clients.provider_model(model_id),
407        gen_ai.request.stream = tracing::field::Empty,
408        gen_ai.request.temperature = tracing::field::Empty,
409        gen_ai.request.top_p = tracing::field::Empty,
410        gen_ai.request.top_k = tracing::field::Empty,
411        gen_ai.request.max_tokens = tracing::field::Empty,
412        gen_ai.request.reasoning.level = tracing::field::Empty,
413        gen_ai.output.type = tracing::field::Empty,
414        gen_ai.conversation.id = tracing::field::Empty,
415        server.address = tracing::field::Empty,
416        server.port = tracing::field::Empty,
417        gen_ai.response.id = tracing::field::Empty,
418        gen_ai.response.model = tracing::field::Empty,
419        gen_ai.usage.input_tokens = tracing::field::Empty,
420        gen_ai.usage.output_tokens = tracing::field::Empty,
421        gen_ai.usage.cache_read.input_tokens = tracing::field::Empty,
422        gen_ai.usage.cache_creation.input_tokens = tracing::field::Empty,
423        gen_ai.usage.cache_creation_1h.input_tokens = tracing::field::Empty,
424        gen_ai.usage.reasoning.output_tokens = tracing::field::Empty,
425        outcome = tracing::field::Empty,
426        otel.status_code = tracing::field::Empty,
427        error.type = tracing::field::Empty,
428        error = tracing::field::Empty,
429    )
430)]
431async fn call_one(
432    clients: &ClientRouter,
433    model_id: &ModelId,
434    request: Request,
435    algorithm: &str,
436    observe: &(dyn Fn(ModelCallObservation) + Send + Sync),
437    // index is for span log
438    index: usize,
439    // count is for span log
440    count: usize,
441    phase: CallPhase,
442) -> Result<Response> {
443    let is_routing = matches!(phase, CallPhase::Routing);
444    let span = tracing::Span::current();
445    observability::record_gen_ai_request(&span, &request.llm_request);
446    if let Some(session_id) = request
447        .metadata
448        .as_ref()
449        .and_then(|metadata| metadata.session_id.as_deref())
450    {
451        span.record("gen_ai.conversation.id", session_id);
452    }
453    // Resolved before the clock starts: picking the client is Switchyard's work, not
454    // the provider's, so it belongs in the routing overhead.
455    let client = clients.route(model_id);
456    let started = Instant::now();
457    let mut routing_usage = None;
458    let result = async {
459        let mut response = client?.call(request).await?;
460        if is_routing && let LlmResponse::Stream(chunks) = response.llm_response {
461            let (chunks, usage) = buffer_routing_stream(chunks).await?;
462            routing_usage = usage;
463            response.llm_response = LlmResponse::Stream(chunks);
464        }
465        Ok(response)
466    }
467    .await
468    .map_err(|source| LibsyError::client_call(model_id.clone(), source));
469    let duration = started.elapsed();
470
471    let result = result.map(|mut response| {
472        response.set_served_model(model_id);
473        response
474    });
475    let result = observability::observe_client_call(result);
476    let result = if is_routing {
477        result
478    } else {
479        metrics::observe_routed_request(
480            algorithm,
481            clients.provider_model(model_id),
482            Some(duration),
483            result,
484        )
485    };
486    observe(ModelCallObservation {
487        selected_model: model_id.clone(),
488        is_success: result.is_ok(),
489        duration,
490        usage: result
491            .as_ref()
492            .ok()
493            .and_then(|response| response.llm_response.as_agg())
494            .map(|response| response.usage.clone())
495            .or(routing_usage),
496    });
497    result
498}
499
500// Routing logs need the final usage, but replay must keep signed provider events intact.
501async fn buffer_routing_stream(
502    mut chunks: LlmResponseStream,
503) -> std::result::Result<(LlmResponseStream, Option<Usage>), LlmClientError> {
504    let mut events = Vec::new();
505    let mut usage = None;
506    while let Some(event) = chunks.try_next().await? {
507        for chunk in event.normalized() {
508            match chunk {
509                LlmResponseChunk::Usage(latest) => usage = Some(latest.clone()),
510                LlmResponseChunk::DecodeError { message } => {
511                    return Err(LlmClientError::ResponseTranslation(message.clone()));
512                }
513                LlmResponseChunk::StreamError { message } => {
514                    return Err(LlmClientError::UpstreamHttp {
515                        status: StatusCode::BAD_GATEWAY,
516                        body: message.clone(),
517                    });
518                }
519                _ => {}
520            }
521        }
522        events.push(event);
523    }
524    Ok((stream::iter(events.into_iter().map(Ok)).boxed(), usage))
525}
526
527/// Whether a failed candidate is worth routing around.
528fn fallback_reason(
529    error: &LibsyError,
530    allow_policy_fallback: bool,
531) -> Option<RoutingFallbackReason> {
532    let LibsyError::ClientCall { source, .. } = error else {
533        return None;
534    };
535    match source {
536        LlmClientError::ContextWindowExceeded { .. } => Some(RoutingFallbackReason::ContextWindow),
537        LlmClientError::Transport { .. } | LlmClientError::TemporarilyUnavailable => {
538            Some(RoutingFallbackReason::Unavailable)
539        }
540        LlmClientError::UpstreamHttp { status, body } => {
541            let policy_denial = serde_json::from_str::<Value>(body).is_ok_and(|value| {
542                value["error"]["code"].as_str() == Some("content_policy_violation")
543            });
544            if policy_denial && !allow_policy_fallback {
545                return None;
546            }
547            ((*status == StatusCode::BAD_REQUEST && policy_denial)
548                || matches!(
549                    *status,
550                    StatusCode::FORBIDDEN
551                        | StatusCode::REQUEST_TIMEOUT
552                        | StatusCode::TOO_MANY_REQUESTS
553                )
554                || status.is_server_error())
555            .then_some(RoutingFallbackReason::Unavailable)
556        }
557        _ => None,
558    }
559}
560
561/// Route to `owner` without fallbacks and record why the algorithm did not run.
562fn continue_on(owner: StateOwner, algorithm: &str, mut request: Request) -> RoutingOutcome {
563    tracing::debug!(
564        target = %owner.model,
565        trigger = owner.trigger,
566        "routing Responses continuation to the model that holds its state"
567    );
568    if let Some(history) = owner.history {
569        let mut messages = Vec::with_capacity(history.len + request.llm_request.messages.len());
570        history.extend(&mut messages);
571        messages.append(&mut request.llm_request.messages);
572        request.llm_request.messages = messages;
573    }
574    let mut outcome = RoutingOutcome::route_to(owner.model, Vec::new(), request);
575    outcome.metadata = Some(OutcomeMetadata::new(
576        algorithm.to_string(),
577        Some(json!({"source": "stored_state", "trigger": owner.trigger})),
578    ));
579    outcome
580}
581
582/// The model that served the stored state and the request field that refers to it.
583struct StateOwner {
584    model: ModelId,
585    trigger: &'static str,
586    history: Option<Arc<MessageHistory>>,
587}
588
589struct MessageHistory {
590    parent: Option<Arc<Self>>,
591    segment: Arc<[Message]>,
592    len: usize,
593}
594
595impl MessageHistory {
596    fn new(parent: Option<Arc<Self>>, segment: Arc<[Message]>) -> Self {
597        let len = parent.as_ref().map_or(0, |history| history.len) + segment.len();
598        Self {
599            parent,
600            segment,
601            len,
602        }
603    }
604
605    fn extend(&self, messages: &mut Vec<Message>) {
606        let mut segments = Vec::new();
607        let mut history = Some(self);
608        while let Some(node) = history {
609            segments.push(node.segment.as_ref());
610            history = node.parent.as_deref();
611        }
612        for segment in segments.into_iter().rev() {
613            messages.extend_from_slice(segment);
614        }
615    }
616}
617
618#[derive(Clone)]
619struct StoredState {
620    model: ModelId,
621    /// `None` means the provider owns the state and only routing must be pinned.
622    history: Option<Arc<MessageHistory>>,
623}
624
625#[derive(Clone)]
626struct CanonicalInput {
627    parent: Option<Arc<MessageHistory>>,
628    messages: Arc<[Message]>,
629}
630
631/// Stored Responses IDs and conversation IDs, with their provider or canonical state.
632///
633/// Keep earlier response IDs because a client can continue from any stored response.
634/// Reject new IDs at capacity rather than forgetting where an earlier response is stored.
635#[derive(Default)]
636struct StateOwners {
637    by_id: HashMap<String, StoredState>,
638}
639
640const MAX_STATE_OWNERS: usize = 65_536;
641
642impl StateOwners {
643    fn owner(&self, id: &str) -> Option<&StoredState> {
644        self.by_id.get(id)
645    }
646
647    fn remember(
648        &mut self,
649        response_id: Option<&str>,
650        conversation_id: Option<&str>,
651        model: &ModelId,
652        history: Option<Arc<MessageHistory>>,
653    ) -> std::result::Result<(), LlmClientError> {
654        let materialized = history.is_some();
655        let ids = [
656            response_id,
657            conversation_id.filter(|id| Some(*id) != response_id),
658        ];
659        let mut new_ids = 0;
660        for id in ids.into_iter().flatten() {
661            match self.by_id.get(id) {
662                Some(owner) if owner.model != *model && !materialized => {
663                    return Err(LlmClientError::ResponseStateConflict);
664                }
665                None => new_ids += 1,
666                _ => {}
667            }
668        }
669        if self.by_id.len() + new_ids > MAX_STATE_OWNERS {
670            return Err(LlmClientError::ResponseStateLimitExceeded {
671                limit: MAX_STATE_OWNERS,
672            });
673        }
674        let state = StoredState {
675            model: model.clone(),
676            history,
677        };
678        if let Some(id) = response_id {
679            if materialized {
680                self.by_id.insert(id.to_owned(), state.clone());
681            } else {
682                self.by_id
683                    .entry(id.to_owned())
684                    .or_insert_with(|| state.clone());
685            }
686        }
687        if let Some(id) = conversation_id {
688            self.by_id.entry(id.to_owned()).or_insert(state);
689        }
690        Ok(())
691    }
692}
693
694/// Read the Responses `conversation` ID from a string or an object.
695fn conversation_id(fields: &serde_json::Map<String, Value>) -> Option<&str> {
696    let conversation = fields.get("conversation")?;
697    conversation
698        .as_str()
699        .or_else(|| conversation.get("id").and_then(Value::as_str))
700}
701
702/// Resolves a routed call's selected model to the client that serves it.
703///
704/// An algorithm routes among named targets; which provider each target lives on is the
705/// host's concern, and two targets in one run may sit on different providers. A router owns
706/// that mapping and resolves the client for each kind of call.
707///
708/// Cloning is cheap — the mapping is shared, so one router can serve every request.
709#[derive(Clone)]
710pub struct ClientRouter {
711    inner: Arc<ClientRouting>,
712    rate_limit_fallback_disabled: Arc<HashSet<ModelId>>,
713}
714
715struct ClientRouting {
716    routing: Routing,
717    decision_clients: HashMap<ModelId, Arc<dyn RoutedDecisionClient>>,
718    target_prompts: HashMap<ModelId, String>,
719    routing_answer_target: Option<ModelId>,
720    /// Provider-owned routing pins and materialized cross-format history.
721    state_owners: Mutex<StateOwners>,
722    /// Native Responses state only needs a routing pin when answer targets span clients.
723    track_provider_state: bool,
724}
725
726enum Routing {
727    /// One client serves every model.
728    Single(Arc<dyn RoutedLlmClient>),
729    /// Each model is served by the client configured for it.
730    ByModel(HashMap<ModelId, Arc<dyn RoutedLlmClient>>),
731}
732
733impl ClientRouter {
734    /// Build a router over `model name -> client`, for targets spread across providers.
735    pub fn new(by_model: HashMap<ModelId, Arc<dyn RoutedLlmClient>>) -> Self {
736        Self::new_with_target_prompts(by_model, HashMap::new(), None)
737    }
738
739    /// Build a router with target prompts used by [`run`] and [`decide`].
740    ///
741    /// `routing_answer_target` identifies a routing-time call whose response may become the
742    /// answer. Pass `None` when routing only selects a later completion target. Prompt keys and
743    /// `routing_answer_target` use the resolved model IDs stored in `by_model`.
744    /// This constructor treats every model in `by_model` as a possible completion target.
745    /// Use [`Self::new_with_completion_targets`] to exclude classifier-only models from the
746    /// comparison of completion clients.
747    pub fn new_with_target_prompts(
748        by_model: HashMap<ModelId, Arc<dyn RoutedLlmClient>>,
749        target_prompts: HashMap<ModelId, String>,
750        routing_answer_target: Option<ModelId>,
751    ) -> Self {
752        let completion_targets = by_model.keys().cloned().collect::<Vec<_>>();
753        Self::new_with_completion_targets(
754            by_model,
755            target_prompts,
756            routing_answer_target,
757            &completion_targets,
758        )
759    }
760
761    /// Build a router with an explicit list of models that can answer requests.
762    ///
763    /// `by_model` contains callable LLMs, including LLM classifiers. Only the model IDs in
764    /// `completion_targets` determine whether native Responses state needs a routing pin.
765    /// Cross-format state is recorded lazily when a Responses request uses a Chat or Anthropic
766    /// target. `target_prompts` and `routing_answer_target` have the same meaning as in
767    /// [`Self::new_with_target_prompts`].
768    pub fn new_with_completion_targets(
769        by_model: HashMap<ModelId, Arc<dyn RoutedLlmClient>>,
770        target_prompts: HashMap<ModelId, String>,
771        routing_answer_target: Option<ModelId>,
772        completion_targets: &[ModelId],
773    ) -> Self {
774        Self::new_with_decision_clients(
775            by_model,
776            HashMap::new(),
777            target_prompts,
778            routing_answer_target,
779            completion_targets,
780        )
781    }
782
783    /// Build a router with separate LLM and decision mappings, shared across clones.
784    /// LLM prompt and completion settings follow [`Self::new_with_completion_targets`].
785    pub fn new_with_decision_clients(
786        by_model: HashMap<ModelId, Arc<dyn RoutedLlmClient>>,
787        decision_clients: HashMap<ModelId, Arc<dyn RoutedDecisionClient>>,
788        target_prompts: HashMap<ModelId, String>,
789        routing_answer_target: Option<ModelId>,
790        completion_targets: &[ModelId],
791    ) -> Self {
792        let mut clients = completion_targets
793            .iter()
794            .filter_map(|model| by_model.get(model));
795        let spans_providers = clients
796            .next()
797            .is_some_and(|first| clients.any(|client| !Arc::ptr_eq(first, client)));
798        Self {
799            rate_limit_fallback_disabled: Arc::default(),
800            inner: Arc::new(ClientRouting {
801                routing: Routing::ByModel(by_model),
802                decision_clients,
803                target_prompts,
804                routing_answer_target,
805                state_owners: Mutex::default(),
806                track_provider_state: spans_providers,
807            }),
808        }
809    }
810
811    /// A router that serves every model with one client — the single-provider case.
812    ///
813    /// [`TranslatingLlmClient`](crate::TranslatingLlmClient) already maps model names to
814    /// backends internally and rejects ones it does not know, so enumerating them here would
815    /// only duplicate that.
816    pub fn single(client: Arc<dyn RoutedLlmClient>) -> Self {
817        Self::single_with_decision_clients(client, HashMap::new())
818    }
819
820    /// Use one client for all LLM targets and explicit clients for decision targets.
821    pub fn single_with_decision_clients(
822        client: Arc<dyn RoutedLlmClient>,
823        decision_clients: HashMap<ModelId, Arc<dyn RoutedDecisionClient>>,
824    ) -> Self {
825        Self {
826            rate_limit_fallback_disabled: Arc::default(),
827            inner: Arc::new(ClientRouting {
828                routing: Routing::Single(client),
829                decision_clients,
830                target_prompts: HashMap::new(),
831                routing_answer_target: None,
832                state_owners: Mutex::default(),
833                track_provider_state: false,
834            }),
835        }
836    }
837
838    /// Stop completion fallback on HTTP 429 for the given models.
839    ///
840    /// For translating clients, also use
841    /// [`TranslatingLlmClient::without_rate_limit_cooldown`](crate::TranslatingLlmClient::without_rate_limit_cooldown)
842    /// so later calls are not skipped with a generic cooldown error.
843    pub fn without_rate_limit_fallback(mut self, models: HashSet<ModelId>) -> Self {
844        self.rate_limit_fallback_disabled = Arc::new(models);
845        self
846    }
847
848    /// Resolves a target for model telemetry, including calls that fail before a response.
849    fn provider_model<'a>(&'a self, target: &'a ModelId) -> &'a ModelId {
850        self.route(target)
851            .map_or(target, |client| client.provider_model(target))
852    }
853
854    /// The client that serves `model`.
855    ///
856    /// Errors with [`LlmClientError::Configuration`] when the router maps models and has no
857    /// entry for this one, rather than silently sending the call to another provider.
858    pub fn route(
859        &self,
860        model: &ModelId,
861    ) -> std::result::Result<&Arc<dyn RoutedLlmClient>, LlmClientError> {
862        match &self.inner.routing {
863            Routing::Single(client) => Ok(client),
864            Routing::ByModel(by_model) => {
865                by_model
866                    .get(model)
867                    .ok_or_else(|| LlmClientError::Configuration {
868                        message: format!("no llm client is configured for model {model:?}"),
869                    })
870            }
871        }
872    }
873
874    /// Resolve a decision target without falling back to an LLM client.
875    fn route_decision(
876        &self,
877        model: &ModelId,
878    ) -> std::result::Result<&Arc<dyn RoutedDecisionClient>, LlmClientError> {
879        self.inner
880            .decision_clients
881            .get(model)
882            .ok_or_else(|| LlmClientError::Configuration {
883                message: format!("no decision client is configured for model {model:?}"),
884            })
885    }
886
887    /// Return the recorded model for the requested response or conversation ID.
888    fn stored_state_owner(&self, request: &Request) -> Option<StateOwner> {
889        let fields = &request.llm_request.extensions.fields;
890        let (trigger, id) = match fields.get("previous_response_id").and_then(Value::as_str) {
891            Some(id) => ("previous_response_id", id),
892            None => ("conversation", conversation_id(fields)?),
893        };
894        let state = self.inner.state_owners.lock().owner(id)?.clone();
895        Some(StateOwner {
896            model: state.model,
897            trigger,
898            history: state.history,
899        })
900    }
901
902    fn canonical_input(&self, request: &Request) -> CanonicalInput {
903        let parent = request
904            .llm_request
905            .extensions
906            .fields
907            .get("previous_response_id")
908            .and_then(Value::as_str)
909            .and_then(|id| self.inner.state_owners.lock().owner(id)?.history.clone());
910        let parent_len = parent.as_ref().map_or(0, |history| history.len);
911        let (parent, messages) = match request.llm_request.messages.get(parent_len..) {
912            Some(messages) => (parent, messages.to_vec()),
913            None => (None, request.llm_request.messages.clone()),
914        };
915        CanonicalInput {
916            parent,
917            messages: Arc::from(messages),
918        }
919    }
920
921    /// Record provider-owned Responses state or canonical history for a cross-format response.
922    fn remember_state_owner(&self, request: &Request, mut response: Response) -> Result<Response> {
923        let Some(model) = response.served_model().cloned() else {
924            return Ok(response);
925        };
926        let fields = &request.llm_request.extensions.fields;
927        let store = fields.get("store").and_then(Value::as_bool) != Some(false);
928        let conversation = conversation_id(fields).map(str::to_owned);
929        let responses_format = WireFormat::OpenAiResponses.into();
930        let responses_request = request
931            .llm_request
932            .preservation
933            .requests
934            .contains_key(&responses_format)
935            || request
936                .llm_request
937                .messages
938                .iter()
939                .any(|message| message.responses.is_some())
940            || fields.contains_key("previous_response_id")
941            || fields.contains_key("conversation");
942        if !responses_request && !self.inner.track_provider_state {
943            return Ok(response);
944        }
945        let canonical_input = responses_request.then(|| self.canonical_input(request));
946        response.llm_response = match response.llm_response {
947            LlmResponse::Agg(agg) => {
948                if let Some(body) = agg.preservation.responses.get(&responses_format) {
949                    if self.inner.track_provider_state {
950                        self.remember_response(body, &model, store, conversation.as_deref())
951                            .map_err(|error| LibsyError::client_call(model.clone(), error))?;
952                    }
953                } else if let Some(input) = &canonical_input {
954                    self.remember_canonical_response(&agg, &model, store, input)
955                        .map_err(|error| LibsyError::client_call(model.clone(), error))?;
956                }
957                LlmResponse::Agg(agg)
958            }
959            LlmResponse::Stream(stream) => {
960                let router = self.clone();
961                LlmResponse::Stream(Box::pin(futures_util::stream::try_unfold(
962                    (
963                        stream,
964                        router,
965                        model,
966                        conversation,
967                        canonical_input,
968                        ResponseAccumulator::new(),
969                        false,
970                        true,
971                    ),
972                    move |(
973                        mut stream,
974                        router,
975                        model,
976                        conversation,
977                        canonical_input,
978                        mut accumulator,
979                        mut native_responses,
980                        mut valid,
981                    )| async move {
982                        let Some(event) = stream.next().await else {
983                            if let Some(input) = &canonical_input
984                                && !native_responses
985                                && valid
986                            {
987                                router.remember_canonical_response(
988                                    &accumulator.finish(),
989                                    &model,
990                                    store,
991                                    input,
992                                )?;
993                            }
994                            return Ok(None);
995                        };
996                        let event = event?;
997                        if let Some(preserved) = event.preservation()
998                            && preserved.source().as_str() == WireFormat::OpenAiResponses.as_str()
999                        {
1000                            native_responses = true;
1001                            if router.inner.track_provider_state
1002                                && let Some(body) = preserved.raw().get("response")
1003                            {
1004                                router.remember_response(
1005                                    body,
1006                                    &model,
1007                                    store,
1008                                    conversation.as_deref(),
1009                                )?;
1010                            }
1011                        }
1012                        if responses_request {
1013                            for chunk in event.normalized() {
1014                                if matches!(
1015                                    chunk,
1016                                    LlmResponseChunk::DecodeError { .. }
1017                                        | LlmResponseChunk::StreamError { .. }
1018                                ) {
1019                                    valid = false;
1020                                } else {
1021                                    accumulator.push(chunk.clone());
1022                                }
1023                            }
1024                        }
1025                        Ok(Some((
1026                            event,
1027                            (
1028                                stream,
1029                                router,
1030                                model,
1031                                conversation,
1032                                canonical_input,
1033                                accumulator,
1034                                native_responses,
1035                                valid,
1036                            ),
1037                        )))
1038                    },
1039                )))
1040            }
1041        };
1042        Ok(response)
1043    }
1044
1045    /// Check both IDs from a response or stream event before recording either. The response's
1046    /// `store` value overrides the request value; `false` skips only the response ID.
1047    fn remember_response(
1048        &self,
1049        body: &Value,
1050        model: &ModelId,
1051        store: bool,
1052        conversation: Option<&str>,
1053    ) -> std::result::Result<(), LlmClientError> {
1054        let mut owners = self.inner.state_owners.lock();
1055        let response_id = body
1056            .get("id")
1057            .and_then(Value::as_str)
1058            .filter(|_| body.get("store").and_then(Value::as_bool).unwrap_or(store));
1059        let conversation = body.as_object().and_then(conversation_id).or(conversation);
1060        if let Err(error) = owners.remember(response_id, conversation, model, None) {
1061            if matches!(error, LlmClientError::ResponseStateLimitExceeded { .. }) {
1062                tracing::warn!(%error, "Responses state owner capacity reached; state was not retained");
1063            } else {
1064                tracing::error!(%error, "could not record Responses state owner");
1065                return Err(error);
1066            }
1067        }
1068        Ok(())
1069    }
1070
1071    fn remember_canonical_response(
1072        &self,
1073        response: &AggLlmResponse,
1074        model: &ModelId,
1075        store: bool,
1076        input: &CanonicalInput,
1077    ) -> std::result::Result<(), LlmClientError> {
1078        let response_id = response.id.as_deref().filter(|_| store);
1079        if response_id.is_none() {
1080            return Ok(());
1081        }
1082        let mut segment = input.messages.to_vec();
1083        segment.extend(response.outputs.iter().map(|output| Message {
1084            responses: None,
1085            role: output.role,
1086            content: output.content.clone(),
1087        }));
1088        let history = Arc::new(MessageHistory::new(
1089            input.parent.clone(),
1090            Arc::from(segment),
1091        ));
1092        let result =
1093            self.inner
1094                .state_owners
1095                .lock()
1096                .remember(response_id, None, model, Some(history));
1097        if let Err(error) = result {
1098            if matches!(error, LlmClientError::ResponseStateLimitExceeded { .. }) {
1099                tracing::warn!(%error, "cross-format Responses state capacity reached; history was not retained");
1100                return Ok(());
1101            }
1102            tracing::error!(%error, "could not record cross-format Responses state");
1103            return Err(error);
1104        }
1105        Ok(())
1106    }
1107
1108    /// Prepare a completion candidate with its configured target prompt.
1109    fn prepare_completion_request(&self, mut request: Request, target: &ModelId) -> Request {
1110        let prompt = self.inner.target_prompts.get(target).map(String::as_str);
1111        prepare_request_for_target(&mut request.llm_request, target, prompt);
1112        request
1113    }
1114
1115    /// Prepare a routing call, adding a target prompt only when it generates a candidate answer.
1116    fn prepare_routing_request(&self, mut request: Request, target: &ModelId) -> Request {
1117        let prompt = if self.inner.routing_answer_target.as_ref() == Some(target) {
1118            self.inner.target_prompts.get(target).map(String::as_str)
1119        } else {
1120            None
1121        };
1122        prepare_request_for_target(&mut request.llm_request, target, prompt);
1123        request
1124    }
1125}
1126
1127impl FromIterator<(ModelId, Arc<dyn RoutedLlmClient>)> for ClientRouter {
1128    fn from_iter<I: IntoIterator<Item = (ModelId, Arc<dyn RoutedLlmClient>)>>(iter: I) -> Self {
1129        Self::new(iter.into_iter().collect())
1130    }
1131}
1132
1133#[cfg(test)]
1134mod tests {
1135    use std::collections::{BTreeMap, BTreeSet};
1136
1137    use super::*;
1138    use async_trait::async_trait;
1139    use futures::StreamExt;
1140    use http::StatusCode;
1141    use switchyard_libsy::{Driver, RoutingOutcome};
1142    use switchyard_protocol::{
1143        ContentBlock, LlmResponse, LlmResponseChunk, LlmResponseStreamEvent, Message, Role,
1144        ToolResult, completion_text, text_request, text_response,
1145    };
1146    use wiremock::matchers::method;
1147    use wiremock::{Mock, MockServer, ResponseTemplate};
1148
1149    use crate::{Backend, HttpBackendConfig, ModelConfig, TranslatingLlmClient};
1150    use switchyard_protocol::Category;
1151
1152    struct CandidateAlgorithm {}
1153
1154    struct AnsweredAlgorithm {
1155        model: ModelId,
1156    }
1157
1158    #[async_trait]
1159    impl Algorithm for CandidateAlgorithm {
1160        fn name(&self) -> &str {
1161            "candidate_test"
1162        }
1163
1164        async fn route(
1165            self: Arc<Self>,
1166            driver: Driver,
1167            request: Request,
1168        ) -> Result<RoutingOutcome> {
1169            let models = driver.models_for(&Category::Any);
1170            let selected_model = models.first().cloned().ok_or(LibsyError::NoTargets)?;
1171            Ok(RoutingOutcome::route_to(
1172                selected_model,
1173                models.iter().skip(1).cloned().collect(),
1174                request,
1175            ))
1176        }
1177    }
1178
1179    #[async_trait]
1180    impl Algorithm for AnsweredAlgorithm {
1181        fn name(&self) -> &str {
1182            "answered_test"
1183        }
1184
1185        async fn route(
1186            self: Arc<Self>,
1187            driver: Driver,
1188            request: Request,
1189        ) -> Result<RoutingOutcome> {
1190            let response = driver
1191                .call_model(request.clone(), vec![self.model.clone()])
1192                .await?;
1193            Ok(RoutingOutcome::answered(
1194                self.model.clone(),
1195                request,
1196                response,
1197            ))
1198        }
1199    }
1200
1201    /// Rewrites the request for its selected model only.
1202    struct RewritingAlgorithm {}
1203
1204    #[async_trait]
1205    impl Algorithm for RewritingAlgorithm {
1206        fn name(&self) -> &str {
1207            "rewriting_test"
1208        }
1209
1210        async fn route(
1211            self: Arc<Self>,
1212            _driver: Driver,
1213            request: Request,
1214        ) -> Result<RoutingOutcome> {
1215            let mut rewritten = request.clone();
1216            rewritten
1217                .llm_request
1218                .messages
1219                .push(Message::text(Role::User, "for weak only"));
1220            let mut outcome =
1221                RoutingOutcome::route_to("weak".into(), vec!["strong".into()], rewritten);
1222            outcome.fallback_request = Some(request);
1223            Ok(outcome)
1224        }
1225    }
1226
1227    #[derive(Clone, Copy)]
1228    enum FirstOutcome {
1229        ContextWindow,
1230        ContentPolicy(StatusCode),
1231        Unauthorized,
1232        StreamSuccess,
1233        MidStreamError,
1234    }
1235
1236    struct CandidateClient {
1237        calls: Mutex<Vec<ModelId>>,
1238        requests: Mutex<Vec<Request>>,
1239        first: FirstOutcome,
1240    }
1241
1242    #[async_trait]
1243    impl RoutedLlmClient for CandidateClient {
1244        async fn call(&self, request: Request) -> std::result::Result<Response, LlmClientError> {
1245            let model = request.model_id().unwrap_or_default();
1246            self.calls.lock().push(model.clone());
1247            self.requests.lock().push(request);
1248            if model == "weak" {
1249                return match self.first {
1250                    FirstOutcome::ContextWindow => Err(LlmClientError::ContextWindowExceeded {
1251                        model,
1252                        message: "too long".to_string(),
1253                    }),
1254                    FirstOutcome::ContentPolicy(status) => Err(LlmClientError::UpstreamHttp {
1255                        status,
1256                        body: r#"{"error":{"code":"content_policy_violation","message":"request blocked by content policy","type":"invalid_request_error"},"metadata":{"documentation_section":"context window"}}"#.to_string(),
1257                    }),
1258                    FirstOutcome::Unauthorized => Err(LlmClientError::UpstreamHttp {
1259                        status: StatusCode::UNAUTHORIZED,
1260                        body: "unauthorized".to_string(),
1261                    }),
1262                    FirstOutcome::StreamSuccess => Ok(stream_response(vec![
1263                        LlmResponseChunk::TextDelta {
1264                            index: 0,
1265                            text: "streamed".to_string(),
1266                        },
1267                        LlmResponseChunk::MessageStop {
1268                            reason: Some("stop".to_string()),
1269                        },
1270                    ])),
1271                    FirstOutcome::MidStreamError => Ok(stream_response(vec![
1272                        LlmResponseChunk::TextDelta {
1273                            index: 0,
1274                            text: "partial".to_string(),
1275                        },
1276                        LlmResponseChunk::StreamError {
1277                            message: "stream failed".to_string(),
1278                        },
1279                        LlmResponseChunk::MessageStop { reason: Some("stop".into()) },
1280                    ])),
1281                };
1282            }
1283            Ok(Response {
1284                llm_response: LlmResponse::Agg(AggLlmResponse {
1285                    id: Some("candidate_response".into()),
1286                    ..text_response(Some(model.to_string()), model)
1287                }),
1288                metadata: None,
1289                upstream_headers: http::HeaderMap::new(),
1290            })
1291        }
1292    }
1293
1294    fn stream_response(chunks: Vec<LlmResponseChunk>) -> Response {
1295        Response {
1296            llm_response: LlmResponse::Stream(
1297                futures::stream::iter(
1298                    chunks
1299                        .into_iter()
1300                        .map(|chunk| Ok(LlmResponseStreamEvent::from(chunk))),
1301                )
1302                .boxed(),
1303            ),
1304            metadata: None,
1305            upstream_headers: http::HeaderMap::new(),
1306        }
1307    }
1308
1309    fn request() -> Request {
1310        Request {
1311            llm_request: text_request(Some("auto".to_string()), "hello".to_string()),
1312            raw_request: None,
1313            metadata: None,
1314        }
1315    }
1316
1317    #[tokio::test]
1318    async fn system_one_serves_decisions_and_returns_failures_to_the_classifier()
1319    -> std::result::Result<(), Box<dyn std::error::Error>> {
1320        use std::time::Duration;
1321        use switchyard_libsy::{
1322            CapabilityJudgeConfig, DecisionJudgeConfig, LlmClassifierConfig, LlmTaskClassifier,
1323            TaskClassifierConfig,
1324        };
1325        use switchyard_protocol::{
1326            BooleanEstimate, DecisionRequest, DecisionValue, Probability, ScoreValue,
1327        };
1328        use wiremock::matchers::{body_partial_json, header, path};
1329
1330        let server = MockServer::start().await;
1331        let client = Arc::new(crate::SystemOneClient::new(
1332            format!("{}/v1/systemone", server.uri()).parse()?,
1333            "test-key".into(),
1334            Duration::from_secs(2),
1335        )?);
1336        assert!(matches!(
1337            crate::SystemOneClient::new(
1338                format!("{}/v1/systemone", server.uri()).parse()?,
1339                "invalid\nkey".into(),
1340                Duration::from_secs(2),
1341            ),
1342            Err(LlmClientError::Configuration { .. })
1343        ));
1344        let mixed: DecisionRequest = serde_json::from_value(json!({
1345            "model": "judge", "input": [Message::text(Role::User, "A simple task")],
1346            "questions": {
1347                "boolean": {"instructions": "Is it simple?", "kind": {"type": "boolean", "data": {
1348                    "true_description": ["Simple"], "false_description": null
1349                }}},
1350                "route": {"instructions": "Choose", "kind": {"type": "choice", "data": {
1351                    "options": [{"id": "capable", "description": "A wins"}, {"id": "efficient", "description": "B wins"}]
1352                }}},
1353                "score": {"instructions": "Rate difficulty", "kind": {"type": "score", "data": {
1354                    "levels": ["Easy", {"description": "Hard"}]
1355                }}}
1356            }
1357        }))?;
1358        let mut body = json!({
1359            "model": "jev-1.13.0", "usage": {"input_tokens": 42, "output_tokens": 3},
1360            "answers": {
1361                "boolean": {"type": "noul", "noul": 0.9},
1362                "route": {"type": "choice", "choice": "efficient", "confidence": 0.7,
1363                    "probabilities": {"capable": 0.2, "efficient": 0.8}},
1364                "score": {"type": "score", "score": 0.6, "confidence": 0.3,
1365                    "legend": {"0": "Easy", "1": {"description": "Hard"}},
1366                    "probabilities": {"1": 0.6, "0": 0.4}}
1367            }
1368        });
1369        Mock::given(method("POST"))
1370            .and(path("/v1/systemone"))
1371            .and(header("authorization", "Bearer test-key"))
1372            .and(body_partial_json(json!({
1373                "model": "judge", "state": mixed.input,
1374                "questions": {
1375                    "boolean": {"type": "noul", "criteria": {"true": ["Simple"]}},
1376                    "route": {"type": "choice", "instructions": "Choose",
1377                        "criteria": {"capable": "A wins", "efficient": "B wins"}},
1378                    "score": {"type": "score", "criteria": ["Easy", {"description": "Hard"}]}
1379                }
1380            })))
1381            .respond_with(ResponseTemplate::new(200).set_body_json(&body))
1382            .expect(1)
1383            .mount(&server)
1384            .await;
1385        let response = client.call(mixed.clone()).await?;
1386        assert_eq!(response.model.as_deref(), Some("jev-1.13.0"));
1387        assert_eq!(response.id, None);
1388        assert_eq!(response.usage.input_tokens, Some(42));
1389        assert_eq!(response.usage.total_tokens, None);
1390        assert_eq!(
1391            response.answers["boolean"].value,
1392            DecisionValue::Boolean(BooleanEstimate::ProbabilityTrue(Probability(0.9)))
1393        );
1394        assert_eq!(
1395            response.answers["score"].value,
1396            DecisionValue::Score {
1397                value: ScoreValue(0.6),
1398                probabilities: Some(vec![Probability(0.4), Probability(0.6)]),
1399            }
1400        );
1401        assert_eq!(
1402            response.answers["route"].provider_confidence.map(|c| c.0),
1403            Some(0.7)
1404        );
1405        server.verify().await;
1406
1407        let mut partial = body.clone();
1408        partial["answers"]
1409            .as_object_mut()
1410            .unwrap()
1411            .remove("boolean");
1412        let mut invalid_responses = vec![json!({"answers": {}}), partial];
1413        for (id, answer) in [
1414            ("unknown-question", json!({"type": "noul", "noul": 0.9})),
1415            ("boolean", json!({"type": "score", "score": 0.0})),
1416            (
1417                "route",
1418                json!({"type": "choice", "choice": "unknown-option",
1419                    "probabilities": {"capable": 0.2, "efficient": 0.8}}),
1420            ),
1421            ("score", json!({"type": "score", "score": -0.1})),
1422            (
1423                "score",
1424                json!({"type": "score", "score": 1.1,
1425                "probabilities": {"0": 0.4, "1": 0.6}}),
1426            ),
1427        ] {
1428            let mut invalid = body.clone();
1429            invalid["answers"][id] = answer;
1430            if id == "unknown-question" {
1431                invalid["answers"]
1432                    .as_object_mut()
1433                    .unwrap()
1434                    .remove("boolean");
1435            }
1436            invalid_responses.push(invalid);
1437        }
1438        for template in invalid_responses
1439            .into_iter()
1440            .map(|body| ResponseTemplate::new(200).set_body_json(body))
1441            .chain([ResponseTemplate::new(200).set_body_string("invalid JSON")])
1442        {
1443            server.reset().await;
1444            Mock::given(method("POST"))
1445                .respond_with(template)
1446                .expect(1)
1447                .mount(&server)
1448                .await;
1449            assert!(matches!(
1450                client.call(mixed.clone()).await,
1451                Err(LlmClientError::ResponseTranslation(_) | LlmClientError::InvalidResponse { .. })
1452            ));
1453            server.verify().await;
1454        }
1455
1456        body["answers"].as_object_mut().unwrap().remove("boolean");
1457        body["answers"].as_object_mut().unwrap().remove("score");
1458        let models = Arc::new(RuntimeModels::new(HashMap::from([
1459            (Category::Judge, vec!["judge".into()]),
1460            (Category::Capable, vec!["capable".into()]),
1461            (Category::Efficient, vec!["efficient".into()]),
1462            (Category::Any, vec!["efficient".into(), "capable".into()]),
1463        ])));
1464        let algorithm = || -> Result<Arc<dyn Algorithm>> {
1465            Ok(Arc::new(LlmTaskClassifier::new(
1466                LlmClassifierConfig::Capability {
1467                    config: TaskClassifierConfig {
1468                        judge: CapabilityJudgeConfig::Decision(DecisionJudgeConfig {
1469                            cutoff: Some(0.4),
1470                            ..DecisionJudgeConfig::default()
1471                        }),
1472                        ..TaskClassifierConfig::default()
1473                    },
1474                },
1475            )?))
1476        };
1477        for (template, expected, is_success) in [
1478            (
1479                ResponseTemplate::new(200).set_body_json(&body),
1480                "efficient",
1481                true,
1482            ),
1483            (
1484                ResponseTemplate::new(503).set_body_string("unavailable"),
1485                "capable",
1486                false,
1487            ),
1488        ] {
1489            server.reset().await;
1490            Mock::given(method("POST"))
1491                .and(path("/v1/systemone"))
1492                .respond_with(template)
1493                .expect(2)
1494                .mount(&server)
1495                .await;
1496            let llm = Arc::new(CandidateClient {
1497                calls: Mutex::default(),
1498                requests: Mutex::default(),
1499                first: FirstOutcome::Unauthorized,
1500            });
1501            let clients = ClientRouter::single_with_decision_clients(
1502                llm.clone(),
1503                HashMap::from([(
1504                    ModelId::from("judge"),
1505                    client.clone() as Arc<dyn RoutedDecisionClient>,
1506                )]),
1507            );
1508            let outcome = decide(algorithm()?, clients.clone(), request(), models.clone()).await?;
1509            assert_eq!(outcome.selected_model_id()?, expected);
1510            assert!(llm.calls.lock().is_empty());
1511            let events = Arc::new(Mutex::new(Vec::new()));
1512            let captured = events.clone();
1513            let (selected, _) = run(
1514                algorithm()?,
1515                clients,
1516                request(),
1517                models.clone(),
1518                Some(Arc::new(move |event| captured.lock().push(event))),
1519            )
1520            .await?;
1521            assert_eq!(selected, expected);
1522            assert_eq!(&*llm.calls.lock(), &[ModelId::from(expected)]);
1523            {
1524                let events = events.lock();
1525                let RunObservation::DecisionCall(call) = &events[0] else {
1526                    panic!("missing decision observation")
1527                };
1528                assert_eq!(call.selected_model, "judge");
1529                assert_eq!(call.is_success, is_success);
1530                assert_eq!(
1531                    call.usage.as_ref().and_then(|u| u.input_tokens),
1532                    is_success.then_some(42)
1533                );
1534                assert!(
1535                    events
1536                        .iter()
1537                        .any(|event| matches!(event, RunObservation::AnswerCall(_)))
1538                );
1539            }
1540            server.verify().await;
1541        }
1542        Ok(())
1543    }
1544
1545    fn instruction_text(request: &Request) -> Vec<&str> {
1546        request
1547            .llm_request
1548            .instructions
1549            .iter()
1550            .flat_map(|instruction| &instruction.content)
1551            .filter_map(|block| match block {
1552                ContentBlock::Text { text, .. } => Some(text.as_str()),
1553                _ => None,
1554            })
1555            .collect()
1556    }
1557
1558    async fn run_candidates(
1559        first: FirstOutcome,
1560    ) -> (Arc<CandidateClient>, Result<(ModelId, Response)>) {
1561        let client = Arc::new(CandidateClient {
1562            calls: Mutex::new(Vec::new()),
1563            requests: Mutex::new(Vec::new()),
1564            first,
1565        });
1566        let algorithm = Arc::new(CandidateAlgorithm {});
1567        let models = to_category_map(&["weak", "strong"]);
1568        let result = run(
1569            algorithm,
1570            ClientRouter::single(client.clone()),
1571            request(),
1572            models,
1573            None,
1574        )
1575        .await;
1576        (client, result)
1577    }
1578
1579    fn to_category_map(names: &[&str]) -> Arc<RuntimeModels> {
1580        Arc::new(RuntimeModels::new(
1581            [(
1582                Category::Any,
1583                names.iter().map(|name| ModelId::from(*name)).collect(),
1584            )]
1585            .into(),
1586        ))
1587    }
1588
1589    #[tokio::test]
1590    async fn answered_outcome_does_not_make_a_second_model_call() -> Result<()> {
1591        let client = Arc::new(CandidateClient {
1592            calls: Mutex::new(Vec::new()),
1593            requests: Mutex::new(Vec::new()),
1594            first: FirstOutcome::StreamSuccess,
1595        });
1596        let observations = Arc::new(Mutex::new(Vec::new()));
1597        let observed = Arc::clone(&observations);
1598        let observer: RunObserver = Arc::new(move |event| observed.lock().push(event));
1599
1600        let (selected, response) = run(
1601            Arc::new(AnsweredAlgorithm {
1602                model: "weak".into(),
1603            }),
1604            ClientRouter::single(client.clone()),
1605            request(),
1606            Arc::new(RuntimeModels::default()),
1607            Some(observer),
1608        )
1609        .await?;
1610
1611        assert_eq!(selected, "weak");
1612        assert_eq!(response.served_model().map(ModelId::as_str), Some("weak"));
1613        assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
1614        let observations = observations.lock();
1615        assert!(matches!(observations[0], RunObservation::AnswerCall(_)));
1616        assert!(matches!(
1617            observations[1],
1618            RunObservation::Outcome(ref metadata) if metadata.algorithm == "answered_test"
1619        ));
1620        assert!(matches!(
1621            observations[2],
1622            RunObservation::RoutingOverhead(_)
1623        ));
1624        assert_eq!(observations.len(), 3);
1625        Ok(())
1626    }
1627
1628    #[tokio::test]
1629    async fn served_answer_is_reported_before_the_client_sees_it_end() -> Result<()> {
1630        #[derive(Default)]
1631        struct ReportingAlgorithm {
1632            answers: Mutex<Vec<(String, bool)>>,
1633            tracking: bool,
1634        }
1635
1636        #[async_trait]
1637        impl Algorithm for ReportingAlgorithm {
1638            fn name(&self) -> &str {
1639                "reporting_test"
1640            }
1641
1642            async fn route(
1643                self: Arc<Self>,
1644                _driver: Driver,
1645                request: Request,
1646            ) -> Result<RoutingOutcome> {
1647                Ok(RoutingOutcome::route_to("weak".into(), Vec::new(), request))
1648            }
1649
1650            fn tracks_answers(&self) -> bool {
1651                self.tracking
1652            }
1653
1654            async fn observe_answer(&self, session_id: &str, answer: AnswerSummary) {
1655                self.answers
1656                    .lock()
1657                    .push((session_id.to_string(), answer.final_reply));
1658            }
1659        }
1660
1661        assert!(!CandidateAlgorithm {}.tracks_answers());
1662        for (tracking, first, final_reply, cancel) in [
1663            (false, FirstOutcome::StreamSuccess, true, false),
1664            (true, FirstOutcome::StreamSuccess, true, false),
1665            (true, FirstOutcome::MidStreamError, false, false),
1666            (true, FirstOutcome::StreamSuccess, false, true),
1667        ] {
1668            let algorithm = Arc::new(ReportingAlgorithm {
1669                tracking,
1670                ..Default::default()
1671            });
1672            let client = Arc::new(CandidateClient {
1673                calls: Mutex::new(Vec::new()),
1674                requests: Mutex::new(Vec::new()),
1675                first,
1676            });
1677            let request = Request {
1678                metadata: Some(switchyard_protocol::Metadata {
1679                    session_id: Some("session-1".to_string()),
1680                    ..Default::default()
1681                }),
1682                ..request()
1683            };
1684            let (_, response) = run(
1685                algorithm.clone(),
1686                ClientRouter::single(client),
1687                request,
1688                to_category_map(&["weak"]),
1689                None,
1690            )
1691            .await?;
1692            let LlmResponse::Stream(mut stream) = response.llm_response else {
1693                panic!("expected a streamed answer");
1694            };
1695            if !tracking {
1696                assert!(algorithm.answers.lock().is_empty());
1697                while let Some(item) = stream.next().await {
1698                    assert!(item.is_ok());
1699                }
1700                assert!(algorithm.answers.lock().is_empty());
1701                continue;
1702            }
1703            if cancel {
1704                stream.next().await;
1705                drop(stream);
1706                assert_eq!(
1707                    *algorithm.answers.lock(),
1708                    [("session-1".to_string(), false)]
1709                );
1710                continue;
1711            }
1712            while let Some(item) = stream.next().await {
1713                let stops = item.as_ref().is_ok_and(|event| {
1714                    event
1715                        .normalized()
1716                        .iter()
1717                        .any(|chunk| matches!(chunk, LlmResponseChunk::MessageStop { .. }))
1718                });
1719                if stops {
1720                    assert_eq!(algorithm.answers.lock().len(), 2);
1721                }
1722            }
1723            assert_eq!(
1724                *algorithm.answers.lock(),
1725                if final_reply {
1726                    vec![
1727                        ("session-1".to_string(), false),
1728                        ("session-1".to_string(), true),
1729                    ]
1730                } else {
1731                    vec![
1732                        ("session-1".to_string(), false),
1733                        ("session-1".to_string(), false),
1734                    ]
1735                }
1736            );
1737        }
1738        Ok(())
1739    }
1740
1741    #[test]
1742    fn answer_observation_keeps_call_order() {
1743        let pending = Some(Arc::new(Mutex::new(
1744            ["answer", "judge"]
1745                .map(|model| ModelCallObservation {
1746                    selected_model: model.into(),
1747                    is_success: true,
1748                    duration: std::time::Duration::ZERO,
1749                    usage: None,
1750                })
1751                .map(RunObservation::LlmCall)
1752                .into(),
1753        )));
1754        let emitted = Arc::new(Mutex::new(Vec::new()));
1755        let captured = Arc::clone(&emitted);
1756        let observer: RunObserver = Arc::new(move |event| captured.lock().push(event));
1757        let answer = ModelId::from("answer");
1758
1759        emit_routing_observations(&Some(observer), &pending, Some(&answer));
1760
1761        assert!(matches!(
1762            &emitted.lock()[..],
1763            [RunObservation::AnswerCall(answer), RunObservation::LlmCall(judge)]
1764                if answer.selected_model == "answer" && judge.selected_model == "judge"
1765        ));
1766    }
1767
1768    #[tokio::test]
1769    async fn responses_state_tracking_uses_upstream_storage_and_format() -> Result<()> {
1770        for (responses, store, conversation) in [
1771            (true, true, None),
1772            (true, false, None),
1773            (true, false, Some(json!("conv_plain"))),
1774            (true, false, Some(json!({"id": "conv_object"}))),
1775            (false, true, None),
1776        ] {
1777            for stream in [false, true] {
1778                let server = MockServer::start().await;
1779                Mock::given(method("POST"))
1780                    .respond_with(move |request: &wiremock::Request| {
1781                        let body: Value = serde_json::from_slice(&request.body).expect("request JSON");
1782                        let response = if responses {
1783                            json!({
1784                                "id": "resp_seed", "object": "response", "model": "weak",
1785                                "status": "completed", "output": [], "store": body["store"],
1786                                "conversation": body["conversation"],
1787                            })
1788                        } else if stream {
1789                            json!({"id": "resp_seed", "model": "weak", "choices": [{"index": 0, "delta": {"content": "ok"}, "finish_reason": "stop"}]})
1790                        } else {
1791                            json!({"id": "resp_seed", "model": "weak", "choices": [{"index": 0, "message": {"role": "assistant", "content": "ok"}, "finish_reason": "stop"}]})
1792                        };
1793                        if stream {
1794                            let event = if responses { json!({"type": "response.completed", "response": response}) } else { response };
1795                            ResponseTemplate::new(200)
1796                                .insert_header("content-type", "text/event-stream")
1797                                .set_body_string(if responses {
1798                                    format!("event: response.completed\ndata: {event}\n\n")
1799                                } else {
1800                                    format!("data: {event}\n\ndata: [DONE]\n\n")
1801                                })
1802                        } else {
1803                            ResponseTemplate::new(200).set_body_json(response)
1804                        }
1805                    })
1806                    .mount(&server).await;
1807                let mut clients = HashMap::new();
1808                for model in ["weak", "strong"] {
1809                    let config = HttpBackendConfig {
1810                        base_url: server.uri(),
1811                        api_key: None,
1812                        forward_auth: false,
1813                        extra_headers: BTreeMap::new(),
1814                        extra_body: BTreeMap::from([("store".to_string(), json!(store))]),
1815                        omit_body_fields: BTreeSet::new(),
1816                        reasoning_effort: None,
1817                        max_retries: 0,
1818                        failure_cooldown: std::time::Duration::ZERO,
1819                        timeout: None,
1820                    };
1821                    let backend = if responses {
1822                        Backend::OpenAiResponses(config)
1823                    } else {
1824                        Backend::OpenAiChat(config)
1825                    };
1826                    let client: Arc<dyn RoutedLlmClient> = Arc::new(
1827                        TranslatingLlmClient::new(&[ModelConfig::new(model, backend, None)])
1828                            .map_err(|error| LibsyError::external("building test client", error))?,
1829                    );
1830                    clients.insert(ModelId::from(model), client);
1831                }
1832                let clients = ClientRouter::new(clients);
1833                let mut seed = request();
1834                seed.llm_request.stream = stream;
1835                if let Some(conversation) = &conversation {
1836                    seed.llm_request
1837                        .extensions
1838                        .fields
1839                        .insert("conversation".to_string(), conversation.clone());
1840                }
1841                let (_, response) = run(
1842                    Arc::new(switchyard_libsy::Passthrough),
1843                    clients.clone(),
1844                    seed,
1845                    to_category_map(&["weak"]),
1846                    None,
1847                )
1848                .await?;
1849                response
1850                    .llm_response
1851                    .into_agg()
1852                    .await
1853                    .map_err(|error| LibsyError::client_call("weak", error))?;
1854                let mut continuations = vec![(
1855                    "previous_response_id",
1856                    json!("resp_seed"),
1857                    responses && store,
1858                )];
1859                if let Some(conversation) = conversation.clone() {
1860                    continuations.push(("conversation", conversation, true));
1861                }
1862                for (field, id, pinned) in continuations {
1863                    let mut follow = request();
1864                    follow
1865                        .llm_request
1866                        .extensions
1867                        .fields
1868                        .insert(field.to_string(), id);
1869                    let outcome = decide(
1870                        Arc::new(switchyard_libsy::Passthrough),
1871                        clients.clone(),
1872                        follow,
1873                        to_category_map(&["strong"]),
1874                    )
1875                    .await?;
1876                    assert_eq!(
1877                        outcome.selected_model_id()?.as_str(),
1878                        if pinned { "weak" } else { "strong" },
1879                        "responses={responses}, store={store}, stream={stream}, field={field}"
1880                    );
1881                }
1882                let requests = server.received_requests().await.expect("request recording");
1883                assert_eq!(requests.len(), 1);
1884                assert_eq!(
1885                    serde_json::from_slice::<Value>(&requests[0].body).expect("request JSON")["store"],
1886                    store
1887                );
1888            }
1889        }
1890        Ok(())
1891    }
1892
1893    #[tokio::test]
1894    async fn responses_stored_tool_continuation_materializes_for_anthropic() -> Result<()> {
1895        let server = MockServer::start().await;
1896        Mock::given(method("POST"))
1897            .respond_with(|request: &wiremock::Request| {
1898                let body: Value = serde_json::from_slice(&request.body).expect("request JSON");
1899                let blocks = body["messages"]
1900                    .as_array()
1901                    .into_iter()
1902                    .flatten()
1903                    .filter_map(|message| message["content"].as_array())
1904                    .flatten()
1905                    .collect::<Vec<_>>();
1906                let has_result = blocks.iter().any(|block| block["type"] == "tool_result");
1907                let has_call = blocks.iter().any(|block| block["type"] == "tool_use");
1908                let has_thanks = blocks
1909                    .iter()
1910                    .any(|block| block["type"] == "text" && block["text"] == "thanks")
1911                    || body["messages"].as_array().is_some_and(|messages| {
1912                        messages
1913                            .iter()
1914                            .any(|message| message["content"] == "thanks")
1915                    });
1916                if has_result && !has_call {
1917                    return ResponseTemplate::new(400).set_body_json(json!({
1918                        "type": "error",
1919                        "error": {
1920                            "type": "invalid_request_error",
1921                            "message": "tool_result has no corresponding tool_use"
1922                        }
1923                    }));
1924                }
1925                let response = if has_thanks {
1926                    json!({
1927                        "id": "msg_third", "type": "message", "role": "assistant",
1928                        "model": "weak", "content": [{"type": "text", "text": "done"}],
1929                        "stop_reason": "end_turn", "usage": {"input_tokens": 6, "output_tokens": 1}
1930                    })
1931                } else if has_result {
1932                    json!({
1933                        "id": "msg_follow", "type": "message", "role": "assistant",
1934                        "model": "weak", "content": [{"type": "text", "text": "sunny"}],
1935                        "stop_reason": "end_turn", "usage": {"input_tokens": 4, "output_tokens": 1}
1936                    })
1937                } else {
1938                    json!({
1939                        "id": "msg_seed", "type": "message", "role": "assistant",
1940                        "model": "weak",
1941                        "content": [{
1942                            "type": "tool_use", "id": "toolu_weather", "name": "get_weather",
1943                            "input": {"city": "Paris"}
1944                        }],
1945                        "stop_reason": "tool_use", "usage": {"input_tokens": 3, "output_tokens": 1}
1946                    })
1947                };
1948                ResponseTemplate::new(200).set_body_json(response)
1949            })
1950            .mount(&server)
1951            .await;
1952
1953        let client: Arc<dyn RoutedLlmClient> = Arc::new(
1954            TranslatingLlmClient::new(&[ModelConfig::new(
1955                "weak",
1956                Backend::Anthropic(HttpBackendConfig {
1957                    base_url: server.uri(),
1958                    api_key: None,
1959                    forward_auth: false,
1960                    extra_headers: BTreeMap::new(),
1961                    extra_body: BTreeMap::new(),
1962                    omit_body_fields: BTreeSet::new(),
1963                    reasoning_effort: None,
1964                    max_retries: 0,
1965                    failure_cooldown: std::time::Duration::ZERO,
1966                    timeout: None,
1967                }),
1968                None,
1969            )])
1970            .map_err(|error| LibsyError::external("building test client", error))?,
1971        );
1972        let clients = ClientRouter::new(HashMap::from([(ModelId::from("weak"), client)]));
1973        let models = to_category_map(&["weak"]);
1974
1975        let mut seed = Request {
1976            llm_request: switchyard_translation::decode_request(
1977                WireFormat::OpenAiResponses,
1978                &json!({
1979                    "model": "route",
1980                    "input": "Call get_weather for Paris",
1981                    "tools": [{
1982                        "type": "function", "name": "get_weather",
1983                        "parameters": {"type": "object"}
1984                    }],
1985                    "store": true
1986                }),
1987            )
1988            .map_err(|error| LibsyError::external("decoding seed request", error))?,
1989            raw_request: None,
1990            metadata: None,
1991        };
1992        // Native item metadata must identify the Responses source after saved bodies are cleared.
1993        seed.llm_request.preservation.requests.clear();
1994        let (_, response) = run(
1995            Arc::new(switchyard_libsy::Passthrough),
1996            clients.clone(),
1997            seed,
1998            models.clone(),
1999            None,
2000        )
2001        .await?;
2002        assert_eq!(
2003            response
2004                .llm_response
2005                .as_agg()
2006                .and_then(|agg| agg.id.as_deref()),
2007            Some("msg_seed")
2008        );
2009
2010        let follow = Request {
2011            llm_request: switchyard_translation::decode_request(
2012                WireFormat::OpenAiResponses,
2013                &json!({
2014                    "model": "route",
2015                    "previous_response_id": "msg_seed",
2016                    "input": [{
2017                        "type": "function_call_output",
2018                        "call_id": "toolu_weather",
2019                        "output": "Paris is sunny"
2020                    }],
2021                    "tools": [{
2022                        "type": "function", "name": "get_weather",
2023                        "parameters": {"type": "object"}
2024                    }],
2025                    "store": true
2026                }),
2027            )
2028            .map_err(|error| LibsyError::external("decoding continuation request", error))?,
2029            raw_request: None,
2030            metadata: None,
2031        };
2032        let (_, response) = run(
2033            Arc::new(switchyard_libsy::Passthrough),
2034            clients.clone(),
2035            follow,
2036            models.clone(),
2037            None,
2038        )
2039        .await?;
2040        assert_eq!(
2041            completion_text(
2042                response
2043                    .llm_response
2044                    .as_agg()
2045                    .expect("buffered Anthropic response"),
2046            ),
2047            "sunny"
2048        );
2049
2050        let third = Request {
2051            llm_request: switchyard_translation::decode_request(
2052                WireFormat::OpenAiResponses,
2053                &json!({
2054                    "model": "route",
2055                    "previous_response_id": "msg_follow",
2056                    "input": "thanks",
2057                    "store": true
2058                }),
2059            )
2060            .map_err(|error| LibsyError::external("decoding chained request", error))?,
2061            raw_request: None,
2062            metadata: None,
2063        };
2064        let history = clients
2065            .stored_state_owner(&third)
2066            .and_then(|owner| owner.history)
2067            .expect("chained canonical history");
2068        assert_eq!(history.len, 4);
2069        assert_eq!(history.segment.len(), 2);
2070        assert!(history.parent.is_some());
2071        let (_, response) = run(
2072            Arc::new(switchyard_libsy::Passthrough),
2073            clients,
2074            third,
2075            models,
2076            None,
2077        )
2078        .await?;
2079        assert_eq!(
2080            completion_text(
2081                response
2082                    .llm_response
2083                    .as_agg()
2084                    .expect("buffered Anthropic response"),
2085            ),
2086            "done"
2087        );
2088
2089        let requests = server.received_requests().await.expect("request recording");
2090        assert_eq!(requests.len(), 3);
2091        let follow: Value = serde_json::from_slice(&requests[1].body)
2092            .map_err(|error| LibsyError::external("decoding captured request", error))?;
2093        assert_eq!(follow["messages"][1]["content"][0]["type"], "tool_use");
2094        assert_eq!(follow["messages"][2]["content"][0]["type"], "tool_result");
2095        let third: Value = serde_json::from_slice(&requests[2].body)
2096            .map_err(|error| LibsyError::external("decoding captured request", error))?;
2097        assert_eq!(third["messages"][1]["content"][0]["type"], "tool_use");
2098        assert_eq!(third["messages"][2]["content"][0]["type"], "tool_result");
2099        assert_eq!(third["messages"][3]["content"], "sunny");
2100        assert_eq!(third["messages"][4]["content"][0]["text"], "thanks");
2101        Ok(())
2102    }
2103
2104    #[tokio::test]
2105    async fn streamed_cross_format_state_is_recorded_only_after_completion() -> Result<()> {
2106        let client = Arc::new(CandidateClient {
2107            calls: Mutex::new(Vec::new()),
2108            requests: Mutex::new(Vec::new()),
2109            first: FirstOutcome::StreamSuccess,
2110        });
2111        let clients = ClientRouter::new(HashMap::from([(
2112            ModelId::from("weak"),
2113            client as Arc<dyn RoutedLlmClient>,
2114        )]));
2115        let mut seed = request();
2116        seed.llm_request.messages = vec![Message::text(Role::User, "inspect")];
2117        seed.llm_request
2118            .preservation
2119            .requests
2120            .insert(WireFormat::OpenAiResponses.into(), json!({}));
2121        let mut response = stream_response(vec![
2122            LlmResponseChunk::MessageStart {
2123                id: Some("msg_stream".to_string()),
2124                model: Some("weak".to_string()),
2125            },
2126            LlmResponseChunk::ToolCallDelta {
2127                index: 0,
2128                id: Some("toolu_stream".to_string()),
2129                name: Some("lookup".to_string()),
2130                arguments_delta: Some("{}".to_string()),
2131            },
2132            LlmResponseChunk::MessageStop {
2133                reason: Some("tool_use".to_string()),
2134            },
2135        ]);
2136        response.set_served_model(&ModelId::from("weak"));
2137        let response = clients.remember_state_owner(&seed, response)?;
2138
2139        let mut follow = request();
2140        follow
2141            .llm_request
2142            .extensions
2143            .fields
2144            .insert("previous_response_id".to_string(), json!("msg_stream"));
2145        follow.llm_request.messages = vec![Message {
2146            responses: None,
2147            role: Role::Tool,
2148            content: vec![ContentBlock::ToolResult(ToolResult {
2149                tool_call_id: "toolu_stream".to_string(),
2150                content: vec![ContentBlock::Text {
2151                    responses: None,
2152                    text: "ready".to_string(),
2153                }],
2154                is_error: None,
2155            })],
2156        }];
2157        assert!(clients.stored_state_owner(&follow).is_none());
2158        response
2159            .llm_response
2160            .into_agg()
2161            .await
2162            .map_err(|error| LibsyError::client_call("weak", error))?;
2163
2164        let outcome = continue_on(
2165            clients
2166                .stored_state_owner(&follow)
2167                .expect("completed stream state"),
2168            "passthrough",
2169            follow,
2170        );
2171        assert_eq!(outcome.request.llm_request.messages.len(), 3);
2172        assert!(matches!(
2173            outcome.request.llm_request.messages[1].content.as_slice(),
2174            [ContentBlock::ToolCall(call)] if call.id == "toolu_stream"
2175        ));
2176        assert!(matches!(
2177            outcome.request.llm_request.messages[2].content.as_slice(),
2178            [ContentBlock::ToolResult(result)] if result.tool_call_id == "toolu_stream"
2179        ));
2180        Ok(())
2181    }
2182
2183    #[test]
2184    fn cross_format_response_with_store_false_is_not_retained() -> Result<()> {
2185        let client = Arc::new(CandidateClient {
2186            calls: Mutex::new(Vec::new()),
2187            requests: Mutex::new(Vec::new()),
2188            first: FirstOutcome::StreamSuccess,
2189        });
2190        let clients = ClientRouter::new(HashMap::from([(
2191            ModelId::from("weak"),
2192            client as Arc<dyn RoutedLlmClient>,
2193        )]));
2194        let mut seed = request();
2195        seed.llm_request
2196            .extensions
2197            .fields
2198            .insert("store".to_string(), json!(false));
2199        seed.llm_request
2200            .preservation
2201            .requests
2202            .insert(WireFormat::OpenAiResponses.into(), json!({}));
2203        let mut agg = text_response(Some("weak".to_string()), "done".to_string());
2204        agg.id = Some("msg_not_stored".to_string());
2205        let mut response = Response {
2206            llm_response: LlmResponse::Agg(agg),
2207            metadata: None,
2208            upstream_headers: http::HeaderMap::new(),
2209        };
2210        response.set_served_model(&ModelId::from("weak"));
2211        clients.remember_state_owner(&seed, response)?;
2212
2213        let mut follow = request();
2214        follow
2215            .llm_request
2216            .extensions
2217            .fields
2218            .insert("previous_response_id".to_string(), json!("msg_not_stored"));
2219        assert!(clients.stored_state_owner(&follow).is_none());
2220        Ok(())
2221    }
2222
2223    #[tokio::test]
2224    async fn state_capacity_does_not_fail_completed_responses() -> Result<()> {
2225        let client = Arc::new(CandidateClient {
2226            calls: Mutex::new(Vec::new()),
2227            requests: Mutex::new(Vec::new()),
2228            first: FirstOutcome::StreamSuccess,
2229        });
2230        let clients = ClientRouter::new(HashMap::from([(
2231            ModelId::from("weak"),
2232            client as Arc<dyn RoutedLlmClient>,
2233        )]));
2234        let model = ModelId::from("weak");
2235        clients.inner.state_owners.lock().by_id = (0..MAX_STATE_OWNERS)
2236            .map(|id| {
2237                (
2238                    format!("existing_{id}"),
2239                    StoredState {
2240                        model: model.clone(),
2241                        history: None,
2242                    },
2243                )
2244            })
2245            .collect();
2246
2247        let mut request = request();
2248        request
2249            .llm_request
2250            .preservation
2251            .requests
2252            .insert(WireFormat::OpenAiResponses.into(), json!({}));
2253        let mut agg = text_response(Some("weak".to_string()), "done".to_string());
2254        agg.id = Some("overflow_buffered".to_string());
2255        let mut buffered = Response {
2256            llm_response: LlmResponse::Agg(agg),
2257            metadata: None,
2258            upstream_headers: http::HeaderMap::new(),
2259        };
2260        buffered.set_served_model(&model);
2261        clients.remember_state_owner(&request, buffered)?;
2262
2263        let mut streamed = stream_response(vec![
2264            LlmResponseChunk::MessageStart {
2265                id: Some("overflow_streamed".to_string()),
2266                model: Some("weak".to_string()),
2267            },
2268            LlmResponseChunk::TextDelta {
2269                index: 0,
2270                text: "done".to_string(),
2271            },
2272            LlmResponseChunk::MessageStop {
2273                reason: Some("stop".to_string()),
2274            },
2275        ]);
2276        streamed.set_served_model(&model);
2277        clients
2278            .remember_state_owner(&request, streamed)?
2279            .llm_response
2280            .into_agg()
2281            .await
2282            .map_err(|error| LibsyError::client_call("weak", error))?;
2283
2284        assert_eq!(
2285            clients.inner.state_owners.lock().by_id.len(),
2286            MAX_STATE_OWNERS
2287        );
2288        Ok(())
2289    }
2290
2291    #[test]
2292    fn state_owners_preserve_existing_records_at_capacity()
2293    -> std::result::Result<(), LlmClientError> {
2294        let mut owners = StateOwners::default();
2295        let model = ModelId::from("model/a");
2296        for id in 0..MAX_STATE_OWNERS - 1 {
2297            owners.remember(Some(&format!("resp_{id}")), None, &model, None)?;
2298        }
2299        assert!(matches!(
2300            owners.remember(Some("new_response"), Some("new_conversation"), &model, None,),
2301            Err(LlmClientError::ResponseStateLimitExceeded {
2302                limit: MAX_STATE_OWNERS
2303            })
2304        ));
2305        assert!(owners.owner("new_response").is_none());
2306        assert!(owners.owner("new_conversation").is_none());
2307        owners.remember(Some("last_id"), Some("last_id"), &model, None)?;
2308        owners.remember(Some("last_id"), Some("resp_0"), &model, None)?;
2309        assert!(matches!(
2310            owners.remember(Some("over_limit"), None, &model, None),
2311            Err(LlmClientError::ResponseStateLimitExceeded { .. })
2312        ));
2313        assert!(matches!(
2314            owners.remember(Some("resp_0"), None, &ModelId::from("model/b"), None,),
2315            Err(LlmClientError::ResponseStateConflict)
2316        ));
2317        assert_eq!(
2318            owners.owner("resp_0").map(|state| &state.model),
2319            Some(&model)
2320        );
2321        assert_eq!(owners.by_id.len(), MAX_STATE_OWNERS);
2322        Ok(())
2323    }
2324
2325    #[test]
2326    fn concurrent_state_owners_do_not_exceed_capacity() {
2327        let model = ModelId::from("model/a");
2328        let owners = Arc::new(Mutex::new(StateOwners {
2329            by_id: (0..MAX_STATE_OWNERS - 16)
2330                .map(|id| {
2331                    (
2332                        format!("existing_{id}"),
2333                        StoredState {
2334                            model: model.clone(),
2335                            history: None,
2336                        },
2337                    )
2338                })
2339                .collect(),
2340        }));
2341        let barrier = Arc::new(std::sync::Barrier::new(32));
2342        let accepted = std::thread::scope(|scope| {
2343            let handles = (0..32)
2344                .map(|id| {
2345                    let owners = owners.clone();
2346                    let barrier = barrier.clone();
2347                    let model = model.clone();
2348                    scope.spawn(move || {
2349                        barrier.wait();
2350                        let result = owners.lock().remember(
2351                            Some(&format!("resp_{id}")),
2352                            Some(&format!("conv_{id}")),
2353                            &model,
2354                            None,
2355                        );
2356                        match result {
2357                            Ok(()) => Some(id),
2358                            Err(LlmClientError::ResponseStateLimitExceeded { .. }) => None,
2359                            other => panic!("unexpected state tracking result: {other:?}"),
2360                        }
2361                    })
2362                })
2363                .collect::<Vec<_>>();
2364            handles
2365                .into_iter()
2366                .filter_map(|handle| handle.join().expect("request thread panicked"))
2367                .collect::<Vec<_>>()
2368        });
2369        let owners = owners.lock();
2370        assert_eq!(accepted.len(), 8);
2371        assert_eq!(owners.by_id.len(), MAX_STATE_OWNERS);
2372        assert_eq!(
2373            owners.owner("existing_0").map(|state| &state.model),
2374            Some(&model)
2375        );
2376        for id in accepted {
2377            assert_eq!(
2378                owners
2379                    .owner(&format!("resp_{id}"))
2380                    .map(|state| &state.model),
2381                Some(&model)
2382            );
2383            assert_eq!(
2384                owners
2385                    .owner(&format!("conv_{id}"))
2386                    .map(|state| &state.model),
2387                Some(&model)
2388            );
2389        }
2390    }
2391
2392    #[tokio::test]
2393    async fn each_fallback_candidate_receives_only_its_own_prompt() -> Result<()> {
2394        let client = Arc::new(CandidateClient {
2395            calls: Mutex::new(Vec::new()),
2396            requests: Mutex::new(Vec::new()),
2397            first: FirstOutcome::ContextWindow,
2398        });
2399        let routed_client: Arc<dyn RoutedLlmClient> = client.clone();
2400        let clients = ClientRouter::new_with_target_prompts(
2401            HashMap::from([
2402                (ModelId::from("weak"), Arc::clone(&routed_client)),
2403                (ModelId::from("strong"), routed_client),
2404            ]),
2405            HashMap::from([
2406                ("weak".into(), "weak prompt".to_string()),
2407                ("strong".into(), "strong prompt".to_string()),
2408            ]),
2409            None,
2410        );
2411
2412        run(
2413            Arc::new(CandidateAlgorithm {}),
2414            clients,
2415            request(),
2416            to_category_map(&["weak", "strong"]),
2417            None,
2418        )
2419        .await?;
2420
2421        let calls = client.requests.lock();
2422        assert_eq!(calls.len(), 2);
2423        assert_eq!(instruction_text(&calls[0]), ["weak prompt"]);
2424        assert_eq!(instruction_text(&calls[1]), ["strong prompt"]);
2425        Ok(())
2426    }
2427
2428    #[tokio::test]
2429    async fn decision_prompts_a_routing_response_target() -> Result<()> {
2430        let client = Arc::new(CandidateClient {
2431            calls: Mutex::new(Vec::new()),
2432            requests: Mutex::new(Vec::new()),
2433            first: FirstOutcome::StreamSuccess,
2434        });
2435        let routed_client: Arc<dyn RoutedLlmClient> = client.clone();
2436        let clients = ClientRouter::new_with_target_prompts(
2437            HashMap::from([(ModelId::from("answer"), routed_client)]),
2438            HashMap::from([("answer".into(), "answer prompt".to_string())]),
2439            Some("answer".into()),
2440        );
2441
2442        decide(
2443            Arc::new(AnsweredAlgorithm {
2444                model: "answer".into(),
2445            }),
2446            clients,
2447            request(),
2448            Arc::new(RuntimeModels::default()),
2449        )
2450        .await?;
2451
2452        let calls = client.requests.lock();
2453        assert_eq!(calls.len(), 1);
2454        assert_eq!(instruction_text(&calls[0]), ["answer prompt"]);
2455        Ok(())
2456    }
2457
2458    #[tokio::test]
2459    async fn decision_prepares_only_the_selected_request() -> Result<()> {
2460        let client = Arc::new(CandidateClient {
2461            calls: Mutex::new(Vec::new()),
2462            requests: Mutex::new(Vec::new()),
2463            first: FirstOutcome::StreamSuccess,
2464        });
2465        let routed_client: Arc<dyn RoutedLlmClient> = client;
2466        let clients = ClientRouter::new_with_target_prompts(
2467            HashMap::from([
2468                (ModelId::from("weak"), Arc::clone(&routed_client)),
2469                (ModelId::from("strong"), routed_client),
2470            ]),
2471            HashMap::from([
2472                (ModelId::from("weak"), "weak prompt".to_string()),
2473                (ModelId::from("strong"), "strong prompt".to_string()),
2474            ]),
2475            None,
2476        );
2477
2478        let outcome = decide(
2479            Arc::new(CandidateAlgorithm {}),
2480            clients,
2481            request(),
2482            to_category_map(&["weak", "strong"]),
2483        )
2484        .await?;
2485
2486        assert_eq!(
2487            outcome.selected_model_ids,
2488            [ModelId::from("weak"), ModelId::from("strong")]
2489        );
2490        assert_eq!(instruction_text(&outcome.request), ["weak prompt"]);
2491        Ok(())
2492    }
2493
2494    #[test]
2495    fn fallback_only_accepts_context_policy_and_unavailable_failures() {
2496        let error = |source| LibsyError::client_call("target", source);
2497        assert_eq!(
2498            fallback_reason(
2499                &error(LlmClientError::ContextWindowExceeded {
2500                    model: "target".into(),
2501                    message: "too long".to_string(),
2502                }),
2503                true
2504            ),
2505            Some(RoutingFallbackReason::ContextWindow)
2506        );
2507        for status in [
2508            StatusCode::FORBIDDEN,
2509            StatusCode::REQUEST_TIMEOUT,
2510            StatusCode::TOO_MANY_REQUESTS,
2511            StatusCode::INTERNAL_SERVER_ERROR,
2512            StatusCode::from_u16(599).expect("599 is a valid status"),
2513        ] {
2514            assert_eq!(
2515                fallback_reason(
2516                    &error(LlmClientError::UpstreamHttp {
2517                        status,
2518                        body: "failed".to_string(),
2519                    }),
2520                    true
2521                ),
2522                Some(RoutingFallbackReason::Unavailable)
2523            );
2524        }
2525        for (body, expected) in [
2526            (
2527                r#"{"error":{"code":"content_policy_violation"}}"#,
2528                Some(RoutingFallbackReason::Unavailable),
2529            ),
2530            (
2531                r#"{"error":{"code":"invalid_request_error"},"metadata":"content_policy_violation"}"#,
2532                None,
2533            ),
2534            (r#"{"error":{"message":"content_policy_violation"}}"#, None),
2535            ("content_policy_violation", None),
2536        ] {
2537            assert_eq!(
2538                fallback_reason(
2539                    &error(LlmClientError::UpstreamHttp {
2540                        status: StatusCode::BAD_REQUEST,
2541                        body: body.to_string(),
2542                    }),
2543                    true
2544                ),
2545                expected,
2546                "{body}"
2547            );
2548        }
2549        for status in [
2550            StatusCode::BAD_REQUEST,
2551            StatusCode::UNAUTHORIZED,
2552            StatusCode::NOT_FOUND,
2553            StatusCode::CONFLICT,
2554            StatusCode::from_u16(499).expect("499 is a valid status"),
2555            StatusCode::from_u16(600).expect("600 is a valid status"),
2556        ] {
2557            assert_eq!(
2558                fallback_reason(
2559                    &error(LlmClientError::UpstreamHttp {
2560                        status,
2561                        body: "failed".to_string(),
2562                    }),
2563                    true
2564                ),
2565                None
2566            );
2567        }
2568    }
2569
2570    #[tokio::test]
2571    async fn candidate_failures_follow_the_fallback_policy() -> Result<()> {
2572        // Context overflow is retryable across candidates.
2573        let (client, result) = run_candidates(FirstOutcome::ContextWindow).await;
2574        let (_, response) = result?;
2575        assert_eq!(
2576            &*client.calls.lock(),
2577            &[ModelId::from("weak"), "strong".into()]
2578        );
2579        assert_eq!(
2580            response
2581                .llm_response
2582                .as_agg()
2583                .map(|response| response.model.as_deref()),
2584            Some(Some("strong"))
2585        );
2586        assert_eq!(response.served_model().map(ModelId::as_str), Some("strong"));
2587
2588        // A provider-specific policy denial also permits another candidate.
2589        let (client, result) =
2590            run_candidates(FirstOutcome::ContentPolicy(StatusCode::BAD_REQUEST)).await;
2591        let (_, response) = result?;
2592        assert_eq!(
2593            &*client.calls.lock(),
2594            &[ModelId::from("weak"), "strong".into()]
2595        );
2596        assert_eq!(response.served_model().map(ModelId::as_str), Some("strong"));
2597
2598        // Authentication failure is not retryable, so the second candidate is untouched.
2599        let (client, result) = run_candidates(FirstOutcome::Unauthorized).await;
2600        assert!(matches!(
2601            result,
2602            Err(LibsyError::ClientCall {
2603                source: LlmClientError::UpstreamHttp {
2604                    status: StatusCode::UNAUTHORIZED,
2605                    ..
2606                },
2607                ..
2608            })
2609        ));
2610        assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
2611        Ok(())
2612    }
2613
2614    #[tokio::test]
2615    async fn fallback_candidates_receive_the_fallback_request() -> Result<()> {
2616        let client = Arc::new(CandidateClient {
2617            calls: Mutex::new(Vec::new()),
2618            requests: Mutex::new(Vec::new()),
2619            first: FirstOutcome::ContextWindow,
2620        });
2621        let clients = ClientRouter::single(client.clone());
2622        let mut seed = request();
2623        seed.llm_request
2624            .preservation
2625            .requests
2626            .insert(WireFormat::OpenAiResponses.into(), json!({}));
2627        run(
2628            Arc::new(RewritingAlgorithm {}),
2629            clients.clone(),
2630            seed,
2631            to_category_map(&["weak", "strong"]),
2632            None,
2633        )
2634        .await?;
2635        let sent: Vec<_> = client
2636            .requests
2637            .lock()
2638            .iter()
2639            .map(|request| request.llm_request.messages.clone())
2640            .collect();
2641        assert_eq!(sent.len(), 2);
2642        assert_eq!(sent[0].len(), request().llm_request.messages.len() + 1);
2643        assert_eq!(sent[1], request().llm_request.messages);
2644        let mut follow = request();
2645        follow
2646            .llm_request
2647            .extensions
2648            .fields
2649            .insert("previous_response_id".into(), json!("candidate_response"));
2650        follow.llm_request.messages = vec![Message::text(Role::User, "continue")];
2651        let owner = clients
2652            .stored_state_owner(&follow)
2653            .expect("fallback Responses state");
2654        let continued = continue_on(owner, "test", follow);
2655        let mut expected = sent[1].clone();
2656        expected.push(Message::text(Role::Assistant, "strong"));
2657        expected.push(Message::text(Role::User, "continue"));
2658        assert_eq!(continued.request.llm_request.messages, expected);
2659        Ok(())
2660    }
2661
2662    #[tokio::test]
2663    async fn fallback_request_does_not_bypass_content_policy() -> Result<()> {
2664        for status in [StatusCode::BAD_REQUEST, StatusCode::FORBIDDEN] {
2665            let client = Arc::new(CandidateClient {
2666                calls: Mutex::new(Vec::new()),
2667                requests: Mutex::new(Vec::new()),
2668                first: FirstOutcome::ContentPolicy(status),
2669            });
2670            let result = run(
2671                Arc::new(RewritingAlgorithm {}),
2672                ClientRouter::single(client.clone()),
2673                request(),
2674                to_category_map(&["weak", "strong"]),
2675                None,
2676            )
2677            .await;
2678            assert!(
2679                matches!(result, Err(LibsyError::ClientCall { source: LlmClientError::UpstreamHttp { status: actual, .. }, .. }) if actual == status)
2680            );
2681            assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
2682        }
2683        Ok(())
2684    }
2685
2686    #[tokio::test]
2687    async fn retry_exhaustion_falls_back_and_optional_cooldown_skips_failed_backend() -> Result<()>
2688    {
2689        let server = MockServer::start().await;
2690        let calls = Arc::new(Mutex::new(Vec::new()));
2691        let observed_calls = Arc::clone(&calls);
2692        Mock::given(method("POST"))
2693            .respond_with(move |request: &wiremock::Request| {
2694                let body: serde_json::Value =
2695                    serde_json::from_slice(&request.body).unwrap_or(serde_json::Value::Null);
2696                let model = body["model"].as_str().unwrap_or_default().to_string();
2697                observed_calls.lock().push(model.clone());
2698                if model == "weak" {
2699                    ResponseTemplate::new(503)
2700                        .insert_header("retry-after", "0")
2701                        .set_body_string("unavailable")
2702                } else {
2703                    ResponseTemplate::new(200).set_body_json(serde_json::json!({
2704                        "id": "answer",
2705                        "model": "strong",
2706                        "choices": [{
2707                            "index": 0,
2708                            "message": {"role": "assistant", "content": "ok"},
2709                            "finish_reason": "stop"
2710                        }],
2711                        "usage": {}
2712                    }))
2713                }
2714            })
2715            .mount(&server)
2716            .await;
2717
2718        let client_with_cooldown = |cooldown| {
2719            let backend = || {
2720                Backend::OpenAiChat(HttpBackendConfig {
2721                    base_url: format!("{}/v1", server.uri()),
2722                    api_key: None,
2723                    forward_auth: false,
2724                    extra_headers: BTreeMap::new(),
2725                    extra_body: BTreeMap::new(),
2726                    omit_body_fields: BTreeSet::new(),
2727                    reasoning_effort: None,
2728                    max_retries: 2,
2729                    failure_cooldown: cooldown,
2730                    timeout: None,
2731                })
2732            };
2733            TranslatingLlmClient::new(&[
2734                ModelConfig::new("weak", backend(), None),
2735                ModelConfig::new("strong", backend(), None),
2736            ])
2737            .map(Arc::new)
2738            .map_err(|error| LibsyError::external("building test client", error))
2739        };
2740        let call = async |client: Arc<TranslatingLlmClient>| {
2741            run(
2742                Arc::new(CandidateAlgorithm {}),
2743                ClientRouter::single(client),
2744                request(),
2745                to_category_map(&["weak", "strong"]),
2746                None,
2747            )
2748            .await?;
2749            Ok::<_, LibsyError>(std::mem::take(&mut *calls.lock()))
2750        };
2751
2752        let client = client_with_cooldown(std::time::Duration::ZERO)?;
2753        assert_eq!(
2754            call(client.clone()).await?,
2755            ["weak", "weak", "weak", "strong"]
2756        );
2757        assert_eq!(call(client).await?, ["weak", "weak", "weak", "strong"]);
2758
2759        let cooldown = std::time::Duration::from_secs(60);
2760        let client = client_with_cooldown(cooldown)?;
2761        assert_eq!(
2762            call(client.clone()).await?,
2763            ["weak", "weak", "weak", "strong"]
2764        );
2765        assert_eq!(call(client.clone()).await?, ["strong"]);
2766
2767        tokio::time::pause();
2768        tokio::time::advance(cooldown).await;
2769        tokio::time::resume();
2770
2771        assert_eq!(call(client).await?, ["weak", "weak", "weak", "strong"]);
2772        Ok(())
2773    }
2774
2775    #[tokio::test]
2776    async fn refused_connection_falls_back_to_the_next_candidate() -> Result<()> {
2777        let server = MockServer::start().await;
2778        Mock::given(method("POST"))
2779            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
2780                "id": "answer",
2781                "model": "strong",
2782                "choices": [{
2783                    "index": 0,
2784                    "message": {"role": "assistant", "content": "ok"},
2785                    "finish_reason": "stop"
2786                }],
2787                "usage": {}
2788            })))
2789            .mount(&server)
2790            .await;
2791
2792        let backend = |base_url: String| {
2793            Backend::OpenAiChat(HttpBackendConfig {
2794                base_url,
2795                api_key: None,
2796                forward_auth: false,
2797                extra_headers: BTreeMap::new(),
2798                extra_body: BTreeMap::new(),
2799                omit_body_fields: BTreeSet::new(),
2800                reasoning_effort: None,
2801                max_retries: 0,
2802                failure_cooldown: std::time::Duration::ZERO,
2803                timeout: None,
2804            })
2805        };
2806        let client = Arc::new(
2807            TranslatingLlmClient::new(&[
2808                // Nothing listens on port 1, so the connection is refused.
2809                ModelConfig::new("weak", backend("http://127.0.0.1:1/v1".to_string()), None),
2810                ModelConfig::new("strong", backend(format!("{}/v1", server.uri())), None),
2811            ])
2812            .map_err(|error| LibsyError::external("building test client", error))?,
2813        );
2814        let (_, response) = run(
2815            Arc::new(CandidateAlgorithm {}),
2816            ClientRouter::single(client),
2817            request(),
2818            to_category_map(&["weak", "strong"]),
2819            None,
2820        )
2821        .await?;
2822
2823        assert_eq!(response.served_model().map(ModelId::as_str), Some("strong"));
2824        Ok(())
2825    }
2826
2827    #[tokio::test]
2828    async fn streams_are_outside_the_candidate_fallback_boundary() -> Result<()> {
2829        // Receiving a stream handle is a successful call and ends candidate selection.
2830        let (client, result) = run_candidates(FirstOutcome::StreamSuccess).await;
2831        let (_, response) = result?;
2832        assert_eq!(response.served_model().map(ModelId::as_str), Some("weak"));
2833        let aggregate = response
2834            .llm_response
2835            .into_agg()
2836            .await
2837            .map_err(|source| LibsyError::client_call("weak", source))?;
2838        assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
2839        assert_eq!(completion_text(&aggregate), "streamed");
2840
2841        // A later in-stream failure surfaces during aggregation without trying another model.
2842        let (client, result) = run_candidates(FirstOutcome::MidStreamError).await;
2843        let (_, response) = result?;
2844        let error = response
2845            .llm_response
2846            .into_agg()
2847            .await
2848            .expect_err("the stream should fail during aggregation");
2849        assert!(error.to_string().contains("stream failed"));
2850        assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
2851        Ok(())
2852    }
2853
2854    // Verbatim shape of an SGLang admission rejection on a streaming session:
2855    // HTTP 200, and the overflow arrives as the first SSE event.
2856    const OVERFLOW_SSE: &str = "data: {\"error\":{\"code\":400,\"message\":\"Input length (600013 tokens) exceeds the maximum allowed length (536826 tokens). Use a shorter input or enable --allow-auto-truncate.\",\"object\":\"error\",\"param\":null,\"type\":\"BAD_REQUEST\"},\"model\":\"weak\"}\n\ndata: [DONE]\n\n";
2857
2858    // A normal one-turn streamed answer, as the second candidate serves it.
2859    const STRONG_SSE: &str = "data: {\"id\":\"answer\",\"model\":\"strong\",\"choices\":[{\"index\":0,\"delta\":{\"role\":\"assistant\",\"content\":\"ok\"},\"finish_reason\":null}]}\n\ndata: {\"id\":\"answer\",\"model\":\"strong\",\"choices\":[{\"index\":0,\"delta\":{},\"finish_reason\":\"stop\"}]}\n\ndata: [DONE]\n\n";
2860
2861    /// Runs a streaming request through the weak→strong candidate loop, serving
2862    /// `weak_sse` from the first candidate and [`STRONG_SSE`] from the second.
2863    /// The server is returned so response streams stay readable after the call.
2864    async fn run_streaming_candidates(
2865        weak_sse: &'static str,
2866    ) -> (
2867        MockServer,
2868        Arc<Mutex<Vec<String>>>,
2869        Result<(ModelId, Response)>,
2870    ) {
2871        let server = MockServer::start().await;
2872        let calls = Arc::new(Mutex::new(Vec::new()));
2873        let observed_calls = Arc::clone(&calls);
2874        Mock::given(method("POST"))
2875            .respond_with(move |request: &wiremock::Request| {
2876                let body: serde_json::Value =
2877                    serde_json::from_slice(&request.body).unwrap_or(serde_json::Value::Null);
2878                let model = body["model"].as_str().unwrap_or_default().to_string();
2879                observed_calls.lock().push(model.clone());
2880                let sse = if model == "weak" {
2881                    weak_sse
2882                } else {
2883                    STRONG_SSE
2884                };
2885                ResponseTemplate::new(200)
2886                    .insert_header("content-type", "text/event-stream")
2887                    .set_body_string(sse)
2888            })
2889            .mount(&server)
2890            .await;
2891
2892        let backend = || {
2893            Backend::OpenAiChat(HttpBackendConfig {
2894                base_url: format!("{}/v1", server.uri()),
2895                api_key: None,
2896                forward_auth: false,
2897                extra_headers: BTreeMap::new(),
2898                extra_body: BTreeMap::new(),
2899                omit_body_fields: BTreeSet::new(),
2900                reasoning_effort: None,
2901                max_retries: 0,
2902                failure_cooldown: std::time::Duration::ZERO,
2903                timeout: None,
2904            })
2905        };
2906        let client = Arc::new(
2907            TranslatingLlmClient::new(&[
2908                ModelConfig::new("weak", backend(), None),
2909                ModelConfig::new("strong", backend(), None),
2910            ])
2911            .expect("building test client"),
2912        );
2913        let algorithm = Arc::new(CandidateAlgorithm {});
2914        let mut llm_request = text_request(Some("auto".to_string()), "hello".to_string());
2915        llm_request.stream = true;
2916        let request = Request {
2917            llm_request,
2918            raw_request: None,
2919            metadata: None,
2920        };
2921        let result = run(
2922            algorithm,
2923            ClientRouter::single(client),
2924            request,
2925            to_category_map(&["weak", "strong"]),
2926            None,
2927        )
2928        .await;
2929        (server, calls, result)
2930    }
2931
2932    #[tokio::test]
2933    async fn first_stream_event_overflow_falls_back_to_the_next_candidate() -> Result<()> {
2934        // Nothing has reached the caller when the first event arrives, so an overflow
2935        // there falls through to the next candidate exactly as its buffered twin does.
2936        let (_server, calls, result) = run_streaming_candidates(OVERFLOW_SSE).await;
2937        let (_, response) = result?;
2938        assert_eq!(&*calls.lock(), &["weak", "strong"]);
2939        assert_eq!(response.served_model().map(ModelId::as_str), Some("strong"));
2940        let aggregate = response
2941            .llm_response
2942            .into_agg()
2943            .await
2944            .map_err(|source| LibsyError::client_call("strong", source))?;
2945        assert_eq!(completion_text(&aggregate), "ok");
2946
2947        // Only a classified overflow re-routes; any other in-band error event still
2948        // streams through to the consumer without trying another candidate.
2949        let (_server, calls, result) = run_streaming_candidates(
2950            "data: {\"error\":{\"code\":500,\"message\":\"engine exploded\",\"object\":\"error\"},\"model\":\"weak\"}\n\ndata: [DONE]\n\n",
2951        )
2952        .await;
2953        let (_, response) = result?;
2954        assert_eq!(&*calls.lock(), &["weak"]);
2955        let error = response
2956            .llm_response
2957            .into_agg()
2958            .await
2959            .expect_err("the in-band error should surface to the consumer");
2960        assert!(error.to_string().contains("engine exploded"));
2961
2962        // Once content has streamed, a retry would repeat delivered output, so a later
2963        // overflow event keeps today's semantics and surfaces during aggregation.
2964        let (_server, calls, result) = run_streaming_candidates(
2965            "data: {\"id\":\"turn\",\"model\":\"weak\",\"choices\":[{\"index\":0,\"delta\":{\"role\":\"assistant\",\"content\":\"partial\"},\"finish_reason\":null}]}\n\ndata: {\"error\":{\"code\":400,\"message\":\"Input length (600013 tokens) exceeds the maximum allowed length (536826 tokens).\",\"object\":\"error\",\"type\":\"BAD_REQUEST\"},\"model\":\"weak\"}\n\ndata: [DONE]\n\n",
2966        )
2967        .await;
2968        let (_, response) = result?;
2969        assert_eq!(&*calls.lock(), &["weak"]);
2970        let error = response
2971            .llm_response
2972            .into_agg()
2973            .await
2974            .expect_err("the mid-stream overflow should surface to the consumer");
2975        assert!(
2976            error
2977                .to_string()
2978                .contains("exceeds the maximum allowed length")
2979        );
2980
2981        // A stream that ends before any event is not a classified failure; it still
2982        // aggregates to an empty response.
2983        let (_server, calls, result) = run_streaming_candidates("data: [DONE]\n\n").await;
2984        let (_, response) = result?;
2985        assert_eq!(&*calls.lock(), &["weak"]);
2986        let aggregate = response
2987            .llm_response
2988            .into_agg()
2989            .await
2990            .map_err(|source| LibsyError::client_call("weak", source))?;
2991        assert_eq!(completion_text(&aggregate), "");
2992        Ok(())
2993    }
2994}