Files
claudetools/.claude/scripts/sync-lock.sh
Mike Swanson 353ba6363c refactor(sync): share the sync lock with /scc and /checkpoint
Extract the per-machine concurrency lock from sync.sh into a sourceable
lib (.claude/scripts/sync-lock.sh) plus a `run <cmd>` wrapper that locks
the current repo (same lock-dir basename, so it mutually excludes with
sync.sh in the ClaudeTools repo and self-scopes in any project repo).
sync.sh now sources it (behavior identical — verified by review). /scc
routes its commit+push through the locked, rebase-safe sync.sh (and drops
the bare YYYY-MM-DD-session.md filename for the per-session-unique one).
/checkpoint now stages+commits atomically under the repo lock so a
concurrent session in a shared worktree can't be swept in. Closes the
remaining commit paths that bypassed the lock shipped in 6b0ce9a.
2026-06-05 19:13:40 -07:00

186 lines
9.7 KiB
Bash

#!/bin/bash
# ClaudeTools shared sync-concurrency lock primitive
# ----------------------------------------------------------------------------
# A per-repo, per-machine critical-section lock shared by every commit path
# (sync.sh, /scc, /checkpoint, ...). Extracted VERBATIM from sync.sh so the
# logic — which already survived two review rounds — is preserved exactly:
# * atomic mkdir lock (flock is frequently absent on Git Bash / MSYS2)
# * stale detection (age threshold OR dead owner PID), with a re-verify guard
# immediately before clearing so a fresh winner is never stolen from
# * rename-aside clear (mv then rm) instead of a bare rm
# * exit 75 (EX_TEMPFAIL) on live-lock contention after the wait budget
# * sleep 1 busy-spin insurance if clearing persistently fails
# * defense-in-depth owner.pid==$$ re-read right after acquisition
# * ownership-checked, idempotent release (owner.pid must be ours or empty)
#
# TWO WAYS TO USE:
# 1. SOURCE it (e.g. from sync.sh). Sourcing defines vars + functions ONLY —
# no trap is installed and the lock is NOT acquired. The caller sets
# SYNC_LOCK_DIR (optional — a default is derived from the current git repo
# if unset), installs its own `trap release_sync_lock EXIT INT TERM`, and
# calls `acquire_sync_lock` where it wants the critical section to begin.
# 2. EXECUTE it as a wrapper: bash sync-lock.sh run <cmd> [args...]
# Resolves the lock dir from the current git repo, installs the trap,
# acquires the lock, runs <cmd>, then releases via the EXIT trap and exits
# with <cmd>'s status. Contention propagates as exit 75.
#
# Lock-dir basename is fixed at `claudetools-sync.lock` so EVERY tool locking
# the same repo root contends on the SAME directory.
# ----------------------------------------------------------------------------
# Colours — define only if the caller hasn't already (sync.sh defines these
# before sourcing; standalone execution needs them too).
: "${RED:=\033[0;31m}"
: "${GREEN:=\033[0;32m}"
: "${YELLOW:=\033[1;33m}"
: "${CYAN:=\033[0;36m}"
: "${NC:=\033[0m}"
# Machine label used in lock diagnostics. sync.sh sets MACHINE before sourcing;
# guard it so standalone wrapper use (under set -u) never trips on an unset var.
: "${MACHINE:=$(hostname 2>/dev/null || echo unknown)}"
# --- Concurrency lock --------------------------------------------------------
# WHY: multiple sync/commit runs on ONE machine must NOT overlap. An interactive
# /sync, /scc, or /checkpoint can collide with the scheduled-task sync, or two
# concurrent Claude sessions can each stage + commit + fetch + rebase + push and
# interleave their git state — corrupting an in-progress rebase, orphaning
# commits, or pushing a half-built tree. We serialize the whole critical section
# behind a single per-machine lock.
#
# PORTABILITY: `flock` is frequently ABSENT on Git Bash (MSYS2), so we can't
# depend on it. An atomic `mkdir` is the lowest common denominator — it fails if
# the directory already exists, atomically, on every platform we run on (Windows
# Git Bash, macOS, Linux). The lock lives under .git/ (never tracked, so a blind
# `git add -A` can't stage it) and is scoped to this repo.
#
# Lock dir: default to the current repo's .git/claudetools-sync.lock IF the
# caller hasn't already set SYNC_LOCK_DIR (sync.sh sets it explicitly).
: "${SYNC_LOCK_DIR:=$(git rev-parse --show-toplevel 2>/dev/null)/.git/claudetools-sync.lock}"
SYNC_LOCK_WAIT="${SYNC_LOCK_WAIT:-120}" # max seconds to wait for a held lock before skipping the run
SYNC_LOCK_STALE="${SYNC_LOCK_STALE:-600}" # seconds after which a held lock is treated as stale (10 min)
SYNC_LOCK_OWNED=0 # becomes 1 only once THIS run owns the lock (gates release)
# Idempotent release — only removes the lock if THIS process actually owns it
# (stored PID == $$), so a "skipping this run" exit can never clobber the lock
# held by the live sync we deferred to. Installed as an EXIT trap by the caller
# because callers run under `set -e`: the lock must be released on error exits too.
release_sync_lock() {
if [ "$SYNC_LOCK_OWNED" = "1" ] && [ -d "$SYNC_LOCK_DIR" ]; then
local owner_pid
owner_pid=$(cat "$SYNC_LOCK_DIR/owner.pid" 2>/dev/null || echo "")
if [ -z "$owner_pid" ] || [ "$owner_pid" = "$$" ]; then
rm -rf "$SYNC_LOCK_DIR" 2>/dev/null || true
fi
SYNC_LOCK_OWNED=0
fi
}
# Portable liveness check. `kill -0 <pid>` works on Git Bash (it maps to the
# Windows process table), macOS, and Linux; guarded so a bad/empty PID is "dead".
sync_pid_alive() {
local pid="$1"
[ -n "$pid" ] || return 1
kill -0 "$pid" 2>/dev/null
}
acquire_sync_lock() {
local waited=0 owner_pid owner_ts now mtime lock_age stale_aside re_pid re_now re_mtime re_age
while true; do
if mkdir "$SYNC_LOCK_DIR" 2>/dev/null; then
SYNC_LOCK_OWNED=1
printf '%s' "$$" > "$SYNC_LOCK_DIR/owner.pid" 2>/dev/null || true
# PID + ISO timestamp inside the lock dir, for diagnostics.
{
printf 'pid=%s\n' "$$"
printf 'iso=%s\n' "$(date -u "+%Y-%m-%dT%H:%M:%SZ")"
printf 'machine=%s\n' "$MACHINE"
} > "$SYNC_LOCK_DIR/owner" 2>/dev/null || true
# Defense-in-depth: confirm we still own the dir we just created. If
# owner.pid isn't ours, drop ownership and re-evaluate (never fatal
# under set -e — comparison is cheap and the body just loops).
if [ "$(cat "$SYNC_LOCK_DIR/owner.pid" 2>/dev/null)" != "$$" ]; then
SYNC_LOCK_OWNED=0; continue
fi
return 0
fi
# mkdir failed -> the lock is held. Decide whether it's stale or live.
owner_pid=$(cat "$SYNC_LOCK_DIR/owner.pid" 2>/dev/null || echo "")
owner_ts=$(sed -n 's/^iso=//p' "$SYNC_LOCK_DIR/owner" 2>/dev/null | head -1)
[ -n "$owner_ts" ] || owner_ts="unknown"
# Stale if the dir is older than the threshold OR the owner PID is dead.
# `stat -c` is GNU/Git-Bash, `stat -f` is BSD/macOS; fall back to 0.
now=$(date +%s 2>/dev/null || echo 0)
mtime=$(stat -c %Y "$SYNC_LOCK_DIR" 2>/dev/null || stat -f %m "$SYNC_LOCK_DIR" 2>/dev/null || echo 0)
lock_age=$(( now - mtime ))
if { [ "$mtime" -gt 0 ] && [ "$lock_age" -ge "$SYNC_LOCK_STALE" ]; } \
|| { [ -n "$owner_pid" ] && ! sync_pid_alive "$owner_pid"; }; then
# Re-verify staleness IMMEDIATELY before clearing. Between the check
# above and here, another racer may have already cleared the stale
# lock and acquired a fresh, LIVE one. Re-read owner.pid + mtime NOW;
# only rename-aside if it is STILL stale this instant. A freshly
# acquired winner has a live PID and fresh mtime, so the loser falls
# through to the live-lock wait path instead of stealing the lock.
re_pid=$(cat "$SYNC_LOCK_DIR/owner.pid" 2>/dev/null || echo "")
re_now=$(date +%s 2>/dev/null || echo 0)
re_mtime=$(stat -c %Y "$SYNC_LOCK_DIR" 2>/dev/null || stat -f %m "$SYNC_LOCK_DIR" 2>/dev/null || echo 0)
re_age=$(( re_now - re_mtime ))
if { [ "$re_mtime" -gt 0 ] && [ "$re_age" -ge "$SYNC_LOCK_STALE" ]; } \
|| { [ -n "$re_pid" ] && ! sync_pid_alive "$re_pid"; }; then
echo -e "${YELLOW}[WARNING]${NC} removing stale sync lock (held by PID ${re_pid:-?} since ${owner_ts}, age ${re_age}s)"
stale_aside="${SYNC_LOCK_DIR}.stale.$$"
if mv "$SYNC_LOCK_DIR" "$stale_aside" 2>/dev/null; then
rm -rf "$stale_aside" 2>/dev/null || true
fi
fi
sleep 1 # insurance: never tight-spin if clearing persistently fails
continue
fi
# Live lock. If we've waited the full budget, skip (a duplicate sync is
# harmless to drop — the next scheduled/interactive run catches up).
if [ "$waited" -ge "$SYNC_LOCK_WAIT" ]; then
echo -e "${YELLOW}[WARNING]${NC} another sync is in progress (held by PID ${owner_pid:-?} since ${owner_ts}); skipping this run"
exit 75 # EX_TEMPFAIL: deferred (another sync in progress), not a real success
fi
sleep 2
waited=$(( waited + 2 ))
done
}
# --- end concurrency lock ----------------------------------------------------
# --- Wrapper mode (direct execution only) ------------------------------------
# Sourcing stops here: the block below runs ONLY when this file is executed
# directly, never when sourced. So sourcing has zero side effects beyond the
# var + function definitions above (no trap, no acquire).
if [ "${BASH_SOURCE[0]}" = "$0" ]; then
# NOT set -e: a non-zero status from the wrapped command must be reported as
# this script's own exit code, not swallowed by an errexit abort.
set -uo pipefail
if [ "${1:-}" != "run" ] || [ -z "${2:-}" ]; then
echo "usage: $(basename "$0") run <command> [args...]" >&2
echo " Acquires the per-repo sync lock, runs <command>, releases, exits with its status." >&2
exit 2
fi
shift # drop the 'run' subcommand; "$@" is now the command + args
# Resolve the lock dir from the CURRENT repo. Must be inside a git repo.
_repo_root=$(git rev-parse --show-toplevel 2>/dev/null || true)
if [ -z "$_repo_root" ]; then
echo -e "${RED}[ERROR]${NC} sync-lock.sh: not inside a git repository (cannot resolve lock dir)" >&2
exit 2
fi
SYNC_LOCK_DIR="$_repo_root/.git/claudetools-sync.lock"
trap release_sync_lock EXIT INT TERM
acquire_sync_lock # exits 75 on contention (propagates to our caller)
"$@"
_status=$?
# Release happens via the EXIT trap; mirror the wrapped command's status.
exit $_status
fi