plugin2

Author: Jamie5

scala/private/phases/phase_compile.bzl

@@ -59,6 +59,7 @@ def phase_compile_library_for_plugin_bootstrapping(ctx, p):
             for target in p.scalac_provider.default_classpath + ctx.attr.exports
         ],
         unused_dependency_checker_mode = "off",
+        buildijar = ctx.attr.build_ijar,
     )
     return _phase_compile_default(ctx, p, args)
 

scala/private/rules/scala_library.bzl

@@ -161,6 +161,8 @@ _scala_library_for_plugin_bootstrapping_attrs.update(
     common_attrs_for_plugin_bootstrapping,
 )
 
+_scala_library_for_plugin_bootstrapping_attrs["build_ijar"] = attr.bool(default = True)
+
 def make_scala_library_for_plugin_bootstrapping(*extras):
     return rule(
         attrs = _dicts.add(

third_party/dependency_analyzer/src/main/BUILD

@@ -2,6 +2,21 @@ licenses(["notice"])  # 3-clause BSD
 
 load("//scala:scala.bzl", "scala_library_for_plugin_bootstrapping")
 
+scala_library_for_plugin_bootstrapping(
+    name = "scala_version",
+    srcs = [
+        "io/bazel/rulesscala/dependencyanalyzer/ScalaVersion.scala",
+    ],
+    # As this contains macros we shouldn't make an ijar
+    build_ijar = False,
+    resources = ["resources/scalac-plugin.xml"],
+    visibility = ["//visibility:public"],
+    deps = [
+        "//external:io_bazel_rules_scala/dependency/scala/scala_compiler",
+        "//external:io_bazel_rules_scala/dependency/scala/scala_reflect",
+    ],
+)
+
 scala_library_for_plugin_bootstrapping(
     name = "dependency_analyzer",
     srcs = [
@@ -14,6 +29,7 @@ scala_library_for_plugin_bootstrapping(
     resources = ["resources/scalac-plugin.xml"],
     visibility = ["//visibility:public"],
     deps = [
+        ":scala_version",
         "//external:io_bazel_rules_scala/dependency/scala/scala_compiler",
         "//external:io_bazel_rules_scala/dependency/scala/scala_reflect",
     ],

third_party/dependency_analyzer/src/main/io/bazel/rulesscala/dependencyanalyzer/AstUsedJarFinder.scala

@@ -37,6 +37,20 @@ class AstUsedJarFinder(
             node.original.foreach(fullyExploreTree)
           }
         case node: Literal =>
+          // We should examine OriginalTreeAttachment but that was only
+          // added in 2.12.4, so include a version check
+          ScalaVersion.conditional(
+            "2.12.4",
+            "",
+            """
+              node.attachments
+                .get[global.treeChecker.OriginalTreeAttachment]
+                .foreach { attach =>
+                  fullyExploreTree(attach.original)
+                }
+            """
+          )
+
           node.value.value match {
             case tpe: Type =>
               exploreType(tpe)

third_party/dependency_analyzer/src/main/io/bazel/rulesscala/dependencyanalyzer/ScalaVersion.scala

@@ -0,0 +1,112 @@
+package third_party.dependency_analyzer.src.main.io.bazel.rulesscala.dependencyanalyzer
+
+import scala.language.experimental.macros
+import scala.reflect.macros.blackbox
+
+object ScalaVersion {
+  val Current: ScalaVersion = ScalaVersion(util.Properties.versionNumberString)
+
+  def apply(versionString: String): ScalaVersion = {
+    versionString.split("\\.") match {
+      case Array(superMajor, major, minor) =>
+        new ScalaVersion(superMajor.toInt, major.toInt, minor.toInt)
+      case _ =>
+        throw new Exception(s"Failed to parse version $versionString")
+    }
+  }
+
+  /**
+   * Runs [code] only if minVersion and maxVersion constraints are met.
+   *
+   * NOTE: This method should be used only rarely. Most of the time
+   * just comparing versions in code should be enough. This is needed
+   * only when the code we want to run can't compile under certain
+   * versions. The reason to use this rarely is the API's inflexibility
+   * and the difficulty in debugging this code.
+   *
+   * Each of minVersion and maxVersion can either be the empty string ("")
+   * to signify that there is no restriction on this bound.
+   *
+   * Or it can be a string of a full version number such as "2.12.10".
+   *
+   * Note only literal strings are accepted, no variables etc. i.e.
+   *
+   * valid:
+   *  conditional(minVersion = "2.12.4", maxVersion = "", code = "foo()")
+   * invalid:
+   *  conditional(minVersion = MinVersionForFoo, maxVersion = "", code = "foo()")
+   */
+  def conditional(
+    minVersion: String,
+    maxVersion: String,
+    code: String
+  ): Unit =
+    macro conditionalImpl
+
+  def conditionalImpl(
+    c: blackbox.Context
+  )(
+    minVersion: c.Expr[String],
+    maxVersion: c.Expr[String],
+    code: c.Expr[String]
+  ): c.Tree = {
+    import c.{universe => u}
+    import u.Quasiquote
+    def extractString(expr: c.Expr[String]): String = {
+      expr.tree match {
+        case u.Literal(u.Constant(s: String)) =>
+          s
+        case _ =>
+          c.error(
+            expr.tree.pos,
+            "Parameter must be passed as a string literal such as \"2.12.10\"")
+          ""
+      }
+    }
+
+    val meetsMinVersionRequirement = {
+      val minVersionStr = extractString(minVersion)
+      minVersionStr == "" || Current >= ScalaVersion(minVersionStr)
+    }
+
+    val meetsMaxVersionRequirement = {
+      val maxVersionStr = extractString(maxVersion)
+      maxVersionStr == "" || Current <= ScalaVersion(maxVersionStr)
+    }
+
+    if (meetsMinVersionRequirement && meetsMaxVersionRequirement) {
+      c.parse(extractString(code))
+    } else {
+      q""
+    }
+  }
+}
+
+class ScalaVersion private(
+  private val superMajor: Int,
+  private val major: Int,
+  private val minor: Int
+) extends Ordered[ScalaVersion] {
+  override def compare(that: ScalaVersion): Int = {
+    if (this.superMajor != that.superMajor) {
+      this.superMajor.compareTo(that.superMajor)
+    } else if (this.major != that.major) {
+      this.major.compareTo(that.major)
+    } else {
+      this.minor.compareTo(that.minor)
+    }
+  }
+
+  override def equals(obj: Any): Boolean = {
+    obj match {
+      case that: ScalaVersion =>
+        compare(that) == 0
+      case _ =>
+        false
+    }
+  }
+
+  override def toString: String = {
+    s"$superMajor.$major.$minor"
+  }
+}

third_party/dependency_analyzer/src/test/BUILD

@@ -14,17 +14,29 @@ scala_test(
         "io/bazel/rulesscala/dependencyanalyzer/AstUsedJarFinderTest.scala",
     ],
     jvm_flags = common_jvm_flags,
-    unused_dependency_checker_mode = "off",
     deps = [
-        "//external:io_bazel_rules_scala/dependency/scala/scala_compiler",
         "//external:io_bazel_rules_scala/dependency/scala/scala_library",
         "//external:io_bazel_rules_scala/dependency/scala/scala_reflect",
         "//third_party/dependency_analyzer/src/main:dependency_analyzer",
+        "//third_party/dependency_analyzer/src/main:scala_version",
         "//third_party/utils/src/test:test_util",
         "@scalac_rules_commons_io//jar",
     ],
 )
 
+scala_test(
+    name = "scala_version_test",
+    size = "small",
+    srcs = [
+        "io/bazel/rulesscala/dependencyanalyzer/ScalaVersionTest.scala",
+    ],
+    deps = [
+        "//external:io_bazel_rules_scala/dependency/scala/scala_library",
+        "//external:io_bazel_rules_scala/dependency/scala/scala_reflect",
+        "//third_party/dependency_analyzer/src/main:scala_version",
+    ],
+)
+
 scala_test(
     name = "strict_deps_test",
     size = "small",

third_party/dependency_analyzer/src/test/io/bazel/rulesscala/dependencyanalyzer/AstUsedJarFinderTest.scala

@@ -5,6 +5,7 @@ import java.nio.file.Path
 import org.apache.commons.io.FileUtils
 import org.scalatest._
 import third_party.dependency_analyzer.src.main.io.bazel.rulesscala.dependencyanalyzer.DependencyTrackingMethod
+import third_party.dependency_analyzer.src.main.io.bazel.rulesscala.dependencyanalyzer.ScalaVersion
 import third_party.utils.src.test.io.bazel.rulesscala.utils.JavaCompileUtil
 import third_party.utils.src.test.io.bazel.rulesscala.utils.TestUtil
 import third_party.utils.src.test.io.bazel.rulesscala.utils.TestUtil.DependencyAnalyzerTestParams
@@ -152,6 +153,23 @@ class AstUsedJarFinderTest extends FunSuite {
     }
   }
 
+  /**
+   * In a situation where B depends indirectly on A, ensure
+   * that the dependency analyzer recognizes this fact.
+   */
+  private def checkIndirectDependencyDetected(
+    aCode: String,
+    bCode: String
+  ): Unit = {
+    withSandbox { sandbox =>
+      sandbox.compileWithoutAnalyzer(aCode)
+      sandbox.checkUnusedDepsErrorReported(
+        code = bCode,
+        expectedUnusedDeps = List("A")
+      )
+    }
+  }
+
   test("simple composition in indirect") {
     checkIndirectDependencyDetected(
       aCode =
@@ -302,6 +320,43 @@ class AstUsedJarFinderTest extends FunSuite {
     )
   }
 
+  test("inlined literal is direct") {
+    // Note: For a constant to be inlined
+    // - it must not have a type declaration such as `: Int`.
+    //   (this appears to be the case in practice at least)
+    //   (is this documented anywhere???)
+    // - some claim it must start with a capital letter, though
+    //   this does not seem to be the case. Nevertheless we do that
+    //    anyways.
+    //
+    // Hence it is possible that as newer versions of scala
+    // are released then this test may need to be updated to
+    // conform to changing requirements of what is inlined.
+
+    // Note that in versions of scala < 2.12.4 we cannot detect
+    // such a situation. Hence we will have a false positive here
+    // for those older versions, which we verify in test.
+
+    val aCode =
+      s"""
+         |object A {
+         |  final val Inlined = 123
+         |}
+         |""".stripMargin
+    val bCode =
+      s"""
+         |object B {
+         |  val d: Int = A.Inlined
+         |}
+         |""".stripMargin
+
+    if (ScalaVersion.Current >= ScalaVersion("2.12.4")) {
+      checkDirectDependencyRecognized(aCode = aCode, bCode = bCode)
+    } else {
+      checkIndirectDependencyDetected(aCode = aCode, bCode = bCode)
+    }
+  }
+
   test("java interface method argument is direct") {
     withSandbox { sandbox =>
       sandbox.compileJava(
@@ -318,4 +373,60 @@ class AstUsedJarFinderTest extends FunSuite {
       )
     }
   }
+
+  test("java interface field and method is direct") {
+    withSandbox { sandbox =>
+      sandbox.compileJava(
+        className = "A",
+        code = "public interface A { int a = 42; }"
+      )
+      val bCode =
+        """
+          |class B {
+          |  def foo(x: A): Unit = {}
+          |  val b = A.a
+          |}
+          |""".stripMargin
+
+      // It is unclear why this only works with these versions but
+      // presumably there were various compiler improvements.
+      if (ScalaVersion.Current >= ScalaVersion("2.12.0")) {
+        sandbox.checkStrictDepsErrorsReported(
+          bCode,
+          expectedStrictDeps = List("A")
+        )
+      } else {
+        sandbox.checkUnusedDepsErrorReported(
+          bCode,
+          expectedUnusedDeps = List("A")
+        )
+      }
+    }
+  }
+
+  test("java interface field is direct") {
+    withSandbox { sandbox =>
+      sandbox.compileJava(
+        className = "A",
+        code = "public interface A { int a = 42; }"
+      )
+      val bCode =
+        """
+          |class B {
+          |  val b = A.a
+          |}
+          |""".stripMargin
+      if (ScalaVersion.Current >= ScalaVersion("2.12.4")) {
+        sandbox.checkStrictDepsErrorsReported(
+          bCode,
+          expectedStrictDeps = List("A")
+        )
+      } else {
+        sandbox.checkUnusedDepsErrorReported(
+          bCode,
+          expectedUnusedDeps = List("A")
+        )
+      }
+    }
+  }
 }