diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index ea714f49add..f1b7ed7fc86 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc @@ -269,6 +269,10 @@ Gnome Builder currently has support for RLS, and there's no way to configure the 1. Rename, symlink or copy the `rust-analyzer` binary to `rls` and place it somewhere Builder can find (in `PATH`, or under `~/.cargo/bin`). 2. Enable the Rust Builder plugin. +==== GNOME Builder (Nightly) + +https://nightly.gnome.org/repo/appstream/org.gnome.Builder.flatpakref[GNOME Builder (Nightly)] has now native support for `rust-analyzer` out of the box. If the `rust-analyzer` binary is not available, GNOME Builder can install it when opening a Rust source file. + == Non-Cargo Based Projects rust-analyzer does not require Cargo. diff --git a/editors/code/package.json b/editors/code/package.json index e6ceb235fcf..68484a370b0 100644 --- a/editors/code/package.json +++ b/editors/code/package.json @@ -426,7 +426,7 @@ "Full log" ], "default": "off", - "description": "Trace requests to the rust-analyzer" + "description": "Trace requests to the rust-analyzer (this is usually overly verbose and not recommended for regular users)" }, "rust-analyzer.trace.extension": { "description": "Enable logging of VS Code extensions itself", diff --git a/editors/code/src/main.ts b/editors/code/src/main.ts index 670f2ebfd62..12b4d051088 100644 --- a/editors/code/src/main.ts +++ b/editors/code/src/main.ts @@ -43,12 +43,16 @@ export async function activate(context: vscode.ExtensionContext) { const config = new Config(context); const state = new PersistentState(context.globalState); const serverPath = await bootstrap(config, state).catch(err => { - let message = "Failed to bootstrap rust-analyzer."; + let message = "bootstrap error. "; + if (err.code === "EBUSY" || err.code === "ETXTBSY") { - message += " Other vscode windows might be using rust-analyzer, " + - "you should close them and reload this window to retry."; + message += "Other vscode windows might be using rust-analyzer, "; + message += "you should close them and reload this window to retry. "; } - message += " Open \"Help > Toggle Developer Tools > Console\" to see the logs"; + + message += 'Open "Help > Toggle Developer Tools > Console" to see the logs '; + message += '(enable verbose logs with "rust-analyzer.trace.extension")'; + log.error("Bootstrap error", err); throw new Error(message); }); @@ -178,7 +182,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); @@ -299,7 +307,12 @@ async function getServer(config: Config, state: PersistentState): Promise true).catch(_ => false)) { diff --git a/editors/code/src/net.ts b/editors/code/src/net.ts index 9debdc57bfa..e02fd6d4f47 100644 --- a/editors/code/src/net.ts +++ b/editors/code/src/net.ts @@ -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); + }); } /** @@ -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(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(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) { +async function withTempDir(scope: (tempDirPath: string) => Promise) { // Based on the great article: https://advancedweb.hu/secure-tempfiles-in-nodejs-without-dependencies/ // `.realpath()` should handle the cases where os.tmpdir() contains symlinks @@ -144,7 +147,7 @@ async function withTempFile(scope: (tempFilePath: string) => Promise) { 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); @@ -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; } } } diff --git a/editors/code/src/util.ts b/editors/code/src/util.ts index fe3fb71cd7d..fec4c3295e0 100644 --- a/editors/code/src/util.ts +++ b/editors/code/src/util.ts @@ -26,7 +26,6 @@ export const log = new class { } error(message?: any, ...optionalParams: any[]): void { - if (!log.enabled) return; debugger; // eslint-disable-next-line no-console console.error(message, ...optionalParams);