Merge #170: Add "Install Server" button to VSCode extension

237deb5 fmt + fix boolean logic issue (Volodymyr Herashchenko)
d9781c7 apply suggestion for find_server.ts (Volodymyr Herashchenko)
a3a210f add option for disabling autoupdates (Volodymyr Herashchenko)
6e994dc fix: ensure server is installed before restarting (Volodymyr Herashchenko)
9203a40 change install to show in notification (Volodymyr Herashchenko)
90deb28 Linting. Ran npm install. (Kyryl R)
1166f73 eslint: change `let` to `const` (Volodymyr Herashchenko)
2980c20 change server installation process to automatic (Volodymyr Herashchenko)
b438089 bump vscode extension version to 0.2.2 (Volodymyr Herashchenko)
7c09cd3 add "Install server" option in notification (Volodymyr Herashchenko)
f4b91fe change installation instructions for lsp (Volodymyr Herashchenko)

Pull request description:

  fixes #169

  This button appears if the user is missing the `simplicityhl-lsp` executable. It spawns the `cargo install simplicityhl-lsp` and shows progress notification for compiling.
  This also updates the LSP installation method in the README and changes the `Learn more` link to point to this repository instead of the old one.

ACKs for top commit:
  KyrylR:
    ACK 237deb5

Tree-SHA512: 8fd9330f65dbe9c8b6c0d135ea9e3e9ff7edd30158fbe9ad714914c269ba2e79657a5225e9d5e356252530a6f76b6d2d165297ec59129b256d1bbe4196513479

Author: KyrylR

lsp/README.md

@@ -22,12 +22,10 @@ Language Server for [SimplicityHL language](https://simplicity-lang.org/).
 
 ## Installation
 
-Clone this repository and install using Cargo:
+Install Language Server using `cargo`:
 
 ```bash
-https://github.com/distributed-lab/simplicityhl-lsp
-cd simplicityhl-lsp
-cargo install --path .
+cargo install simplicityhl-lsp
 ```
 
 ## Integration with editors

vscode/package-lock.json

@@ -2,7 +2,7 @@
   "name": "simplicityhl",
   "displayName": "SimplicityHL Language Support",
   "description": "Syntax highlighting and autocompletion for SimplicityHL (Simfony) language",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "publisher": "Blockstream",
   "repository": {
     "type": "git",
@@ -67,6 +67,11 @@
           "type": "boolean",
           "default": false,
           "description": "Do not show missing LSP executable warning."
+        },
+        "simplicityhl.disableAutoupdate": {
+          "type": "boolean",
+          "default": false,
+          "description": "Do not autoupdate LSP server."
         }
       }
     },

vscode/package.json

@@ -53,11 +53,12 @@ export class LspClient {
     }
   }
 
-  public stop(): Thenable<void> | undefined {
+  public async stop(): Promise<void> {
     if (!this.client) {
-      return undefined;
+      return;
     }
-    return this.client.stop();
+    await this.client.stop();
+    this.client = undefined;
   }
 
   public async restart(): Promise<void> {
@@ -67,8 +68,8 @@ export class LspClient {
     }
 
     try {
-      await this.client.stop();
-      await this.client.start();
+      await this.stop();
+      await this.start();
       window.showInformationMessage("SimplicityHL Language Server restarted successfully!");
     } catch (e) {
       window.showErrorMessage(`Failed to restart LSP: ${e}`);

vscode/src/client.ts

@@ -1,9 +1,11 @@
-import * as cp from "child_process";
+import * as os from "os";
 import * as fs from "fs";
 import * as path from "path";
-import * as os from "os";
-import { env, Uri, window, workspace } from "vscode";
+
 import process from "node:process";
+import * as cp from "child_process";
+
+import { env, ProgressLocation, Uri, window, workspace } from "vscode";
 
 function findExecutable(command: string): string | null {
   try {
@@ -51,27 +53,81 @@ function findExecutable(command: string): string | null {
   return null;
 }
 
+async function installServer(command: string) {
+  const cargoPath = findExecutable("cargo");
+  if (!cargoPath) {
+    throw new Error("Unable to find 'cargo'. Please ensure Rust is installed and in your PATH.");
+  }
+
+  const action = findExecutable(command) ? "Updating" : "Installing";
+
+  return window.withProgress({
+    location: ProgressLocation.Notification,
+    title: `${action} ${command}`,
+    cancellable: true
+  }, async (progress, token) => {
+    return new Promise<void>((resolve, reject) => {
+      const installProcess = cp.spawn(cargoPath!, ["install", "--color", "never", command]);
+
+      token.onCancellationRequested(() => {
+        installProcess.kill("SIGTERM");
+        reject(new Error("Installation canceled"));
+      });
+
+      const reportProgress = (data: Buffer) => {
+        const lines = data.toString()
+          .split(/\r?\n/)
+          .map(l => l.trim())
+
+        for (const line of lines) {
+          if (line.startsWith("Compiling") && line !== "Compiling") {
+            progress.report({ message: line });
+          }
+        }
+      };
+
+      installProcess.stderr?.on('data', reportProgress);
+
+      installProcess.on('close', (code) => {
+        if (code === 0) {
+          resolve();
+        } else {
+          reject(new Error(`Installation failed with exit code ${code}`));
+        }
+      });
+
+      installProcess.on('error', (err) => {
+        reject(new Error(`Failed to start cargo process: ${err.message}`));
+      });
+    });
+  });
+}
+
 export async function ensureExecutable(
   command: string,
 ): Promise<string | null> {
-  const exePath = findExecutable(command);
+  const cargoPath = findExecutable("cargo");
   const config = workspace.getConfiguration("simplicityhl");
 
-  const suppressWarning = config.get<boolean>(
-    "suppressMissingLspWarning",
-    false,
-  );
+  let serverPath = findExecutable(command);
+
+  if (!cargoPath && !serverPath) {
+    const suppressWarning = config.get<boolean>(
+      "suppressMissingLspWarning",
+      false,
+    );
+    if (suppressWarning) {
+      return null;
+    }
 
-  if (!exePath && !suppressWarning) {
     const choice = await window.showWarningMessage(
-      `LSP server "${command}" was not found in PATH or common locations. To use language server feautures, please install server to PATH`,
+      `To use SimplicityHL language server, please install cargo`,
       "Learn more",
       "Don't show again",
-      "Close",
     );
 
     if (choice === "Learn more") {
-      const url = "https://github.com/distributed-lab/simplicityhl-lsp";
+      const url = "https://rust-lang.org/tools/install";
       await env.openExternal(Uri.parse(url));
     } else if (choice === "Don't show again") {
       const config = workspace.getConfiguration("simplicityhl");
@@ -80,5 +136,25 @@ export async function ensureExecutable(
 
     return null;
   }
-  return exePath;
+
+  if (!cargoPath) {
+    return serverPath;
+  }
+
+  const disableAutoupdate = config.get<boolean>("disableAutoupdate", false);
+
+  if (serverPath && disableAutoupdate) {
+    return serverPath;
+  }
+
+  try {
+    await installServer(command);
+
+    serverPath = findExecutable(command);
+  } catch (err) {
+    window.showErrorMessage(err);
+    return null;
+  }
+
+  return serverPath;
 }