Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 59 additions & 1 deletion packages/cli/src/cloud/download.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import {
chmodSync,
createWriteStream,
lstatSync,
mkdtempSync,
readFileSync,
Expand All @@ -11,9 +12,14 @@ import {
} from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { afterEach, beforeEach, describe, expect, it } from "vitest";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { downloadToFile } from "./download.js";

vi.mock("node:fs", async (importOriginal) => {
const actual = await importOriginal<typeof import("node:fs")>();
return { ...actual, createWriteStream: vi.fn(actual.createWriteStream) };
});

function makeBytesFetch(bytes: Uint8Array, headers: Record<string, string> = {}): typeof fetch {
return (async () =>
new Response(new Blob([bytes as unknown as BlobPart]), {
Expand Down Expand Up @@ -187,6 +193,58 @@ describe("cloud/download", () => {
);
});

it("waits for a pending file open to close before cleaning up a failed download", async () => {
const actual = await vi.importActual<typeof import("node:fs")>("node:fs");
const dest = join(dir, "out.mp4");
writeFileSync(dest, "previous render");
let releaseOpen = () => {};
let writerClosed = Promise.resolve();
const openStarted = new Promise<void>((resolveOpen) => {
vi.mocked(createWriteStream).mockImplementationOnce((path, options) => {
const writer = actual.createWriteStream(path, {
...(typeof options === "object" ? options : { encoding: options }),
fs: {
open: (...args: Parameters<typeof actual.open>) => {
releaseOpen = () => actual.open(...args);
resolveOpen();
},
write: actual.write,
close: actual.close,
},
});
writerClosed = new Promise<void>((resolveClose) => writer.once("close", resolveClose));
return writer;
});
});
const body = new ReadableStream<Uint8Array>({
start(controller) {
controller.error(new Error("network interrupted"));
},
});
let settled = false;
let failure: unknown;
const downloading = downloadToFile("https://example/x", dest, {
fetchImpl: (async () => new Response(body)) as typeof fetch,
}).then(
() => {
settled = true;
},
(error: unknown) => {
failure = error;
settled = true;
},
);
await openStarted;
await new Promise<void>((resolve) => setImmediate(resolve));
const settledBeforeOpen = settled;
releaseOpen();
await Promise.all([downloading, writerClosed]);
expect(settledBeforeOpen).toBe(false);
expect(failure).toEqual(new Error("network interrupted"));
expect(readFileSync(dest, "utf8")).toBe("previous render");
expect(readdirSync(dir)).toEqual(["out.mp4"]);
});

it.skipIf(process.platform === "win32")(
"preserves existing and dangling output symlinks",
async () => {
Expand Down
7 changes: 6 additions & 1 deletion packages/cli/src/cloud/download.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,10 @@ export async function downloadToFile(
const stage = mkdtempSync(join(dirname(destination), ".hf-download-"));
const stagedFile = join(stage, "download");
let bytes = 0;
let writerClosed: Promise<void> | undefined;
try {
const writer = createWriteStream(stagedFile, { flags: "wx" });
writerClosed = new Promise<void>((resolveClose) => writer.once("close", resolveClose));
await pipeline(
async function* () {
for await (const chunk of res.body as unknown as AsyncIterable<Uint8Array>) {
Expand All @@ -89,7 +92,7 @@ export async function downloadToFile(
);
}
},
createWriteStream(stagedFile, { flags: "wx" }),
writer,
{ signal: options.signal },
);
options.signal?.throwIfAborted();
Expand All @@ -100,6 +103,8 @@ export async function downloadToFile(
if (options.signal?.aborted && reason instanceof Error) throw reason;
throw error;
} finally {
// An early source error can reject pipeline before the writer's async open finishes.
await writerClosed;
rmSync(stage, { recursive: true, force: true });
}
return { path: destPath, bytes };
Expand Down