[feature] project view 2000

.github/workflows/unit-tests.yml

@@ -10,13 +10,13 @@ jobs:
   bazelrunner-test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up JDK 11
-      uses: actions/setup-java@v1
-      with:
-        java-version: 11
-    - name: Run tests
-      run: bazel test //bazelrunner/...
+      - uses: actions/checkout@v2
+      - name: Set up JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: Run tests
+        run: bazel test //bazelrunner/...
 
   projectview-test:
     runs-on: ubuntu-latest

commons/src/main/java/org/jetbrains/bsp/bazel/commons/BUILD

@@ -7,5 +7,6 @@ java_library(
     deps = [
         "@maven//:ch_epfl_scala_bsp4j",
         "@maven//:com_google_guava_guava",
+        "@maven//:io_vavr_vavr",
     ],
 )

commons/src/main/java/org/jetbrains/bsp/bazel/commons/BetterFiles.java

@@ -0,0 +1,17 @@
+package org.jetbrains.bsp.bazel.commons;
+
+import com.google.common.io.CharSource;
+import com.google.common.io.Files;
+import io.vavr.control.Try;
+import java.nio.charset.Charset;
+import java.nio.file.Path;
+
+public final class BetterFiles {
+
+  public static Try<String> tryReadFileContent(Path filePath) {
+    return Try.success(filePath)
+        .map(Path::toFile)
+        .map(file -> Files.asCharSource(file, Charset.defaultCharset()))
+        .mapTry(CharSource::read);
+  }
+}

commons/src/main/java/org/jetbrains/bsp/bazel/commons/Constants.java

@@ -64,5 +64,7 @@ public class Constants {
 
   public static final String SCALA_TEST_MAIN_CLASSES_ATTRIBUTE_NAME = "main_class";
 
-  public static final String DEFAULT_PROJECT_VIEW_FILE = "projectview.bazelproject";
+  public static final String PROJECT_VIEW_FILE_PATH = "projectview.bazelproject";
+  public static final String DEFAULT_PROJECT_VIEW_FILE_PATH =
+      ".bazelbsp/default-projectview.bazelproject";
 }

commons/src/test/java/org/jetbrains/bsp/bazel/commons/BUILD

@@ -0,0 +1,14 @@
+load("@rules_java//java:defs.bzl", "java_test")
+
+java_test(
+    name = "BetterFilesTest",
+    size = "small",
+    srcs = ["BetterFilesTest.java"],
+    runtime_deps = [
+        "@maven//:junit_junit",
+    ],
+    deps = [
+        "//commons/src/main/java/org/jetbrains/bsp/bazel/commons",
+        "@maven//:io_vavr_vavr",
+    ],
+)

commons/src/test/java/org/jetbrains/bsp/bazel/commons/BetterFilesTest.java

@@ -0,0 +1,45 @@
+package org.jetbrains.bsp.bazel.commons;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.nio.file.Paths;
+import org.junit.Test;
+
+public class BetterFilesTest {
+
+  @Test
+  public void shouldReturnFailureForNotExistingFile() {
+    // given
+    var filePath = Paths.get("file/doesnt/exist");
+
+    // when
+    var fileContent = BetterFiles.tryReadFileContent(filePath);
+
+    // then
+    assertTrue(fileContent.isFailure());
+  }
+
+  @Test
+  public void shouldParseExistingFile() throws IOException {
+    // given
+    var file = File.createTempFile("test", "file");
+    file.deleteOnExit();
+    var filePath = file.toPath();
+
+    var fileWriter = new FileWriter(file);
+
+    fileWriter.write("test content");
+    fileWriter.close();
+
+    // when
+    var fileContent = BetterFiles.tryReadFileContent(filePath);
+
+    // then
+    assertTrue(fileContent.isSuccess());
+    assertEquals("test content", fileContent.get());
+  }
+}

docs/BUMPVERSION.md

@@ -1,5 +1,7 @@
 # Bump Version
+
 If you want to bump version (for example, before a release) you should do this in the following places:
+
 - `central-sync/VERSION`
 - `maven_coordinates` in `server/src/main/java/org/jetbrains/bsp/bazel/BUILD`
 - `VERSION` in `commons/src/main/java/org/jetbrains/bsp/bazel/commons/Constants.java`

docs/kotlin.md

@@ -1,6 +1,9 @@
 # BSP Kotlin
-In order to fully have the experience to use BSP over kotlin, make sure that you're using at least version `0da862aaa11db26f6a113dcec5f6828bfd186ac9` of `rules_kotlin`. This will ensure
+
+In order to fully have the experience to use BSP over kotlin, make sure that you're using at least
+version `0da862aaa11db26f6a113dcec5f6828bfd186ac9` of `rules_kotlin`. This will ensure
 that compilation diagnostics are being delivered to you.
+
 ```
 rules_kotlin_version = "0da862aaa11db26f6a113dcec5f6828bfd186ac9"
 rules_kotlin_sha = "6fda2451b9aaf78a8399e6e5d13c31c8ddc558e87de209a7cfd5ddc777ac7877"
@@ -15,4 +18,5 @@ kotlin_repositories() # if you want the default
 kt_register_toolchains() # to use the default toolchain
 ```
 
-This changes have not been merged yet and progress can be accompanied [here](https://github.com/bazelbuild/rules_kotlin/pull/359).
+This changes have not been merged yet and progress can be
+accompanied [here](https://github.com/bazelbuild/rules_kotlin/pull/359).

docs/scala.md

@@ -1,6 +1,8 @@
 # Toolchain Registration for Scala
+
 In order to fully use Bazel BSP for Scala projects make sure to use at least version
- ``d8bce245a96ca9ab721324bc8daa984aa13fa0f7`` of `rules_scala`:
+`d8bce245a96ca9ab721324bc8daa984aa13fa0f7` of `rules_scala`:
+
 ```
 http_archive(
     name = "io_bazel_rules_scala",
@@ -13,7 +15,9 @@ bazel_version(name = "bazel_version")
 ```
 
 Make sure that your registered toolchain has Compilation Diagnostics enabled:
+
 - At a BUILD file:
+
 ```
 load("@io_bazel_rules_scala//scala:scala_toolchain.bzl", "scala_toolchain")
 
@@ -30,7 +34,9 @@ toolchain(
     visibility = ["//visibility:public"],
 )
 ```
+
 - At the WORKSPACE file:
+
 ```
 register_toolchains(
     "<label_to_build_file>:diagnostics_reporter_toolchain"

e2e/runTest.sh

@@ -36,11 +36,16 @@ fi
 bsp_path="$(bazel info bazel-bin)/server/src/main/java/org/jetbrains/bsp/bazel/bsp-install"
 echo "Building done."
 
-echo "Installing BSP..."
+echo "Cleaning project directory..."
 if [ "$#" -eq 2 ]; then
   cd "$TEST_PROJECT_PATH" || exit
 fi
-$bsp_path
+rm -r .bsp/ > /dev/null 2>&1
+rm -r .bazelbsp/ > /dev/null 2>&1
+echo "Cleaning project directory done!"
+
+echo "Installing BSP..."
+$bsp_path || exit
 echo "Installing done."
 echo "Environment has been prepared!"
 echo -e "-----------------------------------\n"

install/src/main/java/org/jetbrains/bsp/bazel/install/BUILD

@@ -3,10 +3,14 @@ load("@rules_java//java:defs.bzl", "java_library")
 java_library(
     name = "install",
     srcs = glob(["*.java"]),
-    resources = ["aspects.bzl"],
+    resources = [
+        "aspects.bzl",
+        "default-projectview.bazelproject",
+    ],
     visibility = ["//install:__subpackages__"],
     deps = [
         "//commons",
+        "//projectview:parser",
         "@maven//:ch_epfl_scala_bsp4j",
         "@maven//:com_google_code_gson_gson",
         "@maven//:com_google_guava_guava",

install/src/main/java/org/jetbrains/bsp/bazel/install/Install.java

@@ -24,6 +24,8 @@
 import org.apache.commons.cli.Options;
 import org.apache.commons.cli.ParseException;
 import org.jetbrains.bsp.bazel.commons.Constants;
+import org.jetbrains.bsp.bazel.projectview.model.ProjectView;
+import org.jetbrains.bsp.bazel.projectview.parser.ProjectViewDefaultParserProvider;
 
 public class Install {
 
@@ -53,15 +55,30 @@ public static void main(String[] args) throws IOException {
       if (cmd.hasOption(HELP_SHORT_OPT)) {
         formatter.printHelp(INSTALLER_BINARY_NAME, cliOptions);
       } else {
-        addJavaBinary(cmd, argv);
+        Path rootDir = getRootDir(cmd);
+        Path bazelbspDir = createDir(rootDir, Constants.BAZELBSP_DIR_NAME);
+
+        Path defaultProjectViewFilePath = bazelbspDir.resolve("default-projectview.bazelproject");
+        Files.copy(
+            Install.class.getResourceAsStream("default-projectview.bazelproject"),
+            defaultProjectViewFilePath,
+            StandardCopyOption.REPLACE_EXISTING);
+
+        copyAspects(bazelbspDir);
+        createEmptyBuildFile(bazelbspDir);
+
+        var projectViewProvider = new ProjectViewDefaultParserProvider(rootDir);
+        // will be handled properly
+        var projectView = projectViewProvider.create().get();
+
+        addJavaBinary(cmd, argv, projectView);
         addJavaClasspath(argv);
-        addDebuggerConnection(cmd, argv);
+        addDebuggerConnection(cmd, argv, projectView);
         argv.add(SERVER_CLASS_NAME);
         addBazelBinary(cmd, argv);
         addBazelTargets(cmd, argv);
 
         BspConnectionDetails details = createBspConnectionDetails(argv);
-        Path rootDir = getRootDir(cmd);
         writeConfigurationFiles(rootDir, details);
 
         System.out.println("Bazel BSP server installed in '" + rootDir.toAbsolutePath() + "'.");
@@ -70,7 +87,7 @@ public static void main(String[] args) throws IOException {
       writer.println(e.getMessage());
       formatter.printUsage(writer, 120, INSTALLER_BINARY_NAME, cliOptions);
       hasError = true;
-    } catch (NoSuchElementException e) {
+    } catch (NoSuchElementException | IllegalStateException e) {
       writer.println(e.getMessage());
       hasError = true;
     } finally {
@@ -105,9 +122,11 @@ private static void addBazelBinary(CommandLine cmd, List<String> argv) {
     }
   }
 
-  private static void addJavaBinary(CommandLine cmd, List<String> argv) {
+  private static void addJavaBinary(CommandLine cmd, List<String> argv, ProjectView projectView) {
     if (cmd.hasOption(JAVA_SHORT_OPT)) {
       argv.add(cmd.getOptionValue(JAVA_SHORT_OPT));
+    } else if (projectView.getJavaPath().isPresent()) {
+      argv.add(projectView.getJavaPath().get().getValue());
     } else {
       String javaHome = readSystemProperty("java.home");
       argv.add(Paths.get(javaHome).resolve("bin").resolve("java").toString());
@@ -125,9 +144,13 @@ private static void addJavaClasspath(List<String> argv) {
     argv.add(classpath);
   }
 
-  private static void addDebuggerConnection(CommandLine cmd, List<String> argv) {
+  private static void addDebuggerConnection(
+      CommandLine cmd, List<String> argv, ProjectView projectView) {
     if (cmd.hasOption(DEBUGGER_SHORT_OPT)) {
-      String debuggerAddress = cmd.getOptionValue(DEBUGGER_SHORT_OPT);
+      var debuggerAddress = cmd.getOptionValue(DEBUGGER_SHORT_OPT);
+      argv.add("-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=" + debuggerAddress);
+    } else if (projectView.getDebuggerAddress().isPresent()) {
+      var debuggerAddress = projectView.getDebuggerAddress().get().getValue();
       argv.add("-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=" + debuggerAddress);
     }
   }
@@ -174,10 +197,6 @@ private static void writeBazelbspJson(Path bspDir, Object discoveryDetails) thro
 
   private static void writeConfigurationFiles(Path rootDir, Object discoveryDetails)
       throws IOException {
-    Path bazelbspDir = createDir(rootDir, Constants.BAZELBSP_DIR_NAME);
-    copyAspects(bazelbspDir);
-    createEmptyBuildFile(bazelbspDir);
-
     Path bspDir = createDir(rootDir, Constants.BSP_DIR_NAME);
     writeBazelbspJson(bspDir, discoveryDetails);
   }
@@ -190,7 +209,9 @@ private static Options getCliOptions() {
             .longOpt("java")
             .hasArg()
             .argName("path")
-            .desc("Use provided Java executable to run the BSP server")
+            .desc(
+                "Deprecated! Use project view file instead. "
+                    + "(Use provided Java executable to run the BSP server)")
             .build();
 
     cliOptions.addOption(java);
@@ -200,7 +221,9 @@ private static Options getCliOptions() {
             .longOpt("bazel")
             .hasArg()
             .argName("path")
-            .desc("Make the BSP server use this Bazel executable")
+            .desc(
+                "Deprecated! Use project view file instead. "
+                    + "(Make the BSP server use this Bazel executable)")
             .build();
 
     cliOptions.addOption(bazel);
@@ -210,7 +233,7 @@ private static Options getCliOptions() {
             .longOpt("debugger")
             .hasArg()
             .argName("address (e.g. '127.0.0.1:8000'")
-            .desc("Allow BSP server debugging")
+            .desc("Deprecated! Use project view file instead. (Allow BSP server debugging)")
             .build();
 
     cliOptions.addOption(debug);
@@ -221,8 +244,9 @@ private static Options getCliOptions() {
             .hasArg()
             .argName("path")
             .desc(
-                "Path to directory where bazelbsp server should be setup. "
-                    + "Current directory will be used by default")
+                "Deprecated! Use project view file instead. "
+                    + "(Path to directory where bazelbsp server should be setup. "
+                    + "Current directory will be used by default)")
             .build();
 
     cliOptions.addOption(directory);
@@ -233,8 +257,9 @@ private static Options getCliOptions() {
             .hasArg()
             .argName("targets")
             .desc(
-                "Name of the bazel's targets that the server should import. Targets can be"
-                    + "separated by a comma. The default is to import all targets (//...)")
+                "Deprecated! Use project view file instead. (Name of the bazel's targets that the"
+                    + " server should import. Targets can be separated by a comma. The default is"
+                    + " to import all targets (//...))")
             .build();
 
     cliOptions.addOption(targets);
@@ -264,8 +289,4 @@ private static String readSystemProperty(String name) {
     }
     return property;
   }
-
-  private static String getCurrentDirectory() {
-    return System.getProperty("user.dir");
-  }
 }

install/src/main/java/org/jetbrains/bsp/bazel/install/default-projectview.bazelproject

@@ -0,0 +1,5 @@
+# this is default project configuration
+
+# all targets in the project are included
+targets:
+    //...

pom.xml

@@ -10,7 +10,8 @@
 
     <name>Bazel BSP</name>
     <description>
-        An implementation of the Build Server Protocol for Bazel. Allows clients such as IntelliJ to obtain build specific
+        An implementation of the Build Server Protocol for Bazel. Allows clients such as IntelliJ to obtain build
+        specific
         information in order to improve the experience of users in the IDE.
     </description>
     <url>https://www.jetbrains.com/</url>

projectview/BUILD

@@ -5,15 +5,14 @@ java_library(
     visibility = ["//visibility:public"],
     exports = [
         "//projectview/src/main/java/org/jetbrains/bsp/bazel/projectview/model",
-        "//projectview/src/main/java/org/jetbrains/bsp/bazel/projectview/model/sections",
-        "//projectview/src/main/java/org/jetbrains/bsp/bazel/projectview/model/sections/specific",
     ],
 )
 
 java_library(
     name = "parser",
     visibility = ["//visibility:public"],
     exports = [
+        "//projectview/src/main/java/org/jetbrains/bsp/bazel/projectview/model",
         "//projectview/src/main/java/org/jetbrains/bsp/bazel/projectview/parser",
     ],
 )