mirror of
https://github.com/garrytan/gstack.git
synced 2026-09-09 14:38:59 +02:00
fix(session-update): lock pidfile records the live holder; hard TTL bounds every wedge (#2613)
echo $$ inside the backgrounded subshell recorded the PARENT hook's PID —
which exits immediately — so every subsequent session judged the lock stale
and rm -rf'd a LIVE holder's lock, letting concurrent updaters run over each
other. The pidfile now records ${BASHPID:-$(sh -c 'echo $PPID')} (macOS
bash 3.2 has no BASHPID; the sh child's PPID is exactly this subshell).
Staleness is now two independent detectors: PID liveness (as before, but
against the real holder), and a 30-minute hard TTL on the heartbeat mtime —
reclaimed regardless of kill -0, so a recycled PID or hung holder can't wedge
the lock forever. The holder touches the pidfile after the pull and after
setup, so a legitimately-slow run keeps itself alive. Empty and missing
pidfiles are respected inside the TTL window (the mkdir→echo race) and
reclaimed past it.
Fixes #2613.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Fable 5
parent
63ef693d02
commit
ddeeb18edb
@@ -54,26 +54,53 @@ fi
|
||||
mkdir -p "$STATE_DIR"
|
||||
|
||||
# ── Acquire lockfile (skip if another session is running setup) ──
|
||||
#
|
||||
# Staleness has two independent detectors (#2613):
|
||||
# 1. PID liveness — the pidfile records the HOLDER subshell's PID and a
|
||||
# dead PID means reclaim. ($BASHPID, never $$: $$ expands to the PARENT
|
||||
# hook's PID even inside this backgrounded subshell, and the parent
|
||||
# exits immediately — so every later session judged the lock stale and
|
||||
# rm -rf'd a LIVE holder's lock, letting concurrent updaters in.)
|
||||
# 2. Hard TTL on the heartbeat mtime — reclaim regardless of kill -0, so a
|
||||
# recycled PID or a hung holder can't wedge the lock forever. The
|
||||
# holder touches the pidfile at step boundaries (after the pull, after
|
||||
# setup), so a legitimately-slow run keeps itself alive. The TTL also
|
||||
# bounds the missing/empty-pidfile states: inside the window they mean
|
||||
# "just acquired, between mkdir and echo" and are respected.
|
||||
LOCK_TTL_MINUTES=30
|
||||
lock_is_expired() {
|
||||
_hb="$LOCK_DIR/pid"
|
||||
[ -f "$_hb" ] || _hb="$LOCK_DIR"
|
||||
[ -n "$(find "$_hb" -maxdepth 0 -mmin +$LOCK_TTL_MINUTES 2>/dev/null)" ]
|
||||
}
|
||||
if ! mkdir "$LOCK_DIR" 2>/dev/null; then
|
||||
# Lock exists — check if stale (PID dead)
|
||||
if [ -f "$LOCK_DIR/pid" ]; then
|
||||
if lock_is_expired; then
|
||||
rm -rf "$LOCK_DIR" 2>/dev/null
|
||||
mkdir "$LOCK_DIR" 2>/dev/null || { log_entry "SKIP lock_contested"; exit 0; }
|
||||
log_entry "RECLAIMED lock_ttl_expired"
|
||||
elif [ -f "$LOCK_DIR/pid" ]; then
|
||||
LOCK_PID=$(cat "$LOCK_DIR/pid" 2>/dev/null || echo 0)
|
||||
if [ "$LOCK_PID" -gt 0 ] 2>/dev/null && ! kill -0 "$LOCK_PID" 2>/dev/null; then
|
||||
# Stale lock — remove and re-acquire
|
||||
rm -rf "$LOCK_DIR" 2>/dev/null
|
||||
mkdir "$LOCK_DIR" 2>/dev/null || { log_entry "SKIP lock_contested"; exit 0; }
|
||||
else
|
||||
# Live holder — or an empty/non-numeric pidfile inside the TTL
|
||||
# window (the -gt test fails on garbage, landing here by design).
|
||||
log_entry "SKIP locked_by=$LOCK_PID"
|
||||
exit 0
|
||||
fi
|
||||
else
|
||||
# Missing pidfile inside the TTL window: just-acquired (mkdir→echo race).
|
||||
log_entry "SKIP locked_no_pid"
|
||||
exit 0
|
||||
fi
|
||||
fi
|
||||
|
||||
# Write PID for stale lock detection
|
||||
echo $$ > "$LOCK_DIR/pid" 2>/dev/null
|
||||
# Write the HOLDER's PID for stale lock detection (see #2613 note above;
|
||||
# macOS ships bash 3.2 with no BASHPID — the sh child's $PPID IS this
|
||||
# subshell, so the fallback is exact there).
|
||||
echo "${BASHPID:-$(sh -c 'echo $PPID')}" > "$LOCK_DIR/pid" 2>/dev/null
|
||||
|
||||
# Clean up lock on exit
|
||||
trap 'rm -rf "$LOCK_DIR" 2>/dev/null' EXIT
|
||||
@@ -94,6 +121,9 @@ fi
|
||||
PULL_EXIT=$?
|
||||
NEW_HEAD=$(git -C "$GSTACK_DIR" rev-parse HEAD 2>/dev/null)
|
||||
|
||||
# Heartbeat: pull done — keep the TTL clock fresh for the setup step.
|
||||
touch "$LOCK_DIR/pid" 2>/dev/null
|
||||
|
||||
# Record check time regardless of outcome
|
||||
date +%s > "$THROTTLE_FILE" 2>/dev/null
|
||||
|
||||
@@ -132,6 +162,8 @@ fi
|
||||
( cd "$GSTACK_DIR" && ./setup -q ) >/dev/null 2>&1 || {
|
||||
log_entry "SETUP_FAILED"
|
||||
}
|
||||
# Heartbeat: setup done (either way) — refresh the TTL clock.
|
||||
touch "$LOCK_DIR/pid" 2>/dev/null
|
||||
else
|
||||
log_entry "SETUP_SKIPPED bun_missing"
|
||||
fi
|
||||
|
||||
@@ -122,3 +122,138 @@ describe('gstack-session-update pull wedge (#2566)', () => {
|
||||
}
|
||||
}, 30000);
|
||||
});
|
||||
|
||||
// ── #2613: the lock pidfile must record the LIVE holder, not the exited parent ──
|
||||
//
|
||||
// `echo $$` inside the backgrounded subshell recorded the parent hook's PID.
|
||||
// The parent exits immediately, so every subsequent session judged the lock
|
||||
// stale and rm -rf'd a LIVE holder's lock — concurrent updaters, the exact
|
||||
// state the lock exists to prevent. Plus: a hard TTL (heartbeat-refreshed)
|
||||
// bounds PID-reuse wedges and the empty/missing-pidfile races.
|
||||
|
||||
describe('gstack-session-update lock identity + TTL (#2613)', () => {
|
||||
function makeSlowGitShim(base: string, sleepSecs: number): string {
|
||||
const shimDir = path.join(base, 'shim');
|
||||
fs.mkdirSync(shimDir, { recursive: true });
|
||||
const realGit = execFileSync('bash', ['-c', 'command -v git'], { encoding: 'utf8' }).trim();
|
||||
fs.writeFileSync(
|
||||
path.join(shimDir, 'git'),
|
||||
`#!/usr/bin/env bash\ncase "$*" in *pull*) sleep ${sleepSecs};; esac\nexec "${realGit}" "$@"\n`,
|
||||
{ mode: 0o755 },
|
||||
);
|
||||
return shimDir;
|
||||
}
|
||||
|
||||
function runScriptWithPath(install: string, state: string, shimDir: string) {
|
||||
return spawnSync('bash', [SCRIPT], {
|
||||
encoding: 'utf8',
|
||||
env: { ...process.env, GSTACK_DIR: install, GSTACK_STATE_DIR: state, PATH: `${shimDir}:${process.env.PATH}` },
|
||||
timeout: 20000,
|
||||
});
|
||||
}
|
||||
|
||||
function isAlive(pid: number): boolean {
|
||||
try { process.kill(pid, 0); return true; } catch { return false; }
|
||||
}
|
||||
|
||||
test('recorded pid is the live holder subshell, not the exited parent', async () => {
|
||||
const { base, install, state } = makeFixture();
|
||||
const shimDir = makeSlowGitShim(base, 3);
|
||||
try {
|
||||
const r = runScriptWithPath(install, state, shimDir);
|
||||
expect(r.status).toBe(0); // parent hook has EXITED by now (spawnSync waited)
|
||||
// Poll for the pidfile the detached subshell writes.
|
||||
const pidPath = path.join(state, '.setup-lock', 'pid');
|
||||
const deadline = Date.now() + 5000;
|
||||
let pid = 0;
|
||||
while (Date.now() < deadline) {
|
||||
if (fs.existsSync(pidPath)) {
|
||||
pid = Number(fs.readFileSync(pidPath, 'utf8').trim());
|
||||
if (pid > 0) break;
|
||||
}
|
||||
await new Promise((res) => setTimeout(res, 50));
|
||||
}
|
||||
expect(pid).toBeGreaterThan(0);
|
||||
// The lock is held (slow pull) — its recorded PID must be ALIVE.
|
||||
// Pre-fix this held the dead parent's PID and the assertion fails.
|
||||
expect(fs.existsSync(path.join(state, '.setup-lock'))).toBe(true);
|
||||
expect(isAlive(pid)).toBe(true);
|
||||
await waitForLog(state, /UP_TO_DATE|UPDATING|PULL_FAILED/);
|
||||
} finally {
|
||||
fs.rmSync(base, { recursive: true, force: true });
|
||||
}
|
||||
}, 30000);
|
||||
|
||||
test('a live lock with a live pid is respected and survives', async () => {
|
||||
const { base, install, state } = makeFixture();
|
||||
const holder = require('child_process').spawn('sleep', ['30'], { stdio: 'ignore' });
|
||||
try {
|
||||
const lockDir = path.join(state, '.setup-lock');
|
||||
fs.mkdirSync(lockDir, { recursive: true });
|
||||
fs.writeFileSync(path.join(lockDir, 'pid'), String(holder.pid));
|
||||
const r = runScript(install, state);
|
||||
expect(r.status).toBe(0);
|
||||
const log = await waitForLog(state, /SKIP locked_by=/);
|
||||
expect(log).toContain(`SKIP locked_by=${holder.pid}`);
|
||||
expect(fs.existsSync(lockDir)).toBe(true); // NOT rm -rf'd (#2613)
|
||||
} finally {
|
||||
holder.kill();
|
||||
fs.rmSync(base, { recursive: true, force: true });
|
||||
}
|
||||
}, 30000);
|
||||
|
||||
test('a dead pid is reclaimed and the run proceeds', async () => {
|
||||
const { base, install, state } = makeFixture();
|
||||
try {
|
||||
const dead = spawnSync('true', { encoding: 'utf8' }); // reaped by the time spawnSync returns
|
||||
const lockDir = path.join(state, '.setup-lock');
|
||||
fs.mkdirSync(lockDir, { recursive: true });
|
||||
fs.writeFileSync(path.join(lockDir, 'pid'), String(dead.pid));
|
||||
const r = runScript(install, state);
|
||||
expect(r.status).toBe(0);
|
||||
const log = await waitForLog(state, /UP_TO_DATE|UPDATING/);
|
||||
expect(log).toMatch(/UP_TO_DATE|UPDATING/);
|
||||
} finally {
|
||||
fs.rmSync(base, { recursive: true, force: true });
|
||||
}
|
||||
}, 30000);
|
||||
|
||||
test('an empty pidfile inside the TTL window is NOT instantly reaped', async () => {
|
||||
const { base, install, state } = makeFixture();
|
||||
try {
|
||||
const lockDir = path.join(state, '.setup-lock');
|
||||
fs.mkdirSync(lockDir, { recursive: true });
|
||||
fs.writeFileSync(path.join(lockDir, 'pid'), ''); // mkdir→echo race window
|
||||
const r = runScript(install, state);
|
||||
expect(r.status).toBe(0);
|
||||
const log = await waitForLog(state, /SKIP locked_by=/);
|
||||
expect(log).toContain('SKIP locked_by=');
|
||||
expect(fs.existsSync(lockDir)).toBe(true);
|
||||
} finally {
|
||||
fs.rmSync(base, { recursive: true, force: true });
|
||||
}
|
||||
}, 30000);
|
||||
|
||||
test('an expired-TTL lock is reclaimed even when its pid is alive (PID reuse)', async () => {
|
||||
const { base, install, state } = makeFixture();
|
||||
const holder = require('child_process').spawn('sleep', ['30'], { stdio: 'ignore' });
|
||||
try {
|
||||
const lockDir = path.join(state, '.setup-lock');
|
||||
fs.mkdirSync(lockDir, { recursive: true });
|
||||
const pidPath = path.join(lockDir, 'pid');
|
||||
fs.writeFileSync(pidPath, String(holder.pid));
|
||||
// Age the heartbeat past the 30-min TTL: a recycled PID looks alive
|
||||
// forever, so liveness alone can never clear this wedge.
|
||||
const past = new Date(Date.now() - 40 * 60 * 1000);
|
||||
fs.utimesSync(pidPath, past, past);
|
||||
const r = runScript(install, state);
|
||||
expect(r.status).toBe(0);
|
||||
const log = await waitForLog(state, /RECLAIMED lock_ttl_expired/);
|
||||
expect(log).toContain('RECLAIMED lock_ttl_expired');
|
||||
await waitForLog(state, /UP_TO_DATE|UPDATING/);
|
||||
} finally {
|
||||
holder.kill();
|
||||
fs.rmSync(base, { recursive: true, force: true });
|
||||
}
|
||||
}, 30000);
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user