Fix escaping special chars in searchbar links in Scaladoc

Unit tests for links with "#" character were also added.

Author: jchyb

scaladoc/src/dotty/tools/scaladoc/renderers/Locations.scala

@@ -81,7 +81,9 @@ trait Locations(using ctx: DocContext):
 
   def resolveRoot(dri: DRI, path: String): String = resolveRoot(rawLocation(dri), path)
   def absolutePath(dri: DRI, extension: String = "html"): String = rawLocation(dri).mkString("", "/", s".$extension")
-  def absolutePathWithAnchor(dri: DRI, extension: String = "html"): String = s"${absolutePath(dri, extension)}#${dri.anchor}"
+
+  def escapedAbsolutePathWithAnchor(dri: DRI, extension: String = "html"): String =
+    s"${escapeUrl(absolutePath(dri, extension))}#${dri.anchor}"
 
   def resolveLink(dri: DRI, url: String): String =
     if URI(url).isAbsolute then url else resolveRoot(dri, url)

scaladoc/src/dotty/tools/scaladoc/renderers/Resources.scala

@@ -133,7 +133,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
       }.mkString
 
     def mkEntry(dri: DRI, name: String, text: String, descr: String, kind: String) = jsonObject(
-        "l" -> jsonString(absolutePathWithAnchor(dri)),
+        "l" -> jsonString(escapedAbsolutePathWithAnchor(dri)),
         "n" -> jsonString(name),
         "t" -> jsonString(text),
         "d" -> jsonString(descr),

scaladoc/src/dotty/tools/scaladoc/tasty/InkuireSupport.scala

@@ -114,7 +114,7 @@ trait InkuireSupport(using DocContext) extends Resources:
             ),
             name = name,
             packageName = ownerName,
-            uri = methodSymbol.dri.externalLink.getOrElse(absolutePathWithAnchor(methodSymbol.dri)),
+            uri = methodSymbol.dri.externalLink.getOrElse(escapedAbsolutePathWithAnchor(methodSymbol.dri)),
             entryType = "def"
           )
           val curriedSgn = sgn.copy(signature = Inkuire.curry(sgn.signature))
@@ -142,7 +142,7 @@ trait InkuireSupport(using DocContext) extends Resources:
             ),
             name = name,
             packageName = ownerName,
-            uri = valSymbol.dri.externalLink.getOrElse(absolutePathWithAnchor(valSymbol.dri)),
+            uri = valSymbol.dri.externalLink.getOrElse(escapedAbsolutePathWithAnchor(valSymbol.dri)),
             entryType = "val"
           )
           val curriedSgn = sgn.copy(signature = Inkuire.curry(sgn.signature))

scaladoc/test/dotty/tools/scaladoc/renderers/LocationTests.scala

@@ -37,3 +37,18 @@ class LocationTests:
       "../../annotation",
       path("api/scala/annotation/meta/beanGetter", "api/scala/annotation"),
     )
+
+  @Test
+  def testAnchorLinks() =
+    def pathWithAnchor(location: String, anchor: String) =
+      locations.escapedAbsolutePathWithAnchor(new DRI(location, anchor))
+
+    assertEquals(
+      "scala/%23::.html#abcde",
+      pathWithAnchor("scala.#::", "abcde")
+    )
+
+    assertEquals(
+      "scala/collection/immutable/LazyList$$%23$.html#abcde",
+      pathWithAnchor("scala.collection.immutable.LazyList$$#$", "abcde")
+    )