Merge Task Server & Build Server

.github/workflows/main.yml

@@ -13,10 +13,10 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0 # required by sonarqube
-      - name: Use Java 11
+      - name: Use Java 17
         uses: actions/setup-java@v1
         with:
-          java-version: "11"
+          java-version: "17"
           architecture: x64
       - name: Use Node 16.14.2
         uses: actions/setup-node@v4
@@ -31,6 +31,14 @@ jobs:
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
+      - name: Checkout microsoft/build-server-for-gradle
+        uses: actions/checkout@v2
+        with:
+          repository: microsoft/build-server-for-gradle
+          path: extension/build-server-for-gradle
+      - name: Build Jars
+        run: ../gradlew buildJars
+        working-directory: extension/
       - name: Lint
         uses: gradle/gradle-build-action@v2
         with:
@@ -61,7 +69,7 @@ jobs:
       fail-fast: false
       matrix:
         node-version: [16.14.2]
-        java-version: ["8", "11", "17", "21"]
+        java-version: ["17", "21"]
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
       - uses: actions/checkout@v2

.vscode/launch.json

@@ -31,19 +31,14 @@
     },
     {
       "type": "java",
-      "name": "Debug Server",
-      "request": "launch",
-      "mainClass": "com.github.badsyntax.gradle.GradleServer",
-      "projectName": "gradle-server",
-      "cwd": "${workspaceFolder}/gradle-server",
-      "presentation": {
-        "group": "debug",
-        "order": 2,
-        "hidden": true
-      }
+      "name": "Attach to Gradle Server",
+      "request": "attach",
+      "hostName": "localhost",
+      "port": "8089",
+      "projectName": "com.github.badsyntax.gradle"
     },
     {
-      "name": "Debug Extension with Debug Server",
+      "name": "Debug Gradle Server & Extension",
       "type": "extensionHost",
       "request": "launch",
       "runtimeExecutable": "${execPath}",
@@ -54,12 +49,13 @@
         "${workspaceFolder}/extension/dist/**/*.js"
       ],
       "preLaunchTask": "Gradle: Build",
+      "presentation": {
+        "group": "debug",
+        "order": 2
+      },
       "env": {
-        "VSCODE_DEBUG_SERVER": "true"
+        "GRADLE_SERVER_OPTS":"-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=8089"
       },
-      "presentation": {
-        "hidden": true
-      }
     },
     {
       "name": "Debug Extension & Gradle Plugin",
@@ -76,30 +72,10 @@
       "env": {
         "VSCODE_DEBUG_PLUGIN": "true"
       },
-      "presentation": {
-        "group": "debug",
-        "order": 2
-      }
-    },
-    {
-      "name": "Debug Extension & Build Server",
-      "type": "extensionHost",
-      "request": "launch",
-      "runtimeExecutable": "${execPath}",
-      "args": [
-        "--extensionDevelopmentPath=${workspaceFolder}/extension"
-      ],
-      "outFiles": [
-        "${workspaceFolder}/extension/dist/**/*.js"
-      ],
-      "preLaunchTask": "Gradle: Build",
       "presentation": {
         "group": "debug",
         "order": 3
-      },
-      "env": {
-        "DEBUG_GRADLE_BUILD_SERVER":"true"
-      },
+      }
     },
     {
       "name": "Debug Language Server: Launch Extension",
@@ -372,17 +348,4 @@
       }
     },
   ],
-  "compounds": [
-    {
-      "name": "Debug Server & Extension",
-      "configurations": [
-        "Debug Server",
-        "Debug Extension with Debug Server"
-      ],
-      "presentation": {
-        "group": "debug",
-        "order": 3
-      }
-    }
-  ]
 }

CONTRIBUTING.md

@@ -8,7 +8,7 @@ Start by opening an issue using one of the issue templates, or propose a change
 
 ### Build Gradle Server and Gradle Language Server.
 1. Install [nvm](https://github.com/nvm-sh/nvm)
-2. Install [Java version >= 8](https://adoptium.net/)
+2. Install [Java version >= 17](https://adoptium.net/)
 3. Change directory to the root of the project
 4. Select Node version: `nvm use`
 5. If using an Apple M1:
@@ -40,34 +40,22 @@ The extension uses a Gradle plugin (`com.microsoft.gradle.GradlePlugin`) to get
 
 > Note: There is a known issue that when the Gradle project stores in a sub-folder of the root folder, the `Attach to Gradle Plugin` will fail to attach. See [#1237](https://github.com/microsoft/vscode-gradle/issues/1237).
 
-## Debugging Gradle Build Server
-
-To debug the Extension with the [Gradle Build Server](https://github.com/microsoft/build-server-for-gradle), follow these steps:
-
-1. Open the `extension/build-server-for-gradle` directory, which you should have [imported previously](#build-gradle-project-importer) as a separate project.
-2. In the `.vscode/launch.json` of the build-server-for-gradle project, ensure you have the following configuration to attach the debugger:
-   ```json
-   {
-     "type": "java",
-     "name": "Attach to Gradle Build Server",
-     "request": "attach",
-     "hostName": "localhost",
-     "port": "8989",
-     "projectName": "server"
-   }
-   ```
-3. In your main project (vscode-gradle), start the `Debug Extension & Build Server` launch configuration.
-4. In the build-server-for-gradle project, start the `Attach to Gradle Build Server` launch configuration.
+## Debugging Gradle Server
+
+1. Run vscode launch configuration `Debug Gradle Server & Extension`.
+2. Run vscode launch configuration `Attach to Gradle Server` when you notice the `Gradle: Connecting...` message in the bottom status bar.
+
+> **Note:** If the "Java: Error" message appears in the bottom status bar and the following error is logged in the `.log` file:
+> ```java
+> java.lang.NullPointerException: Cannot invoke "ch.epfl.scala.bsp4j.WorkspaceBuildTargetsResult.getTargets()"
+> ```
+> it indicates that the connection attempt to the Gradle Server was too slow. The [GradleBuildClient](/extension/jdtls.ext/com.microsoft.gradle.bs.importer/src/com/microsoft/gradle/bs/importer/ImporterPlugin.java#L107) requires an active Gradle Server to successfully establish a connection. If you encounter this issue, please retry the connection promptly to avoid this error.
 
 ## Debugging Gradle Language Server (editing feature related)
 
 1. Run vscode launch configuration `Debug Language Server: Launch Extension`.
 2. Run vscode launch configuration `Debug Language Server: Launch Language Server`.
 
-## Debugging Gradle Server (work with Gradle daemon)
-
-Run vscode launch configuration `Debug Server & Extension`.
-
 ## Development Workflow
 
 Open the root of the project in VS Code.

build.gradle

@@ -8,7 +8,7 @@ plugins {
 project.ext.set('grpcVersion', '1.53.0')
 project.ext.set('protobufVersion', '3.12.0')
 project.ext.set('protocVersion', project.protobufVersion)
-project.ext.set('toolingAPIVersion', '8.0.2')
+project.ext.set('toolingAPIVersion', '8.8')
 
 allprojects {
   group = 'vscode-gradle'

extension/.eslintignore

@@ -9,3 +9,5 @@ src/proto/
 build/
 beta/
 webpack.config.js
+build-server-for-gradle/
+bin/

extension/.prettierignore

@@ -9,3 +9,5 @@ lib/
 src/proto/
 build/
 src/java-test-runner.api.ts
+build-server-for-gradle/
+bin/

extension/build.gradle

@@ -225,18 +225,28 @@ task buildBuildServer(type: CrossPlatformExec) {
   }
 }
 
-task copyBuildServerJars(type: Copy) {
+task copyBuildServerPluginJars(type: Copy) {
   dependsOn ':extension:buildBuildServer'
   from('./build-server-for-gradle/server/build/libs/') {
-    include '**/*.jar'
-    include '**/init.gradle'
+    include 'plugins/'
   }
   into 'server'
   mustRunAfter copyDocs
 }
 
+// TODO: This task can be removed once the build server is published.
+task copyBuildServerJarsToGradleServer(type: Copy) {
+  dependsOn ':extension:buildBuildServer'
+  from('./build-server-for-gradle/server/build/libs/') {
+    include 'runtime/'
+  }
+  from('./build-server-for-gradle/server/build/libs/server.jar')
+  into '../gradle-server/build/libs/'
+  mustRunAfter copyDocs
+}
+
 task buildJars() {
-  dependsOn copyJdtlsPluginJar, copyBuildServerJars
+  dependsOn copyJdtlsPluginJar, copyBuildServerPluginJars, copyBuildServerJarsToGradleServer
 }
 
 build.finalizedBy buildProd, buildTest

extension/jdtls.ext/com.microsoft.gradle.bs.importer/src/com/microsoft/gradle/bs/importer/GradleBuildServerProjectImporter.java

@@ -61,6 +61,10 @@ public boolean applies(IProgressMonitor monitor) throws OperationCanceledExcepti
             return false;
         }
 
+        //TODO: support multi-root workspaces
+        if (getPreferences().getRootPaths().size() != 1) {
+            return false;
+        }
 
         if (!Utils.isBuildServerEnabled(getPreferences())) {
             return false;

extension/jdtls.ext/com.microsoft.gradle.bs.importer/src/com/microsoft/gradle/bs/importer/ImporterPlugin.java

@@ -2,9 +2,6 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.nio.file.Paths;
-import java.util.ArrayList;
-import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.ConcurrentHashMap;
@@ -38,8 +35,6 @@ public class ImporterPlugin extends Plugin {
      */
     private DigestStore digestStore;
 
-    private static String bundleDirectory;
-
     private static String bundleVersion = "";
 
     @Override
@@ -52,7 +47,6 @@ public void start(BundleContext context) throws Exception {
         if (!bundleFile.isPresent()) {
            throw new IllegalStateException("Failed to get bundle location.");
         }
-        bundleDirectory = bundleFile.get().getParent();
     }
 
     @Override
@@ -102,31 +96,18 @@ public static BuildServerConnection getBuildServerConnection(IPath rootPath, boo
             return null;
         }
 
-        String javaExecutablePath = getJavaExecutablePath();
-        String[] classpaths = getBuildServerClasspath();
-
-        String pluginPath = getBuildServerPluginPath();
-
-        List<String> command = new ArrayList<>();
-        command.add(javaExecutablePath);
-        if (Boolean.parseBoolean(System.getenv("DEBUG_GRADLE_BUILD_SERVER"))) {
-            command.add("-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=8989");
+        if (instance.buildServers.size() > 0) {
+            throw new CoreException(new Status(IStatus.ERROR, PLUGIN_ID,
+                    "Not support multiple workspaces."));
         }
-        command.add("--add-opens=java.base/java.lang=ALL-UNNAMED");
-        command.add("--add-opens=java.base/java.io=ALL-UNNAMED");
-        command.add("--add-opens=java.base/java.util=ALL-UNNAMED");
-        command.add("-Dplugin.dir=" + pluginPath);
-        command.add("-cp");
-        command.add(String.join(getClasspathSeparator(), classpaths));
-        command.add("com.microsoft.java.bs.core.Launcher");
-
-        ProcessBuilder build = new ProcessBuilder(command);
+
         try {
-            Process process = build.start();
-            BuildClient client = new GradleBuildClient();
+            NamedPipeStream pipeStream = new NamedPipeStream();
+
+            GradleBuildClient client = new GradleBuildClient();
             Launcher<BuildServerConnection> launcher = new Launcher.Builder<BuildServerConnection>()
-                    .setOutput(process.getOutputStream())
-                    .setInput(process.getInputStream())
+                    .setOutput(pipeStream.getOutputStream())
+                    .setInput(pipeStream.getInputStream())
                     .setLocalService(client)
                     .setExecutorService(Executors.newCachedThreadPool())
                     .setRemoteInterface(BuildServerConnection.class)
@@ -142,37 +123,4 @@ public static BuildServerConnection getBuildServerConnection(IPath rootPath, boo
                     "Failed to start build server.", e));
         }
     }
-
-    /**
-     * Get the Java executable used by JDT.LS, which will be higher than JDK 17.
-     */
-    private static String getJavaExecutablePath() {
-        Optional<String> command = ProcessHandle.current().info().command();
-        if (command.isPresent()) {
-            return command.get();
-        }
-
-        throw new IllegalStateException("Failed to get Java executable path.");
-    }
-
-    private static String[] getBuildServerClasspath() {
-        return new String[]{
-            Paths.get(bundleDirectory, "server.jar").toString(),
-            Paths.get(bundleDirectory, "runtime").toString() + File.separatorChar + "*"
-        };
-    }
-
-    private static String getBuildServerPluginPath() {
-        return Paths.get(bundleDirectory, "plugins").toString();
-    }
-
-    private static String getClasspathSeparator() {
-        String os = System.getProperty("os.name").toLowerCase();
-
-        if (os.contains("win")) {
-            return ";";
-        }
-
-        return ":"; // Linux or Mac
-    }
 }