root-cause-tracing

Files (2)

• SKILL.md
• find-polluter.sh

SKILL.md (first lines)

# Root Cause Tracing

## Overview

Bugs often manifest deep in the call stack (git init in wrong directory, file created in wrong location, database opened with wrong path). Your instinct is to fix where the error appears, but that's treating a symptom.

**Core principle:** Trace backward through the call chain until you find the original trigger, then fix at the source.

## When to Use

```dot
digraph when_to_use {
    "Bug appears deep in stack?" [shape=diamond];
    "Can trace backwards?" [shape=diamond];
    "Fix at symptom point" [shape=box];
    "Trace to original trigger" [shape=box];
    "BETTER: Also add defense-in-depth" [shape=box];

    "Bug appears deep in stack?" -> "Can trace backwards?" [label="yes"];
    "Can trace backwards?" -> "Trace to original trigger" [label="yes"];
    "Can trace backwards?" -> "Fix at symptom point" [label="no - dead end"];
    "Trace to original trigger" -> "BETTER: Also add defense-in-depth";
}
```

**Use when:**
- Error happens deep in execution (not at entry point)
- Stack trace shows long call chain
- Unclear where invalid data originated
- Need to find which test/code triggers the problem

## The Tracing Process

### 1. Observe the Symptom
```
Error: git init failed in C:\Users\developer\project\src\MyProject.Core
```

### 2. Find Immediate Cause
**What code directly causes this?**
```csharp
await ProcessHelper.RunAsync("git", "init", workingDirectory: projectDir);
```

### 3. Ask: What Called This?
```csharp
WorktreeManager.CreateSessionWorktreeAsync(projectDir, sessionId)
  → called by Session.InitializeWorkspaceAsync()
  → called by Session.CreateAsync()
  → called by test at Project.CreateAsync()
```

### 4. Keep Tracing Up
**What value was passed?**
- `projectDir = ""` (empty string!)
- Empty string as working directory resolves to current directory
- That's the source code directory!

### 5. Find Original Trigger
**Where did empty string come from?**
```csharp
var context = SetupCoreTest(); // Returns { TempDir = "" }
await Project.CreateAsync("name", context.TempDir); // Accessed before setup!
```

## Adding Stack Traces

When you can't trace manually, add instrumentation:

```csharp
// Before the problematic operation
public static async Task GitInitAsync(string directory)
{
    var stackTrace = Environment.StackTrace;
    Console.Error.WriteLine($"DEBUG git init: {new {
        Directory = directory,
        CurrentDirectory = Environment.CurrentDirectory,
        Environment = Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT"),
        StackTrace = stackTrace
    }}");

    await ProcessHelper.RunAsync("git", "init", workingDirectory: directory);
}
```

**Critical:** Use `Console.Error.WriteLine()` in tests (not ILogger - may not show)

**Run and capture:**
```bash
dotnet test --logger "console;verbosity=detailed" 2>&1 | findstr "DEBUG git init"
```

**Analyze stack traces:**
- Look for test file names
- Find the line number triggering the call
- Identify the pattern (same test? same parameter?)

## Finding Which Test Causes Pollution

If something appears during tests but you don't know which test:

Use the bisection script: @find-polluter.sh

```bash
./find-polluter.sh '.git' 'src/**/*.test.ts'
```

Runs tests one-by-one, stops at first polluter. See script for usage.

## Real Example: Empty projectDir

**Symptom:** `.git` created in `packages/core/` (source code)

**Trace chain:**
1. `git init` runs in current directory ← empty working directory parameter
2. WorktreeManager called with empty projectDir
3. Session.CreateAsync() passed empty string
4. Test accessed `context.TempDir` before setup
5. SetupCoreTest() returns `{ TempDir = "" }` initially

From alexsandrocruz/ZenPowers, MIT.

More from alexsandrocruz/ZenPowers