improvement: sorting workspace members with same name by frequency

Author: kasiaMarek

presentation-compiler/src/main/dotty/tools/pc/ScalaPresentationCompiler.scala

@@ -48,7 +48,8 @@ case class ScalaPresentationCompiler(
     sh: Option[ScheduledExecutorService] = None,
     config: PresentationCompilerConfig = PresentationCompilerConfigImpl(),
     folderPath: Option[Path] = None,
-    reportsLevel: ReportLevel = ReportLevel.Info
+    reportsLevel: ReportLevel = ReportLevel.Info,
+    completionItemPriority: CompletionItemPriority = (_: String) => 0,
 ) extends PresentationCompiler:
 
   def this() = this("", None, Nil, Nil)
@@ -63,6 +64,11 @@ case class ScalaPresentationCompiler(
       .map(StdReportContext(_, _ => buildTargetName, reportsLevel))
       .getOrElse(EmptyReportContext)
 
+  override def withCompletionItemPriority(
+    priority: CompletionItemPriority
+  ): PresentationCompiler =
+    copy(completionItemPriority = priority)
+
   override def withBuildTargetName(buildTargetName: String) =
     copy(buildTargetName = Some(buildTargetName))
 
@@ -142,7 +148,8 @@ case class ScalaPresentationCompiler(
         params,
         config,
         buildTargetIdentifier,
-        folderPath
+        folderPath,
+        completionItemPriority
       ).completions()
 
     }

presentation-compiler/src/main/dotty/tools/pc/completions/CompletionProvider.scala

@@ -32,14 +32,16 @@ import org.eclipse.lsp4j.InsertTextFormat
 import org.eclipse.lsp4j.InsertTextMode
 import org.eclipse.lsp4j.Range as LspRange
 import org.eclipse.lsp4j.TextEdit
+import scala.meta.pc.CompletionItemPriority
 
 class CompletionProvider(
     search: SymbolSearch,
     driver: InteractiveDriver,
     params: OffsetParams,
     config: PresentationCompilerConfig,
     buildTargetIdentifier: String,
-    folderPath: Option[Path]
+    folderPath: Option[Path],
+    referenceCounter: CompletionItemPriority
 )(using reports: ReportContext):
   def completions(): CompletionList =
     val uri = params.uri().nn
@@ -86,7 +88,8 @@ class CompletionProvider(
             folderPath,
             autoImportsGen,
             unit.comments,
-            driver.settings
+            driver.settings,
+            referenceCounter
           ).completions()
 
         val items = completions.zipWithIndex.map { case (item, idx) =>

presentation-compiler/src/main/dotty/tools/pc/completions/Completions.scala

@@ -50,7 +50,8 @@ class Completions(
     workspace: Option[Path],
     autoImports: AutoImportsGenerator,
     comments: List[Comment],
-    options: List[String]
+    options: List[String],
+    completionItemPriority: CompletionItemPriority
 )(using ReportContext):
 
   given context: Context = ctx
@@ -909,6 +910,20 @@ class Completions(
         else 0
       end compareLocalSymbols
 
+      private def workspaceMemberPriority(symbol: Symbol): Int =
+        completionItemPriority
+          .workspaceMemberPriority(
+            SemanticdbSymbols.symbolName(symbol),
+          )
+
+      def compareFrequency(o1: CompletionValue, o2: CompletionValue): Int =
+        (o1, o2) match
+          case (w1: CompletionValue.Workspace, w2: CompletionValue.Workspace) =>
+            workspaceMemberPriority(w1.symbol)
+              .compareTo(workspaceMemberPriority(w2.symbol))
+          case _ => 0
+      end compareFrequency
+
       def compareByRelevance(o1: CompletionValue, o2: CompletionValue): Int =
         Integer.compare(
           computeRelevancePenalty(o1, application),
@@ -1018,17 +1033,20 @@ class Completions(
                       )
                       if byIdentifier != 0 then byIdentifier
                       else
-                        val byOwner =
-                          s1.owner.fullName.toString
-                            .compareTo(s2.owner.fullName.toString)
-                        if byOwner != 0 then byOwner
+                        val byFrequency = compareFrequency(o1, o2)
+                        if byFrequency != 0 then byFrequency
                         else
-                          val byParamCount = Integer.compare(
-                            s1.paramSymss.flatten.size,
-                            s2.paramSymss.flatten.size
-                          )
-                          if byParamCount != 0 then byParamCount
-                          else s1.detailString.compareTo(s2.detailString)
+                          val byOwner =
+                            s1.owner.fullName.toString
+                              .compareTo(s2.owner.fullName.toString)
+                          if byOwner != 0 then byOwner
+                          else
+                            val byParamCount = Integer.compare(
+                              s1.paramSymss.flatten.size,
+                              s2.paramSymss.flatten.size
+                            )
+                            if byParamCount != 0 then byParamCount
+                            else s1.detailString.compareTo(s2.detailString)
                     end if
                   end if
                 end if

presentation-compiler/test/dotty/tools/pc/base/BasePCSuite.scala

@@ -22,6 +22,7 @@ import dotty.tools.pc.utils._
 import org.eclipse.lsp4j.MarkupContent
 import org.eclipse.lsp4j.jsonrpc.messages.Either as JEither
 import org.junit.runner.RunWith
+import scala.meta.pc.CompletionItemPriority
 
 object TestResources:
   val scalaLibrary = BuildInfo.ideTestsDependencyClasspath.map(_.toPath).toSeq
@@ -30,6 +31,7 @@ object TestResources:
 
 @RunWith(classOf[ReusableClassRunner])
 abstract class BasePCSuite extends PcAssertions:
+  val completionItemPriority: CompletionItemPriority = (_: String) => 0
   private val isDebug = ManagementFactory.getRuntimeMXBean.getInputArguments.toString.contains("-agentlib:jdwp")
 
   val tmp = Files.createTempDirectory("stable-pc-tests")
@@ -53,6 +55,7 @@ abstract class BasePCSuite extends PcAssertions:
       .withExecutorService(executorService)
       .withScheduledExecutorService(executorService)
       .withSearch(search)
+      .withCompletionItemPriority(completionItemPriority)
       .newInstance("", myclasspath.asJava, scalacOpts.asJava)
 
   protected def config: PresentationCompilerConfig =

presentation-compiler/test/dotty/tools/pc/tests/completion/CompletionContextSuite.scala

@@ -0,0 +1,27 @@
+package dotty.tools.pc.tests.completion
+
+import dotty.tools.pc.base.BaseCompletionSuite
+import scala.meta.pc.CompletionItemPriority
+import org.junit.Test
+
+class CompletionContextSuite extends BaseCompletionSuite:
+  override val completionItemPriority: CompletionItemPriority = {
+      case "scala/concurrent/Future." => -1
+      case _ => 0
+  }
+  // scala.concurrent.Future should be ranked higher than java.util.concurrent.Future
+  val futureCompletionResult: List[String] =
+    List("Future - scala.concurrent", "Future - java.util.concurrent")
+
+  @Test
+  def `context` =
+    check(
+      """package fut
+        |object A {
+        |  Futur@@
+        |}""".stripMargin,
+      """Future - scala.concurrent
+        |Future - java.util.concurrent
+        |""".stripMargin,
+      filter = futureCompletionResult.contains
+    )