Skip to content

AvinashP/AgentsAtlas / skills/debugging

debugging

Verified

Use when encountering any bug, test failure, error, or unexpected behavior - before proposing fixes. Requires root cause investigation first.

FileKindSize
SKILL.mdskill md6.2 KB
examples.mdmarkdown6.1 KB
root-cause-tracing.mdmarkdown4.4 KB
strategies.mdmarkdown5.6 KB

root-cause-tracing.md

View on GitHub
# Root Cause Tracing

Trace bugs backward through the call chain to find the original trigger.

## Overview

Bugs often manifest deep in the call stack (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

- 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 /Users/project/packages/core
```

### 2. Find Immediate Cause
**What code directly causes this?**
```typescript
await execFileAsync('git', ['init'], { cwd: projectDir });
```

### 3. Ask: What Called This?
```typescript
WorktreeManager.createSessionWorktree(projectDir, sessionId)
  → called by Session.initializeWorkspace()
  → called by Session.create()
  → called by test at Project.create()
```

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

### 5. Find Original Trigger
**Where did empty string come from?**
```typescript
const context = setupCoreTest(); // Returns { tempDir: '' }
Project.create('name', context.tempDir); // Accessed before beforeEach!
```

## Adding Stack Traces

When you can't trace manually, add instrumentation:

```typescript
// Before the problematic operation
async function gitInit(directory: string) {
  const stack = new Error().stack;
  console.error('DEBUG git init:', {
    directory,
    cwd: process.cwd(),
    stack,
  });

  await execFileAsync('git', ['init'], { cwd: directory });
}
```

**Critical:** Use `console.error()` in tests (not logger - may not show)

**Run and capture:**
```bash
npm test 2>&1 | grep '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?)

## Real Example: Empty projectDir

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

**Trace chain:**
1. `git init` runs in `process.cwd()` ← empty cwd parameter
2. WorktreeManager called with empty projectDir
3. Session.create() passed empty string
4. Test accessed `context.tempDir` before beforeEach
5. setupCoreTest() returns `{ tempDir: '' }` initially

**Root cause:** Top-level variable initialization accessing empty value

**Fix:** Made tempDir a getter that throws if accessed before beforeEach

**Also added defense-in-depth:**
- Layer 1: Project.create() validates directory
- Layer 2: WorkspaceManager validates not empty
- Layer 3: NODE_ENV guard refuses git init outside tmpdir
- Layer 4: Stack trace logging before git init

## Defense in Depth

After finding root cause, add validation at multiple layers:

```typescript
// Layer 1: Entry point validation
function createProject(directory: string) {
  if (!directory?.trim()) {
    throw new Error('Directory required');
  }
  // ...
}

// Layer 2: Business logic validation
class WorkspaceManager {
  async create(path: string) {
    if (!path || path === process.cwd()) {
      throw new Error('Invalid workspace path');
    }
    // ...
  }
}

// Layer 3: Environment guards
function gitInit(directory: string) {
  if (process.env.NODE_ENV === 'test' && !directory.includes('/tmp')) {
    throw new Error('Test git init must use temp directory');
  }
  // ...
}

// Layer 4: Debug logging
console.error('DEBUG:', { operation: 'gitInit', directory, stack: new Error().stack });
```

## Key Principle

```
Found immediate cause
       ↓
Can trace one level up? ──NO──→ NEVER fix just the symptom
       ↓ YES
Trace backwards
       ↓
Is this the source? ──NO──→ (keep tracing)
       ↓ YES
Fix at source
       ↓
Add validation at each layer
       ↓
Bug impossible
```

**NEVER fix just where the error appears.** Trace back to find the original trigger.

## Stack Trace Tips

- **In tests:** Use `console.error()` not logger - logger may be suppressed
- **Before operation:** Log before the dangerous operation, not after it fails
- **Include context:** Directory, cwd, environment variables, timestamps
- **Capture stack:** `new Error().stack` shows complete call chain
finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the workStars: 322kUpdated Claude CodeCodexVerifiedInstall
systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixesStars: 322kUpdated Claude CodeCodexVerifiedInstall
test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation codeStars: 322kUpdated Claude CodeCodexVerifiedInstall
skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.Stars: 197kUpdated Claude CodeCodexVerifiedInstall