refactor: remove cycle checking becuase API prevents cycles

This commit is contained in:
swaits committed 2025-10-08 14:28:54 -06:00
1 parent 683579a18b
commit 802e584646
11 files changed
+543 -75

No files matched your search

+87 -3
View File
@@ -6,9 +6,9 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Rust Version](https://img.shields.io/badge/rust-1.81+-blue.svg)](https://www.rust-lang.org)
A minimal, type-safe, runtime-agnostic async DAG (Directed Acyclic Graph) executor with compile-time dependency validation and true parallel execution.
A minimal, type-safe, runtime-agnostic async DAG (Directed Acyclic Graph) executor with compile-time cycle prevention, compile-time dependency validation, and true parallel execution.
**Why dagx?** No custom scheduler—just battle-tested primitives (channels, async/await). Compile-time type safety catches wiring errors before runtime. Works with ANY async runtime (Tokio, async-std, smol). Simple API: `#[task]`, `add_task()`, `depends_on()`—that's it. **4-148x faster than dagrs** across all workloads with sub-microsecond overhead per task.
**Why dagx?** **Cycles are impossible** via the type system—zero runtime overhead. No custom scheduler—just battle-tested primitives (channels, async/await). Compile-time type safety catches wiring errors before runtime. Works with ANY async runtime (Tokio, async-std, smol). Simple API: `#[task]`, `add_task()`, `depends_on()`—that's it. **4-148x faster than dagrs** across all workloads with sub-microsecond overhead per task.
<!--toc:start-->
@@ -65,6 +65,7 @@ A minimal, type-safe, runtime-agnostic async DAG (Directed Acyclic Graph) execut
## Features
- **Compile-time cycle prevention**: The type system makes cycles **impossible**—no runtime checks needed! See [Compile-Time Cycle Prevention](#compile-time-cycle-prevention) below.
- **Compile-time type safety**: Dependencies are validated at compile time through the type system. No `dyn Any`, no downcasting, no runtime type errors.
- **Runtime-agnostic**: Works with any async runtime (Tokio, async-std, smol, and more)
- **True parallelism**: Tasks spawn to multiple threads for genuine parallel execution
@@ -75,6 +76,89 @@ A minimal, type-safe, runtime-agnostic async DAG (Directed Acyclic Graph) execut
- **Comprehensive error handling**: Result-based errors with actionable messages
- **Optional tracing**: Zero-cost observability via optional `tracing` feature flag
## Compile-Time Cycle Prevention
**dagx guarantees acyclic graphs at compile time with zero runtime overhead.** Unlike other DAG libraries that detect cycles at runtime, dagx uses Rust's type system to make cycles impossible to express in the first place.
### Why This Matters
Most DAG libraries check for cycles when you execute the graph:
```rust
// Other libraries: cycle detected at RUNTIME
let dag = DagRunner::new();
let a = dag.add_task(TaskA);
let b = dag.add_task(TaskB);
a.depends_on(b);
b.depends_on(a); // Compiles fine...
dag.run().await?; // ❌ Error: "Cycle detected!" (at runtime)
```
**dagx prevents this at compile time:**
```rust
// dagx: cycle prevented at COMPILE TIME
let dag = DagRunner::new();
let a_builder = dag.add_task(TaskA);
let b_builder = dag.add_task(TaskB);
// To make A depend on B, we need B as a TaskHandle.
// But calling depends_on() consumes the builder!
let b_handle = b_builder.depends_on(&some_source);
// Now we can't make B depend on A because b_builder was moved!
// This won't compile:
// a_builder.depends_on(&b_handle); // ✓ OK: A→B
// b_handle.depends_on(&a_handle); // ❌ ERROR: TaskHandle has no depends_on() method!
```
### How It Works: The Type-State Pattern
dagx uses two types to enforce acyclic structure:
1. **`TaskBuilder<T, Deps>`**: Mutable builder that can have dependencies added via `depends_on()`
- Consumed (moved) when you call `depends_on()` or convert to `TaskHandle`
- Can only be used once for wiring
2. **`TaskHandle<T>`**: Immutable reference to a finalized task
- Copy type (just wraps a task ID)
- Can be used as a dependency for other tasks
- **Has no `depends_on()` method** - can't be modified after creation
This creates an impossible ordering constraint for cycles:
```rust
// Attempting a cycle A→B→A:
let a_builder = dag.add_task(TaskA); // TaskBuilder
let b_builder = dag.add_task(TaskB); // TaskBuilder
// To wire A→B, we need B as a TaskHandle
let b_handle = b_builder.into(); // Convert B to TaskHandle (consumes builder)
// To wire B→A, we need A as a TaskHandle
let a_handle = a_builder.depends_on(&b_handle); // A now depends on B
// Now if we try to complete the cycle:
// a_handle.depends_on(&...); // ❌ ERROR: no method named `depends_on` found
```
**The type system enforces strict topological ordering!** You can't create a `TaskHandle` until all its dependencies exist as handles, which prevents cycles.
### Proof & Examples
See [`src/cycle_prevention.rs`](src/cycle_prevention.rs) for comprehensive documentation with `compile_fail` tests proving various cycle attempts don't compile.
See [`tests/cycle_prevention.rs`](tests/cycle_prevention.rs) for runtime tests demonstrating the type-state pattern in action.
### Benefits
- ✅ **Zero runtime cost**: No cycle detection code to execute
- ✅ **Catches errors early**: Cycles are caught at compile time, not in production
- ✅ **Compiler-verified**: The type system proves your graph is acyclic
- ✅ **No mental overhead**: You can't accidentally create cycles even if you try
This is a true **zero-cost abstraction**—the type system provides safety guarantees without any runtime checks or performance penalty.
## Optional Tracing Support
dagx provides optional observability through the `tracing` crate with **zero runtime overhead when disabled**. The tracing instrumentation is conditionally compiled using feature flags, meaning when the feature is off, the logging code doesn't exist in the compiled binary at all.
@@ -108,7 +192,7 @@ fmt()
- **INFO**: DAG execution start/completion
- **DEBUG**: Task additions, dependency wiring, layer computation
- **TRACE**: Individual task execution (inline vs spawned), detailed execution flow
- **ERROR**: Panics, cycles, type errors
- **ERROR**: Task panics, concurrent execution attempts
Run with different levels: