1 import * as vscode from 'vscode';
2 import * as path from "path";
3 import * as os from "os";
4 import { promises as fs, PathLike } from "fs";
6 import * as commands from './commands';
7 import { activateInlayHints } from './inlay_hints';
8 import { Ctx } from './ctx';
9 import { Config, NIGHTLY_TAG } from './config';
10 import { log, assert, isValidExecutable } from './util';
11 import { PersistentState } from './persistent_state';
12 import { fetchRelease, download } from './net';
13 import { activateTaskProvider } from './tasks';
14 import { setContextValue } from './util';
15 import { exec } from 'child_process';
17 let ctx: Ctx | undefined;
19 const RUST_PROJECT_CONTEXT_NAME = "inRustProject";
21 export async function activate(context: vscode.ExtensionContext) {
22 // For some reason vscode not always shows pop-up error notifications
23 // when an extension fails to activate, so we do it explicitly by ourselves.
24 // FIXME: remove this bit of code once vscode fixes this issue: https://github.com/microsoft/vscode/issues/101242
25 await tryActivate(context).catch(err => {
26 void vscode.window.showErrorMessage(`Cannot activate rust-analyzer: ${err.message}`);
31 async function tryActivate(context: vscode.ExtensionContext) {
32 // Register a "dumb" onEnter command for the case where server fails to
35 // FIXME: refactor command registration code such that commands are
36 // **always** registered, even if the server does not start. Use API like
41 // factory: (Ctx) => ((Ctx) => any),
42 // fallback: () => any = () => vscode.window.showErrorMessage(
43 // "rust-analyzer is not available"
46 const defaultOnEnter = vscode.commands.registerCommand(
47 'rust-analyzer.onEnter',
48 () => vscode.commands.executeCommand('default:type', { text: '\n' }),
50 context.subscriptions.push(defaultOnEnter);
52 const config = new Config(context);
53 const state = new PersistentState(context.globalState);
54 const serverPath = await bootstrap(config, state).catch(err => {
55 let message = "bootstrap error. ";
57 if (err.code === "EBUSY" || err.code === "ETXTBSY" || err.code === "EPERM") {
58 message += "Other vscode windows might be using rust-analyzer, ";
59 message += "you should close them and reload this window to retry. ";
62 message += 'See the logs in "OUTPUT > Rust Analyzer Client" (should open automatically). ';
63 message += 'To enable verbose logs use { "rust-analyzer.trace.extension": true }';
65 log.error("Bootstrap error", err);
66 throw new Error(message);
69 const workspaceFolder = vscode.workspace.workspaceFolders?.[0];
70 if (workspaceFolder === undefined) {
71 throw new Error("no folder is opened");
74 // Note: we try to start the server before we activate type hints so that it
75 // registers its `onDidChangeDocument` handler before us.
77 // This a horribly, horribly wrong way to deal with this problem.
78 ctx = await Ctx.create(config, context, serverPath, workspaceFolder.uri.fsPath);
80 setContextValue(RUST_PROJECT_CONTEXT_NAME, true);
82 // Commands which invokes manually via command palette, shortcut, etc.
84 // Reloading is inspired by @DanTup maneuver: https://github.com/microsoft/vscode/issues/45774#issuecomment-373423895
85 ctx.registerCommand('reload', _ => async () => {
86 void vscode.window.showInformationMessage('Reloading rust-analyzer...');
88 while (context.subscriptions.length > 0) {
90 context.subscriptions.pop()!.dispose();
92 log.error("Dispose error:", err);
95 await activate(context).catch(log.error);
98 ctx.registerCommand('updateGithubToken', ctx => async () => {
99 await queryForGithubToken(new PersistentState(ctx.globalState));
102 ctx.registerCommand('analyzerStatus', commands.analyzerStatus);
103 ctx.registerCommand('memoryUsage', commands.memoryUsage);
104 ctx.registerCommand('reloadWorkspace', commands.reloadWorkspace);
105 ctx.registerCommand('matchingBrace', commands.matchingBrace);
106 ctx.registerCommand('joinLines', commands.joinLines);
107 ctx.registerCommand('parentModule', commands.parentModule);
108 ctx.registerCommand('syntaxTree', commands.syntaxTree);
109 ctx.registerCommand('expandMacro', commands.expandMacro);
110 ctx.registerCommand('run', commands.run);
111 ctx.registerCommand('debug', commands.debug);
112 ctx.registerCommand('newDebugConfig', commands.newDebugConfig);
113 ctx.registerCommand('openDocs', commands.openDocs);
114 ctx.registerCommand('openCargoToml', commands.openCargoToml);
116 defaultOnEnter.dispose();
117 ctx.registerCommand('onEnter', commands.onEnter);
119 ctx.registerCommand('ssr', commands.ssr);
120 ctx.registerCommand('serverVersion', commands.serverVersion);
121 ctx.registerCommand('toggleInlayHints', commands.toggleInlayHints);
123 // Internal commands which are invoked by the server.
124 ctx.registerCommand('runSingle', commands.runSingle);
125 ctx.registerCommand('debugSingle', commands.debugSingle);
126 ctx.registerCommand('showReferences', commands.showReferences);
127 ctx.registerCommand('applySnippetWorkspaceEdit', commands.applySnippetWorkspaceEditCommand);
128 ctx.registerCommand('resolveCodeAction', commands.resolveCodeAction);
129 ctx.registerCommand('applyActionGroup', commands.applyActionGroup);
130 ctx.registerCommand('gotoLocation', commands.gotoLocation);
132 ctx.pushCleanup(activateTaskProvider(workspaceFolder, ctx.config));
134 activateInlayHints(ctx);
135 warnAboutRustLangExtensionConflict();
137 vscode.workspace.onDidChangeConfiguration(
138 _ => ctx?.client?.sendNotification('workspace/didChangeConfiguration', { settings: "" }),
144 export async function deactivate() {
145 setContextValue(RUST_PROJECT_CONTEXT_NAME, undefined);
146 await ctx?.client.stop();
150 async function bootstrap(config: Config, state: PersistentState): Promise<string> {
151 await fs.mkdir(config.globalStoragePath, { recursive: true });
153 await bootstrapExtension(config, state);
154 const path = await bootstrapServer(config, state);
159 async function bootstrapExtension(config: Config, state: PersistentState): Promise<void> {
160 if (config.package.releaseTag === null) return;
161 if (config.channel === "stable") {
162 if (config.package.releaseTag === NIGHTLY_TAG) {
163 void vscode.window.showWarningMessage(
164 `You are running a nightly version of rust-analyzer extension. ` +
165 `To switch to stable, uninstall the extension and re-install it from the marketplace`
171 const now = Date.now();
172 if (config.package.releaseTag === NIGHTLY_TAG) {
173 // Check if we should poll github api for the new nightly version
174 // if we haven't done it during the past hour
175 const lastCheck = state.lastCheck;
177 const anHour = 60 * 60 * 1000;
178 const shouldCheckForNewNightly = state.releaseId === undefined || (now - (lastCheck ?? 0)) > anHour;
180 if (!shouldCheckForNewNightly) return;
183 const release = await downloadWithRetryDialog(state, async () => {
184 return await fetchRelease("nightly", state.githubToken);
187 if (state.releaseId === undefined) { // Show error only for the initial download
188 vscode.window.showErrorMessage(`Failed to download rust-analyzer nightly ${e}`);
192 if (release === undefined || release.id === state.releaseId) return;
194 const userResponse = await vscode.window.showInformationMessage(
195 "New version of rust-analyzer (nightly) is available (requires reload).",
198 if (userResponse !== "Update") return;
200 const artifact = release.assets.find(artifact => artifact.name === "rust-analyzer.vsix");
201 assert(!!artifact, `Bad release: ${JSON.stringify(release)}`);
203 const dest = path.join(config.globalStoragePath, "rust-analyzer.vsix");
205 await downloadWithRetryDialog(state, async () => {
207 url: artifact.browser_download_url,
209 progressTitle: "Downloading rust-analyzer extension",
214 await vscode.commands.executeCommand("workbench.extensions.installExtension", vscode.Uri.file(dest));
215 await fs.unlink(dest);
217 await state.updateReleaseId(release.id);
218 await state.updateLastCheck(now);
219 await vscode.commands.executeCommand("workbench.action.reloadWindow");
222 async function bootstrapServer(config: Config, state: PersistentState): Promise<string> {
223 const path = await getServer(config, state);
226 "Rust Analyzer Language Server is not available. " +
227 "Please, ensure its [proper installation](https://rust-analyzer.github.io/manual.html#installation)."
231 log.info("Using server binary at", path);
233 if (!isValidExecutable(path)) {
234 throw new Error(`Failed to execute ${path} --version`);
240 async function patchelf(dest: PathLike): Promise<void> {
241 await vscode.window.withProgress(
243 location: vscode.ProgressLocation.Notification,
244 title: "Patching rust-analyzer for NixOS"
246 async (progress, _) => {
248 {src, pkgs ? import <nixpkgs> {}}:
249 pkgs.stdenv.mkDerivation {
250 name = "rust-analyzer";
252 phases = [ "installPhase" "fixupPhase" ];
253 installPhase = "cp $src $out";
256 patchelf --set-interpreter "$(cat $NIX_CC/nix-support/dynamic-linker)" $out
260 const origFile = dest + "-orig";
261 await fs.rename(dest, origFile);
262 progress.report({ message: "Patching executable", increment: 20 });
263 await new Promise((resolve, reject) => {
264 const handle = exec(`nix-build -E - --arg src '${origFile}' -o ${dest}`,
265 (err, stdout, stderr) => {
267 reject(Error(stderr));
272 handle.stdin?.write(expression);
275 await fs.unlink(origFile);
280 async function getServer(config: Config, state: PersistentState): Promise<string | undefined> {
281 const explicitPath = process.env.__RA_LSP_SERVER_DEBUG ?? config.serverPath;
283 if (explicitPath.startsWith("~/")) {
284 return os.homedir() + explicitPath.slice("~".length);
288 if (config.package.releaseTag === null) return "rust-analyzer";
290 let platform: string | undefined;
291 if (process.arch === "x64" || process.arch === "ia32") {
292 if (process.platform === "linux") platform = "linux";
293 if (process.platform === "darwin") platform = "mac";
294 if (process.platform === "win32") platform = "windows";
296 if (platform === undefined) {
297 vscode.window.showErrorMessage(
298 "Unfortunately we don't ship binaries for your platform yet. " +
299 "You need to manually clone rust-analyzer repository and " +
300 "run `cargo xtask install --server` to build the language server from sources. " +
301 "If you feel that your platform should be supported, please create an issue " +
302 "about that [here](https://github.com/rust-analyzer/rust-analyzer/issues) and we " +
307 const ext = platform === "windows" ? ".exe" : "";
308 const dest = path.join(config.globalStoragePath, `rust-analyzer-${platform}${ext}`);
309 const exists = await fs.stat(dest).then(() => true, () => false);
311 await state.updateServerVersion(undefined);
314 if (state.serverVersion === config.package.version) return dest;
316 if (config.askBeforeDownload) {
317 const userResponse = await vscode.window.showInformationMessage(
318 `Language server version ${config.package.version} for rust-analyzer is not installed.`,
321 if (userResponse !== "Download now") return dest;
324 const releaseTag = config.package.releaseTag;
325 const release = await downloadWithRetryDialog(state, async () => {
326 return await fetchRelease(releaseTag, state.githubToken);
328 const artifact = release.assets.find(artifact => artifact.name === `rust-analyzer-${platform}.gz`);
329 assert(!!artifact, `Bad release: ${JSON.stringify(release)}`);
331 await downloadWithRetryDialog(state, async () => {
333 url: artifact.browser_download_url,
335 progressTitle: "Downloading rust-analyzer server",
342 // Patching executable if that's NixOS.
343 if (await fs.stat("/etc/nixos").then(_ => true).catch(_ => false)) {
344 await patchelf(dest);
347 await state.updateServerVersion(config.package.version);
351 async function downloadWithRetryDialog<T>(state: PersistentState, downloadFunc: () => Promise<T>): Promise<T> {
354 return await downloadFunc();
356 const selected = await vscode.window.showErrorMessage("Failed to download: " + e.message, {}, {
357 title: "Update Github Auth Token",
360 title: "Retry download",
366 if (selected?.updateToken) {
367 await queryForGithubToken(state);
369 } else if (selected?.retry) {
377 async function queryForGithubToken(state: PersistentState): Promise<void> {
378 const githubTokenOptions: vscode.InputBoxOptions = {
379 value: state.githubToken,
382 This dialog allows to store a Github authorization token.
383 The usage of an authorization token will increase the rate
384 limit on the use of Github APIs and can thereby prevent getting
386 Auth tokens can be created at https://github.com/settings/tokens`,
389 const newToken = await vscode.window.showInputBox(githubTokenOptions);
390 if (newToken === undefined) {
391 // The user aborted the dialog => Do not update the stored token
395 if (newToken === "") {
396 log.info("Clearing github token");
397 await state.updateGithubToken(undefined);
399 log.info("Storing new github token");
400 await state.updateGithubToken(newToken);
404 function warnAboutRustLangExtensionConflict() {
405 const rustLangExt = vscode.extensions.getExtension("rust-lang.rust");
406 if (rustLangExt !== undefined) {
407 vscode.window .showWarningMessage(
408 "You have both rust-analyzer (matklad.rust-analyzer) and Rust (rust-lang.rust) " +
409 "plugins enabled. These are known to conflict and cause various functions of " +
410 "both plugins to not work correctly. You should disable one of them.", "Got it")