Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-11-15 01:17:27 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge #5025

Browse source 
5025: Don't mess with messy temp dir and just download into extension dir r=matklad a=Veetaha

Temp dirs are messy. Dealing with them requires handling quite a bunch of
edge cases. As proposed by lnicola this seems better to just put the temp files
in the extension dir and not care much about suddenly leaving garbage.
Instead we get shorter and less platform-caveat-y code.
We will also assume users don't try to issue a download in different vscode windows simultaneously.

Fixes #5019 

Co-authored-by: Veetaha <veetaha2@gmail.com>
This commit is contained in:
bors[bot] 2020-06-24 22:09:28 +00:00 committed by GitHub
commit 104fad65da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
editors/code/src/net.ts
View file

@ -1,10 +1,10 @@
import fetch from "node-fetch";
import * as vscode from "vscode";
import * as stream from "stream";
import * as crypto from "crypto";
import * as fs from "fs";
import * as os from "os";
import * as path from "path";
import * as util from "util";
import * as path from "path";
import { log, assert } from "./util";
const pipeline = util.promisify(stream.pipeline);
@ -68,32 +68,33 @@ interface DownloadOpts {
}
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));
// Put artifact into a temporary file (in the same dir for simplicity)
// to prevent partially downloaded files when user kills vscode
const dest = path.parse(opts.dest);
const randomHex = crypto.randomBytes(5).toString("hex");
const tempFile = path.join(dest.dir, `${dest.name}${randomHex}`);
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;
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
});
}
);
await moveFile(tempFile, opts.dest);
});
lastPercentage = newPercentage;
});
}
);
await fs.promises.rename(tempFile, opts.dest);
}
/**
@ -137,34 +138,3 @@ async function downloadFile(
// https://github.com/rust-analyzer/rust-analyzer/issues/3167
});
}
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
const osTempDir = await fs.promises.realpath(os.tmpdir());
const tempDir = await fs.promises.mkdtemp(path.join(osTempDir, "rust-analyzer"));
try {
return await scope(tempDir);
} finally {
// We are good citizens :D
void fs.promises.rmdir(tempDir, { recursive: true }).catch(log.error);
}
};
async function moveFile(src: fs.PathLike, dest: fs.PathLike) {
try {
await fs.promises.rename(src, dest);
} catch (err) {
if (err.code === 'EXDEV') {
// We are probably moving the file across partitions/devices
await fs.promises.copyFile(src, dest);
await fs.promises.unlink(src);
} else {
log.error(`Failed to rename the file ${src} -> ${dest}`, err);
throw err;
}
}
}