vscode: move throtting of download progress to call site

This commit is contained in:
Veetaha 2020-02-09 14:18:05 +02:00
parent a63659badb
commit f3240e22c6
2 changed files with 18 additions and 15 deletions

View file

@ -1,20 +1,18 @@
import fetch from "node-fetch"; import fetch from "node-fetch";
import { throttle } from "throttle-debounce";
import * as fs from "fs"; import * as fs from "fs";
import { strict as assert } from "assert"; import { strict as assert } from "assert";
/** /**
* Downloads file from `url` and stores it at `destFilePath`. * Downloads file from `url` and stores it at `destFilePath`.
* `onProgress` callback is periodically called to track the progress of downloading, * `onProgress` callback is called on recieveing each chunk of bytes
* it gets the already read and total amount of bytes to read as its parameters. * 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( export async function downloadFile(
url: string, url: string,
destFilePath: fs.PathLike, destFilePath: fs.PathLike,
onProgress: (readBytes: number, totalBytes: number) => void onProgress: (readBytes: number, totalBytes: number) => void
): Promise<void> { ): Promise<void> {
onProgress = throttle(200, /* noTrailing: */ true, onProgress);
const response = await fetch(url); const response = await fetch(url);
const totalBytes = Number(response.headers.get('content-length')); const totalBytes = Number(response.headers.get('content-length'));

View file

@ -1,8 +1,9 @@
import { spawnSync } from "child_process";
import * as vscode from "vscode"; import * as vscode from "vscode";
import * as path from "path"; import * as path from "path";
import { strict as assert } from "assert"; import { strict as assert } from "assert";
import { promises as fs } from "fs"; import { promises as fs } from "fs";
import { spawnSync } from "child_process";
import { throttle } from "throttle-debounce";
import { BinarySource } from "./interfaces"; import { BinarySource } from "./interfaces";
import { fetchLatestArtifactMetadata } from "./fetch_latest_artifact_metadata"; import { fetchLatestArtifactMetadata } from "./fetch_latest_artifact_metadata";
@ -28,19 +29,23 @@ export async function downloadLatestLanguageServer(
{ {
location: vscode.ProgressLocation.Notification, location: vscode.ProgressLocation.Notification,
cancellable: false, // FIXME: add support for canceling download? cancellable: false, // FIXME: add support for canceling download?
title: `Downloading language server ${releaseName}` title: `Downloading language server (${releaseName})`
}, },
async (progress, _cancellationToken) => { async (progress, _cancellationToken) => {
let lastPrecentage = 0; let lastPrecentage = 0;
await downloadFile(downloadUrl, installationPath, (readBytes, totalBytes) => { await downloadFile(downloadUrl, installationPath, throttle(
const newPercentage = (readBytes / totalBytes) * 100; 200,
progress.report({ /* noTrailing: */ true,
message: newPercentage.toFixed(0) + "%", (readBytes, totalBytes) => {
increment: newPercentage - lastPrecentage const newPercentage = (readBytes / totalBytes) * 100;
}); progress.report({
message: newPercentage.toFixed(0) + "%",
increment: newPercentage - lastPrecentage
});
lastPrecentage = newPercentage; lastPrecentage = newPercentage;
}); })
);
} }
); );