reports for chosen errors

The errors are chosen based on what reoccurs in `metals.log`.
scalameta · Feb 17, 2023 · 84d0290 · 84d0290
1 parent e2997ce
commit 84d0290
Show file tree

Hide file tree

Showing 18 changed files with 133 additions and 83 deletions.
diff --git a/metals/src/main/scala/scala/meta/internal/implementation/Supermethods.scala b/metals/src/main/scala/scala/meta/internal/implementation/Supermethods.scala
@@ -7,6 +7,7 @@ import scala.meta.internal.implementation.Supermethods.formatMethodSymbolForQuic
 import scala.meta.internal.metals.ClientCommands
 import scala.meta.internal.metals.DefinitionProvider
 import scala.meta.internal.metals.MetalsEnrichments._
+import scala.meta.internal.metals.Reports
 import scala.meta.internal.metals.clients.language.MetalsLanguageClient
 import scala.meta.internal.metals.clients.language.MetalsQuickPickItem
 import scala.meta.internal.metals.clients.language.MetalsQuickPickParams
@@ -23,7 +24,8 @@ class Supermethods(
     definitionProvider: DefinitionProvider,
     implementationProvider: ImplementationProvider,
 )(implicit
-    ec: ExecutionContext
+    ec: ExecutionContext,
+    reports: Reports,
 ) {
 
   def getGoToSuperMethodCommand(

diff --git a/metals/src/main/scala/scala/meta/internal/metals/Directories.scala b/metals/src/main/scala/scala/meta/internal/metals/Directories.scala
@@ -8,8 +8,6 @@ object Directories {
     RelativePath(".metals").resolve("readonly")
   def tmp: RelativePath =
     RelativePath(".metals").resolve(".tmp")
-  def reports: RelativePath =
-    RelativePath(".metals").resolve(".reports")
   def dependencies: RelativePath =
     readonly.resolve(dependenciesName)
   def log: RelativePath =

diff --git a/metals/src/main/scala/scala/meta/internal/metals/MetalsEnrichments.scala b/metals/src/main/scala/scala/meta/internal/metals/MetalsEnrichments.scala
@@ -488,9 +488,6 @@ object MetalsEnrichments
       else Files.move(path.toNIO, newPath.toNIO)
     }
 
-    def createDirectories(): AbsolutePath =
-      AbsolutePath(Files.createDirectories(path.dealias.toNIO))
-
     def createAndGetDirectories(): Seq[AbsolutePath] = {
       def createDirectoriesRec(
           absolutePath: AbsolutePath,
@@ -513,31 +510,6 @@ object MetalsEnrichments
       path.listRecursive.toList.reverse.foreach(_.delete())
     }
 
-    def writeText(text: String): Unit = {
-      path.parent.createDirectories()
-      val tmp = Files.createTempFile("metals", path.filename)
-      // Write contents first to a temporary file and then try to
-      // atomically move the file to the destination. The atomic move
-      // reduces the risk that another tool will concurrently read the
-      // file contents during a half-complete file write.
-      Files.write(
-        tmp,
-        text.getBytes(StandardCharsets.UTF_8),
-        StandardOpenOption.TRUNCATE_EXISTING,
-      )
-      try {
-        Files.move(
-          tmp,
-          path.toNIO,
-          StandardCopyOption.REPLACE_EXISTING,
-          StandardCopyOption.ATOMIC_MOVE,
-        )
-      } catch {
-        case NonFatal(_) =>
-          Files.move(tmp, path.toNIO, StandardCopyOption.REPLACE_EXISTING)
-      }
-    }
-
     def appendText(text: String): Unit = {
       path.parent.createDirectories()
       Files.write(
@@ -601,7 +573,19 @@ object MetalsEnrichments
         case _ => None
       }
 
-    def toAbsolutePathSafe: Option[AbsolutePath] = Try(toAbsolutePath).toOption
+    def toAbsolutePathSafe(implicit reports: Reports): Option[AbsolutePath] =
+      try {
+        Some(toAbsolutePath)
+      } catch {
+        case NonFatal(e) =>
+          reports.incognito.createReport(
+            "absolute-path",
+            s"""|Uri: $value
+                |""".stripMargin,
+            e,
+          )
+          None
+      }
 
     def toAbsolutePath: AbsolutePath = toAbsolutePath(followSymlink = true)
 
@@ -1086,11 +1070,4 @@ object MetalsEnrichments
     }
   }
 
-  implicit class XtensionAny[T](v: T) {
-    def withExec[R](toExec: T => R): T = {
-      toExec(v)
-      v
-    }
-  }
-
 }
diff --git a/metals/src/main/scala/scala/meta/internal/metals/MetalsLspService.scala b/metals/src/main/scala/scala/meta/internal/metals/MetalsLspService.scala
@@ -43,6 +43,7 @@ import scala.meta.internal.metals.BuildInfo
 import scala.meta.internal.metals.Messages.AmmoniteJvmParametersChange
 import scala.meta.internal.metals.Messages.IncompatibleBloopVersion
 import scala.meta.internal.metals.MetalsEnrichments._
+import scala.meta.internal.metals.Reports
 import scala.meta.internal.metals.ammonite.Ammonite
 import scala.meta.internal.metals.callHierarchy.CallHierarchyProvider
 import scala.meta.internal.metals.clients.language.ConfiguredLanguageClient
@@ -189,7 +190,7 @@ class MetalsLspService(
 
   val tables: Tables = register(new Tables(workspace, time))
 
-  private val reports = new Reports(workspace)
+  implicit val reports: Reports = new Reports(workspace)
 
   private val buildTools: BuildTools = new BuildTools(
     workspace,
@@ -290,7 +291,7 @@ class MetalsLspService(
   )
 
   private val timerProvider: TimerProvider = new TimerProvider(time)
-  private val trees = new Trees(buffers, scalaVersionSelector, reports)
+  private val trees = new Trees(buffers, scalaVersionSelector)
 
   private val documentSymbolProvider = new DocumentSymbolProvider(
     trees,
@@ -1170,9 +1171,10 @@ class MetalsLspService(
         None
     }
 
-    uriOpt match {
-      case Some(uri) => {
-        val path = uri.toAbsolutePath
+    val pathOpt = uriOpt.flatMap(_.toAbsolutePathSafe)
+
+    pathOpt match {
+      case Some(path) => {
         focusedDocument = Some(path)
         buildTargets
           .inverseSources(path)
@@ -2736,6 +2738,11 @@ class MetalsLspService(
         case e: IndexingExceptions.PathIndexingException =>
           scribe.error(s"issues while parsing: ${e.path}", e.underlying)
         case e: IndexingExceptions.InvalidSymbolException =>
+          reports.incognito.createReport(
+            "invalid-symbol",
+            s"""Symbol: ${e.symbol}""".stripMargin,
+            e,
+          )
           scribe.error(s"searching for `${e.symbol}` failed", e.underlying)
         case _: NoSuchFileException =>
         // only comes for badly configured jar with `/Users` path added.

diff --git a/metals/src/main/scala/scala/meta/internal/parsing/JavaFoldingRangeExtractor.scala b/metals/src/main/scala/scala/meta/internal/parsing/JavaFoldingRangeExtractor.scala
@@ -46,14 +46,16 @@ final class JavaFoldingRangeExtractor(
   def extract(): List[FoldingRange] = {
     val scanner = ToolFactory.createScanner(true, true, false, true)
     scanner.setSource(text.toCharArray())
-
     @tailrec
     def swallowUntilSemicolon(token: Int, line: Int): Int = {
-      val addLine = scanner.getCurrentTokenSource.count(_ == '\n')
-      if (token != ITerminalSymbols.TokenNameSEMICOLON) {
-        swallowUntilSemicolon(scanner.getNextToken(), line + addLine)
-      } else {
-        line + addLine
+      if (token == ITerminalSymbols.TokenNameEOF) line
+      else {
+        val addLine = scanner.getCurrentTokenSource.count(_ == '\n')
+        if (token != ITerminalSymbols.TokenNameSEMICOLON) {
+          swallowUntilSemicolon(scanner.getNextToken(), line + addLine)
+        } else {
+          line + addLine
+        }
       }
     }
 

diff --git a/metals/src/main/scala/scala/meta/internal/parsing/Trees.scala b/metals/src/main/scala/scala/meta/internal/parsing/Trees.scala
@@ -28,8 +28,7 @@ import org.eclipse.{lsp4j => l}
 final class Trees(
     buffers: Buffers,
     scalaVersionSelector: ScalaVersionSelector,
-    reports: Reports,
-) {
+)(implicit reports: Reports) {
 
   private val trees = TrieMap.empty[AbsolutePath, Tree]
 

diff --git a/mtags/src/main/scala-2/scala/meta/internal/pc/PcCollector.scala b/mtags/src/main/scala-2/scala/meta/internal/pc/PcCollector.scala
@@ -228,7 +228,7 @@ abstract class PcCollector[T](
         def isForComprehensionOwner(named: NameTree) =
           soughtNames(named.name) &&
             named.symbol.owner.isAnonymousFunction && owners.exists(
-              _.pos.point == named.symbol.owner.pos.point
+              pos.isDefined && _.pos.point == named.symbol.owner.pos.point
             )
 
         def soughtOrOverride(sym: Symbol) =

diff --git a/mtags/src/main/scala-3/scala/meta/internal/pc/AutoImportsProvider.scala b/mtags/src/main/scala-3/scala/meta/internal/pc/AutoImportsProvider.scala
@@ -6,6 +6,7 @@ import java.{util as ju}
 import scala.collection.mutable
 import scala.jdk.CollectionConverters.*
 
+import scala.meta.internal.metals.Reports
 import scala.meta.internal.mtags.MtagsEnrichments.*
 import scala.meta.internal.pc.AutoImports.*
 import scala.meta.internal.pc.completions.CompletionPos
@@ -31,7 +32,7 @@ final class AutoImportsProvider(
     params: OffsetParams,
     config: PresentationCompilerConfig,
     buildTargetIdentifier: String,
-):
+)(using Option[Reports]):
 
   def autoImports(isExtension: Boolean): List[AutoImportsResult] =
     val uri = params.uri

diff --git a/mtags/src/main/scala-3/scala/meta/internal/pc/CompilerSearchVisitor.scala b/mtags/src/main/scala-3/scala/meta/internal/pc/CompilerSearchVisitor.scala
@@ -5,6 +5,7 @@ import java.util.logging.Logger
 
 import scala.util.control.NonFatal
 
+import scala.meta.internal.metals.Reports
 import scala.meta.pc.*
 
 import dotty.tools.dotc.core.Contexts.*
@@ -16,7 +17,7 @@ import dotty.tools.dotc.core.Symbols.*
 class CompilerSearchVisitor(
     query: String,
     visitSymbol: Symbol => Boolean,
-)(using ctx: Context)
+)(using ctx: Context, reports: Option[Reports])
     extends SymbolSearchVisitor:
 
   val logger: Logger = Logger.getLogger(classOf[CompilerSearchVisitor].getName)
@@ -25,6 +26,13 @@ class CompilerSearchVisitor(
     sym != NoSymbol && sym.isPublic
   catch
     case NonFatal(e) =>
+      reports.foreach(
+        _.incognito.createReport(
+          "is_public",
+          s"""Symbol: $sym""".stripMargin,
+          e,
+        )
+      )
       logger.log(Level.SEVERE, e.getMessage(), e)
       false
 

diff --git a/mtags/src/main/scala-3/scala/meta/internal/pc/ScalaPresentationCompiler.scala b/mtags/src/main/scala-3/scala/meta/internal/pc/ScalaPresentationCompiler.scala
@@ -15,6 +15,7 @@ import scala.concurrent.ExecutionContext
 import scala.concurrent.ExecutionContextExecutor
 
 import scala.meta.internal.metals.EmptyCancelToken
+import scala.meta.internal.metals.Reports
 import scala.meta.internal.mtags.BuildInfo
 import scala.meta.internal.mtags.MtagsEnrichments.*
 import scala.meta.internal.pc.AutoImports.*
@@ -57,6 +58,7 @@ case class ScalaPresentationCompiler(
 
   private val forbiddenOptions = Set("-print-lines", "-print-tasty")
   private val forbiddenDoubleOptions = Set("-release")
+  given Option[Reports] = workspace.map(Reports(_))
 
   val compilerAccess: CompilerAccess[StoreReporter, MetalsDriver] =
     Scala3CompilerAccess(

diff --git a/mtags/src/main/scala-3/scala/meta/internal/pc/completions/CompletionProvider.scala b/mtags/src/main/scala-3/scala/meta/internal/pc/completions/CompletionProvider.scala
@@ -6,6 +6,7 @@ import java.nio.file.Path
 import scala.annotation.tailrec
 import scala.collection.JavaConverters.*
 
+import scala.meta.internal.metals.Reports
 import scala.meta.internal.mtags.MtagsEnrichments.*
 import scala.meta.internal.pc.AutoImports.AutoImportEdits
 import scala.meta.internal.pc.AutoImports.AutoImportsGenerator
@@ -38,7 +39,7 @@ class CompletionProvider(
     config: PresentationCompilerConfig,
     buildTargetIdentifier: String,
     workspace: Option[Path],
-):
+)(using reports: Option[Reports]):
   def completions(): CompletionList =
     val uri = params.uri
 

diff --git a/mtags/src/main/scala-3/scala/meta/internal/pc/completions/Completions.scala b/mtags/src/main/scala-3/scala/meta/internal/pc/completions/Completions.scala
@@ -7,6 +7,7 @@ import java.nio.file.Paths
 import scala.collection.mutable
 
 import scala.meta.internal.metals.Fuzzy
+import scala.meta.internal.metals.Reports
 import scala.meta.internal.mtags.BuildInfo
 import scala.meta.internal.mtags.MtagsEnrichments.*
 import scala.meta.internal.pc.AutoImports.AutoImportsGenerator
@@ -51,7 +52,7 @@ class Completions(
     workspace: Option[Path],
     autoImports: AutoImportsGenerator,
     options: List[String],
-):
+)(using Option[Reports]):
 
   implicit val context: Context = ctx
 

diff --git a/mtags/src/main/scala-3/scala/meta/internal/pc/completions/InterpolatorCompletions.scala b/mtags/src/main/scala-3/scala/meta/internal/pc/completions/InterpolatorCompletions.scala
@@ -3,6 +3,7 @@ package scala.meta.internal.pc.completions
 import scala.collection.mutable.ListBuffer
 
 import scala.meta.internal.metals.Fuzzy
+import scala.meta.internal.metals.Reports
 import scala.meta.internal.mtags.MtagsEnrichments.*
 import scala.meta.internal.mtags.MtagsEnrichments.given
 import scala.meta.internal.pc.AutoImports.AutoImport
@@ -41,7 +42,7 @@ object InterpolatorCompletions:
       search: SymbolSearch,
       config: PresentationCompilerConfig,
       buildTargetIdentifier: String,
-  )(using Context) =
+  )(using Context, Option[Reports]) =
     InterpolationSplice(pos.span.point, text.toCharArray(), text) match
       case Some(interpolator) =>
         InterpolatorCompletions.contributeScope(
@@ -122,7 +123,7 @@ object InterpolatorCompletions:
       areSnippetsSupported: Boolean,
       search: SymbolSearch,
       buildTargetIdentifier: String,
-  )(using Context): List[CompletionValue] =
+  )(using Context, Option[Reports]): List[CompletionValue] =
     def newText(
         name: String,
         suffix: Option[String],
@@ -241,7 +242,7 @@ object InterpolatorCompletions:
       search: SymbolSearch,
       config: PresentationCompilerConfig,
       buildTargetIdentifier: String,
-  )(using ctx: Context): List[CompletionValue] =
+  )(using ctx: Context, reports: Option[Reports]): List[CompletionValue] =
     val litStartPos = lit.span.start
     val litEndPos = lit.span.end - Cursor.value.length()
     val span = position.span