Merge pull request #12 from VirtusLab/jmh

Add JMH tests for pretty stacktraces

build.sbt

@@ -1,3 +1,5 @@
+enablePlugins(JmhPlugin)
+
 inThisBuild(List(
   sonatypeProfileName := "org.virtuslab",
   organization := "org.virtuslab",
@@ -19,20 +21,18 @@ inThisBuild(List(
   )
 ))
 
+Global / excludeLintKeys += ThisBuild / organization
+
 val scala3Version = "3.1.0-RC1-bin-20210820-68044a6-NIGHTLY"
-val Examples = config("examples") extend Compile
 
 lazy val root = project
   .in(file("."))
-  .configs(Examples)
+  .enablePlugins(JmhPlugin)
   .settings(
     organization := "org.virtuslab",
     name := "pretty-stacktraces",
 
     scalaVersion := scala3Version,
     libraryDependencies += "com.novocode" % "junit-interface" % "0.11" % "test",
     libraryDependencies += "org.scala-lang" %% "scala3-tasty-inspector" % scalaVersion.value,
-
-    inConfig(Examples)(Defaults.compileSettings),
-    Examples / sourceDirectory := baseDirectory.value / "src" / "examples",
   )

project/plugins.sbt

@@ -1 +1,2 @@
 addSbtPlugin("com.geirsson" % "sbt-ci-release" % "1.5.7")
+addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.4.3")

src/jmh/scala/com/virtuslab/stacktraces/benchmarks/Main.scala

@@ -0,0 +1,46 @@
+package org.virtuslab.stacktraces
+package benchmarks
+
+import org.virtuslab.stacktraces.core.Stacktraces
+import org.virtuslab.stacktraces.printer.PrettyExceptionPrinter
+
+// Must not be in default package
+import java.util.concurrent.TimeUnit
+
+import org.openjdk.jmh.annotations.{Benchmark, BenchmarkMode, Mode, OutputTimeUnit, State, Scope}
+
+
+trait A:
+  def doSth(n: Int) = doSthNested(n)
+  def doSthNested(n: Int) = doSthInlined(n)
+  extension[T] (t: T) def let[R](l: (T) => R): R = l(t)
+  inline def doSthInlined(n: Int): Int =
+    if math.random < n/10.0 then n.let { 
+      n => n.let { n => throw RuntimeException("error") }
+    }
+    n
+
+class B extends A
+
+extension (b: B)
+  def !(n: Int): Int = b.doSth(n)
+
+@OutputTimeUnit(TimeUnit.MILLISECONDS)
+@BenchmarkMode(Array(Mode.AverageTime))
+@State(Scope.Thread)
+class Benchmarks:
+
+  @Benchmark
+  @BenchmarkMode(Array(Mode.AverageTime))
+  @OutputTimeUnit(TimeUnit.MILLISECONDS)
+  def method: Unit =
+    try
+      val x = (0 to 10).flatMap { 
+        n => (0 to n).map {  
+          n => B() ! n.toInt
+        }
+      }
+    catch
+      case e: Exception =>
+        val prettyStackTrace = convertToPrettyStackTraceWithStdlib(e)
+        // PrettyExceptionPrinter.printStacktrace(prettyStackTrace)

src/examples/scala/com/virtuslab/stacktraces/parser/StacktraceParserTest.scala → src/jmh/scala/com/virtuslab/stacktraces/parser/StacktraceParserTest.scala

@@ -1,4 +1,5 @@
 package org.virtuslab.stacktraces
+package parser
 
 import org.virtuslab.stacktraces.parser.StacktraceParser
 import org.virtuslab.stacktraces.core.Stacktraces
@@ -36,7 +37,7 @@ object StacktraceParserTest:
     errorOrStacktrace match
       case Left(msg) => throw AssertionError(msg)
       case Right(stacktrace) =>
-        val prettyStackTrace = Stacktraces.convertToPrettyStackTrace(stacktrace)
+        val prettyStackTrace = convertToPrettyStackTraceWithStdlib(stacktrace)
         /*
          * This stacktrace is subject to Tasty files generated for BasicTest.scala, if you see some weird output, probably BasicTest.scala diverged.
          * Nonetheless, we can count test as passing correctly if it hits Right branch.

src/examples/scala/com/virtuslab/stacktraces/tests/BasicTest.scala → src/jmh/scala/com/virtuslab/stacktraces/tests/BasicTest.scala

@@ -1,8 +1,8 @@
 package org.virtuslab.stacktraces
+package tests
 
 import org.virtuslab.stacktraces.core.Stacktraces
 import org.virtuslab.stacktraces.printer.PrettyExceptionPrinter
-import org.virtuslab.stacktraces.util.TestExecutor
 
 
 trait A:

src/examples/scala/com/virtuslab/stacktraces/util/TestExecutor.scala → src/jmh/scala/com/virtuslab/stacktraces/util/TestExecutor.scala

@@ -1,4 +1,4 @@
-package org.virtuslab.stacktraces.util
+package org.virtuslab.stacktraces
 
 import org.virtuslab.stacktraces.core.Stacktraces
 import org.virtuslab.stacktraces.printer.PrettyExceptionPrinter
@@ -10,5 +10,8 @@ object TestExecutor:
       test()
     catch
       case e: Exception =>
-        val prettyStackTrace = Stacktraces.convertToPrettyStackTrace(e)
+        val prettyStackTrace = convertToPrettyStackTraceWithStdlib(e)
         PrettyExceptionPrinter.printStacktrace(prettyStackTrace)
+
+def convertToPrettyStackTraceWithStdlib(e: Exception) =
+  Stacktraces.convertToPrettyStackTrace(e, Seq("scala-library_3-3.1.0-RC1-bin-SNAPSHOT.jar"))

src/main/scala/com/virtuslab/stacktraces/core/Stacktraces.scala

@@ -3,7 +3,6 @@ package org.virtuslab.stacktraces.core
 import org.virtuslab.stacktraces.model.ClasspathWrapper
 import org.virtuslab.stacktraces.model.TastyWrapper
 import org.virtuslab.stacktraces.model.PrettyException
-import org.virtuslab.stacktraces.model.PrettyStackTraceElement
 import org.virtuslab.stacktraces.model.ElementType
 import org.virtuslab.stacktraces.io.TastyFilesLocator
 
@@ -19,8 +18,8 @@ import java.nio.file.Paths
 
 object Stacktraces:
 
-  def convertToPrettyStackTrace(e: Throwable): PrettyException =
-    val tastyFilesLocator = TastyFilesLocator(Thread.currentThread().getContextClassLoader)
+  def convertToPrettyStackTrace(e: Throwable, additionalClasspath: Seq[String] = Nil): PrettyException =
+    val tastyFilesLocator = TastyFilesLocator(Thread.currentThread().getContextClassLoader, additionalClasspath)
     val st = filterInternalStackFrames(e.getStackTrace)
     val ctp = tastyFilesLocator.classNameToPath(st.map(_.getClassName))
     val tastyFiles = tastyFilesLocator.tastyFilesFromStackTrace(ctp)
@@ -31,4 +30,4 @@ object Stacktraces:
     st.sliding(2).toList.flatMap {
       case Array(fs, sc) =>
         if sc.getMethodName.contains("$adapted") then Nil else List(fs)
-    }
+    } :+ st.last

src/main/scala/com/virtuslab/stacktraces/core/StacktracesInspector.scala

@@ -23,8 +23,9 @@ import org.virtuslab.stacktraces.model.TastyWrapper
 object StacktracesInspector:
   def inspectStackTrace(st: List[StackTraceElement], tastyFiles: List[TastyWrapper], ctp: Map[String, String]): List[PrettyStackTraceElement] =
     val stacktracesInspector = StacktracesInspector(st, ctp)
-    val (tastys, jars) = tastyFiles.map(_.file.toPath.toString).partition(_.endsWith(".tasty"))
-    TastyInspector.inspectAllTastyFiles(tastys, jars, Nil)(stacktracesInspector)
+    val tastys = tastyFiles.map(_.file.toPath.toString)
+    val dependencies = tastyFiles.flatMap(_.jar).map(_.toPath.toString)
+    TastyInspector.inspectAllTastyFiles(tastys, Nil, dependencies)(stacktracesInspector)
     stacktracesInspector.prettyStackTraceElements.toList
 
 

src/main/scala/com/virtuslab/stacktraces/io/TastyFilesLocator.scala

@@ -10,21 +10,36 @@ import java.nio.file.Files
 import java.nio.file.Paths
 import java.nio.file.StandardCopyOption
 import java.net.JarURLConnection
+import java.net.URLClassLoader
+import java.net.URL
 
-class TastyFilesLocator(classLoader: ClassLoader):
+class TastyFilesLocator(classLoader: ClassLoader, additionalClasspath: Seq[String]):
+
+  val newClassloader = URLClassLoader(additionalClasspath.map(File(_).toURI.toURL).toArray, classLoader)
 
   def tastyFilesFromStackTrace(classNameToPath: Map[String, String]): List[TastyWrapper] =
     classNameToPath.values.toList.distinct.flatMap { clPath =>
-    val url = classLoader.getResource(clPath + ".tasty")
+    val url = newClassloader.getResource(clPath + ".tasty")
       if url != null then
-        url.getProtocol match
+
+        // Get temporary copy of the tasty file from the URL
+        val tastyFile: File =
+          val inputStream = url.openStream
+          val tf: Path = Files.createTempFile("pretty-stacktraces", ".tasty")
+          tf.toFile.deleteOnExit()
+          Files.copy(inputStream, tf, StandardCopyOption.REPLACE_EXISTING)
+          tf.toFile
+
+        // Get path of the external jar (if any)
+        val extraJar = url.getProtocol match
           case "jar" =>
             val outerUrl = url.openConnection.asInstanceOf[JarURLConnection].getJarFileURL
-            Some(TastyWrapper(Paths.get(outerUrl.toURI).toFile, null))
+            Some(Paths.get(outerUrl.toURI).toFile)
           case "file" =>
-            Some(TastyWrapper(Paths.get(url.toURI).toFile, null))
+            None
           case _ =>
             None
+        Some(TastyWrapper(tastyFile, extraJar))
       else 
         None
     }

src/main/scala/com/virtuslab/stacktraces/model/model.scala

@@ -3,7 +3,7 @@ package org.virtuslab.stacktraces.model
 import java.io.File
 
 case class ClasspathWrapper(file: File, jarName: Option[String])
-case class TastyWrapper(file: File, jarName: Option[String])
+case class TastyWrapper(file: File, jar: Option[File])
 case class PrettyException(original: Throwable, prettyStackTrace: List[PrettyStackTraceElement])
 
 enum ElementType(val name: String):