Skip to content

Commit 2ad3132

Browse files
borsbors
committed
Auto merge of #17455 - Veykril:vscode-ext, r=Veykril
Tidy up vscode extension a bit
2 parents 1ad33f9 + 74c1675 commit 2ad3132

16 files changed

+143
-171
lines changed

‎src/tools/rust-analyzer/editors/code/src/ast_inspector.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
import * as vscode from "vscode";
22

33
import type { Ctx, Disposable } from "./ctx";
4-
import { type RustEditor, isRustEditor } from "./util";
5-
import { unwrapUndefinable } from "./undefinable";
4+
import { type RustEditor, isRustEditor, unwrapUndefinable } from "./util";
65

76
// FIXME: consider implementing this via the Tree View API?
87
// https://code.visualstudio.com/api/extension-guides/tree-view

‎src/tools/rust-analyzer/editors/code/src/bootstrap.ts

+50-26
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import * as vscode from "vscode";
22
import * as os from "os";
33
import type { Config } from "./config";
4-
import { log, isValidExecutable } from "./util";
4+
import { type Env, log } from "./util";
55
import type { PersistentState } from "./persistent_state";
6-
import { exec } from "child_process";
6+
import { exec, spawnSync } from "child_process";
77

88
export async function bootstrap(
99
context: vscode.ExtensionContext,
@@ -13,20 +13,20 @@ export async function bootstrap(
1313
const path = await getServer(context, config, state);
1414
if (!path) {
1515
throw new Error(
16-
"Rust Analyzer Language Server is not available. " +
16+
"rust-analyzer Language Server is not available. " +
1717
"Please, ensure its [proper installation](https://rust-analyzer.github.io/manual.html#installation).",
1818
);
1919
}
2020

2121
log.info("Using server binary at", path);
2222

2323
if (!isValidExecutable(path, config.serverExtraEnv)) {
24-
if (config.serverPath) {
25-
throw new Error(`Failed to execute ${path} --version. \`config.server.path\` or \`config.serverPath\` has been set explicitly.\
26-
Consider removing this config or making a valid server binary available at that path.`);
27-
} else {
28-
throw new Error(`Failed to execute ${path} --version`);
29-
}
24+
throw new Error(
25+
`Failed to execute ${path} --version.` + config.serverPath
26+
? `\`config.server.path\` or \`config.serverPath\` has been set explicitly.\
27+
Consider removing this config or making a valid server binary available at that path.`
28+
: "",
29+
);
3030
}
3131

3232
return path;
@@ -54,27 +54,12 @@ async function getServer(
5454
if (bundledExists) {
5555
let server = bundled;
5656
if (await isNixOs()) {
57-
await vscode.workspace.fs.createDirectory(config.globalStorageUri).then();
58-
const dest = vscode.Uri.joinPath(config.globalStorageUri, `rust-analyzer${ext}`);
59-
let exists = await vscode.workspace.fs.stat(dest).then(
60-
() => true,
61-
() => false,
62-
);
63-
if (exists && config.package.version !== state.serverVersion) {
64-
await vscode.workspace.fs.delete(dest);
65-
exists = false;
66-
}
67-
if (!exists) {
68-
await vscode.workspace.fs.copy(bundled, dest);
69-
await patchelf(dest);
70-
}
71-
server = dest;
57+
server = await getNixOsServer(config, ext, state, bundled, server);
58+
await state.updateServerVersion(config.package.version);
7259
}
73-
await state.updateServerVersion(config.package.version);
7460
return server.fsPath;
7561
}
7662

77-
await state.updateServerVersion(undefined);
7863
await vscode.window.showErrorMessage(
7964
"Unfortunately we don't ship binaries for your platform yet. " +
8065
"You need to manually clone the rust-analyzer repository and " +
@@ -86,6 +71,45 @@ async function getServer(
8671
return undefined;
8772
}
8873

74+
export function isValidExecutable(path: string, extraEnv: Env): boolean {
75+
log.debug("Checking availability of a binary at", path);
76+
77+
const res = spawnSync(path, ["--version"], {
78+
encoding: "utf8",
79+
env: { ...process.env, ...extraEnv },
80+
});
81+
82+
const printOutput = res.error ? log.warn : log.info;
83+
printOutput(path, "--version:", res);
84+
85+
return res.status === 0;
86+
}
87+
88+
async function getNixOsServer(
89+
config: Config,
90+
ext: string,
91+
state: PersistentState,
92+
bundled: vscode.Uri,
93+
server: vscode.Uri,
94+
) {
95+
await vscode.workspace.fs.createDirectory(config.globalStorageUri).then();
96+
const dest = vscode.Uri.joinPath(config.globalStorageUri, `rust-analyzer${ext}`);
97+
let exists = await vscode.workspace.fs.stat(dest).then(
98+
() => true,
99+
() => false,
100+
);
101+
if (exists && config.package.version !== state.serverVersion) {
102+
await vscode.workspace.fs.delete(dest);
103+
exists = false;
104+
}
105+
if (!exists) {
106+
await vscode.workspace.fs.copy(bundled, dest);
107+
await patchelf(dest);
108+
}
109+
server = dest;
110+
return server;
111+
}
112+
89113
async function isNixOs(): Promise<boolean> {
90114
try {
91115
const contents = (

‎src/tools/rust-analyzer/editors/code/src/client.ts

+30-61
Original file line numberDiff line numberDiff line change
@@ -3,73 +3,13 @@ import * as lc from "vscode-languageclient/node";
33
import * as vscode from "vscode";
44
import * as ra from "../src/lsp_ext";
55
import * as Is from "vscode-languageclient/lib/common/utils/is";
6-
import { assert } from "./util";
6+
import { assert, unwrapUndefinable } from "./util";
77
import * as diagnostics from "./diagnostics";
88
import { WorkspaceEdit } from "vscode";
99
import { type Config, prepareVSCodeConfig } from "./config";
10-
import { randomUUID } from "crypto";
1110
import { sep as pathSeparator } from "path";
12-
import { unwrapUndefinable } from "./undefinable";
1311
import { RaLanguageClient } from "./lang_client";
1412

15-
export interface Env {
16-
[name: string]: string;
17-
}
18-
19-
// Command URIs have a form of command:command-name?arguments, where
20-
// arguments is a percent-encoded array of data we want to pass along to
21-
// the command function. For "Show References" this is a list of all file
22-
// URIs with locations of every reference, and it can get quite long.
23-
//
24-
// To work around it we use an intermediary linkToCommand command. When
25-
// we render a command link, a reference to a command with all its arguments
26-
// is stored in a map, and instead a linkToCommand link is rendered
27-
// with the key to that map.
28-
export const LINKED_COMMANDS = new Map<string, ra.CommandLink>();
29-
30-
// For now the map is cleaned up periodically (I've set it to every
31-
// 10 minutes). In general case we'll probably need to introduce TTLs or
32-
// flags to denote ephemeral links (like these in hover popups) and
33-
// persistent links and clean those separately. But for now simply keeping
34-
// the last few links in the map should be good enough. Likewise, we could
35-
// add code to remove a target command from the map after the link is
36-
// clicked, but assuming most links in hover sheets won't be clicked anyway
37-
// this code won't change the overall memory use much.
38-
setInterval(
39-
function cleanupOlderCommandLinks() {
40-
// keys are returned in insertion order, we'll keep a few
41-
// of recent keys available, and clean the rest
42-
const keys = [...LINKED_COMMANDS.keys()];
43-
const keysToRemove = keys.slice(0, keys.length - 10);
44-
for (const key of keysToRemove) {
45-
LINKED_COMMANDS.delete(key);
46-
}
47-
},
48-
10 * 60 * 1000,
49-
);
50-
51-
function renderCommand(cmd: ra.CommandLink): string {
52-
const commandId = randomUUID();
53-
LINKED_COMMANDS.set(commandId, cmd);
54-
return `[${cmd.title}](command:rust-analyzer.linkToCommand?${encodeURIComponent(
55-
JSON.stringify([commandId]),
56-
)} '${cmd.tooltip}')`;
57-
}
58-
59-
function renderHoverActions(actions: ra.CommandLinkGroup[]): vscode.MarkdownString {
60-
const text = actions
61-
.map(
62-
(group) =>
63-
(group.title ? group.title + " " : "") +
64-
group.commands.map(renderCommand).join(" | "),
65-
)
66-
.join(" | ");
67-
68-
const result = new vscode.MarkdownString(text);
69-
result.isTrusted = true;
70-
return result;
71-
}
72-
7313
export async function createClient(
7414
traceOutputChannel: vscode.OutputChannel,
7515
outputChannel: vscode.OutputChannel,
@@ -450,3 +390,32 @@ function isCodeActionWithoutEditsAndCommands(value: any): boolean {
450390
candidate.command === void 0
451391
);
452392
}
393+
394+
// Command URIs have a form of command:command-name?arguments, where
395+
// arguments is a percent-encoded array of data we want to pass along to
396+
// the command function. For "Show References" this is a list of all file
397+
// URIs with locations of every reference, and it can get quite long.
398+
// So long in fact that it will fail rendering inside an `a` tag so we need
399+
// to proxy around that. We store the last hover's reference command link
400+
// here, as only one hover can be active at a time, and we don't need to
401+
// keep a history of these.
402+
export let HOVER_REFERENCE_COMMAND: ra.CommandLink | undefined = undefined;
403+
404+
function renderCommand(cmd: ra.CommandLink): string {
405+
HOVER_REFERENCE_COMMAND = cmd;
406+
return `[${cmd.title}](command:rust-analyzer.hoverRefCommandProxy '${cmd.tooltip}')`;
407+
}
408+
409+
function renderHoverActions(actions: ra.CommandLinkGroup[]): vscode.MarkdownString {
410+
const text = actions
411+
.map(
412+
(group) =>
413+
(group.title ? group.title + " " : "") +
414+
group.commands.map(renderCommand).join(" | "),
415+
)
416+
.join(" | ");
417+
418+
const result = new vscode.MarkdownString(text);
419+
result.isTrusted = true;
420+
return result;
421+
}

‎src/tools/rust-analyzer/editors/code/src/commands.ts

+6-7
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ import {
2424
isRustEditor,
2525
type RustEditor,
2626
type RustDocument,
27+
unwrapUndefinable,
2728
} from "./util";
2829
import { startDebugSession, makeDebugConfig } from "./debug";
2930
import type { LanguageClient } from "vscode-languageclient/node";
30-
import { LINKED_COMMANDS } from "./client";
31+
import { HOVER_REFERENCE_COMMAND } from "./client";
3132
import type { DependencyId } from "./dependencies_provider";
32-
import { unwrapUndefinable } from "./undefinable";
3333
import { log } from "./util";
3434

3535
export * from "./ast_inspector";
@@ -1196,11 +1196,10 @@ export function newDebugConfig(ctx: CtxInit): Cmd {
11961196
};
11971197
}
11981198

1199-
export function linkToCommand(_: Ctx): Cmd {
1200-
return async (commandId: string) => {
1201-
const link = LINKED_COMMANDS.get(commandId);
1202-
if (link) {
1203-
const { command, arguments: args = [] } = link;
1199+
export function hoverRefCommandProxy(_: Ctx): Cmd {
1200+
return async () => {
1201+
if (HOVER_REFERENCE_COMMAND) {
1202+
const { command, arguments: args = [] } = HOVER_REFERENCE_COMMAND;
12041203
await vscode.commands.executeCommand(command, ...args);
12051204
}
12061205
};

‎src/tools/rust-analyzer/editors/code/src/config.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@ import * as Is from "vscode-languageclient/lib/common/utils/is";
22
import * as os from "os";
33
import * as path from "path";
44
import * as vscode from "vscode";
5-
import type { Env } from "./client";
6-
import { log } from "./util";
7-
import { expectNotUndefined, unwrapUndefinable } from "./undefinable";
5+
import { type Env, log, unwrapUndefinable, expectNotUndefined } from "./util";
86
import type { JsonProject } from "./rust_project";
97

108
export type RunnableEnvCfgItem = {

‎src/tools/rust-analyzer/editors/code/src/debug.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ import type * as ra from "./lsp_ext";
66
import { Cargo, getRustcId, getSysroot } from "./toolchain";
77
import type { Ctx } from "./ctx";
88
import { prepareEnv } from "./run";
9-
import { unwrapUndefinable } from "./undefinable";
10-
import { isCargoRunnableArgs } from "./util";
9+
import { isCargoRunnableArgs, unwrapUndefinable } from "./util";
1110

1211
const debugOutput = vscode.window.createOutputChannel("Debug");
1312
type DebugConfigProvider = (
@@ -136,7 +135,7 @@ async function getDebugConfiguration(
136135
const workspaceQualifier = isMultiFolderWorkspace ? `:${workspace.name}` : "";
137136
function simplifyPath(p: string): string {
138137
// see https://github.com/rust-lang/rust-analyzer/pull/5513#issuecomment-663458818 for why this is needed
139-
return path.normalize(p).replace(wsFolder, "${workspaceFolder" + workspaceQualifier + "}");
138+
return path.normalize(p).replace(wsFolder, `\${workspaceFolder${workspaceQualifier}}`);
140139
}
141140

142141
const env = prepareEnv(runnable.label, runnableArgs, ctx.config.runnablesExtraEnv);

‎src/tools/rust-analyzer/editors/code/src/dependencies_provider.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as fs from "fs";
44
import type { CtxInit } from "./ctx";
55
import * as ra from "./lsp_ext";
66
import type { FetchDependencyListResult } from "./lsp_ext";
7-
import { unwrapUndefinable } from "./undefinable";
7+
import { unwrapUndefinable } from "./util";
88

99
export class RustDependenciesProvider
1010
implements vscode.TreeDataProvider<Dependency | DependencyFile>

‎src/tools/rust-analyzer/editors/code/src/diagnostics.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
window,
99
} from "vscode";
1010
import type { Ctx } from "./ctx";
11-
import { unwrapUndefinable } from "./undefinable";
11+
import { unwrapUndefinable } from "./util";
1212

1313
export const URI_SCHEME = "rust-analyzer-diagnostics-view";
1414

‎src/tools/rust-analyzer/editors/code/src/main.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ function createCommands(): Record<string, CommandFactory> {
182182
applySnippetWorkspaceEdit: { enabled: commands.applySnippetWorkspaceEditCommand },
183183
debugSingle: { enabled: commands.debugSingle },
184184
gotoLocation: { enabled: commands.gotoLocation },
185-
linkToCommand: { enabled: commands.linkToCommand },
185+
hoverRefCommandProxy: { enabled: commands.hoverRefCommandProxy },
186186
resolveCodeAction: { enabled: commands.resolveCodeAction },
187187
runSingle: { enabled: commands.runSingle },
188188
showReferences: { enabled: commands.showReferences },

‎src/tools/rust-analyzer/editors/code/src/nullable.ts

-19
This file was deleted.

‎src/tools/rust-analyzer/editors/code/src/run.ts

+2-4
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ import * as tasks from "./tasks";
66
import type { CtxInit } from "./ctx";
77
import { makeDebugConfig } from "./debug";
88
import type { Config, RunnableEnvCfg, RunnableEnvCfgItem } from "./config";
9-
import { unwrapUndefinable } from "./undefinable";
109
import type { LanguageClient } from "vscode-languageclient/node";
11-
import type { RustEditor } from "./util";
10+
import { unwrapUndefinable, type RustEditor } from "./util";
1211
import * as toolchain from "./toolchain";
1312

1413
const quickPickButtons = [
@@ -148,8 +147,7 @@ export async function createTaskFromRunnable(
148147
};
149148
}
150149

151-
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
152-
const target = vscode.workspace.workspaceFolders![0]; // safe, see main activate()
150+
const target = vscode.workspace.workspaceFolders?.[0];
153151
const exec = await tasks.targetToExecution(definition, config.cargoRunner, true);
154152
const task = await tasks.buildRustTask(
155153
target,

‎src/tools/rust-analyzer/editors/code/src/snippets.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import * as vscode from "vscode";
22

3-
import { assert } from "./util";
4-
import { unwrapUndefinable } from "./undefinable";
3+
import { assert, unwrapUndefinable } from "./util";
54

65
export type SnippetTextDocumentEdit = [vscode.Uri, (vscode.TextEdit | vscode.SnippetTextEdit)[]];
76

‎src/tools/rust-analyzer/editors/code/src/tasks.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import * as vscode from "vscode";
22
import type { Config } from "./config";
3-
import { log } from "./util";
4-
import { unwrapUndefinable } from "./undefinable";
3+
import { log, unwrapUndefinable } from "./util";
54
import * as toolchain from "./toolchain";
65

76
// This ends up as the `type` key in tasks.json. RLS also uses `cargo` and

0 commit comments

Comments
 (0)