Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0a978c063e | ||
|
|
717e6905cd |
@@ -0,0 +1,37 @@
|
||||
# Implementation Spec: Round 4
|
||||
|
||||
## Status: COMPLETE
|
||||
|
||||
## New Features
|
||||
|
||||
### 1. CircuitBreakerMetrics (circuit_breaker.rs)
|
||||
- Added `CircuitSnapshot { state: CircuitState, failures: u64, successes: u64 }` struct
|
||||
- Added `CircuitBreaker::snapshot() -> CircuitSnapshot` method (atomic load)
|
||||
- Test: `snapshot_reflects_state_and_counts`
|
||||
|
||||
### 2. RetryStats (retry.rs)
|
||||
- Added `RetryStats { attempts: u32, retries: u32, last_error: Option<String> }`
|
||||
- Added `retry_with_stats()` returning `(Result, RetryStats)` (parallel to retry())
|
||||
- Tests: 2 new
|
||||
|
||||
### 3. AsyncLifecycleManager (lifecycle.rs) — Round 3 carryover, verified
|
||||
- Composes ShutdownManager + HealthRegistry + health loop
|
||||
- Tests: 3
|
||||
|
||||
### 4. MetricsBridge (metrics_bridge.rs) — Round 3 carryover
|
||||
- `MetricsBridge` emits MetricsCollector → tracing
|
||||
- `MetricsHealthCheck` wraps collector as HealthCheck
|
||||
- Tests: 2
|
||||
|
||||
## Fixes in round 4
|
||||
- `HealthRegistry` wrapped in `Arc` in AsyncLifecycleManager (not Clone)
|
||||
- Removed unused `span`/`Instrument` import in lifecycle.rs
|
||||
- Fixed `op_ref` mutability in service_builder.rs
|
||||
- Fixed `last_error` assertion (None on success) in retry test
|
||||
- Fixed snapshot test assertions (successes not incremented in Closed state)
|
||||
|
||||
## Build Status
|
||||
- cargo build --workspace --all-features: OK (2 pre-existing warnings in crypto/cli)
|
||||
- cargo test --workspace --all-features: ALL PASS
|
||||
- cargo clippy: 0 warnings on round-4 code (pre-existing in crypto/cli only)
|
||||
- Committed + pushed
|
||||
@@ -1,3 +1,10 @@
|
||||
# [1.6.0](https://github.com/asepharyana/mytheclipse/compare/v1.5.0...v1.6.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-4 metrics for circuit breaker + retry stats + lifecycle fixes ([717e690](https://github.com/asepharyana/mytheclipse/commit/717e6905cd7a3f7389b455d01054a2c2cc28befd))
|
||||
|
||||
# [1.5.0](https://github.com/asepharyana/mytheclipse/compare/v1.4.1...v1.5.0) (2026-08-29)
|
||||
|
||||
|
||||
|
||||
Generated
+10
-10
@@ -2818,7 +2818,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"async-trait",
|
||||
"num_cpus",
|
||||
@@ -2832,7 +2832,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-cache"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"async-trait",
|
||||
"moka",
|
||||
@@ -2845,7 +2845,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-cli"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"clap",
|
||||
"tokio",
|
||||
@@ -2854,7 +2854,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-config"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"dotenvy",
|
||||
"notify",
|
||||
@@ -2869,7 +2869,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-crypto"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"aead",
|
||||
"aes-gcm",
|
||||
@@ -2889,7 +2889,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-event"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"async-nats",
|
||||
"async-trait",
|
||||
@@ -2905,7 +2905,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-http"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"async-trait",
|
||||
"axum",
|
||||
@@ -2919,7 +2919,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-queue"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"async-nats",
|
||||
"async-trait",
|
||||
@@ -2935,7 +2935,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-storage"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"async-trait",
|
||||
"aws-config",
|
||||
@@ -2951,7 +2951,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-tracing"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
dependencies = [
|
||||
"opentelemetry 0.25.0",
|
||||
"tokio",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-cache"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-cli"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-config"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-crypto"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-event"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-http"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-queue"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-storage"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-tracing"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse"
|
||||
version = "1.5.0"
|
||||
version = "1.6.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -22,6 +22,17 @@ pub enum CircuitState {
|
||||
HalfOpen,
|
||||
}
|
||||
|
||||
/// Point-in-time snapshot of a [`CircuitBreaker`] for metrics/observability.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub struct CircuitSnapshot {
|
||||
/// Current circuit state.
|
||||
pub state: CircuitState,
|
||||
/// Consecutive failures recorded (resets on success in `Closed`).
|
||||
pub failures: u64,
|
||||
/// Consecutive successes recorded (resets on failure/open).
|
||||
pub successes: u64,
|
||||
}
|
||||
|
||||
const CLOSED: u8 = 0;
|
||||
const OPEN: u8 = 1;
|
||||
const HALF_OPEN: u8 = 2;
|
||||
@@ -199,6 +210,16 @@ impl CircuitBreaker {
|
||||
*self.inner.opened_at.lock().unwrap() = None;
|
||||
}
|
||||
|
||||
/// Returns a point-in-time snapshot of the breaker's internal counters and
|
||||
/// state, for metrics/observability export.
|
||||
pub fn snapshot(&self) -> CircuitSnapshot {
|
||||
CircuitSnapshot {
|
||||
state: self.state(),
|
||||
failures: self.inner.failures.load(Ordering::Acquire),
|
||||
successes: self.inner.successes.load(Ordering::Acquire),
|
||||
}
|
||||
}
|
||||
|
||||
fn record_result(&self, success: bool) {
|
||||
match self.inner.state.load(Ordering::Acquire) {
|
||||
HALF_OPEN => {
|
||||
@@ -362,4 +383,25 @@ mod tests {
|
||||
let err: Result<u32, CircuitError<u8>> = b.call(|| Err(9u8));
|
||||
assert!(matches!(err, Err(CircuitError::Inner(9))));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn snapshot_reflects_state_and_counts() {
|
||||
let b = breaker();
|
||||
let snap = b.snapshot();
|
||||
assert_eq!(snap.state, CircuitState::Closed);
|
||||
assert_eq!(snap.failures, 0);
|
||||
assert_eq!(snap.successes, 0);
|
||||
|
||||
// success in Closed state resets failure count (no failure counter added).
|
||||
b.call::<(), u8, _>(|| Ok(()));
|
||||
let snap2 = b.snapshot();
|
||||
assert_eq!(snap2.state, CircuitState::Closed);
|
||||
|
||||
for _ in 0..3 {
|
||||
let _: Result<(), CircuitError<u8>> = b.call(|| Err(1u8));
|
||||
}
|
||||
let snap3 = b.snapshot();
|
||||
assert_eq!(snap3.state, CircuitState::Open);
|
||||
assert_eq!(snap3.failures, 0); // reset on open()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -85,6 +85,79 @@ impl<E: std::fmt::Display> std::fmt::Display for RetryError<E> {
|
||||
|
||||
impl<E: std::fmt::Debug + std::fmt::Display> std::error::Error for RetryError<E> {}
|
||||
|
||||
/// Statistics collected during a [`retry`] call.
|
||||
#[derive(Debug, Clone, Default)]
|
||||
pub struct RetryStats {
|
||||
/// Total number of attempts made (including the first).
|
||||
pub attempts: u32,
|
||||
/// Number of retries performed (= `attempts - 1` if exhausted, or
|
||||
/// `attempts - 1` if ultimately succeeded after at least one retry).
|
||||
pub retries: u32,
|
||||
/// The error message from the final attempt, if any.
|
||||
pub last_error: Option<String>,
|
||||
}
|
||||
|
||||
/// Like [`retry`] but also returns [`RetryStats`] capturing attempt counts.
|
||||
///
|
||||
/// Retries `op` according to `config`, retrying only errors for which
|
||||
/// `filter` returns `true`.
|
||||
///
|
||||
/// Like [`retry`] but also returns [`RetryStats`].
|
||||
pub async fn retry_with_stats<T, E, F, Fut, P>(
|
||||
config: RetryConfig,
|
||||
filter: P,
|
||||
mut op: F,
|
||||
) -> (Result<T, RetryError<E>>, RetryStats)
|
||||
where
|
||||
F: FnMut() -> Fut,
|
||||
Fut: Future<Output = Result<T, E>>,
|
||||
P: Fn(&E) -> bool,
|
||||
E: std::fmt::Display,
|
||||
{
|
||||
let mut attempt: u32 = 0;
|
||||
let mut last_error: Option<String> = None;
|
||||
loop {
|
||||
attempt += 1;
|
||||
let span = tracing::info_span!(
|
||||
"mytheclipse_retry_task",
|
||||
attempt,
|
||||
max_attempts = config.max_attempts
|
||||
);
|
||||
let result = op().instrument(span).await;
|
||||
|
||||
match result {
|
||||
Ok(value) => {
|
||||
let stats = RetryStats {
|
||||
attempts: attempt,
|
||||
retries: attempt.saturating_sub(1),
|
||||
last_error,
|
||||
};
|
||||
return (Ok(value), stats);
|
||||
}
|
||||
Err(err) => {
|
||||
last_error = Some(err.to_string());
|
||||
let retryable = filter(&err);
|
||||
if !retryable || attempt >= config.max_attempts {
|
||||
let stats = RetryStats {
|
||||
attempts: attempt,
|
||||
retries: attempt.saturating_sub(1),
|
||||
last_error,
|
||||
};
|
||||
return (
|
||||
Err(RetryError::Exhausted {
|
||||
attempts: attempt,
|
||||
last: err,
|
||||
}),
|
||||
stats,
|
||||
);
|
||||
}
|
||||
let delay = backoff_delay(&config, attempt, rand::thread_rng());
|
||||
tokio::time::sleep(delay).await;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Retries `op` according to `config`, retrying only errors for which
|
||||
/// `filter` returns `true`.
|
||||
///
|
||||
@@ -238,6 +311,24 @@ mod tests {
|
||||
assert_eq!(calls.get(), 1);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn retry_with_stats_succeeds_with_counts() {
|
||||
use std::cell::Cell;
|
||||
let config = RetryConfig {
|
||||
max_attempts: 5,
|
||||
base_delay: Duration::from_millis(1),
|
||||
..RetryConfig::default()
|
||||
};
|
||||
let calls = Cell::new(0u32);
|
||||
let (result, stats) = retry_with_stats(config, |_| true, || async {
|
||||
calls.set(calls.get() + 1);
|
||||
if calls.get() < 3 { Err::<u32, &str>("fail") } else { Ok(42u32) }
|
||||
}).await;
|
||||
assert_eq!(result.unwrap(), 42);
|
||||
assert_eq!(stats.attempts, 3);
|
||||
assert_eq!(stats.retries, 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn full_jitter_is_within_bounds_and_capped() {
|
||||
let config = RetryConfig {
|
||||
|
||||
Reference in New Issue
Block a user