fix(extension): Restart after changing path setting (#33)

Author: felix-andreas

.vscode/settings.json

@@ -5,5 +5,4 @@
 	"editor.codeActionsOnSave": {
 		"source.fixAll.eslint": "explicit"
 	},
-	"rust-analyzer.trace.server": "verbose"
 }

docs/content/development.md

@@ -173,10 +173,13 @@ See https://github.com/r-lib/tree-sitter-r/issues/166
 
 ### VS Code Extensions
 
-* https://github.com/microsoft/vscode-extension-samples/tree/main/lsp-sample
-* https://github.com/semanticart/lsp-from-scratch
-* https://github.com/nix-community/vscode-nix-ide
-* https://github.com/ziglang/vscode-zig/
+* docs:
+  * https://code.visualstudio.com/api/references/vscode-api
+* examples:
+  * https://github.com/microsoft/vscode-extension-samples/tree/main/lsp-sample
+  * https://github.com/semanticart/lsp-from-scratch
+  * https://github.com/nix-community/vscode-nix-ide
+  * https://github.com/ziglang/vscode-zig/
 
 ### Other Language Servers written in Rust
 

editors/code/bun.lockb

@@ -34,14 +34,13 @@
 		"vscode-languageclient": "^9.0.1"
 	},
 	"devDependencies": {
-		"@eslint/js": "^9.29.0",
-		"@stylistic/eslint-plugin": "^2.13.0",
-		"@types/node": "^20.19.0",
-		"@types/vscode": "^1.101.0",
+		"@eslint/js": "^9.13.0",
+		"@types/node": "^20",
+		"@types/vscode": "^1.75.1",
 		"@vscode/vsce": "^3.5.0",
 		"eslint": "^9.29.0",
 		"typescript": "^5.8.3",
-		"typescript-eslint": "^8.34.0"
+		"typescript-eslint": "^8.34.1"
 	},
 	"main": "./out/extension",
 	"activationEvents": [

editors/code/package.json

@@ -1,5 +1,5 @@
-import * as path from "path";
-import * as fs from 'fs';
+import * as fs from "fs"
+import * as path from "path"
 
 import {
   commands,
@@ -9,6 +9,7 @@ import {
   ExtensionContext,
   MarkdownString,
   StatusBarAlignment,
+  StatusBarItem,
   TextEditor,
   ThemeColor,
 } from 'vscode'
@@ -20,62 +21,21 @@ import {
   TransportKind,
 } from 'vscode-languageclient/node'
 
-const logger = window.createOutputChannel("Roughly Extension", { log: true });
+const logger = window.createOutputChannel("Roughly Extension", { log: true })
+const outputChannel = window.createOutputChannel("Roughly")
 
 const EXTENSION_ROOT_DIR = path.dirname(__dirname)
 const ROUGHLY_BINARY_NAME = process.platform === "win32" ? "roughly.exe" : "roughly"
 const BUNDLED_ROUGHLY_EXECUTABLE = path.join(EXTENSION_ROOT_DIR, "bin", ROUGHLY_BINARY_NAME)
 
-let client: LanguageClient
-let statusBar
+let client: LanguageClient | null = null
+let statusBar: StatusBarItem
 let status = { health: "started" }
-let version
+let version: string | undefined
 
-export function activate({ subscriptions, extension }: ExtensionContext) {
+export async function activate({ subscriptions, extension, }: ExtensionContext): Promise<void> {
   version = extension.packageJSON.version ?? "<unknown>"
 
-  const config = workspace.getConfiguration("roughly")
-
-  const command = process.env.SERVER_PATH
-    ?? config.get<string>("path")
-    ?? (
-      fs.existsSync(BUNDLED_ROUGHLY_EXECUTABLE)
-        ? BUNDLED_ROUGHLY_EXECUTABLE
-        : "roughly"
-    )
-
-  const args = config.get<string[]>("args", ["server"])
-
-  logger.info("using server command:", [command, ...args].join(" "))
-
-  const outputChannel = window.createOutputChannel("Roughly");
-
-  client = (() => {
-    const serverOptions: ServerOptions = {
-      command,
-      args,
-      transport: TransportKind.stdio,
-      options: {
-        env: {
-          ...process.env,
-          RUST_LOG: "debug",
-        },
-      },
-    }
-
-    const clientOptions: LanguageClientOptions = {
-      documentSelector: [{ scheme: "file", language: "r" }],
-      outputChannel,
-    }
-
-    return new LanguageClient(
-      'roughly',
-      'Roughly',
-      serverOptions,
-      clientOptions
-    )
-  })()
-
   subscriptions.push(
     workspace.onDidChangeConfiguration(async (change) => {
       if (
@@ -85,43 +45,36 @@ export function activate({ subscriptions, extension }: ExtensionContext) {
           "Restart",
         )
         if (choice === "Restart") {
-          await client.restart()
+          await restartClient()
           setTimeout(() => {
-            client.outputChannel.show()
+            client?.outputChannel.show()
           }, 1500)
         }
       }
     }),
     commands.registerCommand(
       "roughly.restartServer",
       async () => {
-        if (client.isRunning) {
-          await client.restart()
-        } else {
-          await client.start()
-        }
-        setServerStatus({ health: "started" })
+        await restartClient()
       }
     ),
     commands.registerCommand(
       "roughly.startServer",
       async () => {
-        await client.start()
-        setServerStatus({ health: "started" })
+        await restartClient()
       }
     ),
     commands.registerCommand(
       "roughly.stopServer",
       async () => {
-        await client.stop()
-        setServerStatus({ health: "stopped" })
+        await stopClient()
       }
     ),
     commands.registerCommand(
       "roughly.openLogs",
       async () => {
-        if (client.outputChannel) {
-          client.outputChannel.show();
+        if (client?.outputChannel) {
+          client.outputChannel.show()
         }
       }
     )
@@ -133,16 +86,100 @@ export function activate({ subscriptions, extension }: ExtensionContext) {
   updateStatusBarVisibility(window.activeTextEditor)
   window.onDidChangeActiveTextEditor((editor) => updateStatusBarVisibility(editor))
 
-  client.start() // this also launches the server
+  restartClient()
+}
+
+export async function deactivate(): Promise<void> {
+  await stopClient()
 }
 
+//
+// SERVER
+//
+
+async function restartClient(): Promise<void> {
+  const newClient = createClient()
+  try {
+    await newClient.start()
+    void stopClient()
+    client = newClient
+    setServerStatus({ health: "started" })
+  } catch (reason) {
+    void window.showWarningMessage("Failed to start Roughly language server.")
+    setServerStatus({ health: "stopped" })
+  }
+}
+
+function createClient(): LanguageClient {
+  const config = workspace.getConfiguration("roughly")
+
+  const command = process.env.SERVER_PATH
+    ?? config.get<string>("path")
+    ?? (
+      fs.existsSync(BUNDLED_ROUGHLY_EXECUTABLE)
+        ? BUNDLED_ROUGHLY_EXECUTABLE
+        : "roughly"
+    )
+
+  const args = config.get<string[]>("args", ["server"])
+
+  logger.info("using server command:", [command, ...args].join(" "))
+
+  const serverOptions: ServerOptions = {
+    command,
+    args,
+    transport: TransportKind.stdio,
+    options: {
+      env: {
+        ...process.env,
+        RUST_LOG: "debug",
+      },
+    },
+  }
+
+  const clientOptions: LanguageClientOptions = {
+    documentSelector: [{ scheme: "file", language: "r" }],
+    outputChannel,
+  }
+
+  const client = new LanguageClient(
+    'roughly',
+    'Roughly',
+    serverOptions,
+    clientOptions
+  )
+
+  return client
+}
+
+
+async function stopClient(): Promise<void> {
+  if (!client) {
+    return
+  }
+
+  logger.info("stopping server ...")
+
+  const oldClient = client
+  client = null
+
+  // The `stop` call will send the "shutdown" notification to the LSP
+  await oldClient.stop()
+  // The `dipose` call will send the "exit" request to the LSP which actually tells the child process to exit
+  await oldClient.dispose()
+}
+
+//
+// STATUS BAR
+//
+
 type ServerStatus = {
   health: "started" | "stopped"
 }
 
 function setServerStatus(newStatus: ServerStatus) {
-  status = newStatus;
-  updateStatusBarItem();
+  status = newStatus
+  updateStatusBarItem()
 }
 
 function updateStatusBarVisibility(editor: TextEditor | undefined) {
@@ -188,11 +225,3 @@ function updateStatusBarItem() {
   // if (true) icon = "$(loading~spin) "
   statusBar.text = `${icon}Roughly`
 }
-
-
-export function deactivate(): Thenable<void> | undefined {
-  if (!client) {
-    return undefined
-  }
-  return client.stop()
-}

editors/code/src/extension.ts

@@ -1,5 +1,6 @@
 {
 	"compilerOptions": {
+		"strict": true,
 		"module": "commonjs",
 		"target": "es2020",
 		"lib": ["es2020"],

editors/code/tsconfig.json

@@ -23,13 +23,15 @@ snapshot *args:
 vsce *args:
 	@bun --cwd=editors/code run vsce -- {{args}}
 
+install-extension:
+	mkdir -p release/dev
+	just build-extension pre-release --out ../../release/dev/roughly.vsix
+	code --install-extension release/dev/roughly.vsix
+
 #
 # BUILD
 #
 
-install-extension $path:
-	code --install-extension {{path}}
-
 build-linux:
 	cargo build --release --target x86_64-unknown-linux-gnu