Something went wrong. Try again.
source dump of claude code
Something went wrong. Try again.
22 kB · 699 lines
TypeScript
at main
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700/** * Filesystem-based git state reading — avoids spawning git subprocesses. * * Covers: resolving .git directories (including worktrees/submodules), * parsing HEAD, resolving refs via loose files and packed-refs, * and the GitHeadWatcher that caches branch/SHA with fs.watchFile. * * Correctness notes (verified against git source): * - HEAD: `ref: refs/heads/<branch>\n` or raw SHA (refs/files-backend.c) * - Packed-refs: `<sha> <refname>\n`, skip `#` and `^` lines (packed-backend.c) * - .git file (worktree): `gitdir: <path>\n` with optional relative path (setup.c) * - Shallow: mere existence of `<commonDir>/shallow` means shallow (shallow.c) */
import { unwatchFile, watchFile } from 'fs'import { readdir, readFile, stat } from 'fs/promises'import { join, resolve } from 'path'import { waitForScrollIdle } from '../../bootstrap/state.js'import { registerCleanup } from '../cleanupRegistry.js'import { getCwd } from '../cwd.js'import { findGitRoot } from '../git.js'import { parseGitConfigValue } from './gitConfigParser.js'
// ---------------------------------------------------------------------------// resolveGitDir — find the actual .git directory// ---------------------------------------------------------------------------
const resolveGitDirCache = new Map<string, string | null>()
/** Clear cached git dir resolutions. Exported for testing only. */export function clearResolveGitDirCache(): void { resolveGitDirCache.clear()}
/** * Resolve the actual .git directory for a repo. * Handles worktrees/submodules where .git is a file containing `gitdir: <path>`. * Memoized per startPath. */export async function resolveGitDir( startPath?: string,): Promise<string | null> { const cwd = resolve(startPath ?? getCwd()) const cached = resolveGitDirCache.get(cwd) if (cached !== undefined) { return cached }
const root = findGitRoot(cwd) if (!root) { resolveGitDirCache.set(cwd, null) return null }
const gitPath = join(root, '.git') try { const st = await stat(gitPath) if (st.isFile()) { // Worktree or submodule: .git is a file with `gitdir: <path>` // Git strips trailing \n and \r (setup.c read_gitfile_gently). const content = (await readFile(gitPath, 'utf-8')).trim() if (content.startsWith('gitdir:')) { const rawDir = content.slice('gitdir:'.length).trim() const resolved = resolve(root, rawDir) resolveGitDirCache.set(cwd, resolved) return resolved } } // Regular repo: .git is a directory resolveGitDirCache.set(cwd, gitPath) return gitPath } catch { resolveGitDirCache.set(cwd, null) return null }}
// ---------------------------------------------------------------------------// isSafeRefName — validate ref/branch names read from .git/// ---------------------------------------------------------------------------
/** * Validate that a ref/branch name read from .git/ is safe to use in path * joins, as git positional arguments, and when interpolated into shell * commands (commit-push-pr skill interpolates the branch into shell). * An attacker who controls .git/HEAD or a loose ref file could otherwise * embed path traversal (`..`), argument injection (leading `-`), or shell * metacharacters — .git/HEAD is a plain text file that can be written * without git's own check-ref-format validation. * * Allowlist: ASCII alphanumerics, `/`, `.`, `_`, `+`, `-`, `@` only. This * covers all legitimate git branch names (e.g. `feature/foo`, * `release-1.2.3+build`, `dependabot/npm_and_yarn/@types/node-18.0.0`) * while rejecting everything that could be dangerous in shell context * (newlines, backticks, `$`, `;`, `|`, `&`, `(`, `)`, `<`, `>`, spaces, * tabs, quotes, backslash) and path traversal (`..`). */export function isSafeRefName(name: string): boolean { if (!name || name.startsWith('-') || name.startsWith('/')) { return false } if (name.includes('..')) { return false } // Reject single-dot and empty path components (`.`, `foo/./bar`, `foo//bar`, // `foo/`). Git-check-ref-format rejects these, and `.` normalizes away in // path joins so a tampered HEAD of `refs/heads/.` would make us watch the // refs/heads directory itself instead of a branch file. if (name.split('/').some(c => c === '.' || c === '')) { return false } // Allowlist-only: alphanumerics, /, ., _, +, -, @. Rejects all shell // metacharacters, whitespace, NUL, and non-ASCII. Git's forbidden @{ // sequence is blocked because { is not in the allowlist. if (!/^[a-zA-Z0-9/._+@-]+$/.test(name)) { return false } return true}
/** * Validate that a string is a git SHA: 40 hex chars (SHA-1) or 64 hex chars * (SHA-256). Git never writes abbreviated SHAs to HEAD or ref files, so we * only accept full-length hashes. * * An attacker who controls .git/HEAD when detached, or a loose ref file, * could otherwise return arbitrary content that flows into shell contexts. */export function isValidGitSha(s: string): boolean { return /^[0-9a-f]{40}$/.test(s) || /^[0-9a-f]{64}$/.test(s)}
// ---------------------------------------------------------------------------// readGitHead — parse .git/HEAD// ---------------------------------------------------------------------------
/** * Parse .git/HEAD to determine current branch or detached SHA. * * HEAD format (per git source, refs/files-backend.c): * - `ref: refs/heads/<branch>\n` — on a branch * - `ref: <other-ref>\n` — unusual symref (e.g. during bisect) * - `<hex-sha>\n` — detached HEAD (e.g. during rebase) * * Git strips trailing whitespace via strbuf_rtrim; .trim() is equivalent. * Git allows any whitespace between "ref:" and the path; we handle * this by trimming after slicing past "ref:". */export async function readGitHead( gitDir: string,): Promise< { type: 'branch'; name: string } | { type: 'detached'; sha: string } | null> { try { const content = (await readFile(join(gitDir, 'HEAD'), 'utf-8')).trim() if (content.startsWith('ref:')) { const ref = content.slice('ref:'.length).trim() if (ref.startsWith('refs/heads/')) { const name = ref.slice('refs/heads/'.length) // Reject path traversal and argument injection from a tampered HEAD. if (!isSafeRefName(name)) { return null } return { type: 'branch', name } } // Unusual symref (not a local branch) — resolve to SHA if (!isSafeRefName(ref)) { return null } const sha = await resolveRef(gitDir, ref) return sha ? { type: 'detached', sha } : { type: 'detached', sha: '' } } // Raw SHA (detached HEAD). Validate: an attacker-controlled HEAD file // could contain shell metacharacters that flow into downstream shell // contexts. if (!isValidGitSha(content)) { return null } return { type: 'detached', sha: content } } catch { return null }}
// ---------------------------------------------------------------------------// resolveRef — resolve loose/packed refs to SHAs// ---------------------------------------------------------------------------
/** * Resolve a git ref (e.g. `refs/heads/main`) to a commit SHA. * Checks loose ref files first, then falls back to packed-refs. * Follows symrefs (e.g. `ref: refs/remotes/origin/main`). * * For worktrees, refs live in the common gitdir (pointed to by the * `commondir` file), not the worktree-specific gitdir. We check the * worktree gitdir first, then fall back to the common dir. * * Packed-refs format (per packed-backend.c): * - Header: `# pack-refs with: <traits>\n` * - Entries: `<40-hex-sha> <refname>\n` * - Peeled: `^<40-hex-sha>\n` (after annotated tag entries) */export async function resolveRef( gitDir: string, ref: string,): Promise<string | null> { const result = await resolveRefInDir(gitDir, ref) if (result) { return result }
// For worktrees: try the common gitdir where shared refs live const commonDir = await getCommonDir(gitDir) if (commonDir && commonDir !== gitDir) { return resolveRefInDir(commonDir, ref) }
return null}
async function resolveRefInDir( dir: string, ref: string,): Promise<string | null> { // Try loose ref file try { const content = (await readFile(join(dir, ref), 'utf-8')).trim() if (content.startsWith('ref:')) { const target = content.slice('ref:'.length).trim() // Reject path traversal in a tampered symref chain. if (!isSafeRefName(target)) { return null } return resolveRef(dir, target) } // Loose ref content should be a raw SHA. Validate: an attacker-controlled // ref file could contain shell metacharacters. if (!isValidGitSha(content)) { return null } return content } catch { // Loose ref doesn't exist, try packed-refs }
try { const packed = await readFile(join(dir, 'packed-refs'), 'utf-8') for (const line of packed.split('\n')) { if (line.startsWith('#') || line.startsWith('^')) { continue } const spaceIdx = line.indexOf(' ') if (spaceIdx === -1) { continue } if (line.slice(spaceIdx + 1) === ref) { const sha = line.slice(0, spaceIdx) return isValidGitSha(sha) ? sha : null } } } catch { // No packed-refs }
return null}
/** * Read the `commondir` file to find the shared git directory. * In a worktree, this points to the main repo's .git dir. * Returns null if no commondir file exists (regular repo). */export async function getCommonDir(gitDir: string): Promise<string | null> { try { const content = (await readFile(join(gitDir, 'commondir'), 'utf-8')).trim() return resolve(gitDir, content) } catch { return null }}
/** * Read a raw symref file and extract the branch name after a known prefix. * Returns null if the ref doesn't exist, isn't a symref, or doesn't match the prefix. * Checks loose file only — packed-refs doesn't store symrefs. */export async function readRawSymref( gitDir: string, refPath: string, branchPrefix: string,): Promise<string | null> { try { const content = (await readFile(join(gitDir, refPath), 'utf-8')).trim() if (content.startsWith('ref:')) { const target = content.slice('ref:'.length).trim() if (target.startsWith(branchPrefix)) { const name = target.slice(branchPrefix.length) // Reject path traversal and argument injection from a tampered symref. if (!isSafeRefName(name)) { return null } return name } } } catch { // Not a loose ref } return null}
// ---------------------------------------------------------------------------// GitFileWatcher — watches git files and caches derived values.// Lazily initialized on first cache access. Invalidates all cached// values when any watched file changes.//// Watches:// .git/HEAD — branch switches, detached HEAD// .git/config — remote URL changes// .git/refs/heads/<branch> — new commits on the current branch//// When HEAD changes (branch switch), the branch ref watcher is updated// to track the new branch's ref file.// ---------------------------------------------------------------------------
type CacheEntry<T> = { value: T dirty: boolean compute: () => Promise<T>}
const WATCH_INTERVAL_MS = process.env.NODE_ENV === 'test' ? 10 : 1000
class GitFileWatcher { private gitDir: string | null = null private commonDir: string | null = null private initialized = false private initPromise: Promise<void> | null = null private watchedPaths: string[] = [] private branchRefPath: string | null = null private cache = new Map<string, CacheEntry<unknown>>()
async ensureStarted(): Promise<void> { if (this.initialized) { return } if (this.initPromise) { return this.initPromise } this.initPromise = this.start() return this.initPromise }
private async start(): Promise<void> { this.gitDir = await resolveGitDir() this.initialized = true if (!this.gitDir) { return }
// In a worktree, branch refs and the main config are shared and live in // commonDir, not the per-worktree gitDir. Resolve once so we don't // re-read the commondir file on every branch switch. this.commonDir = await getCommonDir(this.gitDir)
// Watch .git/HEAD and .git/config this.watchPath(join(this.gitDir, 'HEAD'), () => { void this.onHeadChanged() }) // Config (remote URLs) lives in commonDir for worktrees this.watchPath(join(this.commonDir ?? this.gitDir, 'config'), () => { this.invalidate() })
// Watch the current branch's ref file for commit changes await this.watchCurrentBranchRef()
registerCleanup(async () => { this.stopWatching() }) }
private watchPath(path: string, callback: () => void): void { this.watchedPaths.push(path) watchFile(path, { interval: WATCH_INTERVAL_MS }, callback) }
/** * Watch the loose ref file for the current branch. * Called on startup and whenever HEAD changes (branch switch). */ private async watchCurrentBranchRef(): Promise<void> { if (!this.gitDir) { return }
const head = await readGitHead(this.gitDir) // Branch refs live in commonDir for worktrees (gitDir for regular repos) const refsDir = this.commonDir ?? this.gitDir const refPath = head?.type === 'branch' ? join(refsDir, 'refs', 'heads', head.name) : null
// Already watching this ref (or already not watching anything) if (refPath === this.branchRefPath) { return }
// Stop watching old branch ref. Runs for branch→branch AND // branch→detached (checkout --detach, rebase, bisect). if (this.branchRefPath) { unwatchFile(this.branchRefPath) this.watchedPaths = this.watchedPaths.filter( p => p !== this.branchRefPath, ) }
this.branchRefPath = refPath
if (!refPath) { return }
// The ref file may not exist yet (new branch before first commit). // watchFile works on nonexistent files — it fires when the file appears. this.watchPath(refPath, () => { this.invalidate() }) }
private async onHeadChanged(): Promise<void> { // HEAD changed — could be a branch switch or detach. // Defer file I/O (readGitHead, watchFile setup) until scroll settles so // watchFile callbacks that land mid-scroll don't compete for the event // loop. invalidate() is cheap (just marks dirty) so do it first — the // cache correctly serves stale-marked values until the watcher updates. this.invalidate() await waitForScrollIdle() await this.watchCurrentBranchRef() }
private invalidate(): void { for (const entry of this.cache.values()) { entry.dirty = true } }
private stopWatching(): void { for (const path of this.watchedPaths) { unwatchFile(path) } this.watchedPaths = [] this.branchRefPath = null }
/** * Get a cached value by key. On first call for a key, computes and caches it. * Subsequent calls return the cached value until a watched file changes, * which marks the entry dirty. The next get() re-computes from disk. * * Race condition handling: dirty is cleared BEFORE the async compute starts. * If a file change arrives during compute, it re-sets dirty, so the next * get() will re-read again rather than serving a stale value. */ async get<T>(key: string, compute: () => Promise<T>): Promise<T> { await this.ensureStarted() const existing = this.cache.get(key) if (existing && !existing.dirty) { return existing.value as T } // Clear dirty before compute — if the file changes again during the // async read, invalidate() will re-set dirty and we'll re-read on // the next get() call. if (existing) { existing.dirty = false } const value = await compute() // Only update the cached value if no new invalidation arrived during compute const entry = this.cache.get(key) if (entry && !entry.dirty) { entry.value = value } if (!entry) { this.cache.set(key, { value, dirty: false, compute }) } return value }
/** Reset all state. Stops file watchers. For testing only. */ reset(): void { this.stopWatching() this.cache.clear() this.initialized = false this.initPromise = null this.gitDir = null this.commonDir = null }}
const gitWatcher = new GitFileWatcher()
async function computeBranch(): Promise<string> { const gitDir = await resolveGitDir() if (!gitDir) { return 'HEAD' } const head = await readGitHead(gitDir) if (!head) { return 'HEAD' } return head.type === 'branch' ? head.name : 'HEAD'}
async function computeHead(): Promise<string> { const gitDir = await resolveGitDir() if (!gitDir) { return '' } const head = await readGitHead(gitDir) if (!head) { return '' } if (head.type === 'branch') { return (await resolveRef(gitDir, `refs/heads/${head.name}`)) ?? '' } return head.sha}
async function computeRemoteUrl(): Promise<string | null> { const gitDir = await resolveGitDir() if (!gitDir) { return null } const url = await parseGitConfigValue(gitDir, 'remote', 'origin', 'url') if (url) { return url } // In worktrees, the config with remote URLs is in the common dir const commonDir = await getCommonDir(gitDir) if (commonDir && commonDir !== gitDir) { return parseGitConfigValue(commonDir, 'remote', 'origin', 'url') } return null}
async function computeDefaultBranch(): Promise<string> { const gitDir = await resolveGitDir() if (!gitDir) { return 'main' } // refs/remotes/ lives in commonDir, not the per-worktree gitDir const commonDir = (await getCommonDir(gitDir)) ?? gitDir const branchFromSymref = await readRawSymref( commonDir, 'refs/remotes/origin/HEAD', 'refs/remotes/origin/', ) if (branchFromSymref) { return branchFromSymref } for (const candidate of ['main', 'master']) { const sha = await resolveRef(commonDir, `refs/remotes/origin/${candidate}`) if (sha) { return candidate } } return 'main'}
export function getCachedBranch(): Promise<string> { return gitWatcher.get('branch', computeBranch)}
export function getCachedHead(): Promise<string> { return gitWatcher.get('head', computeHead)}
export function getCachedRemoteUrl(): Promise<string | null> { return gitWatcher.get('remoteUrl', computeRemoteUrl)}
export function getCachedDefaultBranch(): Promise<string> { return gitWatcher.get('defaultBranch', computeDefaultBranch)}
/** Reset the git file watcher state. For testing only. */export function resetGitFileWatcher(): void { gitWatcher.reset()}
/** * Read the HEAD SHA for an arbitrary directory (not using the watcher). * Used by plugins that need the HEAD of a specific repo, not the CWD repo. */export async function getHeadForDir(cwd: string): Promise<string | null> { const gitDir = await resolveGitDir(cwd) if (!gitDir) { return null } const head = await readGitHead(gitDir) if (!head) { return null } if (head.type === 'branch') { return resolveRef(gitDir, `refs/heads/${head.name}`) } return head.sha}
/** * Read the HEAD SHA for a git worktree directory (not the main repo). * * Unlike `getHeadForDir`, this reads `<worktreePath>/.git` directly as a * `gitdir:` pointer file, with no upward walk. `getHeadForDir` walks upward * via `findGitRoot` and would find the parent repo's `.git` when the * worktree path doesn't exist — misreporting the parent HEAD as the worktree's. * * Returns null if the worktree doesn't exist (`.git` pointer ENOENT) or is * malformed. Caller can treat null as "not a valid worktree". */export async function readWorktreeHeadSha( worktreePath: string,): Promise<string | null> { let gitDir: string try { const ptr = (await readFile(join(worktreePath, '.git'), 'utf-8')).trim() if (!ptr.startsWith('gitdir:')) { return null } gitDir = resolve(worktreePath, ptr.slice('gitdir:'.length).trim()) } catch { return null } const head = await readGitHead(gitDir) if (!head) { return null } if (head.type === 'branch') { return resolveRef(gitDir, `refs/heads/${head.name}`) } return head.sha}
/** * Read the remote origin URL for an arbitrary directory via .git/config. */export async function getRemoteUrlForDir(cwd: string): Promise<string | null> { const gitDir = await resolveGitDir(cwd) if (!gitDir) { return null } const url = await parseGitConfigValue(gitDir, 'remote', 'origin', 'url') if (url) { return url } // In worktrees, the config with remote URLs is in the common dir const commonDir = await getCommonDir(gitDir) if (commonDir && commonDir !== gitDir) { return parseGitConfigValue(commonDir, 'remote', 'origin', 'url') } return null}
/** * Check if we're in a shallow clone by looking for <commonDir>/shallow. * Per git's shallow.c, mere existence of the file means shallow. * The shallow file lives in commonDir, not the per-worktree gitDir. */export async function isShallowClone(): Promise<boolean> { const gitDir = await resolveGitDir() if (!gitDir) { return false } const commonDir = (await getCommonDir(gitDir)) ?? gitDir try { await stat(join(commonDir, 'shallow')) return true } catch { return false }}
/** * Count worktrees by reading <commonDir>/worktrees/ directory. * The worktrees/ directory lives in commonDir, not the per-worktree gitDir. * The main worktree is not listed there, so add 1. */export async function getWorktreeCountFromFs(): Promise<number> { try { const gitDir = await resolveGitDir() if (!gitDir) { return 0 } const commonDir = (await getCommonDir(gitDir)) ?? gitDir const entries = await readdir(join(commonDir, 'worktrees')) return entries.length + 1 } catch { // No worktrees directory means only the main worktree return 1 }}