rust-analyzer/editors/code/src/util.ts

118 lines
3.7 KiB
TypeScript

import * as lc from "vscode-languageclient";
import * as vscode from "vscode";
import { strict as nativeAssert } from "assert";
import { spawnSync } from "child_process";
export function assert(condition: boolean, explanation: string): asserts condition {
try {
nativeAssert(condition, explanation);
} catch (err) {
log.error(`Assertion failed:`, explanation);
throw err;
}
}
export const log = new class {
private enabled = true;
setEnabled(yes: boolean): void {
log.enabled = yes;
}
debug(message?: any, ...optionalParams: any[]): void {
if (!log.enabled) return;
// eslint-disable-next-line no-console
console.log(message, ...optionalParams);
}
error(message?: any, ...optionalParams: any[]): void {
debugger;
// eslint-disable-next-line no-console
console.error(message, ...optionalParams);
}
};
export async function sendRequestWithRetry<TParam, TRet>(
client: lc.LanguageClient,
reqType: lc.RequestType<TParam, TRet, unknown>,
param: TParam,
token?: vscode.CancellationToken,
): Promise<TRet> {
for (const delay of [2, 4, 6, 8, 10, null]) {
try {
return await (token
? client.sendRequest(reqType, param, token)
: client.sendRequest(reqType, param)
);
} catch (error) {
if (delay === null) {
log.error("LSP request timed out", { method: reqType.method, param, error });
throw error;
}
if (error.code === lc.ErrorCodes.RequestCancelled) {
throw error;
}
if (error.code !== lc.ErrorCodes.ContentModified) {
log.error("LSP request failed", { method: reqType.method, param, error });
throw error;
}
await sleep(10 * (1 << delay));
}
}
throw 'unreachable';
}
export function sleep(ms: number) {
return new Promise(resolve => setTimeout(resolve, ms));
}
export type RustDocument = vscode.TextDocument & { languageId: "rust" };
export type RustEditor = vscode.TextEditor & { document: RustDocument };
export function isRustDocument(document: vscode.TextDocument): document is RustDocument {
// Prevent corrupted text (particularly via inlay hints) in diff views
// by allowing only `file` schemes
// unfortunately extensions that use diff views not always set this
// to something different than 'file' (see ongoing bug: #4608)
return document.languageId === 'rust' && document.uri.scheme === 'file';
}
export function isRustEditor(editor: vscode.TextEditor): editor is RustEditor {
return isRustDocument(editor.document);
}
export function isValidExecutable(path: string): boolean {
log.debug("Checking availability of a binary at", path);
const res = spawnSync(path, ["--version"], { encoding: 'utf8' });
log.debug(res, "--version output:", res.output);
return res.status === 0;
}
/** Sets ['when'](https://code.visualstudio.com/docs/getstarted/keybindings#_when-clause-contexts) clause contexts */
export function setContextValue(key: string, value: any): Thenable<void> {
return vscode.commands.executeCommand('setContext', key, value);
}
/**
* Returns a higher-order function that caches the results of invoking the
* underlying function.
*/
export function memoize<Ret, TThis, Param extends string>(func: (this: TThis, arg: Param) => Ret) {
const cache = new Map<string, Ret>();
return function(this: TThis, arg: Param) {
const cached = cache.get(arg);
if (cached) return cached;
const result = func.call(this, arg);
cache.set(arg, result);
return result;
};
}