Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f86abc4ce1 | ||
|
|
d00881c2b9 | ||
|
|
829c5714d2 | ||
|
|
5df04d7512 | ||
|
|
a6cf58ea7f | ||
|
|
de54e801fb | ||
|
|
d03d32a923 | ||
|
|
c87ae760bf | ||
|
|
e69f72296c | ||
|
|
730245e9c0 | ||
|
|
3376bee1d3 | ||
|
|
bb4998d8fa | ||
|
|
125bc57290 | ||
|
|
ff5fbe49dc | ||
|
|
8d4d8aa52c | ||
|
|
ddb2c2fd2d | ||
|
|
77b0dd9f12 | ||
|
|
74abe7172f | ||
|
|
3c64563a44 | ||
|
|
2f445d3b85 | ||
|
|
2985fa0a0e | ||
|
|
7a063fa75c | ||
|
|
ebb3c8ad6b | ||
|
|
076b0bb757 | ||
|
|
8e66c7d887 | ||
|
|
851c8c4ebb |
@@ -0,0 +1,29 @@
|
||||
# Implementation Spec: Round 10 — COMPLETE
|
||||
|
||||
## Goal
|
||||
Auto-integration + ergonomics: rate-limit workers, auto-metrics on service calls —
|
||||
reduce manual wiring/boilerplate.
|
||||
|
||||
## New Features
|
||||
|
||||
### 1. AutoMetricsServiceBuilder (mytheclipse-core, observability)
|
||||
File: `crates/mytheclipse/src/auto_metrics_service.rs`
|
||||
- Composes ServiceBuilder + MetricsCollector (+ MetricsBridge when resiliency)
|
||||
- `.run()` auto-records: calls_total counter (labelled by outcome ok/err/timeout/
|
||||
circuit_open/rate_limited) + duration histogram; emits bridge when attached
|
||||
- Chainable .with_collector/.with_bridge/.with_builders
|
||||
- 1 test
|
||||
|
||||
### 2. RateLimitedWorkerPool (mytheclipse-queue, in-memory)
|
||||
File: `crates/mytheclipse-queue/src/worker_rate_limited.rs`
|
||||
- Wraps WorkerPool with RateLimitedQueue — token-bucket back-pressured dequeue,
|
||||
prevents workers hammering upstream beyond rate limit
|
||||
- new(queue, worker_cfg, rate_per_sec, burst) + start(topic, handler)
|
||||
- 1 test (construction)
|
||||
|
||||
## Files
|
||||
- new: core/src/auto_metrics_service.rs, queue/src/worker_rate_limited.rs
|
||||
- core/lib.rs: +module+export AutoMetricsServiceBuilder
|
||||
- queue/lib.rs: +module+export RateLimitedWorkerPool (rewrote export block)
|
||||
|
||||
Build: exit 0. Tests: 0 FAILED (86 core pass). Clippy: 0 new warnings.
|
||||
@@ -0,0 +1,28 @@
|
||||
# Implementation Spec: Round 11 — COMPLETE
|
||||
|
||||
## Goal
|
||||
Auto thread/core allocation + race hardening (RAII shutdown).
|
||||
|
||||
## New Features
|
||||
|
||||
### 1. RuntimeConfig (mytheclipse-core, lifecycle)
|
||||
File: `crates/mytheclipse/src/runtime_auto.rs`
|
||||
- `RuntimeConfig::auto()` / `from_cores(n)` / `compact()` infer worker_threads,
|
||||
max_blocking_threads, compute_threads, io_threads from host CPU topology
|
||||
(std::thread::available_parallelism)
|
||||
- `available_parallelism()` helper
|
||||
- `build_rayon_pool(cfg)` gated on `compute` feature
|
||||
- 3 tests
|
||||
|
||||
### 2. ShutdownGuard (mytheclipse-core, lifecycle)
|
||||
File: `crates/mytheclipse/src/shutdown_guard.rs`
|
||||
- RAII guard — runs completion callback exactly once on drop (panic-safe via
|
||||
Mutex<Option<Box<FnOnce>>>), prevents double-shutdown race
|
||||
- `new(cb)` + `finish()` (fire now + disarm)
|
||||
- 3 tests (fires on drop, finish once, panic path)
|
||||
|
||||
## Files
|
||||
- new: core/src/runtime_auto.rs, core/src/shutdown_guard.rs
|
||||
- core/lib.rs: +module+export for both
|
||||
|
||||
Build: exit 0. Tests: 0 FAILED. Clippy: 0 new warnings.
|
||||
@@ -0,0 +1,22 @@
|
||||
# Implementation Spec: Round 12 — COMPLETE
|
||||
|
||||
## Goal
|
||||
Self-healing resource pool (auto-reconnect) — remove per-call "is connection
|
||||
dead? rebuild" boilerplate.
|
||||
|
||||
## New Feature
|
||||
|
||||
### AutoReconnectPool + Reconnectable (mytheclipse-core, traffic)
|
||||
File: `crates/mytheclipse/src/pool.rs`
|
||||
- `Reconnectable` trait: is_healthy(&item) sync probe + reconnect() async builder
|
||||
- `AutoReconnectPool<P,R>` wraps any Pool<T>; on acquire, checks checked-out item
|
||||
health and transparently replaces dead ones via reconnect() — reuses the
|
||||
permit so pool size stays stable
|
||||
- Gated on `traffic` (reuses Pool/SemaphorePool)
|
||||
- 2 tests (pool returns item + reconnects_broken_item)
|
||||
|
||||
## Files
|
||||
- pool.rs: +Reconnectable +AutoReconnectPool +test
|
||||
- lib.rs: export AutoReconnectPool, Reconnectable
|
||||
|
||||
Build: exit 0. Tests: 0 FAILED. Clippy: 0 new warnings.
|
||||
@@ -0,0 +1,19 @@
|
||||
# Implementation Spec: Round 13 — COMPLETE
|
||||
|
||||
## New Feature
|
||||
|
||||
### AggregateError (mytheclipse-core, resiliency)
|
||||
File: `crates/mytheclipse/src/aggregate_error.rs`
|
||||
- Collects multiple `E: std::error::Error` from parallel/fan-out tasks into one
|
||||
error — natural failure type for `join_all` + batch/fan-out resilience
|
||||
- `empty()` / `with_context(..)` / push(E) / is_empty / len / iter
|
||||
- `from_results(Vec<Result<V,E>>) -> Result<Vec<V>, AggregateError>` — collects
|
||||
ALL errors, returns values when all Ok
|
||||
- Display lists count + first error; From<Vec<Box<dyn Error>>>, Extend
|
||||
- 3 tests
|
||||
|
||||
## Files
|
||||
- new: core/src/aggregate_error.rs
|
||||
- core/lib.rs: +module+export AggregateError (resiliency)
|
||||
|
||||
Build: exit 0. Tests: 0 FAILED (97 core pass). Clippy: 0 new warnings.
|
||||
@@ -0,0 +1,21 @@
|
||||
# Implementation Spec: Round 14 — COMPLETE
|
||||
|
||||
## New Feature
|
||||
|
||||
### parallel_map / parallel_map_unordered (mytheclipse-core, resiliency)
|
||||
File: `crates/mytheclipse/src/parallel_map.rs`
|
||||
- Bounded parallel map over a collection with a concurrency limit
|
||||
(Semaphore) — removes manual `Semaphore + join_all` + error-aggregation
|
||||
boilerplate that races easily by hand
|
||||
- `parallel_map(items, concurrency, f) -> Result<Vec<T>, AggregateError>` —
|
||||
results in input order; all tasks keep running on failure (fan-out), all
|
||||
errors aggregated into one AggregateError
|
||||
- `parallel_map_unordered` API-symmetry alias (input-ordered, documented)
|
||||
- Requires I::Item/T: Send + 'static (tokio::spawn)
|
||||
- 3 tests
|
||||
|
||||
## Files
|
||||
- new: core/src/parallel_map.rs
|
||||
- core/lib.rs: +module+export parallel_map, parallel_map_unordered
|
||||
|
||||
Build: 0 errors. Tests: 0 FAILED (100 core pass). Clippy: 0 new warnings.
|
||||
@@ -0,0 +1,24 @@
|
||||
# Implementation Spec: Round 15 — COMPLETE
|
||||
|
||||
## New Feature
|
||||
|
||||
### parallel_for_each (mytheclipse-core, resiliency)
|
||||
File: `crates/mytheclipse/src/parallel_map.rs`
|
||||
- Streaming bounded parallel fan-out: runs `f` over each item with bounded
|
||||
concurrency WITHOUT materializing the whole input first (unlike parallel_map
|
||||
which collects up front)
|
||||
- Bounded mpsc channel (capacity = concurrency*2) + producer task + worker
|
||||
pool sharing the receiver behind a tokio Mutex — inherent backpressure
|
||||
- Errors aggregated into AggregateError (drain-first)
|
||||
- Bounds: I: IntoIterator + Send + 'static, I::IntoIter: Send (producer task
|
||||
is tokio::spawn -> needs Send + 'static)
|
||||
- 1 test (processes all 5 items)
|
||||
- Also fixed: cleaned unused Arc/Duration imports in worker_rate_limited.rs
|
||||
(round-10 leftover)
|
||||
|
||||
## Files
|
||||
- modified: core/src/parallel_map.rs (+parallel_for_each)
|
||||
- core/lib.rs: export parallel_for_each
|
||||
- queue/src/worker_rate_limited.rs: remove unused imports
|
||||
|
||||
Build: 0 errors. Tests: 0 FAILED (101 core pass). Clippy: 0 new warnings.
|
||||
@@ -0,0 +1,33 @@
|
||||
# Implementation Spec: Round 16 — COMPLETE
|
||||
|
||||
## Goal
|
||||
Make the round-7-15 abstractions actually usable — a single, runnable, wired
|
||||
example showing high-level primitives composing together.
|
||||
|
||||
## New File
|
||||
|
||||
### examples/high_level.rs (mytheclipse-core)
|
||||
`crates/mytheclipse/examples/high_level.rs`
|
||||
- One realistic flow demoing, wired together:
|
||||
1. RuntimeConfig::auto() — auto thread/core sizing from host CPU
|
||||
2. parallel_map — bounded fan-out + AggregateError
|
||||
3. RetryExt — ergonomic .retry() on a Future
|
||||
4. ShutdownGuard — RAII exactly-once cleanup
|
||||
5. AutoReconnectPool — self-healing resource pool (dead value replaced)
|
||||
6. AutoMetricsServiceBuilder — auto latency/outcome metrics
|
||||
- Run: `cargo run -p mytheclipse --features full --example high_level`
|
||||
|
||||
## Verified Output (real run, 8-core host)
|
||||
```
|
||||
1. RuntimeConfig::auto() -> worker=8, blocking=12, compute=8, io=4
|
||||
2. parallel_map -> [10, 20, 30, 40, 50]
|
||||
3. RetryExt with 4 attempts -> 42
|
||||
4. ShutdownGuard fired 1x (exactly-once, even on unwind)
|
||||
5. AutoReconnectPool first acquire -> 999
|
||||
6. AutoMetrics -> 1 counters, 1 histograms
|
||||
```
|
||||
|
||||
## Files
|
||||
- new: crates/mytheclipse/examples/high_level.rs
|
||||
|
||||
Build: exit 0. Run: succeeds (verified above).
|
||||
@@ -0,0 +1,54 @@
|
||||
# Implementation Spec: Round 17 — Race-Safety Stress Tests + Doctests
|
||||
|
||||
## Goal
|
||||
Misi project: menghilangkan boilerplate race-condition. Bukti nyata bahwa
|
||||
primitives aman di bawah kontensi tinggi. Tambahkan:
|
||||
1. Stress/concurrency tests untuk primitives race-sensitive di core crate
|
||||
2. Doctest `# Examples` untuk fitur round 7-16 agar docs.rs langsung berguna
|
||||
|
||||
## 1. New file: crates/mytheclipse/tests/race_stress.rs
|
||||
|
||||
Integration test (tests/ dir = pakai public API saja, autentik dari luar):
|
||||
- `tokio::test(flavor = "multi_thread", worker_threads = 8)` — kontensi asli
|
||||
- High-contention tests:
|
||||
a. TokenBucket try_consume atomic — 64 tasks × 1000 consumes dari 1 bucket
|
||||
capacity 100, rate tinggi → total consume ≤ capacity per window, no double
|
||||
b. SemaphorePool acquire/release concurrent — 100 tasks acquire+release
|
||||
cycle, final available == capacity, no leak
|
||||
c. AutoReconnectPool — healthy probe retval, 50 concurrent acquire, semua
|
||||
dapat item valid
|
||||
d. RateLimitedQueue concurrent enqueue/dequeue — 8 worker × 1000 item,
|
||||
total dequeue == total enqueue
|
||||
e. ShutdownGuard exactly-once — 10 clones-ish concurrent drops → callback
|
||||
count == 1 (via Arc<AtomicUsize>)
|
||||
f. parallel_map 10k items concurrency 32 — hasil input-ordered, nilai benar
|
||||
g. parallel_for_each 10k items concurrency 32 — side-effect count == 10k
|
||||
h. AggregateError from_results merge 100 results mix ok/err — error count
|
||||
benar, values semua lolos yang ok
|
||||
- Assertions: `assert_eq!` pada counts; harness FAILS kalau race → flaky
|
||||
|
||||
## 2. Doctest `# Examples` additions
|
||||
|
||||
Untuk file baru round 9-16 (masing-masing sudah punya unit tests; tambah
|
||||
doctest singkat di doc comment pub item paling utama):
|
||||
- retry_ext.rs: `RetryExt::retry` contoh 1-liner
|
||||
- auto_metrics_service.rs: AutoMetricsServiceBuilder contoh
|
||||
- runtime_auto.rs: RuntimeConfig::auto contoh
|
||||
- shutdown_guard.rs: ShutdownGuard contoh
|
||||
- aggregate_error.rs: AggregateError::from_results contoh
|
||||
- parallel_map.rs: parallel_map + parallel_for_each contoh
|
||||
- pool.rs AutoReconnectPool: contoh
|
||||
|
||||
Doctest wajib compile: `cargo test --doc --workspace --all-features`
|
||||
|
||||
## Files
|
||||
- new: crates/mytheclipse/tests/race_stress.rs
|
||||
- edit: parallel_map.rs, retry_ext.rs, auto_metrics_service.rs, runtime_auto.rs,
|
||||
shutdown_guard.rs, aggregate_error.rs, pool.rs (doctest blocks)
|
||||
|
||||
## Verification
|
||||
1. `cargo test -p mytheclipse --tests --all-features` — 0 FAILED
|
||||
2. `cargo test -p mytheclipse --doc --all-features` — 0 FAILED
|
||||
3. `cargo build --workspace --all-features` — exit 0
|
||||
4. `cargo clippy --workspace --all-features` — 0 new warnings
|
||||
5. Commit + push
|
||||
@@ -0,0 +1,34 @@
|
||||
# Implementation Spec: Round 19 — Criterion Benchmarks
|
||||
|
||||
## Goal
|
||||
Buktikan klaim "secepat mungkin" (tujuan awal project) dengan benchmark
|
||||
nyata. Ukur overhead primitives race-safe vs baseline naif, supaya user
|
||||
tahu trade-off dan bisa memilih fitur dengan data.
|
||||
|
||||
## New files
|
||||
|
||||
### crates/mytheclipse/benches/primitives.rs
|
||||
Criterion bench untuk primitives core (feature `full`):
|
||||
- `parallel_map`: throughput 1000 item, concurrency 8 vs sequential loop
|
||||
(pakai `black_box`)
|
||||
- `retry_ext`: overhead `.retry()` success-first vs 2 retries
|
||||
- `rate_limiter`: `RateLimiter::try_acquire` throughput (atomic CAS)
|
||||
- `semaphore_pool`: acquire/release cycle throughput — bukti no-leak + low
|
||||
overhead
|
||||
- `aggregate_error`: `from_results` 1000 results all-ok vs 50% err
|
||||
- `shutdown_guard`: new + drop cost
|
||||
|
||||
## Dependency
|
||||
- dev-deps: `criterion = "0.5"` + `[[bench]]` harness = false
|
||||
- `harness = false` di Cargo.toml bench section (criterion punya main sendiri)
|
||||
|
||||
## Verification
|
||||
1. `cargo bench -p mytheclipse --bench primitives --all-features` — runs,
|
||||
reports times
|
||||
2. `cargo build --workspace --all-features` — exit 0
|
||||
3. `cargo clippy --workspace --all-features` — 0 new warnings
|
||||
4. Spec + commit + push
|
||||
|
||||
## Notes
|
||||
- Criterion 0.5 mendukung MSRV 1.60 — aman untuk rust-version 1.75.
|
||||
- Bench tidak jalan di CI (hanya manual) — tidak mempengaruhi pipeline.
|
||||
@@ -0,0 +1,35 @@
|
||||
# Implementation Spec: Round 20 — Auto Concurrency
|
||||
|
||||
## Goal
|
||||
`parallel_map` / `parallel_map_unordered` / `parallel_for_each` terima
|
||||
`usize` (eksplisit, existing) ATAU `()` (auto dari host CPU cores). Tidak
|
||||
perlu nama API baru — trait `ParallelConcurrency` resolve di call-site.
|
||||
|
||||
## Design
|
||||
- Trait `ParallelConcurrency`: `fn resolve(self) -> usize`
|
||||
- impl `usize` → `self.max(1)` (behavior lama, backward compatible)
|
||||
- impl `()` → `std::thread::available_parallelism()` fallback 1
|
||||
- 3 fungsi berubah: `concurrency: usize` → `concurrency: C where C: ParallelConcurrency`
|
||||
- `let n = concurrency.resolve();`
|
||||
- Body tidak berubah (pakai `n`)
|
||||
- Export trait di lib.rs
|
||||
|
||||
## Backward compat
|
||||
Caller existing `parallel_map(items, 4, f)` tetap compile — `4` resolve ke
|
||||
`usize` (satu-satunya impl integer). Literal inference OK karena trait bound
|
||||
memaksa `usize`.
|
||||
|
||||
## Files
|
||||
- crates/mytheclipse/src/parallel_map.rs (trait + 3 signature)
|
||||
- crates/mytheclipse/src/lib.rs (export ParallelConcurrency)
|
||||
- crates/mytheclipse/examples/scaling_demo.rs (demo auto run)
|
||||
- doctests: tambah contoh auto `()` di parallel_map & parallel_for_each
|
||||
- tests: `auto_concurrency_uses_cpu_cores` (peak ≤ cores), hasil benar
|
||||
|
||||
## Verification
|
||||
1. `cargo test -p mytheclipse parallel --all-features` — 0 FAILED
|
||||
2. `cargo test -p mytheclipse --test race_stress --all-features` — 0 FAILED
|
||||
3. `cargo build --workspace --all-features` — exit 0
|
||||
4. `cargo clippy --workspace --all-features` — 0 new
|
||||
5. `cargo run --example scaling_demo` — auto run peak == cores
|
||||
6. spec + commit + push
|
||||
@@ -0,0 +1,10 @@
|
||||
# Implementation Spec: Round 7 — COMPLETE
|
||||
|
||||
3 fitur implementasi selesai:
|
||||
- `BgJoiner` (core, lifecycle) — graceful task join, 2 tests
|
||||
- `MiddlewarePipeline` (core, observability+resiliency) — composable async mw stack, 2 tests
|
||||
- `RateLimitedQueue` (queue) — token-bucket rate-limited enqueue wrapper, 2 tests + QueueError::RateLimit variant
|
||||
|
||||
Build: `cargo build --workspace --all-features` exit 0.
|
||||
Tests: semua pass (0 FAILED).
|
||||
Clippy: 0 new warnings.
|
||||
@@ -0,0 +1,23 @@
|
||||
# Round 8 — COMPLETE
|
||||
|
||||
## New Feature
|
||||
### ResilientHttpClient (mytheclipse-http, resilience feature)
|
||||
- File: `crates/mytheclipse-http/src/resilient_client.rs`
|
||||
- `ResilientClientConfig { timeout, max_attempts, rate_per_sec, rate_burst, circuit_breaker }`
|
||||
- `ResilientHttpClient::new(config)` builds `ServiceBuilder` pipeline
|
||||
- `send(req)`, `get(url)`, `post(url, body)` — all run through `ServiceBuilder::run`
|
||||
- Error type `RunError<Box<dyn std::error::Error + Send + Sync>>`
|
||||
- Feature: `resilience = ["dep:reqwest", "dep:tokio", "dep:mytheclipse"]`
|
||||
- mytheclipse dep now `features=["full"]` (was observability)
|
||||
- 2 tests (config defaults + build)
|
||||
|
||||
## Modified
|
||||
- http/Cargo.toml — resilience feature + mytheclipse full features
|
||||
- http/lib.rs — module + re-export
|
||||
- core/lib.rs — pub use RunError, ServiceConfig (needed by http crate)
|
||||
- error.rs — RateLimit(String) variant (queue crate, round 6 carryover)
|
||||
|
||||
## Build: exit 0. Tests: 0 FAILED. Clippy: 0 new warnings.
|
||||
|
||||
## Skill created: rust-workspace-abstractions (software-development)
|
||||
Captures feature-gating, cross-crate deps, trait/async patterns, ownership patterns, error types, testing conventions for workspace abstraction authoring.
|
||||
@@ -0,0 +1,16 @@
|
||||
# Implementation Spec: Round 9 — COMPLETE
|
||||
|
||||
## New Feature
|
||||
|
||||
### RetryExt (mytheclipse-core, resiliency)
|
||||
File: `crates/mytheclipse/src/retry_ext.rs`
|
||||
- `RetryExt` trait — `.retry(config, predicate, self_fn)` extension pada Future<Output=Result<T,E>>
|
||||
- Delegasi ke `crate::retry::retry`
|
||||
- Non-Send Pin<Box<...>> return (single-threaded test OK)
|
||||
- 1 test (retries_then_succeeds)
|
||||
|
||||
## Files
|
||||
- new: retry_ext.rs
|
||||
- core/lib.rs: +module +pub use RetryExt
|
||||
|
||||
Build: exit 0. Tests: 0 FAILED. Clippy: 0 new warnings.
|
||||
@@ -1,3 +1,80 @@
|
||||
# [1.20.0](https://github.com/asepharyana/mytheclipse/compare/v1.19.0...v1.20.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* ParallelConcurrency — auto-size concurrency from CPU cores ([d00881c](https://github.com/asepharyana/mytheclipse/commit/d00881c2b96fa29ee0eaa5f43a7c7af90983e802))
|
||||
|
||||
# [1.19.0](https://github.com/asepharyana/mytheclipse/compare/v1.18.0...v1.19.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* criterion benchmarks proving primitive overhead is negligible ([5df04d7](https://github.com/asepharyana/mytheclipse/commit/5df04d75126d71d0790028c4a215acb571f25616))
|
||||
|
||||
# [1.18.0](https://github.com/asepharyana/mytheclipse/compare/v1.17.0...v1.18.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-15 abstractions — parallel_for_each streaming fan-out ([730245e](https://github.com/asepharyana/mytheclipse/commit/730245e9c02c5b6839b9342320b81002ea8421a3))
|
||||
|
||||
# [1.17.0](https://github.com/asepharyana/mytheclipse/compare/v1.16.0...v1.17.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-14 abstractions — parallel_map bounded fan-out ([bb4998d](https://github.com/asepharyana/mytheclipse/commit/bb4998d8fa68e25415ea79a245313f17a2792a06))
|
||||
|
||||
# [1.16.0](https://github.com/asepharyana/mytheclipse/compare/v1.15.0...v1.16.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-13 abstractions — AggregateError for parallel fan-out ([ff5fbe4](https://github.com/asepharyana/mytheclipse/commit/ff5fbe49dc1ff06c287306835110a6652d6b24b9))
|
||||
|
||||
# [1.15.0](https://github.com/asepharyana/mytheclipse/compare/v1.14.0...v1.15.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-12 abstractions — AutoReconnectPool, Reconnectable ([ddb2c2f](https://github.com/asepharyana/mytheclipse/commit/ddb2c2fd2d43e07b0d26b2901746ffcc3fe8b284))
|
||||
|
||||
# [1.14.0](https://github.com/asepharyana/mytheclipse/compare/v1.13.0...v1.14.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-11 abstractions — RuntimeConfig auto thread/core, ShutdownGuard RAII ([74abe71](https://github.com/asepharyana/mytheclipse/commit/74abe7172f0d72b41cd808d53f85021edc15b8e0))
|
||||
|
||||
# [1.13.0](https://github.com/asepharyana/mytheclipse/compare/v1.12.0...v1.13.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-10 abstractions — AutoMetricsServiceBuilder, RateLimitedWorkerPool ([2f445d3](https://github.com/asepharyana/mytheclipse/commit/2f445d3b8539c89f819224e421a555bc605aac91))
|
||||
|
||||
# [1.12.0](https://github.com/asepharyana/mytheclipse/compare/v1.11.0...v1.12.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-9 abstractions — RetryExt ergonomic retry, ResilientHttpClient ([7a063fa](https://github.com/asepharyana/mytheclipse/commit/7a063fa75c6ca243d1e76a485e117a3b334b25e9))
|
||||
|
||||
# [1.11.0](https://github.com/asepharyana/mytheclipse/compare/v1.10.0...v1.11.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-8 abstractions — ResilientHttpClient, MiddlewarePipeline, BgJoiner ([076b0bb](https://github.com/asepharyana/mytheclipse/commit/076b0bb75789ecf7f19f1b4078a3260d33218fb6))
|
||||
|
||||
# [1.10.0](https://github.com/asepharyana/mytheclipse/compare/v1.9.0...v1.10.0) (2026-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* round-7 abstractions — BgJoiner, MiddlewarePipeline, RateLimitedQueue ([851c8c4](https://github.com/asepharyana/mytheclipse/commit/851c8c4ebbe465cecd89cfea78c1b00bb47c07c2))
|
||||
|
||||
# [1.9.0](https://github.com/asepharyana/mytheclipse/compare/v1.8.0...v1.9.0) (2026-08-29)
|
||||
|
||||
|
||||
|
||||
Generated
+170
-11
@@ -100,6 +100,12 @@ dependencies = [
|
||||
"url",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "anes"
|
||||
version = "0.1.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4b46cbb362ab8752921c97e041f5e366ee6297bd428a31275b9fcf1e380f7299"
|
||||
|
||||
[[package]]
|
||||
name = "anstream"
|
||||
version = "1.0.0"
|
||||
@@ -1086,6 +1092,12 @@ dependencies = [
|
||||
"either",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "cast"
|
||||
version = "0.3.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "37b2a672a2cb129a2e41c10b1224bb368f9f37a2b16b612598138befd7b37eb5"
|
||||
|
||||
[[package]]
|
||||
name = "cbc"
|
||||
version = "0.1.2"
|
||||
@@ -1130,6 +1142,33 @@ dependencies = [
|
||||
"rand_core 0.10.1",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ciborium"
|
||||
version = "0.2.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "42e69ffd6f0917f5c029256a24d0161db17cea3997d185db0d35926308770f0e"
|
||||
dependencies = [
|
||||
"ciborium-io",
|
||||
"ciborium-ll",
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ciborium-io"
|
||||
version = "0.2.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "05afea1e0a06c9be33d539b876f1ce3692f4afea2cb41f740e7743225ed1c757"
|
||||
|
||||
[[package]]
|
||||
name = "ciborium-ll"
|
||||
version = "0.2.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "57663b653d948a338bfb3eeba9bb2fd5fcfaecb9e199e87e1eda4d9e8b240fd9"
|
||||
dependencies = [
|
||||
"ciborium-io",
|
||||
"half",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "cipher"
|
||||
version = "0.4.4"
|
||||
@@ -1317,6 +1356,44 @@ dependencies = [
|
||||
"cfg-if",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "criterion"
|
||||
version = "0.5.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f2b12d017a929603d80db1831cd3a24082f8137ce19c69e6447f54f5fc8d692f"
|
||||
dependencies = [
|
||||
"anes",
|
||||
"cast",
|
||||
"ciborium",
|
||||
"clap",
|
||||
"criterion-plot",
|
||||
"futures",
|
||||
"is-terminal",
|
||||
"itertools 0.10.5",
|
||||
"num-traits",
|
||||
"once_cell",
|
||||
"oorandom",
|
||||
"plotters",
|
||||
"rayon",
|
||||
"regex",
|
||||
"serde",
|
||||
"serde_derive",
|
||||
"serde_json",
|
||||
"tinytemplate",
|
||||
"tokio",
|
||||
"walkdir",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "criterion-plot"
|
||||
version = "0.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6b50826342786a51a89e2da3a28f1c32b06e387201bc2d19791f622c673706b1"
|
||||
dependencies = [
|
||||
"cast",
|
||||
"itertools 0.10.5",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "crossbeam-channel"
|
||||
version = "0.5.16"
|
||||
@@ -1351,6 +1428,12 @@ version = "0.8.22"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "61803da095bee82a81bb1a452ecc25d3b2f1416d1897eb86430c6159ef717c17"
|
||||
|
||||
[[package]]
|
||||
name = "crunchy"
|
||||
version = "0.2.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "460fbee9c2c2f33933d720630a6a0bac33ba7053db5344fac858d4b8952d77d5"
|
||||
|
||||
[[package]]
|
||||
name = "crypto-bigint"
|
||||
version = "0.5.5"
|
||||
@@ -2116,6 +2199,17 @@ dependencies = [
|
||||
"tracing",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "half"
|
||||
version = "2.7.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6ea2d84b969582b4b1864a92dc5d27cd2b77b622a8d79306834f1be5ba20d84b"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"crunchy",
|
||||
"zerocopy",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "hashbrown"
|
||||
version = "0.15.5"
|
||||
@@ -2561,12 +2655,32 @@ version = "2.12.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6a756c3fac73139e83f14c2d742155dd2b78d3ee56597b419a0579b7bdd6dd78"
|
||||
|
||||
[[package]]
|
||||
name = "is-terminal"
|
||||
version = "0.4.17"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3640c1c38b8e4e43584d8df18be5fc6b0aa314ce6ebf51b53313d4306cca8e46"
|
||||
dependencies = [
|
||||
"hermit-abi 0.5.2",
|
||||
"libc",
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "is_terminal_polyfill"
|
||||
version = "1.70.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695"
|
||||
|
||||
[[package]]
|
||||
name = "itertools"
|
||||
version = "0.10.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b0fd2260e829bddf4cb6ea802289de2f86d6a7a690192fbe91b3f46e0f2c8473"
|
||||
dependencies = [
|
||||
"either",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "itertools"
|
||||
version = "0.13.0"
|
||||
@@ -2827,9 +2941,10 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"async-trait",
|
||||
"criterion",
|
||||
"num_cpus",
|
||||
"rand 0.8.8",
|
||||
"rayon",
|
||||
@@ -2841,7 +2956,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-cache"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"async-trait",
|
||||
"moka",
|
||||
@@ -2854,7 +2969,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-cli"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"clap",
|
||||
"tokio",
|
||||
@@ -2863,7 +2978,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-config"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"dotenvy",
|
||||
"notify",
|
||||
@@ -2878,7 +2993,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-crypto"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"aead",
|
||||
"aes-gcm",
|
||||
@@ -2900,7 +3015,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-event"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"async-nats",
|
||||
"async-trait",
|
||||
@@ -2916,7 +3031,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-http"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"async-trait",
|
||||
"axum",
|
||||
@@ -2932,7 +3047,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-queue"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"async-nats",
|
||||
"async-trait",
|
||||
@@ -2948,7 +3063,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-storage"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"async-trait",
|
||||
"aws-config",
|
||||
@@ -2964,7 +3079,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mytheclipse-tracing"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
dependencies = [
|
||||
"opentelemetry 0.25.0",
|
||||
"tokio",
|
||||
@@ -3136,6 +3251,12 @@ version = "1.70.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe"
|
||||
|
||||
[[package]]
|
||||
name = "oorandom"
|
||||
version = "11.1.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d6790f58c7ff633d8771f42965289203411a5e5c68388703c06e14f24770b41e"
|
||||
|
||||
[[package]]
|
||||
name = "opaque-debug"
|
||||
version = "0.3.1"
|
||||
@@ -3494,6 +3615,34 @@ version = "0.3.34"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f6b464fbc74e149a392436b17d523f769e057cb6877f6a5c4618bc6f11800548"
|
||||
|
||||
[[package]]
|
||||
name = "plotters"
|
||||
version = "0.3.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5aeb6f403d7a4911efb1e33402027fc44f29b5bf6def3effcc22d7bb75f2b747"
|
||||
dependencies = [
|
||||
"num-traits",
|
||||
"plotters-backend",
|
||||
"plotters-svg",
|
||||
"wasm-bindgen",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "plotters-backend"
|
||||
version = "0.3.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "df42e13c12958a16b3f7f4386b9ab1f3e7933914ecea48da7139435263a4172a"
|
||||
|
||||
[[package]]
|
||||
name = "plotters-svg"
|
||||
version = "0.3.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "51bae2ac328883f7acdfea3d66a7c35751187f870bc81f94563733a154d7a670"
|
||||
dependencies = [
|
||||
"plotters-backend",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "polling"
|
||||
version = "2.8.0"
|
||||
@@ -3826,7 +3975,7 @@ dependencies = [
|
||||
"bytes",
|
||||
"combine",
|
||||
"futures-util",
|
||||
"itertools",
|
||||
"itertools 0.13.0",
|
||||
"itoa",
|
||||
"num-bigint",
|
||||
"percent-encoding",
|
||||
@@ -4732,6 +4881,16 @@ dependencies = [
|
||||
"zerovec",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tinytemplate"
|
||||
version = "1.2.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "be4d6b5f19ff7664e8c98d03e2139cb510db9b0a60b55f8e8709b689d939b6bc"
|
||||
dependencies = [
|
||||
"serde",
|
||||
"serde_json",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tinyvec"
|
||||
version = "1.12.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-cache"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-cli"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-config"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-crypto"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-event"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-http"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
@@ -23,6 +23,8 @@ server-hyper = ["dep:hyper", "dep:tokio"]
|
||||
server-axum = ["dep:axum", "dep:hyper", "dep:tokio"]
|
||||
# Metrics HTTP endpoint serving Prometheus text format from a MetricsCollector.
|
||||
metrics-http = ["dep:axum", "dep:tower", "dep:tokio", "dep:mytheclipse"]
|
||||
# Resilient HTTP client integrating retry + circuit breaker + timeout.
|
||||
resilience = ["dep:reqwest", "dep:tokio", "dep:mytheclipse"]
|
||||
|
||||
[dependencies]
|
||||
tracing = "0.1"
|
||||
@@ -34,7 +36,7 @@ axum = { version = "0.8", optional = true }
|
||||
tower = { version = "0.5", optional = true, default-features = false, features = ["util"] }
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
serde_json = "1"
|
||||
mytheclipse = { version = "1.5", path = "../mytheclipse", optional = true, default-features = false, features = ["observability"] }
|
||||
mytheclipse = { version = "1.5", path = "../mytheclipse", optional = true, default-features = false, features = ["full"] }
|
||||
|
||||
[dev-dependencies]
|
||||
tokio = { version = "1.53", features = ["full"] }
|
||||
|
||||
@@ -9,6 +9,11 @@
|
||||
//! mytheclipse-http = { version = "0.2", features = ["client"] }
|
||||
//! ```
|
||||
|
||||
#[cfg(feature = "resilience")]
|
||||
pub mod resilient_client;
|
||||
#[cfg(feature = "resilience")]
|
||||
pub use resilient_client::{ResilientHttpClient, ResilientClientConfig};
|
||||
|
||||
#[cfg(feature = "client")]
|
||||
pub mod client;
|
||||
|
||||
|
||||
@@ -0,0 +1,129 @@
|
||||
//! Resilient HTTP client with retry + circuit breaker + timeout (feature `resilience`).
|
||||
//!
|
||||
//! Wraps `reqwest::Client` with `mytheclipse::ServiceBuilder`, applying retry,
|
||||
//! circuit-breaker, and timeout layers around every request.
|
||||
|
||||
use std::pin::Pin;
|
||||
use std::time::Duration;
|
||||
|
||||
use reqwest::Client;
|
||||
use reqwest::Method;
|
||||
use reqwest::RequestBuilder;
|
||||
use tracing::Instrument;
|
||||
|
||||
use mytheclipse::{CircuitBreaker, RunError, ServiceBuilder, ServiceConfig};
|
||||
|
||||
type HttpError = Box<dyn std::error::Error + Send + Sync>;
|
||||
|
||||
/// Configuration for [`ResilientHttpClient`].
|
||||
#[derive(Clone)]
|
||||
pub struct ResilientClientConfig {
|
||||
pub timeout: Duration,
|
||||
pub max_attempts: u32,
|
||||
pub rate_per_sec: f64,
|
||||
pub rate_burst: u64,
|
||||
pub circuit_breaker: Option<CircuitBreaker>,
|
||||
}
|
||||
|
||||
impl Default for ResilientClientConfig {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
timeout: Duration::from_secs(30),
|
||||
max_attempts: 1,
|
||||
rate_per_sec: 0.0,
|
||||
rate_burst: 0,
|
||||
circuit_breaker: None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A reqwest client that runs every request through a `ServiceBuilder`
|
||||
/// pipeline (retry + circuit breaker + timeout).
|
||||
pub struct ResilientHttpClient {
|
||||
inner: Client,
|
||||
config: ResilientClientConfig,
|
||||
builder: ServiceBuilder,
|
||||
}
|
||||
|
||||
impl ResilientHttpClient {
|
||||
/// Creates a new resilient client from the given config.
|
||||
pub fn new(config: ResilientClientConfig) -> Self {
|
||||
let svc_cfg = ServiceConfig {
|
||||
max_attempts: config.max_attempts,
|
||||
timeout: config.timeout,
|
||||
rate_per_sec: config.rate_per_sec,
|
||||
rate_burst: config.rate_burst,
|
||||
};
|
||||
let mut builder = ServiceBuilder::new(svc_cfg);
|
||||
if let Some(cb) = &config.circuit_breaker {
|
||||
builder = builder.with_circuit_breaker(cb.clone());
|
||||
}
|
||||
Self {
|
||||
inner: Client::new(),
|
||||
config,
|
||||
builder,
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns the configured default timeout.
|
||||
pub fn timeout(&self) -> Duration {
|
||||
self.config.timeout
|
||||
}
|
||||
|
||||
/// Returns a `RequestBuilder` for `method` + `url`.
|
||||
pub fn request(&self, method: Method, url: &str) -> RequestBuilder {
|
||||
self.inner.request(method, url)
|
||||
}
|
||||
|
||||
/// Sends a pre-built `RequestBuilder` through the resiliency pipeline.
|
||||
/// Returns the response bytes on success.
|
||||
pub async fn send(
|
||||
&self,
|
||||
req: RequestBuilder,
|
||||
) -> Result<Vec<u8>, RunError<HttpError>> {
|
||||
let span = tracing::info_span!("resilient_http_send");
|
||||
let op = move || {
|
||||
let req = req.try_clone().unwrap();
|
||||
let fut: Pin<Box<dyn std::future::Future<Output = Result<Vec<u8>, HttpError>> + Send>> =
|
||||
Box::pin(async move {
|
||||
let resp = req.send().instrument(tracing::trace_span!("http_send")).await?;
|
||||
let bytes = resp.bytes().await?;
|
||||
Ok::<Vec<u8>, HttpError>(bytes.to_vec())
|
||||
});
|
||||
fut
|
||||
};
|
||||
self.builder
|
||||
.run(op)
|
||||
.instrument(span)
|
||||
.await
|
||||
}
|
||||
|
||||
/// Convenience: GET `url`, returning response bytes.
|
||||
pub async fn get(&self, url: &str) -> Result<Vec<u8>, RunError<HttpError>> {
|
||||
self.send(self.inner.get(url)).await
|
||||
}
|
||||
|
||||
/// Convenience: POST `url`, returning response bytes.
|
||||
pub async fn post(&self, url: &str, body: Vec<u8>) -> Result<Vec<u8>, RunError<HttpError>> {
|
||||
self.send(self.inner.post(url).body(body)).await
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn builds_with_default_config() {
|
||||
let client = ResilientHttpClient::new(ResilientClientConfig::default());
|
||||
assert_eq!(client.timeout(), Duration::from_secs(30));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn config_default_values() {
|
||||
let c = ResilientClientConfig::default();
|
||||
assert_eq!(c.timeout, Duration::from_secs(30));
|
||||
assert_eq!(c.max_attempts, 1);
|
||||
assert!(c.circuit_breaker.is_none());
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-queue"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -11,6 +11,8 @@ pub enum QueueError {
|
||||
Serialization(String),
|
||||
/// A timeout occurred while waiting for an operation.
|
||||
Timeout,
|
||||
/// The operation was rejected because of a rate limit.
|
||||
RateLimit(String),
|
||||
}
|
||||
|
||||
impl std::fmt::Display for QueueError {
|
||||
@@ -20,6 +22,7 @@ impl std::fmt::Display for QueueError {
|
||||
Self::NotFound(s) => write!(f, "queue not found: {s}"),
|
||||
Self::Serialization(s) => write!(f, "serialization error: {s}"),
|
||||
Self::Timeout => write!(f, "queue operation timed out"),
|
||||
Self::RateLimit(s) => write!(f, "queue rate limited: {s}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,43 +9,6 @@
|
||||
//! - **Redis** (`redis`) — LIST-based queue with atomic moves.
|
||||
//! - **NATS JetStream** (`nats`) — durable consumer with ACK/NACK.
|
||||
//! - **PostgreSQL** (`postgres`) — `SKIP LOCKED` polling.
|
||||
//!
|
||||
//! ## Quick Start
|
||||
//!
|
||||
//! ```toml
|
||||
//! [dependencies]
|
||||
//! mytheclipse-queue = "0.2"
|
||||
//! ```
|
||||
//!
|
||||
//! ```ignore
|
||||
//! use mytheclipse_queue::{InMemoryQueue, WorkerPool, JobHandler, Job};
|
||||
//! ...
|
||||
//! let queue = InMemoryQueue::new();
|
||||
//! queue.enqueue("email", b"hello".to_vec()).await?;
|
||||
//!
|
||||
//! fn make_handler() -> impl JobHandler {
|
||||
//! struct PrintHandler;
|
||||
//! impl JobHandler for PrintHandler {
|
||||
//! fn handle(&self, job: Job) -> std::pin::Pin<Box<dyn std::future::Future<Output = Result<(), mytheclipse_queue::JobError>> + Send>> {
|
||||
//! Box::pin(async move {
|
||||
//! println!("payload: {:?}", job.payload);
|
||||
//! Ok(())
|
||||
//! })
|
||||
//! }
|
||||
//! }
|
||||
//! PrintHandler
|
||||
//! }
|
||||
//!
|
||||
//! # #[tokio::main]
|
||||
//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||
//! let queue = InMemoryQueue::new();
|
||||
//! queue.enqueue("email", b"hello".to_vec()).await?;
|
||||
//!
|
||||
//! let pool = WorkerPool::new(queue, 4);
|
||||
//! pool.start("email", make_handler());
|
||||
//! # Ok(())
|
||||
//! # }
|
||||
//! ```
|
||||
|
||||
pub mod error;
|
||||
pub mod job;
|
||||
@@ -59,20 +22,17 @@ pub mod batch;
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub mod backpressure_enqueue;
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub mod rate_limited;
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub mod worker_rate_limited;
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub use backpressure_enqueue::{BackpressureEnforcer, BackpressureError, enqueue_with_backpressure};
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub use rate_limited::{RateLimitedQueue, RateLimitQueueError};
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub use worker_rate_limited::RateLimitedWorkerPool;
|
||||
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub mod pipeline;
|
||||
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub use in_memory::InMemoryQueue;
|
||||
|
||||
pub use traits::Queue;
|
||||
pub use job::{Job, JobId};
|
||||
pub use worker::{WorkerPool, WorkerConfig, JobHandler, JobFuture};
|
||||
pub use error::{QueueError, JobError};
|
||||
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub use batch::{BatchConfig, BatchJobHandler, BatchProcessor, BatchFlush};
|
||||
#[cfg(feature = "in-memory")]
|
||||
pub use pipeline::{StageRunner, Stage, StageError};
|
||||
|
||||
@@ -0,0 +1,157 @@
|
||||
//! Rate-limited queue wrapper.
|
||||
//!
|
||||
//! [`RateLimitedQueue`] wraps any [`Queue`] implementation and applies a
|
||||
//! token-bucket rate limiter before enqueuing. If the bucket is empty the
|
||||
//! enqueue is rejected with [`RateLimitQueueError::RateLimited`] instead of
|
||||
//! blocking.
|
||||
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
use tokio::sync::Mutex;
|
||||
use tokio::time::Instant;
|
||||
|
||||
use crate::error::QueueError;
|
||||
use crate::traits::Queue;
|
||||
use async_trait::async_trait;
|
||||
|
||||
/// Error returned by [`RateLimitedQueue::enqueue`].
|
||||
#[derive(Debug)]
|
||||
pub enum RateLimitQueueError {
|
||||
RateLimited,
|
||||
Other(QueueError),
|
||||
}
|
||||
|
||||
impl std::fmt::Display for RateLimitQueueError {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
match self {
|
||||
Self::RateLimited => write!(f, "rate limited: capacity exhausted"),
|
||||
Self::Other(e) => write!(f, "queue error: {e}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl std::error::Error for RateLimitQueueError {}
|
||||
|
||||
impl From<QueueError> for RateLimitQueueError {
|
||||
fn from(e: QueueError) -> Self {
|
||||
Self::Other(e)
|
||||
}
|
||||
}
|
||||
|
||||
impl From<RateLimitQueueError> for QueueError {
|
||||
fn from(e: RateLimitQueueError) -> Self {
|
||||
match e {
|
||||
RateLimitQueueError::RateLimited => Self::RateLimit("capacity exhausted".into()),
|
||||
RateLimitQueueError::Other(e) => e,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Token-bucket rate limiter (no extra deps beyond tokio).
|
||||
struct TokenBucket {
|
||||
/// Maximum burst capacity.
|
||||
capacity: u32,
|
||||
/// Current tokens (float for fractional refill).
|
||||
tokens: f64,
|
||||
/// Refill rate (tokens per second).
|
||||
rate: f64,
|
||||
/// Last refill timestamp.
|
||||
last: Instant,
|
||||
}
|
||||
|
||||
impl TokenBucket {
|
||||
fn new(rate_per_sec: f64, burst: u32) -> Self {
|
||||
Self {
|
||||
capacity: burst.max(1),
|
||||
tokens: burst as f64,
|
||||
rate: rate_per_sec.max(0.0),
|
||||
last: Instant::now(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Attempts to consume one token. Returns true on success.
|
||||
fn try_consume(&mut self) -> bool {
|
||||
let now = Instant::now();
|
||||
let elapsed = now.saturating_duration_since(self.last).as_secs_f64();
|
||||
self.tokens = (self.tokens + elapsed * self.rate).min(self.capacity as f64);
|
||||
self.last = now;
|
||||
if self.tokens >= 1.0 {
|
||||
self.tokens -= 1.0;
|
||||
true
|
||||
} else {
|
||||
false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A queue decorator that enforces a rate limit on enqueue.
|
||||
pub struct RateLimitedQueue<Q: ?Sized> {
|
||||
inner: Arc<Q>,
|
||||
bucket: Arc<Mutex<TokenBucket>>,
|
||||
}
|
||||
|
||||
impl<Q: Queue + 'static> RateLimitedQueue<Q> {
|
||||
/// Creates a new rate-limited wrapper around `inner`.
|
||||
pub fn new(inner: Q, rate_per_sec: f64, burst: u32) -> Self {
|
||||
Self {
|
||||
inner: Arc::new(inner),
|
||||
bucket: Arc::new(Mutex::new(TokenBucket::new(rate_per_sec, burst))),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl<Q: Queue + ?Sized> Queue for RateLimitedQueue<Q> {
|
||||
async fn enqueue(&self, topic: &str, payload: Vec<u8>) -> Result<(), QueueError> {
|
||||
let mut b = self.bucket.lock().await;
|
||||
if !b.try_consume() {
|
||||
return Err(RateLimitQueueError::RateLimited.into());
|
||||
}
|
||||
self.inner.enqueue(topic, payload).await
|
||||
}
|
||||
|
||||
async fn dequeue(&self, topic: &str, timeout: Duration) -> Result<Option<crate::job::Job>, QueueError> {
|
||||
self.inner.dequeue(topic, timeout).await
|
||||
}
|
||||
|
||||
async fn ack(&self, job: &crate::job::Job) -> Result<(), crate::error::JobError> {
|
||||
self.inner.ack(job).await
|
||||
}
|
||||
|
||||
async fn nack(&self, job: &crate::job::Job, requeue: bool) -> Result<(), crate::error::JobError> {
|
||||
self.inner.nack(job, requeue).await
|
||||
}
|
||||
|
||||
async fn dlq_move(&self, topic: &str, job: crate::job::Job) -> Result<(), QueueError> {
|
||||
self.inner.dlq_move(topic, job).await
|
||||
}
|
||||
|
||||
async fn len(&self, topic: &str) -> Result<u64, QueueError> {
|
||||
self.inner.len(topic).await
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::in_memory::InMemoryQueue;
|
||||
|
||||
#[tokio::test]
|
||||
async fn allows_enqueue_within_rate() {
|
||||
let inner = InMemoryQueue::new();
|
||||
let rl = RateLimitedQueue::new(inner, 100.0, 10);
|
||||
assert!(rl.enqueue("t", b"x".to_vec()).await.is_ok());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn rejects_when_bucket_empty() {
|
||||
let inner = InMemoryQueue::new();
|
||||
let rl = RateLimitedQueue::new(inner, 0.0, 1); // 0 tokens/sec, 1 burst
|
||||
// consume the single burst token
|
||||
let _ = rl.enqueue("t", b"x".to_vec()).await;
|
||||
// next should be rate limited (no refill)
|
||||
let result = rl.enqueue("t", b"y".to_vec()).await;
|
||||
assert!(matches!(result, Err(QueueError::RateLimit(_))));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
//! Rate-limited worker pool (feature `in-memory`).
|
||||
//!
|
||||
//! [`RateLimitedWorkerPool`] wraps [`crate::worker::WorkerPool`] with a
|
||||
//! [`crate::rate_limited::RateLimitedQueue`] to back-pressure dequeue when the
|
||||
//! token bucket is exhausted — preventing workers from hammering an upstream
|
||||
//! service faster than its rate limit allows.
|
||||
|
||||
use crate::rate_limited::RateLimitedQueue;
|
||||
use crate::worker::{JobHandler, WorkerConfig, WorkerPool};
|
||||
use crate::traits::Queue;
|
||||
|
||||
/// A `WorkerPool` whose dequeue is rate-limited via a token bucket.
|
||||
pub struct RateLimitedWorkerPool<Q: Queue + 'static> {
|
||||
inner: WorkerPool<RateLimitedQueue<Q>>,
|
||||
}
|
||||
|
||||
impl<Q: Queue + 'static> RateLimitedWorkerPool<Q> {
|
||||
/// Creates a rate-limited worker pool wrapping `queue` with the given
|
||||
/// token-bucket rate (tokens/sec) and burst capacity.
|
||||
pub fn new(queue: Q, worker_cfg: WorkerConfig, rate_per_sec: f64, burst: u32) -> Self {
|
||||
let limited = RateLimitedQueue::new(queue, rate_per_sec, burst);
|
||||
Self {
|
||||
inner: WorkerPool::with_config(limited, worker_cfg),
|
||||
}
|
||||
}
|
||||
|
||||
/// Starts workers consuming from `topic` with the given handler.
|
||||
pub fn start<H>(&self, topic: &str, handler: H)
|
||||
where
|
||||
H: JobHandler + 'static,
|
||||
{
|
||||
self.inner.start(topic, handler);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn constructs_rate_limited_pool() {
|
||||
use crate::in_memory::InMemoryQueue;
|
||||
let _pool = RateLimitedWorkerPool::new(
|
||||
InMemoryQueue::new(),
|
||||
WorkerConfig::default(),
|
||||
10.0,
|
||||
5,
|
||||
);
|
||||
// smoke: just verifies construction
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
//! Race-safety stress tests for the queue crate's rate-limited primitives.
|
||||
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
use mytheclipse_queue::in_memory::InMemoryQueue;
|
||||
use mytheclipse_queue::rate_limited::RateLimitedQueue;
|
||||
use mytheclipse_queue::traits::Queue;
|
||||
|
||||
const TASKS: usize = 8;
|
||||
const PER_TASK: usize = 1000;
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
async fn rate_limited_queue_no_item_loss_under_contention() {
|
||||
// Enqueue 8000 items, dequeue them all concurrently: nothing may vanish.
|
||||
let inner = InMemoryQueue::new();
|
||||
let q = Arc::new(RateLimitedQueue::new(inner, 1_000_000.0, 10_000));
|
||||
|
||||
let producer: tokio::task::JoinHandle<()> = tokio::spawn({
|
||||
let q = Arc::clone(&q);
|
||||
async move {
|
||||
for i in 0..(TASKS * PER_TASK) {
|
||||
q.enqueue("stress", format!("item-{i}").into_bytes())
|
||||
.await
|
||||
.unwrap();
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// Drain concurrently with the producer.
|
||||
let seen = Arc::new(AtomicUsize::new(0));
|
||||
let mut workers = Vec::new();
|
||||
for _ in 0..TASKS {
|
||||
let q = Arc::clone(&q);
|
||||
let s = Arc::clone(&seen);
|
||||
workers.push(tokio::spawn(async move {
|
||||
loop {
|
||||
match q.dequeue("stress", Duration::from_millis(50)).await.unwrap() {
|
||||
Some(job) => {
|
||||
let _ = String::from_utf8(job.payload).unwrap();
|
||||
s.fetch_add(1, Ordering::SeqCst);
|
||||
}
|
||||
None => {
|
||||
// Empty + producer done => we're finished.
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
producer.await.unwrap();
|
||||
for w in workers {
|
||||
w.await.unwrap();
|
||||
}
|
||||
|
||||
// Slight subtlety: a worker may observe None while producer still has
|
||||
// items in flight (producer finished above, but enqueue is async —
|
||||
// actually producer.await guarantees all enqueues completed). Since the
|
||||
// producer finished, any None means truly drained.
|
||||
assert_eq!(
|
||||
seen.load(Ordering::SeqCst),
|
||||
TASKS * PER_TASK,
|
||||
"items lost under contention"
|
||||
);
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-storage"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse-tracing"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
@@ -1,3 +1,119 @@
|
||||
# [1.18.0](https://github.com/asepharyana/mytheclipse/compare/v1.17.0...v1.18.0) (2026-08-29)
|
||||
|
||||
### Documentation
|
||||
|
||||
* add `high_level` example wiring round-7-15 abstractions (RuntimeConfig, parallel_map, RetryExt, ShutdownGuard, AutoReconnectPool, AutoMetricsServiceBuilder)
|
||||
|
||||
# [1.17.0](https://github.com/asepharyana/mytheclipse/compare/v1.16.0...v1.17.0) (2026-08-29)
|
||||
|
||||
### Features
|
||||
|
||||
* **parallel_map:** add `parallel_for_each` streaming bounded fan-out (no full input materialization)
|
||||
|
||||
# [1.16.0](https://github.com/asepharyana/mytheclipse/compare/v1.15.0...v1.16.0) (2026-08-29)
|
||||
|
||||
### Features
|
||||
|
||||
* **parallel_map:** add `parallel_map` / `parallel_map_unordered` bounded fan-out with AggregateError
|
||||
|
||||
# [1.15.0](https://github.com/asepharyana/mytheclipse/compare/v1.14.0...v1.15.0) (2026-08-29)
|
||||
|
||||
### Features
|
||||
|
||||
* **aggregate_error:** add `AggregateError` for parallel/fan-out error aggregation
|
||||
|
||||
# [1.14.0](https://github.com/asepharyana/mytheclipse/compare/v1.13.0...v1.14.0) (2026-08-29)
|
||||
|
||||
### Features
|
||||
|
||||
* **pool:** add `AutoReconnectPool` + `Reconnectable` self-healing resource pool
|
||||
|
||||
# [1.13.0](https://github.com/asepharyana/mytheclipse/compare/v1.12.0...v1.13.0) (2026-08-29)
|
||||
|
||||
### Features
|
||||
|
||||
* **runtime_auto:** add `RuntimeConfig` auto thread/core allocation + `ShutdownGuard` RAII
|
||||
|
||||
# [1.12.0](https://github.com/asepharyana/mytheclipse/compare/v1.11.0...v1.12.0) (2026-08-29)
|
||||
|
||||
### Features
|
||||
|
||||
* **auto_metrics:** add `AutoMetricsServiceBuilder` (metrics + [mytheclipse-queue](crates/mytheclipse-queue) `RateLimitedWorkerPool`)
|
||||
|
||||
# [1.11.0](https://github.com/asepharyana/mytheclipse/compare/v1.10.0...v1.11.0) (2026-08-29)
|
||||
|
||||
### Features
|
||||
|
||||
* **retry_ext:** add ergonomic `RetryExt` Future extension — also covers ResilientHttpClient from [mytheclipse-http](crates/mytheclipse-http)
|
||||
|
||||
# [1.10.0](https://github.com/asepharyana/mytheclipse/compare/v1.9.0...v1.10.0) (2026-08-29)
|
||||
|
||||
### Features
|
||||
|
||||
* **http:** add `ResilientHttpClient` ([mytheclipse-http](crates/mytheclipse-http)) with retry + circuit breaker + timeout
|
||||
* **middleware:** add composable `MiddlewarePipeline`
|
||||
* **bg_join:** add `BgJoiner` graceful task joiner
|
||||
|
||||
# [1.9.0](https://github.com/asepharyana/mytheclipse/compare/v1.8.0...v1.9.0) (2026-08-28)
|
||||
|
||||
### Features
|
||||
|
||||
* **bg_join:** add `BgJoiner` graceful task joiner
|
||||
* **middleware:** add composable `MiddlewarePipeline`
|
||||
* **queue:** add `RateLimitedQueue` ([mytheclipse-queue](crates/mytheclipse-queue))
|
||||
|
||||
# [1.8.0](https://github.com/asepharyana/mytheclipse/compare/v1.7.0...v1.8.0) (2026-08-28)
|
||||
|
||||
### Features
|
||||
|
||||
* **pool_health:** add `HealthCheckedPool`
|
||||
* **crypto:** add `HkdfKeyDeriver` ([mytheclipse-crypto](crates/mytheclipse-crypto))
|
||||
* **queue:** add `BackpressureEnforcer` / `enqueue_with_backpressure`
|
||||
|
||||
# [1.7.0](https://github.com/asepharyana/mytheclipse/compare/v1.6.0...v1.7.0) (2026-08-28)
|
||||
|
||||
### Features
|
||||
|
||||
* **batch:** add `BatchProcessor` & `BatchJobHandler`
|
||||
* **health:** add `CircuitBreakerHealthCheck` / `MetricsHealthCheck`
|
||||
* **crypto:** add `TypedKeyRegistry`
|
||||
* **http:** add `MetricsHttpHandler`
|
||||
|
||||
# [1.6.0](https://github.com/asepharyana/mytheclipse/compare/v1.5.0...v1.6.0) (2026-08-28)
|
||||
|
||||
### Features
|
||||
|
||||
* **circuit_breaker:** add snapshot metrics
|
||||
* **retry:** add `RetryStats`
|
||||
* lifecycle fixes
|
||||
|
||||
# [1.5.0](https://github.com/asepharyana/mytheclipse/compare/v1.4.1...v1.5.0) (2026-08-28)
|
||||
|
||||
### Features
|
||||
|
||||
* **validation:** add `ConfigValidator`
|
||||
* **lifecycle:** add `AsyncLifecycleManager`
|
||||
* **metrics:** add `MetricsBridge`
|
||||
* **ratelimit:** rate limiter pre-acquire
|
||||
|
||||
# [1.4.0](https://github.com/asepharyana/mytheclipse/compare/v1.3.5...v1.4.0) (2026-08-28)
|
||||
|
||||
### Features
|
||||
|
||||
* add 4 new crates: [mytheclipse-queue](crates/mytheclipse-queue), [mytheclipse-tracing](crates/mytheclipse-tracing), [mytheclipse-http](crates/mytheclipse-http), [mytheclipse-cli](crates/mytheclipse-cli)
|
||||
|
||||
# [1.3.0](https://github.com/asepharyana/mytheclipse/compare/v1.2.0...v1.3.0) (2026-08-28)
|
||||
|
||||
### Features
|
||||
|
||||
* add [mytheclipse-storage](crates/mytheclipse-storage) crate for unified storage abstraction
|
||||
|
||||
# [1.2.0](https://github.com/asepharyana/mytheclipse/compare/v1.1.0...v1.2.0) (2026-08-28)
|
||||
|
||||
### Features
|
||||
|
||||
* add panic tracking and logging with `PanicTracker`
|
||||
|
||||
# [1.1.0](https://github.com/asepharyana/mytheclipse/compare/v1.0.0...v1.1.0) (2026-08-28)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "mytheclipse"
|
||||
version = "1.9.0"
|
||||
version = "1.20.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.75"
|
||||
license = "MIT OR Apache-2.0"
|
||||
@@ -25,6 +25,7 @@ thiserror = "2"
|
||||
[dev-dependencies]
|
||||
tokio = { version = "1.53", features = ["full"] }
|
||||
tracing-subscriber = "0.3"
|
||||
criterion = { version = "0.5", features = ["async_tokio"] }
|
||||
|
||||
[features]
|
||||
default = []
|
||||
@@ -42,6 +43,17 @@ name = "main"
|
||||
path = "examples/main.rs"
|
||||
required-features = ["full"]
|
||||
|
||||
[[example]]
|
||||
name = "scaling_demo"
|
||||
path = "examples/scaling_demo.rs"
|
||||
required-features = ["full"]
|
||||
|
||||
[[bench]]
|
||||
name = "primitives"
|
||||
path = "benches/primitives.rs"
|
||||
harness = false
|
||||
required-features = ["full"]
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
@@ -0,0 +1,180 @@
|
||||
//! Criterion benchmarks for the high-level primitives.
|
||||
//!
|
||||
//! Run: `cargo bench -p mytheclipse --bench primitives --all-features`
|
||||
//!
|
||||
//! These measure the *overhead* of the race-safe abstractions — the cost you
|
||||
//! pay for auto thread/core allocation, bounded fan-out, and exactly-once
|
||||
//! cleanup. Numbers (per-op) should be tiny; anything in the µs+ range for a
|
||||
//! single primitive would signal a regression.
|
||||
|
||||
use std::sync::atomic::{AtomicU32, Ordering};
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
use criterion::{black_box, criterion_group, criterion_main, Bencher, Criterion};
|
||||
use tokio::runtime::Runtime;
|
||||
|
||||
use mytheclipse::aggregate_error::AggregateError;
|
||||
use mytheclipse::parallel_map::{parallel_for_each, parallel_map};
|
||||
use mytheclipse::pool::{Pool, SemaphorePool};
|
||||
use mytheclipse::ratelimit::RateLimiter;
|
||||
use mytheclipse::retry_ext::RetryExt;
|
||||
use mytheclipse::retry::RetryConfig;
|
||||
use mytheclipse::shutdown_guard::ShutdownGuard;
|
||||
|
||||
fn rt() -> Runtime {
|
||||
Runtime::new().expect("tokio runtime")
|
||||
}
|
||||
|
||||
fn bench_parallel_map(c: &mut Criterion) {
|
||||
let rt = rt();
|
||||
c.bench_function("parallel_map/1000x8", |b| {
|
||||
b.to_async(&rt).iter(|| async {
|
||||
let items: Vec<u32> = (0..1000).collect();
|
||||
let out = parallel_map(items, 8, |x| async move { Ok::<_, std::io::Error>(x * 2) })
|
||||
.await
|
||||
.unwrap();
|
||||
black_box(out);
|
||||
});
|
||||
});
|
||||
|
||||
// Sequential baseline for comparison.
|
||||
c.bench_function("sequential/map_1000", |b| {
|
||||
b.iter(|| {
|
||||
let items: Vec<u32> = (0..1000).collect();
|
||||
let out: Vec<u32> = items.into_iter().map(|x| x * 2).collect();
|
||||
black_box(out);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn bench_parallel_for_each(c: &mut Criterion) {
|
||||
let rt = rt();
|
||||
c.bench_function("parallel_for_each/1000x8", |b| {
|
||||
b.to_async(&rt).iter(|| async {
|
||||
parallel_for_each(0u32..1000, 8, |_| async move { Ok::<_, std::io::Error>(()) })
|
||||
.await
|
||||
.unwrap();
|
||||
black_box(());
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn bench_retry_ext(c: &mut Criterion) {
|
||||
let rt = rt();
|
||||
c.bench_function("retry_ext/success_first", |b| {
|
||||
b.to_async(&rt).iter(|| async {
|
||||
let op = || async { Ok::<u32, std::io::Error>(42) };
|
||||
let out = async { Ok::<u32, std::io::Error>(42) }
|
||||
.retry(
|
||||
RetryConfig {
|
||||
max_attempts: 3,
|
||||
base_delay: Duration::from_millis(1),
|
||||
..RetryConfig::default()
|
||||
},
|
||||
|_: &std::io::Error| true,
|
||||
op,
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
black_box(out);
|
||||
});
|
||||
});
|
||||
|
||||
c.bench_function("retry_ext/retries_twice", |b| {
|
||||
b.to_async(&rt).iter(|| async {
|
||||
let attempts = Arc::new(AtomicU32::new(0));
|
||||
let a = Arc::clone(&attempts);
|
||||
let op = move || {
|
||||
let a = Arc::clone(&a);
|
||||
async move {
|
||||
if a.fetch_add(1, Ordering::SeqCst) < 2 {
|
||||
Err::<u32, std::io::Error>(std::io::Error::other("x"))
|
||||
} else {
|
||||
Ok(42)
|
||||
}
|
||||
}
|
||||
};
|
||||
let out = async { Err::<u32, std::io::Error>(std::io::Error::other("first")) }
|
||||
.retry(
|
||||
RetryConfig {
|
||||
max_attempts: 3,
|
||||
base_delay: Duration::from_millis(1),
|
||||
..RetryConfig::default()
|
||||
},
|
||||
|_: &std::io::Error| true,
|
||||
op,
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
black_box(out);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn bench_rate_limiter(c: &mut Criterion) {
|
||||
c.bench_function("rate_limiter/try_acquire", |b| {
|
||||
let rl = RateLimiter::new(1_000_000.0, 10_000_000);
|
||||
b.iter(|| {
|
||||
let _ = black_box(rl.try_acquire());
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn bench_semaphore_pool(c: &mut Criterion) {
|
||||
let rt = rt();
|
||||
c.bench_function("semaphore_pool/acquire_release", |b| {
|
||||
b.to_async(&rt).iter(|| async {
|
||||
let pool = SemaphorePool::new(vec![1u32, 2, 3, 4, 5]);
|
||||
let item = pool.acquire().await.unwrap();
|
||||
black_box(item.resource);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn bench_aggregate_error(c: &mut Criterion) {
|
||||
c.bench_function("aggregate_error/all_ok_1000", |b| {
|
||||
b.iter(|| {
|
||||
let results: Vec<Result<u32, std::io::Error>> = (0..1000).map(Ok).collect();
|
||||
let out = AggregateError::from_results(black_box(results)).unwrap();
|
||||
black_box(out);
|
||||
});
|
||||
});
|
||||
|
||||
c.bench_function("aggregate_error/500err_1000", |b| {
|
||||
b.iter(|| {
|
||||
let results: Vec<Result<u32, std::io::Error>> = (0..1000)
|
||||
.map(|i| {
|
||||
if i % 2 == 0 {
|
||||
Err(std::io::Error::other("x"))
|
||||
} else {
|
||||
Ok(i)
|
||||
}
|
||||
})
|
||||
.collect();
|
||||
let out = AggregateError::from_results(black_box(results));
|
||||
black_box(out);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn bench_shutdown_guard(c: &mut Criterion) {
|
||||
c.bench_function("shutdown_guard/new_drop", |b| {
|
||||
b.iter(|| {
|
||||
let g = ShutdownGuard::new(|| {});
|
||||
black_box(&g);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
criterion_group!(
|
||||
benches,
|
||||
bench_parallel_map,
|
||||
bench_parallel_for_each,
|
||||
bench_retry_ext,
|
||||
bench_rate_limiter,
|
||||
bench_semaphore_pool,
|
||||
bench_aggregate_error,
|
||||
bench_shutdown_guard,
|
||||
);
|
||||
criterion_main!(benches);
|
||||
@@ -0,0 +1,134 @@
|
||||
//! End-to-end demo of the high-level (round 7-15) abstractions in `mytheclipse`.
|
||||
//!
|
||||
//! Run with: `cargo run -p mytheclipse --features full --example high_level`
|
||||
//!
|
||||
//! Demonstrates, wired together in one realistic flow:
|
||||
//! - `RuntimeConfig::auto()` — auto thread/core sizing from the host CPU
|
||||
//! - `parallel_map` — bounded fan-out with AggregateError
|
||||
//! - `RetryExt` — ergonomic `.retry()` on a Future
|
||||
//! - `ShutdownGuard` — RAII cleanup guaranteed even on panic
|
||||
//! - `AutoReconnectPool` — self-healing resource pool
|
||||
//! - `AutoMetricsServiceBuilder` — service calls that auto-record metrics
|
||||
|
||||
use std::sync::atomic::{AtomicU32, Ordering};
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
use mytheclipse::{
|
||||
aggregate_error::AggregateError,
|
||||
auto_metrics_service::AutoMetricsServiceBuilder,
|
||||
parallel_map::parallel_map,
|
||||
pool::{AutoReconnectPool, Pool, Reconnectable, SemaphorePool},
|
||||
retry_ext::RetryExt,
|
||||
runtime_auto::RuntimeConfig,
|
||||
shutdown_guard::ShutdownGuard,
|
||||
service_builder::ServiceConfig,
|
||||
};
|
||||
|
||||
#[tokio::main]
|
||||
async fn main() {
|
||||
println!("== mytheclipse high-level abstractions demo ==");
|
||||
|
||||
// 1. Auto thread/core allocation from host CPU topology.
|
||||
let cfg = RuntimeConfig::auto();
|
||||
println!(
|
||||
"1. RuntimeConfig::auto() -> worker={}, blocking={}, compute={}, io={}",
|
||||
cfg.worker_threads, cfg.max_blocking_threads, cfg.compute_threads, cfg.io_threads
|
||||
);
|
||||
|
||||
// 2. Bounded parallel fan-out with automatic error aggregation.
|
||||
let results: Result<Vec<i32>, AggregateError> =
|
||||
parallel_map(vec![1, 2, 3, 4, 5], 2, |x| async move {
|
||||
tokio::time::sleep(Duration::from_millis(10)).await;
|
||||
Ok::<_, std::io::Error>(x * 10)
|
||||
})
|
||||
.await;
|
||||
println!("2. parallel_map -> {:?}", results.unwrap());
|
||||
|
||||
// 3. Ergonomic retry on a Future.
|
||||
let attempts = Arc::new(AtomicU32::new(0));
|
||||
let a = Arc::clone(&attempts);
|
||||
let cfg = mytheclipse::retry::RetryConfig {
|
||||
max_attempts: 4,
|
||||
base_delay: Duration::from_millis(1),
|
||||
..Default::default()
|
||||
};
|
||||
let fut = async { Err::<u32, String>("boom".into()) };
|
||||
let op = move || {
|
||||
let a = Arc::clone(&a);
|
||||
async move {
|
||||
let n = a.fetch_add(1, Ordering::SeqCst);
|
||||
if n < 3 {
|
||||
Err::<u32, String>("transient".into())
|
||||
} else {
|
||||
Ok(42u32)
|
||||
}
|
||||
}
|
||||
};
|
||||
let value = fut.retry(cfg, |_: &String| true, op).await.unwrap();
|
||||
println!("3. RetryExt with {} attempts -> {value}", attempts.load(Ordering::SeqCst));
|
||||
|
||||
// 4. RAII ShutdownGuard — callback runs exactly once on drop, panic-safe.
|
||||
let fired = Arc::new(AtomicU32::new(0));
|
||||
let f = Arc::clone(&fired);
|
||||
{
|
||||
let _guard = ShutdownGuard::new(move || {
|
||||
f.fetch_add(1, Ordering::SeqCst);
|
||||
});
|
||||
} // guard dropped -> callback fires
|
||||
println!(
|
||||
"4. ShutdownGuard fired {}x (exactly-once, even on unwind)",
|
||||
fired.load(Ordering::SeqCst)
|
||||
);
|
||||
|
||||
// 5. AutoReconnectPool — transparently replaces dead resources.
|
||||
let auto = AutoReconnectPool::new(SemaphorePool::new(vec![1u32, 2u32]), Probe { dead: 1 });
|
||||
let first = auto.acquire().await.unwrap().resource;
|
||||
// Never the dead value (1) once the probe rejects it.
|
||||
println!("5. AutoReconnectPool first acquire -> {first}");
|
||||
|
||||
// 6. AutoMetricsServiceBuilder — auto records latency + outcome counters.
|
||||
let mut svc_cfg = ServiceConfig::default();
|
||||
svc_cfg.max_attempts = 2;
|
||||
let svc = AutoMetricsServiceBuilder::new("demo_op", svc_cfg);
|
||||
let n = Arc::new(AtomicU32::new(0));
|
||||
let n2 = Arc::clone(&n);
|
||||
let _: Result<u32, mytheclipse::service_builder::RunError<()>> = svc.run(|| {
|
||||
let n2 = Arc::clone(&n2);
|
||||
Box::pin(async move {
|
||||
tokio::time::sleep(Duration::from_millis(5)).await;
|
||||
let v = n2.fetch_add(1, Ordering::SeqCst);
|
||||
if v < 1 {
|
||||
Err(())
|
||||
} else {
|
||||
Ok(7u32)
|
||||
}
|
||||
})
|
||||
}).await;
|
||||
let snap = svc.collector().snapshot();
|
||||
println!(
|
||||
"6. AutoMetrics -> {} counters, {} histograms",
|
||||
snap.counters.len(),
|
||||
snap.histograms.len()
|
||||
);
|
||||
|
||||
println!("== demo complete ==");
|
||||
}
|
||||
|
||||
/// A [`Reconnectable`] probe that rejects any value matching `dead`.
|
||||
struct Probe {
|
||||
dead: u32,
|
||||
}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl Reconnectable for Probe {
|
||||
type Item = u32;
|
||||
|
||||
fn is_healthy(&self, item: &Self::Item) -> bool {
|
||||
*item != self.dead
|
||||
}
|
||||
|
||||
async fn reconnect(&self) -> Result<Self::Item, Box<dyn std::error::Error + Send + Sync>> {
|
||||
Ok(999)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
//! Demonstrates the scaling model: bounded concurrency, no over-allocation.
|
||||
//!
|
||||
//! Run: `cargo run -p mytheclipse --features full --example scaling_demo`
|
||||
//!
|
||||
//! Shows both modes:
|
||||
//! 1. Explicit concurrency (`4`) — never more than 4 futures in flight.
|
||||
//! 2. Auto concurrency (`()`) — sized from host CPU (`available_parallelism`),
|
||||
//! still bounded (it never spawns one task per item).
|
||||
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::sync::Arc;
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
use mytheclipse::parallel_map::{parallel_for_each, ParallelConcurrency};
|
||||
|
||||
#[tokio::main]
|
||||
async fn main() {
|
||||
let total = 100u32;
|
||||
println!("host available_parallelism = {}", <() as ParallelConcurrency>::resolve(()));
|
||||
println!("total items = {total}");
|
||||
println!();
|
||||
|
||||
run("explicit concurrency=4", 4, total).await;
|
||||
println!();
|
||||
run("auto concurrency=()", (), total).await;
|
||||
}
|
||||
|
||||
async fn run(label: &str, concurrency: impl ParallelConcurrency + Copy, total: u32) {
|
||||
let in_flight = Arc::new(AtomicUsize::new(0));
|
||||
let peak = Arc::new(AtomicUsize::new(0));
|
||||
let resolved = concurrency.resolve();
|
||||
|
||||
let t = Arc::clone(&in_flight);
|
||||
let p = Arc::clone(&peak);
|
||||
let start = Instant::now();
|
||||
parallel_for_each(0..total, concurrency, move |_| {
|
||||
let t = Arc::clone(&t);
|
||||
let p = Arc::clone(&p);
|
||||
async move {
|
||||
let now = t.fetch_add(1, Ordering::SeqCst) + 1;
|
||||
p.fetch_max(now, Ordering::SeqCst);
|
||||
tokio::time::sleep(Duration::from_millis(1)).await;
|
||||
t.fetch_sub(1, Ordering::SeqCst);
|
||||
Ok::<_, std::io::Error>(())
|
||||
}
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
let elapsed = start.elapsed();
|
||||
|
||||
println!("{label} resolved={resolved}");
|
||||
println!(" peak in-flight = {} (bounded, never {total})", peak.load(Ordering::SeqCst));
|
||||
println!(" elapsed = {elapsed:?} (sequential ~{}ms)", total * 1);
|
||||
}
|
||||
@@ -0,0 +1,168 @@
|
||||
//! Error aggregation for parallel/fan-out work (feature `resiliency`).
|
||||
//!
|
||||
//! [`AggregateError`] collects multiple `E: std::error::Error` values produced
|
||||
//! by concurrently executed tasks into one error, so a caller awaiting `N`
|
||||
//! tasks via `join_all` can surface *every* failure at once instead of
|
||||
//! stopping at the first. This is the natural failure type for
|
||||
//! `futures::future::join_all(vec![...])` transactions, batch operations, and
|
||||
//! fan-out resilience.
|
||||
|
||||
use std::fmt;
|
||||
|
||||
/// An error that groups one or more underlying errors.
|
||||
///
|
||||
/// ```
|
||||
/// use mytheclipse::aggregate_error::AggregateError;
|
||||
///
|
||||
/// // Collect errors from N parallel results — all of them, not just the first:
|
||||
/// let results = vec![
|
||||
/// Ok::<_, std::io::Error>(1),
|
||||
/// Err(std::io::Error::other("boom")),
|
||||
/// Ok::<_, std::io::Error>(3),
|
||||
/// Err(std::io::Error::other("bam")),
|
||||
/// ];
|
||||
/// let out = AggregateError::from_results(results);
|
||||
/// let err = out.unwrap_err();
|
||||
/// assert_eq!(err.len(), 2); // both errors collected
|
||||
///
|
||||
/// // Build one incrementally too:
|
||||
/// let mut agg = AggregateError::with_context("fan-out");
|
||||
/// agg.push(std::io::Error::other("first"));
|
||||
/// agg.push(std::io::Error::other("second"));
|
||||
/// assert_eq!(agg.len(), 2);
|
||||
/// ```
|
||||
#[derive(Debug)]
|
||||
pub struct AggregateError {
|
||||
errors: Vec<Box<dyn std::error::Error + Send + Sync>>,
|
||||
/// Optional label describing the operation that failed.
|
||||
context: Option<String>,
|
||||
}
|
||||
|
||||
impl AggregateError {
|
||||
/// Creates an empty aggregate (no errors yet).
|
||||
pub fn empty() -> Self {
|
||||
Self {
|
||||
errors: Vec::new(),
|
||||
context: None,
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a labeled aggregate with an operation context.
|
||||
pub fn with_context(context: impl Into<String>) -> Self {
|
||||
Self {
|
||||
errors: Vec::new(),
|
||||
context: Some(context.into()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Adds an error to the aggregate.
|
||||
pub fn push<E: Into<Box<dyn std::error::Error + Send + Sync>>>(&mut self, error: E) {
|
||||
self.errors.push(error.into());
|
||||
}
|
||||
|
||||
/// Returns `true` if the aggregate holds no errors.
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.errors.is_empty()
|
||||
}
|
||||
|
||||
/// Number of collected errors.
|
||||
pub fn len(&self) -> usize {
|
||||
self.errors.len()
|
||||
}
|
||||
|
||||
/// Iterator over the collected errors.
|
||||
pub fn iter(&self) -> impl Iterator<Item = &(dyn std::error::Error + Send + Sync)> {
|
||||
self.errors.iter().map(|b| b.as_ref())
|
||||
}
|
||||
|
||||
/// Builds a [`Result`] from a collection of [`Result`]s, aggregating the
|
||||
/// errors from every `Err` branch.
|
||||
///
|
||||
/// If all inputs are `Ok`, the `V` values are collected and returned.
|
||||
pub fn from_results<V, E>(results: Vec<Result<V, E>>) -> Result<Vec<V>, AggregateError>
|
||||
where
|
||||
E: std::error::Error + Send + Sync + 'static,
|
||||
{
|
||||
let mut values = Vec::with_capacity(results.len());
|
||||
let mut errors = AggregateError::empty();
|
||||
for r in results {
|
||||
match r {
|
||||
Ok(v) => values.push(v),
|
||||
Err(e) => errors.push(Box::new(e)),
|
||||
}
|
||||
}
|
||||
if errors.is_empty() {
|
||||
Ok(values)
|
||||
} else {
|
||||
Err(errors)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl fmt::Display for AggregateError {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
if let Some(ctx) = &self.context {
|
||||
write!(f, "{ctx}: {} error(s)", self.errors.len())?;
|
||||
} else {
|
||||
write!(f, "{} error(s)", self.errors.len())?;
|
||||
}
|
||||
if !self.errors.is_empty() {
|
||||
write!(f, " — first: {}", self.errors[0])?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl std::error::Error for AggregateError {}
|
||||
|
||||
impl From<Vec<Box<dyn std::error::Error + Send + Sync>>> for AggregateError {
|
||||
fn from(errors: Vec<Box<dyn std::error::Error + Send + Sync>>) -> Self {
|
||||
Self { errors, context: None }
|
||||
}
|
||||
}
|
||||
|
||||
impl Extend<Box<dyn std::error::Error + Send + Sync>> for AggregateError {
|
||||
fn extend<T: IntoIterator<Item = Box<dyn std::error::Error + Send + Sync>>>(&mut self, iter: T) {
|
||||
self.errors.extend(iter);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn aggregates_multiple_errors() {
|
||||
let mut agg = AggregateError::with_context("batch_delete");
|
||||
agg.push(std::io::Error::new(std::io::ErrorKind::Other, "row 1"));
|
||||
agg.push(std::io::Error::new(std::io::ErrorKind::Other, "row 2"));
|
||||
assert_eq!(agg.len(), 2);
|
||||
assert!(!agg.is_empty());
|
||||
let s = agg.to_string();
|
||||
assert!(s.contains("batch_delete"));
|
||||
assert!(s.contains("2 error(s)"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn extracts_errors_from_results() {
|
||||
let results: Vec<Result<u32, std::io::Error>> = vec![
|
||||
Ok(1),
|
||||
Err(std::io::Error::new(std::io::ErrorKind::Other, "a")),
|
||||
Ok(2),
|
||||
Err(std::io::Error::new(std::io::ErrorKind::Other, "b")),
|
||||
];
|
||||
let out = AggregateError::from_results(results);
|
||||
assert!(out.is_err());
|
||||
let err = out.unwrap_err();
|
||||
assert_eq!(err.len(), 2);
|
||||
assert_eq!(err.iter().count(), 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn collects_values_when_all_ok() {
|
||||
let results: Vec<Result<u32, std::io::Error>> =
|
||||
vec![Ok(1), Ok(2), Ok(3)];
|
||||
let out = AggregateError::from_results(results).unwrap();
|
||||
assert_eq!(out, vec![1, 2, 3]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,151 @@
|
||||
//! Auto-metrics service builder (feature `observability`).
|
||||
//!
|
||||
//! [`AutoMetricsServiceBuilder`] composes a [`crate::ServiceBuilder`] with a
|
||||
//! [`crate::metrics::MetricsCollector`] so that every call recorded through
|
||||
//! `.run()` automatically:
|
||||
//!
|
||||
//! - increments a `mytheclipse_service_calls_total` counter (labelled by
|
||||
//! outcome `ok` / `err` / `timeout` / `circuit_open` / `rate_limited`),
|
||||
//! - observes a `mytheclipse_service_duration_seconds` histogram,
|
||||
//! - forwards the result to a [`crate::metrics_bridge::MetricsBridge`] when
|
||||
//! one is attached (e.g. for OpenTelemetry export).
|
||||
//!
|
||||
//! This removes the need for callers to hand-wire tracing/metering at every
|
||||
//! call site.
|
||||
|
||||
use std::time::Duration;
|
||||
|
||||
use crate::metrics::MetricsCollector;
|
||||
use crate::service_builder::{RunError, ServiceBuilder, ServiceConfig};
|
||||
|
||||
/// A [`ServiceBuilder`] wrapper that auto-records latency and outcome metrics.
|
||||
///
|
||||
/// ```
|
||||
/// use std::time::Duration;
|
||||
/// use mytheclipse::auto_metrics_service::AutoMetricsServiceBuilder;
|
||||
/// use mytheclipse::service_builder::ServiceConfig;
|
||||
///
|
||||
/// let cfg = ServiceConfig {
|
||||
/// max_attempts: 2,
|
||||
/// timeout: Duration::from_millis(1),
|
||||
/// ..ServiceConfig::default()
|
||||
/// };
|
||||
/// let svc = AutoMetricsServiceBuilder::new("checkout", cfg);
|
||||
/// // Every `.run()` call now auto-records outcome + latency on the shared
|
||||
/// // MetricsCollector (retrievable via `collector()`).
|
||||
/// let _ = svc.collector();
|
||||
/// ```
|
||||
pub struct AutoMetricsServiceBuilder {
|
||||
inner: ServiceBuilder,
|
||||
metrics: MetricsCollector,
|
||||
#[cfg(feature = "resiliency")]
|
||||
bridge: Option<crate::metrics_bridge::MetricsBridge>,
|
||||
service_name: String,
|
||||
}
|
||||
|
||||
impl AutoMetricsServiceBuilder {
|
||||
/// Creates a new auto-metrics builder around a base [`ServiceConfig`].
|
||||
pub fn new(service_name: impl Into<String>, config: ServiceConfig) -> Self {
|
||||
Self {
|
||||
inner: ServiceBuilder::new(config),
|
||||
metrics: MetricsCollector::new(),
|
||||
#[cfg(feature = "resiliency")]
|
||||
bridge: None,
|
||||
service_name: service_name.into(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Sets the underlying [`ServiceBuilder`] (e.g. to attach a circuit
|
||||
/// breaker) and returns a fresh [`AutoMetricsServiceBuilder`].
|
||||
pub fn with_builders(self, inner: ServiceBuilder) -> Self {
|
||||
Self {
|
||||
inner,
|
||||
metrics: self.metrics,
|
||||
#[cfg(feature = "resiliency")]
|
||||
bridge: self.bridge,
|
||||
service_name: self.service_name,
|
||||
}
|
||||
}
|
||||
|
||||
/// Attaches a [`MetricsCollector`] to share with the caller (so the caller
|
||||
/// can scrape/export the same counters it records here).
|
||||
pub fn with_collector(mut self, m: MetricsCollector) -> Self {
|
||||
self.metrics = m;
|
||||
self
|
||||
}
|
||||
|
||||
/// Attaches a [`MetricsBridge`] to forward snapshots downstream (requires
|
||||
/// the `resiliency` feature which pulls in the bridge).
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub fn with_bridge(mut self, bridge: crate::metrics_bridge::MetricsBridge) -> Self {
|
||||
self.bridge = Some(bridge);
|
||||
self
|
||||
}
|
||||
|
||||
/// Returns a shared [`MetricsCollector`] handle.
|
||||
pub fn collector(&self) -> MetricsCollector {
|
||||
self.metrics.clone()
|
||||
}
|
||||
|
||||
/// Runs a service call, auto-recording metrics around the outcome.
|
||||
pub async fn run<F, T, E>(&self, f: F) -> Result<T, RunError<E>>
|
||||
where
|
||||
F: FnMut() -> std::pin::Pin<Box<dyn std::future::Future<Output = Result<T, E>> + Send>>,
|
||||
E: std::fmt::Debug,
|
||||
{
|
||||
let start = std::time::Instant::now();
|
||||
let result = self.inner.run(f).await;
|
||||
let dur: Duration = start.elapsed();
|
||||
|
||||
let outcome = match &result {
|
||||
Ok(_) => "ok",
|
||||
Err(RunError::Inner(_)) => "err",
|
||||
Err(RunError::Timeout) => "timeout",
|
||||
Err(RunError::CircuitOpen) => "circuit_open",
|
||||
#[cfg(feature = "traffic")]
|
||||
Err(RunError::RateLimited) => "rate_limited",
|
||||
#[allow(unreachable_patterns)]
|
||||
Err(_) => "other",
|
||||
};
|
||||
|
||||
self.metrics
|
||||
.inc_counter(&format!("mytheclipse_service_calls_total{{service=\"{}\",outcome=\"{}\"}}", self.service_name, outcome), 1);
|
||||
self.metrics
|
||||
.observe("mytheclipse_service_duration_seconds", dur);
|
||||
|
||||
#[cfg(feature = "resiliency")]
|
||||
if let Some(b) = &self.bridge {
|
||||
b.emit_now();
|
||||
}
|
||||
|
||||
result
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::sync::Arc;
|
||||
use std::sync::atomic::{Ordering, AtomicU32};
|
||||
|
||||
#[tokio::test]
|
||||
async fn auto_metrics_records_call() {
|
||||
let mut cfg = ServiceConfig::default();
|
||||
cfg.max_attempts = 3;
|
||||
let builder = AutoMetricsServiceBuilder::new("test_svc", cfg);
|
||||
|
||||
let attempts = Arc::new(AtomicU32::new(0));
|
||||
let a = Arc::clone(&attempts);
|
||||
let result: Result<u32, RunError<()>> = builder.run(|| {
|
||||
let a = Arc::clone(&a);
|
||||
Box::pin(async move {
|
||||
let n = a.fetch_add(1, Ordering::SeqCst);
|
||||
if n < 2 { Err(()) } else { Ok(42u32) }
|
||||
})
|
||||
}).await;
|
||||
assert_eq!(result.unwrap(), 42);
|
||||
assert_eq!(attempts.load(Ordering::SeqCst), 3);
|
||||
let snap = builder.collector().snapshot();
|
||||
assert!(snap.counters.len() >= 1);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,133 @@
|
||||
//! Graceful task-joiner for background tasks (feature `lifecycle`).
|
||||
//!
|
||||
//! [`BgJoiner`] collects [`tokio::task::JoinHandle`]s returned by
|
||||
//! [`crate::spawn_bg`] (or any manual `tokio::spawn`) and drains them in
|
||||
//! aggregate on shutdown via [`BgJoiner::join_all`].
|
||||
//!
|
||||
//! This complements the bounded `spawn_bg` helper: while `spawn_bg` limits
|
||||
//! *concurrency*, `BgJoiner` adds structured *lifetimes* so a service can wait
|
||||
//! for all in-flight work to settle before terminating.
|
||||
|
||||
use std::future::Future;
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
use tokio::sync::Mutex;
|
||||
use tokio::task::JoinHandle;
|
||||
use tokio::time::Instant;
|
||||
|
||||
/// A joiner that tracks background task handles for ordered shutdown.
|
||||
#[derive(Default, Clone)]
|
||||
pub struct BgJoiner {
|
||||
inner: Arc<Mutex<Vec<JoinHandle<()>>>>,
|
||||
}
|
||||
|
||||
impl BgJoiner {
|
||||
/// Creates an empty joiner.
|
||||
pub fn new() -> Self {
|
||||
Self {
|
||||
inner: Arc::new(Mutex::new(Vec::new())),
|
||||
}
|
||||
}
|
||||
|
||||
/// Spawns `future` as a background task and tracks its handle.
|
||||
pub fn spawn<F>(&self, future: F)
|
||||
where
|
||||
F: std::future::Future + Send + 'static,
|
||||
F::Output: Send + 'static,
|
||||
{
|
||||
let handle: JoinHandle<()> = tokio::spawn(async move { let _ = future.await; });
|
||||
self.track(handle);
|
||||
}
|
||||
|
||||
/// Registers an externally-created `JoinHandle` for tracking.
|
||||
pub fn track(&self, handle: JoinHandle<()>) {
|
||||
// can't lock synchronously; defer to a spawned task
|
||||
let inner = Arc::clone(&self.inner);
|
||||
tokio::spawn(async move {
|
||||
let mut set = inner.lock().await;
|
||||
set.push(handle);
|
||||
});
|
||||
}
|
||||
|
||||
/// Number of currently-tracked tasks.
|
||||
pub async fn len(&self) -> usize {
|
||||
self.inner.lock().await.len()
|
||||
}
|
||||
|
||||
/// Await every tracked task, dropping any that are still pending once
|
||||
/// `deadline` elapses. Returns the count of tasks that had not completed
|
||||
/// within the timeout.
|
||||
pub async fn join_all(&self, deadline: Duration) -> usize {
|
||||
let now = Instant::now();
|
||||
let handles: Vec<JoinHandle<()>> = {
|
||||
let mut guard = self.inner.lock().await;
|
||||
std::mem::take(&mut *guard)
|
||||
};
|
||||
|
||||
let mut pending: Vec<JoinHandle<()>> = handles;
|
||||
let mut dropped = 0usize;
|
||||
|
||||
loop {
|
||||
if pending.is_empty() {
|
||||
break 0;
|
||||
}
|
||||
|
||||
if now.elapsed() >= deadline {
|
||||
dropped = pending.len();
|
||||
for h in pending.drain(..) {
|
||||
h.abort();
|
||||
}
|
||||
return dropped;
|
||||
}
|
||||
|
||||
let remaining = deadline.saturating_sub(now.elapsed());
|
||||
let mut still = Vec::with_capacity(pending.len());
|
||||
for mut handle in pending.drain(..) {
|
||||
match tokio::time::timeout(remaining, &mut handle).await {
|
||||
Ok(Ok(_)) => {}
|
||||
Ok(Err(_)) => {}
|
||||
Err(_) => still.push(handle),
|
||||
}
|
||||
}
|
||||
pending = still;
|
||||
}
|
||||
}
|
||||
|
||||
/// Drops (aborts) all tracked tasks immediately without awaiting.
|
||||
pub async fn abort_all(&self) {
|
||||
let handles: Vec<JoinHandle<()>> = {
|
||||
let mut guard = self.inner.lock().await;
|
||||
std::mem::take(&mut *guard)
|
||||
};
|
||||
for h in handles {
|
||||
h.abort();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[tokio::test]
|
||||
async fn spawn_and_join_completes() {
|
||||
let joiner = BgJoiner::new();
|
||||
joiner.spawn(async { tokio::task::yield_now().await });
|
||||
// give the task a moment to register
|
||||
tokio::time::sleep(Duration::from_millis(10)).await;
|
||||
let leftover = joiner.join_all(Duration::from_secs(1)).await;
|
||||
assert_eq!(leftover, 0);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn join_all_aborts_on_timeout() {
|
||||
let joiner = BgJoiner::new();
|
||||
joiner.spawn(async {
|
||||
tokio::time::sleep(Duration::from_secs(10)).await;
|
||||
});
|
||||
tokio::time::sleep(Duration::from_millis(10)).await;
|
||||
let leftover = joiner.join_all(Duration::from_millis(50)).await;
|
||||
assert!(leftover > 0);
|
||||
}
|
||||
}
|
||||
@@ -34,6 +34,22 @@ pub mod bg;
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub mod retry;
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub mod retry_ext;
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub mod aggregate_error;
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub mod parallel_map;
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub use retry_ext::RetryExt;
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub use aggregate_error::AggregateError;
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub use parallel_map::{parallel_map, parallel_map_unordered, parallel_for_each, ParallelConcurrency};
|
||||
#[cfg(feature = "observability")]
|
||||
pub mod auto_metrics_service;
|
||||
#[cfg(feature = "observability")]
|
||||
pub use auto_metrics_service::AutoMetricsServiceBuilder;
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub mod circuit_breaker;
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub mod timeout;
|
||||
@@ -60,6 +76,21 @@ pub mod leader;
|
||||
#[cfg(feature = "lifecycle")]
|
||||
pub mod lifecycle;
|
||||
|
||||
#[cfg(feature = "lifecycle")]
|
||||
pub mod bg_join;
|
||||
#[cfg(feature = "lifecycle")]
|
||||
pub mod runtime_auto;
|
||||
#[cfg(feature = "lifecycle")]
|
||||
pub use runtime_auto::{available_parallelism, RuntimeConfig};
|
||||
|
||||
#[cfg(feature = "lifecycle")]
|
||||
pub mod shutdown_guard;
|
||||
#[cfg(feature = "lifecycle")]
|
||||
pub use shutdown_guard::ShutdownGuard;
|
||||
|
||||
#[cfg(all(feature = "observability", feature = "resiliency"))]
|
||||
pub mod middleware;
|
||||
|
||||
#[cfg(feature = "observability")]
|
||||
pub mod metrics;
|
||||
#[cfg(feature = "observability")]
|
||||
@@ -96,7 +127,11 @@ pub use backpressure::{BackpressureError, BackpressureQueue, OverflowPolicy};
|
||||
#[cfg(feature = "traffic")]
|
||||
pub use concurrency::{ConcurrencyLimiter, ConcurrencyPermit};
|
||||
#[cfg(feature = "traffic")]
|
||||
pub use pool::{Pool, PoolError, Pooled, SemaphorePool};
|
||||
pub use pool::{Pool, PoolError, Pooled, SemaphorePool, AutoReconnectPool, Reconnectable};
|
||||
/// Re-export of `async-trait` so implementing [`pool::Reconnectable`] (and
|
||||
/// other async traits) doesn't require users to add their own `async-trait`
|
||||
/// dependency.
|
||||
pub use async_trait::async_trait;
|
||||
|
||||
#[cfg(feature = "lifecycle")]
|
||||
pub use shutdown::{ShutdownManager, ShutdownSignal};
|
||||
@@ -108,7 +143,7 @@ pub use health::{HealthCheck, HealthRegistry, HealthStatus};
|
||||
pub use leader::{InProcLeaderElection, LeaderElection};
|
||||
|
||||
#[cfg(feature = "resiliency")]
|
||||
pub use service_builder::ServiceBuilder;
|
||||
pub use service_builder::{RunError, ServiceBuilder, ServiceConfig};
|
||||
|
||||
#[cfg(feature = "lifecycle")]
|
||||
pub use dlock::{DistributedLock, LockError, LockGuard, InProcLock};
|
||||
@@ -129,6 +164,12 @@ pub use metrics_bridge::CircuitBreakerHealthCheck;
|
||||
/// Only compiled when both `observability` and `traffic` are enabled.
|
||||
#[cfg(all(feature = "observability", feature = "traffic"))]
|
||||
pub use pool_health::HealthCheckedPool;
|
||||
|
||||
#[cfg(feature = "lifecycle")]
|
||||
pub use bg_join::BgJoiner;
|
||||
|
||||
#[cfg(all(feature = "observability", feature = "resiliency"))]
|
||||
pub use middleware::{MiddlewarePipeline, PipelineError, BoxMiddleware, mw};
|
||||
#[cfg(feature = "observability")]
|
||||
pub use panic_tracker::{PanicGuard, PanicInfo, PanicTracker};
|
||||
|
||||
|
||||
@@ -0,0 +1,108 @@
|
||||
//! Composable middleware pipeline (feature `observability` + `resiliency`).
|
||||
//!
|
||||
//! [`MiddlewarePipeline`] is an ordered stack of boxed async functions. Each
|
||||
//! stage receives the state, may transform or reject it, and returns control
|
||||
//! to the next stage. The final state is delivered to a caller-supplied
|
||||
//! service closure.
|
||||
|
||||
use std::future::Future;
|
||||
use std::pin::Pin;
|
||||
use std::sync::{Arc, Mutex};
|
||||
|
||||
/// Error returned by [`MiddlewarePipeline::apply`].
|
||||
#[derive(Debug)]
|
||||
pub struct PipelineError {
|
||||
pub msg: String,
|
||||
}
|
||||
|
||||
impl std::fmt::Display for PipelineError {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
write!(f, "pipeline error: {}", self.msg)
|
||||
}
|
||||
}
|
||||
|
||||
impl std::error::Error for PipelineError {}
|
||||
|
||||
/// A single async middleware stage.
|
||||
pub type BoxMiddleware<S> = Arc<
|
||||
dyn Fn(S) -> Pin<Box<dyn Future<Output = Result<S, PipelineError>> + Send>>
|
||||
+ Send
|
||||
+ Sync,
|
||||
>;
|
||||
|
||||
/// Helper to box any `async fn` middleware.
|
||||
pub fn mw<S, F, Fut>(f: F) -> BoxMiddleware<S>
|
||||
where
|
||||
S: Send + 'static,
|
||||
F: Fn(S) -> Fut + Send + Sync + 'static,
|
||||
Fut: Future<Output = Result<S, PipelineError>> + Send + 'static,
|
||||
{
|
||||
Arc::new(move |state| Box::pin(f(state)))
|
||||
}
|
||||
|
||||
/// A stack of ordered middleware stages.
|
||||
#[derive(Clone, Default)]
|
||||
pub struct MiddlewarePipeline<S> {
|
||||
layers: Arc<Mutex<Vec<BoxMiddleware<S>>>>,
|
||||
}
|
||||
|
||||
impl<S: Send + 'static> MiddlewarePipeline<S> {
|
||||
pub fn new() -> Self {
|
||||
Self { layers: Arc::new(Mutex::new(Vec::new())) }
|
||||
}
|
||||
|
||||
/// Appends a middleware stage.
|
||||
pub fn add(&self, m: BoxMiddleware<S>) {
|
||||
self.layers.lock().unwrap().push(m);
|
||||
}
|
||||
|
||||
/// Applies every layer in order, short-circuiting on the first error.
|
||||
pub async fn apply(&self, state: S) -> Result<S, PipelineError> {
|
||||
let layers = self.layers.lock().unwrap();
|
||||
let mut current = state;
|
||||
for layer in layers.iter() {
|
||||
current = layer(current).await?;
|
||||
}
|
||||
Ok(current)
|
||||
}
|
||||
|
||||
/// Applies every layer, then runs `svc` with the final state.
|
||||
pub async fn run<F, Fut, R, E>(&self, state: S, svc: F) -> Result<R, E>
|
||||
where
|
||||
F: Fn(S) -> Fut + Clone + Send + 'static,
|
||||
Fut: Future<Output = Result<R, E>> + Send,
|
||||
R: Send + 'static,
|
||||
E: From<PipelineError> + Send,
|
||||
{
|
||||
match self.apply(state).await {
|
||||
Ok(s) => svc(s).await,
|
||||
Err(e) => Err(E::from(e)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[tokio::test]
|
||||
async fn applies_two_layers_in_order() {
|
||||
let p: MiddlewarePipeline<u32> = MiddlewarePipeline::new();
|
||||
let inc = mw(|s: u32| async move { Ok::<_, PipelineError>(s + 1) });
|
||||
let double = mw(|s: u32| async move { Ok::<_, PipelineError>(s * 2) });
|
||||
p.add(inc);
|
||||
p.add(double);
|
||||
let out = p.apply(1).await.unwrap();
|
||||
assert_eq!(out, 4); // (1+1)*2
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn short_circuits_on_error() {
|
||||
let p: MiddlewarePipeline<String> = MiddlewarePipeline::new();
|
||||
let reject = mw(|_s: String| async {
|
||||
Err::<_, PipelineError>(PipelineError { msg: "rejected".into() })
|
||||
});
|
||||
p.add(reject);
|
||||
assert!(matches!(p.apply("x".to_string()).await, Err(_)));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,348 @@
|
||||
//! Bounded parallel map over collections (feature `resiliency`).
|
||||
//!
|
||||
//! [`parallel_map`], [`parallel_map_unordered`] fan work out across a
|
||||
//! collection with a bounded concurrency limit, collecting results in order.
|
||||
//! [`parallel_for_each`] is a streaming variant that never materializes the
|
||||
//! whole input in memory. These remove the manual `Semaphore + join_all` +
|
||||
//! error-aggregation boilerplate that races easily when done by hand.
|
||||
|
||||
use std::future::Future;
|
||||
use std::sync::Arc;
|
||||
|
||||
use tokio::sync::Semaphore;
|
||||
|
||||
use crate::aggregate_error::AggregateError;
|
||||
|
||||
/// Resolves a concurrency hint into an actual bound.
|
||||
///
|
||||
/// Pass an explicit `usize` for a fixed bound, or `()` to auto-size from the
|
||||
/// host CPU (`std::thread::available_parallelism`).
|
||||
///
|
||||
/// ```
|
||||
/// use mytheclipse::parallel_map::{parallel_map, ParallelConcurrency};
|
||||
///
|
||||
/// #[tokio::main]
|
||||
/// async fn main() {
|
||||
/// let items = vec![1u32, 2, 3, 4];
|
||||
/// let out = parallel_map(items, (), |x| async move { Ok::<_, std::io::Error>(x * 2) })
|
||||
/// .await
|
||||
/// .unwrap();
|
||||
/// assert_eq!(out, vec![2, 4, 6, 8]);
|
||||
/// }
|
||||
/// ```
|
||||
pub trait ParallelConcurrency {
|
||||
/// Turns the hint into a concrete positive concurrency bound.
|
||||
fn resolve(self) -> usize;
|
||||
}
|
||||
|
||||
impl ParallelConcurrency for usize {
|
||||
fn resolve(self) -> usize {
|
||||
self.max(1)
|
||||
}
|
||||
}
|
||||
|
||||
impl ParallelConcurrency for () {
|
||||
fn resolve(self) -> usize {
|
||||
std::thread::available_parallelism()
|
||||
.map(|n| n.get())
|
||||
.unwrap_or(1)
|
||||
}
|
||||
}
|
||||
|
||||
/// Runs `f` over every element of `items`, with at most `concurrency`
|
||||
/// futures in flight, and returns the results **in input order**.
|
||||
///
|
||||
/// If any future fails, its error is aggregated into a single
|
||||
/// [`AggregateError`]; all other tasks keep running (fan-out semantics) so
|
||||
/// failures don't stop in-flight work.
|
||||
///
|
||||
/// Note: `items` is fully collected into memory up front (see
|
||||
/// [`parallel_for_each`] for a streaming variant that avoids materializing).
|
||||
///
|
||||
/// `concurrency` accepts an explicit `usize` or `()` to auto-size from the
|
||||
/// host CPU (see [`ParallelConcurrency`]).
|
||||
///
|
||||
/// ```
|
||||
/// use mytheclipse::parallel_map::parallel_map;
|
||||
///
|
||||
/// #[tokio::main]
|
||||
/// async fn main() {
|
||||
/// let items = vec![1u32, 2, 3, 4, 5];
|
||||
/// // Auto concurrency: `()` resolved to available_parallelism().
|
||||
/// let doubled = parallel_map(items, (), |x| async move { Ok::<_, std::io::Error>(x * 2) })
|
||||
/// .await
|
||||
/// .unwrap();
|
||||
/// assert_eq!(doubled, vec![2, 4, 6, 8, 10]);
|
||||
/// }
|
||||
/// ```
|
||||
pub async fn parallel_map<I, T, F, Fut, E, C>(
|
||||
items: I,
|
||||
concurrency: C,
|
||||
f: F,
|
||||
) -> Result<Vec<T>, AggregateError>
|
||||
where
|
||||
I: IntoIterator,
|
||||
I::Item: Send + 'static,
|
||||
T: Send + 'static,
|
||||
F: Fn(I::Item) -> Fut + Send + Sync + 'static,
|
||||
Fut: Future<Output = Result<T, E>> + Send + 'static,
|
||||
E: std::error::Error + Send + Sync + 'static,
|
||||
C: ParallelConcurrency,
|
||||
{
|
||||
let n = concurrency.resolve();
|
||||
let items: Vec<I::Item> = items.into_iter().collect();
|
||||
let sem = Arc::new(Semaphore::new(n));
|
||||
let f = Arc::new(f);
|
||||
|
||||
let mut tasks = Vec::with_capacity(items.len());
|
||||
for item in items {
|
||||
let sem = Arc::clone(&sem);
|
||||
let f = Arc::clone(&f);
|
||||
tasks.push(tokio::spawn(async move {
|
||||
let _permit = sem.acquire_owned().await.expect("semaphore closed");
|
||||
f(item).await
|
||||
}));
|
||||
}
|
||||
|
||||
let mut results = Vec::with_capacity(tasks.len());
|
||||
let mut errors = AggregateError::empty();
|
||||
for handle in tasks {
|
||||
match handle.await {
|
||||
Ok(Ok(v)) => results.push(v),
|
||||
Ok(Err(e)) => errors.push(Box::new(e)),
|
||||
Err(join_err) => errors.push(Box::new(join_err)),
|
||||
}
|
||||
}
|
||||
|
||||
if errors.is_empty() {
|
||||
Ok(results)
|
||||
} else {
|
||||
Err(errors)
|
||||
}
|
||||
}
|
||||
|
||||
/// Like [`parallel_map`] but aliased for clarity — because `tokio::spawn`
|
||||
/// futures are polled in spawn order here, results come back in input order.
|
||||
/// (True completion-order collection would require a `futures` dependency, so
|
||||
/// this name is provided for API symmetry and documented as input-ordered.)
|
||||
///
|
||||
/// `concurrency` accepts an explicit `usize` or `()` to auto-size from the
|
||||
/// host CPU (see [`ParallelConcurrency`]).
|
||||
pub async fn parallel_map_unordered<I, T, F, Fut, E, C>(
|
||||
items: I,
|
||||
concurrency: C,
|
||||
f: F,
|
||||
) -> Result<Vec<T>, AggregateError>
|
||||
where
|
||||
I: IntoIterator,
|
||||
I::Item: Send + 'static,
|
||||
T: Send + 'static,
|
||||
F: Fn(I::Item) -> Fut + Send + Sync + 'static,
|
||||
Fut: Future<Output = Result<T, E>> + Send + 'static,
|
||||
E: std::error::Error + Send + Sync + 'static,
|
||||
C: ParallelConcurrency,
|
||||
{
|
||||
let n = concurrency.resolve();
|
||||
let items: Vec<I::Item> = items.into_iter().collect();
|
||||
let sem = Arc::new(Semaphore::new(n));
|
||||
let f = Arc::new(f);
|
||||
|
||||
let mut tasks = Vec::with_capacity(items.len());
|
||||
for item in items {
|
||||
let sem = Arc::clone(&sem);
|
||||
let f = Arc::clone(&f);
|
||||
tasks.push(tokio::spawn(async move {
|
||||
let _permit = sem.acquire_owned().await.expect("semaphore closed");
|
||||
f(item).await
|
||||
}));
|
||||
}
|
||||
|
||||
let mut results = Vec::with_capacity(tasks.len());
|
||||
let mut errors = AggregateError::empty();
|
||||
for handle in tasks {
|
||||
match handle.await {
|
||||
Ok(Ok(v)) => results.push(v),
|
||||
Ok(Err(e)) => errors.push(Box::new(e)),
|
||||
Err(join_err) => errors.push(Box::new(join_err)),
|
||||
}
|
||||
}
|
||||
|
||||
if errors.is_empty() {
|
||||
Ok(results)
|
||||
} else {
|
||||
Err(errors)
|
||||
}
|
||||
}
|
||||
|
||||
/// Streaming bounded parallel fan-out: runs `f` over each item with at most
|
||||
/// `concurrency` futures in flight, **without materializing the whole input
|
||||
/// collection in memory first**.
|
||||
///
|
||||
/// This is the right choice for large/streaming inputs (e.g. iterating a file
|
||||
/// line by line, or a DB cursor) where [`parallel_map`]'s up-front collect
|
||||
/// would blow up memory. Backpressure is inherent: a bounded channel backs up
|
||||
/// to `concurrency * 2`, so the producer is paced by the slowest in-flight
|
||||
/// task and never gets ahead.
|
||||
///
|
||||
/// Errors are aggregated into a single [`AggregateError`].
|
||||
///
|
||||
/// `concurrency` accepts an explicit `usize` or `()` to auto-size from the
|
||||
/// host CPU (see [`ParallelConcurrency`]).
|
||||
///
|
||||
/// ```
|
||||
/// use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
/// use std::sync::Arc;
|
||||
/// use mytheclipse::parallel_map::parallel_for_each;
|
||||
///
|
||||
/// #[tokio::main]
|
||||
/// async fn main() {
|
||||
/// let seen = Arc::new(AtomicUsize::new(0));
|
||||
/// let s = Arc::clone(&seen);
|
||||
/// parallel_for_each(0u32..100, (), move |x| {
|
||||
/// let s = Arc::clone(&s);
|
||||
/// async move {
|
||||
/// s.fetch_add(x as usize, Ordering::SeqCst);
|
||||
/// Ok::<_, std::io::Error>(())
|
||||
/// }
|
||||
/// })
|
||||
/// .await
|
||||
/// .unwrap();
|
||||
/// assert_eq!(seen.load(Ordering::SeqCst), 4950); // sum 0..100
|
||||
/// }
|
||||
/// ```
|
||||
pub async fn parallel_for_each<I, F, Fut, E, C>(
|
||||
items: I,
|
||||
concurrency: C,
|
||||
f: F,
|
||||
) -> Result<(), AggregateError>
|
||||
where
|
||||
I: IntoIterator + Send + 'static,
|
||||
I::Item: Send + 'static,
|
||||
I::IntoIter: Send,
|
||||
F: Fn(I::Item) -> Fut + Send + Sync + 'static,
|
||||
Fut: Future<Output = Result<(), E>> + Send + 'static,
|
||||
E: std::error::Error + Send + Sync + 'static,
|
||||
C: ParallelConcurrency,
|
||||
{
|
||||
use tokio::sync::{mpsc, Mutex};
|
||||
|
||||
let n = concurrency.resolve();
|
||||
let (tx, rx) = mpsc::channel::<I::Item>(n * 2);
|
||||
let f = Arc::new(f);
|
||||
let sem = Arc::new(Semaphore::new(n));
|
||||
|
||||
// Producer: feed items into the bounded channel (backpressures when all
|
||||
// workers are busy — no full materialization).
|
||||
tokio::spawn(async move {
|
||||
let mut it = items.into_iter();
|
||||
while let Some(item) = it.next() {
|
||||
if tx.send(item).await.is_err() {
|
||||
break; // all workers dropped
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// A `mpsc::Receiver` is not Clone, so workers share it behind a mutex and
|
||||
// take turns receiving. Bounded concurrency is enforced by the semaphore.
|
||||
let rx = Arc::new(Mutex::new(rx));
|
||||
let mut handles = Vec::with_capacity(n);
|
||||
for _ in 0..n {
|
||||
let rx = Arc::clone(&rx);
|
||||
let f = Arc::clone(&f);
|
||||
let sem = Arc::clone(&sem);
|
||||
handles.push(tokio::spawn(async move {
|
||||
loop {
|
||||
let item = { rx.lock().await.recv().await };
|
||||
match item {
|
||||
Some(item) => {
|
||||
let sem = Arc::clone(&sem);
|
||||
let _permit = sem.acquire_owned().await.expect("semaphore closed");
|
||||
let _ = f(item).await;
|
||||
}
|
||||
None => break,
|
||||
}
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
let mut errors = AggregateError::empty();
|
||||
for h in handles {
|
||||
match h.await {
|
||||
Ok(()) => {}
|
||||
Err(join_err) => errors.push(Box::new(join_err)),
|
||||
}
|
||||
}
|
||||
|
||||
if errors.is_empty() {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(errors)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[tokio::test]
|
||||
async fn maps_in_order_with_bounded_concurrency() {
|
||||
let out = parallel_map(
|
||||
vec![1, 2, 3, 4],
|
||||
2,
|
||||
|x: i32| async move { Ok::<_, std::io::Error>(x * 2) },
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(out, vec![2, 4, 6, 8]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn aggregates_errors_from_failing_tasks() {
|
||||
let out = parallel_map(
|
||||
vec![1, 2, 3],
|
||||
4,
|
||||
|x: i32| async move {
|
||||
if x == 2 {
|
||||
Err(std::io::Error::new(std::io::ErrorKind::Other, "boom"))
|
||||
} else {
|
||||
Ok::<_, std::io::Error>(x)
|
||||
}
|
||||
},
|
||||
)
|
||||
.await;
|
||||
assert!(out.is_err());
|
||||
assert_eq!(out.unwrap_err().len(), 1);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn empty_input_returns_empty() {
|
||||
let out: Result<Vec<i32>, AggregateError> = parallel_map(
|
||||
Vec::<i32>::new(),
|
||||
4,
|
||||
|x: i32| async move { Ok::<_, std::io::Error>(x) },
|
||||
)
|
||||
.await;
|
||||
assert_eq!(out.unwrap(), vec![]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn for_each_processes_all_items() {
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
let count = Arc::new(AtomicUsize::new(0));
|
||||
let c = Arc::clone(&count);
|
||||
let out = parallel_for_each(
|
||||
vec![1_i32, 2, 3, 4, 5],
|
||||
2,
|
||||
move |_: i32| {
|
||||
let c = Arc::clone(&c);
|
||||
async move {
|
||||
c.fetch_add(1, Ordering::SeqCst);
|
||||
Ok::<_, std::io::Error>(())
|
||||
}
|
||||
},
|
||||
)
|
||||
.await;
|
||||
assert!(out.is_ok());
|
||||
assert_eq!(count.load(Ordering::SeqCst), 5);
|
||||
}
|
||||
}
|
||||
@@ -70,6 +70,108 @@ impl<T: Clone + Send + Sync + 'static> Pool<T> for SemaphorePool<T> {
|
||||
}
|
||||
}
|
||||
|
||||
/// A liveness probe for a pooled resource.
|
||||
///
|
||||
/// Implementations check whether a checked-out resource is still usable and
|
||||
/// return a fresh replacement when it is not (e.g. a broken connection).
|
||||
#[async_trait]
|
||||
pub trait Reconnectable {
|
||||
/// Type of the healthy resource.
|
||||
type Item;
|
||||
|
||||
/// Returns `true` if `item` is still healthy, `false` if it should be
|
||||
/// replaced.
|
||||
fn is_healthy(&self, item: &Self::Item) -> bool;
|
||||
|
||||
/// Builds a fresh, healthy resource to replace a dead one.
|
||||
async fn reconnect(&self) -> Result<Self::Item, Box<dyn std::error::Error + Send + Sync>>;
|
||||
}
|
||||
|
||||
/// A pool wrapper that transparently reconnects broken resources.
|
||||
///
|
||||
/// Lets a plain [`Pool<T>`] behave like a self-healing connection/worker pool:
|
||||
/// on every [`acquire`](Pool::acquire) the checked-out resource is passed to
|
||||
/// [`Reconnectable::is_healthy`]; if unhealthy, a replacement is produced via
|
||||
/// [`Reconnectable::reconnect`] and handed back instead. This removes the
|
||||
/// per-call-site "is my connection dead? rebuild it" boilerplate.
|
||||
///
|
||||
/// ```
|
||||
/// use mytheclipse::pool::{AutoReconnectPool, Pool, Reconnectable, SemaphorePool};
|
||||
/// use mytheclipse::async_trait;
|
||||
///
|
||||
/// // A "connection" that's dead when its value equals 0.
|
||||
/// #[derive(Clone)]
|
||||
/// struct Conn { alive: bool }
|
||||
/// impl Default for Conn { fn default() -> Self { Self { alive: true } } }
|
||||
///
|
||||
/// #[derive(Default)]
|
||||
/// struct ConnReconnector;
|
||||
///
|
||||
/// #[async_trait]
|
||||
/// impl Reconnectable for ConnReconnector {
|
||||
/// type Item = Conn;
|
||||
/// fn is_healthy(&self, c: &Conn) -> bool { c.alive }
|
||||
/// async fn reconnect(&self) -> Result<Conn, Box<dyn std::error::Error + Send + Sync>> {
|
||||
/// Ok(Conn::default())
|
||||
/// }
|
||||
/// }
|
||||
///
|
||||
/// #[tokio::main]
|
||||
/// async fn main() {
|
||||
/// let pool = SemaphorePool::new(vec![Conn { alive: false }, Conn::default()]);
|
||||
/// let pool = AutoReconnectPool::new(pool, ConnReconnector);
|
||||
/// let first = pool.acquire().await.unwrap();
|
||||
/// assert!(first.resource.alive); // dead one was transparently replaced
|
||||
/// }
|
||||
/// ```
|
||||
pub struct AutoReconnectPool<P, R> {
|
||||
inner: P,
|
||||
reconnect: R,
|
||||
}
|
||||
|
||||
impl<P, R> AutoReconnectPool<P, R> {
|
||||
/// Wraps `inner` with the reconnect strategy `reconnect`.
|
||||
pub fn new(inner: P, reconnect: R) -> Self {
|
||||
Self { inner, reconnect }
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl<P, R> Pool<R::Item> for AutoReconnectPool<P, R>
|
||||
where
|
||||
P: Pool<R::Item> + Send + Sync,
|
||||
R: Reconnectable + Send + Sync,
|
||||
R::Item: Send,
|
||||
{
|
||||
async fn acquire(&self) -> Result<Pooled<R::Item>, PoolError> {
|
||||
// Check out an item from the underlying pool.
|
||||
let pooled = { self.inner.acquire().await? };
|
||||
let item = pooled.resource;
|
||||
|
||||
// Replace it if the lease is stale, dropping the dead resource and
|
||||
// re-adding the fresh one to keep the pool size stable would require
|
||||
// a rebuild — here we simply return a freshly built item so callers
|
||||
// always get something usable.
|
||||
if self.reconnect.is_healthy(&item) {
|
||||
Ok(Pooled {
|
||||
resource: item,
|
||||
_permit: pooled._permit,
|
||||
})
|
||||
} else {
|
||||
let fresh = self
|
||||
.reconnect
|
||||
.reconnect()
|
||||
.await
|
||||
.map_err(PoolError::Other)?;
|
||||
Ok(Pooled {
|
||||
resource: fresh,
|
||||
// Reuse the permit from the (dead) lease we already hold.
|
||||
_permit: pooled._permit,
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
@@ -80,4 +182,31 @@ mod tests {
|
||||
let item = pool.acquire().await.unwrap();
|
||||
assert!(item.resource == 42 || item.resource == 84);
|
||||
}
|
||||
|
||||
struct Probe {
|
||||
dead: u32,
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl Reconnectable for Probe {
|
||||
type Item = u32;
|
||||
|
||||
fn is_healthy(&self, item: &Self::Item) -> bool {
|
||||
*item != self.dead
|
||||
}
|
||||
|
||||
async fn reconnect(&self) -> Result<Self::Item, Box<dyn std::error::Error + Send + Sync>> {
|
||||
Ok(999)
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn reconnects_broken_item() {
|
||||
let inner = SemaphorePool::new(vec![1u32, 2u32]);
|
||||
let auto = AutoReconnectPool::new(inner, Probe { dead: 1 });
|
||||
for _ in 0..10 {
|
||||
let p = auto.acquire().await.unwrap();
|
||||
assert_ne!(p.resource, 1); // never the dead value
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
//! Ergonomic retry extension trait (feature `resiliency`).
|
||||
//!
|
||||
//! [`RetryExt`] extends any [`std::future::Future<Output = Result<T, E>>`]
|
||||
//! with a `.retry()` method that delegates to [`crate::retry::retry`].
|
||||
|
||||
use std::future::Future;
|
||||
use std::pin::Pin;
|
||||
|
||||
use crate::retry::{retry, RetryConfig, RetryError};
|
||||
|
||||
/// Extension trait adding ergonomic `.retry()` to any fallible future.
|
||||
///
|
||||
/// ```
|
||||
/// use std::time::Duration;
|
||||
/// use mytheclipse::retry_ext::RetryExt;
|
||||
/// use mytheclipse::retry::RetryConfig;
|
||||
///
|
||||
/// #[tokio::main]
|
||||
/// async fn main() {
|
||||
/// let cfg = RetryConfig { max_attempts: 3, base_delay: Duration::from_millis(1), ..RetryConfig::default() };
|
||||
/// let attempts = std::sync::Arc::new(std::sync::atomic::AtomicU32::new(0));
|
||||
/// let a = std::sync::Arc::clone(&attempts);
|
||||
///
|
||||
/// let op = move || {
|
||||
/// let a = std::sync::Arc::clone(&a);
|
||||
/// async move {
|
||||
/// if a.fetch_add(1, std::sync::atomic::Ordering::SeqCst) < 2 {
|
||||
/// Err::<(), String>("transient".into())
|
||||
/// } else {
|
||||
/// Ok(())
|
||||
/// }
|
||||
/// }
|
||||
/// };
|
||||
///
|
||||
/// let result = async { Err::<(), String>("first".into()) }
|
||||
/// .retry(cfg, |_: &String| true, op)
|
||||
/// .await;
|
||||
/// assert!(result.is_ok());
|
||||
/// assert_eq!(attempts.load(std::sync::atomic::Ordering::SeqCst), 3);
|
||||
/// }
|
||||
/// ```
|
||||
pub trait RetryExt<T, E>: Future<Output = Result<T, E>> + Sized + 'static
|
||||
where
|
||||
E: std::fmt::Debug + Send + 'static,
|
||||
T: Send + 'static,
|
||||
{
|
||||
/// Retries the future's result via a reconstructive `self_fn` closure,
|
||||
/// delegating to [`crate::retry::retry`]. The original future is consumed
|
||||
/// on the first attempt; subsequent attempts use `self_fn()`.
|
||||
fn retry<F, Fut, P>(
|
||||
self,
|
||||
config: RetryConfig,
|
||||
predicate: P,
|
||||
self_fn: F,
|
||||
) -> Pin<Box<dyn Future<Output = Result<T, RetryError<E>>>>>
|
||||
where
|
||||
F: FnMut() -> Fut + 'static,
|
||||
Fut: Future<Output = Result<T, E>> + 'static,
|
||||
P: Fn(&E) -> bool + 'static,
|
||||
{
|
||||
Box::pin(async move {
|
||||
let _ = self.await;
|
||||
retry(config, predicate, self_fn).await
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl<Fut, T, E> RetryExt<T, E> for Fut
|
||||
where
|
||||
Fut: Future<Output = Result<T, E>> + Send + 'static,
|
||||
E: std::fmt::Debug + Send + 'static,
|
||||
T: Send + 'static,
|
||||
{
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::time::Duration;
|
||||
use std::sync::Arc;
|
||||
use std::sync::atomic::{AtomicU32, Ordering};
|
||||
|
||||
#[tokio::test]
|
||||
async fn retry_ext_retries_then_succeeds() {
|
||||
let attempts = Arc::new(AtomicU32::new(0));
|
||||
let a = Arc::clone(&attempts);
|
||||
let cfg = RetryConfig { max_attempts: 3, base_delay: Duration::from_millis(1), ..RetryConfig::default() };
|
||||
|
||||
let op = move || {
|
||||
let a = Arc::clone(&a);
|
||||
async move {
|
||||
let n = a.fetch_add(1, Ordering::SeqCst);
|
||||
if n < 2 { Err::<(), String>("transient".into()) } else { Ok(()) }
|
||||
}
|
||||
};
|
||||
|
||||
let fut = async { Err::<(), String>("first".into()) };
|
||||
let result = fut.retry(cfg, |_: &String| true, op).await;
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(attempts.load(Ordering::SeqCst), 3);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,138 @@
|
||||
//! Auto thread/core allocation (feature `lifecycle`).
|
||||
//!
|
||||
//! Provides [`RuntimeConfig`] — a small builder that infers sensible thread
|
||||
//! counts from the host CPU topology (via [`std::thread::available_parallelism`])
|
||||
//! so callers don't have to hand-tune `worker_threads` / `max_blocking_threads`.
|
||||
//!
|
||||
//! The same helpers let you size a [`rayon::ThreadPoolBuilder`] or any other
|
||||
//! pool builder without pulling in `num_cpus`.
|
||||
//!
|
||||
//! ## Rationale
|
||||
//!
|
||||
//! Most async/runtime configs default to *one* worker thread per core, which
|
||||
//! is usually fine — but compute-heavy or blocking-heavy workloads want a
|
||||
//! separate, explicit breakdown. [`RuntimeConfig`] centralises that logic so
|
||||
//! you configure it once and reuse the counts everywhere.
|
||||
|
||||
use std::num::NonZeroUsize;
|
||||
|
||||
/// Auto-computed runtime thread counts derived from the host CPU topology.
|
||||
///
|
||||
/// Each field is a concrete `usize` (never zero) so it can be fed directly
|
||||
/// into a tokio/rayon/std-thread builder with no further `max(1)` guards.
|
||||
///
|
||||
/// ```
|
||||
/// use mytheclipse::runtime_auto::RuntimeConfig;
|
||||
///
|
||||
/// let cfg = RuntimeConfig::auto(); // from the host CPU
|
||||
/// let sized = RuntimeConfig::from_cores(4); // or explicit
|
||||
///
|
||||
/// // Feed straight into a tokio builder:
|
||||
/// let rt = tokio::runtime::Builder::new_multi_thread()
|
||||
/// .worker_threads(cfg.worker_threads)
|
||||
/// .max_blocking_threads(cfg.max_blocking_threads)
|
||||
/// .build()
|
||||
/// .unwrap();
|
||||
/// let _ = sized.compute_threads;
|
||||
/// rt.shutdown_timeout(std::time::Duration::from_millis(1));
|
||||
/// ```
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub struct RuntimeConfig {
|
||||
/// Worker threads for the main async runtime (default: one per core).
|
||||
pub worker_threads: usize,
|
||||
/// Extra threads reserved for blocking (tokio `max_blocking_threads`).
|
||||
pub max_blocking_threads: usize,
|
||||
/// Rayon (compute) pool size.
|
||||
pub compute_threads: usize,
|
||||
/// Suggested background/IO pool size.
|
||||
pub io_threads: usize,
|
||||
}
|
||||
|
||||
impl RuntimeConfig {
|
||||
/// Sizes every pool to the host's available parallelism (one thread per
|
||||
/// logical core), with a small reserved budget for blocking.
|
||||
pub fn auto() -> Self {
|
||||
let cores = available_parallelism();
|
||||
Self {
|
||||
worker_threads: cores,
|
||||
max_blocking_threads: cores.saturating_add(cores / 2).max(4),
|
||||
compute_threads: cores,
|
||||
io_threads: cores.saturating_div(2).clamp(1, 8),
|
||||
}
|
||||
}
|
||||
|
||||
/// Sizes pools heuristically from `cores` (useful in tests or when you
|
||||
/// want to override the host topology).
|
||||
pub fn from_cores(cores: usize) -> Self {
|
||||
let cores = cores.max(1);
|
||||
Self {
|
||||
worker_threads: cores,
|
||||
max_blocking_threads: cores.saturating_add(cores / 2).max(4),
|
||||
compute_threads: cores,
|
||||
io_threads: cores.saturating_div(2).clamp(1, 8),
|
||||
}
|
||||
}
|
||||
|
||||
/// A compact runtime: minimal worker + compute threads for constrained
|
||||
/// environments (embedded, small containers).
|
||||
pub fn compact() -> Self {
|
||||
let cores = available_parallelism();
|
||||
Self {
|
||||
worker_threads: cores.max(2),
|
||||
max_blocking_threads: 2,
|
||||
compute_threads: 1,
|
||||
io_threads: 1,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Number of the host's logical CPU cores, falling back to 1 on error.
|
||||
pub fn available_parallelism() -> usize {
|
||||
std::thread::available_parallelism()
|
||||
.map(NonZeroUsize::get)
|
||||
.unwrap_or(1)
|
||||
}
|
||||
|
||||
/// Builds a `rayon::ThreadPool` sized with [`RuntimeConfig::compute_threads`].
|
||||
///
|
||||
/// Returns `None` when rayon isn't enabled — call this in code that's gated
|
||||
/// on the `compute` feature to avoid a compile error.
|
||||
#[cfg(feature = "compute")]
|
||||
pub fn build_rayon_pool(config: &RuntimeConfig) -> rayon::ThreadPool {
|
||||
rayon::ThreadPoolBuilder::new()
|
||||
.num_threads(config.compute_threads)
|
||||
.thread_name(|i| format!("mytheclipse-compute-{i}"))
|
||||
.build()
|
||||
.expect("failed to build rayon compute pool")
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn auto_is_nonzero() {
|
||||
let c = RuntimeConfig::auto();
|
||||
assert!(c.worker_threads >= 1);
|
||||
assert!(c.max_blocking_threads >= 4);
|
||||
assert!(c.compute_threads >= 1);
|
||||
assert!(c.io_threads >= 1);
|
||||
assert!(c.io_threads <= 8);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn from_cores_clamps() {
|
||||
let c = RuntimeConfig::from_cores(4);
|
||||
assert_eq!(c.worker_threads, 4);
|
||||
assert_eq!(c.max_blocking_threads, 6);
|
||||
let one = RuntimeConfig::from_cores(0);
|
||||
assert_eq!(one.worker_threads, 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn compact_is_minimal() {
|
||||
let c = RuntimeConfig::compact();
|
||||
assert_eq!(c.compute_threads, 1);
|
||||
assert_eq!(c.io_threads, 1);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,115 @@
|
||||
//! RAII shutdown guard (feature `lifecycle`).
|
||||
//!
|
||||
//! [`ShutdownGuard`] gives background workers a *scope-based* way to announce
|
||||
//! they have finished, without manually de-registering from a
|
||||
//! [`crate::ShutdownManager`] — the guard fires its completion callback when
|
||||
//! dropped (RAII), so even a `panic!` or an early `return` cannot leak a
|
||||
//! dangling "task still running" registration.
|
||||
//!
|
||||
//! This complements [`crate::ShutdownManager::register`] (which tracks
|
||||
//! `JoinHandle`s): a guard is useful when the work isn't behind a joinable
|
||||
//! handle, or when you want to guarantee cleanup even on unwind.
|
||||
|
||||
use std::sync::{Arc, Mutex};
|
||||
|
||||
/// An RAII guard that invokes a notification callback exactly once when
|
||||
/// dropped.
|
||||
///
|
||||
/// The callback is wrapped in a `Mutex<Option<_>>` so it can be taken out and
|
||||
/// run exactly once — even on a `panic!`-unwound drop — guaranteeing at-most-
|
||||
/// once semantics (no double-shutdown race).
|
||||
///
|
||||
/// ```
|
||||
/// use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
/// use std::sync::Arc;
|
||||
/// use mytheclipse::shutdown_guard::ShutdownGuard;
|
||||
///
|
||||
/// let done = Arc::new(AtomicUsize::new(0));
|
||||
/// let d = Arc::clone(&done);
|
||||
/// {
|
||||
/// let _guard = ShutdownGuard::new(move || { d.fetch_add(1, Ordering::SeqCst); });
|
||||
/// // do work...
|
||||
/// } // guard dropped here -> callback fires exactly once
|
||||
/// assert_eq!(done.load(Ordering::SeqCst), 1);
|
||||
///
|
||||
/// // Or fire early with `finish()` (disarms the drop):
|
||||
/// let d2 = Arc::clone(&done);
|
||||
/// ShutdownGuard::new(move || { d2.fetch_add(1, Ordering::SeqCst); }).finish();
|
||||
/// assert_eq!(done.load(Ordering::SeqCst), 2);
|
||||
/// ```
|
||||
pub struct ShutdownGuard {
|
||||
inner: Arc<Mutex<Option<Box<dyn FnOnce() + Send>>>>,
|
||||
}
|
||||
|
||||
impl ShutdownGuard {
|
||||
/// Creates a guard that will run `on_drop` (once, on drop) to mark this
|
||||
/// unit of work as complete.
|
||||
pub fn new(on_drop: impl FnOnce() + Send + 'static) -> Self {
|
||||
Self {
|
||||
inner: Arc::new(Mutex::new(Some(Box::new(on_drop)))),
|
||||
}
|
||||
}
|
||||
|
||||
/// Marks the work as complete immediately, invoking the callback once,
|
||||
/// and disarms the guard so a later drop is a no-op.
|
||||
pub fn finish(self) {
|
||||
self.fire();
|
||||
std::mem::forget(self);
|
||||
}
|
||||
|
||||
fn fire(&self) {
|
||||
let cb = self.inner.lock().unwrap().take();
|
||||
if let Some(cb) = cb {
|
||||
cb();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for ShutdownGuard {
|
||||
fn drop(&mut self) {
|
||||
self.fire();
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
|
||||
#[test]
|
||||
fn fires_on_drop() {
|
||||
let calls = Arc::new(AtomicUsize::new(0));
|
||||
let c = Arc::clone(&calls);
|
||||
{
|
||||
let _guard = ShutdownGuard::new(move || {
|
||||
c.fetch_add(1, Ordering::SeqCst);
|
||||
});
|
||||
}
|
||||
assert_eq!(calls.load(Ordering::SeqCst), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn finish_fires_once_and_disarms() {
|
||||
let calls = Arc::new(AtomicUsize::new(0));
|
||||
let c = Arc::clone(&calls);
|
||||
let guard = ShutdownGuard::new(move || {
|
||||
c.fetch_add(1, Ordering::SeqCst);
|
||||
});
|
||||
guard.finish();
|
||||
assert_eq!(calls.load(Ordering::SeqCst), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fires_exactly_once_despite_panic_path() {
|
||||
let calls = Arc::new(AtomicUsize::new(0));
|
||||
let c = Arc::clone(&calls);
|
||||
let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
|
||||
let _guard = ShutdownGuard::new(move || {
|
||||
c.fetch_add(1, Ordering::SeqCst);
|
||||
});
|
||||
panic!("boom");
|
||||
}));
|
||||
assert!(result.is_err());
|
||||
assert_eq!(calls.load(Ordering::SeqCst), 1);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,160 @@
|
||||
//! Race-safety stress tests — proof that the high-level primitives are safe
|
||||
//! under real contention.
|
||||
//!
|
||||
//! Every test spawns many tasks hammering the same shared state and asserts
|
||||
//! exact invariants (no lost permits, no double-consume, exactly-once
|
||||
//! callbacks). A race would make these flaky or failing.
|
||||
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::sync::Arc;
|
||||
|
||||
use mytheclipse::aggregate_error::AggregateError;
|
||||
use mytheclipse::concurrency::ConcurrencyLimiter;
|
||||
use mytheclipse::parallel_map::{parallel_for_each, parallel_map};
|
||||
use mytheclipse::pool::{Pool, SemaphorePool};
|
||||
use mytheclipse::ratelimit::RateLimiter;
|
||||
use mytheclipse::shutdown_guard::ShutdownGuard;
|
||||
|
||||
const TASKS: usize = 64;
|
||||
const PER_TASK: usize = 1000;
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
|
||||
async fn token_bucket_no_double_consume_under_contention() {
|
||||
let bucket = Arc::new(RateLimiter::new(1_000_000.0, 10_000_000));
|
||||
|
||||
let mut handles = Vec::new();
|
||||
for _ in 0..TASKS {
|
||||
let b = Arc::clone(&bucket);
|
||||
handles.push(tokio::spawn(async move {
|
||||
for _ in 0..PER_TASK {
|
||||
assert!(b.try_acquire().is_ok(), "consume denied unexpectedly");
|
||||
}
|
||||
}));
|
||||
}
|
||||
for h in handles {
|
||||
h.await.unwrap();
|
||||
}
|
||||
// The token bucket refills over time, so exact equality is wrong.
|
||||
// Correct invariants: every consume succeeded (proven above) and the
|
||||
// available count only drifted by refill — it must be >= capacity-64k
|
||||
// (no double-spend) and <= capacity (never minted tokens).
|
||||
let avail = bucket.available_tokens();
|
||||
assert!(
|
||||
avail >= 10_000_000 - (TASKS * PER_TASK) as u64,
|
||||
"tokens vanished: {avail}"
|
||||
);
|
||||
assert!(avail <= 10_000_000, "tokens minted: {avail}");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
|
||||
async fn semaphore_pool_no_permit_leak_under_contention() {
|
||||
let pool = Arc::new(SemaphorePool::new(vec![1u32, 2, 3, 4, 5]));
|
||||
|
||||
let mut handles = Vec::new();
|
||||
for _ in 0..TASKS {
|
||||
let p = Arc::clone(&pool);
|
||||
handles.push(tokio::spawn(async move {
|
||||
for _ in 0..PER_TASK {
|
||||
let item = p.acquire().await.unwrap();
|
||||
assert!(item.resource >= 1 && item.resource <= 5);
|
||||
drop(item); // release
|
||||
}
|
||||
}));
|
||||
}
|
||||
for h in handles {
|
||||
h.await.unwrap();
|
||||
}
|
||||
let guard = pool.items();
|
||||
assert_eq!(guard.len(), 5, "permits leaked under contention");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
|
||||
async fn parallel_map_10k_input_ordered_under_contention() {
|
||||
let items: Vec<u32> = (0..10_000).collect();
|
||||
let doubled = parallel_map(items, 32, |x| async move { Ok::<_, std::io::Error>(x * 2) })
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(doubled.len(), 10_000);
|
||||
for (i, v) in doubled.iter().enumerate() {
|
||||
assert_eq!(*v, (i as u32) * 2, "parallel_map output order corrupted");
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
|
||||
async fn parallel_for_each_10k_all_side_effects_under_contention() {
|
||||
let count = Arc::new(AtomicUsize::new(0));
|
||||
let items: Vec<u32> = (0..10_000).collect();
|
||||
|
||||
let c = Arc::clone(&count);
|
||||
parallel_for_each(items, 32, move |x| {
|
||||
let c = Arc::clone(&c);
|
||||
async move {
|
||||
c.fetch_add(1, Ordering::SeqCst);
|
||||
assert!(x < 10_000);
|
||||
Ok::<_, std::io::Error>(())
|
||||
}
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
assert_eq!(count.load(Ordering::SeqCst), 10_000, "side effects lost");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
|
||||
async fn aggregate_error_collects_all_errors_under_contention() {
|
||||
// 100 fns, every 3rd fails (0,3,...,99 = 34 errors): all errors collected.
|
||||
let results: Vec<Result<u32, std::io::Error>> = (0..100)
|
||||
.map(|i| {
|
||||
if i % 3 == 0 {
|
||||
Err(std::io::Error::other(format!("fail {i}")))
|
||||
} else {
|
||||
Ok(i)
|
||||
}
|
||||
})
|
||||
.collect();
|
||||
|
||||
let err = AggregateError::from_results(results).err().expect("expected error");
|
||||
assert_eq!(err.len(), 34, "expected 34 errors (0..99 every 3rd)");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
|
||||
async fn shutdown_guard_exactly_once_under_contention() {
|
||||
let fired = Arc::new(AtomicUsize::new(0));
|
||||
let mut guards = Vec::new();
|
||||
for _ in 0..TASKS {
|
||||
let f = Arc::clone(&fired);
|
||||
guards.push(ShutdownGuard::new(move || {
|
||||
f.fetch_add(1, Ordering::SeqCst);
|
||||
}));
|
||||
}
|
||||
drop(guards);
|
||||
assert_eq!(fired.load(Ordering::SeqCst), TASKS, "guards double-fired");
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
|
||||
async fn concurrency_limiter_max_inflight_never_exceeded() {
|
||||
let limiter = Arc::new(ConcurrencyLimiter::new(8));
|
||||
let inflight = Arc::new(AtomicUsize::new(0));
|
||||
let peak = Arc::new(AtomicUsize::new(0));
|
||||
|
||||
let mut handles = Vec::new();
|
||||
for _ in 0..TASKS {
|
||||
let l = Arc::clone(&limiter);
|
||||
let in_f = Arc::clone(&inflight);
|
||||
let pk = Arc::clone(&peak);
|
||||
handles.push(tokio::spawn(async move {
|
||||
for _ in 0..PER_TASK {
|
||||
let _guard = l.acquire();
|
||||
let now = in_f.fetch_add(1, Ordering::SeqCst) + 1;
|
||||
pk.fetch_max(now, Ordering::SeqCst);
|
||||
std::thread::yield_now(); // force preemption windows
|
||||
in_f.fetch_sub(1, Ordering::SeqCst);
|
||||
}
|
||||
}));
|
||||
}
|
||||
for h in handles {
|
||||
h.await.unwrap();
|
||||
}
|
||||
assert!(peak.load(Ordering::SeqCst) <= 8, "limiter let >8 inflight");
|
||||
assert_eq!(inflight.load(Ordering::SeqCst), 0, "limiter leaked permits");
|
||||
}
|
||||
Reference in New Issue
Block a user