mirror of
https://github.com/outbackdingo/optimclaw.git
synced 2026-08-25 14:53:34 +00:00
* Add automated QA: tool schema validator, feature-flag CI matrix, Docker build P0 items from the automated QA plan (#352): - Add validate_tool_schema() that checks OpenAI strict-mode rules (type: object, required keys in properties, nested object/array recursion) with 10 unit tests and 6 integration tests covering all core built-in tools - CI test matrix now runs with --all-features, default features, and --no-default-features --features libsql to catch dead code behind wrong cfg gates - CI clippy now runs the same 3-feature matrix with --all flags - Docker build job added to catch missing files in Dockerfile Co-Authored-By: Claude Opus 4.6 <[email protected]> * Add P1 automated QA tests and fix LeakDetector prefix shadowing bug P1 test coverage: config round-trip (settings + bootstrap), shell tool arg handling, safety adversarial tests (sanitizer, leak detector, allowlist), turn persistence (conversations, metadata, pagination, jobs), and a clippy fix for libsql-only builds. Fixed a real bug where AhoCorasick non-overlapping prefix iteration caused shorter prefixes (e.g. "sk-") to shadow longer ones (e.g. "sk-ant-api"), preventing Anthropic API key and SSH private key detection. Co-Authored-By: Claude Opus 4.6 <[email protected]> * Add P2 automated QA tests: chaos, lifecycle, collision, and recovery Cover all P2 items from the automated QA plan: - Circuit breaker chaos tests (hanging provider, rapid cycles, mixed errors) - Failover chaos tests (hanging failover, all-fail, tools path, single provider) - Value estimator boundary tests (negative cost, zero price, zero earnings) - Context length recovery test (ContextLengthExceeded -> compact -> retry) - WASM channel lifecycle tests (write/commit/read round-trip, namespace isolation) - Extension registry collision tests (same-name different-kind coexistence) - Extension filesystem collision tests (separate dirs, detect_kind priority) Co-Authored-By: Claude Opus 4.6 <[email protected]> * Add P3 concurrent stress tests for ContextManager and SessionManager Tests verify thread safety of double-checked locking, TOCTOU prevention, and RwLock-based concurrent access patterns under load. Co-Authored-By: Claude Opus 4.6 <[email protected]> * Add dispatcher loop guard and self-repair stuck job tests Dispatcher: test force_text mechanism prevents infinite tool call loops, verify iteration bound arithmetic guarantees termination for all configs. Self-repair: test stuck job detection, recovery within attempt limits, manual escalation when limit exceeded, graceful degradation without store/builder dependencies. Co-Authored-By: Claude Opus 4.6 <[email protected]> * Add E2E testing infrastructure design doc Python + Playwright framework with mock LLM server for deterministic browser-level testing of the web gateway. Covers connection/auth, chat round-trip with SSE streaming, and skills lifecycle scenarios. Co-Authored-By: Claude Opus 4.6 <[email protected]> * Add E2E testing infrastructure implementation plan 10-task plan covering: scaffolding, mock LLM server, helpers, conftest fixtures, connection/chat/skills test scenarios, CI workflow, README, and integration run. Co-Authored-By: Claude Opus 4.6 <[email protected]> * scaffold: E2E test project with pyproject.toml Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: E2E helpers with DOM selectors and port discovery Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: mock OpenAI-compat LLM server for E2E tests Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: E2E conftest with session fixtures for mock LLM and ironclaw Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: E2E scenario 1 -- connection and tab navigation tests Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: E2E scenario 2 -- chat message round-trip tests Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: E2E scenario 3 -- skills search, install, remove tests Co-Authored-By: Claude Opus 4.6 <[email protected]> * ci: add weekly E2E test workflow with Playwright Co-Authored-By: Claude Opus 4.6 <[email protected]> * docs: E2E test README with setup and usage instructions Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: E2E test integration fixes from first run - Use temp file DB instead of :memory: (libSQL :memory: doesn't persist tables across execute_batch) - Fix installed skills selector: #skills-list not #installed-skills - Add pytest-timeout to dependencies - Improve skills install/remove test with wait_for instead of fixed sleeps 8 passed, 1 skipped (skills install depends on ClawHub availability) Co-Authored-By: Claude Opus 4.6 <[email protected]> * test: add OpenAI strict-mode schema validator for all built-in tools (QA 1.1) Add src/tools/schema_validator.rs with validate_strict_schema() that checks tool parameter schemas against OpenAI function calling strict-mode rules: type object at top level, required keys in properties, enum type consistency, array items definitions, nested object recursion, and additionalProperties. 17 tests validate all 34+ built-in tool schemas across 5 test groups: - 9 simple tools (echo, time, json, http, shell, file read/write/list/patch) - 4 job tools (create, list, status, cancel) - 4 skill tools (list, search, install, remove) - 13 inline schemas for extension, routine, and complex job tools - 4 memory tool schemas Co-Authored-By: Claude Opus 4.6 <[email protected]> * test: add E2E scenarios for SSE reconnect, HTML injection, and tool approval (QA 3.3/5/6) Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: E2E test reliability for HTML injection and SSE reconnect - HTML injection: test sanitization directly via JS injection instead of depending on full LLM round-trip (avoids intermittent 404 from mock) - SSE reconnect: increase wait times for DB persistence and relax assertion to check total message count after history reload Co-Authored-By: Claude Opus 4.6 <[email protected]> * style: cargo fmt formatting Co-Authored-By: Claude Opus 4.6 <[email protected]> * test: add WASM and MCP tool schema validation tests (QA 1.1) Extends the schema validator with representative WASM tool schemas (weather, HTTP client, batch processor, status), MCP tool schemas (default, file read, SQL query, strict mode), and defect detection tests for common external schema issues (missing type, typo in required, array without items, enum type mismatch). Co-Authored-By: Claude Opus 4.6 <[email protected]> * test: add auth middleware and compaction module tests Auth middleware (8 new tests): valid/invalid bearer tokens, query param fallback, case sensitivity, empty tokens, whitespace handling. Compaction module (16 new tests): truncation strategy, summarize strategy with mock LLM, workspace fallback, format_turns helper, sequential compactions, coherence after compaction, token decrease verification. Co-Authored-By: Claude Opus 4.6 <[email protected]> * test: add config round-trip integration tests (QA 1.2) Test the full bootstrap .env lifecycle: write via the same format as save_bootstrap_env/upsert_bootstrap_var, read back via dotenvy, and assert values match. Covers LLM backend selection, embedding disable flag, onboard completion flag, session token keys, multi-key preservation across upsert, and special characters (spaces, equals, quotes, backslashes, hashes). Co-Authored-By: Claude Opus 4.6 <[email protected]> * test: add value estimator boundary tests and dispatcher loop guard (QA 4.3/4.4) Value estimator (14 new tests): zero/negative prices, large values, negative cost, exact margin boundaries, custom margin configuration. Dispatcher loop guard (2 new tests): verifies the dispatch loop terminates when all tool calls fail (regression guard for PR #252 infinite loop) and when max iterations are reached. Co-Authored-By: Claude Opus 4.6 <[email protected]> * test: add failover edge cases and provider chaos tests (QA 2.6/4.1) Failover edge cases (4 new tests): cooldown at zero nanos, half-open failure reopens circuit, all providers fail gracefully (no panic), single failing provider with cooldown. Provider chaos tests (15 new tests): flakey provider with retries, hanging provider with timeout, garbage provider, circuit breaker trip/recover, failover chain cascading, non-transient error stops chain, full stack integration (retry + failover + circuit breaker). Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: address PR review feedback on QA tests - Fix Bearer auth case-sensitivity per RFC 6750 (auth.rs) - Refactor bootstrap.rs to expose path-parameterized variants so config_round_trip tests call real code instead of reimplementations - Remove deprecated event_loop fixture, use dynamic ports, minimal env, session-scoped browser, and wire HEADED=1 in E2E conftest - Add cross-referencing doc comments between schema validators - Simplify array validation logic in tool.rs - Bump e2e.yml checkout@v4 to @v6 Co-Authored-By: Claude Opus 4.6 <[email protected]> * style: cargo fmt and fix clippy warning in signal.rs Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: improve E2E fixture error reporting and prevent stdin blocking - Add --no-onboard flag to prevent wizard from blocking in CI - Pipe /dev/null to stdin to prevent any stdin reads from hanging - Add RUST_BACKTRACE=1 for crash diagnostics - On server startup timeout, dump stderr to pytest output so CI logs show why the server failed to start Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: set session-scoped event loop for E2E async fixtures pytest-asyncio 1.3.0 defaults asyncio_default_fixture_loop_scope to None (function scope), causing session-scoped async fixtures to be re-evaluated per test function with independent event loops. Each test then independently attempts to start the ironclaw server, times out at 120s, and wastes ~24 minutes of CI before the job is cancelled. Setting asyncio_default_fixture_loop_scope = "session" ensures all session-scoped async fixtures share a single event loop, so the server starts once and is reused across all tests. Also adds -x flag to pytest in CI to stop on first failure instead of running all 19 tests when the fixture is broken. Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: set test loop scope to session to match fixture loop scope With asyncio_default_fixture_loop_scope=session but asyncio_default_test_loop_scope=function (the default), tests run on a per-function event loop while fixtures produce objects (Playwright pages, browser contexts) on the session event loop. This event loop mismatch causes the test to hang indefinitely awaiting Playwright operations that are bound to the wrong loop. Setting both scopes to "session" ensures a single event loop is shared across all fixtures and tests, eliminating the deadlock. Co-Authored-By: Claude Opus 4.6 <[email protected]> * ci: add roll-up jobs to match branch protection required checks Branch protection expects "Code Style (fmt + clippy)" and "Run Tests" status checks, but only individual job names were reported. Add roll-up jobs that aggregate results and report the expected names. Co-Authored-By: Claude Opus 4.6 <[email protected]> --------- Co-authored-by: Claude Opus 4.6 <[email protected]>
779 lines
26 KiB
Rust
779 lines
26 KiB
Rust
//! LLM provider chaos tests (QA Plan item 4.1).
|
|
//!
|
|
//! Tests the failover chain, circuit breaker, and retry logic under realistic
|
|
//! failure modes with specialized mock providers.
|
|
//!
|
|
//! Mock providers:
|
|
//! - `FlakeyProvider` -- Fails N times, then succeeds
|
|
//! - `HangingProvider` -- Hangs forever (tests caller-side timeout)
|
|
//! - `GarbageProvider` -- Returns valid response structure with garbage content
|
|
|
|
use std::sync::Arc;
|
|
use std::sync::atomic::{AtomicU32, Ordering};
|
|
use std::time::Duration;
|
|
|
|
use async_trait::async_trait;
|
|
use rust_decimal::Decimal;
|
|
|
|
use ironclaw::error::LlmError;
|
|
use ironclaw::llm::{
|
|
ChatMessage, CircuitBreakerConfig, CircuitBreakerProvider, CompletionRequest,
|
|
CompletionResponse, CooldownConfig, FailoverProvider, FinishReason, LlmProvider, RetryConfig,
|
|
RetryProvider, ToolCompletionRequest, ToolCompletionResponse,
|
|
};
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Mock providers
|
|
// ---------------------------------------------------------------------------
|
|
|
|
/// Provider that fails N times then succeeds.
|
|
///
|
|
/// Thread-safe: uses atomic counter so it works correctly across retries
|
|
/// and concurrent access.
|
|
struct FlakeyProvider {
|
|
failures_remaining: AtomicU32,
|
|
success_response: String,
|
|
name: String,
|
|
call_count: AtomicU32,
|
|
}
|
|
|
|
impl FlakeyProvider {
|
|
fn new(failures: u32, response: impl Into<String>) -> Self {
|
|
Self {
|
|
failures_remaining: AtomicU32::new(failures),
|
|
success_response: response.into(),
|
|
name: "flakey".to_string(),
|
|
call_count: AtomicU32::new(0),
|
|
}
|
|
}
|
|
|
|
fn with_name(mut self, name: impl Into<String>) -> Self {
|
|
self.name = name.into();
|
|
self
|
|
}
|
|
|
|
fn calls(&self) -> u32 {
|
|
self.call_count.load(Ordering::Relaxed)
|
|
}
|
|
}
|
|
|
|
#[async_trait]
|
|
impl LlmProvider for FlakeyProvider {
|
|
fn model_name(&self) -> &str {
|
|
&self.name
|
|
}
|
|
|
|
fn cost_per_token(&self) -> (Decimal, Decimal) {
|
|
(Decimal::ZERO, Decimal::ZERO)
|
|
}
|
|
|
|
async fn complete(&self, _request: CompletionRequest) -> Result<CompletionResponse, LlmError> {
|
|
self.call_count.fetch_add(1, Ordering::Relaxed);
|
|
let prev = self.failures_remaining.load(Ordering::Relaxed);
|
|
if prev > 0 {
|
|
// Attempt to decrement; if another thread decremented first, that's fine.
|
|
let _ = self.failures_remaining.compare_exchange(
|
|
prev,
|
|
prev - 1,
|
|
Ordering::Relaxed,
|
|
Ordering::Relaxed,
|
|
);
|
|
return Err(LlmError::RequestFailed {
|
|
provider: self.name.clone(),
|
|
reason: format!("transient failure ({} remaining)", prev - 1),
|
|
});
|
|
}
|
|
Ok(CompletionResponse {
|
|
content: self.success_response.clone(),
|
|
input_tokens: 10,
|
|
output_tokens: 5,
|
|
finish_reason: FinishReason::Stop,
|
|
})
|
|
}
|
|
|
|
async fn complete_with_tools(
|
|
&self,
|
|
_request: ToolCompletionRequest,
|
|
) -> Result<ToolCompletionResponse, LlmError> {
|
|
self.call_count.fetch_add(1, Ordering::Relaxed);
|
|
let prev = self.failures_remaining.load(Ordering::Relaxed);
|
|
if prev > 0 {
|
|
let _ = self.failures_remaining.compare_exchange(
|
|
prev,
|
|
prev - 1,
|
|
Ordering::Relaxed,
|
|
Ordering::Relaxed,
|
|
);
|
|
return Err(LlmError::RequestFailed {
|
|
provider: self.name.clone(),
|
|
reason: format!("transient failure ({} remaining)", prev - 1),
|
|
});
|
|
}
|
|
Ok(ToolCompletionResponse {
|
|
content: Some(self.success_response.clone()),
|
|
tool_calls: vec![],
|
|
input_tokens: 10,
|
|
output_tokens: 5,
|
|
finish_reason: FinishReason::Stop,
|
|
})
|
|
}
|
|
}
|
|
|
|
/// Provider that hangs forever (tests timeout handling at the caller).
|
|
struct HangingProvider {
|
|
name: String,
|
|
}
|
|
|
|
impl HangingProvider {
|
|
fn new(name: impl Into<String>) -> Self {
|
|
Self { name: name.into() }
|
|
}
|
|
}
|
|
|
|
#[async_trait]
|
|
impl LlmProvider for HangingProvider {
|
|
fn model_name(&self) -> &str {
|
|
&self.name
|
|
}
|
|
|
|
fn cost_per_token(&self) -> (Decimal, Decimal) {
|
|
(Decimal::ZERO, Decimal::ZERO)
|
|
}
|
|
|
|
async fn complete(&self, _request: CompletionRequest) -> Result<CompletionResponse, LlmError> {
|
|
// Hang forever -- callers must use tokio::time::timeout.
|
|
std::future::pending().await
|
|
}
|
|
|
|
async fn complete_with_tools(
|
|
&self,
|
|
_request: ToolCompletionRequest,
|
|
) -> Result<ToolCompletionResponse, LlmError> {
|
|
std::future::pending().await
|
|
}
|
|
}
|
|
|
|
/// Provider that returns valid response structures but with garbage content.
|
|
///
|
|
/// This tests that the system handles "technically valid but semantically
|
|
/// nonsensical" responses gracefully.
|
|
struct GarbageProvider {
|
|
name: String,
|
|
call_count: AtomicU32,
|
|
}
|
|
|
|
impl GarbageProvider {
|
|
fn new(name: impl Into<String>) -> Self {
|
|
Self {
|
|
name: name.into(),
|
|
call_count: AtomicU32::new(0),
|
|
}
|
|
}
|
|
|
|
fn calls(&self) -> u32 {
|
|
self.call_count.load(Ordering::Relaxed)
|
|
}
|
|
}
|
|
|
|
#[async_trait]
|
|
impl LlmProvider for GarbageProvider {
|
|
fn model_name(&self) -> &str {
|
|
&self.name
|
|
}
|
|
|
|
fn cost_per_token(&self) -> (Decimal, Decimal) {
|
|
(Decimal::ZERO, Decimal::ZERO)
|
|
}
|
|
|
|
async fn complete(&self, _request: CompletionRequest) -> Result<CompletionResponse, LlmError> {
|
|
self.call_count.fetch_add(1, Ordering::Relaxed);
|
|
Ok(CompletionResponse {
|
|
content: "\x00\x01\x02\x7f garbage \u{FFFD} response".to_string(),
|
|
input_tokens: 0,
|
|
output_tokens: 0,
|
|
finish_reason: FinishReason::Unknown,
|
|
})
|
|
}
|
|
|
|
async fn complete_with_tools(
|
|
&self,
|
|
_request: ToolCompletionRequest,
|
|
) -> Result<ToolCompletionResponse, LlmError> {
|
|
self.call_count.fetch_add(1, Ordering::Relaxed);
|
|
Ok(ToolCompletionResponse {
|
|
content: Some(String::new()), // empty content
|
|
tool_calls: vec![],
|
|
input_tokens: 0,
|
|
output_tokens: 0,
|
|
finish_reason: FinishReason::Unknown,
|
|
})
|
|
}
|
|
}
|
|
|
|
/// Simple always-ok provider for use as a reliable fallback in tests.
|
|
struct ReliableProvider {
|
|
name: String,
|
|
response: String,
|
|
call_count: AtomicU32,
|
|
}
|
|
|
|
impl ReliableProvider {
|
|
fn new(name: impl Into<String>, response: impl Into<String>) -> Self {
|
|
Self {
|
|
name: name.into(),
|
|
response: response.into(),
|
|
call_count: AtomicU32::new(0),
|
|
}
|
|
}
|
|
|
|
fn calls(&self) -> u32 {
|
|
self.call_count.load(Ordering::Relaxed)
|
|
}
|
|
}
|
|
|
|
#[async_trait]
|
|
impl LlmProvider for ReliableProvider {
|
|
fn model_name(&self) -> &str {
|
|
&self.name
|
|
}
|
|
|
|
fn cost_per_token(&self) -> (Decimal, Decimal) {
|
|
(Decimal::ZERO, Decimal::ZERO)
|
|
}
|
|
|
|
async fn complete(&self, _request: CompletionRequest) -> Result<CompletionResponse, LlmError> {
|
|
self.call_count.fetch_add(1, Ordering::Relaxed);
|
|
Ok(CompletionResponse {
|
|
content: self.response.clone(),
|
|
input_tokens: 10,
|
|
output_tokens: 5,
|
|
finish_reason: FinishReason::Stop,
|
|
})
|
|
}
|
|
|
|
async fn complete_with_tools(
|
|
&self,
|
|
_request: ToolCompletionRequest,
|
|
) -> Result<ToolCompletionResponse, LlmError> {
|
|
self.call_count.fetch_add(1, Ordering::Relaxed);
|
|
Ok(ToolCompletionResponse {
|
|
content: Some(self.response.clone()),
|
|
tool_calls: vec![],
|
|
input_tokens: 10,
|
|
output_tokens: 5,
|
|
finish_reason: FinishReason::Stop,
|
|
})
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Helpers
|
|
// ---------------------------------------------------------------------------
|
|
|
|
fn make_request() -> CompletionRequest {
|
|
CompletionRequest::new(vec![ChatMessage::user("hello")])
|
|
}
|
|
|
|
fn make_tool_request() -> ToolCompletionRequest {
|
|
ToolCompletionRequest::new(vec![ChatMessage::user("hello")], vec![])
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: FlakeyProvider eventually succeeds through RetryProvider
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[tokio::test]
|
|
async fn test_flakey_provider_eventually_succeeds() {
|
|
// FlakeyProvider fails 3 times then succeeds.
|
|
// RetryProvider with max_retries=5 should be enough to get through.
|
|
let flakey = Arc::new(FlakeyProvider::new(3, "success after retries"));
|
|
let retry = RetryProvider::new(flakey.clone(), RetryConfig { max_retries: 5 });
|
|
|
|
let result = tokio::time::timeout(Duration::from_secs(30), retry.complete(make_request()))
|
|
.await
|
|
.expect("should not timeout with 30s budget");
|
|
|
|
let response = result.expect("should succeed after retries");
|
|
assert_eq!(response.content, "success after retries");
|
|
// Should have been called 4 times: 3 failures + 1 success
|
|
assert_eq!(
|
|
flakey.calls(),
|
|
4,
|
|
"expected 3 failures + 1 success = 4 calls"
|
|
);
|
|
}
|
|
|
|
/// Verify that a FlakeyProvider with more failures than retries exhausts
|
|
/// retries and returns an error.
|
|
#[tokio::test]
|
|
async fn test_flakey_provider_exhausts_retries() {
|
|
// Fails 10 times, but retry allows only 2 retries (3 attempts total).
|
|
let flakey = Arc::new(FlakeyProvider::new(10, "never reached"));
|
|
let retry = RetryProvider::new(flakey.clone(), RetryConfig { max_retries: 2 });
|
|
|
|
let result = retry.complete(make_request()).await;
|
|
assert!(result.is_err(), "should fail when retries are exhausted");
|
|
// 3 total attempts: initial + 2 retries
|
|
assert_eq!(flakey.calls(), 3);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: HangingProvider times out with tokio::time::timeout
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[tokio::test]
|
|
async fn test_hanging_provider_times_out() {
|
|
let hanging: Arc<dyn LlmProvider> = Arc::new(HangingProvider::new("hanging-provider"));
|
|
|
|
let result =
|
|
tokio::time::timeout(Duration::from_millis(200), hanging.complete(make_request())).await;
|
|
|
|
// Should be a timeout error, not hang forever.
|
|
assert!(
|
|
result.is_err(),
|
|
"HangingProvider should timeout, not hang forever"
|
|
);
|
|
}
|
|
|
|
/// HangingProvider behind a CircuitBreakerProvider can still be timed out.
|
|
#[tokio::test]
|
|
async fn test_hanging_provider_behind_circuit_breaker_times_out() {
|
|
let hanging: Arc<dyn LlmProvider> = Arc::new(HangingProvider::new("hanging-behind-cb"));
|
|
let cb = CircuitBreakerProvider::new(
|
|
hanging,
|
|
CircuitBreakerConfig {
|
|
failure_threshold: 3,
|
|
recovery_timeout: Duration::from_secs(30),
|
|
half_open_successes_needed: 1,
|
|
},
|
|
);
|
|
|
|
let result =
|
|
tokio::time::timeout(Duration::from_millis(200), cb.complete(make_request())).await;
|
|
|
|
assert!(
|
|
result.is_err(),
|
|
"should timeout even when wrapped in circuit breaker"
|
|
);
|
|
}
|
|
|
|
/// complete_with_tools also hangs and can be timed out.
|
|
#[tokio::test]
|
|
async fn test_hanging_provider_complete_with_tools_times_out() {
|
|
let hanging: Arc<dyn LlmProvider> = Arc::new(HangingProvider::new("hanging-tools"));
|
|
|
|
let result = tokio::time::timeout(
|
|
Duration::from_millis(200),
|
|
hanging.complete_with_tools(make_tool_request()),
|
|
)
|
|
.await;
|
|
|
|
assert!(result.is_err(), "complete_with_tools should also timeout");
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: GarbageProvider returns valid response with garbage content
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[tokio::test]
|
|
async fn test_garbage_provider_returns_error_or_empty() {
|
|
let garbage = Arc::new(GarbageProvider::new("garbage-provider"));
|
|
|
|
// complete() returns a valid CompletionResponse with garbage content.
|
|
let response = garbage
|
|
.complete(make_request())
|
|
.await
|
|
.expect("garbage provider should not return an error");
|
|
|
|
// The response is structurally valid but the content is nonsensical.
|
|
assert!(
|
|
!response.content.is_empty(),
|
|
"garbage content should be non-empty"
|
|
);
|
|
assert_eq!(
|
|
response.finish_reason,
|
|
FinishReason::Unknown,
|
|
"garbage response has Unknown finish reason"
|
|
);
|
|
assert_eq!(response.input_tokens, 0);
|
|
assert_eq!(response.output_tokens, 0);
|
|
|
|
// complete_with_tools() returns empty content.
|
|
let tool_response = garbage
|
|
.complete_with_tools(make_tool_request())
|
|
.await
|
|
.expect("garbage provider tool completion should not error");
|
|
|
|
assert_eq!(
|
|
tool_response.content,
|
|
Some(String::new()),
|
|
"tool response should have empty content"
|
|
);
|
|
assert!(tool_response.tool_calls.is_empty());
|
|
assert_eq!(garbage.calls(), 2, "should have recorded 2 calls total");
|
|
}
|
|
|
|
/// GarbageProvider is not retried by RetryProvider since it returns Ok.
|
|
#[tokio::test]
|
|
async fn test_garbage_provider_not_retried() {
|
|
let garbage = Arc::new(GarbageProvider::new("garbage-no-retry"));
|
|
let retry = RetryProvider::new(garbage.clone(), RetryConfig { max_retries: 3 });
|
|
|
|
let response = retry.complete(make_request()).await;
|
|
assert!(response.is_ok(), "garbage Ok response should pass through");
|
|
assert_eq!(
|
|
garbage.calls(),
|
|
1,
|
|
"should only call once -- no retry on Ok"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: Circuit breaker trips and recovers
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[tokio::test]
|
|
async fn test_circuit_breaker_trips_and_recovers() {
|
|
// Use a FlakeyProvider that fails 5 times then succeeds.
|
|
let flakey = Arc::new(FlakeyProvider::new(5, "recovered"));
|
|
let cb = CircuitBreakerProvider::new(
|
|
flakey.clone(),
|
|
CircuitBreakerConfig {
|
|
failure_threshold: 3,
|
|
recovery_timeout: Duration::from_millis(50),
|
|
half_open_successes_needed: 1,
|
|
},
|
|
);
|
|
|
|
// Send 3 failures to trip the breaker.
|
|
for _ in 0..3 {
|
|
let _ = cb.complete(make_request()).await;
|
|
}
|
|
|
|
// Circuit should now be open.
|
|
let state = cb.circuit_state().await;
|
|
assert_eq!(
|
|
state,
|
|
ironclaw::llm::circuit_breaker::CircuitState::Open,
|
|
"circuit should be open after 3 failures"
|
|
);
|
|
|
|
// Requests while open should be rejected immediately with a circuit breaker message.
|
|
let err = cb.complete(make_request()).await.unwrap_err();
|
|
match &err {
|
|
LlmError::RequestFailed { reason, .. } => {
|
|
assert!(
|
|
reason.contains("Circuit breaker open"),
|
|
"expected circuit breaker message, got: {}",
|
|
reason
|
|
);
|
|
}
|
|
other => panic!("expected RequestFailed, got: {:?}", other),
|
|
}
|
|
|
|
// Wait for recovery timeout.
|
|
tokio::time::sleep(Duration::from_millis(60)).await;
|
|
|
|
// The FlakeyProvider still has 2 failures remaining (5 - 3 = 2).
|
|
// The first probe (half-open) will fail, sending it back to open.
|
|
let _ = cb.complete(make_request()).await;
|
|
assert_eq!(
|
|
cb.circuit_state().await,
|
|
ironclaw::llm::circuit_breaker::CircuitState::Open,
|
|
"probe failed, should reopen"
|
|
);
|
|
|
|
// Wait again for recovery.
|
|
tokio::time::sleep(Duration::from_millis(60)).await;
|
|
|
|
// Second probe: FlakeyProvider has 1 failure remaining.
|
|
let _ = cb.complete(make_request()).await;
|
|
assert_eq!(
|
|
cb.circuit_state().await,
|
|
ironclaw::llm::circuit_breaker::CircuitState::Open,
|
|
"still one failure left, should reopen again"
|
|
);
|
|
|
|
// Wait once more.
|
|
tokio::time::sleep(Duration::from_millis(60)).await;
|
|
|
|
// Third probe: FlakeyProvider should now succeed (all 5 failures consumed).
|
|
let result = cb.complete(make_request()).await;
|
|
assert!(result.is_ok(), "should succeed after all failures consumed");
|
|
assert_eq!(result.unwrap().content, "recovered");
|
|
assert_eq!(
|
|
cb.circuit_state().await,
|
|
ironclaw::llm::circuit_breaker::CircuitState::Closed,
|
|
"circuit should close after successful probe"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: Failover chain under chaos
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[tokio::test]
|
|
async fn test_failover_chain_under_chaos() {
|
|
// First provider is flakey (fails 3 times), second is reliable.
|
|
// FailoverProvider should fall back to the reliable one on failures
|
|
// from the flakey provider, then route back to flakey once it recovers.
|
|
//
|
|
// Use a high cooldown threshold (100) so the flakey provider doesn't
|
|
// enter cooldown during this test -- we want to test pure failover
|
|
// behavior, not cooldown.
|
|
let flakey: Arc<dyn LlmProvider> =
|
|
Arc::new(FlakeyProvider::new(3, "flakey recovered").with_name("flakey-primary"));
|
|
let reliable: Arc<dyn LlmProvider> =
|
|
Arc::new(ReliableProvider::new("reliable-backup", "backup response"));
|
|
|
|
let config = CooldownConfig {
|
|
cooldown_duration: Duration::from_secs(300),
|
|
failure_threshold: 100, // high threshold: no cooldown during this test
|
|
};
|
|
let failover = FailoverProvider::with_cooldown(vec![flakey.clone(), reliable.clone()], config)
|
|
.expect("should create failover with 2 providers");
|
|
|
|
// Request 1: flakey fails, reliable succeeds.
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "backup response");
|
|
|
|
// Request 2: flakey fails again, reliable succeeds.
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "backup response");
|
|
|
|
// Request 3: flakey fails (third failure), reliable succeeds.
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "backup response");
|
|
|
|
// Request 4: flakey should now succeed (all 3 failures consumed).
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "flakey recovered");
|
|
}
|
|
|
|
/// Failover with cooldown: flakey provider enters cooldown, backup serves,
|
|
/// then flakey recovers after cooldown expires.
|
|
#[tokio::test]
|
|
async fn test_failover_cooldown_with_flakey_provider() {
|
|
let flakey: Arc<dyn LlmProvider> =
|
|
Arc::new(FlakeyProvider::new(3, "flakey back").with_name("flakey-cd"));
|
|
let reliable: Arc<dyn LlmProvider> = Arc::new(ReliableProvider::new("reliable-cd", "reliable"));
|
|
|
|
let config = CooldownConfig {
|
|
cooldown_duration: Duration::from_millis(50),
|
|
failure_threshold: 2,
|
|
};
|
|
let failover = FailoverProvider::with_cooldown(vec![flakey.clone(), reliable.clone()], config)
|
|
.expect("should create failover with cooldown");
|
|
|
|
// Requests 1-2: flakey fails twice, reaching cooldown threshold.
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "reliable");
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "reliable");
|
|
|
|
// Request 3: flakey should be in cooldown, only reliable called.
|
|
// (flakey's 3rd failure would be consumed if called, but it's skipped.)
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "reliable");
|
|
|
|
// Wait for cooldown to expire, then flakey gets retried.
|
|
tokio::time::sleep(Duration::from_millis(60)).await;
|
|
|
|
// After cooldown: flakey is tried again. It still has 1 failure remaining.
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
// Flakey fails again (3rd failure consumed), reliable serves.
|
|
assert_eq!(r.content, "reliable");
|
|
|
|
// Wait again for cooldown.
|
|
tokio::time::sleep(Duration::from_millis(60)).await;
|
|
|
|
// Now flakey should succeed (all 3 failures consumed).
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "flakey back");
|
|
}
|
|
|
|
/// Three providers: first always fails, second is flakey, third is reliable.
|
|
/// Tests cascading failover through multiple providers.
|
|
#[tokio::test]
|
|
async fn test_failover_three_provider_cascade() {
|
|
let always_fail: Arc<dyn LlmProvider> =
|
|
Arc::new(FlakeyProvider::new(u32::MAX, "unreachable").with_name("always-fail"));
|
|
let flakey: Arc<dyn LlmProvider> =
|
|
Arc::new(FlakeyProvider::new(2, "flakey ok").with_name("flakey-middle"));
|
|
let reliable: Arc<dyn LlmProvider> =
|
|
Arc::new(ReliableProvider::new("reliable-last", "last resort"));
|
|
|
|
let failover = FailoverProvider::new(vec![always_fail, flakey.clone(), reliable.clone()])
|
|
.expect("three providers");
|
|
|
|
// Request 1: always-fail fails, flakey fails (1st), reliable serves.
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "last resort");
|
|
|
|
// Request 2: always-fail fails, flakey fails (2nd), reliable serves.
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "last resort");
|
|
|
|
// Request 3: always-fail fails, flakey now succeeds.
|
|
let r = failover.complete(make_request()).await.unwrap();
|
|
assert_eq!(r.content, "flakey ok");
|
|
}
|
|
|
|
/// Failover with a mix of transient and non-transient errors.
|
|
/// Non-transient error from primary should propagate immediately.
|
|
#[tokio::test]
|
|
async fn test_failover_non_transient_stops_chain() {
|
|
// Provider that returns a non-transient error.
|
|
struct NonTransientProvider;
|
|
|
|
#[async_trait]
|
|
impl LlmProvider for NonTransientProvider {
|
|
fn model_name(&self) -> &str {
|
|
"non-transient"
|
|
}
|
|
fn cost_per_token(&self) -> (Decimal, Decimal) {
|
|
(Decimal::ZERO, Decimal::ZERO)
|
|
}
|
|
async fn complete(
|
|
&self,
|
|
_request: CompletionRequest,
|
|
) -> Result<CompletionResponse, LlmError> {
|
|
Err(LlmError::ContextLengthExceeded {
|
|
used: 200_000,
|
|
limit: 100_000,
|
|
})
|
|
}
|
|
async fn complete_with_tools(
|
|
&self,
|
|
_request: ToolCompletionRequest,
|
|
) -> Result<ToolCompletionResponse, LlmError> {
|
|
Err(LlmError::ContextLengthExceeded {
|
|
used: 200_000,
|
|
limit: 100_000,
|
|
})
|
|
}
|
|
}
|
|
|
|
let primary: Arc<dyn LlmProvider> = Arc::new(NonTransientProvider);
|
|
let backup = Arc::new(ReliableProvider::new("backup", "should not reach"));
|
|
|
|
let failover = FailoverProvider::new(vec![primary, backup.clone() as Arc<dyn LlmProvider>])
|
|
.expect("failover");
|
|
|
|
let err = failover.complete(make_request()).await.unwrap_err();
|
|
assert!(
|
|
matches!(err, LlmError::ContextLengthExceeded { .. }),
|
|
"non-transient error should propagate: {:?}",
|
|
err
|
|
);
|
|
// Backup should never have been called.
|
|
assert_eq!(
|
|
backup.calls(),
|
|
0,
|
|
"backup should not be called for non-transient errors"
|
|
);
|
|
}
|
|
|
|
/// Full stack: RetryProvider wrapping FlakeyProvider, behind a
|
|
/// CircuitBreakerProvider. Verifies the full chain works together.
|
|
#[tokio::test]
|
|
async fn test_retry_plus_circuit_breaker_integration() {
|
|
// Flakey provider that fails 2 times then succeeds.
|
|
let flakey = Arc::new(FlakeyProvider::new(2, "stack success"));
|
|
let retry: Arc<dyn LlmProvider> = Arc::new(RetryProvider::new(
|
|
flakey.clone(),
|
|
RetryConfig { max_retries: 3 },
|
|
));
|
|
let cb = CircuitBreakerProvider::new(
|
|
retry,
|
|
CircuitBreakerConfig {
|
|
failure_threshold: 10, // high threshold so we don't trip
|
|
recovery_timeout: Duration::from_secs(30),
|
|
half_open_successes_needed: 1,
|
|
},
|
|
);
|
|
|
|
let result = tokio::time::timeout(Duration::from_secs(30), cb.complete(make_request()))
|
|
.await
|
|
.expect("should not timeout");
|
|
|
|
let response = result.expect("retry+CB stack should succeed");
|
|
assert_eq!(response.content, "stack success");
|
|
assert_eq!(
|
|
cb.circuit_state().await,
|
|
ironclaw::llm::circuit_breaker::CircuitState::Closed,
|
|
"circuit should remain closed"
|
|
);
|
|
}
|
|
|
|
/// Full chain: RetryProvider -> FailoverProvider -> CircuitBreakerProvider.
|
|
/// Primary is flakey with insufficient retries to recover; failover catches it.
|
|
#[tokio::test]
|
|
async fn test_full_chain_retry_failover_circuit_breaker() {
|
|
// Primary: flakey, fails 5 times. Retry allows 2 retries (3 attempts).
|
|
// After retry exhaustion, failover should kick in to the reliable backup.
|
|
let flakey = Arc::new(FlakeyProvider::new(5, "not reachable").with_name("flakey-full"));
|
|
let retry_primary: Arc<dyn LlmProvider> = Arc::new(RetryProvider::new(
|
|
flakey.clone(),
|
|
RetryConfig { max_retries: 2 },
|
|
));
|
|
|
|
// Backup: always reliable.
|
|
let reliable: Arc<dyn LlmProvider> =
|
|
Arc::new(ReliableProvider::new("reliable-full", "backup ok"));
|
|
|
|
// Failover wraps both.
|
|
let failover: Arc<dyn LlmProvider> =
|
|
Arc::new(FailoverProvider::new(vec![retry_primary, reliable.clone()]).expect("failover"));
|
|
|
|
// Circuit breaker on top.
|
|
let cb = CircuitBreakerProvider::new(
|
|
failover,
|
|
CircuitBreakerConfig {
|
|
failure_threshold: 10,
|
|
recovery_timeout: Duration::from_secs(30),
|
|
half_open_successes_needed: 1,
|
|
},
|
|
);
|
|
|
|
let result = tokio::time::timeout(Duration::from_secs(30), cb.complete(make_request()))
|
|
.await
|
|
.expect("should not timeout");
|
|
|
|
let response = result.expect("full chain should succeed via failover");
|
|
assert_eq!(response.content, "backup ok");
|
|
}
|
|
|
|
/// Verify that GarbageProvider content flows through the full decorator chain
|
|
/// without causing panics or unexpected errors.
|
|
#[tokio::test]
|
|
async fn test_garbage_through_full_chain() {
|
|
let garbage: Arc<dyn LlmProvider> = Arc::new(GarbageProvider::new("garbage-chain"));
|
|
let retry: Arc<dyn LlmProvider> = Arc::new(RetryProvider::new(
|
|
garbage.clone(),
|
|
RetryConfig { max_retries: 1 },
|
|
));
|
|
let cb = CircuitBreakerProvider::new(
|
|
retry,
|
|
CircuitBreakerConfig {
|
|
failure_threshold: 5,
|
|
recovery_timeout: Duration::from_secs(30),
|
|
half_open_successes_needed: 1,
|
|
},
|
|
);
|
|
|
|
let result = cb.complete(make_request()).await;
|
|
assert!(result.is_ok(), "garbage should flow through without error");
|
|
|
|
let response = result.unwrap();
|
|
assert!(
|
|
response.content.contains("garbage"),
|
|
"garbage content should be preserved"
|
|
);
|
|
assert_eq!(
|
|
cb.circuit_state().await,
|
|
ironclaw::llm::circuit_breaker::CircuitState::Closed,
|
|
"Ok responses should not trip the breaker"
|
|
);
|
|
}
|