aboutsummaryrefslogtreecommitdiff
path: root/editors/code/src/installation/download_file.ts
blob: b31d2a736d25f7a7e6402d7f476bd2407c9219b7 (plain)
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
import fetch from "node-fetch";
import * as fs from "fs";
import * as stream from "stream";
import * as util from "util";
import { strict as assert } from "assert";
import { NestedError } from "ts-nested-error";

const pipeline = util.promisify(stream.pipeline);

class DownloadFileError extends NestedError {}

/**
 * Downloads file from `url` and stores it at `destFilePath` with `destFilePermissions`.
 * `onProgress` callback is called on recieveing each chunk of bytes
 * to track the progress of downloading, it gets the already read and total
 * amount of bytes to read as its parameters.
 */
export async function downloadFile(
    url: string,
    destFilePath: fs.PathLike,
    destFilePermissions: number,
    onProgress: (readBytes: number, totalBytes: number) => void
): Promise<void> {
    const res = await fetch(url).catch(DownloadFileError.rethrow("Failed at initial fetch"));

    if (!res.ok) {
        console.log("Error", res.status, "while downloading file from", url);
        console.dir({ body: await res.text(), headers: res.headers }, { depth: 3 });

        throw new DownloadFileError(`Got response ${res.status}`);
    }

    const totalBytes = Number(res.headers.get('content-length'));
    assert(!Number.isNaN(totalBytes), "Sanity check of content-length protocol");

    console.log("Downloading file of", totalBytes, "bytes size from", url, "to", destFilePath);

    let readBytes = 0;
    res.body.on("data", (chunk: Buffer) => {
        readBytes += chunk.length;
        onProgress(readBytes, totalBytes);
    });

    const destFileStream = fs.createWriteStream(destFilePath, { mode: destFilePermissions });

    await pipeline(res.body, destFileStream).catch(DownloadFileError.rethrow("Piping file error"));
    return new Promise<void>(resolve => {
        destFileStream.on("close", resolve); // details on workaround: https://github.com/rust-analyzer/rust-analyzer/pull/3092#discussion_r378191131
        destFileStream.destroy();
    });
}