1use 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
43pub 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 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
139async 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
194pub 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
255fn 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
278async 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
315async 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#[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#[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: usize,
439 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 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
500async 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
527fn 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
561fn 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
582struct 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 history: Option<Arc<MessageHistory>>,
623}
624
625#[derive(Clone)]
626struct CanonicalInput {
627 parent: Option<Arc<MessageHistory>>,
628 messages: Arc<[Message]>,
629}
630
631#[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
694fn 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#[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 state_owners: Mutex<StateOwners>,
722 track_provider_state: bool,
724}
725
726enum Routing {
727 Single(Arc<dyn RoutedLlmClient>),
729 ByModel(HashMap<ModelId, Arc<dyn RoutedLlmClient>>),
731}
732
733impl ClientRouter {
734 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 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 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 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 pub fn single(client: Arc<dyn RoutedLlmClient>) -> Self {
817 Self::single_with_decision_clients(client, HashMap::new())
818 }
819
820 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 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 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 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 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 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 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 || fields.contains_key("previous_response_id")
936 || fields.contains_key("conversation");
937 if !responses_request && !self.inner.track_provider_state {
938 return Ok(response);
939 }
940 let canonical_input = responses_request.then(|| self.canonical_input(request));
941 response.llm_response = match response.llm_response {
942 LlmResponse::Agg(agg) => {
943 if let Some(body) = agg.preservation.responses.get(&responses_format) {
944 if self.inner.track_provider_state {
945 self.remember_response(body, &model, store, conversation.as_deref())
946 .map_err(|error| LibsyError::client_call(model.clone(), error))?;
947 }
948 } else if let Some(input) = &canonical_input {
949 self.remember_canonical_response(&agg, &model, store, input)
950 .map_err(|error| LibsyError::client_call(model.clone(), error))?;
951 }
952 LlmResponse::Agg(agg)
953 }
954 LlmResponse::Stream(stream) => {
955 let router = self.clone();
956 LlmResponse::Stream(Box::pin(futures_util::stream::try_unfold(
957 (
958 stream,
959 router,
960 model,
961 conversation,
962 canonical_input,
963 ResponseAccumulator::new(),
964 false,
965 true,
966 ),
967 move |(
968 mut stream,
969 router,
970 model,
971 conversation,
972 canonical_input,
973 mut accumulator,
974 mut native_responses,
975 mut valid,
976 )| async move {
977 let Some(event) = stream.next().await else {
978 if let Some(input) = &canonical_input
979 && !native_responses
980 && valid
981 {
982 router.remember_canonical_response(
983 &accumulator.finish(),
984 &model,
985 store,
986 input,
987 )?;
988 }
989 return Ok(None);
990 };
991 let event = event?;
992 if let Some(preserved) = event.preservation()
993 && preserved.source().as_str() == WireFormat::OpenAiResponses.as_str()
994 {
995 native_responses = true;
996 if router.inner.track_provider_state
997 && let Some(body) = preserved.raw().get("response")
998 {
999 router.remember_response(
1000 body,
1001 &model,
1002 store,
1003 conversation.as_deref(),
1004 )?;
1005 }
1006 }
1007 if responses_request {
1008 for chunk in event.normalized() {
1009 if matches!(
1010 chunk,
1011 LlmResponseChunk::DecodeError { .. }
1012 | LlmResponseChunk::StreamError { .. }
1013 ) {
1014 valid = false;
1015 } else {
1016 accumulator.push(chunk.clone());
1017 }
1018 }
1019 }
1020 Ok(Some((
1021 event,
1022 (
1023 stream,
1024 router,
1025 model,
1026 conversation,
1027 canonical_input,
1028 accumulator,
1029 native_responses,
1030 valid,
1031 ),
1032 )))
1033 },
1034 )))
1035 }
1036 };
1037 Ok(response)
1038 }
1039
1040 fn remember_response(
1043 &self,
1044 body: &Value,
1045 model: &ModelId,
1046 store: bool,
1047 conversation: Option<&str>,
1048 ) -> std::result::Result<(), LlmClientError> {
1049 let mut owners = self.inner.state_owners.lock();
1050 let response_id = body
1051 .get("id")
1052 .and_then(Value::as_str)
1053 .filter(|_| body.get("store").and_then(Value::as_bool).unwrap_or(store));
1054 let conversation = body.as_object().and_then(conversation_id).or(conversation);
1055 if let Err(error) = owners.remember(response_id, conversation, model, None) {
1056 if matches!(error, LlmClientError::ResponseStateLimitExceeded { .. }) {
1057 tracing::warn!(%error, "Responses state owner capacity reached; state was not retained");
1058 } else {
1059 tracing::error!(%error, "could not record Responses state owner");
1060 return Err(error);
1061 }
1062 }
1063 Ok(())
1064 }
1065
1066 fn remember_canonical_response(
1067 &self,
1068 response: &AggLlmResponse,
1069 model: &ModelId,
1070 store: bool,
1071 input: &CanonicalInput,
1072 ) -> std::result::Result<(), LlmClientError> {
1073 let response_id = response.id.as_deref().filter(|_| store);
1074 if response_id.is_none() {
1075 return Ok(());
1076 }
1077 let mut segment = input.messages.to_vec();
1078 segment.extend(response.outputs.iter().map(|output| Message {
1079 role: output.role,
1080 content: output.content.clone(),
1081 }));
1082 let history = Arc::new(MessageHistory::new(
1083 input.parent.clone(),
1084 Arc::from(segment),
1085 ));
1086 let result =
1087 self.inner
1088 .state_owners
1089 .lock()
1090 .remember(response_id, None, model, Some(history));
1091 if let Err(error) = result {
1092 if matches!(error, LlmClientError::ResponseStateLimitExceeded { .. }) {
1093 tracing::warn!(%error, "cross-format Responses state capacity reached; history was not retained");
1094 return Ok(());
1095 }
1096 tracing::error!(%error, "could not record cross-format Responses state");
1097 return Err(error);
1098 }
1099 Ok(())
1100 }
1101
1102 fn prepare_completion_request(&self, mut request: Request, target: &ModelId) -> Request {
1104 let prompt = self.inner.target_prompts.get(target).map(String::as_str);
1105 prepare_request_for_target(&mut request.llm_request, target, prompt);
1106 request
1107 }
1108
1109 fn prepare_routing_request(&self, mut request: Request, target: &ModelId) -> Request {
1111 let prompt = if self.inner.routing_answer_target.as_ref() == Some(target) {
1112 self.inner.target_prompts.get(target).map(String::as_str)
1113 } else {
1114 None
1115 };
1116 prepare_request_for_target(&mut request.llm_request, target, prompt);
1117 request
1118 }
1119}
1120
1121impl FromIterator<(ModelId, Arc<dyn RoutedLlmClient>)> for ClientRouter {
1122 fn from_iter<I: IntoIterator<Item = (ModelId, Arc<dyn RoutedLlmClient>)>>(iter: I) -> Self {
1123 Self::new(iter.into_iter().collect())
1124 }
1125}
1126
1127#[cfg(test)]
1128mod tests {
1129 use std::collections::{BTreeMap, BTreeSet};
1130
1131 use super::*;
1132 use async_trait::async_trait;
1133 use futures::StreamExt;
1134 use http::StatusCode;
1135 use switchyard_libsy::{Driver, RoutingOutcome};
1136 use switchyard_protocol::{
1137 ContentBlock, LlmResponse, LlmResponseChunk, LlmResponseStreamEvent, Message, Role,
1138 ToolResult, completion_text, text_request, text_response,
1139 };
1140 use wiremock::matchers::method;
1141 use wiremock::{Mock, MockServer, ResponseTemplate};
1142
1143 use crate::{Backend, HttpBackendConfig, ModelConfig, TranslatingLlmClient};
1144 use switchyard_protocol::Category;
1145
1146 struct CandidateAlgorithm {}
1147
1148 struct AnsweredAlgorithm {
1149 model: ModelId,
1150 }
1151
1152 #[async_trait]
1153 impl Algorithm for CandidateAlgorithm {
1154 fn name(&self) -> &str {
1155 "candidate_test"
1156 }
1157
1158 async fn route(
1159 self: Arc<Self>,
1160 driver: Driver,
1161 request: Request,
1162 ) -> Result<RoutingOutcome> {
1163 let models = driver.models_for(&Category::Any);
1164 let selected_model = models.first().cloned().ok_or(LibsyError::NoTargets)?;
1165 Ok(RoutingOutcome::route_to(
1166 selected_model,
1167 models.iter().skip(1).cloned().collect(),
1168 request,
1169 ))
1170 }
1171 }
1172
1173 #[async_trait]
1174 impl Algorithm for AnsweredAlgorithm {
1175 fn name(&self) -> &str {
1176 "answered_test"
1177 }
1178
1179 async fn route(
1180 self: Arc<Self>,
1181 driver: Driver,
1182 request: Request,
1183 ) -> Result<RoutingOutcome> {
1184 let response = driver
1185 .call_model(request.clone(), vec![self.model.clone()])
1186 .await?;
1187 Ok(RoutingOutcome::answered(
1188 self.model.clone(),
1189 request,
1190 response,
1191 ))
1192 }
1193 }
1194
1195 struct RewritingAlgorithm {}
1197
1198 #[async_trait]
1199 impl Algorithm for RewritingAlgorithm {
1200 fn name(&self) -> &str {
1201 "rewriting_test"
1202 }
1203
1204 async fn route(
1205 self: Arc<Self>,
1206 _driver: Driver,
1207 request: Request,
1208 ) -> Result<RoutingOutcome> {
1209 let mut rewritten = request.clone();
1210 rewritten
1211 .llm_request
1212 .messages
1213 .push(Message::text(Role::User, "for weak only"));
1214 let mut outcome =
1215 RoutingOutcome::route_to("weak".into(), vec!["strong".into()], rewritten);
1216 outcome.fallback_request = Some(request);
1217 Ok(outcome)
1218 }
1219 }
1220
1221 #[derive(Clone, Copy)]
1222 enum FirstOutcome {
1223 ContextWindow,
1224 ContentPolicy(StatusCode),
1225 Unauthorized,
1226 StreamSuccess,
1227 MidStreamError,
1228 }
1229
1230 struct CandidateClient {
1231 calls: Mutex<Vec<ModelId>>,
1232 requests: Mutex<Vec<Request>>,
1233 first: FirstOutcome,
1234 }
1235
1236 #[async_trait]
1237 impl RoutedLlmClient for CandidateClient {
1238 async fn call(&self, request: Request) -> std::result::Result<Response, LlmClientError> {
1239 let model = request.model_id().unwrap_or_default();
1240 self.calls.lock().push(model.clone());
1241 self.requests.lock().push(request);
1242 if model == "weak" {
1243 return match self.first {
1244 FirstOutcome::ContextWindow => Err(LlmClientError::ContextWindowExceeded {
1245 model,
1246 message: "too long".to_string(),
1247 }),
1248 FirstOutcome::ContentPolicy(status) => Err(LlmClientError::UpstreamHttp {
1249 status,
1250 body: r#"{"error":{"code":"content_policy_violation","message":"request blocked by content policy","type":"invalid_request_error"},"metadata":{"documentation_section":"context window"}}"#.to_string(),
1251 }),
1252 FirstOutcome::Unauthorized => Err(LlmClientError::UpstreamHttp {
1253 status: StatusCode::UNAUTHORIZED,
1254 body: "unauthorized".to_string(),
1255 }),
1256 FirstOutcome::StreamSuccess => Ok(stream_response(vec![
1257 LlmResponseChunk::TextDelta {
1258 index: 0,
1259 text: "streamed".to_string(),
1260 },
1261 LlmResponseChunk::MessageStop {
1262 reason: Some("stop".to_string()),
1263 },
1264 ])),
1265 FirstOutcome::MidStreamError => Ok(stream_response(vec![
1266 LlmResponseChunk::TextDelta {
1267 index: 0,
1268 text: "partial".to_string(),
1269 },
1270 LlmResponseChunk::StreamError {
1271 message: "stream failed".to_string(),
1272 },
1273 LlmResponseChunk::MessageStop { reason: Some("stop".into()) },
1274 ])),
1275 };
1276 }
1277 Ok(Response {
1278 llm_response: LlmResponse::Agg(AggLlmResponse {
1279 id: Some("candidate_response".into()),
1280 ..text_response(Some(model.to_string()), model)
1281 }),
1282 metadata: None,
1283 upstream_headers: http::HeaderMap::new(),
1284 })
1285 }
1286 }
1287
1288 fn stream_response(chunks: Vec<LlmResponseChunk>) -> Response {
1289 Response {
1290 llm_response: LlmResponse::Stream(
1291 futures::stream::iter(
1292 chunks
1293 .into_iter()
1294 .map(|chunk| Ok(LlmResponseStreamEvent::from(chunk))),
1295 )
1296 .boxed(),
1297 ),
1298 metadata: None,
1299 upstream_headers: http::HeaderMap::new(),
1300 }
1301 }
1302
1303 fn request() -> Request {
1304 Request {
1305 llm_request: text_request(Some("auto".to_string()), "hello".to_string()),
1306 raw_request: None,
1307 metadata: None,
1308 }
1309 }
1310
1311 #[tokio::test]
1312 async fn system_one_serves_decisions_and_returns_failures_to_the_classifier()
1313 -> std::result::Result<(), Box<dyn std::error::Error>> {
1314 use std::time::Duration;
1315 use switchyard_libsy::{
1316 CapabilityJudgeConfig, DecisionJudgeConfig, LlmClassifierConfig, LlmTaskClassifier,
1317 TaskClassifierConfig,
1318 };
1319 use switchyard_protocol::{
1320 BooleanEstimate, DecisionRequest, DecisionValue, Probability, ScoreValue,
1321 };
1322 use wiremock::matchers::{body_partial_json, header, path};
1323
1324 let server = MockServer::start().await;
1325 let client = Arc::new(crate::SystemOneClient::new(
1326 format!("{}/v1/systemone", server.uri()).parse()?,
1327 "test-key".into(),
1328 Duration::from_secs(2),
1329 )?);
1330 assert!(matches!(
1331 crate::SystemOneClient::new(
1332 format!("{}/v1/systemone", server.uri()).parse()?,
1333 "invalid\nkey".into(),
1334 Duration::from_secs(2),
1335 ),
1336 Err(LlmClientError::Configuration { .. })
1337 ));
1338 let mixed: DecisionRequest = serde_json::from_value(json!({
1339 "model": "judge", "input": [Message::text(Role::User, "A simple task")],
1340 "questions": {
1341 "boolean": {"instructions": "Is it simple?", "kind": {"type": "boolean", "data": {
1342 "true_description": ["Simple"], "false_description": null
1343 }}},
1344 "route": {"instructions": "Choose", "kind": {"type": "choice", "data": {
1345 "options": [{"id": "capable", "description": "A wins"}, {"id": "efficient", "description": "B wins"}]
1346 }}},
1347 "score": {"instructions": "Rate difficulty", "kind": {"type": "score", "data": {
1348 "levels": ["Easy", {"description": "Hard"}]
1349 }}}
1350 }
1351 }))?;
1352 let mut body = json!({
1353 "model": "jev-1.13.0", "usage": {"input_tokens": 42, "output_tokens": 3},
1354 "answers": {
1355 "boolean": {"type": "noul", "noul": 0.9},
1356 "route": {"type": "choice", "choice": "efficient", "confidence": 0.7,
1357 "probabilities": {"capable": 0.2, "efficient": 0.8}},
1358 "score": {"type": "score", "score": 0.6, "confidence": 0.3,
1359 "legend": {"0": "Easy", "1": {"description": "Hard"}},
1360 "probabilities": {"1": 0.6, "0": 0.4}}
1361 }
1362 });
1363 Mock::given(method("POST"))
1364 .and(path("/v1/systemone"))
1365 .and(header("authorization", "Bearer test-key"))
1366 .and(body_partial_json(json!({
1367 "model": "judge", "state": mixed.input,
1368 "questions": {
1369 "boolean": {"type": "noul", "criteria": {"true": ["Simple"]}},
1370 "route": {"type": "choice", "instructions": "Choose",
1371 "criteria": {"capable": "A wins", "efficient": "B wins"}},
1372 "score": {"type": "score", "criteria": ["Easy", {"description": "Hard"}]}
1373 }
1374 })))
1375 .respond_with(ResponseTemplate::new(200).set_body_json(&body))
1376 .expect(1)
1377 .mount(&server)
1378 .await;
1379 let response = client.call(mixed.clone()).await?;
1380 assert_eq!(response.model.as_deref(), Some("jev-1.13.0"));
1381 assert_eq!(response.id, None);
1382 assert_eq!(response.usage.input_tokens, Some(42));
1383 assert_eq!(response.usage.total_tokens, None);
1384 assert_eq!(
1385 response.answers["boolean"].value,
1386 DecisionValue::Boolean(BooleanEstimate::ProbabilityTrue(Probability(0.9)))
1387 );
1388 assert_eq!(
1389 response.answers["score"].value,
1390 DecisionValue::Score {
1391 value: ScoreValue(0.6),
1392 probabilities: Some(vec![Probability(0.4), Probability(0.6)]),
1393 }
1394 );
1395 assert_eq!(
1396 response.answers["route"].provider_confidence.map(|c| c.0),
1397 Some(0.7)
1398 );
1399 server.verify().await;
1400
1401 let mut partial = body.clone();
1402 partial["answers"]
1403 .as_object_mut()
1404 .unwrap()
1405 .remove("boolean");
1406 let mut invalid_responses = vec![json!({"answers": {}}), partial];
1407 for (id, answer) in [
1408 ("unknown-question", json!({"type": "noul", "noul": 0.9})),
1409 ("boolean", json!({"type": "score", "score": 0.0})),
1410 (
1411 "route",
1412 json!({"type": "choice", "choice": "unknown-option",
1413 "probabilities": {"capable": 0.2, "efficient": 0.8}}),
1414 ),
1415 ("score", json!({"type": "score", "score": -0.1})),
1416 (
1417 "score",
1418 json!({"type": "score", "score": 1.1,
1419 "probabilities": {"0": 0.4, "1": 0.6}}),
1420 ),
1421 ] {
1422 let mut invalid = body.clone();
1423 invalid["answers"][id] = answer;
1424 if id == "unknown-question" {
1425 invalid["answers"]
1426 .as_object_mut()
1427 .unwrap()
1428 .remove("boolean");
1429 }
1430 invalid_responses.push(invalid);
1431 }
1432 for template in invalid_responses
1433 .into_iter()
1434 .map(|body| ResponseTemplate::new(200).set_body_json(body))
1435 .chain([ResponseTemplate::new(200).set_body_string("invalid JSON")])
1436 {
1437 server.reset().await;
1438 Mock::given(method("POST"))
1439 .respond_with(template)
1440 .expect(1)
1441 .mount(&server)
1442 .await;
1443 assert!(matches!(
1444 client.call(mixed.clone()).await,
1445 Err(LlmClientError::ResponseTranslation(_) | LlmClientError::InvalidResponse { .. })
1446 ));
1447 server.verify().await;
1448 }
1449
1450 body["answers"].as_object_mut().unwrap().remove("boolean");
1451 body["answers"].as_object_mut().unwrap().remove("score");
1452 let models = Arc::new(RuntimeModels::new(HashMap::from([
1453 (Category::Judge, vec!["judge".into()]),
1454 (Category::Capable, vec!["capable".into()]),
1455 (Category::Efficient, vec!["efficient".into()]),
1456 (Category::Any, vec!["efficient".into(), "capable".into()]),
1457 ])));
1458 let algorithm = || -> Result<Arc<dyn Algorithm>> {
1459 Ok(Arc::new(LlmTaskClassifier::new(
1460 LlmClassifierConfig::Capability {
1461 config: TaskClassifierConfig {
1462 judge: CapabilityJudgeConfig::Decision(DecisionJudgeConfig {
1463 cutoff: Some(0.4),
1464 ..DecisionJudgeConfig::default()
1465 }),
1466 ..TaskClassifierConfig::default()
1467 },
1468 },
1469 )?))
1470 };
1471 for (template, expected, is_success) in [
1472 (
1473 ResponseTemplate::new(200).set_body_json(&body),
1474 "efficient",
1475 true,
1476 ),
1477 (
1478 ResponseTemplate::new(503).set_body_string("unavailable"),
1479 "capable",
1480 false,
1481 ),
1482 ] {
1483 server.reset().await;
1484 Mock::given(method("POST"))
1485 .and(path("/v1/systemone"))
1486 .respond_with(template)
1487 .expect(2)
1488 .mount(&server)
1489 .await;
1490 let llm = Arc::new(CandidateClient {
1491 calls: Mutex::default(),
1492 requests: Mutex::default(),
1493 first: FirstOutcome::Unauthorized,
1494 });
1495 let clients = ClientRouter::single_with_decision_clients(
1496 llm.clone(),
1497 HashMap::from([(
1498 ModelId::from("judge"),
1499 client.clone() as Arc<dyn RoutedDecisionClient>,
1500 )]),
1501 );
1502 let outcome = decide(algorithm()?, clients.clone(), request(), models.clone()).await?;
1503 assert_eq!(outcome.selected_model_id()?, expected);
1504 assert!(llm.calls.lock().is_empty());
1505 let events = Arc::new(Mutex::new(Vec::new()));
1506 let captured = events.clone();
1507 let (selected, _) = run(
1508 algorithm()?,
1509 clients,
1510 request(),
1511 models.clone(),
1512 Some(Arc::new(move |event| captured.lock().push(event))),
1513 )
1514 .await?;
1515 assert_eq!(selected, expected);
1516 assert_eq!(&*llm.calls.lock(), &[ModelId::from(expected)]);
1517 {
1518 let events = events.lock();
1519 let RunObservation::DecisionCall(call) = &events[0] else {
1520 panic!("missing decision observation")
1521 };
1522 assert_eq!(call.selected_model, "judge");
1523 assert_eq!(call.is_success, is_success);
1524 assert_eq!(
1525 call.usage.as_ref().and_then(|u| u.input_tokens),
1526 is_success.then_some(42)
1527 );
1528 assert!(
1529 events
1530 .iter()
1531 .any(|event| matches!(event, RunObservation::AnswerCall(_)))
1532 );
1533 }
1534 server.verify().await;
1535 }
1536 Ok(())
1537 }
1538
1539 fn instruction_text(request: &Request) -> Vec<&str> {
1540 request
1541 .llm_request
1542 .instructions
1543 .iter()
1544 .flat_map(|instruction| &instruction.content)
1545 .filter_map(|block| match block {
1546 ContentBlock::Text { text } => Some(text.as_str()),
1547 _ => None,
1548 })
1549 .collect()
1550 }
1551
1552 async fn run_candidates(
1553 first: FirstOutcome,
1554 ) -> (Arc<CandidateClient>, Result<(ModelId, Response)>) {
1555 let client = Arc::new(CandidateClient {
1556 calls: Mutex::new(Vec::new()),
1557 requests: Mutex::new(Vec::new()),
1558 first,
1559 });
1560 let algorithm = Arc::new(CandidateAlgorithm {});
1561 let models = to_category_map(&["weak", "strong"]);
1562 let result = run(
1563 algorithm,
1564 ClientRouter::single(client.clone()),
1565 request(),
1566 models,
1567 None,
1568 )
1569 .await;
1570 (client, result)
1571 }
1572
1573 fn to_category_map(names: &[&str]) -> Arc<RuntimeModels> {
1574 Arc::new(RuntimeModels::new(
1575 [(
1576 Category::Any,
1577 names.iter().map(|name| ModelId::from(*name)).collect(),
1578 )]
1579 .into(),
1580 ))
1581 }
1582
1583 #[tokio::test]
1584 async fn answered_outcome_does_not_make_a_second_model_call() -> Result<()> {
1585 let client = Arc::new(CandidateClient {
1586 calls: Mutex::new(Vec::new()),
1587 requests: Mutex::new(Vec::new()),
1588 first: FirstOutcome::StreamSuccess,
1589 });
1590 let observations = Arc::new(Mutex::new(Vec::new()));
1591 let observed = Arc::clone(&observations);
1592 let observer: RunObserver = Arc::new(move |event| observed.lock().push(event));
1593
1594 let (selected, response) = run(
1595 Arc::new(AnsweredAlgorithm {
1596 model: "weak".into(),
1597 }),
1598 ClientRouter::single(client.clone()),
1599 request(),
1600 Arc::new(RuntimeModels::default()),
1601 Some(observer),
1602 )
1603 .await?;
1604
1605 assert_eq!(selected, "weak");
1606 assert_eq!(response.served_model().map(ModelId::as_str), Some("weak"));
1607 assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
1608 let observations = observations.lock();
1609 assert!(matches!(observations[0], RunObservation::AnswerCall(_)));
1610 assert!(matches!(
1611 observations[1],
1612 RunObservation::Outcome(ref metadata) if metadata.algorithm == "answered_test"
1613 ));
1614 assert!(matches!(
1615 observations[2],
1616 RunObservation::RoutingOverhead(_)
1617 ));
1618 assert_eq!(observations.len(), 3);
1619 Ok(())
1620 }
1621
1622 #[tokio::test]
1623 async fn served_answer_is_reported_before_the_client_sees_it_end() -> Result<()> {
1624 #[derive(Default)]
1625 struct ReportingAlgorithm {
1626 answers: Mutex<Vec<(String, bool)>>,
1627 tracking: bool,
1628 }
1629
1630 #[async_trait]
1631 impl Algorithm for ReportingAlgorithm {
1632 fn name(&self) -> &str {
1633 "reporting_test"
1634 }
1635
1636 async fn route(
1637 self: Arc<Self>,
1638 _driver: Driver,
1639 request: Request,
1640 ) -> Result<RoutingOutcome> {
1641 Ok(RoutingOutcome::route_to("weak".into(), Vec::new(), request))
1642 }
1643
1644 fn tracks_answers(&self) -> bool {
1645 self.tracking
1646 }
1647
1648 async fn observe_answer(&self, session_id: &str, answer: AnswerSummary) {
1649 self.answers
1650 .lock()
1651 .push((session_id.to_string(), answer.final_reply));
1652 }
1653 }
1654
1655 assert!(!CandidateAlgorithm {}.tracks_answers());
1656 for (tracking, first, final_reply, cancel) in [
1657 (false, FirstOutcome::StreamSuccess, true, false),
1658 (true, FirstOutcome::StreamSuccess, true, false),
1659 (true, FirstOutcome::MidStreamError, false, false),
1660 (true, FirstOutcome::StreamSuccess, false, true),
1661 ] {
1662 let algorithm = Arc::new(ReportingAlgorithm {
1663 tracking,
1664 ..Default::default()
1665 });
1666 let client = Arc::new(CandidateClient {
1667 calls: Mutex::new(Vec::new()),
1668 requests: Mutex::new(Vec::new()),
1669 first,
1670 });
1671 let request = Request {
1672 metadata: Some(switchyard_protocol::Metadata {
1673 session_id: Some("session-1".to_string()),
1674 ..Default::default()
1675 }),
1676 ..request()
1677 };
1678 let (_, response) = run(
1679 algorithm.clone(),
1680 ClientRouter::single(client),
1681 request,
1682 to_category_map(&["weak"]),
1683 None,
1684 )
1685 .await?;
1686 let LlmResponse::Stream(mut stream) = response.llm_response else {
1687 panic!("expected a streamed answer");
1688 };
1689 if !tracking {
1690 assert!(algorithm.answers.lock().is_empty());
1691 while let Some(item) = stream.next().await {
1692 assert!(item.is_ok());
1693 }
1694 assert!(algorithm.answers.lock().is_empty());
1695 continue;
1696 }
1697 if cancel {
1698 stream.next().await;
1699 drop(stream);
1700 assert_eq!(
1701 *algorithm.answers.lock(),
1702 [("session-1".to_string(), false)]
1703 );
1704 continue;
1705 }
1706 while let Some(item) = stream.next().await {
1707 let stops = item.as_ref().is_ok_and(|event| {
1708 event
1709 .normalized()
1710 .iter()
1711 .any(|chunk| matches!(chunk, LlmResponseChunk::MessageStop { .. }))
1712 });
1713 if stops {
1714 assert_eq!(algorithm.answers.lock().len(), 2);
1715 }
1716 }
1717 assert_eq!(
1718 *algorithm.answers.lock(),
1719 if final_reply {
1720 vec![
1721 ("session-1".to_string(), false),
1722 ("session-1".to_string(), true),
1723 ]
1724 } else {
1725 vec![
1726 ("session-1".to_string(), false),
1727 ("session-1".to_string(), false),
1728 ]
1729 }
1730 );
1731 }
1732 Ok(())
1733 }
1734
1735 #[test]
1736 fn answer_observation_keeps_call_order() {
1737 let pending = Some(Arc::new(Mutex::new(
1738 ["answer", "judge"]
1739 .map(|model| ModelCallObservation {
1740 selected_model: model.into(),
1741 is_success: true,
1742 duration: std::time::Duration::ZERO,
1743 usage: None,
1744 })
1745 .map(RunObservation::LlmCall)
1746 .into(),
1747 )));
1748 let emitted = Arc::new(Mutex::new(Vec::new()));
1749 let captured = Arc::clone(&emitted);
1750 let observer: RunObserver = Arc::new(move |event| captured.lock().push(event));
1751 let answer = ModelId::from("answer");
1752
1753 emit_routing_observations(&Some(observer), &pending, Some(&answer));
1754
1755 assert!(matches!(
1756 &emitted.lock()[..],
1757 [RunObservation::AnswerCall(answer), RunObservation::LlmCall(judge)]
1758 if answer.selected_model == "answer" && judge.selected_model == "judge"
1759 ));
1760 }
1761
1762 #[tokio::test]
1763 async fn responses_state_tracking_uses_upstream_storage_and_format() -> Result<()> {
1764 for (responses, store, conversation) in [
1765 (true, true, None),
1766 (true, false, None),
1767 (true, false, Some(json!("conv_plain"))),
1768 (true, false, Some(json!({"id": "conv_object"}))),
1769 (false, true, None),
1770 ] {
1771 for stream in [false, true] {
1772 let server = MockServer::start().await;
1773 Mock::given(method("POST"))
1774 .respond_with(move |request: &wiremock::Request| {
1775 let body: Value = serde_json::from_slice(&request.body).expect("request JSON");
1776 let response = if responses {
1777 json!({
1778 "id": "resp_seed", "object": "response", "model": "weak",
1779 "status": "completed", "output": [], "store": body["store"],
1780 "conversation": body["conversation"],
1781 })
1782 } else if stream {
1783 json!({"id": "resp_seed", "model": "weak", "choices": [{"index": 0, "delta": {"content": "ok"}, "finish_reason": "stop"}]})
1784 } else {
1785 json!({"id": "resp_seed", "model": "weak", "choices": [{"index": 0, "message": {"role": "assistant", "content": "ok"}, "finish_reason": "stop"}]})
1786 };
1787 if stream {
1788 let event = if responses { json!({"type": "response.completed", "response": response}) } else { response };
1789 ResponseTemplate::new(200)
1790 .insert_header("content-type", "text/event-stream")
1791 .set_body_string(if responses {
1792 format!("event: response.completed\ndata: {event}\n\n")
1793 } else {
1794 format!("data: {event}\n\ndata: [DONE]\n\n")
1795 })
1796 } else {
1797 ResponseTemplate::new(200).set_body_json(response)
1798 }
1799 })
1800 .mount(&server).await;
1801 let mut clients = HashMap::new();
1802 for model in ["weak", "strong"] {
1803 let config = HttpBackendConfig {
1804 base_url: server.uri(),
1805 api_key: None,
1806 forward_auth: false,
1807 extra_headers: BTreeMap::new(),
1808 extra_body: BTreeMap::from([("store".to_string(), json!(store))]),
1809 omit_body_fields: BTreeSet::new(),
1810 reasoning_effort: None,
1811 max_retries: 0,
1812 failure_cooldown: std::time::Duration::ZERO,
1813 timeout: None,
1814 };
1815 let backend = if responses {
1816 Backend::OpenAiResponses(config)
1817 } else {
1818 Backend::OpenAiChat(config)
1819 };
1820 let client: Arc<dyn RoutedLlmClient> = Arc::new(
1821 TranslatingLlmClient::new(&[ModelConfig::new(model, backend, None)])
1822 .map_err(|error| LibsyError::external("building test client", error))?,
1823 );
1824 clients.insert(ModelId::from(model), client);
1825 }
1826 let clients = ClientRouter::new(clients);
1827 let mut seed = request();
1828 seed.llm_request.stream = stream;
1829 if let Some(conversation) = &conversation {
1830 seed.llm_request
1831 .extensions
1832 .fields
1833 .insert("conversation".to_string(), conversation.clone());
1834 }
1835 let (_, response) = run(
1836 Arc::new(switchyard_libsy::Passthrough),
1837 clients.clone(),
1838 seed,
1839 to_category_map(&["weak"]),
1840 None,
1841 )
1842 .await?;
1843 response
1844 .llm_response
1845 .into_agg()
1846 .await
1847 .map_err(|error| LibsyError::client_call("weak", error))?;
1848 let mut continuations = vec![(
1849 "previous_response_id",
1850 json!("resp_seed"),
1851 responses && store,
1852 )];
1853 if let Some(conversation) = conversation.clone() {
1854 continuations.push(("conversation", conversation, true));
1855 }
1856 for (field, id, pinned) in continuations {
1857 let mut follow = request();
1858 follow
1859 .llm_request
1860 .extensions
1861 .fields
1862 .insert(field.to_string(), id);
1863 let outcome = decide(
1864 Arc::new(switchyard_libsy::Passthrough),
1865 clients.clone(),
1866 follow,
1867 to_category_map(&["strong"]),
1868 )
1869 .await?;
1870 assert_eq!(
1871 outcome.selected_model_id()?.as_str(),
1872 if pinned { "weak" } else { "strong" },
1873 "responses={responses}, store={store}, stream={stream}, field={field}"
1874 );
1875 }
1876 let requests = server.received_requests().await.expect("request recording");
1877 assert_eq!(requests.len(), 1);
1878 assert_eq!(
1879 serde_json::from_slice::<Value>(&requests[0].body).expect("request JSON")["store"],
1880 store
1881 );
1882 }
1883 }
1884 Ok(())
1885 }
1886
1887 #[tokio::test]
1888 async fn responses_stored_tool_continuation_materializes_for_anthropic() -> Result<()> {
1889 let server = MockServer::start().await;
1890 Mock::given(method("POST"))
1891 .respond_with(|request: &wiremock::Request| {
1892 let body: Value = serde_json::from_slice(&request.body).expect("request JSON");
1893 let blocks = body["messages"]
1894 .as_array()
1895 .into_iter()
1896 .flatten()
1897 .filter_map(|message| message["content"].as_array())
1898 .flatten()
1899 .collect::<Vec<_>>();
1900 let has_result = blocks.iter().any(|block| block["type"] == "tool_result");
1901 let has_call = blocks.iter().any(|block| block["type"] == "tool_use");
1902 let has_thanks = blocks
1903 .iter()
1904 .any(|block| block["type"] == "text" && block["text"] == "thanks")
1905 || body["messages"].as_array().is_some_and(|messages| {
1906 messages
1907 .iter()
1908 .any(|message| message["content"] == "thanks")
1909 });
1910 if has_result && !has_call {
1911 return ResponseTemplate::new(400).set_body_json(json!({
1912 "type": "error",
1913 "error": {
1914 "type": "invalid_request_error",
1915 "message": "tool_result has no corresponding tool_use"
1916 }
1917 }));
1918 }
1919 let response = if has_thanks {
1920 json!({
1921 "id": "msg_third", "type": "message", "role": "assistant",
1922 "model": "weak", "content": [{"type": "text", "text": "done"}],
1923 "stop_reason": "end_turn", "usage": {"input_tokens": 6, "output_tokens": 1}
1924 })
1925 } else if has_result {
1926 json!({
1927 "id": "msg_follow", "type": "message", "role": "assistant",
1928 "model": "weak", "content": [{"type": "text", "text": "sunny"}],
1929 "stop_reason": "end_turn", "usage": {"input_tokens": 4, "output_tokens": 1}
1930 })
1931 } else {
1932 json!({
1933 "id": "msg_seed", "type": "message", "role": "assistant",
1934 "model": "weak",
1935 "content": [{
1936 "type": "tool_use", "id": "toolu_weather", "name": "get_weather",
1937 "input": {"city": "Paris"}
1938 }],
1939 "stop_reason": "tool_use", "usage": {"input_tokens": 3, "output_tokens": 1}
1940 })
1941 };
1942 ResponseTemplate::new(200).set_body_json(response)
1943 })
1944 .mount(&server)
1945 .await;
1946
1947 let client: Arc<dyn RoutedLlmClient> = Arc::new(
1948 TranslatingLlmClient::new(&[ModelConfig::new(
1949 "weak",
1950 Backend::Anthropic(HttpBackendConfig {
1951 base_url: server.uri(),
1952 api_key: None,
1953 forward_auth: false,
1954 extra_headers: BTreeMap::new(),
1955 extra_body: BTreeMap::new(),
1956 omit_body_fields: BTreeSet::new(),
1957 reasoning_effort: None,
1958 max_retries: 0,
1959 failure_cooldown: std::time::Duration::ZERO,
1960 timeout: None,
1961 }),
1962 None,
1963 )])
1964 .map_err(|error| LibsyError::external("building test client", error))?,
1965 );
1966 let clients = ClientRouter::new(HashMap::from([(ModelId::from("weak"), client)]));
1967 let models = to_category_map(&["weak"]);
1968
1969 let seed = Request {
1970 llm_request: switchyard_translation::decode_request(
1971 WireFormat::OpenAiResponses,
1972 &json!({
1973 "model": "route",
1974 "input": "Call get_weather for Paris",
1975 "tools": [{
1976 "type": "function", "name": "get_weather",
1977 "parameters": {"type": "object"}
1978 }],
1979 "store": true
1980 }),
1981 )
1982 .map_err(|error| LibsyError::external("decoding seed request", error))?,
1983 raw_request: None,
1984 metadata: None,
1985 };
1986 let (_, response) = run(
1987 Arc::new(switchyard_libsy::Passthrough),
1988 clients.clone(),
1989 seed,
1990 models.clone(),
1991 None,
1992 )
1993 .await?;
1994 assert_eq!(
1995 response
1996 .llm_response
1997 .as_agg()
1998 .and_then(|agg| agg.id.as_deref()),
1999 Some("msg_seed")
2000 );
2001
2002 let follow = Request {
2003 llm_request: switchyard_translation::decode_request(
2004 WireFormat::OpenAiResponses,
2005 &json!({
2006 "model": "route",
2007 "previous_response_id": "msg_seed",
2008 "input": [{
2009 "type": "function_call_output",
2010 "call_id": "toolu_weather",
2011 "output": "Paris is sunny"
2012 }],
2013 "tools": [{
2014 "type": "function", "name": "get_weather",
2015 "parameters": {"type": "object"}
2016 }],
2017 "store": true
2018 }),
2019 )
2020 .map_err(|error| LibsyError::external("decoding continuation request", error))?,
2021 raw_request: None,
2022 metadata: None,
2023 };
2024 let (_, response) = run(
2025 Arc::new(switchyard_libsy::Passthrough),
2026 clients.clone(),
2027 follow,
2028 models.clone(),
2029 None,
2030 )
2031 .await?;
2032 assert_eq!(
2033 completion_text(
2034 response
2035 .llm_response
2036 .as_agg()
2037 .expect("buffered Anthropic response"),
2038 ),
2039 "sunny"
2040 );
2041
2042 let third = Request {
2043 llm_request: switchyard_translation::decode_request(
2044 WireFormat::OpenAiResponses,
2045 &json!({
2046 "model": "route",
2047 "previous_response_id": "msg_follow",
2048 "input": "thanks",
2049 "store": true
2050 }),
2051 )
2052 .map_err(|error| LibsyError::external("decoding chained request", error))?,
2053 raw_request: None,
2054 metadata: None,
2055 };
2056 let history = clients
2057 .stored_state_owner(&third)
2058 .and_then(|owner| owner.history)
2059 .expect("chained canonical history");
2060 assert_eq!(history.len, 4);
2061 assert_eq!(history.segment.len(), 2);
2062 assert!(history.parent.is_some());
2063 let (_, response) = run(
2064 Arc::new(switchyard_libsy::Passthrough),
2065 clients,
2066 third,
2067 models,
2068 None,
2069 )
2070 .await?;
2071 assert_eq!(
2072 completion_text(
2073 response
2074 .llm_response
2075 .as_agg()
2076 .expect("buffered Anthropic response"),
2077 ),
2078 "done"
2079 );
2080
2081 let requests = server.received_requests().await.expect("request recording");
2082 assert_eq!(requests.len(), 3);
2083 let follow: Value = serde_json::from_slice(&requests[1].body)
2084 .map_err(|error| LibsyError::external("decoding captured request", error))?;
2085 assert_eq!(follow["messages"][1]["content"][0]["type"], "tool_use");
2086 assert_eq!(follow["messages"][2]["content"][0]["type"], "tool_result");
2087 let third: Value = serde_json::from_slice(&requests[2].body)
2088 .map_err(|error| LibsyError::external("decoding captured request", error))?;
2089 assert_eq!(third["messages"][1]["content"][0]["type"], "tool_use");
2090 assert_eq!(third["messages"][2]["content"][0]["type"], "tool_result");
2091 assert_eq!(third["messages"][3]["content"], "sunny");
2092 assert_eq!(third["messages"][4]["content"][0]["text"], "thanks");
2093 Ok(())
2094 }
2095
2096 #[tokio::test]
2097 async fn streamed_cross_format_state_is_recorded_only_after_completion() -> Result<()> {
2098 let client = Arc::new(CandidateClient {
2099 calls: Mutex::new(Vec::new()),
2100 requests: Mutex::new(Vec::new()),
2101 first: FirstOutcome::StreamSuccess,
2102 });
2103 let clients = ClientRouter::new(HashMap::from([(
2104 ModelId::from("weak"),
2105 client as Arc<dyn RoutedLlmClient>,
2106 )]));
2107 let mut seed = request();
2108 seed.llm_request.messages = vec![Message::text(Role::User, "inspect")];
2109 seed.llm_request
2110 .preservation
2111 .requests
2112 .insert(WireFormat::OpenAiResponses.into(), json!({}));
2113 let mut response = stream_response(vec![
2114 LlmResponseChunk::MessageStart {
2115 id: Some("msg_stream".to_string()),
2116 model: Some("weak".to_string()),
2117 },
2118 LlmResponseChunk::ToolCallDelta {
2119 index: 0,
2120 id: Some("toolu_stream".to_string()),
2121 name: Some("lookup".to_string()),
2122 arguments_delta: Some("{}".to_string()),
2123 },
2124 LlmResponseChunk::MessageStop {
2125 reason: Some("tool_use".to_string()),
2126 },
2127 ]);
2128 response.set_served_model(&ModelId::from("weak"));
2129 let response = clients.remember_state_owner(&seed, response)?;
2130
2131 let mut follow = request();
2132 follow
2133 .llm_request
2134 .extensions
2135 .fields
2136 .insert("previous_response_id".to_string(), json!("msg_stream"));
2137 follow.llm_request.messages = vec![Message {
2138 role: Role::Tool,
2139 content: vec![ContentBlock::ToolResult(ToolResult {
2140 tool_call_id: "toolu_stream".to_string(),
2141 content: vec![ContentBlock::Text {
2142 text: "ready".to_string(),
2143 }],
2144 is_error: None,
2145 })],
2146 }];
2147 assert!(clients.stored_state_owner(&follow).is_none());
2148 response
2149 .llm_response
2150 .into_agg()
2151 .await
2152 .map_err(|error| LibsyError::client_call("weak", error))?;
2153
2154 let outcome = continue_on(
2155 clients
2156 .stored_state_owner(&follow)
2157 .expect("completed stream state"),
2158 "passthrough",
2159 follow,
2160 );
2161 assert_eq!(outcome.request.llm_request.messages.len(), 3);
2162 assert!(matches!(
2163 outcome.request.llm_request.messages[1].content.as_slice(),
2164 [ContentBlock::ToolCall(call)] if call.id == "toolu_stream"
2165 ));
2166 assert!(matches!(
2167 outcome.request.llm_request.messages[2].content.as_slice(),
2168 [ContentBlock::ToolResult(result)] if result.tool_call_id == "toolu_stream"
2169 ));
2170 Ok(())
2171 }
2172
2173 #[test]
2174 fn cross_format_response_with_store_false_is_not_retained() -> Result<()> {
2175 let client = Arc::new(CandidateClient {
2176 calls: Mutex::new(Vec::new()),
2177 requests: Mutex::new(Vec::new()),
2178 first: FirstOutcome::StreamSuccess,
2179 });
2180 let clients = ClientRouter::new(HashMap::from([(
2181 ModelId::from("weak"),
2182 client as Arc<dyn RoutedLlmClient>,
2183 )]));
2184 let mut seed = request();
2185 seed.llm_request
2186 .extensions
2187 .fields
2188 .insert("store".to_string(), json!(false));
2189 seed.llm_request
2190 .preservation
2191 .requests
2192 .insert(WireFormat::OpenAiResponses.into(), json!({}));
2193 let mut agg = text_response(Some("weak".to_string()), "done".to_string());
2194 agg.id = Some("msg_not_stored".to_string());
2195 let mut response = Response {
2196 llm_response: LlmResponse::Agg(agg),
2197 metadata: None,
2198 upstream_headers: http::HeaderMap::new(),
2199 };
2200 response.set_served_model(&ModelId::from("weak"));
2201 clients.remember_state_owner(&seed, response)?;
2202
2203 let mut follow = request();
2204 follow
2205 .llm_request
2206 .extensions
2207 .fields
2208 .insert("previous_response_id".to_string(), json!("msg_not_stored"));
2209 assert!(clients.stored_state_owner(&follow).is_none());
2210 Ok(())
2211 }
2212
2213 #[tokio::test]
2214 async fn state_capacity_does_not_fail_completed_responses() -> Result<()> {
2215 let client = Arc::new(CandidateClient {
2216 calls: Mutex::new(Vec::new()),
2217 requests: Mutex::new(Vec::new()),
2218 first: FirstOutcome::StreamSuccess,
2219 });
2220 let clients = ClientRouter::new(HashMap::from([(
2221 ModelId::from("weak"),
2222 client as Arc<dyn RoutedLlmClient>,
2223 )]));
2224 let model = ModelId::from("weak");
2225 clients.inner.state_owners.lock().by_id = (0..MAX_STATE_OWNERS)
2226 .map(|id| {
2227 (
2228 format!("existing_{id}"),
2229 StoredState {
2230 model: model.clone(),
2231 history: None,
2232 },
2233 )
2234 })
2235 .collect();
2236
2237 let mut request = request();
2238 request
2239 .llm_request
2240 .preservation
2241 .requests
2242 .insert(WireFormat::OpenAiResponses.into(), json!({}));
2243 let mut agg = text_response(Some("weak".to_string()), "done".to_string());
2244 agg.id = Some("overflow_buffered".to_string());
2245 let mut buffered = Response {
2246 llm_response: LlmResponse::Agg(agg),
2247 metadata: None,
2248 upstream_headers: http::HeaderMap::new(),
2249 };
2250 buffered.set_served_model(&model);
2251 clients.remember_state_owner(&request, buffered)?;
2252
2253 let mut streamed = stream_response(vec![
2254 LlmResponseChunk::MessageStart {
2255 id: Some("overflow_streamed".to_string()),
2256 model: Some("weak".to_string()),
2257 },
2258 LlmResponseChunk::TextDelta {
2259 index: 0,
2260 text: "done".to_string(),
2261 },
2262 LlmResponseChunk::MessageStop {
2263 reason: Some("stop".to_string()),
2264 },
2265 ]);
2266 streamed.set_served_model(&model);
2267 clients
2268 .remember_state_owner(&request, streamed)?
2269 .llm_response
2270 .into_agg()
2271 .await
2272 .map_err(|error| LibsyError::client_call("weak", error))?;
2273
2274 assert_eq!(
2275 clients.inner.state_owners.lock().by_id.len(),
2276 MAX_STATE_OWNERS
2277 );
2278 Ok(())
2279 }
2280
2281 #[test]
2282 fn state_owners_preserve_existing_records_at_capacity()
2283 -> std::result::Result<(), LlmClientError> {
2284 let mut owners = StateOwners::default();
2285 let model = ModelId::from("model/a");
2286 for id in 0..MAX_STATE_OWNERS - 1 {
2287 owners.remember(Some(&format!("resp_{id}")), None, &model, None)?;
2288 }
2289 assert!(matches!(
2290 owners.remember(Some("new_response"), Some("new_conversation"), &model, None,),
2291 Err(LlmClientError::ResponseStateLimitExceeded {
2292 limit: MAX_STATE_OWNERS
2293 })
2294 ));
2295 assert!(owners.owner("new_response").is_none());
2296 assert!(owners.owner("new_conversation").is_none());
2297 owners.remember(Some("last_id"), Some("last_id"), &model, None)?;
2298 owners.remember(Some("last_id"), Some("resp_0"), &model, None)?;
2299 assert!(matches!(
2300 owners.remember(Some("over_limit"), None, &model, None),
2301 Err(LlmClientError::ResponseStateLimitExceeded { .. })
2302 ));
2303 assert!(matches!(
2304 owners.remember(Some("resp_0"), None, &ModelId::from("model/b"), None,),
2305 Err(LlmClientError::ResponseStateConflict)
2306 ));
2307 assert_eq!(
2308 owners.owner("resp_0").map(|state| &state.model),
2309 Some(&model)
2310 );
2311 assert_eq!(owners.by_id.len(), MAX_STATE_OWNERS);
2312 Ok(())
2313 }
2314
2315 #[test]
2316 fn concurrent_state_owners_do_not_exceed_capacity() {
2317 let model = ModelId::from("model/a");
2318 let owners = Arc::new(Mutex::new(StateOwners {
2319 by_id: (0..MAX_STATE_OWNERS - 16)
2320 .map(|id| {
2321 (
2322 format!("existing_{id}"),
2323 StoredState {
2324 model: model.clone(),
2325 history: None,
2326 },
2327 )
2328 })
2329 .collect(),
2330 }));
2331 let barrier = Arc::new(std::sync::Barrier::new(32));
2332 let accepted = std::thread::scope(|scope| {
2333 let handles = (0..32)
2334 .map(|id| {
2335 let owners = owners.clone();
2336 let barrier = barrier.clone();
2337 let model = model.clone();
2338 scope.spawn(move || {
2339 barrier.wait();
2340 let result = owners.lock().remember(
2341 Some(&format!("resp_{id}")),
2342 Some(&format!("conv_{id}")),
2343 &model,
2344 None,
2345 );
2346 match result {
2347 Ok(()) => Some(id),
2348 Err(LlmClientError::ResponseStateLimitExceeded { .. }) => None,
2349 other => panic!("unexpected state tracking result: {other:?}"),
2350 }
2351 })
2352 })
2353 .collect::<Vec<_>>();
2354 handles
2355 .into_iter()
2356 .filter_map(|handle| handle.join().expect("request thread panicked"))
2357 .collect::<Vec<_>>()
2358 });
2359 let owners = owners.lock();
2360 assert_eq!(accepted.len(), 8);
2361 assert_eq!(owners.by_id.len(), MAX_STATE_OWNERS);
2362 assert_eq!(
2363 owners.owner("existing_0").map(|state| &state.model),
2364 Some(&model)
2365 );
2366 for id in accepted {
2367 assert_eq!(
2368 owners
2369 .owner(&format!("resp_{id}"))
2370 .map(|state| &state.model),
2371 Some(&model)
2372 );
2373 assert_eq!(
2374 owners
2375 .owner(&format!("conv_{id}"))
2376 .map(|state| &state.model),
2377 Some(&model)
2378 );
2379 }
2380 }
2381
2382 #[tokio::test]
2383 async fn each_fallback_candidate_receives_only_its_own_prompt() -> Result<()> {
2384 let client = Arc::new(CandidateClient {
2385 calls: Mutex::new(Vec::new()),
2386 requests: Mutex::new(Vec::new()),
2387 first: FirstOutcome::ContextWindow,
2388 });
2389 let routed_client: Arc<dyn RoutedLlmClient> = client.clone();
2390 let clients = ClientRouter::new_with_target_prompts(
2391 HashMap::from([
2392 (ModelId::from("weak"), Arc::clone(&routed_client)),
2393 (ModelId::from("strong"), routed_client),
2394 ]),
2395 HashMap::from([
2396 ("weak".into(), "weak prompt".to_string()),
2397 ("strong".into(), "strong prompt".to_string()),
2398 ]),
2399 None,
2400 );
2401
2402 run(
2403 Arc::new(CandidateAlgorithm {}),
2404 clients,
2405 request(),
2406 to_category_map(&["weak", "strong"]),
2407 None,
2408 )
2409 .await?;
2410
2411 let calls = client.requests.lock();
2412 assert_eq!(calls.len(), 2);
2413 assert_eq!(instruction_text(&calls[0]), ["weak prompt"]);
2414 assert_eq!(instruction_text(&calls[1]), ["strong prompt"]);
2415 Ok(())
2416 }
2417
2418 #[tokio::test]
2419 async fn decision_prompts_a_routing_response_target() -> Result<()> {
2420 let client = Arc::new(CandidateClient {
2421 calls: Mutex::new(Vec::new()),
2422 requests: Mutex::new(Vec::new()),
2423 first: FirstOutcome::StreamSuccess,
2424 });
2425 let routed_client: Arc<dyn RoutedLlmClient> = client.clone();
2426 let clients = ClientRouter::new_with_target_prompts(
2427 HashMap::from([(ModelId::from("answer"), routed_client)]),
2428 HashMap::from([("answer".into(), "answer prompt".to_string())]),
2429 Some("answer".into()),
2430 );
2431
2432 decide(
2433 Arc::new(AnsweredAlgorithm {
2434 model: "answer".into(),
2435 }),
2436 clients,
2437 request(),
2438 Arc::new(RuntimeModels::default()),
2439 )
2440 .await?;
2441
2442 let calls = client.requests.lock();
2443 assert_eq!(calls.len(), 1);
2444 assert_eq!(instruction_text(&calls[0]), ["answer prompt"]);
2445 Ok(())
2446 }
2447
2448 #[tokio::test]
2449 async fn decision_prepares_only_the_selected_request() -> Result<()> {
2450 let client = Arc::new(CandidateClient {
2451 calls: Mutex::new(Vec::new()),
2452 requests: Mutex::new(Vec::new()),
2453 first: FirstOutcome::StreamSuccess,
2454 });
2455 let routed_client: Arc<dyn RoutedLlmClient> = client;
2456 let clients = ClientRouter::new_with_target_prompts(
2457 HashMap::from([
2458 (ModelId::from("weak"), Arc::clone(&routed_client)),
2459 (ModelId::from("strong"), routed_client),
2460 ]),
2461 HashMap::from([
2462 (ModelId::from("weak"), "weak prompt".to_string()),
2463 (ModelId::from("strong"), "strong prompt".to_string()),
2464 ]),
2465 None,
2466 );
2467
2468 let outcome = decide(
2469 Arc::new(CandidateAlgorithm {}),
2470 clients,
2471 request(),
2472 to_category_map(&["weak", "strong"]),
2473 )
2474 .await?;
2475
2476 assert_eq!(
2477 outcome.selected_model_ids,
2478 [ModelId::from("weak"), ModelId::from("strong")]
2479 );
2480 assert_eq!(instruction_text(&outcome.request), ["weak prompt"]);
2481 Ok(())
2482 }
2483
2484 #[test]
2485 fn fallback_only_accepts_context_policy_and_unavailable_failures() {
2486 let error = |source| LibsyError::client_call("target", source);
2487 assert_eq!(
2488 fallback_reason(
2489 &error(LlmClientError::ContextWindowExceeded {
2490 model: "target".into(),
2491 message: "too long".to_string(),
2492 }),
2493 true
2494 ),
2495 Some(RoutingFallbackReason::ContextWindow)
2496 );
2497 for status in [
2498 StatusCode::FORBIDDEN,
2499 StatusCode::REQUEST_TIMEOUT,
2500 StatusCode::TOO_MANY_REQUESTS,
2501 StatusCode::INTERNAL_SERVER_ERROR,
2502 StatusCode::from_u16(599).expect("599 is a valid status"),
2503 ] {
2504 assert_eq!(
2505 fallback_reason(
2506 &error(LlmClientError::UpstreamHttp {
2507 status,
2508 body: "failed".to_string(),
2509 }),
2510 true
2511 ),
2512 Some(RoutingFallbackReason::Unavailable)
2513 );
2514 }
2515 for (body, expected) in [
2516 (
2517 r#"{"error":{"code":"content_policy_violation"}}"#,
2518 Some(RoutingFallbackReason::Unavailable),
2519 ),
2520 (
2521 r#"{"error":{"code":"invalid_request_error"},"metadata":"content_policy_violation"}"#,
2522 None,
2523 ),
2524 (r#"{"error":{"message":"content_policy_violation"}}"#, None),
2525 ("content_policy_violation", None),
2526 ] {
2527 assert_eq!(
2528 fallback_reason(
2529 &error(LlmClientError::UpstreamHttp {
2530 status: StatusCode::BAD_REQUEST,
2531 body: body.to_string(),
2532 }),
2533 true
2534 ),
2535 expected,
2536 "{body}"
2537 );
2538 }
2539 for status in [
2540 StatusCode::BAD_REQUEST,
2541 StatusCode::UNAUTHORIZED,
2542 StatusCode::NOT_FOUND,
2543 StatusCode::CONFLICT,
2544 StatusCode::from_u16(499).expect("499 is a valid status"),
2545 StatusCode::from_u16(600).expect("600 is a valid status"),
2546 ] {
2547 assert_eq!(
2548 fallback_reason(
2549 &error(LlmClientError::UpstreamHttp {
2550 status,
2551 body: "failed".to_string(),
2552 }),
2553 true
2554 ),
2555 None
2556 );
2557 }
2558 }
2559
2560 #[tokio::test]
2561 async fn candidate_failures_follow_the_fallback_policy() -> Result<()> {
2562 let (client, result) = run_candidates(FirstOutcome::ContextWindow).await;
2564 let (_, response) = result?;
2565 assert_eq!(
2566 &*client.calls.lock(),
2567 &[ModelId::from("weak"), "strong".into()]
2568 );
2569 assert_eq!(
2570 response
2571 .llm_response
2572 .as_agg()
2573 .map(|response| response.model.as_deref()),
2574 Some(Some("strong"))
2575 );
2576 assert_eq!(response.served_model().map(ModelId::as_str), Some("strong"));
2577
2578 let (client, result) =
2580 run_candidates(FirstOutcome::ContentPolicy(StatusCode::BAD_REQUEST)).await;
2581 let (_, response) = result?;
2582 assert_eq!(
2583 &*client.calls.lock(),
2584 &[ModelId::from("weak"), "strong".into()]
2585 );
2586 assert_eq!(response.served_model().map(ModelId::as_str), Some("strong"));
2587
2588 let (client, result) = run_candidates(FirstOutcome::Unauthorized).await;
2590 assert!(matches!(
2591 result,
2592 Err(LibsyError::ClientCall {
2593 source: LlmClientError::UpstreamHttp {
2594 status: StatusCode::UNAUTHORIZED,
2595 ..
2596 },
2597 ..
2598 })
2599 ));
2600 assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
2601 Ok(())
2602 }
2603
2604 #[tokio::test]
2605 async fn fallback_candidates_receive_the_fallback_request() -> Result<()> {
2606 let client = Arc::new(CandidateClient {
2607 calls: Mutex::new(Vec::new()),
2608 requests: Mutex::new(Vec::new()),
2609 first: FirstOutcome::ContextWindow,
2610 });
2611 let clients = ClientRouter::single(client.clone());
2612 let mut seed = request();
2613 seed.llm_request
2614 .preservation
2615 .requests
2616 .insert(WireFormat::OpenAiResponses.into(), json!({}));
2617 run(
2618 Arc::new(RewritingAlgorithm {}),
2619 clients.clone(),
2620 seed,
2621 to_category_map(&["weak", "strong"]),
2622 None,
2623 )
2624 .await?;
2625 let sent: Vec<_> = client
2626 .requests
2627 .lock()
2628 .iter()
2629 .map(|request| request.llm_request.messages.clone())
2630 .collect();
2631 assert_eq!(sent.len(), 2);
2632 assert_eq!(sent[0].len(), request().llm_request.messages.len() + 1);
2633 assert_eq!(sent[1], request().llm_request.messages);
2634 let mut follow = request();
2635 follow
2636 .llm_request
2637 .extensions
2638 .fields
2639 .insert("previous_response_id".into(), json!("candidate_response"));
2640 follow.llm_request.messages = vec![Message::text(Role::User, "continue")];
2641 let owner = clients
2642 .stored_state_owner(&follow)
2643 .expect("fallback Responses state");
2644 let continued = continue_on(owner, "test", follow);
2645 let mut expected = sent[1].clone();
2646 expected.push(Message::text(Role::Assistant, "strong"));
2647 expected.push(Message::text(Role::User, "continue"));
2648 assert_eq!(continued.request.llm_request.messages, expected);
2649 Ok(())
2650 }
2651
2652 #[tokio::test]
2653 async fn fallback_request_does_not_bypass_content_policy() -> Result<()> {
2654 for status in [StatusCode::BAD_REQUEST, StatusCode::FORBIDDEN] {
2655 let client = Arc::new(CandidateClient {
2656 calls: Mutex::new(Vec::new()),
2657 requests: Mutex::new(Vec::new()),
2658 first: FirstOutcome::ContentPolicy(status),
2659 });
2660 let result = run(
2661 Arc::new(RewritingAlgorithm {}),
2662 ClientRouter::single(client.clone()),
2663 request(),
2664 to_category_map(&["weak", "strong"]),
2665 None,
2666 )
2667 .await;
2668 assert!(
2669 matches!(result, Err(LibsyError::ClientCall { source: LlmClientError::UpstreamHttp { status: actual, .. }, .. }) if actual == status)
2670 );
2671 assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
2672 }
2673 Ok(())
2674 }
2675
2676 #[tokio::test]
2677 async fn retry_exhaustion_falls_back_and_optional_cooldown_skips_failed_backend() -> Result<()>
2678 {
2679 let server = MockServer::start().await;
2680 let calls = Arc::new(Mutex::new(Vec::new()));
2681 let observed_calls = Arc::clone(&calls);
2682 Mock::given(method("POST"))
2683 .respond_with(move |request: &wiremock::Request| {
2684 let body: serde_json::Value =
2685 serde_json::from_slice(&request.body).unwrap_or(serde_json::Value::Null);
2686 let model = body["model"].as_str().unwrap_or_default().to_string();
2687 observed_calls.lock().push(model.clone());
2688 if model == "weak" {
2689 ResponseTemplate::new(503)
2690 .insert_header("retry-after", "0")
2691 .set_body_string("unavailable")
2692 } else {
2693 ResponseTemplate::new(200).set_body_json(serde_json::json!({
2694 "id": "answer",
2695 "model": "strong",
2696 "choices": [{
2697 "index": 0,
2698 "message": {"role": "assistant", "content": "ok"},
2699 "finish_reason": "stop"
2700 }],
2701 "usage": {}
2702 }))
2703 }
2704 })
2705 .mount(&server)
2706 .await;
2707
2708 let client_with_cooldown = |cooldown| {
2709 let backend = || {
2710 Backend::OpenAiChat(HttpBackendConfig {
2711 base_url: format!("{}/v1", server.uri()),
2712 api_key: None,
2713 forward_auth: false,
2714 extra_headers: BTreeMap::new(),
2715 extra_body: BTreeMap::new(),
2716 omit_body_fields: BTreeSet::new(),
2717 reasoning_effort: None,
2718 max_retries: 2,
2719 failure_cooldown: cooldown,
2720 timeout: None,
2721 })
2722 };
2723 TranslatingLlmClient::new(&[
2724 ModelConfig::new("weak", backend(), None),
2725 ModelConfig::new("strong", backend(), None),
2726 ])
2727 .map(Arc::new)
2728 .map_err(|error| LibsyError::external("building test client", error))
2729 };
2730 let call = async |client: Arc<TranslatingLlmClient>| {
2731 run(
2732 Arc::new(CandidateAlgorithm {}),
2733 ClientRouter::single(client),
2734 request(),
2735 to_category_map(&["weak", "strong"]),
2736 None,
2737 )
2738 .await?;
2739 Ok::<_, LibsyError>(std::mem::take(&mut *calls.lock()))
2740 };
2741
2742 let client = client_with_cooldown(std::time::Duration::ZERO)?;
2743 assert_eq!(
2744 call(client.clone()).await?,
2745 ["weak", "weak", "weak", "strong"]
2746 );
2747 assert_eq!(call(client).await?, ["weak", "weak", "weak", "strong"]);
2748
2749 let cooldown = std::time::Duration::from_secs(60);
2750 let client = client_with_cooldown(cooldown)?;
2751 assert_eq!(
2752 call(client.clone()).await?,
2753 ["weak", "weak", "weak", "strong"]
2754 );
2755 assert_eq!(call(client.clone()).await?, ["strong"]);
2756
2757 tokio::time::pause();
2758 tokio::time::advance(cooldown).await;
2759 tokio::time::resume();
2760
2761 assert_eq!(call(client).await?, ["weak", "weak", "weak", "strong"]);
2762 Ok(())
2763 }
2764
2765 #[tokio::test]
2766 async fn refused_connection_falls_back_to_the_next_candidate() -> Result<()> {
2767 let server = MockServer::start().await;
2768 Mock::given(method("POST"))
2769 .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
2770 "id": "answer",
2771 "model": "strong",
2772 "choices": [{
2773 "index": 0,
2774 "message": {"role": "assistant", "content": "ok"},
2775 "finish_reason": "stop"
2776 }],
2777 "usage": {}
2778 })))
2779 .mount(&server)
2780 .await;
2781
2782 let backend = |base_url: String| {
2783 Backend::OpenAiChat(HttpBackendConfig {
2784 base_url,
2785 api_key: None,
2786 forward_auth: false,
2787 extra_headers: BTreeMap::new(),
2788 extra_body: BTreeMap::new(),
2789 omit_body_fields: BTreeSet::new(),
2790 reasoning_effort: None,
2791 max_retries: 0,
2792 failure_cooldown: std::time::Duration::ZERO,
2793 timeout: None,
2794 })
2795 };
2796 let client = Arc::new(
2797 TranslatingLlmClient::new(&[
2798 ModelConfig::new("weak", backend("http://127.0.0.1:1/v1".to_string()), None),
2800 ModelConfig::new("strong", backend(format!("{}/v1", server.uri())), None),
2801 ])
2802 .map_err(|error| LibsyError::external("building test client", error))?,
2803 );
2804 let (_, response) = run(
2805 Arc::new(CandidateAlgorithm {}),
2806 ClientRouter::single(client),
2807 request(),
2808 to_category_map(&["weak", "strong"]),
2809 None,
2810 )
2811 .await?;
2812
2813 assert_eq!(response.served_model().map(ModelId::as_str), Some("strong"));
2814 Ok(())
2815 }
2816
2817 #[tokio::test]
2818 async fn streams_are_outside_the_candidate_fallback_boundary() -> Result<()> {
2819 let (client, result) = run_candidates(FirstOutcome::StreamSuccess).await;
2821 let (_, response) = result?;
2822 assert_eq!(response.served_model().map(ModelId::as_str), Some("weak"));
2823 let aggregate = response
2824 .llm_response
2825 .into_agg()
2826 .await
2827 .map_err(|source| LibsyError::client_call("weak", source))?;
2828 assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
2829 assert_eq!(completion_text(&aggregate), "streamed");
2830
2831 let (client, result) = run_candidates(FirstOutcome::MidStreamError).await;
2833 let (_, response) = result?;
2834 let error = response
2835 .llm_response
2836 .into_agg()
2837 .await
2838 .expect_err("the stream should fail during aggregation");
2839 assert!(error.to_string().contains("stream failed"));
2840 assert_eq!(&*client.calls.lock(), &[ModelId::from("weak")]);
2841 Ok(())
2842 }
2843
2844 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";
2847
2848 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";
2850
2851 async fn run_streaming_candidates(
2855 weak_sse: &'static str,
2856 ) -> (
2857 MockServer,
2858 Arc<Mutex<Vec<String>>>,
2859 Result<(ModelId, Response)>,
2860 ) {
2861 let server = MockServer::start().await;
2862 let calls = Arc::new(Mutex::new(Vec::new()));
2863 let observed_calls = Arc::clone(&calls);
2864 Mock::given(method("POST"))
2865 .respond_with(move |request: &wiremock::Request| {
2866 let body: serde_json::Value =
2867 serde_json::from_slice(&request.body).unwrap_or(serde_json::Value::Null);
2868 let model = body["model"].as_str().unwrap_or_default().to_string();
2869 observed_calls.lock().push(model.clone());
2870 let sse = if model == "weak" {
2871 weak_sse
2872 } else {
2873 STRONG_SSE
2874 };
2875 ResponseTemplate::new(200)
2876 .insert_header("content-type", "text/event-stream")
2877 .set_body_string(sse)
2878 })
2879 .mount(&server)
2880 .await;
2881
2882 let backend = || {
2883 Backend::OpenAiChat(HttpBackendConfig {
2884 base_url: format!("{}/v1", server.uri()),
2885 api_key: None,
2886 forward_auth: false,
2887 extra_headers: BTreeMap::new(),
2888 extra_body: BTreeMap::new(),
2889 omit_body_fields: BTreeSet::new(),
2890 reasoning_effort: None,
2891 max_retries: 0,
2892 failure_cooldown: std::time::Duration::ZERO,
2893 timeout: None,
2894 })
2895 };
2896 let client = Arc::new(
2897 TranslatingLlmClient::new(&[
2898 ModelConfig::new("weak", backend(), None),
2899 ModelConfig::new("strong", backend(), None),
2900 ])
2901 .expect("building test client"),
2902 );
2903 let algorithm = Arc::new(CandidateAlgorithm {});
2904 let mut llm_request = text_request(Some("auto".to_string()), "hello".to_string());
2905 llm_request.stream = true;
2906 let request = Request {
2907 llm_request,
2908 raw_request: None,
2909 metadata: None,
2910 };
2911 let result = run(
2912 algorithm,
2913 ClientRouter::single(client),
2914 request,
2915 to_category_map(&["weak", "strong"]),
2916 None,
2917 )
2918 .await;
2919 (server, calls, result)
2920 }
2921
2922 #[tokio::test]
2923 async fn first_stream_event_overflow_falls_back_to_the_next_candidate() -> Result<()> {
2924 let (_server, calls, result) = run_streaming_candidates(OVERFLOW_SSE).await;
2927 let (_, response) = result?;
2928 assert_eq!(&*calls.lock(), &["weak", "strong"]);
2929 assert_eq!(response.served_model().map(ModelId::as_str), Some("strong"));
2930 let aggregate = response
2931 .llm_response
2932 .into_agg()
2933 .await
2934 .map_err(|source| LibsyError::client_call("strong", source))?;
2935 assert_eq!(completion_text(&aggregate), "ok");
2936
2937 let (_server, calls, result) = run_streaming_candidates(
2940 "data: {\"error\":{\"code\":500,\"message\":\"engine exploded\",\"object\":\"error\"},\"model\":\"weak\"}\n\ndata: [DONE]\n\n",
2941 )
2942 .await;
2943 let (_, response) = result?;
2944 assert_eq!(&*calls.lock(), &["weak"]);
2945 let error = response
2946 .llm_response
2947 .into_agg()
2948 .await
2949 .expect_err("the in-band error should surface to the consumer");
2950 assert!(error.to_string().contains("engine exploded"));
2951
2952 let (_server, calls, result) = run_streaming_candidates(
2955 "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",
2956 )
2957 .await;
2958 let (_, response) = result?;
2959 assert_eq!(&*calls.lock(), &["weak"]);
2960 let error = response
2961 .llm_response
2962 .into_agg()
2963 .await
2964 .expect_err("the mid-stream overflow should surface to the consumer");
2965 assert!(
2966 error
2967 .to_string()
2968 .contains("exceeds the maximum allowed length")
2969 );
2970
2971 let (_server, calls, result) = run_streaming_candidates("data: [DONE]\n\n").await;
2974 let (_, response) = result?;
2975 assert_eq!(&*calls.lock(), &["weak"]);
2976 let aggregate = response
2977 .llm_response
2978 .into_agg()
2979 .await
2980 .map_err(|source| LibsyError::client_call("weak", source))?;
2981 assert_eq!(completion_text(&aggregate), "");
2982 Ok(())
2983 }
2984}