Release/0.1.0

[GioeleB00]

Release: v0.1.0-alpha — Public Preview of AsyncFlow

Why

First public preview of the AsyncFlow simulator. This sets the baseline for community feedback and early adopters.

What’s included (high-level)

• Core simulator (SimPy-based) for async, distributed backends.

• Topology graph: client, servers, load balancer, network edges with probabilistic latency.

• Stochastic workload (active users × requests/min).

• Inputs: full YAML schema or a Python builder with identical semantics.

• ResultsAnalyzer with plotting helpers:

  • Latency histogram (mean/P50/P95/P99).
  • Throughput with overlays (mean/P95/max).
  • Per-server Ready Queue and RAM usage.

• Examples:

  • Single server (YAML and builder).
  • Load balancer + two servers (builder and YAML).

• Dev tooling:

  • scripts/dev_setup.(sh|ps1) (one-shot post-clone).
  • scripts/quality_check.(sh|ps1) (Ruff + MyPy).
  • scripts/run_tests.(sh|ps1) (unit/integration with coverage).
  • scripts/run_sys_tests.(sh|ps1) (system tests).

• CI:

  • Main-branch workflow gating on lint, type check, unit/integration and system tests.

Known limitations (tracked for v0.1 line)

• Simplified network (no bandwidth/payload/TCP).
• One event loop per server (no multi-process model yet).
• Linear endpoint pipelines (no branching/fan-out).
• No autoscaling/backpressure policies.
• Sampling cadence can miss ultra-short spikes.

---

How reviewers can validate quickly

Local (Linux/macOS/WSL):

bash scripts/dev_setup.sh
bash scripts/run_tests.sh         # unit + integration
bash scripts/run_sys_tests.sh     # system tests

Local (Windows PowerShell):

.\scripts\dev_setup.ps1
.\scripts\run_tests.ps1
.\scripts\run_sys_tests.ps1

Try examples (plots saved next to the script):

• Single server from YAML: see examples/ (prints latency + saves a 2×2 PNG).
• Load balancer (2 servers) from builder: analogous 2×2 PNG plus per-server plots.

CI on this PR runs Ruff, MyPy, unit/integration and system tests. All must pass for merge.

---

Breaking changes

None. This is the first public preview; public modules are intentionally small and explicit.

Documentation

• Updated README with Quick Start (YAML + builder), development setup, and scripts.
• Example scripts demonstrate recommended public APIs and plotting.

Release notes (user-facing)

• New: AsyncFlow simulator (SimPy) with async server event-loop semantics (CPU/RAM/IO steps).
• New: Topology graph (client, servers, load balancer, edges with stochastic latency).
• New: Stochastic workload generator (active users × req/min).
• New: ResultsAnalyzer with latency/throughput and per-server metrics plots.
• New: Examples (single server, LB with two servers) and developer scripts.
• CI: main branch gated by lint, type check, unit/integration, and system tests.

---

Risks & mitigations

• Platform diffs in dependency resolution: dev setup intentionally deletes poetry.lock to avoid cross-platform lock drift; CI pins Python 3.12 and installs with --with dev.
• Matplotlib headless: CI sets MPLBACKEND=Agg.

---

Checklist

• Code compiles and examples run (plots generated).
• Ruff/MyPy clean on src/ and tests/.
• Unit + integration tests pass locally.
• System tests pass locally.
• CI green on this PR (all jobs, including system).
• README updated (Quick Start, scripts, examples).
• Release tag/version set to v0.1.0-alpha.

Reviewer focus: public API boundaries (asyncflow.{analysis,components,enums,settings,workload}), examples’ clarity, CI gating behavior, and overall dev-onboarding flow.

---