Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Decouple http file stream logic from temp dir logic #4994

Merged
merged 1 commit into from
Jun 23, 2020
Merged

Decouple http file stream logic from temp dir logic #4994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions editors/code/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,11 @@ async function bootstrapExtension(config: Config, state: PersistentState): Promi
assert(!!artifact, `Bad release: ${JSON.stringify(release)}`);

const dest = path.join(config.globalStoragePath, "rust-analyzer.vsix");
await download(artifact.browser_download_url, dest, "Downloading rust-analyzer extension");
await download({
url: artifact.browser_download_url,
dest,
progressTitle: "Downloading rust-analyzer extension",
});

await vscode.commands.executeCommand("workbench.extensions.installExtension", vscode.Uri.file(dest));
await fs.unlink(dest);
Expand Down Expand Up @@ -299,7 +303,12 @@ async function getServer(config: Config, state: PersistentState): Promise<string
if (err.code !== "ENOENT") throw err;
});

await download(artifact.browser_download_url, dest, "Downloading rust-analyzer server", { mode: 0o755 });
await download({
url: artifact.browser_download_url,
dest,
progressTitle: "Downloading rust-analyzer server",
mode: 0o755
});

// Patching executable if that's NixOS.
if (await fs.stat("/etc/nixos").then(_ => true).catch(_ => false)) {
Expand Down
88 changes: 46 additions & 42 deletions editors/code/src/net.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,32 +60,40 @@ export interface GithubRelease {
}>;
}

interface DownloadOpts {
progressTitle: string;
url: string;
dest: string;
mode?: number;
}

export async function download(
downloadUrl: string,
destinationPath: string,
progressTitle: string,
{ mode }: { mode?: number } = {},
) {
await vscode.window.withProgress(
{
location: vscode.ProgressLocation.Notification,
cancellable: false,
title: progressTitle
},
async (progress, _cancellationToken) => {
let lastPercentage = 0;
await downloadFile(downloadUrl, destinationPath, mode, (readBytes, totalBytes) => {
const newPercentage = (readBytes / totalBytes) * 100;
progress.report({
message: newPercentage.toFixed(0) + "%",
increment: newPercentage - lastPercentage
export async function download(opts: DownloadOpts) {
// Put the artifact into a temporary folder to prevent partially downloaded files when user kills vscode
await withTempDir(async tempDir => {
const tempFile = path.join(tempDir, path.basename(opts.dest));

await vscode.window.withProgress(
{
location: vscode.ProgressLocation.Notification,
cancellable: false,
title: opts.progressTitle
},
async (progress, _cancellationToken) => {
let lastPercentage = 0;
await downloadFile(opts.url, tempFile, opts.mode, (readBytes, totalBytes) => {
const newPercentage = (readBytes / totalBytes) * 100;
progress.report({
message: newPercentage.toFixed(0) + "%",
increment: newPercentage - lastPercentage
});

lastPercentage = newPercentage;
});
}
);

lastPercentage = newPercentage;
});
}
);
await moveFile(tempFile, opts.dest);
});
}

/**
Expand Down Expand Up @@ -114,28 +122,23 @@ async function downloadFile(

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

// Put the artifact into a temporary folder to prevent partially downloaded files when user kills vscode
await withTempFile(async tempFilePath => {
const destFileStream = fs.createWriteStream(tempFilePath, { mode });

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

await pipeline(res.body, destFileStream);
await new Promise<void>(resolve => {
destFileStream.on("close", resolve);
destFileStream.destroy();
// This workaround is awaiting to be removed when vscode moves to newer nodejs version:
// https://github.com/rust-analyzer/rust-analyzer/issues/3167
});
await moveFile(tempFilePath, destFilePath);
const destFileStream = fs.createWriteStream(destFilePath, { mode });
await pipeline(res.body, destFileStream);
await new Promise<void>(resolve => {
destFileStream.on("close", resolve);
destFileStream.destroy();
// This workaround is awaiting to be removed when vscode moves to newer nodejs version:
// https://github.com/rust-analyzer/rust-analyzer/issues/3167
});
}

async function withTempFile(scope: (tempFilePath: string) => Promise<void>) {
async function withTempDir(scope: (tempDirPath: string) => Promise<void>) {
// Based on the great article: https://advancedweb.hu/secure-tempfiles-in-nodejs-without-dependencies/

// `.realpath()` should handle the cases where os.tmpdir() contains symlinks
Expand All @@ -144,7 +147,7 @@ async function withTempFile(scope: (tempFilePath: string) => Promise<void>) {
const tempDir = await fs.promises.mkdtemp(path.join(osTempDir, "rust-analyzer"));

try {
return await scope(path.join(tempDir, "file"));
return await scope(tempDir);
} finally {
// We are good citizens :D
void fs.promises.rmdir(tempDir, { recursive: true }).catch(log.error);
Expand All @@ -161,6 +164,7 @@ async function moveFile(src: fs.PathLike, dest: fs.PathLike) {
await fs.promises.unlink(src);
} else {
log.error(`Failed to rename the file ${src} -> ${dest}`, err);
throw err;
}
}
}