editors/code/src/main.ts

   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";
   5
   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';
  16
  17 let ctx: Ctx | undefined;
  18
  19 const RUST_PROJECT_CONTEXT_NAME = "inRustProject";
  20
  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}`);
  27         throw err;
  28     });
  29 }
  30
  31 async function tryActivate(context: vscode.ExtensionContext) {
  32     // Register a "dumb" onEnter command for the case where server fails to
  33     // start.
  34     //
  35     // FIXME: refactor command registration code such that commands are
  36     // **always** registered, even if the server does not start. Use API like
  37     // this perhaps?
  38     //
  39     // ```TypeScript
  40     // registerCommand(
  41     //    factory: (Ctx) => ((Ctx) => any),
  42     //    fallback: () => any = () => vscode.window.showErrorMessage(
  43     //        "rust-analyzer is not available"
  44     //    ),
  45     // )
  46     const defaultOnEnter = vscode.commands.registerCommand(
  47         'rust-analyzer.onEnter',
  48         () => vscode.commands.executeCommand('default:type', { text: '\n' }),
  49     );
  50     context.subscriptions.push(defaultOnEnter);
  51
  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. ";
  56
  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. ";
  60         }
  61
  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 }';
  64
  65         log.error("Bootstrap error", err);
  66         throw new Error(message);
  67     });
  68
  69     const workspaceFolder = vscode.workspace.workspaceFolders?.[0];
  70     if (workspaceFolder === undefined) {
  71         throw new Error("no folder is opened");
  72     }
  73
  74     // Note: we try to start the server before we activate type hints so that it
  75     // registers its `onDidChangeDocument` handler before us.
  76     //
  77     // This a horribly, horribly wrong way to deal with this problem.
  78     ctx = await Ctx.create(config, context, serverPath, workspaceFolder.uri.fsPath);
  79
  80     setContextValue(RUST_PROJECT_CONTEXT_NAME, true);
  81
  82     // Commands which invokes manually via command palette, shortcut, etc.
  83
  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...');
  87         await deactivate();
  88         while (context.subscriptions.length > 0) {
  89             try {
  90                 context.subscriptions.pop()!.dispose();
  91             } catch (err) {
  92                 log.error("Dispose error:", err);
  93             }
  94         }
  95         await activate(context).catch(log.error);
  96     });
  97
  98     ctx.registerCommand('updateGithubToken', ctx => async () => {
  99         await queryForGithubToken(new PersistentState(ctx.globalState));
 100     });
 101
 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);
 115
 116     defaultOnEnter.dispose();
 117     ctx.registerCommand('onEnter', commands.onEnter);
 118
 119     ctx.registerCommand('ssr', commands.ssr);
 120     ctx.registerCommand('serverVersion', commands.serverVersion);
 121     ctx.registerCommand('toggleInlayHints', commands.toggleInlayHints);
 122
 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);
 131
 132     ctx.pushCleanup(activateTaskProvider(workspaceFolder, ctx.config));
 133
 134     activateInlayHints(ctx);
 135
 136     vscode.workspace.onDidChangeConfiguration(
 137         _ => ctx?.client?.sendNotification('workspace/didChangeConfiguration', { settings: "" }),
 138         null,
 139         ctx.subscriptions,
 140     );
 141 }
 142
 143 export async function deactivate() {
 144     setContextValue(RUST_PROJECT_CONTEXT_NAME, undefined);
 145     await ctx?.client.stop();
 146     ctx = undefined;
 147 }
 148
 149 async function bootstrap(config: Config, state: PersistentState): Promise<string> {
 150     await fs.mkdir(config.globalStoragePath, { recursive: true });
 151
 152     await bootstrapExtension(config, state);
 153     const path = await bootstrapServer(config, state);
 154
 155     return path;
 156 }
 157
 158 async function bootstrapExtension(config: Config, state: PersistentState): Promise<void> {
 159     if (config.package.releaseTag === null) return;
 160     if (config.channel === "stable") {
 161         if (config.package.releaseTag === NIGHTLY_TAG) {
 162             void vscode.window.showWarningMessage(
 163                 `You are running a nightly version of rust-analyzer extension. ` +
 164                 `To switch to stable, uninstall the extension and re-install it from the marketplace`
 165             );
 166         }
 167         return;
 168     };
 169
 170     const now = Date.now();
 171     if (config.package.releaseTag === NIGHTLY_TAG) {
 172         // Check if we should poll github api for the new nightly version
 173         // if we haven't done it during the past hour
 174         const lastCheck = state.lastCheck;
 175
 176         const anHour = 60 * 60 * 1000;
 177         const shouldCheckForNewNightly = state.releaseId === undefined || (now - (lastCheck ?? 0)) > anHour;
 178
 179         if (!shouldCheckForNewNightly) return;
 180     }
 181
 182     const release = await downloadWithRetryDialog(state, async () => {
 183         return await fetchRelease("nightly", state.githubToken);
 184     }).catch((e) => {
 185         log.error(e);
 186         if (state.releaseId === undefined) { // Show error only for the initial download
 187             vscode.window.showErrorMessage(`Failed to download rust-analyzer nightly ${e}`);
 188         }
 189         return undefined;
 190     });
 191     if (release === undefined || release.id === state.releaseId) return;
 192
 193     const userResponse = await vscode.window.showInformationMessage(
 194         "New version of rust-analyzer (nightly) is available (requires reload).",
 195         "Update"
 196     );
 197     if (userResponse !== "Update") return;
 198
 199     const artifact = release.assets.find(artifact => artifact.name === "rust-analyzer.vsix");
 200     assert(!!artifact, `Bad release: ${JSON.stringify(release)}`);
 201
 202     const dest = path.join(config.globalStoragePath, "rust-analyzer.vsix");
 203
 204     await downloadWithRetryDialog(state, async () => {
 205         await download({
 206             url: artifact.browser_download_url,
 207             dest,
 208             progressTitle: "Downloading rust-analyzer extension",
 209             overwrite: true,
 210         });
 211     });
 212
 213     await vscode.commands.executeCommand("workbench.extensions.installExtension", vscode.Uri.file(dest));
 214     await fs.unlink(dest);
 215
 216     await state.updateReleaseId(release.id);
 217     await state.updateLastCheck(now);
 218     await vscode.commands.executeCommand("workbench.action.reloadWindow");
 219 }
 220
 221 async function bootstrapServer(config: Config, state: PersistentState): Promise<string> {
 222     const path = await getServer(config, state);
 223     if (!path) {
 224         throw new Error(
 225             "Rust Analyzer Language Server is not available. " +
 226             "Please, ensure its [proper installation](https://rust-analyzer.github.io/manual.html#installation)."
 227         );
 228     }
 229
 230     log.info("Using server binary at", path);
 231
 232     if (!isValidExecutable(path)) {
 233         throw new Error(`Failed to execute ${path} --version`);
 234     }
 235
 236     return path;
 237 }
 238
 239 async function patchelf(dest: PathLike): Promise<void> {
 240     await vscode.window.withProgress(
 241         {
 242             location: vscode.ProgressLocation.Notification,
 243             title: "Patching rust-analyzer for NixOS"
 244         },
 245         async (progress, _) => {
 246             const expression = `
 247             {src, pkgs ? import <nixpkgs> {}}:
 248                 pkgs.stdenv.mkDerivation {
 249                     name = "rust-analyzer";
 250                     inherit src;
 251                     phases = [ "installPhase" "fixupPhase" ];
 252                     installPhase = "cp $src $out";
 253                     fixupPhase = ''
 254                     chmod 755 $out
 255                     patchelf --set-interpreter "$(cat $NIX_CC/nix-support/dynamic-linker)" $out
 256                     '';
 257                 }
 258             `;
 259             const origFile = dest + "-orig";
 260             await fs.rename(dest, origFile);
 261             progress.report({ message: "Patching executable", increment: 20 });
 262             await new Promise((resolve, reject) => {
 263                 const handle = exec(`nix-build -E - --arg src '${origFile}' -o ${dest}`,
 264                     (err, stdout, stderr) => {
 265                         if (err != null) {
 266                             reject(Error(stderr));
 267                         } else {
 268                             resolve(stdout);
 269                         }
 270                     });
 271                 handle.stdin?.write(expression);
 272                 handle.stdin?.end();
 273             });
 274             await fs.unlink(origFile);
 275         }
 276     );
 277 }
 278
 279 async function getServer(config: Config, state: PersistentState): Promise<string | undefined> {
 280     const explicitPath = process.env.__RA_LSP_SERVER_DEBUG ?? config.serverPath;
 281     if (explicitPath) {
 282         if (explicitPath.startsWith("~/")) {
 283             return os.homedir() + explicitPath.slice("~".length);
 284         }
 285         return explicitPath;
 286     };
 287     if (config.package.releaseTag === null) return "rust-analyzer";
 288
 289     let platform: string | undefined;
 290     if (process.arch === "x64" || process.arch === "ia32") {
 291         if (process.platform === "linux") platform = "linux";
 292         if (process.platform === "darwin") platform = "mac";
 293         if (process.platform === "win32") platform = "windows";
 294     }
 295     if (platform === undefined) {
 296         vscode.window.showErrorMessage(
 297             "Unfortunately we don't ship binaries for your platform yet. " +
 298             "You need to manually clone rust-analyzer repository and " +
 299             "run `cargo xtask install --server` to build the language server from sources. " +
 300             "If you feel that your platform should be supported, please create an issue " +
 301             "about that [here](https://github.com/rust-analyzer/rust-analyzer/issues) and we " +
 302             "will consider it."
 303         );
 304         return undefined;
 305     }
 306     const ext = platform === "windows" ? ".exe" : "";
 307     const dest = path.join(config.globalStoragePath, `rust-analyzer-${platform}${ext}`);
 308     const exists = await fs.stat(dest).then(() => true, () => false);
 309     if (!exists) {
 310         await state.updateServerVersion(undefined);
 311     }
 312
 313     if (state.serverVersion === config.package.version) return dest;
 314
 315     if (config.askBeforeDownload) {
 316         const userResponse = await vscode.window.showInformationMessage(
 317             `Language server version ${config.package.version} for rust-analyzer is not installed.`,
 318             "Download now"
 319         );
 320         if (userResponse !== "Download now") return dest;
 321     }
 322
 323     const releaseTag = config.package.releaseTag;
 324     const release = await downloadWithRetryDialog(state, async () => {
 325         return await fetchRelease(releaseTag, state.githubToken);
 326     });
 327     const artifact = release.assets.find(artifact => artifact.name === `rust-analyzer-${platform}.gz`);
 328     assert(!!artifact, `Bad release: ${JSON.stringify(release)}`);
 329
 330     await downloadWithRetryDialog(state, async () => {
 331         await download({
 332             url: artifact.browser_download_url,
 333             dest,
 334             progressTitle: "Downloading rust-analyzer server",
 335             gunzip: true,
 336             mode: 0o755,
 337             overwrite: true,
 338         });
 339     });
 340
 341     // Patching executable if that's NixOS.
 342     if (await fs.stat("/etc/nixos").then(_ => true).catch(_ => false)) {
 343         await patchelf(dest);
 344     }
 345
 346     await state.updateServerVersion(config.package.version);
 347     return dest;
 348 }
 349
 350 async function downloadWithRetryDialog<T>(state: PersistentState, downloadFunc: () => Promise<T>): Promise<T> {
 351     while (true) {
 352         try {
 353             return await downloadFunc();
 354         } catch (e) {
 355             const selected = await vscode.window.showErrorMessage("Failed to download: " + e.message, {}, {
 356                 title: "Update Github Auth Token",
 357                 updateToken: true,
 358             }, {
 359                 title: "Retry download",
 360                 retry: true,
 361             }, {
 362                 title: "Dismiss",
 363             });
 364
 365             if (selected?.updateToken) {
 366                 await queryForGithubToken(state);
 367                 continue;
 368             } else if (selected?.retry) {
 369                 continue;
 370             }
 371             throw e;
 372         };
 373     }
 374 }
 375
 376 async function queryForGithubToken(state: PersistentState): Promise<void> {
 377     const githubTokenOptions: vscode.InputBoxOptions = {
 378         value: state.githubToken,
 379         password: true,
 380         prompt: `
 381             This dialog allows to store a Github authorization token.
 382             The usage of an authorization token will increase the rate
 383             limit on the use of Github APIs and can thereby prevent getting
 384             throttled.
 385             Auth tokens can be created at https://github.com/settings/tokens`,
 386     };
 387
 388     const newToken = await vscode.window.showInputBox(githubTokenOptions);
 389     if (newToken === undefined) {
 390         // The user aborted the dialog => Do not update the stored token
 391         return;
 392     }
 393
 394     if (newToken === "") {
 395         log.info("Clearing github token");
 396         await state.updateGithubToken(undefined);
 397     } else {
 398         log.info("Storing new github token");
 399         await state.updateGithubToken(newToken);
 400     }
 401 }