|
| 1 | +import { describe, expect, it } from "vitest"; |
| 2 | +import { |
| 3 | + existsSync, |
| 4 | + lstatSync, |
| 5 | + mkdirSync, |
| 6 | + mkdtempSync, |
| 7 | + readFileSync, |
| 8 | + readdirSync, |
| 9 | + renameSync as renamePathSync, |
| 10 | + rmSync, |
| 11 | + writeFileSync, |
| 12 | +} from "node:fs"; |
| 13 | +import { dirname, join } from "node:path"; |
| 14 | +import { tmpdir } from "node:os"; |
| 15 | +import { ArtifactTransaction } from "./artifactTransaction.js"; |
| 16 | + |
| 17 | +function tempDir(): string { |
| 18 | + return mkdtempSync(join(tmpdir(), "hf-artifact-transaction-")); |
| 19 | +} |
| 20 | + |
| 21 | +function transactionDirectories(dir: string): string[] { |
| 22 | + return readdirSync(dir).filter((name) => name.includes(".hf-transaction-")); |
| 23 | +} |
| 24 | + |
| 25 | +describe("ArtifactTransaction", () => { |
| 26 | + it("uses a private, atomically reserved sibling directory", () => { |
| 27 | + const dir = tempDir(); |
| 28 | + const destination = join(dir, "render.mp4"); |
| 29 | + const transaction = new ArtifactTransaction(destination, "file"); |
| 30 | + const transactionDir = dirname(transaction.stagingPath); |
| 31 | + |
| 32 | + expect(dirname(transactionDir)).toBe(dir); |
| 33 | + expect(transaction.stagingPath).toBe(join(transactionDir, "render.mp4")); |
| 34 | + if (process.platform !== "win32") { |
| 35 | + expect(lstatSync(transactionDir).mode & 0o777).toBe(0o700); |
| 36 | + } |
| 37 | + |
| 38 | + transaction.rollback(); |
| 39 | + expect(transactionDirectories(dir)).toEqual([]); |
| 40 | + }); |
| 41 | + |
| 42 | + it("atomically replaces a file only after validation", () => { |
| 43 | + const dir = tempDir(); |
| 44 | + const destination = join(dir, "render.mp4"); |
| 45 | + writeFileSync(destination, "existing"); |
| 46 | + const transaction = new ArtifactTransaction(destination, "file"); |
| 47 | + writeFileSync(transaction.stagingPath, "new-render"); |
| 48 | + |
| 49 | + transaction.commit(); |
| 50 | + |
| 51 | + expect(readFileSync(destination, "utf8")).toBe("new-render"); |
| 52 | + expect(existsSync(transaction.stagingPath)).toBe(false); |
| 53 | + expect(transactionDirectories(dir)).toEqual([]); |
| 54 | + }); |
| 55 | + |
| 56 | + it("leaves an existing file byte-identical when validation fails", () => { |
| 57 | + const dir = tempDir(); |
| 58 | + const destination = join(dir, "render.gif"); |
| 59 | + const existing = Buffer.from([0, 1, 2, 3, 255]); |
| 60 | + writeFileSync(destination, existing); |
| 61 | + const transaction = new ArtifactTransaction(destination, "file"); |
| 62 | + writeFileSync(transaction.stagingPath, ""); |
| 63 | + |
| 64 | + expect(() => transaction.commit()).toThrow("not a non-empty file"); |
| 65 | + transaction.rollback(); |
| 66 | + |
| 67 | + expect(readFileSync(destination)).toEqual(existing); |
| 68 | + expect(existsSync(transaction.stagingPath)).toBe(false); |
| 69 | + expect(transactionDirectories(dir)).toEqual([]); |
| 70 | + }); |
| 71 | + |
| 72 | + it("keeps the existing file addressable when atomic promotion fails", () => { |
| 73 | + const dir = tempDir(); |
| 74 | + const destination = join(dir, "render.mp4"); |
| 75 | + writeFileSync(destination, "existing"); |
| 76 | + let replacementCalls = 0; |
| 77 | + const transaction = new ArtifactTransaction(destination, "file", { |
| 78 | + existsSync, |
| 79 | + renameSync(source, target) { |
| 80 | + replacementCalls += 1; |
| 81 | + expect(source).toBe(transaction.stagingPath); |
| 82 | + expect(target).toBe(destination); |
| 83 | + expect(readFileSync(destination, "utf8")).toBe("existing"); |
| 84 | + throw new Error("injected replacement failure"); |
| 85 | + }, |
| 86 | + rmSync, |
| 87 | + }); |
| 88 | + writeFileSync(transaction.stagingPath, "new-render"); |
| 89 | + |
| 90 | + expect(() => transaction.commit()).toThrow("injected replacement failure"); |
| 91 | + expect(replacementCalls).toBe(1); |
| 92 | + expect(readFileSync(destination, "utf8")).toBe("existing"); |
| 93 | + |
| 94 | + transaction.rollback(); |
| 95 | + expect(existsSync(transaction.stagingPath)).toBe(false); |
| 96 | + expect(transactionDirectories(dir)).toEqual([]); |
| 97 | + }); |
| 98 | + |
| 99 | + it("removes cancelled staging output without touching the destination", () => { |
| 100 | + const dir = tempDir(); |
| 101 | + const destination = join(dir, "render.mp4"); |
| 102 | + writeFileSync(destination, "keep-me"); |
| 103 | + const transaction = new ArtifactTransaction(destination, "file"); |
| 104 | + writeFileSync(transaction.stagingPath, "partial-render"); |
| 105 | + |
| 106 | + transaction.rollback(); |
| 107 | + |
| 108 | + expect(readFileSync(destination, "utf8")).toBe("keep-me"); |
| 109 | + expect(existsSync(transaction.stagingPath)).toBe(false); |
| 110 | + expect(transactionDirectories(dir)).toEqual([]); |
| 111 | + }); |
| 112 | + |
| 113 | + it("promotes a validated PNG sequence as one directory artifact", () => { |
| 114 | + const dir = tempDir(); |
| 115 | + const destination = join(dir, "frames"); |
| 116 | + mkdirSync(destination); |
| 117 | + writeFileSync(join(destination, "frame_000001.png"), "old"); |
| 118 | + const transaction = new ArtifactTransaction(destination, "directory"); |
| 119 | + mkdirSync(transaction.stagingPath); |
| 120 | + writeFileSync(join(transaction.stagingPath, "frame_000001.png"), "png-1"); |
| 121 | + writeFileSync(join(transaction.stagingPath, "frame_000002.png"), "png-2"); |
| 122 | + |
| 123 | + transaction.commit(); |
| 124 | + |
| 125 | + expect(readdirSync(destination).sort()).toEqual(["frame_000001.png", "frame_000002.png"]); |
| 126 | + expect(readFileSync(join(destination, "frame_000001.png"), "utf8")).toBe("png-1"); |
| 127 | + expect(transactionDirectories(dir)).toEqual([]); |
| 128 | + }); |
| 129 | + |
| 130 | + it("restores the previous PNG sequence when directory promotion fails", () => { |
| 131 | + const dir = tempDir(); |
| 132 | + const destination = join(dir, "frames"); |
| 133 | + mkdirSync(destination); |
| 134 | + writeFileSync(join(destination, "frame_000001.png"), "existing-frame"); |
| 135 | + let transaction: ArtifactTransaction; |
| 136 | + transaction = new ArtifactTransaction(destination, "directory", { |
| 137 | + existsSync, |
| 138 | + renameSync(source, target) { |
| 139 | + if (source === transaction.stagingPath && target === destination) { |
| 140 | + throw new Error("injected directory promotion failure"); |
| 141 | + } |
| 142 | + renamePathSync(source, target); |
| 143 | + }, |
| 144 | + rmSync, |
| 145 | + }); |
| 146 | + mkdirSync(transaction.stagingPath); |
| 147 | + writeFileSync(join(transaction.stagingPath, "frame_000001.png"), "new-frame"); |
| 148 | + |
| 149 | + expect(() => transaction.commit()).toThrow("injected directory promotion failure"); |
| 150 | + |
| 151 | + expect(readFileSync(join(destination, "frame_000001.png"), "utf8")).toBe("existing-frame"); |
| 152 | + expect(transactionDirectories(dir)).toEqual([]); |
| 153 | + }); |
| 154 | + |
| 155 | + it("does not delete a concurrent PNG sequence published during recovery", () => { |
| 156 | + const dir = tempDir(); |
| 157 | + const destination = join(dir, "frames"); |
| 158 | + mkdirSync(destination); |
| 159 | + writeFileSync(join(destination, "frame_000001.png"), "existing-frame"); |
| 160 | + const concurrentTransaction = new ArtifactTransaction(destination, "directory"); |
| 161 | + mkdirSync(concurrentTransaction.stagingPath); |
| 162 | + writeFileSync(join(concurrentTransaction.stagingPath, "frame_000001.png"), "concurrent-frame"); |
| 163 | + |
| 164 | + let firstTransaction: ArtifactTransaction; |
| 165 | + firstTransaction = new ArtifactTransaction(destination, "directory", { |
| 166 | + existsSync, |
| 167 | + renameSync(source, target) { |
| 168 | + if (source === firstTransaction.stagingPath && target === destination) { |
| 169 | + concurrentTransaction.commit(); |
| 170 | + expect(readFileSync(join(destination, "frame_000001.png"), "utf8")).toBe( |
| 171 | + "concurrent-frame", |
| 172 | + ); |
| 173 | + throw new Error("injected first promotion failure"); |
| 174 | + } |
| 175 | + renamePathSync(source, target); |
| 176 | + }, |
| 177 | + rmSync, |
| 178 | + }); |
| 179 | + mkdirSync(firstTransaction.stagingPath); |
| 180 | + writeFileSync(join(firstTransaction.stagingPath, "frame_000001.png"), "first-frame"); |
| 181 | + |
| 182 | + expect(() => firstTransaction.commit()).toThrow("injected first promotion failure"); |
| 183 | + |
| 184 | + expect(readFileSync(join(destination, "frame_000001.png"), "utf8")).toBe("concurrent-frame"); |
| 185 | + expect(transactionDirectories(dir)).toEqual([]); |
| 186 | + }); |
| 187 | + |
| 188 | + it("rejects an empty PNG sequence and preserves the existing directory", () => { |
| 189 | + const dir = tempDir(); |
| 190 | + const destination = join(dir, "frames"); |
| 191 | + mkdirSync(destination); |
| 192 | + writeFileSync(join(destination, "frame_000001.png"), "existing-frame"); |
| 193 | + const transaction = new ArtifactTransaction(destination, "directory"); |
| 194 | + mkdirSync(transaction.stagingPath); |
| 195 | + |
| 196 | + expect(() => transaction.commit()).toThrow("directory is empty"); |
| 197 | + transaction.rollback(); |
| 198 | + |
| 199 | + expect(readFileSync(join(destination, "frame_000001.png"), "utf8")).toBe("existing-frame"); |
| 200 | + expect(transactionDirectories(dir)).toEqual([]); |
| 201 | + }); |
| 202 | +}); |
0 commit comments