191 lines
5.9 KiB
Markdown
191 lines
5.9 KiB
Markdown
---
|
|
name: root-cause-tracing
|
|
description: |
|
|
Backward call-chain tracing - systematically trace bugs from error location back
|
|
through call stack to original trigger. Adds instrumentation when needed.
|
|
|
|
trigger: |
|
|
- Error happens deep in execution (not at entry point)
|
|
- Stack trace shows long call chain
|
|
- Unclear where invalid data originated
|
|
- systematic-debugging Phase 1 leads you here
|
|
|
|
skip_when: |
|
|
- Bug at entry point → use systematic-debugging directly
|
|
- Haven't started investigation → use systematic-debugging first
|
|
- Root cause is obvious → just fix it
|
|
|
|
sequence:
|
|
after: [systematic-debugging]
|
|
|
|
related:
|
|
complementary: [systematic-debugging]
|
|
---
|
|
|
|
# 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
|
|
|
|
**Use root-cause-tracing when:**
|
|
- Error happens deep in execution (not at entry point)
|
|
- Stack trace shows long call chain
|
|
- Unclear where invalid data originated
|
|
- systematic-debugging Phase 1 leads you here
|
|
|
|
**Relationship with systematic-debugging:**
|
|
- root-cause-tracing is a **SUB-SKILL** of systematic-debugging
|
|
- Use during **systematic-debugging Phase 1, Step 5** (Trace Data Flow)
|
|
- Can also use standalone if you KNOW bug is deep-stack issue
|
|
- After tracing to source, **return to systematic-debugging Phase 2**
|
|
|
|
**When NOT to use:**
|
|
- Bug appears at entry point → Use systematic-debugging Phase 1 directly
|
|
- You haven't started systematic-debugging yet → Start there first
|
|
- Root cause is obvious → Just fix it
|
|
- Still gathering evidence → Continue systematic-debugging Phase 1
|
|
|
|
## The Tracing Process
|
|
|
|
### 1. Observe the Symptom
|
|
```
|
|
Error: git init failed in /Users/jesse/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(),
|
|
nodeEnv: process.env.NODE_ENV,
|
|
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?)
|
|
|
|
## 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 `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
|
|
|
|
## Key Principle
|
|
|
|
```dot
|
|
digraph principle {
|
|
"Found immediate cause" [shape=ellipse];
|
|
"Can trace one level up?" [shape=diamond];
|
|
"Trace backwards" [shape=box];
|
|
"Is this the source?" [shape=diamond];
|
|
"Fix at source" [shape=box];
|
|
"Add validation at each layer" [shape=box];
|
|
"Bug impossible" [shape=doublecircle];
|
|
"NEVER fix just the symptom" [shape=octagon, style=filled, fillcolor=red, fontcolor=white];
|
|
|
|
"Found immediate cause" -> "Can trace one level up?";
|
|
"Can trace one level up?" -> "Trace backwards" [label="yes"];
|
|
"Can trace one level up?" -> "NEVER fix just the symptom" [label="no"];
|
|
"Trace backwards" -> "Is this the source?";
|
|
"Is this the source?" -> "Trace backwards" [label="no - keeps going"];
|
|
"Is this the source?" -> "Fix at source" [label="yes"];
|
|
"Fix at source" -> "Add validation at each layer";
|
|
"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
|
|
|
|
## Real-World Impact
|
|
|
|
From debugging session (2025-10-03):
|
|
- Found root cause through 5-level trace
|
|
- Fixed at source (getter validation)
|
|
- Added 4 layers of defense
|
|
- 1847 tests passed, zero pollution
|