File size: 4,991 Bytes
311fa35 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | import * as fs from "node:fs";
import * as os from "node:os";
import * as path from "node:path";
import { afterEach, beforeEach, describe, expect, it } from "vitest";
import { createIdempotencyStore } from "./idempotency.js";
let jobsDir: string;
function makeJobDir(id: string): void {
fs.mkdirSync(path.join(jobsDir, id), { recursive: true });
}
/** Backdate every stored record so the stale-reservation grace period expires. */
function ageRecords(ageMs = 11 * 60 * 1000): void {
const file = path.join(jobsDir, ".idempotency.json");
const data = JSON.parse(fs.readFileSync(file, "utf-8")) as {
records: Record<string, { createdAt: string }>;
};
for (const record of Object.values(data.records)) {
record.createdAt = new Date(Date.now() - ageMs).toISOString();
}
fs.writeFileSync(file, JSON.stringify(data));
}
beforeEach(() => {
jobsDir = fs.mkdtempSync(path.join(os.tmpdir(), "openreels-idempotency-"));
});
afterEach(() => {
fs.rmSync(jobsDir, { recursive: true, force: true });
});
describe("createIdempotencyStore", () => {
it("reserves a new key", () => {
makeJobDir("job-1");
const store = createIdempotencyStore(jobsDir);
const result = store.reserve("key-1", "job-1");
expect(result.reserved).toBe(true);
expect(result.record).toMatchObject({ key: "key-1", jobId: "job-1" });
expect(store.get("key-1")?.jobId).toBe("job-1");
});
it("returns the existing record when a key is already reserved", () => {
makeJobDir("job-1");
makeJobDir("job-2");
const store = createIdempotencyStore(jobsDir);
store.reserve("key-1", "job-1");
const result = store.reserve("key-1", "job-2");
expect(result.reserved).toBe(false);
expect(result.record.jobId).toBe("job-1");
});
it("persists records across store instances", () => {
makeJobDir("job-1");
createIdempotencyStore(jobsDir).reserve("key-1", "job-1");
expect(createIdempotencyStore(jobsDir).get("key-1")?.jobId).toBe("job-1");
});
it("keeps a fresh reservation before its job directory exists", () => {
const store = createIdempotencyStore(jobsDir);
expect(store.reserve("key-1", "job-1").reserved).toBe(true);
expect(store.get("key-1")?.jobId).toBe("job-1");
expect(store.list().map((record) => record.key)).toEqual(["key-1"]);
});
it("prunes a key whose job directory has been gone past the grace period", () => {
makeJobDir("job-1");
const store = createIdempotencyStore(jobsDir);
store.reserve("key-1", "job-1");
fs.rmSync(path.join(jobsDir, "job-1"), { recursive: true, force: true });
ageRecords();
expect(store.get("key-1")).toBeNull();
expect(store.list()).toEqual([]);
});
it("reclaims a stale key on reserve", () => {
makeJobDir("job-1");
makeJobDir("job-2");
const store = createIdempotencyStore(jobsDir);
store.reserve("key-1", "job-1");
fs.rmSync(path.join(jobsDir, "job-1"), { recursive: true, force: true });
ageRecords();
const result = store.reserve("key-1", "job-2");
expect(result.reserved).toBe(true);
expect(result.record.jobId).toBe("job-2");
});
it("releases a key", () => {
makeJobDir("job-1");
const store = createIdempotencyStore(jobsDir);
store.reserve("key-1", "job-1");
store.release("key-1");
expect(store.get("key-1")).toBeNull();
});
it("removes every key that points at a job", () => {
makeJobDir("job-1");
makeJobDir("job-2");
const store = createIdempotencyStore(jobsDir);
store.reserve("a", "job-1");
store.reserve("b", "job-1");
store.reserve("c", "job-2");
store.removeJob("job-1");
expect(store.list().map((record) => record.key)).toEqual(["c"]);
});
it("lists only live records", () => {
makeJobDir("job-1");
makeJobDir("job-2");
const store = createIdempotencyStore(jobsDir);
store.reserve("a", "job-1");
store.reserve("b", "job-2");
fs.rmSync(path.join(jobsDir, "job-1"), { recursive: true, force: true });
ageRecords();
expect(store.list().map((record) => record.key)).toEqual(["b"]);
});
it("treats a corrupt file as empty", () => {
fs.writeFileSync(path.join(jobsDir, ".idempotency.json"), "{not json");
const store = createIdempotencyStore(jobsDir);
expect(store.list()).toEqual([]);
makeJobDir("job-1");
expect(store.reserve("key-1", "job-1").reserved).toBe(true);
});
it("drops malformed records when reading", () => {
fs.writeFileSync(
path.join(jobsDir, ".idempotency.json"),
JSON.stringify({
version: 1,
records: {
good: { key: "good", jobId: "job-1", createdAt: new Date().toISOString() },
mismatch: { key: "other", jobId: "job-1", createdAt: new Date().toISOString() },
bad: { key: "bad", jobId: 42 },
},
}),
);
makeJobDir("job-1");
const store = createIdempotencyStore(jobsDir);
expect(store.list().map((record) => record.key)).toEqual(["good"]);
});
});
|