Download language server on startup (#68)

Signed-off-by: Ben Sherman <[email protected]>

Author: bentsherman

.github/workflows/publish.yml

@@ -1,11 +1,7 @@
 name: Publish Extension
 
 on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: 'Language server version'
-        required: true
+  workflow_dispatch
 
 jobs:
   deploy:
@@ -21,13 +17,6 @@ jobs:
       - name: npm clean install
         run: npm ci
 
-      - name: Download language server JAR
-        run: |
-          mkdir -p language-server/build/libs
-          wget -P language-server/build/libs https://github.com/nextflow-io/language-server/releases/download/$VERSION/language-server-all.jar
-        env:
-          VERSION: ${{ github.event.inputs.version }}
-
       - name: Build vscode extension
         run: npm run package
 

Makefile

@@ -4,7 +4,7 @@ clean:
 	rm -rf build
 
 server:
-	cd language-server ; ./gradlew build
+	cd language-server ; make
 
 package:
 	npm run package

README.md

@@ -44,20 +44,13 @@ git clone https://github.com/nextflow-io/language-server
 make server
 ```
 
-Otherwise, you can simply download a language server release into the following subdirectory:
-
-```bash
-mkdir -p language-server/build/libs
-wget -P language-server/build/libs https://github.com/nextflow-io/language-server/releases/download/$VERSION/language-server-all.jar
-```
-
 Finally, press `F5` to build the extension and launch a new VS Code window with the extension loaded.
 
 ## Publishing
 
 1. Update the extension version number in `package.json`.
 2. Update the changelog in `CHANGELOG.md`.
-3. Run the "Deploy Extension" action to publish the extension to the VSCode marketplace and Open VSX.
+3. Run the "Publish Extension" action to publish the extension to the VSCode marketplace and Open VSX.
 
 ## Contributing
 

esbuild.js

@@ -13,9 +13,10 @@ async function main() {
     'README.md': './README.md',
     'language-configuration.json': './language-configuration.json',
     'package.json': './package.json',
-    'language-server/build/libs/language-server-all.jar': 'bin',
     'node_modules/mermaid/dist/mermaid.min.js': 'media',
   };
+  if( !production )
+    files['language-server/build/libs/language-server-all.jar'] = 'bin'
   await build({
     entryPoints: [
       'src/extension.ts'

package-lock.json

@@ -144,6 +144,14 @@
                     "type": "boolean",
                     "default": false,
                     "description": "Enable additional warnings for things like future deprecations, discouraged patterns, and so on."
+                },
+                "nextflow.targetVersion": {
+                    "type": "string",
+                    "enum": [
+                        "v24.10"
+                    ],
+                    "default": "v24.10",
+                    "markdownDescription": "Target version of Nextflow to be used by the language server."
                 }
             }
         }
@@ -160,6 +168,7 @@
         "esbuild": "^0.24.0",
         "esbuild-plugin-copy": "^2.1.1",
         "mermaid": "^11.4.1",
+        "node-fetch": "^3.3.2",
         "typescript": "^5.7.2",
         "vscode-jsonrpc": "^8.0.2",
         "vscode-languageclient": "^8.0.2"

package.json

@@ -1,5 +1,8 @@
 import buildMermaid from "./utils/buildMermaid";
 import findJava from "./utils/findJava";
+import * as fs from 'fs';
+import fetch from 'node-fetch';
+import * as os from "os";
 import * as path from "path";
 import * as vscode from "vscode";
 import {
@@ -13,6 +16,89 @@ let extensionContext: vscode.ExtensionContext | null = null;
 let languageClient: LanguageClient | null = null;
 let javaPath: string | null = null;
 
+async function getLatestRemoteVersion(versionPrefix: string): Promise<string | null> {
+  try {
+    const url = `https://api.github.com/repos/nextflow-io/language-server/releases`;
+    const response = await fetch(url, {
+      headers: { 'Accept': 'application/vnd.github.v3+json' }
+    });
+    if (!response.ok) {
+      return null;
+    }
+    const releases = await response.json();
+    const matchingReleases = (releases as any[])
+      .map((release) => release.tag_name)
+      .filter((tag) => tag.startsWith(versionPrefix))
+      .sort((a, b) => b.localeCompare(a, undefined, { numeric: true }));
+    return matchingReleases.length > 0 ? matchingReleases[0] : null;
+  }
+  catch (error) {
+    return null
+  }
+}
+
+async function getLatestLocalVersion(versionPrefix: string): Promise<string | null> {
+  const targetDir = path.join(os.homedir(), ".nextflow", "lsp", versionPrefix);
+  const files = await vscode.workspace.fs.readDirectory(vscode.Uri.file(targetDir));
+  const jarFiles = files
+    .map(([name]) => name)
+    .filter(name => name.endsWith(".jar"))
+    .map(name => name.replace(".jar", ""))
+    .sort((a, b) => b.localeCompare(a, undefined, { numeric: true }));
+  return jarFiles.length > 0 ? jarFiles[0] : null;
+}
+
+async function getLanguageServerPath() {
+  if (!extensionContext) {
+    return null;
+  }
+
+  // use development build if present
+  const devPath = path.resolve(
+    extensionContext.extensionPath,
+    "bin",
+    "language-server-all.jar"
+  );
+  if (fs.existsSync(devPath)) {
+    vscode.window.showInformationMessage("Using development build of language server.");
+    return devPath;
+  }
+
+  // get the latest patch release from GitHub or local cache
+  const versionPrefix = vscode.workspace
+    .getConfiguration("nextflow")
+    .get("targetVersion") as string;
+  let resolvedVersion = await getLatestRemoteVersion(versionPrefix);
+  if (!resolvedVersion) {
+    resolvedVersion = await getLatestLocalVersion(versionPrefix);
+    if (resolvedVersion) {
+      vscode.window.showInformationMessage(`Failed to query latest version of language server from GitHub -- using version ${resolvedVersion} from local cache.`);
+    }
+  }
+  if (!resolvedVersion) {
+    return null;
+  }
+
+  // use locally cached version if present
+  const targetDir = path.join(os.homedir(), ".nextflow", "lsp", versionPrefix);
+  const cachePath = path.join(targetDir, `${resolvedVersion}.jar`);
+  if (fs.existsSync(cachePath)) {
+    return cachePath;
+  }
+
+  // download latest patch release to local cache
+  const response = await fetch(`https://github.com/nextflow-io/language-server/releases/download/${resolvedVersion}/language-server-all.jar`);
+  if (!response.ok) {
+    return null;
+  }
+  const arrayBuffer = await response.arrayBuffer();
+  await vscode.workspace.fs.createDirectory(vscode.Uri.file(targetDir));
+  const fileUri = vscode.Uri.file(cachePath);
+  await vscode.workspace.fs.writeFile(fileUri, new Uint8Array(arrayBuffer));
+  vscode.window.showInformationMessage(`Downloaded language server ${resolvedVersion}.`);
+  return fileUri.fsPath;
+}
+
 function startLanguageServer() {
   vscode.window.withProgress(
     { location: vscode.ProgressLocation.Window },
@@ -57,13 +143,15 @@ function startLanguageServer() {
             protocol2Code: (value) => vscode.Uri.parse(value),
           },
         };
+        let serverPath = await getLanguageServerPath();
+        if (!serverPath) {
+          resolve();
+          vscode.window.showErrorMessage("Failed to retrieve language server.");
+          return;
+        }
         let args = [
           "-jar",
-          path.resolve(
-            extensionContext.extensionPath,
-            "bin",
-            "language-server-all.jar"
-          ),
+          serverPath,
         ];
         // uncomment to allow a debugger to attach to the language server
         // args.unshift("-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005,quiet=y");