Make sure that evalaution runs with a proper classloader

Previously, we would run evalaution with the default mdoc classloader, which might have not contained things like default akka config. Now, we run it in a Thread with the specific classloader set. Fixes scalameta/metals#2525
scalameta · Mar 26, 2021 · 2429a02 · 2429a02
1 parent 5df6290
commit 2429a02
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 24 deletions.
diff --git a/mdoc/src/main/scala/mdoc/internal/markdown/MarkdownBuilder.scala b/mdoc/src/main/scala/mdoc/internal/markdown/MarkdownBuilder.scala
@@ -12,6 +12,7 @@ import mdoc.internal.document.MdocNonFatal
 import mdoc.internal.CompatClassloader
 import java.nio.file.Path
 import java.nio.file.Paths
+import java.util.concurrent.atomic.AtomicReference
 
 object MarkdownBuilder {
 
@@ -40,31 +41,35 @@ object MarkdownBuilder {
         val ctor = cls.getDeclaredConstructor()
         ctor.setAccessible(true)
         val doc = ctor.newInstance().asInstanceOf[DocumentBuilder].$doc
-        try {
-          doc.build(instrumentedInput)
-        } catch {
-          case e: DocumentException =>
-            val index = e.sections.length - 1
-            val input = sectionInputs(index).input
-            val pos =
-              if (e.pos.isEmpty) {
-                Position.Range(input, 0, 0)
-              } else {
-                val slice = Position.Range(
-                  input,
-                  e.pos.startLine,
-                  e.pos.startColumn,
-                  e.pos.endLine,
-                  e.pos.endColumn
-                )
-                slice.toUnslicedPosition
-              }
-            reporter.error(pos, e.getCause)
-            Document(instrumentedInput, e.sections)
-          case MdocNonFatal(e) =>
-            reporter.error(e)
-            Document.empty(instrumentedInput)
+        var evaluatedDoc = Document.empty(instrumentedInput)
+        runInClassLoader(cls.getClassLoader()) { () =>
+          try {
+            evaluatedDoc = doc.build(instrumentedInput)
+          } catch {
+            case e: DocumentException =>
+              val index = e.sections.length - 1
+              val input = sectionInputs(index).input
+              val pos =
+                if (e.pos.isEmpty) {
+                  Position.Range(input, 0, 0)
+                } else {
+                  val slice = Position.Range(
+                    input,
+                    e.pos.startLine,
+                    e.pos.startColumn,
+                    e.pos.endLine,
+                    e.pos.endColumn
+                  )
+                  slice.toUnslicedPosition
+                }
+              reporter.error(pos, e.getCause)
+              evaluatedDoc = Document(instrumentedInput, e.sections)
+            case MdocNonFatal(e) =>
+              reporter.error(e)
+              evaluatedDoc = Document.empty(instrumentedInput)
+          }
         }
+        evaluatedDoc
       case None =>
         // An empty document will render as the original markdown
         Document.empty(instrumentedInput)
@@ -92,6 +97,17 @@ object MarkdownBuilder {
     new MarkdownCompiler(fullClasspath.syntax, scalacOptions)
   }
 
+  private def runInClassLoader(classloader: ClassLoader)(f: () => Unit) = {
+    val thread = new Thread {
+      override def run: Unit = {
+        f()
+      }
+    }
+    thread.setContextClassLoader(classloader)
+    thread.start()
+    thread.join()
+  }
+
   private def defaultClasspath(fn: Path => Boolean): Classpath = {
     val paths =
       CompatClassloader

diff --git a/tests/worksheets/src/test/scala/tests/worksheets/WorksheetSuite.scala b/tests/worksheets/src/test/scala/tests/worksheets/WorksheetSuite.scala
@@ -372,6 +372,22 @@ class WorksheetSuite extends BaseSuite {
        |""".stripMargin
   )
 
+  checkDecorations(
+    "akka".tag(SkipScala3).tag(SkipScala211),
+    """|import $dep.`com.typesafe.akka::akka-actor:2.6.13`
+       |import akka.actor.ActorSystem
+       |
+       |implicit val system = ActorSystem("worksheet")
+       |
+       |""".stripMargin,
+    """|import $dep.`com.typesafe.akka::akka-actor:2.6.13`
+       |import akka.actor.ActorSystem
+       |
+       |<implicit val system = ActorSystem("worksheet")> // : ActorSystem = akka...
+       |system: ActorSystem = akka://worksheet
+       |""".stripMargin
+  )
+
   checkDecorations(
     "placeholder",
     """|def x = 1 -> 2