mirror of
https://github.com/stablyai/orca.git
synced 2026-10-01 08:01:56 +00:00
* perf(git): pack the loose refs Orca's own fetches leave behind Orca strips git's auto-maintenance off every fetch it issues (GIT_FETCH_SKIP_AUTO_MAINTENANCE_CONFIG_ARGS) and never compensated, so nothing in an Orca-driven checkout ever packs refs. One real machine reached 36,574 loose refs, where `git show-ref -- main` costs 5.2s and every worktree create pays for it. Add an idle-time, per-repo `git pack-refs --all --prune`, armed by the fetches that create the debt. It runs only after ten minutes of quiet on that repo, only above 1000 loose refs (probed with a walk bounded by that threshold, not by the backlog), one at a time across the whole app, at the background admission tier, and never while an agent is working, a create is prepared or in flight, a worktree removal is deleting refs, the app is quitting, or the machine is on battery. A user who set `maintenance.auto=false` or `gc.auto=0` has opted out. Measured on a 36,001-loose-ref fixture (macOS/APFS, git 2.44): `show-ref` 5.5-12.2s -> 30-49ms, `for-each-ref` 4.0-10.8s -> 43-48ms. Also fixes a pre-existing bug the split exposed: `--path-format=absolute` is ignored before git 2.31, and taking rev-parse's stdout raw collapsed every repo on such a host onto one fetch-serialization key. Refs #17828 * perf(git): make idle ref maintenance preemptible and cheaper to probe The idle veto was one-directional: it stopped a pack from starting during a create, removal, or agent work, but nothing stopped those from starting during a pack. A user-clicked Fetch, a branch delete, or a worktree removal that needed `packed-refs.lock` mid-rewrite could fail with `unable to create packed-refs.lock` -- a git error with no visible cause. Make the pack cancellable end to end. An AbortSignal now reaches the `pack-refs` child and both pre-pack probes, and `pause()` aborts what is running, waits for it to actually stop, and holds a suspension count so nothing new starts until the caller releases. Every entry point that deletes a ref takes that pause: gitFetch, gitPull, gitFastForward, removeWorktree, forceDeleteLocalBranch, prepareWorktreeCreateCheckout, addWorktree. Five more triggers close the rest of the window: battery drop, window focus, quit, the attempt deadline, and any other git command queueing for an admission slot. Judge a pack by re-probing the backlog rather than by the child's exit code. Measured in the field: another Orca session moved a branch mid-pack, git reported `cannot lock ref`, skipped that ref and packed the rest -- 36,688 loose refs down to 3. On a machine running several sessions that is the normal case, and retrying it would be wrong. Probe with one batched `readdir` per directory instead of streaming `opendir`, which issues a thread-pool round trip every 32 entries: 177ms -> 23ms on a real 36,600-ref repository, with half the event-loop lag. The walk stays strictly sequential so it can never occupy more than one of libuv's four filesystem threads. `PackRefsLockOwnership` makes a lock left by SIGKILL attributable, and only reclaims one when a marker exists, the lock is older than any pack-refs could run for, and the recorded process is gone. Refs #17828 * fix(git): wait out the packed-refs lock instead of killing the pack Measured on Git 2.55/APFS with 37k loose refs: a full `pack-refs --all --prune` takes 23-32s but holds `packed-refs.lock` for only 0.03-1.37s of it. The other ~95% is the prune phase, during which a concurrent `fetch --prune`, `branch -D` or `update-ref` succeeds every time -- per-ref locks last microseconds and git retries for `core.filesRefLockTimeout`. So the abort-on-everything design was strictly harmful. SIGTERM into the prune loop strands an empty `refs/**/*.lock` about one time in five (9/30, 5/40, 6/30 kills): `tempfile.c` opens the lock O_EXCL before `activate_tempfile()` links it into the list the signal handler walks, and a pack does ~36k lock cycles. Afterwards `update-ref -d` on that ref fails with `cannot lock ref ... File exists`, permanently. On Windows `taskkill /f` never runs git's handlers at all, so an abort inside the rewrite strands `packed-refs.lock` every time. Never signal the child. `packRefs` no longer takes an abort signal; it polls `packed-refs.lock` and reports the window through a `PackedRefsLockReporter`. `pause()` resolves when the lock is released -- bounded, and free during the prune -- while the suspension counter still blocks new attempts. Battery and window-focus become do-not-start rather than stop-what-is-running, and quit waits for the lock and lets the child finish orphaned. For strands that already exist, `PackRefsLockOwnership` now also reclaims `refs/**/*.lock` under the same three conditions plus a 0-byte check, and a lock carrying our own not-yet-reclaimable marker records `locked` with a 30min retry instead of the 6h failure cooldown -- so a Windows strand self-heals in half an hour rather than six. Reverts the git admission-scheduler event bus, which existed only to drive the abort this removes. Refs #17828 * test(git): make the ref-maintenance waits survive a loaded runner CI shard 4/8 failed on `restarts every armed countdown when the user does ref work themselves`, which passes locally. The `until()` helper spun a fixed 200 event-loop turns and then returned silently, so on a contended runner the filesystem probe had not finished and the assertion that followed failed with an unrelated message. Bound the wait by wall clock instead and throw a named error, which immediately exposed a second latent bug: the single-flight test's second wait could never succeed, because the deferred repo's retry is on a faked `setTimeout` that spinning the real loop never advances. It had been passing only because the old helper gave up quietly. Add a timer-aware variant for those, and have the countdown test await a signal the fake pack resolves rather than polling at all. Verified stable across five sequential runs and once under load average 32 with six concurrent suites. Refs #17828
291 lines
9.2 KiB
TypeScript
291 lines
9.2 KiB
TypeScript
import { windowsLongPathGitArgs } from '../../shared/windows-long-path-git-args'
|
|
import { resolveWorktreeAddBaseRef } from '../../shared/worktree/base-ref'
|
|
import type { AddWorktreeOptions, AddWorktreeResult, GitWorktreeExecOptions } from './worktree'
|
|
import {
|
|
configurePushAutoSetupRemote,
|
|
notifyPreparedWorktreeMutation,
|
|
persistWorktreeCreationBase,
|
|
resolveWorktreeAddBaseContext,
|
|
resolveWorktreeAddTimeoutMs,
|
|
WORKTREE_REMOVAL_REGISTRATION_TIMEOUT_MS
|
|
} from './worktree'
|
|
import { hasWorktreeBaseCommitRef } from './worktree-base-ref-probe'
|
|
import { withRepoRefMaintenancePaused } from './local-repo-ref-maintenance'
|
|
import { gitExecFileAsync } from './runner'
|
|
import { runWithGitReadCacheInvalidation } from './status'
|
|
import { invalidateWslLinkedWorktreeGitRouting } from './wsl-linked-worktree-git-routing'
|
|
|
|
function gitExecOptions(
|
|
cwd: string,
|
|
options: GitWorktreeExecOptions
|
|
): { cwd: string; wslDistro?: string; signal?: AbortSignal; timeout?: number } {
|
|
return {
|
|
cwd,
|
|
...(options.wslDistro ? { wslDistro: options.wslDistro } : {}),
|
|
...(options.signal ? { signal: options.signal } : {}),
|
|
...(options.timeout ? { timeout: options.timeout } : {})
|
|
}
|
|
}
|
|
|
|
function gitCleanupOptions(
|
|
cwd: string,
|
|
options: GitWorktreeExecOptions
|
|
): { cwd: string; wslDistro?: string; timeout?: number } {
|
|
// Why: cancellation must not strand a partially moved worktree; cleanup is bounded separately.
|
|
return gitExecOptions(cwd, { ...options, signal: undefined })
|
|
}
|
|
|
|
async function performDiscardPreparedWorktree(
|
|
repoPath: string,
|
|
worktreePath: string,
|
|
options: GitWorktreeExecOptions
|
|
): Promise<void> {
|
|
const cleanupGitOptions = {
|
|
...gitCleanupOptions(repoPath, options),
|
|
timeout: options.timeout ?? WORKTREE_REMOVAL_REGISTRATION_TIMEOUT_MS
|
|
}
|
|
try {
|
|
await gitExecFileAsync(
|
|
[...windowsLongPathGitArgs(repoPath), 'worktree', 'unlock', worktreePath],
|
|
cleanupGitOptions
|
|
)
|
|
} catch {
|
|
// It may be unlocked already or only partially registered.
|
|
}
|
|
try {
|
|
await gitExecFileAsync(
|
|
[...windowsLongPathGitArgs(repoPath), 'worktree', 'remove', '--force', worktreePath],
|
|
cleanupGitOptions
|
|
)
|
|
} finally {
|
|
invalidateWslLinkedWorktreeGitRouting(worktreePath)
|
|
}
|
|
}
|
|
|
|
export async function prepareWorktreeCreateCheckout(
|
|
repoPath: string,
|
|
worktreePath: string,
|
|
baseBranch: string,
|
|
lockReason: string,
|
|
options: GitWorktreeExecOptions = {}
|
|
): Promise<void> {
|
|
try {
|
|
await withRepoRefMaintenancePaused('worktree-prepare', () =>
|
|
runWithGitReadCacheInvalidation(async () => {
|
|
const effectiveBase = await resolveWorktreeAddBaseRef(baseBranch, (qualifiedRef) =>
|
|
hasWorktreeBaseCommitRef(repoPath, qualifiedRef, options)
|
|
)
|
|
try {
|
|
await gitExecFileAsync(
|
|
[
|
|
...windowsLongPathGitArgs(repoPath),
|
|
'worktree',
|
|
'add',
|
|
'--detach',
|
|
'--no-checkout',
|
|
worktreePath,
|
|
effectiveBase
|
|
],
|
|
{ ...gitExecOptions(repoPath, options), timeout: resolveWorktreeAddTimeoutMs() }
|
|
)
|
|
// The add just wrote the marker; drop any pre-create route before the reset routes Git.
|
|
invalidateWslLinkedWorktreeGitRouting(worktreePath)
|
|
// Why: reset materializes files without running user post-checkout hooks before submit.
|
|
await gitExecFileAsync(
|
|
[...windowsLongPathGitArgs(worktreePath), 'reset', '--hard', effectiveBase],
|
|
{ ...gitExecOptions(worktreePath, options), timeout: resolveWorktreeAddTimeoutMs() }
|
|
)
|
|
await gitExecFileAsync(
|
|
[
|
|
...windowsLongPathGitArgs(repoPath),
|
|
'worktree',
|
|
'lock',
|
|
'--reason',
|
|
lockReason,
|
|
worktreePath
|
|
],
|
|
{ ...gitExecOptions(repoPath, options), timeout: resolveWorktreeAddTimeoutMs() }
|
|
)
|
|
} catch (error) {
|
|
await performDiscardPreparedWorktree(repoPath, worktreePath, options).catch(() => {})
|
|
throw error
|
|
}
|
|
})
|
|
)
|
|
} finally {
|
|
notifyPreparedWorktreeMutation(repoPath)
|
|
}
|
|
}
|
|
|
|
export async function discardPreparedWorktree(
|
|
repoPath: string,
|
|
worktreePath: string,
|
|
options: GitWorktreeExecOptions = {}
|
|
): Promise<void> {
|
|
try {
|
|
await runWithGitReadCacheInvalidation(() =>
|
|
performDiscardPreparedWorktree(repoPath, worktreePath, options)
|
|
)
|
|
} finally {
|
|
notifyPreparedWorktreeMutation(repoPath)
|
|
}
|
|
}
|
|
|
|
export async function unlockPreparedWorktree(
|
|
repoPath: string,
|
|
worktreePath: string,
|
|
options: GitWorktreeExecOptions = {}
|
|
): Promise<void> {
|
|
const cleanupGitOptions = {
|
|
...gitCleanupOptions(repoPath, options),
|
|
timeout: options.timeout ?? WORKTREE_REMOVAL_REGISTRATION_TIMEOUT_MS
|
|
}
|
|
try {
|
|
await runWithGitReadCacheInvalidation(() =>
|
|
gitExecFileAsync(
|
|
[...windowsLongPathGitArgs(repoPath), 'worktree', 'unlock', worktreePath],
|
|
cleanupGitOptions
|
|
)
|
|
)
|
|
} finally {
|
|
notifyPreparedWorktreeMutation(repoPath)
|
|
}
|
|
}
|
|
|
|
async function removeFailedFinalization(
|
|
repoPath: string,
|
|
cleanupPath: string,
|
|
branch: string,
|
|
moved: boolean,
|
|
options: GitWorktreeExecOptions
|
|
): Promise<void> {
|
|
let branchAttached = false
|
|
if (moved) {
|
|
try {
|
|
const { stdout } = await gitExecFileAsync(
|
|
['symbolic-ref', '--short', 'HEAD'],
|
|
gitCleanupOptions(cleanupPath, options)
|
|
)
|
|
branchAttached = stdout.trim() === branch
|
|
} catch {
|
|
// Detached or no longer readable.
|
|
}
|
|
}
|
|
await performDiscardPreparedWorktree(repoPath, cleanupPath, options).catch(() => {})
|
|
if (branchAttached) {
|
|
await gitExecFileAsync(
|
|
['branch', '-D', '--', branch],
|
|
gitCleanupOptions(repoPath, options)
|
|
).catch(() => {})
|
|
}
|
|
}
|
|
|
|
export async function finalizePreparedWorktree(
|
|
repoPath: string,
|
|
preparedPath: string,
|
|
worktreePath: string,
|
|
branch: string,
|
|
baseBranch: string,
|
|
refreshLocalBaseRef = false,
|
|
options: AddWorktreeOptions = {}
|
|
): Promise<AddWorktreeResult> {
|
|
const finalizeGitOptions: AddWorktreeOptions = {
|
|
...options,
|
|
timeout: options.timeout ?? resolveWorktreeAddTimeoutMs()
|
|
}
|
|
try {
|
|
return await runWithGitReadCacheInvalidation(async () => {
|
|
const baseContext = await resolveWorktreeAddBaseContext(
|
|
repoPath,
|
|
baseBranch,
|
|
refreshLocalBaseRef,
|
|
finalizeGitOptions
|
|
)
|
|
const [targetHeadResult, preparedHeadResult] = await Promise.all([
|
|
gitExecFileAsync(
|
|
['rev-parse', '--verify', `${baseContext.effectiveBase}^{commit}`],
|
|
gitExecOptions(repoPath, finalizeGitOptions)
|
|
),
|
|
gitExecFileAsync(
|
|
['rev-parse', '--verify', 'HEAD'],
|
|
gitExecOptions(preparedPath, finalizeGitOptions)
|
|
)
|
|
])
|
|
const { stdout: targetHeadOutput } = targetHeadResult
|
|
const targetHead = targetHeadOutput.trim()
|
|
const { stdout: preparedHeadOutput } = preparedHeadResult
|
|
if (preparedHeadOutput.trim() !== targetHead) {
|
|
await gitExecFileAsync(
|
|
[...windowsLongPathGitArgs(preparedPath), 'reset', '--hard', targetHead],
|
|
gitExecOptions(preparedPath, finalizeGitOptions)
|
|
)
|
|
}
|
|
|
|
let moved = false
|
|
try {
|
|
try {
|
|
// Why: `-f -f` moves the locked preparation while preserving its lock reason (Git >=2.25).
|
|
await gitExecFileAsync(
|
|
[
|
|
...windowsLongPathGitArgs(repoPath),
|
|
'worktree',
|
|
'move',
|
|
'-f',
|
|
'-f',
|
|
preparedPath,
|
|
worktreePath
|
|
],
|
|
gitExecOptions(repoPath, finalizeGitOptions)
|
|
)
|
|
moved = true
|
|
} finally {
|
|
// The move rewrites both `.git` markers, and a failure can have rewritten one.
|
|
invalidateWslLinkedWorktreeGitRouting(preparedPath)
|
|
invalidateWslLinkedWorktreeGitRouting(worktreePath)
|
|
}
|
|
await gitExecFileAsync(
|
|
[
|
|
...windowsLongPathGitArgs(worktreePath),
|
|
'checkout',
|
|
'--no-track',
|
|
'-b',
|
|
branch,
|
|
targetHead
|
|
],
|
|
gitExecOptions(worktreePath, finalizeGitOptions)
|
|
)
|
|
await persistWorktreeCreationBase(
|
|
worktreePath,
|
|
branch,
|
|
baseContext.effectiveBase,
|
|
finalizeGitOptions
|
|
)
|
|
await configurePushAutoSetupRemote(worktreePath, finalizeGitOptions)
|
|
await gitExecFileAsync(
|
|
[...windowsLongPathGitArgs(repoPath), 'worktree', 'unlock', worktreePath],
|
|
gitExecOptions(repoPath, finalizeGitOptions)
|
|
)
|
|
} catch (error) {
|
|
await removeFailedFinalization(
|
|
repoPath,
|
|
moved ? worktreePath : preparedPath,
|
|
branch,
|
|
moved,
|
|
finalizeGitOptions
|
|
)
|
|
throw error
|
|
}
|
|
return {
|
|
...(baseContext.localBaseRefRefresh
|
|
? { localBaseRefRefresh: baseContext.localBaseRefRefresh }
|
|
: {}),
|
|
...(baseContext.localBaseRefUpdateSuggestion
|
|
? { localBaseRefUpdateSuggestion: baseContext.localBaseRefUpdateSuggestion }
|
|
: {})
|
|
}
|
|
})
|
|
} finally {
|
|
notifyPreparedWorktreeMutation(repoPath)
|
|
}
|
|
}
|