diff options
| author | Dax <[email protected]> | 2026-04-25 10:59:17 -0400 |
|---|---|---|
| committer | GitHub <[email protected]> | 2026-04-25 10:59:17 -0400 |
| commit | 62ef2a220723a6d6cb050e523fcdfaa974dafdda (patch) | |
| tree | 214b03d016e18e4d8fe1bfc7209c1edd86547bbd /packages/shared/test | |
| parent | 37aa8442dc023fad250f2573c8235a544789900c (diff) | |
| download | opencode-62ef2a220723a6d6cb050e523fcdfaa974dafdda.tar.gz opencode-62ef2a220723a6d6cb050e523fcdfaa974dafdda.zip | |
refactor: rename shared package to core (#24309)
Diffstat (limited to 'packages/shared/test')
| -rw-r--r-- | packages/shared/test/filesystem/filesystem.test.ts | 338 | ||||
| -rw-r--r-- | packages/shared/test/fixture/effect-flock-worker.ts | 63 | ||||
| -rw-r--r-- | packages/shared/test/fixture/flock-worker.ts | 72 | ||||
| -rw-r--r-- | packages/shared/test/lib/effect.ts | 53 | ||||
| -rw-r--r-- | packages/shared/test/util/effect-flock.test.ts | 389 | ||||
| -rw-r--r-- | packages/shared/test/util/flock.test.ts | 426 |
6 files changed, 0 insertions, 1341 deletions
diff --git a/packages/shared/test/filesystem/filesystem.test.ts b/packages/shared/test/filesystem/filesystem.test.ts deleted file mode 100644 index b49026bcb..000000000 --- a/packages/shared/test/filesystem/filesystem.test.ts +++ /dev/null @@ -1,338 +0,0 @@ -import { describe, test, expect } from "bun:test" -import { Effect, Layer, FileSystem } from "effect" -import { NodeFileSystem } from "@effect/platform-node" -import { AppFileSystem } from "@opencode-ai/shared/filesystem" -import { testEffect } from "../lib/effect" -import path from "path" - -const live = AppFileSystem.layer.pipe(Layer.provideMerge(NodeFileSystem.layer)) -const { effect: it } = testEffect(live) - -describe("AppFileSystem", () => { - describe("isDir", () => { - it( - "returns true for directories", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - expect(yield* fs.isDir(tmp)).toBe(true) - }), - ) - - it( - "returns false for files", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const file = path.join(tmp, "test.txt") - yield* filesys.writeFileString(file, "hello") - expect(yield* fs.isDir(file)).toBe(false) - }), - ) - - it( - "returns false for non-existent paths", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - expect(yield* fs.isDir("/tmp/nonexistent-" + Math.random())).toBe(false) - }), - ) - }) - - describe("isFile", () => { - it( - "returns true for files", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const file = path.join(tmp, "test.txt") - yield* filesys.writeFileString(file, "hello") - expect(yield* fs.isFile(file)).toBe(true) - }), - ) - - it( - "returns false for directories", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - expect(yield* fs.isFile(tmp)).toBe(false) - }), - ) - }) - - describe("readJson / writeJson", () => { - it( - "round-trips JSON data", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const file = path.join(tmp, "data.json") - const data = { name: "test", count: 42, nested: { ok: true } } - - yield* fs.writeJson(file, data) - const result = yield* fs.readJson(file) - - expect(result).toEqual(data) - }), - ) - }) - - describe("ensureDir", () => { - it( - "creates nested directories", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const nested = path.join(tmp, "a", "b", "c") - - yield* fs.ensureDir(nested) - - const info = yield* filesys.stat(nested) - expect(info.type).toBe("Directory") - }), - ) - - it( - "is idempotent", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const dir = path.join(tmp, "existing") - yield* filesys.makeDirectory(dir) - - yield* fs.ensureDir(dir) - - const info = yield* filesys.stat(dir) - expect(info.type).toBe("Directory") - }), - ) - }) - - describe("writeWithDirs", () => { - it( - "creates parent directories if missing", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const file = path.join(tmp, "deep", "nested", "file.txt") - - yield* fs.writeWithDirs(file, "hello") - - expect(yield* filesys.readFileString(file)).toBe("hello") - }), - ) - - it( - "writes directly when parent exists", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const file = path.join(tmp, "direct.txt") - - yield* fs.writeWithDirs(file, "world") - - expect(yield* filesys.readFileString(file)).toBe("world") - }), - ) - - it( - "writes Uint8Array content", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const file = path.join(tmp, "binary.bin") - const content = new Uint8Array([0x00, 0x01, 0x02, 0x03]) - - yield* fs.writeWithDirs(file, content) - - const result = yield* filesys.readFile(file) - expect(new Uint8Array(result)).toEqual(content) - }), - ) - }) - - describe("findUp", () => { - it( - "finds target in start directory", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - yield* filesys.writeFileString(path.join(tmp, "target.txt"), "found") - - const result = yield* fs.findUp("target.txt", tmp) - expect(result).toEqual([path.join(tmp, "target.txt")]) - }), - ) - - it( - "finds target in parent directories", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - yield* filesys.writeFileString(path.join(tmp, "marker"), "root") - const child = path.join(tmp, "a", "b") - yield* filesys.makeDirectory(child, { recursive: true }) - - const result = yield* fs.findUp("marker", child, tmp) - expect(result).toEqual([path.join(tmp, "marker")]) - }), - ) - - it( - "returns empty array when not found", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const result = yield* fs.findUp("nonexistent", tmp, tmp) - expect(result).toEqual([]) - }), - ) - }) - - describe("up", () => { - it( - "finds multiple targets walking up", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - yield* filesys.writeFileString(path.join(tmp, "a.txt"), "a") - yield* filesys.writeFileString(path.join(tmp, "b.txt"), "b") - const child = path.join(tmp, "sub") - yield* filesys.makeDirectory(child) - yield* filesys.writeFileString(path.join(child, "a.txt"), "a-child") - - const result = yield* fs.up({ targets: ["a.txt", "b.txt"], start: child, stop: tmp }) - - expect(result).toContain(path.join(child, "a.txt")) - expect(result).toContain(path.join(tmp, "a.txt")) - expect(result).toContain(path.join(tmp, "b.txt")) - }), - ) - }) - - describe("glob", () => { - it( - "finds files matching pattern", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - yield* filesys.writeFileString(path.join(tmp, "a.ts"), "a") - yield* filesys.writeFileString(path.join(tmp, "b.ts"), "b") - yield* filesys.writeFileString(path.join(tmp, "c.json"), "c") - - const result = yield* fs.glob("*.ts", { cwd: tmp }) - expect(result.sort()).toEqual(["a.ts", "b.ts"]) - }), - ) - - it( - "supports absolute paths", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - yield* filesys.writeFileString(path.join(tmp, "file.txt"), "hello") - - const result = yield* fs.glob("*.txt", { cwd: tmp, absolute: true }) - expect(result).toEqual([path.join(tmp, "file.txt")]) - }), - ) - }) - - describe("globMatch", () => { - it( - "matches patterns", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - expect(fs.globMatch("*.ts", "foo.ts")).toBe(true) - expect(fs.globMatch("*.ts", "foo.json")).toBe(false) - expect(fs.globMatch("src/**", "src/a/b.ts")).toBe(true) - }), - ) - }) - - describe("globUp", () => { - it( - "finds files walking up directories", - Effect.gen(function* () { - const fs = yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - yield* filesys.writeFileString(path.join(tmp, "root.md"), "root") - const child = path.join(tmp, "a", "b") - yield* filesys.makeDirectory(child, { recursive: true }) - yield* filesys.writeFileString(path.join(child, "leaf.md"), "leaf") - - const result = yield* fs.globUp("*.md", child, tmp) - expect(result).toContain(path.join(child, "leaf.md")) - expect(result).toContain(path.join(tmp, "root.md")) - }), - ) - }) - - describe("built-in passthrough", () => { - it( - "exists works", - Effect.gen(function* () { - yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const file = path.join(tmp, "exists.txt") - yield* filesys.writeFileString(file, "yes") - - expect(yield* filesys.exists(file)).toBe(true) - expect(yield* filesys.exists(file + ".nope")).toBe(false) - }), - ) - - it( - "remove works", - Effect.gen(function* () { - yield* AppFileSystem.Service - const filesys = yield* FileSystem.FileSystem - const tmp = yield* filesys.makeTempDirectoryScoped() - const file = path.join(tmp, "delete-me.txt") - yield* filesys.writeFileString(file, "bye") - - yield* filesys.remove(file) - - expect(yield* filesys.exists(file)).toBe(false) - }), - ) - }) - - describe("pure helpers", () => { - test("mimeType returns correct types", () => { - expect(AppFileSystem.mimeType("file.json")).toBe("application/json") - expect(AppFileSystem.mimeType("image.png")).toBe("image/png") - expect(AppFileSystem.mimeType("unknown.qzx")).toBe("application/octet-stream") - }) - - test("contains checks path containment", () => { - expect(AppFileSystem.contains("/a/b", "/a/b/c")).toBe(true) - expect(AppFileSystem.contains("/a/b", "/a/c")).toBe(false) - }) - - test("overlaps detects overlapping paths", () => { - expect(AppFileSystem.overlaps("/a/b", "/a/b/c")).toBe(true) - expect(AppFileSystem.overlaps("/a/b/c", "/a/b")).toBe(true) - expect(AppFileSystem.overlaps("/a", "/b")).toBe(false) - }) - }) -}) diff --git a/packages/shared/test/fixture/effect-flock-worker.ts b/packages/shared/test/fixture/effect-flock-worker.ts deleted file mode 100644 index c9116c2d5..000000000 --- a/packages/shared/test/fixture/effect-flock-worker.ts +++ /dev/null @@ -1,63 +0,0 @@ -import fs from "fs/promises" -import os from "os" -import { Effect, Layer } from "effect" -import { AppFileSystem } from "@opencode-ai/shared/filesystem" -import { EffectFlock } from "@opencode-ai/shared/util/effect-flock" -import { Global } from "@opencode-ai/shared/global" - -type Msg = { - key: string - dir: string - holdMs?: number - ready?: string - active?: string - done?: string -} - -function sleep(ms: number) { - return new Promise<void>((resolve) => setTimeout(resolve, ms)) -} - -const msg: Msg = JSON.parse(process.argv[2]!) - -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)) - -async function job() { - if (msg.ready) await fs.writeFile(msg.ready, String(process.pid)) - if (msg.active) await fs.writeFile(msg.active, String(process.pid), { flag: "wx" }) - - try { - if (msg.holdMs && msg.holdMs > 0) await sleep(msg.holdMs) - if (msg.done) await fs.appendFile(msg.done, "1\n") - } finally { - if (msg.active) await fs.rm(msg.active, { force: true }) - } -} - -await Effect.runPromise( - Effect.gen(function* () { - const flock = yield* EffectFlock.Service - yield* flock.withLock( - Effect.promise(() => job()), - msg.key, - msg.dir, - ) - }).pipe(Effect.provide(testLayer)), -).catch((err) => { - const text = err instanceof Error ? (err.stack ?? err.message) : String(err) - process.stderr.write(text) - process.exit(1) -}) diff --git a/packages/shared/test/fixture/flock-worker.ts b/packages/shared/test/fixture/flock-worker.ts deleted file mode 100644 index 9954d290c..000000000 --- a/packages/shared/test/fixture/flock-worker.ts +++ /dev/null @@ -1,72 +0,0 @@ -import fs from "fs/promises" -import { Flock } from "@opencode-ai/shared/util/flock" - -type Msg = { - key: string - dir: string - staleMs?: number - timeoutMs?: number - baseDelayMs?: number - maxDelayMs?: number - holdMs?: number - ready?: string - active?: string - done?: string -} - -function sleep(ms: number) { - return new Promise<void>((resolve) => { - setTimeout(resolve, ms) - }) -} - -function input() { - const raw = process.argv[2] - if (!raw) { - throw new Error("Missing flock worker input") - } - - return JSON.parse(raw) as Msg -} - -async function job(input: Msg) { - if (input.ready) { - await fs.writeFile(input.ready, String(process.pid)) - } - - if (input.active) { - await fs.writeFile(input.active, String(process.pid), { flag: "wx" }) - } - - try { - if (input.holdMs && input.holdMs > 0) { - await sleep(input.holdMs) - } - - if (input.done) { - await fs.appendFile(input.done, "1\n") - } - } finally { - if (input.active) { - await fs.rm(input.active, { force: true }) - } - } -} - -async function main() { - const msg = input() - - await Flock.withLock(msg.key, () => job(msg), { - dir: msg.dir, - staleMs: msg.staleMs, - timeoutMs: msg.timeoutMs, - baseDelayMs: msg.baseDelayMs, - maxDelayMs: msg.maxDelayMs, - }) -} - -await main().catch((err) => { - const text = err instanceof Error ? (err.stack ?? err.message) : String(err) - process.stderr.write(text) - process.exit(1) -}) diff --git a/packages/shared/test/lib/effect.ts b/packages/shared/test/lib/effect.ts deleted file mode 100644 index 131ec5cc6..000000000 --- a/packages/shared/test/lib/effect.ts +++ /dev/null @@ -1,53 +0,0 @@ -import { test, type TestOptions } from "bun:test" -import { Cause, Effect, Exit, Layer } from "effect" -import type * as Scope from "effect/Scope" -import * as TestClock from "effect/testing/TestClock" -import * as TestConsole from "effect/testing/TestConsole" - -type Body<A, E, R> = Effect.Effect<A, E, R> | (() => Effect.Effect<A, E, R>) - -const body = <A, E, R>(value: Body<A, E, R>) => Effect.suspend(() => (typeof value === "function" ? value() : value)) - -const run = <A, E, R, E2>(value: Body<A, E, R | Scope.Scope>, layer: Layer.Layer<R, E2>) => - Effect.gen(function* () { - const exit = yield* body(value).pipe(Effect.scoped, Effect.provide(layer), Effect.exit) - if (Exit.isFailure(exit)) { - for (const err of Cause.prettyErrors(exit.cause)) { - yield* Effect.logError(err) - } - } - return yield* exit - }).pipe(Effect.runPromise) - -const make = <R, E>(testLayer: Layer.Layer<R, E>, liveLayer: Layer.Layer<R, E>) => { - const effect = <A, E2>(name: string, value: Body<A, E2, R | Scope.Scope>, opts?: number | TestOptions) => - test(name, () => run(value, testLayer), opts) - - effect.only = <A, E2>(name: string, value: Body<A, E2, R | Scope.Scope>, opts?: number | TestOptions) => - test.only(name, () => run(value, testLayer), opts) - - effect.skip = <A, E2>(name: string, value: Body<A, E2, R | Scope.Scope>, opts?: number | TestOptions) => - test.skip(name, () => run(value, testLayer), opts) - - const live = <A, E2>(name: string, value: Body<A, E2, R | Scope.Scope>, opts?: number | TestOptions) => - test(name, () => run(value, liveLayer), opts) - - live.only = <A, E2>(name: string, value: Body<A, E2, R | Scope.Scope>, opts?: number | TestOptions) => - test.only(name, () => run(value, liveLayer), opts) - - live.skip = <A, E2>(name: string, value: Body<A, E2, R | Scope.Scope>, opts?: number | TestOptions) => - test.skip(name, () => run(value, liveLayer), opts) - - return { effect, live } -} - -// Test environment with TestClock and TestConsole -const testEnv = Layer.mergeAll(TestConsole.layer, TestClock.layer()) - -// Live environment - uses real clock, but keeps TestConsole for output capture -const liveEnv = TestConsole.layer - -export const it = make(testEnv, liveEnv) - -export const testEffect = <R, E>(layer: Layer.Layer<R, E>) => - make(Layer.provideMerge(layer, testEnv), Layer.provideMerge(layer, liveEnv)) diff --git a/packages/shared/test/util/effect-flock.test.ts b/packages/shared/test/util/effect-flock.test.ts deleted file mode 100644 index bd71e4f02..000000000 --- a/packages/shared/test/util/effect-flock.test.ts +++ /dev/null @@ -1,389 +0,0 @@ -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 deleted file mode 100644 index f1053dfd2..000000000 --- a/packages/shared/test/util/flock.test.ts +++ /dev/null @@ -1,426 +0,0 @@ -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) - } - }) -}) |
