Introduce searchable docs, decreasing index by 40x

Author: felixmulder

doc-tool/resources/_layouts/search.html

@@ -33,7 +33,7 @@ <h1>Member Results</h1>
     // Parse parameters from URL:
     var parameters = [];
     var apiSearch = undefined;
-    var docs = {{ docs | json }};
+    var docs = {{ searchableDocs | json }};
     (function() {
         var pairs = location.search.substring(1).split('&');
         for (var i = 0; i < pairs.length; i++) {

doc-tool/resources/js/api-search.js

@@ -47,7 +47,15 @@ onmessage = function(e) {
     var searchRegex = regexForTerm(searchTerm);
 
     var filterPackages = function(entity) {
-        return entity.kind != "package";
+        switch(entity.kind) {
+            case "val":
+            case "def":
+            case "type":
+            case "package":
+                return false;
+            default:
+                return true;
+        }
     };
 
     // look at this higher order function, such syntax:
@@ -78,7 +86,7 @@ onmessage = function(e) {
     };
 
     docs.forEach(function(pack) {
-        pack.children
+        pack.members
             .filter(filterPackages)
             .forEach(messageParentIfMatches(pack));
     });

doc-tool/src/dotty/tools/dottydoc/model/JavaConverters.scala

@@ -241,13 +241,41 @@ object JavaConverters {
   }
 
   implicit class JavaMap(val map: collection.Map[String, Package]) extends AnyVal {
-    def toJavaList: LinkedList[AnyRef] = {
-      map.toList
-         .sortBy(_._1)
-         .foldLeft(new LinkedList[AnyRef]()) { case (list, (_, pkg)) =>
-           list.add(pkg.asJava())
-           list
-         }
+    def toJavaList: LinkedList[AnyRef] =
+      convertToList(map.mapValues(_.asJava))
+
+    def flattened: LinkedList[AnyRef] =
+      convertToList(map.mapValues(flattenEntity))
+
+    private[this] def convertToList(ms: collection.Map[String, AnyRef]): LinkedList[AnyRef] =
+      ms.toList.sortBy(_._1)
+        .foldLeft(new LinkedList[AnyRef]()) { case (list, (_, value)) =>
+          list.add(value); list
+        }
+
+    private[this] def flattenEntity(e: Entity): JMap[String, _] = {
+      def entity(e: Entity) =
+        Map("name" -> e.name, "path" -> e.path.asJava, "kind" -> e.kind)
+
+      def members(e: Entity with Members) =
+        Map("members" -> e.members.map(flattenEntity).asJava)
+
+      def companion(e: Companion) = Map(
+        "hasCompanion" -> e.hasCompanion,
+        "companionPath" -> e.companionPath.asJava
+      )
+
+      (e match {
+        case e: Package   => entity(e) ++ members(e)
+        case e: Class     => entity(e) ++ members(e) ++ companion(e)
+        case e: CaseClass => entity(e) ++ members(e) ++ companion(e)
+        case e: Trait     => entity(e) ++ members(e) ++ companion(e)
+        case e: Object    => entity(e) ++ members(e) ++ companion(e)
+        case e: TypeAlias => entity(e)
+        case e: Def       => entity(e)
+        case e: Val       => entity(e)
+      })
+      .asJava
     }
   }
 }

doc-tool/src/dotty/tools/dottydoc/staticsite/DefaultParams.scala

@@ -11,6 +11,7 @@ import scala.collection.JavaConverters._
 
 case class DefaultParams(
   docs: JList[_],
+  docsFlattened: JList[_],
   originalDocs: Map[String, Package],
   page: PageInfo,
   site: SiteInfo,
@@ -23,6 +24,8 @@ case class DefaultParams(
     val base = Map(
       "docs" -> docs,
 
+      "searchableDocs" -> docsFlattened,
+
       "originalDocs" -> originalDocs,
 
       "page" -> Map(

doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala

@@ -41,6 +41,11 @@ case class Site(
     documentation.toJavaList
   }
 
+  private val docsFlattened: JList[_] = {
+    import model.JavaConverters._
+    documentation.flattened
+  }
+
   /** All files that are considered static in this context, this can be
     * anything from CSS, JS to images and other files.
     *
@@ -166,7 +171,7 @@ case class Site(
     }
 
     DefaultParams(
-      docs, documentation, PageInfo(pathFromRoot),
+      docs, docsFlattened, documentation, PageInfo(pathFromRoot),
       SiteInfo(baseUrl, projectTitle, projectVersion, projectUrl, Array()),
       sidebar
     )