summaryrefslogtreecommitdiffhomepage
path: root/packages/shared/test/util
diff options
context:
space:
mode:
authorShoubhit Dash <[email protected]>2026-04-16 17:30:14 +0530
committerShoubhit Dash <[email protected]>2026-04-16 17:30:14 +0530
commit2e18a603f0ea24154908e748493fd4bfaa74fc00 (patch)
treeb723e00af2821b213573b16fa199b64babd5f1f5 /packages/shared/test/util
parent9819eb04614fd607cacb07d754052f1531a82331 (diff)
parent7341718f9234b0cf3a8758c87e91d2006b71bff6 (diff)
downloadopencode-2e18a603f0ea24154908e748493fd4bfaa74fc00.tar.gz
opencode-2e18a603f0ea24154908e748493fd4bfaa74fc00.zip
merge dev
Diffstat (limited to 'packages/shared/test/util')
-rw-r--r--packages/shared/test/util/effect-flock.test.ts389
-rw-r--r--packages/shared/test/util/flock.test.ts426
2 files changed, 815 insertions, 0 deletions
diff --git a/packages/shared/test/util/effect-flock.test.ts b/packages/shared/test/util/effect-flock.test.ts
new file mode 100644
index 000000000..bd71e4f02
--- /dev/null
+++ b/packages/shared/test/util/effect-flock.test.ts
@@ -0,0 +1,389 @@
+import { describe, expect } from "bun:test"
+import { spawn } from "child_process"
+import fs from "fs/promises"
+import path from "path"
+import os from "os"
+import { Cause, Effect, Exit, Layer } from "effect"
+import { testEffect } from "../lib/effect"
+import { AppFileSystem } from "@opencode-ai/shared/filesystem"
+import { EffectFlock } from "@opencode-ai/shared/util/effect-flock"
+import { Global } from "@opencode-ai/shared/global"
+import { Hash } from "@opencode-ai/shared/util/hash"
+
+function lock(dir: string, key: string) {
+ return path.join(dir, Hash.fast(key) + ".lock")
+}
+
+function sleep(ms: number) {
+ return new Promise<void>((resolve) => setTimeout(resolve, ms))
+}
+
+async function exists(file: string) {
+ return fs
+ .stat(file)
+ .then(() => true)
+ .catch(() => false)
+}
+
+async function readJson<T>(p: string): Promise<T> {
+ return JSON.parse(await fs.readFile(p, "utf8"))
+}
+
+// ---------------------------------------------------------------------------
+// Worker subprocess helpers
+// ---------------------------------------------------------------------------
+
+type Msg = {
+ key: string
+ dir: string
+ holdMs?: number
+ ready?: string
+ active?: string
+ done?: string
+}
+
+const root = path.join(import.meta.dir, "../..")
+const worker = path.join(import.meta.dir, "../fixture/effect-flock-worker.ts")
+
+function run(msg: Msg) {
+ return new Promise<{ code: number; stdout: Buffer; stderr: Buffer }>((resolve) => {
+ const proc = spawn(process.execPath, [worker, JSON.stringify(msg)], { cwd: root })
+ const stdout: Buffer[] = []
+ const stderr: Buffer[] = []
+ proc.stdout?.on("data", (data) => stdout.push(Buffer.from(data)))
+ proc.stderr?.on("data", (data) => stderr.push(Buffer.from(data)))
+ proc.on("close", (code) => {
+ resolve({ code: code ?? 1, stdout: Buffer.concat(stdout), stderr: Buffer.concat(stderr) })
+ })
+ })
+}
+
+function spawnWorker(msg: Msg) {
+ return spawn(process.execPath, [worker, JSON.stringify(msg)], {
+ cwd: root,
+ stdio: ["ignore", "pipe", "pipe"],
+ })
+}
+
+function stopWorker(proc: ReturnType<typeof spawnWorker>) {
+ if (proc.exitCode !== null || proc.signalCode !== null) return Promise.resolve()
+ if (process.platform !== "win32" || !proc.pid) {
+ proc.kill()
+ return Promise.resolve()
+ }
+ return new Promise<void>((resolve) => {
+ const killProc = spawn("taskkill", ["/pid", String(proc.pid), "/T", "/F"])
+ killProc.on("close", () => {
+ proc.kill()
+ resolve()
+ })
+ })
+}
+
+async function waitForFile(file: string, timeout = 3_000) {
+ const stop = Date.now() + timeout
+ while (Date.now() < stop) {
+ if (await exists(file)) return
+ await sleep(20)
+ }
+ throw new Error(`Timed out waiting for file: ${file}`)
+}
+
+// ---------------------------------------------------------------------------
+// Test layer
+// ---------------------------------------------------------------------------
+
+const testGlobal = Layer.succeed(
+ Global.Service,
+ Global.Service.of({
+ home: os.homedir(),
+ data: os.tmpdir(),
+ cache: os.tmpdir(),
+ config: os.tmpdir(),
+ state: os.tmpdir(),
+ bin: os.tmpdir(),
+ log: os.tmpdir(),
+ }),
+)
+
+const testLayer = EffectFlock.layer.pipe(Layer.provide(testGlobal), Layer.provide(AppFileSystem.defaultLayer))
+
+// ---------------------------------------------------------------------------
+// Tests
+// ---------------------------------------------------------------------------
+
+describe("util.effect-flock", () => {
+ const it = testEffect(testLayer)
+
+ it.live(
+ "acquire and release via scoped Effect",
+ Effect.gen(function* () {
+ const flock = yield* EffectFlock.Service
+ const tmp = yield* Effect.promise(() => fs.mkdtemp(path.join(os.tmpdir(), "eflock-test-")))
+ const dir = path.join(tmp, "locks")
+ const lockDir = lock(dir, "eflock:acquire")
+
+ yield* Effect.scoped(flock.acquire("eflock:acquire", dir))
+
+ expect(yield* Effect.promise(() => exists(lockDir))).toBe(false)
+ yield* Effect.promise(() => fs.rm(tmp, { recursive: true, force: true }))
+ }),
+ )
+
+ it.live(
+ "withLock data-first",
+ Effect.gen(function* () {
+ const flock = yield* EffectFlock.Service
+ const tmp = yield* Effect.promise(() => fs.mkdtemp(path.join(os.tmpdir(), "eflock-test-")))
+ const dir = path.join(tmp, "locks")
+
+ let hit = false
+ yield* flock.withLock(
+ Effect.sync(() => {
+ hit = true
+ }),
+ "eflock:df",
+ dir,
+ )
+ expect(hit).toBe(true)
+ yield* Effect.promise(() => fs.rm(tmp, { recursive: true, force: true }))
+ }),
+ )
+
+ it.live(
+ "withLock pipeable",
+ Effect.gen(function* () {
+ const flock = yield* EffectFlock.Service
+ const tmp = yield* Effect.promise(() => fs.mkdtemp(path.join(os.tmpdir(), "eflock-test-")))
+ const dir = path.join(tmp, "locks")
+
+ let hit = false
+ yield* Effect.sync(() => {
+ hit = true
+ }).pipe(flock.withLock("eflock:pipe", dir))
+ expect(hit).toBe(true)
+ yield* Effect.promise(() => fs.rm(tmp, { recursive: true, force: true }))
+ }),
+ )
+
+ it.live(
+ "writes owner metadata",
+ Effect.gen(function* () {
+ const flock = yield* EffectFlock.Service
+ const tmp = yield* Effect.promise(() => fs.mkdtemp(path.join(os.tmpdir(), "eflock-test-")))
+ const dir = path.join(tmp, "locks")
+ const key = "eflock:meta"
+ const file = path.join(lock(dir, key), "meta.json")
+
+ yield* Effect.scoped(
+ Effect.gen(function* () {
+ yield* flock.acquire(key, dir)
+ const json = yield* Effect.promise(() =>
+ readJson<{ token?: unknown; pid?: unknown; hostname?: unknown; createdAt?: unknown }>(file),
+ )
+ expect(typeof json.token).toBe("string")
+ expect(typeof json.pid).toBe("number")
+ expect(typeof json.hostname).toBe("string")
+ expect(typeof json.createdAt).toBe("string")
+ }),
+ )
+ yield* Effect.promise(() => fs.rm(tmp, { recursive: true, force: true }))
+ }),
+ )
+
+ it.live(
+ "breaks stale lock dirs",
+ Effect.gen(function* () {
+ const flock = yield* EffectFlock.Service
+ const tmp = yield* Effect.promise(() => fs.mkdtemp(path.join(os.tmpdir(), "eflock-test-")))
+ const dir = path.join(tmp, "locks")
+ const key = "eflock:stale"
+ const lockDir = lock(dir, key)
+
+ yield* Effect.promise(async () => {
+ await fs.mkdir(lockDir, { recursive: true })
+ const old = new Date(Date.now() - 120_000)
+ await fs.utimes(lockDir, old, old)
+ })
+
+ let hit = false
+ yield* flock.withLock(
+ Effect.sync(() => {
+ hit = true
+ }),
+ key,
+ dir,
+ )
+ expect(hit).toBe(true)
+ yield* Effect.promise(() => fs.rm(tmp, { recursive: true, force: true }))
+ }),
+ )
+
+ it.live(
+ "recovers from stale breaker",
+ Effect.gen(function* () {
+ const flock = yield* EffectFlock.Service
+ const tmp = yield* Effect.promise(() => fs.mkdtemp(path.join(os.tmpdir(), "eflock-test-")))
+ const dir = path.join(tmp, "locks")
+ const key = "eflock:stale-breaker"
+ const lockDir = lock(dir, key)
+ const breaker = lockDir + ".breaker"
+
+ yield* Effect.promise(async () => {
+ await fs.mkdir(lockDir, { recursive: true })
+ await fs.mkdir(breaker)
+ const old = new Date(Date.now() - 120_000)
+ await fs.utimes(lockDir, old, old)
+ await fs.utimes(breaker, old, old)
+ })
+
+ let hit = false
+ yield* flock.withLock(
+ Effect.sync(() => {
+ hit = true
+ }),
+ key,
+ dir,
+ )
+ expect(hit).toBe(true)
+ expect(yield* Effect.promise(() => exists(breaker))).toBe(false)
+ yield* Effect.promise(() => fs.rm(tmp, { recursive: true, force: true }))
+ }),
+ )
+
+ it.live(
+ "detects compromise when lock dir removed",
+ Effect.gen(function* () {
+ const flock = yield* EffectFlock.Service
+ const tmp = yield* Effect.promise(() => fs.mkdtemp(path.join(os.tmpdir(), "eflock-test-")))
+ const dir = path.join(tmp, "locks")
+ const key = "eflock:compromised"
+ const lockDir = lock(dir, key)
+
+ const result = yield* flock
+ .withLock(
+ Effect.promise(() => fs.rm(lockDir, { recursive: true, force: true })),
+ key,
+ dir,
+ )
+ .pipe(Effect.exit)
+
+ expect(Exit.isFailure(result)).toBe(true)
+ expect(Exit.isFailure(result) ? Cause.pretty(result.cause) : "").toContain("missing")
+ yield* Effect.promise(() => fs.rm(tmp, { recursive: true, force: true }))
+ }),
+ )
+
+ it.live(
+ "detects token mismatch",
+ Effect.gen(function* () {
+ const flock = yield* EffectFlock.Service
+ const tmp = yield* Effect.promise(() => fs.mkdtemp(path.join(os.tmpdir(), "eflock-test-")))
+ const dir = path.join(tmp, "locks")
+ const key = "eflock:token"
+ const lockDir = lock(dir, key)
+ const meta = path.join(lockDir, "meta.json")
+
+ const result = yield* flock
+ .withLock(
+ Effect.promise(async () => {
+ const json = await readJson<{ token?: string }>(meta)
+ json.token = "tampered"
+ await fs.writeFile(meta, JSON.stringify(json, null, 2))
+ }),
+ key,
+ dir,
+ )
+ .pipe(Effect.exit)
+
+ expect(Exit.isFailure(result)).toBe(true)
+ expect(Exit.isFailure(result) ? Cause.pretty(result.cause) : "").toContain("token mismatch")
+ expect(yield* Effect.promise(() => exists(lockDir))).toBe(true)
+ yield* Effect.promise(() => fs.rm(tmp, { recursive: true, force: true }))
+ }),
+ )
+
+ it.live(
+ "fails on unwritable lock roots",
+ Effect.gen(function* () {
+ if (process.platform === "win32") return
+ const flock = yield* EffectFlock.Service
+ const tmp = yield* Effect.promise(() => fs.mkdtemp(path.join(os.tmpdir(), "eflock-test-")))
+ const dir = path.join(tmp, "locks")
+
+ yield* Effect.promise(async () => {
+ await fs.mkdir(dir, { recursive: true })
+ await fs.chmod(dir, 0o500)
+ })
+
+ const result = yield* flock.withLock(Effect.void, "eflock:perm", dir).pipe(Effect.exit)
+ // oxlint-disable-next-line no-base-to-string -- Exit has a useful toString for test assertions
+ expect(String(result)).toContain("PermissionDenied")
+ yield* Effect.promise(() => fs.chmod(dir, 0o700).then(() => fs.rm(tmp, { recursive: true, force: true })))
+ }),
+ )
+
+ it.live(
+ "enforces mutual exclusion under process contention",
+ () =>
+ Effect.promise(async () => {
+ const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "eflock-stress-"))
+ const dir = path.join(tmp, "locks")
+ const done = path.join(tmp, "done.log")
+ const active = path.join(tmp, "active")
+ const n = 16
+
+ try {
+ const out = await Promise.all(
+ Array.from({ length: n }, () => run({ key: "eflock:stress", dir, done, active, holdMs: 30 })),
+ )
+
+ expect(out.map((x) => x.code)).toEqual(Array.from({ length: n }, () => 0))
+ expect(out.map((x) => x.stderr.toString()).filter(Boolean)).toEqual([])
+
+ const lines = (await fs.readFile(done, "utf8"))
+ .split("\n")
+ .map((x) => x.trim())
+ .filter(Boolean)
+ expect(lines.length).toBe(n)
+ } finally {
+ await fs.rm(tmp, { recursive: true, force: true })
+ }
+ }),
+ 60_000,
+ )
+
+ it.live(
+ "recovers after a crashed lock owner",
+ () =>
+ Effect.promise(async () => {
+ const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "eflock-crash-"))
+ const dir = path.join(tmp, "locks")
+ const ready = path.join(tmp, "ready")
+
+ const proc = spawnWorker({ key: "eflock:crash", dir, ready, holdMs: 120_000 })
+
+ try {
+ await waitForFile(ready, 5_000)
+ await stopWorker(proc)
+ await new Promise((resolve) => proc.on("close", resolve))
+
+ // Backdate lock files so they're past STALE_MS (60s)
+ const lockDir = lock(dir, "eflock:crash")
+ const old = new Date(Date.now() - 120_000)
+ await fs.utimes(lockDir, old, old).catch(() => {})
+ await fs.utimes(path.join(lockDir, "heartbeat"), old, old).catch(() => {})
+ await fs.utimes(path.join(lockDir, "meta.json"), old, old).catch(() => {})
+
+ const done = path.join(tmp, "done.log")
+ const result = await run({ key: "eflock:crash", dir, done, holdMs: 10 })
+ expect(result.code).toBe(0)
+ expect(result.stderr.toString()).toBe("")
+ } finally {
+ await stopWorker(proc).catch(() => {})
+ await fs.rm(tmp, { recursive: true, force: true })
+ }
+ }),
+ 30_000,
+ )
+})
diff --git a/packages/shared/test/util/flock.test.ts b/packages/shared/test/util/flock.test.ts
new file mode 100644
index 000000000..f1053dfd2
--- /dev/null
+++ b/packages/shared/test/util/flock.test.ts
@@ -0,0 +1,426 @@
+import { describe, expect, test } from "bun:test"
+import fs from "fs/promises"
+import { spawn } from "child_process"
+import path from "path"
+import os from "os"
+import { Flock } from "@opencode-ai/shared/util/flock"
+import { Hash } from "@opencode-ai/shared/util/hash"
+
+type Msg = {
+ key: string
+ dir: string
+ staleMs?: number
+ timeoutMs?: number
+ baseDelayMs?: number
+ maxDelayMs?: number
+ holdMs?: number
+ ready?: string
+ active?: string
+ done?: string
+}
+
+const root = path.join(import.meta.dir, "../..")
+const worker = path.join(import.meta.dir, "../fixture/flock-worker.ts")
+
+async function tmpdir() {
+ const dir = await fs.mkdtemp(path.join(os.tmpdir(), "flock-test-"))
+ return {
+ path: dir,
+ async [Symbol.asyncDispose]() {
+ await fs.rm(dir, { recursive: true, force: true })
+ },
+ }
+}
+
+function lock(dir: string, key: string) {
+ return path.join(dir, Hash.fast(key) + ".lock")
+}
+
+function sleep(ms: number) {
+ return new Promise<void>((resolve) => {
+ setTimeout(resolve, ms)
+ })
+}
+
+async function exists(file: string) {
+ return fs
+ .stat(file)
+ .then(() => true)
+ .catch(() => false)
+}
+
+async function wait(file: string, timeout = 3_000) {
+ const stop = Date.now() + timeout
+ while (Date.now() < stop) {
+ if (await exists(file)) return
+ await sleep(20)
+ }
+
+ throw new Error(`Timed out waiting for file: ${file}`)
+}
+
+function run(msg: Msg) {
+ return new Promise<{ code: number; stdout: Buffer; stderr: Buffer }>((resolve) => {
+ const proc = spawn(process.execPath, [worker, JSON.stringify(msg)], {
+ cwd: root,
+ })
+
+ const stdout: Buffer[] = []
+ const stderr: Buffer[] = []
+
+ proc.stdout?.on("data", (data) => stdout.push(Buffer.from(data)))
+ proc.stderr?.on("data", (data) => stderr.push(Buffer.from(data)))
+
+ proc.on("close", (code) => {
+ resolve({
+ code: code ?? 1,
+ stdout: Buffer.concat(stdout),
+ stderr: Buffer.concat(stderr),
+ })
+ })
+ })
+}
+
+function spawnWorker(msg: Msg) {
+ return spawn(process.execPath, [worker, JSON.stringify(msg)], {
+ cwd: root,
+ stdio: ["ignore", "pipe", "pipe"],
+ })
+}
+
+function stopWorker(proc: ReturnType<typeof spawnWorker>) {
+ if (proc.exitCode !== null || proc.signalCode !== null) return Promise.resolve()
+
+ if (process.platform !== "win32" || !proc.pid) {
+ proc.kill()
+ return Promise.resolve()
+ }
+
+ return new Promise<void>((resolve) => {
+ const killProc = spawn("taskkill", ["/pid", String(proc.pid), "/T", "/F"])
+ killProc.on("close", () => {
+ proc.kill()
+ resolve()
+ })
+ })
+}
+
+async function readJson<T>(p: string): Promise<T> {
+ return JSON.parse(await fs.readFile(p, "utf8"))
+}
+
+describe("util.flock", () => {
+ test("enforces mutual exclusion under process contention", async () => {
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const done = path.join(tmp.path, "done.log")
+ const active = path.join(tmp.path, "active")
+ const key = "flock:stress"
+ const n = 16
+
+ const out = await Promise.all(
+ Array.from({ length: n }, () =>
+ run({
+ key,
+ dir,
+ done,
+ active,
+ holdMs: 30,
+ staleMs: 1_000,
+ timeoutMs: 15_000,
+ }),
+ ),
+ )
+
+ expect(out.map((x) => x.code)).toEqual(Array.from({ length: n }, () => 0))
+ expect(out.map((x) => x.stderr.toString()).filter(Boolean)).toEqual([])
+
+ const lines = (await fs.readFile(done, "utf8"))
+ .split("\n")
+ .map((x) => x.trim())
+ .filter(Boolean)
+ expect(lines.length).toBe(n)
+ }, 20_000)
+
+ test("times out while waiting when lock is still healthy", async () => {
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const key = "flock:timeout"
+ const ready = path.join(tmp.path, "ready")
+ const proc = spawnWorker({
+ key,
+ dir,
+ ready,
+ holdMs: 20_000,
+ staleMs: 10_000,
+ timeoutMs: 30_000,
+ })
+
+ try {
+ await wait(ready, 5_000)
+ const seen: string[] = []
+ const err = await Flock.withLock(key, async () => {}, {
+ dir,
+ staleMs: 10_000,
+ timeoutMs: 1_000,
+ onWait: (tick) => {
+ seen.push(tick.key)
+ },
+ }).catch((err) => err)
+
+ expect(err).toBeInstanceOf(Error)
+ if (!(err instanceof Error)) throw err
+ expect(err.message).toContain("Timed out waiting for lock")
+ expect(seen.length).toBeGreaterThan(0)
+ expect(seen.every((x) => x === key)).toBe(true)
+ } finally {
+ await stopWorker(proc).catch(() => undefined)
+ await new Promise((resolve) => proc.on("close", resolve))
+ }
+ }, 15_000)
+
+ test("recovers after a crashed lock owner", async () => {
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const key = "flock:crash"
+ const ready = path.join(tmp.path, "ready")
+ const proc = spawnWorker({
+ key,
+ dir,
+ ready,
+ holdMs: 20_000,
+ staleMs: 500,
+ timeoutMs: 30_000,
+ })
+
+ await wait(ready, 5_000)
+ await stopWorker(proc)
+ await new Promise((resolve) => proc.on("close", resolve))
+
+ let hit = false
+ await Flock.withLock(
+ key,
+ async () => {
+ hit = true
+ },
+ {
+ dir,
+ staleMs: 500,
+ timeoutMs: 8_000,
+ },
+ )
+
+ expect(hit).toBe(true)
+ }, 20_000)
+
+ test("breaks stale lock dirs when heartbeat is missing", async () => {
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const key = "flock:missing-heartbeat"
+ const lockDir = lock(dir, key)
+
+ await fs.mkdir(lockDir, { recursive: true })
+ const old = new Date(Date.now() - 2_000)
+ await fs.utimes(lockDir, old, old)
+
+ let hit = false
+ await Flock.withLock(
+ key,
+ async () => {
+ hit = true
+ },
+ {
+ dir,
+ staleMs: 200,
+ timeoutMs: 3_000,
+ },
+ )
+
+ expect(hit).toBe(true)
+ })
+
+ test("recovers when a stale breaker claim was left behind", async () => {
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const key = "flock:stale-breaker"
+ const lockDir = lock(dir, key)
+ const breaker = lockDir + ".breaker"
+
+ await fs.mkdir(lockDir, { recursive: true })
+ await fs.mkdir(breaker)
+
+ const old = new Date(Date.now() - 2_000)
+ await fs.utimes(lockDir, old, old)
+ await fs.utimes(breaker, old, old)
+
+ let hit = false
+ await Flock.withLock(
+ key,
+ async () => {
+ hit = true
+ },
+ {
+ dir,
+ staleMs: 200,
+ timeoutMs: 3_000,
+ },
+ )
+
+ expect(hit).toBe(true)
+ expect(await exists(breaker)).toBe(false)
+ })
+
+ test("fails clearly if lock dir is removed while held", async () => {
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const key = "flock:compromised"
+ const lockDir = lock(dir, key)
+
+ const err = await Flock.withLock(
+ key,
+ async () => {
+ await fs.rm(lockDir, {
+ recursive: true,
+ force: true,
+ })
+ },
+ {
+ dir,
+ staleMs: 1_000,
+ timeoutMs: 3_000,
+ },
+ ).catch((err) => err)
+
+ expect(err).toBeInstanceOf(Error)
+ if (!(err instanceof Error)) throw err
+ expect(err.message).toContain("compromised")
+
+ let hit = false
+ await Flock.withLock(
+ key,
+ async () => {
+ hit = true
+ },
+ {
+ dir,
+ staleMs: 200,
+ timeoutMs: 3_000,
+ },
+ )
+ expect(hit).toBe(true)
+ })
+
+ test("writes owner metadata while lock is held", async () => {
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const key = "flock:meta"
+ const file = path.join(lock(dir, key), "meta.json")
+
+ await Flock.withLock(
+ key,
+ async () => {
+ const json = await readJson<{
+ token?: unknown
+ pid?: unknown
+ hostname?: unknown
+ createdAt?: unknown
+ }>(file)
+
+ expect(typeof json.token).toBe("string")
+ expect(typeof json.pid).toBe("number")
+ expect(typeof json.hostname).toBe("string")
+ expect(typeof json.createdAt).toBe("string")
+ },
+ {
+ dir,
+ staleMs: 1_000,
+ timeoutMs: 3_000,
+ },
+ )
+ })
+
+ test("supports acquire with await using", async () => {
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const key = "flock:acquire"
+ const lockDir = lock(dir, key)
+
+ {
+ await using _ = await Flock.acquire(key, {
+ dir,
+ staleMs: 1_000,
+ timeoutMs: 3_000,
+ })
+ expect(await exists(lockDir)).toBe(true)
+ }
+
+ expect(await exists(lockDir)).toBe(false)
+ })
+
+ test("refuses token mismatch release and recovers from stale", async () => {
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const key = "flock:token"
+ const lockDir = lock(dir, key)
+ const meta = path.join(lockDir, "meta.json")
+
+ const err = await Flock.withLock(
+ key,
+ async () => {
+ const json = await readJson<{ token?: string }>(meta)
+ json.token = "tampered"
+ await fs.writeFile(meta, JSON.stringify(json, null, 2))
+ },
+ {
+ dir,
+ staleMs: 500,
+ timeoutMs: 3_000,
+ },
+ ).catch((err) => err)
+
+ expect(err).toBeInstanceOf(Error)
+ if (!(err instanceof Error)) throw err
+ expect(err.message).toContain("token mismatch")
+ expect(await exists(lockDir)).toBe(true)
+
+ let hit = false
+ await Flock.withLock(
+ key,
+ async () => {
+ hit = true
+ },
+ {
+ dir,
+ staleMs: 500,
+ timeoutMs: 6_000,
+ },
+ )
+ expect(hit).toBe(true)
+ })
+
+ test("fails clearly on unwritable lock roots", async () => {
+ if (process.platform === "win32") return
+
+ await using tmp = await tmpdir()
+ const dir = path.join(tmp.path, "locks")
+ const key = "flock:perm"
+
+ await fs.mkdir(dir, { recursive: true })
+ await fs.chmod(dir, 0o500)
+
+ try {
+ const err = await Flock.withLock(key, async () => {}, {
+ dir,
+ staleMs: 100,
+ timeoutMs: 500,
+ }).catch((err) => err)
+
+ expect(err).toBeInstanceOf(Error)
+ if (!(err instanceof Error)) throw err
+ const text = err.message
+ expect(text.includes("EACCES") || text.includes("EPERM")).toBe(true)
+ } finally {
+ await fs.chmod(dir, 0o700)
+ }
+ })
+})