Refactor LSP Initialization to avoid blocking on update prompt (#69)

* draft of rearranging active order

* add Hole initialization

* make sure refactoring does include all comments

* add comments indicating the wrongful `getEffektVersion`

* Introduce new OutputChannel for the Main extension and log instead of showing the user more messages

* extract fetching the Effekt version to `getEffektVersion`

* Move the npm search of the Effekt executable into `locateEffektExecutable`

* Remove unneccessary comments

* Revert changes regarding npmRoot executable search

* Finalize Revert

* whitespace :)

* more whitescpace fixes

* WIP

* Refactor and Rearrange Extension activation to handle cases of no effekt exe, old effekt exe and current effekt exe without blocking lsp

* Manually fix whitespaces / formatting

* Minor stylistic fixes

---------

Co-authored-by: Tim Süberkrüb <dev@timsueberkrueb.io>

Author: JakubSchwenkbeck

src/effektLanguageClient.ts

@@ -0,0 +1,23 @@
+import { LanguageClient } from 'vscode-languageclient/node';
+
+/*
+ * Overrides the `registerFeature` method to disable the built-in inlay hints feature.
+ *
+ * By default the LanguageClient provides inlay hints automatically, which does not allow 
+ * for filtering Inlay Hints based on their 'data'-field. We use the 'data'-field to allow
+ * the user to select which inlay hints the extension should show.
+ * 
+ * By doing this, we retain full control over how inlay hints are displayed, allowing us to
+ * implement custom logic.
+ *
+ * Note: This approach relies on identifying the inlay hints feature by its constructor name
+ * (`InlayHintsFeature`). If the LSP implementation changes, this logic may need to be updated.
+ */
+export class EffektLanguageClient extends LanguageClient {
+    public registerFeature(feature: any) {
+        if (feature.constructor.name === 'InlayHintsFeature') { 
+            return; 
+        }
+        super.registerFeature(feature);
+    }
+}

src/effektManager.ts

@@ -5,6 +5,7 @@ import { compare as compareVersion } from 'compare-versions';
 import { URL } from 'url';
 import * as path from 'path';
 import * as fs from 'fs/promises';
+import { EffektLanguageClient } from './effektLanguageClient';
 
 interface InstallationResult {
     success: boolean;
@@ -18,6 +19,13 @@ interface EffektExecutableInfo {
     version: string;
 }
 
+export class EffektExecutableNotFoundError extends Error {
+    constructor(message: string = "Effekt executable not found") {
+        super(message);
+        this.name = "EffektExecutableNotFoundError";
+    }
+}
+
 /**
  * Manages Effekt installation, updates, and status within VS Code.
  */
@@ -83,6 +91,15 @@ export class EffektManager {
         throw new Error("Unable to determine Effekt version");
     }
 
+    public async getEffektVersion(): Promise<string> {
+        if (!this.effektVersion) {
+            const effektPath = await this.locateEffektExecutable();
+            const currentVersion = await this.fetchEffektVersion(effektPath.path);
+            this.effektVersion = currentVersion;
+        }
+        return this.effektVersion || '';
+    }
+
     /**
      * Executes a shell command and returns the output.
      * @param command The command to execute.
@@ -161,16 +178,15 @@ export class EffektManager {
             }
         }
 
-        throw new Error('Effekt executable not found');
+        throw new EffektExecutableNotFoundError('Effekt executable not found');
     }
 
     /**
      * Installs or updates Effekt.
-     * @param version The version to install or update to.
      * @param action The action being performed ('install' or 'update').
      * @returns A promise that resolves with the installed/updated version or an empty string.
      */
-    private async installOrUpdateEffekt(version: string, action: 'install' | 'update'): Promise<string> {
+    private async installOrUpdateEffekt(action: 'install' | 'update', client?: EffektLanguageClient): Promise<string> {
         if (!(await this.checkJava())) {
             this.logMessage('INFO', 'Java is not installed.');
             return '';
@@ -186,6 +202,8 @@ export class EffektManager {
             cancellable: false
         }, async (progress) => {
             try {
+                // The client is optional as when installing Effekt, there is no LSP initialized yet
+                await client?.stop();
                 progress.report({ increment: 0, message: 'Preparing...' });
                 await this.runNpmInstall();
                 progress.report({ increment: 50, message: 'Verifying installation...' });
@@ -194,10 +212,14 @@ export class EffektManager {
                 progress.report({ increment: 100, message: 'Completed' });
 
                 this.handleInstallationResult(verificationResult, action);
+
+                await client?.start();
                 return verificationResult.success ? verificationResult.version || '' : '';
             } catch (error) {
                 this.showErrorWithLogs(`Failed to ${action} Effekt: ${error}`);
                 this.updateStatusBar();
+
+                await client?.start();
                 return '';
             }
         });
@@ -269,20 +291,20 @@ export class EffektManager {
             const baseMessage = `Effekt has been ${action === 'update' ? 'updated' : 'installed'} to version ${result.version}.`;
 
             if (result.executable && !result.executable.includes(path.sep)) {
-                // Effekt is in PATH            
+                // Effekt is in PATH
                 const isUpdate = action === 'update';
-                
+
                 const options = isUpdate ? ['View Release Notes', 'Close'] : ['View Language Introduction', 'Close'];
                 const changelogResponse = await vscode.window.showInformationMessage(baseMessage, ...options);
-            
+
                 if (changelogResponse === 'View Release Notes') {
                     const changelogUrl = `https://github.com/effekt-lang/effekt/releases/tag/v${result.version}`;
                     vscode.env.openExternal(vscode.Uri.parse(changelogUrl));
                 } else if (changelogResponse === 'View Language Introduction') {
                     const introUrl = 'https://effekt-lang.org/docs/introduction';
                     vscode.env.openExternal(vscode.Uri.parse(introUrl));
                 }
-                                    
+
             } else {
                 // Effekt is not in PATH
                 const fullMessage = `${baseMessage}\n${result.message}\nConsider adding it to your PATH for easier access.`;
@@ -306,29 +328,24 @@ export class EffektManager {
      * Checks for Effekt updates and offers to install/update if necessary.
      * @returns A promise that resolves with the current Effekt version.
      */
-    public async checkForUpdatesAndInstall(): Promise<string> {
+    public async checkForUpdatesAndInstall(client?: EffektLanguageClient): Promise<string> {
         try {
-            const effektPath = await this.locateEffektExecutable();
-            if (!this.effektVersion) {
-                const currentVersion = await this.fetchEffektVersion(effektPath.path);
-                this.effektVersion = currentVersion;
-            }
-
+            let currentVersion = await this.getEffektVersion();
             const latestVersion = await this.getLatestNPMVersion(this.effektNPMPackage);
 
             // check if the latest version strictly newer than the current version
-            if (!this.effektVersion || compareVersion(latestVersion, this.effektVersion, '>')) {
-                return this.promptForAction(latestVersion, 'update');
+            if (!currentVersion || compareVersion(latestVersion, currentVersion, '>')) {
+                return this.promptForAction(latestVersion, 'update', client);
             } else {
-                vscode.window.showInformationMessage(`Effekt is up-to-date (version ${this.effektVersion}).`);
+                vscode.window.showInformationMessage(`Effekt is up-to-date (version ${currentVersion}).`);
             }
 
             this.updateStatusBar();
             return this.effektVersion || '';
         } catch (error) {
             if (error instanceof Error && error.message.includes('Effekt executable not found')) {
                 const latestVersion = await this.getLatestNPMVersion(this.effektNPMPackage);
-                return this.promptForAction(latestVersion, 'install');
+                return this.promptForAction(latestVersion, 'install', client);
             } else {
                 this.showErrorWithLogs(`Failed to check Effekt: ${error}`);
                 return '';
@@ -342,14 +359,14 @@ export class EffektManager {
      * @param action The action to perform ('install' or 'update').
      * @returns A promise that resolves with the installed/updated version or an empty string.
      */
-    private async promptForAction(version: string, action: 'install' | 'update'): Promise<string> {
+    private async promptForAction(version: string, action: 'install' | 'update', client?: EffektLanguageClient): Promise<string> {
         const message = action === 'update'
             ? `A new version of Effekt is available (${version}). Would you like to update?`
             : `Effekt ${version} is available. Would you like to install it?`;
 
         const response = await vscode.window.showInformationMessage(message, 'Yes', 'No');
         if (response === 'Yes') {
-            return this.installOrUpdateEffekt(version, action);
+            return this.installOrUpdateEffekt(action, client);
         }
         this.updateStatusBar();
         return this.effektVersion || '';