feat: surface llm retry and continuation state
This commit is contained in:
@@ -59,4 +59,6 @@ pub use interceptor::Interceptor;
|
||||
pub use message::{ContentPart, Item, Message, Role};
|
||||
pub use tool::{ToolCall, ToolOutputLimits, ToolResult};
|
||||
pub use usage_record::UsageRecord;
|
||||
pub use worker::{RunOutput, ToolRegistryError, Worker, WorkerConfig, WorkerError, WorkerResult};
|
||||
pub use worker::{
|
||||
LlmRetryNotice, RunOutput, ToolRegistryError, Worker, WorkerConfig, WorkerError, WorkerResult,
|
||||
};
|
||||
|
||||
@@ -36,6 +36,8 @@ impl std::fmt::Display for ConfigWarning {
|
||||
}
|
||||
}
|
||||
|
||||
pub type ResponseStream = Pin<Box<dyn Stream<Item = Result<Event, ClientError>> + Send>>;
|
||||
|
||||
/// LLMクライアントのtrait
|
||||
///
|
||||
/// 各プロバイダはこのtraitを実装し、統一されたインターフェースを提供する。
|
||||
@@ -49,10 +51,7 @@ pub trait LlmClient: Send + Sync {
|
||||
/// # Returns
|
||||
/// * `Ok(Stream)` - イベントストリーム
|
||||
/// * `Err(ClientError)` - エラー
|
||||
async fn stream(
|
||||
&self,
|
||||
request: Request,
|
||||
) -> Result<Pin<Box<dyn Stream<Item = Result<Event, ClientError>> + Send>>, ClientError>;
|
||||
async fn stream(&self, request: Request) -> Result<ResponseStream, ClientError>;
|
||||
|
||||
/// Clone this client into a new `Box<dyn LlmClient>`.
|
||||
///
|
||||
@@ -85,10 +84,7 @@ impl Clone for Box<dyn LlmClient> {
|
||||
/// これにより、動的ディスパッチを使用するクライアントも `Worker` で利用可能になる。
|
||||
#[async_trait]
|
||||
impl LlmClient for Box<dyn LlmClient> {
|
||||
async fn stream(
|
||||
&self,
|
||||
request: Request,
|
||||
) -> Result<Pin<Box<dyn Stream<Item = Result<Event, ClientError>> + Send>>, ClientError> {
|
||||
async fn stream(&self, request: Request) -> Result<ResponseStream, ClientError> {
|
||||
(**self).stream(request).await
|
||||
}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//! LLMクライアントエラー型
|
||||
|
||||
use std::fmt;
|
||||
use std::{fmt, time::Duration};
|
||||
|
||||
/// LLMクライアントのエラー
|
||||
#[derive(Debug)]
|
||||
@@ -16,6 +16,7 @@ pub enum ClientError {
|
||||
status: Option<u16>,
|
||||
code: Option<String>,
|
||||
message: String,
|
||||
retry_after: Option<Duration>,
|
||||
},
|
||||
/// 設定エラー
|
||||
Config(String),
|
||||
@@ -31,6 +32,7 @@ impl fmt::Display for ClientError {
|
||||
status,
|
||||
code,
|
||||
message,
|
||||
..
|
||||
} => {
|
||||
write!(f, "API error")?;
|
||||
if let Some(s) = status {
|
||||
@@ -68,6 +70,22 @@ impl From<serde_json::Error> for ClientError {
|
||||
}
|
||||
}
|
||||
|
||||
impl ClientError {
|
||||
pub fn status(&self) -> Option<u16> {
|
||||
match self {
|
||||
ClientError::Api { status, .. } => *status,
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn retry_after(&self) -> Option<Duration> {
|
||||
match self {
|
||||
ClientError::Api { retry_after, .. } => *retry_after,
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// transient な失敗としてリトライ対象になるかを判定する。
|
||||
///
|
||||
/// 対象:
|
||||
@@ -97,6 +115,7 @@ mod tests {
|
||||
status,
|
||||
code: None,
|
||||
message: String::new(),
|
||||
retry_after: None,
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
//! HTTP transient エラー向けリトライポリシー。
|
||||
//! LLM response stream を開く前の transient error 向けリトライポリシー。
|
||||
//!
|
||||
//! `transport.rs` の HTTP 送信〜ステータスチェック区間で `is_retryable`
|
||||
//! が true を返した失敗をリトライする際に、待ち時間と打ち切り条件を
|
||||
//! 提供する。SSE 読み出し開始後の失敗は対象外。
|
||||
//! Worker が `LlmClient::stream` の open error に対して `is_retryable` を見て
|
||||
//! retry / backoff / TUI event / cancellation をまとめて管理する。
|
||||
//! SSE 読み出し開始後の失敗は対象外。
|
||||
|
||||
use std::time::Duration;
|
||||
|
||||
|
||||
@@ -131,6 +131,7 @@ impl GeminiScheme {
|
||||
status: None,
|
||||
code: Some("parse_error".to_string()),
|
||||
message: format!("Failed to parse Gemini SSE data: {} -> {}", e, data),
|
||||
retry_after: None,
|
||||
})?;
|
||||
|
||||
let mut events = Vec::new();
|
||||
|
||||
@@ -75,6 +75,7 @@ impl OpenAIScheme {
|
||||
status: None,
|
||||
code: Some("parse_error".to_string()),
|
||||
message: format!("Failed to parse SSE data: {} -> {}", e, data),
|
||||
retry_after: None,
|
||||
})?;
|
||||
|
||||
let mut events = Vec::new();
|
||||
|
||||
@@ -597,6 +597,7 @@ fn from_json<T: for<'de> Deserialize<'de>>(data: &str) -> Result<T, ClientError>
|
||||
status: None,
|
||||
code: Some("parse_error".to_string()),
|
||||
message: format!("Failed to parse SSE data: {e}"),
|
||||
retry_after: None,
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@@ -12,15 +12,12 @@ use async_trait::async_trait;
|
||||
use eventsource_stream::Eventsource;
|
||||
use futures::{Stream, StreamExt, TryStreamExt};
|
||||
use reqwest::header::{CONTENT_TYPE, HeaderMap, HeaderValue, RETRY_AFTER};
|
||||
use tokio::time::Instant;
|
||||
use tracing::warn;
|
||||
|
||||
use super::auth::{AuthProvider, AuthRequirement};
|
||||
use super::capability::ModelCapability;
|
||||
use super::client::{ConfigWarning, LlmClient};
|
||||
use super::error::{ClientError, is_retryable};
|
||||
use super::client::{ConfigWarning, LlmClient, ResponseStream};
|
||||
use super::error::ClientError;
|
||||
use super::event::Event;
|
||||
use super::retry::RetryPolicy;
|
||||
use super::scheme::Scheme;
|
||||
use super::types::{Request, RequestConfig};
|
||||
|
||||
@@ -67,7 +64,6 @@ pub struct HttpTransport<S: Scheme> {
|
||||
base_url: String,
|
||||
auth: ResolvedAuth,
|
||||
capability: ModelCapability,
|
||||
retry_policy: RetryPolicy,
|
||||
}
|
||||
|
||||
impl<S: Scheme> HttpTransport<S> {
|
||||
@@ -89,7 +85,6 @@ impl<S: Scheme> HttpTransport<S> {
|
||||
base_url,
|
||||
auth,
|
||||
capability,
|
||||
retry_policy: RetryPolicy::default(),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -99,12 +94,6 @@ impl<S: Scheme> HttpTransport<S> {
|
||||
self
|
||||
}
|
||||
|
||||
/// リトライポリシーを差し替える(テスト用 / 将来の manifest 化フック)。
|
||||
pub fn with_retry_policy(mut self, policy: RetryPolicy) -> Self {
|
||||
self.retry_policy = policy;
|
||||
self
|
||||
}
|
||||
|
||||
fn build_url(&self) -> String {
|
||||
let path = self.scheme.path(&self.model_id);
|
||||
let url = format!("{}{}", self.base_url, path);
|
||||
@@ -171,14 +160,12 @@ impl<S: Scheme + Clone> Clone for HttpTransport<S> {
|
||||
base_url: self.base_url.clone(),
|
||||
auth: self.auth.clone(),
|
||||
capability: self.capability.clone(),
|
||||
retry_policy: self.retry_policy.clone(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// エラーレスポンスを `ClientError::Api` に変換し、`Retry-After` の秒数を
|
||||
/// 同時に取り出す。リトライループで wait の上書きに使う。
|
||||
async fn classify_error_response(resp: reqwest::Response) -> (ClientError, Option<Duration>) {
|
||||
/// エラーレスポンスを `ClientError::Api` に変換する。
|
||||
async fn classify_error_response(resp: reqwest::Response) -> ClientError {
|
||||
let status = resp.status().as_u16();
|
||||
let retry_after = resp
|
||||
.headers()
|
||||
@@ -187,7 +174,7 @@ async fn classify_error_response(resp: reqwest::Response) -> (ClientError, Optio
|
||||
.and_then(|s| s.trim().parse::<u64>().ok())
|
||||
.map(Duration::from_secs);
|
||||
let text = resp.text().await.unwrap_or_default();
|
||||
let err = if let Ok(json) = serde_json::from_str::<serde_json::Value>(&text) {
|
||||
if let Ok(json) = serde_json::from_str::<serde_json::Value>(&text) {
|
||||
let error = json.get("error").unwrap_or(&json);
|
||||
let code = error.get("type").and_then(|v| v.as_str()).map(String::from);
|
||||
let message = error
|
||||
@@ -199,15 +186,16 @@ async fn classify_error_response(resp: reqwest::Response) -> (ClientError, Optio
|
||||
status: Some(status),
|
||||
code,
|
||||
message,
|
||||
retry_after,
|
||||
}
|
||||
} else {
|
||||
ClientError::Api {
|
||||
status: Some(status),
|
||||
code: None,
|
||||
message: text,
|
||||
retry_after,
|
||||
}
|
||||
};
|
||||
(err, retry_after)
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
@@ -220,51 +208,25 @@ impl<S: Scheme + Clone + 'static> LlmClient for HttpTransport<S> {
|
||||
self.scheme.validate_config(config)
|
||||
}
|
||||
|
||||
async fn stream(
|
||||
&self,
|
||||
request: Request,
|
||||
) -> Result<Pin<Box<dyn Stream<Item = Result<Event, ClientError>> + Send>>, ClientError> {
|
||||
async fn stream(&self, request: Request) -> Result<ResponseStream, ClientError> {
|
||||
let url = self.build_url();
|
||||
let headers = self.build_headers().await?;
|
||||
let body = self
|
||||
.scheme
|
||||
.build_request_body(&self.model_id, &request, &self.capability);
|
||||
|
||||
let policy = &self.retry_policy;
|
||||
let started = Instant::now();
|
||||
let mut attempt: u32 = 0;
|
||||
let response = loop {
|
||||
let send_result = self
|
||||
.http_client
|
||||
.post(&url)
|
||||
.headers(headers.clone())
|
||||
.json(&body)
|
||||
.send()
|
||||
.await;
|
||||
let response = self
|
||||
.http_client
|
||||
.post(&url)
|
||||
.headers(headers)
|
||||
.json(&body)
|
||||
.send()
|
||||
.await
|
||||
.map_err(ClientError::Http)?;
|
||||
|
||||
let (err, retry_after) = match send_result {
|
||||
Ok(resp) if resp.status().is_success() => break resp,
|
||||
Ok(resp) => classify_error_response(resp).await,
|
||||
Err(e) => (ClientError::Http(e), None),
|
||||
};
|
||||
|
||||
let next_attempt = attempt + 1;
|
||||
if next_attempt >= policy.max_attempts || !is_retryable(&err) {
|
||||
return Err(err);
|
||||
}
|
||||
let wait = retry_after.unwrap_or_else(|| policy.backoff(attempt));
|
||||
if started.elapsed() + wait > policy.total_timeout {
|
||||
return Err(err);
|
||||
}
|
||||
warn!(
|
||||
error = %err,
|
||||
attempt = next_attempt,
|
||||
wait_ms = wait.as_millis() as u64,
|
||||
"transient HTTP error, retrying"
|
||||
);
|
||||
tokio::time::sleep(wait).await;
|
||||
attempt = next_attempt;
|
||||
};
|
||||
if !response.status().is_success() {
|
||||
return Err(classify_error_response(response).await);
|
||||
}
|
||||
|
||||
let scheme = self.scheme.clone();
|
||||
let byte_stream = response.bytes_stream().map_err(std::io::Error::other);
|
||||
|
||||
+207
-24
@@ -1,5 +1,5 @@
|
||||
use std::collections::HashMap;
|
||||
use std::marker::PhantomData;
|
||||
use std::{marker::PhantomData, time::Instant};
|
||||
|
||||
use futures::StreamExt;
|
||||
use tokio::sync::mpsc;
|
||||
@@ -17,8 +17,8 @@ use crate::{
|
||||
PromptAction, ToolCallInfo, ToolResultInfo, TurnEndAction,
|
||||
},
|
||||
llm_client::{
|
||||
ClientError, ConfigWarning, LlmClient, Request, RequestConfig, ToolDefinition,
|
||||
types::parse_tool_arguments,
|
||||
ClientError, ConfigWarning, LlmClient, Request, RequestConfig, ResponseStream,
|
||||
ToolDefinition, error::is_retryable, retry::RetryPolicy, types::parse_tool_arguments,
|
||||
},
|
||||
state::{Locked, Mutable, WorkerState},
|
||||
timeline::event::{ErrorEvent, StatusEvent, UsageEvent},
|
||||
@@ -99,6 +99,8 @@ enum ToolExecutionResult {
|
||||
Paused,
|
||||
}
|
||||
|
||||
const MAX_STREAM_CONTINUATIONS: u32 = 3;
|
||||
|
||||
/// Central component for managing LLM interactions
|
||||
///
|
||||
/// Receives input from the user, sends requests to the LLM, and
|
||||
@@ -131,9 +133,28 @@ enum ToolExecutionResult {
|
||||
/// let out = worker.run("Continue").await?;
|
||||
/// let mut worker = out.worker;
|
||||
/// ```
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct LlmRetryNotice {
|
||||
/// 直近で失敗した attempt 番号。1 origin。
|
||||
pub failed_attempt: u32,
|
||||
pub max_attempts: u32,
|
||||
pub wait: std::time::Duration,
|
||||
pub elapsed: std::time::Duration,
|
||||
pub status: Option<u16>,
|
||||
pub error: String,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
enum StreamCompletion {
|
||||
Complete,
|
||||
Interrupted { reason: String },
|
||||
}
|
||||
|
||||
pub struct Worker<C: LlmClient, S: WorkerState = Mutable> {
|
||||
/// LLM client
|
||||
client: C,
|
||||
/// Retry policy for opening an LLM response stream.
|
||||
retry_policy: RetryPolicy,
|
||||
/// Event timeline
|
||||
timeline: Timeline,
|
||||
/// Text block collector (Timeline handler)
|
||||
@@ -175,6 +196,10 @@ pub struct Worker<C: LlmClient, S: WorkerState = Mutable> {
|
||||
llm_call_start_cbs: Vec<Box<dyn Fn(usize) + Send + Sync>>,
|
||||
/// LlmCall-end callbacks
|
||||
llm_call_end_cbs: Vec<Box<dyn Fn(usize) + Send + Sync>>,
|
||||
/// Transport-level retry callbacks for a specific LlmCall.
|
||||
llm_retry_cbs: Vec<Box<dyn Fn(usize, &LlmRetryNotice) + Send + Sync>>,
|
||||
/// Stream continuation callbacks for a specific LlmCall.
|
||||
llm_continuation_cbs: Vec<Box<dyn Fn(usize, u32, u32, &str) + Send + Sync>>,
|
||||
/// Non-fatal warning callbacks. Invoked when the Worker wants to
|
||||
/// surface an advisory message to the upper layer (e.g. Pod) so it
|
||||
/// can be forwarded to the user — distinct from `tracing::warn!`,
|
||||
@@ -355,6 +380,34 @@ impl<C: LlmClient, S: WorkerState> Worker<C, S> {
|
||||
self.llm_call_end_cbs.push(Box::new(callback));
|
||||
}
|
||||
|
||||
/// Register a transport-level retry callback.
|
||||
pub fn on_llm_retry(
|
||||
&mut self,
|
||||
callback: impl Fn(usize, &LlmRetryNotice) + Send + Sync + 'static,
|
||||
) {
|
||||
self.llm_retry_cbs.push(Box::new(callback));
|
||||
}
|
||||
|
||||
/// Register a stream continuation callback.
|
||||
pub fn on_llm_continuation(
|
||||
&mut self,
|
||||
callback: impl Fn(usize, u32, u32, &str) + Send + Sync + 'static,
|
||||
) {
|
||||
self.llm_continuation_cbs.push(Box::new(callback));
|
||||
}
|
||||
|
||||
fn emit_llm_continuation(
|
||||
&self,
|
||||
llm_call: usize,
|
||||
attempt: u32,
|
||||
max_attempts: u32,
|
||||
reason: &str,
|
||||
) {
|
||||
for cb in &self.llm_continuation_cbs {
|
||||
cb(llm_call, attempt, max_attempts, reason);
|
||||
}
|
||||
}
|
||||
|
||||
/// Register a non-fatal warning callback.
|
||||
///
|
||||
/// The callback is invoked with a short human-readable message
|
||||
@@ -964,6 +1017,8 @@ impl<C: LlmClient, S: WorkerState> Worker<C, S> {
|
||||
}
|
||||
}
|
||||
|
||||
let mut stream_continuations: u32 = 0;
|
||||
let mut continuing_stream = false;
|
||||
loop {
|
||||
if self.try_cancelled() {
|
||||
info!("Execution cancelled");
|
||||
@@ -973,9 +1028,11 @@ impl<C: LlmClient, S: WorkerState> Worker<C, S> {
|
||||
}
|
||||
|
||||
let current_turn = self.turn_count;
|
||||
debug!(turn = current_turn, "Turn start");
|
||||
for cb in &self.turn_start_cbs {
|
||||
cb(current_turn);
|
||||
if !continuing_stream {
|
||||
debug!(turn = current_turn, "Turn start");
|
||||
for cb in &self.turn_start_cbs {
|
||||
cb(current_turn);
|
||||
}
|
||||
}
|
||||
|
||||
// Drain interceptor-side inputs that are meant to land in
|
||||
@@ -1080,13 +1137,50 @@ impl<C: LlmClient, S: WorkerState> Worker<C, S> {
|
||||
|
||||
// Stream LLM response
|
||||
let request = self.build_request(&tool_definitions, &request_context);
|
||||
self.stream_response(request).await?;
|
||||
let stream_outcome = self.stream_response(request, current_llm_call).await?;
|
||||
|
||||
for cb in &self.llm_call_end_cbs {
|
||||
cb(current_llm_call);
|
||||
}
|
||||
self.llm_call_count += 1;
|
||||
|
||||
if let StreamCompletion::Interrupted { reason } = stream_outcome {
|
||||
stream_continuations += 1;
|
||||
if stream_continuations > MAX_STREAM_CONTINUATIONS {
|
||||
self.last_run_interrupted = true;
|
||||
return Err(WorkerError::Client(ClientError::Api {
|
||||
status: None,
|
||||
code: None,
|
||||
message: format!("LLM stream interrupted too many times: {reason}"),
|
||||
retry_after: None,
|
||||
}));
|
||||
}
|
||||
|
||||
self.timeline.abort_current_block();
|
||||
self.timeline.flush_usage();
|
||||
let reasoning_items = self.reasoning_item_collector.take_collected();
|
||||
let text_blocks = self.text_block_collector.take_collected();
|
||||
// Do not recover tool calls from an interrupted stream. A completed
|
||||
// tool_use is executable only when the provider finishes the stream.
|
||||
let _dropped_tool_calls = self.tool_call_collector.take_collected();
|
||||
let assistant_items =
|
||||
self.build_assistant_items(&reasoning_items, &text_blocks, &[]);
|
||||
if !assistant_items.is_empty() {
|
||||
self.append_history_items(assistant_items);
|
||||
}
|
||||
self.emit_llm_continuation(
|
||||
current_llm_call,
|
||||
stream_continuations,
|
||||
MAX_STREAM_CONTINUATIONS,
|
||||
&reason,
|
||||
);
|
||||
continuing_stream = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
stream_continuations = 0;
|
||||
continuing_stream = false;
|
||||
|
||||
for cb in &self.turn_end_cbs {
|
||||
cb(current_turn);
|
||||
}
|
||||
@@ -1138,8 +1232,88 @@ impl<C: LlmClient, S: WorkerState> Worker<C, S> {
|
||||
}
|
||||
}
|
||||
|
||||
async fn open_stream_with_retry(
|
||||
&mut self,
|
||||
request: Request,
|
||||
llm_call: usize,
|
||||
) -> Result<ResponseStream, WorkerError> {
|
||||
let policy = self.retry_policy.clone();
|
||||
let started = Instant::now();
|
||||
let mut failed_attempt: u32 = 0;
|
||||
|
||||
loop {
|
||||
let stream_result = tokio::select! {
|
||||
stream_result = self.client.stream(request.clone()) => stream_result,
|
||||
cancel = self.cancel_rx.recv() => {
|
||||
if cancel.is_some() {
|
||||
info!("Cancelled before stream started");
|
||||
}
|
||||
self.timeline.abort_current_block();
|
||||
self.last_run_interrupted = true;
|
||||
return Err(WorkerError::Cancelled);
|
||||
}
|
||||
};
|
||||
|
||||
match stream_result {
|
||||
Ok(stream) => return Ok(stream),
|
||||
Err(err) => {
|
||||
let next_failed_attempt = failed_attempt + 1;
|
||||
if next_failed_attempt >= policy.max_attempts || !is_retryable(&err) {
|
||||
self.last_run_interrupted = true;
|
||||
return Err(WorkerError::Client(err));
|
||||
}
|
||||
|
||||
let wait = err
|
||||
.retry_after()
|
||||
.unwrap_or_else(|| policy.backoff(failed_attempt));
|
||||
let elapsed = started.elapsed();
|
||||
if elapsed + wait > policy.total_timeout {
|
||||
self.last_run_interrupted = true;
|
||||
return Err(WorkerError::Client(err));
|
||||
}
|
||||
|
||||
warn!(
|
||||
error = %err,
|
||||
failed_attempt = next_failed_attempt,
|
||||
wait_ms = wait.as_millis() as u64,
|
||||
"transient LLM request error, retrying"
|
||||
);
|
||||
let notice = LlmRetryNotice {
|
||||
failed_attempt: next_failed_attempt,
|
||||
max_attempts: policy.max_attempts,
|
||||
wait,
|
||||
elapsed,
|
||||
status: err.status(),
|
||||
error: err.to_string(),
|
||||
};
|
||||
for cb in &self.llm_retry_cbs {
|
||||
cb(llm_call, ¬ice);
|
||||
}
|
||||
|
||||
tokio::select! {
|
||||
_ = tokio::time::sleep(wait) => {}
|
||||
cancel = self.cancel_rx.recv() => {
|
||||
if cancel.is_some() {
|
||||
info!("Cancelled during LLM retry backoff");
|
||||
}
|
||||
self.timeline.abort_current_block();
|
||||
self.last_run_interrupted = true;
|
||||
return Err(WorkerError::Cancelled);
|
||||
}
|
||||
}
|
||||
|
||||
failed_attempt = next_failed_attempt;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Open a stream, dispatch all events to the timeline, handle cancellation.
|
||||
async fn stream_response(&mut self, request: Request) -> Result<(), WorkerError> {
|
||||
async fn stream_response(
|
||||
&mut self,
|
||||
request: Request,
|
||||
llm_call: usize,
|
||||
) -> Result<StreamCompletion, WorkerError> {
|
||||
debug!(
|
||||
item_count = request.items.len(),
|
||||
tool_count = request.tools.len(),
|
||||
@@ -1147,18 +1321,7 @@ impl<C: LlmClient, S: WorkerState> Worker<C, S> {
|
||||
"Sending request to LLM"
|
||||
);
|
||||
|
||||
let mut stream = tokio::select! {
|
||||
stream_result = self.client.stream(request) => stream_result
|
||||
.inspect_err(|_| self.last_run_interrupted = true)?,
|
||||
cancel = self.cancel_rx.recv() => {
|
||||
if cancel.is_some() {
|
||||
info!("Cancelled before stream started");
|
||||
}
|
||||
self.timeline.abort_current_block();
|
||||
self.last_run_interrupted = true;
|
||||
return Err(WorkerError::Cancelled);
|
||||
}
|
||||
};
|
||||
let mut stream = self.open_stream_with_retry(request, llm_call).await?;
|
||||
|
||||
let mut event_count: usize = 0;
|
||||
loop {
|
||||
@@ -1175,12 +1338,17 @@ impl<C: LlmClient, S: WorkerState> Worker<C, S> {
|
||||
warn!(error = %e, "Stream error");
|
||||
}
|
||||
}
|
||||
let event = result
|
||||
.inspect_err(|_| {
|
||||
let event = match result {
|
||||
Ok(event) => event,
|
||||
Err(err) => {
|
||||
self.last_run_interrupted = true;
|
||||
// 部分情報でも発火しておく(料金会計用)
|
||||
self.timeline.flush_usage();
|
||||
})?;
|
||||
return Ok(StreamCompletion::Interrupted {
|
||||
reason: err.to_string(),
|
||||
});
|
||||
}
|
||||
};
|
||||
self.timeline.dispatch(&event);
|
||||
}
|
||||
None => break,
|
||||
@@ -1200,7 +1368,7 @@ impl<C: LlmClient, S: WorkerState> Worker<C, S> {
|
||||
// ストリーム完了時に集約済み Usage を 1 度だけ発火
|
||||
self.timeline.flush_usage();
|
||||
debug!(event_count = event_count, "Stream completed");
|
||||
Ok(())
|
||||
Ok(StreamCompletion::Complete)
|
||||
}
|
||||
|
||||
/// Execute tools and push results to history.
|
||||
@@ -1254,6 +1422,7 @@ impl<C: LlmClient> Worker<C, Mutable> {
|
||||
|
||||
Self {
|
||||
client,
|
||||
retry_policy: RetryPolicy::default(),
|
||||
timeline,
|
||||
text_block_collector,
|
||||
tool_call_collector,
|
||||
@@ -1270,6 +1439,8 @@ impl<C: LlmClient> Worker<C, Mutable> {
|
||||
turn_end_cbs: Vec::new(),
|
||||
llm_call_start_cbs: Vec::new(),
|
||||
llm_call_end_cbs: Vec::new(),
|
||||
llm_retry_cbs: Vec::new(),
|
||||
llm_continuation_cbs: Vec::new(),
|
||||
warning_cbs: Vec::new(),
|
||||
tool_result_cbs: Vec::new(),
|
||||
history_append_cbs: Vec::new(),
|
||||
@@ -1385,6 +1556,12 @@ impl<C: LlmClient> Worker<C, Mutable> {
|
||||
self
|
||||
}
|
||||
|
||||
/// Set the retry policy used when opening an LLM response stream.
|
||||
pub fn with_retry_policy(mut self, retry_policy: RetryPolicy) -> Self {
|
||||
self.retry_policy = retry_policy;
|
||||
self
|
||||
}
|
||||
|
||||
/// Validate current configuration against the provider
|
||||
///
|
||||
/// Returns an error if there are unsupported settings.
|
||||
@@ -1507,6 +1684,7 @@ impl<C: LlmClient> Worker<C, Mutable> {
|
||||
let locked_prefix_len = self.history.len();
|
||||
Worker {
|
||||
client: self.client,
|
||||
retry_policy: self.retry_policy,
|
||||
timeline: self.timeline,
|
||||
text_block_collector: self.text_block_collector,
|
||||
tool_call_collector: self.tool_call_collector,
|
||||
@@ -1523,6 +1701,8 @@ impl<C: LlmClient> Worker<C, Mutable> {
|
||||
turn_end_cbs: self.turn_end_cbs,
|
||||
llm_call_start_cbs: self.llm_call_start_cbs,
|
||||
llm_call_end_cbs: self.llm_call_end_cbs,
|
||||
llm_retry_cbs: self.llm_retry_cbs,
|
||||
llm_continuation_cbs: self.llm_continuation_cbs,
|
||||
warning_cbs: self.warning_cbs,
|
||||
tool_result_cbs: self.tool_result_cbs,
|
||||
history_append_cbs: self.history_append_cbs,
|
||||
@@ -1594,6 +1774,7 @@ impl<C: LlmClient> Worker<C, Locked> {
|
||||
pub fn unlock(self) -> Worker<C, Mutable> {
|
||||
Worker {
|
||||
client: self.client,
|
||||
retry_policy: self.retry_policy,
|
||||
timeline: self.timeline,
|
||||
text_block_collector: self.text_block_collector,
|
||||
tool_call_collector: self.tool_call_collector,
|
||||
@@ -1610,6 +1791,8 @@ impl<C: LlmClient> Worker<C, Locked> {
|
||||
turn_end_cbs: self.turn_end_cbs,
|
||||
llm_call_start_cbs: self.llm_call_start_cbs,
|
||||
llm_call_end_cbs: self.llm_call_end_cbs,
|
||||
llm_retry_cbs: self.llm_retry_cbs,
|
||||
llm_continuation_cbs: self.llm_continuation_cbs,
|
||||
warning_cbs: self.warning_cbs,
|
||||
tool_result_cbs: self.tool_result_cbs,
|
||||
history_append_cbs: self.history_append_cbs,
|
||||
|
||||
@@ -4,17 +4,77 @@
|
||||
|
||||
mod common;
|
||||
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::sync::{Arc, Mutex};
|
||||
use std::time::Duration;
|
||||
|
||||
use async_trait::async_trait;
|
||||
use common::MockLlmClient;
|
||||
use llm_worker::Worker;
|
||||
use llm_worker::llm_client::event::{Event, ResponseStatus, StatusEvent as ClientStatusEvent};
|
||||
use llm_worker::llm_client::retry::RetryPolicy;
|
||||
use llm_worker::llm_client::{ClientError, LlmClient, Request, ResponseStream};
|
||||
use llm_worker::tool::{Tool, ToolDefinition, ToolError, ToolMeta, ToolOutput};
|
||||
|
||||
// =============================================================================
|
||||
// Tests
|
||||
// =============================================================================
|
||||
#[derive(Clone)]
|
||||
struct FailOnceClient {
|
||||
calls: Arc<AtomicUsize>,
|
||||
events: Vec<Event>,
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl LlmClient for FailOnceClient {
|
||||
async fn stream(&self, _request: Request) -> Result<ResponseStream, ClientError> {
|
||||
if self.calls.fetch_add(1, Ordering::SeqCst) == 0 {
|
||||
return Err(ClientError::Api {
|
||||
status: Some(504),
|
||||
code: None,
|
||||
message: "gateway timeout".into(),
|
||||
retry_after: None,
|
||||
});
|
||||
}
|
||||
Ok(Box::pin(futures::stream::iter(
|
||||
self.events.clone().into_iter().map(Ok),
|
||||
)))
|
||||
}
|
||||
|
||||
fn clone_boxed(&self) -> Box<dyn LlmClient> {
|
||||
Box::new(self.clone())
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_callback_llm_retry_event() {
|
||||
let events = vec![Event::Status(ClientStatusEvent {
|
||||
status: ResponseStatus::Completed,
|
||||
})];
|
||||
let client = FailOnceClient {
|
||||
calls: Arc::new(AtomicUsize::new(0)),
|
||||
events,
|
||||
};
|
||||
let mut worker = Worker::new(client).with_retry_policy(RetryPolicy {
|
||||
base: Duration::from_millis(1),
|
||||
cap: Duration::from_millis(1),
|
||||
max_attempts: 2,
|
||||
total_timeout: Duration::from_secs(1),
|
||||
});
|
||||
|
||||
let notices = Arc::new(Mutex::new(Vec::new()));
|
||||
let sink = notices.clone();
|
||||
worker.on_llm_retry(move |llm_call, notice| {
|
||||
sink.lock().unwrap().push((llm_call, notice.clone()));
|
||||
});
|
||||
|
||||
let result = worker.run("retry once").await;
|
||||
assert!(result.is_ok(), "worker should succeed after one retry");
|
||||
|
||||
let notices = notices.lock().unwrap();
|
||||
assert_eq!(notices.len(), 1);
|
||||
assert_eq!(notices[0].0, 0);
|
||||
assert_eq!(notices[0].1.failed_attempt, 1);
|
||||
assert_eq!(notices[0].1.max_attempts, 2);
|
||||
assert_eq!(notices[0].1.status, Some(504));
|
||||
}
|
||||
|
||||
/// Verify that on_text_block correctly receives delta and stop events
|
||||
#[tokio::test]
|
||||
|
||||
@@ -59,6 +59,7 @@ impl LlmClient for MockLlmClient {
|
||||
status: Some(500),
|
||||
code: Some("mock_error".to_string()),
|
||||
message: "No more mock responses".to_string(),
|
||||
retry_after: None,
|
||||
});
|
||||
}
|
||||
let events = self.responses[count].clone();
|
||||
|
||||
@@ -1,12 +1,7 @@
|
||||
//! HTTP transport の transient エラーリトライ挙動の integration テスト。
|
||||
//! HTTP transport の単発 request / error classification テスト。
|
||||
//!
|
||||
//! 対応チケット: `tickets/llm-worker-transient-retry.md`。
|
||||
//! - 503 / 529 / connect refused でリトライ発火
|
||||
//! - max_attempts 上限到達でエラー
|
||||
//! - `Retry-After` ヘッダで指数バックオフを上書き
|
||||
//! - `parse_sse` 由来の `ClientError::Sse`(mid-stream 想定)はリトライしない
|
||||
|
||||
use std::time::{Duration, Instant};
|
||||
//! Retry/backoff は Worker の lifecycle 管理に属するため、transport は 1 回だけ
|
||||
//! request を送り、HTTP status / Retry-After を `ClientError` に載せて返す。
|
||||
|
||||
use futures::StreamExt;
|
||||
use llm_worker::llm_client::LlmClient;
|
||||
@@ -14,16 +9,16 @@ use llm_worker::llm_client::auth::AuthRequirement;
|
||||
use llm_worker::llm_client::capability::ModelCapability;
|
||||
use llm_worker::llm_client::error::ClientError;
|
||||
use llm_worker::llm_client::event::Event;
|
||||
use llm_worker::llm_client::retry::RetryPolicy;
|
||||
use llm_worker::llm_client::scheme::Scheme;
|
||||
use llm_worker::llm_client::transport::{HttpTransport, ResolvedAuth};
|
||||
use llm_worker::llm_client::types::Request;
|
||||
use serde_json::Value;
|
||||
use std::time::Duration;
|
||||
use wiremock::matchers::{method, path};
|
||||
use wiremock::{Mock, MockServer, ResponseTemplate};
|
||||
|
||||
/// SSE 本体は触らないテスト用 scheme。`parse_fail` を立てると
|
||||
/// stream 消費中(= retry loop の外)で `ClientError::Sse` を返す。
|
||||
/// stream 消費中で `ClientError::Sse` を返す。
|
||||
#[derive(Clone)]
|
||||
struct DummyScheme {
|
||||
parse_fail: bool,
|
||||
@@ -31,18 +26,23 @@ struct DummyScheme {
|
||||
|
||||
impl Scheme for DummyScheme {
|
||||
type State = ();
|
||||
|
||||
fn default_base_url(&self) -> &'static str {
|
||||
""
|
||||
}
|
||||
|
||||
fn path(&self, _: &str) -> String {
|
||||
"/v1/chat".into()
|
||||
}
|
||||
|
||||
fn required_auth(&self) -> AuthRequirement {
|
||||
AuthRequirement::None
|
||||
}
|
||||
|
||||
fn build_request_body(&self, _: &str, _: &Request, _: &ModelCapability) -> Value {
|
||||
serde_json::json!({})
|
||||
}
|
||||
|
||||
fn parse_sse(&self, _: &str, _: &str, _: &mut ()) -> Result<Vec<Event>, ClientError> {
|
||||
if self.parse_fail {
|
||||
Err(ClientError::Sse(
|
||||
@@ -52,25 +52,13 @@ impl Scheme for DummyScheme {
|
||||
Ok(vec![])
|
||||
}
|
||||
}
|
||||
|
||||
fn default_capability(&self) -> ModelCapability {
|
||||
ModelCapability::minimal()
|
||||
}
|
||||
}
|
||||
|
||||
fn fast_policy(max_attempts: u32) -> RetryPolicy {
|
||||
RetryPolicy {
|
||||
base: Duration::from_millis(1),
|
||||
cap: Duration::from_millis(1),
|
||||
max_attempts,
|
||||
total_timeout: Duration::from_secs(60),
|
||||
}
|
||||
}
|
||||
|
||||
fn build_transport(
|
||||
base_url: impl Into<String>,
|
||||
parse_fail: bool,
|
||||
policy: RetryPolicy,
|
||||
) -> HttpTransport<DummyScheme> {
|
||||
fn build_transport(base_url: impl Into<String>, parse_fail: bool) -> HttpTransport<DummyScheme> {
|
||||
HttpTransport::new(
|
||||
DummyScheme { parse_fail },
|
||||
"test-model",
|
||||
@@ -78,7 +66,6 @@ fn build_transport(
|
||||
ResolvedAuth::None,
|
||||
ModelCapability::minimal(),
|
||||
)
|
||||
.with_retry_policy(policy)
|
||||
}
|
||||
|
||||
fn ok_sse() -> ResponseTemplate {
|
||||
@@ -88,78 +75,11 @@ fn ok_sse() -> ResponseTemplate {
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn retries_503_then_succeeds() {
|
||||
async fn retryable_status_returns_api_error_without_retrying() {
|
||||
let server = MockServer::start().await;
|
||||
Mock::given(method("POST"))
|
||||
.and(path("/v1/chat"))
|
||||
.respond_with(ResponseTemplate::new(503).set_body_string("upstream connect error"))
|
||||
.up_to_n_times(2)
|
||||
.mount(&server)
|
||||
.await;
|
||||
Mock::given(method("POST"))
|
||||
.and(path("/v1/chat"))
|
||||
.respond_with(ok_sse())
|
||||
.mount(&server)
|
||||
.await;
|
||||
|
||||
let transport = build_transport(server.uri(), false, fast_policy(5));
|
||||
let mut stream = transport
|
||||
.stream(Request::default())
|
||||
.await
|
||||
.expect("stream should succeed after retries");
|
||||
while stream.next().await.is_some() {}
|
||||
|
||||
let received = server.received_requests().await.unwrap();
|
||||
assert_eq!(received.len(), 3, "two failures plus one success expected");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn retries_529_then_exhausts() {
|
||||
let server = MockServer::start().await;
|
||||
Mock::given(method("POST"))
|
||||
.and(path("/v1/chat"))
|
||||
.respond_with(ResponseTemplate::new(529).set_body_string("overloaded"))
|
||||
.mount(&server)
|
||||
.await;
|
||||
|
||||
let transport = build_transport(server.uri(), false, fast_policy(3));
|
||||
match transport.stream(Request::default()).await {
|
||||
Err(ClientError::Api {
|
||||
status: Some(529), ..
|
||||
}) => {}
|
||||
Err(other) => panic!("expected Api(529), got {other:?}"),
|
||||
Ok(_) => panic!("expected error after exhausting retries"),
|
||||
}
|
||||
|
||||
let received = server.received_requests().await.unwrap();
|
||||
assert_eq!(received.len(), 3, "should hit max_attempts and stop");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn connect_refused_retries_then_fails() {
|
||||
// 接続不能なローカルアドレスを使う。Linux では `Connection refused` で
|
||||
// 即時失敗するため、`fast_policy` ならテストが秒以下で終わる。
|
||||
let unreachable = "http://127.0.0.1:1";
|
||||
|
||||
let transport = build_transport(unreachable, false, fast_policy(3));
|
||||
match transport.stream(Request::default()).await {
|
||||
Err(ClientError::Http(e)) => {
|
||||
assert!(
|
||||
e.is_connect() || e.is_timeout(),
|
||||
"expected connect/timeout, got {e:?}"
|
||||
);
|
||||
}
|
||||
Err(other) => panic!("expected Http error, got {other:?}"),
|
||||
Ok(_) => panic!("expected error connecting to closed port"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn retry_after_header_overrides_backoff() {
|
||||
let server = MockServer::start().await;
|
||||
Mock::given(method("POST"))
|
||||
.and(path("/v1/chat"))
|
||||
.respond_with(ResponseTemplate::new(503).insert_header("retry-after", "1"))
|
||||
.up_to_n_times(1)
|
||||
.mount(&server)
|
||||
.await;
|
||||
@@ -169,34 +89,48 @@ async fn retry_after_header_overrides_backoff() {
|
||||
.mount(&server)
|
||||
.await;
|
||||
|
||||
// base/cap を 1ms に絞った policy で `Retry-After: 1` を観察すると、
|
||||
// 指数バックオフ単独なら 1ms 程度で終わるはずが Retry-After に従って
|
||||
// 1 秒待つ → 経過時間で override を検証できる。
|
||||
let policy = RetryPolicy {
|
||||
base: Duration::from_millis(1),
|
||||
cap: Duration::from_millis(1),
|
||||
max_attempts: 3,
|
||||
total_timeout: Duration::from_secs(10),
|
||||
};
|
||||
let transport = build_transport(server.uri(), false, policy);
|
||||
let transport = build_transport(server.uri(), false);
|
||||
match transport.stream(Request::default()).await {
|
||||
Err(ClientError::Api {
|
||||
status: Some(503), ..
|
||||
}) => {}
|
||||
Err(other) => panic!("expected Api(503), got {other:?}"),
|
||||
Ok(_) => panic!("transport must not retry internally"),
|
||||
}
|
||||
|
||||
let start = Instant::now();
|
||||
let mut stream = transport.stream(Request::default()).await.expect("ok");
|
||||
while stream.next().await.is_some() {}
|
||||
let elapsed = start.elapsed();
|
||||
|
||||
assert!(
|
||||
elapsed >= Duration::from_secs(1),
|
||||
"Retry-After=1 should make us wait >=1s, elapsed={elapsed:?}"
|
||||
);
|
||||
assert!(
|
||||
elapsed < Duration::from_secs(3),
|
||||
"Retry-After=1 should not balloon, elapsed={elapsed:?}"
|
||||
let received = server.received_requests().await.unwrap();
|
||||
assert_eq!(
|
||||
received.len(),
|
||||
1,
|
||||
"transport should send exactly one request"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn mid_stream_sse_error_does_not_retry() {
|
||||
async fn retry_after_header_is_preserved_on_api_error() {
|
||||
let server = MockServer::start().await;
|
||||
Mock::given(method("POST"))
|
||||
.and(path("/v1/chat"))
|
||||
.respond_with(ResponseTemplate::new(503).insert_header("retry-after", "1"))
|
||||
.mount(&server)
|
||||
.await;
|
||||
|
||||
let transport = build_transport(server.uri(), false);
|
||||
match transport.stream(Request::default()).await {
|
||||
Err(
|
||||
err @ ClientError::Api {
|
||||
status: Some(503), ..
|
||||
},
|
||||
) => {
|
||||
assert_eq!(err.retry_after(), Some(Duration::from_secs(1)));
|
||||
}
|
||||
Err(other) => panic!("expected Api(503), got {other:?}"),
|
||||
Ok(_) => panic!("expected error"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn mid_stream_sse_error_is_stream_item_error() {
|
||||
let server = MockServer::start().await;
|
||||
Mock::given(method("POST"))
|
||||
.and(path("/v1/chat"))
|
||||
@@ -211,11 +145,11 @@ async fn mid_stream_sse_error_does_not_retry() {
|
||||
.mount(&server)
|
||||
.await;
|
||||
|
||||
let transport = build_transport(server.uri(), true, fast_policy(5));
|
||||
let transport = build_transport(server.uri(), true);
|
||||
let mut stream = transport
|
||||
.stream(Request::default())
|
||||
.await
|
||||
.expect("status 200 should bypass retry loop");
|
||||
.expect("status 200 should open stream");
|
||||
let mut saw_sse_err = false;
|
||||
while let Some(item) = stream.next().await {
|
||||
if matches!(item, Err(ClientError::Sse(_))) {
|
||||
@@ -225,11 +159,11 @@ async fn mid_stream_sse_error_does_not_retry() {
|
||||
assert!(saw_sse_err, "expected Sse error from stream consumer");
|
||||
|
||||
let received = server.received_requests().await.unwrap();
|
||||
assert_eq!(received.len(), 1, "mid-stream Sse must not retry");
|
||||
assert_eq!(received.len(), 1, "mid-stream Sse must not reopen stream");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn non_retryable_status_returns_immediately() {
|
||||
async fn non_retryable_status_returns_api_error() {
|
||||
let server = MockServer::start().await;
|
||||
Mock::given(method("POST"))
|
||||
.and(path("/v1/chat"))
|
||||
@@ -237,7 +171,7 @@ async fn non_retryable_status_returns_immediately() {
|
||||
.mount(&server)
|
||||
.await;
|
||||
|
||||
let transport = build_transport(server.uri(), false, fast_policy(5));
|
||||
let transport = build_transport(server.uri(), false);
|
||||
match transport.stream(Request::default()).await {
|
||||
Err(ClientError::Api {
|
||||
status: Some(401), ..
|
||||
@@ -247,5 +181,5 @@ async fn non_retryable_status_returns_immediately() {
|
||||
}
|
||||
|
||||
let received = server.received_requests().await.unwrap();
|
||||
assert_eq!(received.len(), 1, "401 must not retry");
|
||||
assert_eq!(received.len(), 1);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user