Commit dca6833
committed
feat(libstore): add detailed cycle detection for build errors
Implements comprehensive cycle detection that shows users exactly which
files create circular dependencies when a build fails. This dramatically
improves the developer experience when debugging dependency cycles.
## What's Added
**findCycles() Method** (dependency-graph-impl.hh):
- DFS-based cycle detection using BGL's depth_first_search
- Custom visitor that tracks back edges to identify cycles
- Returns all cycles found in the graph (not just the first one)
- Each cycle is represented as a path: [A, B, C, A]
**findDependencyCycles() Function** (build/find-cycles.hh):
High-level API for cycle detection in store paths:
1. Builds StorePath-level dependency graph via buildStorePathGraphFromScan()
2. Detects cycles using the DFS algorithm
3. Annotates each edge in the cycle with the files that created it
4. Returns human-readable cycle descriptions with file paths
Example output format:
```
Cycle 1:
→ /nix/store/abc-pkg-a
(via /lib/libfoo.so)
→ /nix/store/def-pkg-b
(via /bin/bar)
→ /nix/store/abc-pkg-a
```
**Enhanced Build Error Reporting** (derivation-builder.cc):
- Wraps output registration in try-catch blocks
- On cycle detection, calls analyzeCyclesAndThrow()
- Scans all outputs to find exact file locations
- Generates detailed error messages showing:
* All cycles found (not just one)
* Specific files creating each dependency
* Helpful hints about preserved temp paths for debugging
**analyzeCyclesAndThrow() Helper**:
- Takes output path information and referenceable paths
- Invokes findDependencyCycles() on each output
- Aggregates all cycles across outputs
- Throws BuildError with comprehensive cycle details
- Falls back to original error if no detailed cycles found
## Comprehensive Testing
**find-cycles.cc**: Parameterized tests covering:
- Empty graphs and single edges (no cycles)
- Simple 2-node cycles: A→B→A
- Multi-node cycles: A→B→C→A, A→B→C→D→A
- Multiple disjoint cycles in same graph
- Self-loops: A→A
- Chains without cycles (negative cases)
- Complex graphs with cycles + non-cycle edges
- Cycles with additional incoming/outgoing edges
Uses GoogleTest's INSTANTIATE_TEST_CASE_P for comprehensive coverage.
## Implementation Notes
- **DFS Back-Edge Detection**: Standard algorithm for finding all cycles
- Discovers vertices and tracks the DFS path
- Back edges indicate cycles; extract path from stack
- Finds all cycles in one traversal
- **File-Level Attribution**:
- Uses FileListEdgeProperty to store file lists on edges
- buildStorePathGraphFromScan() populates this during scanning
- Enables showing "which file caused this dependency"
- **Error Recovery**: If scanForReferencesDeep fails to find detailed cycles,
re-throws original exception rather than suppressing it
- **Performance**: Only runs detailed cycle analysis on error path,
no overhead for successful builds
## User Experience
Before: "cycle detected in build of 'foo' in the references of output 'out' from output 'dev'"
After: Shows all cycles with file paths, making it immediately clear which
specific files need to be fixed to break the circular dependency.
This is part of the better-cycle-errors-v2 effort to improve Nix's
error messages for one of the most confusing build failure scenarios.1 parent 4c04a5e commit dca6833
File tree
7 files changed
+346
-38
lines changed- src
- libstore-tests
- libstore
- build
- include/nix/store
- build
- unix/build
7 files changed
+346
-38
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
| 65 | + | |
65 | 66 | | |
66 | 67 | | |
67 | 68 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
267 | 267 | | |
268 | 268 | | |
269 | 269 | | |
| 270 | + | |
270 | 271 | | |
271 | 272 | | |
272 | 273 | | |
| |||
0 commit comments