|
|
|
|
@@ -6,7 +6,7 @@ import {
|
|
|
|
|
mkdir,
|
|
|
|
|
open,
|
|
|
|
|
readFile,
|
|
|
|
|
rename,
|
|
|
|
|
stat,
|
|
|
|
|
unlink,
|
|
|
|
|
writeFile,
|
|
|
|
|
} from 'node:fs/promises';
|
|
|
|
|
@@ -594,21 +594,10 @@ async function readRestartLockToken(lockPath: string): Promise<string | null> {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns true when an existing lock file is stale: older than
|
|
|
|
|
* RESTART_LOCK_STALE_MS, or unreadable/unparseable (a corrupt or partially
|
|
|
|
|
* written lock left by a crashed owner). A vanished lock (ENOENT) is not stale —
|
|
|
|
|
* the next acquire attempt will simply succeed.
|
|
|
|
|
* Returns true when a lock's contents are stale: older than RESTART_LOCK_STALE_MS,
|
|
|
|
|
* or unparseable (a corrupt or partially written lock left by a crashed owner).
|
|
|
|
|
*/
|
|
|
|
|
async function isRestartLockStale(lockPath: string, now: number): Promise<boolean> {
|
|
|
|
|
let raw: string;
|
|
|
|
|
try {
|
|
|
|
|
raw = await readFile(lockPath, 'utf8');
|
|
|
|
|
} catch (err) {
|
|
|
|
|
if ((err as NodeJS.ErrnoException).code === 'ENOENT') {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
function isRestartLockContentStale(raw: string, now: number): boolean {
|
|
|
|
|
const stampLine = raw.split('\n')[1] ?? '';
|
|
|
|
|
const stamp = Number.parseInt(stampLine.trim(), 10);
|
|
|
|
|
if (!Number.isFinite(stamp)) {
|
|
|
|
|
@@ -618,28 +607,139 @@ async function isRestartLockStale(lockPath: string, now: number): Promise<boolea
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Atomically take over an existing (stale or timed-out) lock WITHOUT blind
|
|
|
|
|
* unlinking it: write our own token to a temp file and `rename()` it over the
|
|
|
|
|
* lock. rename is atomic, so it replaces the prior owner's content in one step
|
|
|
|
|
* rather than the unsafe unlink-then-recreate (which a third restart could slip
|
|
|
|
|
* between). Returns true only if our token is the one on disk afterwards — if a
|
|
|
|
|
* concurrent breaker raced and won, we read back their token and return false so
|
|
|
|
|
* the caller keeps waiting instead of assuming ownership.
|
|
|
|
|
* Path of the short-lived registry mutex that guards EVERY transition of the
|
|
|
|
|
* restart lock (acquire, release, takeover). Held only across a few filesystem
|
|
|
|
|
* ops — never across the restart itself — so contention clears in microseconds.
|
|
|
|
|
*/
|
|
|
|
|
async function breakAndOwnRestartLock(
|
|
|
|
|
lockPath: string,
|
|
|
|
|
token: string,
|
|
|
|
|
content: string,
|
|
|
|
|
): Promise<boolean> {
|
|
|
|
|
const tmpPath = `${lockPath}.${token}`;
|
|
|
|
|
await writeFile(tmpPath, content);
|
|
|
|
|
function restartMutexPath(lockPath: string): string {
|
|
|
|
|
return `${lockPath}.mutex`;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/** Brief back-off between registry-mutex acquisition attempts (held microseconds). */
|
|
|
|
|
const RESTART_MUTEX_RETRY_MS = 20;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Staleness for the internal mutex / reclaim locks, judged by the file's mtime
|
|
|
|
|
* rather than its CONTENT. `open(path, 'wx')` creates the inode (with a fresh
|
|
|
|
|
* mtime) before any token/timestamp is written into it, so a content-based check
|
|
|
|
|
* would momentarily see that empty file as corrupt-and-stale and could reap a
|
|
|
|
|
* lock another contender is still acquiring. mtime is set atomically at creation,
|
|
|
|
|
* so a just-created lock always reads as live; only a lock whose holder died and
|
|
|
|
|
* stopped touching it ages past the threshold. These locks are never held across
|
|
|
|
|
* the restart itself (only a couple of filesystem ops), so any mtime this old can
|
|
|
|
|
* belong only to a dead holder.
|
|
|
|
|
*/
|
|
|
|
|
async function isRestartLockPathStale(path: string, now: number): Promise<boolean> {
|
|
|
|
|
try {
|
|
|
|
|
await rename(tmpPath, lockPath);
|
|
|
|
|
const info = await stat(path);
|
|
|
|
|
return now - info.mtimeMs >= RESTART_LOCK_STALE_MS;
|
|
|
|
|
} catch (err) {
|
|
|
|
|
await unlink(tmpPath).catch(() => {});
|
|
|
|
|
throw err;
|
|
|
|
|
if ((err as NodeJS.ErrnoException).code === 'ENOENT') {
|
|
|
|
|
return false; // Gone, not stale — the caller will re-contend.
|
|
|
|
|
}
|
|
|
|
|
return false; // Can't stat — treat as live and back off rather than reap.
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/** Path of the reclaim lock that serializes reaping of a crashed-holder mutex. */
|
|
|
|
|
function restartReclaimPath(mutexPath: string): string {
|
|
|
|
|
return `${mutexPath}.reclaim`;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Reap a registry mutex left behind by a process that CRASHED mid-transition —
|
|
|
|
|
* one whose file has aged past RESTART_LOCK_STALE_MS. Because the mutex is held
|
|
|
|
|
* only for a couple of filesystem ops (no sleeps, never across the restart), a
|
|
|
|
|
* mutex this old can only belong to a dead holder.
|
|
|
|
|
*
|
|
|
|
|
* The reap removes the dead mutex but never CREATES/holds it — acquisition stays
|
|
|
|
|
* the single `open('wx')` create in {@link acquireRestartMutex}, so exactly one
|
|
|
|
|
* contender wins ownership no matter how the reap and acquires interleave. The
|
|
|
|
|
* removal is made conditional by a dedicated reclaim lock: while it is held the
|
|
|
|
|
* dead mutex is stable (its dead holder will never touch it, and no other
|
|
|
|
|
* reclaimer can race), so re-reading it and removing it only if it is STILL stale
|
|
|
|
|
* is a true compare — a live holder's fresh mutex is never removed. This closes
|
|
|
|
|
* the reclaim race a content-blind rename-and-restore left open (a third
|
|
|
|
|
* contender slipping into the gap while a fresh mutex was moved aside).
|
|
|
|
|
*/
|
|
|
|
|
async function reclaimStaleRestartMutex(mutexPath: string): Promise<void> {
|
|
|
|
|
const reclaimPath = restartReclaimPath(mutexPath);
|
|
|
|
|
let handle: Awaited<ReturnType<typeof open>>;
|
|
|
|
|
try {
|
|
|
|
|
handle = await open(reclaimPath, 'wx');
|
|
|
|
|
} catch (err) {
|
|
|
|
|
if ((err as NodeJS.ErrnoException).code !== 'EEXIST') {
|
|
|
|
|
throw err;
|
|
|
|
|
}
|
|
|
|
|
// Someone is already reclaiming. If their reclaim lock is itself stale by
|
|
|
|
|
// mtime, its holder crashed mid-reap (the lock spans only a stat + unlink,
|
|
|
|
|
// microseconds) — clear it so a later pass can retry. Otherwise a live
|
|
|
|
|
// reclaimer has it; back off. Either way we do not reap the mutex this pass.
|
|
|
|
|
if (await isRestartLockPathStale(reclaimPath, Date.now())) {
|
|
|
|
|
await unlink(reclaimPath).catch(() => {});
|
|
|
|
|
}
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
try {
|
|
|
|
|
// Re-check the mutex UNDER the reclaim lock and remove it only if it is STILL
|
|
|
|
|
// stale by mtime. A live holder's mutex is fresh and is left untouched; a dead
|
|
|
|
|
// holder's mutex is stable here (its holder is gone and no other reclaimer can
|
|
|
|
|
// race us), so this re-check is authoritative.
|
|
|
|
|
if (await isRestartLockPathStale(mutexPath, Date.now())) {
|
|
|
|
|
await unlink(mutexPath).catch(() => {});
|
|
|
|
|
}
|
|
|
|
|
} finally {
|
|
|
|
|
await handle.close();
|
|
|
|
|
await unlink(reclaimPath).catch(() => {});
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Acquire the registry mutex, BLOCKING (with brief back-offs) until held, and
|
|
|
|
|
* return a token-gated release. This is the single point of mutual exclusion for
|
|
|
|
|
* the restart lock: acquire, release, and stale/timeout takeover all run under it,
|
|
|
|
|
* so "read the lock, then mutate it" is atomic — no acquirer, releaser, or breaker
|
|
|
|
|
* can ever interleave with another. A mutex left by a crashed holder is reclaimed
|
|
|
|
|
* once it ages past the stale threshold.
|
|
|
|
|
*/
|
|
|
|
|
async function acquireRestartMutex(
|
|
|
|
|
mutexPath: string,
|
|
|
|
|
token: string,
|
|
|
|
|
): Promise<RestartGuard['release']> {
|
|
|
|
|
for (;;) {
|
|
|
|
|
let handle: Awaited<ReturnType<typeof open>>;
|
|
|
|
|
try {
|
|
|
|
|
handle = await open(mutexPath, 'wx');
|
|
|
|
|
} catch (err) {
|
|
|
|
|
if ((err as NodeJS.ErrnoException).code !== 'EEXIST') {
|
|
|
|
|
throw err;
|
|
|
|
|
}
|
|
|
|
|
// Staleness is judged by mtime, not content, so a mutex that exists but has
|
|
|
|
|
// not yet had its token written (the open-before-write window) reads as live
|
|
|
|
|
// and is never wrongly reaped.
|
|
|
|
|
if (!(await isRestartLockPathStale(mutexPath, Date.now()))) {
|
|
|
|
|
// A live holder has it — it will be gone in microseconds. Back off briefly.
|
|
|
|
|
await new Promise((resolve) => setTimeout(resolve, RESTART_MUTEX_RETRY_MS));
|
|
|
|
|
continue;
|
|
|
|
|
}
|
|
|
|
|
await reclaimStaleRestartMutex(mutexPath);
|
|
|
|
|
continue;
|
|
|
|
|
}
|
|
|
|
|
// We created the mutex. Populate it with our token; if writing fails, clean up
|
|
|
|
|
// our own file so we never leak an empty mutex that a peer would have to reap.
|
|
|
|
|
try {
|
|
|
|
|
await handle.writeFile(formatRestartLockContent(token));
|
|
|
|
|
await handle.close();
|
|
|
|
|
} catch (err) {
|
|
|
|
|
await handle.close().catch(() => {});
|
|
|
|
|
await unlink(mutexPath).catch(() => {});
|
|
|
|
|
throw err;
|
|
|
|
|
}
|
|
|
|
|
return async (): Promise<void> => {
|
|
|
|
|
if ((await readRestartLockToken(mutexPath)) !== token) return;
|
|
|
|
|
await unlink(mutexPath).catch(() => {});
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
return (await readRestartLockToken(lockPath)) === token;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
@@ -652,11 +752,16 @@ async function breakAndOwnRestartLock(
|
|
|
|
|
* by a crashed owner, and after RESTART_LOCK_MAX_WAIT_MS breaks the lock to
|
|
|
|
|
* avoid a permanent deadlock.
|
|
|
|
|
*
|
|
|
|
|
* Ownership is tracked by a unique per-acquire token written into the lock.
|
|
|
|
|
* `release()` only unlinks the lock while our token is still on disk, and a
|
|
|
|
|
* break takes ownership atomically — so once another caller has broken and
|
|
|
|
|
* re-owned the lock, neither the timed-out original owner's `release()` nor a
|
|
|
|
|
* stale `break` can drop the new owner's lock and let a third restart interleave.
|
|
|
|
|
* Correctness rests on a single invariant: EVERY transition of the lock — taking
|
|
|
|
|
* a free lock, taking over a stale/timed-out one, and releasing — happens under
|
|
|
|
|
* the registry mutex. Because the check ("is the lock free / stale / fresh?") and
|
|
|
|
|
* the mutation that follows it both run while the mutex is held, they are atomic:
|
|
|
|
|
* no other acquirer, releaser, or breaker can slip in between. That is what makes
|
|
|
|
|
* takeover a true compare-and-swap rather than a content-blind clobber — a normal
|
|
|
|
|
* `open('wx')` acquirer cannot create a fresh lock in a gap, and the original
|
|
|
|
|
* owner's `release()` (also mutex-gated and token-checked) cannot drop a lock a
|
|
|
|
|
* breaker already took over. So no interleaving lets two restarts both own the
|
|
|
|
|
* lock and run concurrently.
|
|
|
|
|
*/
|
|
|
|
|
export async function acquireRestartLock(
|
|
|
|
|
mosaicHome: string,
|
|
|
|
|
@@ -664,50 +769,67 @@ export async function acquireRestartLock(
|
|
|
|
|
): Promise<RestartGuard> {
|
|
|
|
|
const token = randomUUID();
|
|
|
|
|
const lockPath = restartLockPath(mosaicHome);
|
|
|
|
|
const mutexPath = restartMutexPath(lockPath);
|
|
|
|
|
await mkdir(dirname(lockPath), { recursive: true });
|
|
|
|
|
const release = async (): Promise<void> => {
|
|
|
|
|
// Ownership-safe: only remove the lock if it is still ours. If another
|
|
|
|
|
// caller broke and re-owned it (after a stale/timeout break), the token no
|
|
|
|
|
// longer matches and we must leave their lock intact.
|
|
|
|
|
if ((await readRestartLockToken(lockPath)) !== token) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
// Mutex-gated and token-gated: only remove the lock if it is still ours. If
|
|
|
|
|
// another caller took it over (after a stale/timeout break) the token no
|
|
|
|
|
// longer matches and we leave their lock intact.
|
|
|
|
|
const releaseMutex = await acquireRestartMutex(mutexPath, token);
|
|
|
|
|
try {
|
|
|
|
|
await unlink(lockPath);
|
|
|
|
|
} catch {
|
|
|
|
|
// Raced away between the token check and unlink — nothing more to do.
|
|
|
|
|
if ((await readRestartLockToken(lockPath)) === token) {
|
|
|
|
|
await unlink(lockPath).catch(() => {});
|
|
|
|
|
}
|
|
|
|
|
} finally {
|
|
|
|
|
await releaseMutex();
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
const deadline = Date.now() + RESTART_LOCK_MAX_WAIT_MS;
|
|
|
|
|
for (;;) {
|
|
|
|
|
let owned = false;
|
|
|
|
|
const releaseMutex = await acquireRestartMutex(mutexPath, token);
|
|
|
|
|
try {
|
|
|
|
|
const handle = await open(lockPath, 'wx');
|
|
|
|
|
await handle.writeFile(formatRestartLockContent(token));
|
|
|
|
|
await handle.close();
|
|
|
|
|
return { release };
|
|
|
|
|
} catch (err) {
|
|
|
|
|
if ((err as NodeJS.ErrnoException).code !== 'EEXIST') {
|
|
|
|
|
throw err;
|
|
|
|
|
// Read and (if appropriate) mutate the lock atomically under the mutex.
|
|
|
|
|
let current: string | null = null;
|
|
|
|
|
let absent = false;
|
|
|
|
|
try {
|
|
|
|
|
current = await readFile(lockPath, 'utf8');
|
|
|
|
|
} catch (readErr) {
|
|
|
|
|
if ((readErr as NodeJS.ErrnoException).code === 'ENOENT') {
|
|
|
|
|
absent = true;
|
|
|
|
|
} else {
|
|
|
|
|
current = null; // Unreadable/corrupt: treat as stale.
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
// A restart is already in flight (or its lock was left behind).
|
|
|
|
|
const stale = await isRestartLockStale(lockPath, Date.now());
|
|
|
|
|
const timedOut = Date.now() >= deadline;
|
|
|
|
|
if (stale || timedOut) {
|
|
|
|
|
if (await breakAndOwnRestartLock(lockPath, token, formatRestartLockContent(token))) {
|
|
|
|
|
const now = Date.now();
|
|
|
|
|
if (absent) {
|
|
|
|
|
// Lock is free — take it.
|
|
|
|
|
await writeFile(lockPath, formatRestartLockContent(token));
|
|
|
|
|
owned = true;
|
|
|
|
|
} else {
|
|
|
|
|
const stale = current === null || isRestartLockContentStale(current, now);
|
|
|
|
|
const timedOut = now >= deadline;
|
|
|
|
|
if (stale || timedOut) {
|
|
|
|
|
process.stderr.write(
|
|
|
|
|
stale
|
|
|
|
|
? 'Breaking stale fleet restart lock and proceeding.\n'
|
|
|
|
|
? 'Breaking stale fleet restart lock.\n'
|
|
|
|
|
: `Timed out after ${RESTART_LOCK_MAX_WAIT_MS}ms waiting for the in-flight fleet ` +
|
|
|
|
|
'restart; breaking the lock and proceeding.\n',
|
|
|
|
|
'restart; breaking the lock.\n',
|
|
|
|
|
);
|
|
|
|
|
return { release };
|
|
|
|
|
// Takeover is just an overwrite — safe because we hold the mutex, so no
|
|
|
|
|
// acquirer or releaser can touch the lock between our read and this write.
|
|
|
|
|
await writeFile(lockPath, formatRestartLockContent(token));
|
|
|
|
|
owned = true;
|
|
|
|
|
}
|
|
|
|
|
// A concurrent breaker won the takeover; back off and re-evaluate.
|
|
|
|
|
await sleepFn(RESTART_LOCK_POLL_INTERVAL_MS);
|
|
|
|
|
continue;
|
|
|
|
|
// else: a fresh restart owns it — wait below and re-evaluate.
|
|
|
|
|
}
|
|
|
|
|
await sleepFn(RESTART_LOCK_POLL_INTERVAL_MS);
|
|
|
|
|
} finally {
|
|
|
|
|
await releaseMutex();
|
|
|
|
|
}
|
|
|
|
|
if (owned) {
|
|
|
|
|
return { release };
|
|
|
|
|
}
|
|
|
|
|
await sleepFn(RESTART_LOCK_POLL_INTERVAL_MS);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|