fix(pub): Improve support for custom package repositories

Signed-off-by: Timo Salmi <[email protected]>

Author: Syyllinen

plugins/package-managers/pub/src/main/kotlin/PubCacheReader.kt

@@ -84,13 +84,13 @@ internal class PubCacheReader(flutterHome: File? = null) {
         val path = if (type == "hosted" && url.isNotEmpty()) {
             // Packages with source set to "hosted" and "url" key in description set to "https://pub.dartlang.org".
             // The path should be resolved to "hosted/pub.dartlang.org/packageName-packageVersion".
-            "hosted/${url.replace("https://", "")}/$packageName-$packageVersion"
+            "hosted/${url.hostedUrlToDirectoryName()}/$packageName-$packageVersion"
         } else if (type == "git" && resolvedRef.isNotEmpty()) {
             // Packages with source set to "git" and a "resolved-ref" key in description set to a gitHash.
             // These packages do not define a packageName in the packageInfo, but by definition the path resolves to
             // the project name as given from the VcsHost and to the resolvedRef.
             val projectName = VcsHost.getProject(url) ?: return null
-            if (resolvedPath.isNotEmpty()) {
+            if (resolvedPath.isNotEmpty() && resolvedPath != ".") {
                 "git/$projectName-$resolvedRef/$resolvedPath"
             } else {
                 "git/$projectName-$resolvedRef"
@@ -106,3 +106,21 @@ internal class PubCacheReader(flutterHome: File? = null) {
             ?: flutterPubCacheRoot?.resolve(path)?.takeIf { it.isDirectory }
     }
 }
+
+// See https://github.com/dart-lang/pub/blob/ea4a1c854690d3abceb92c8cc2c6454470f9d5a7/lib/src/source/hosted.dart#L1899.
+private fun String.hostedUrlToDirectoryName(): String {
+    val url = replace(schemeLocalhostRegex) { match ->
+        // Do not include the scheme for HTTPS URLs. This makes the directory names nice for the default and most
+        // recommended scheme. Also do not include it for localhost URLs, since they are always known to be HTTP.
+        val localhost = if (match.groupValues.size == 3) "" else "localhost"
+        val scheme = if (match.groupValues[1] == "https://" || localhost.isNotEmpty()) "" else match.groupValues[1]
+        "$scheme$localhost"
+    }
+
+    return url.replace(specialCharRegex) { match ->
+        match.groupValues[0].map { char -> "%${char.code}" }.joinToString("")
+    }
+}
+
+private val schemeLocalhostRegex = """^(https?://)(127\.0\.0\.1|\[::1]|localhost)?""".toRegex()
+private val specialCharRegex = """[<>:"\\/|?*%]""".toRegex()

plugins/package-managers/pub/src/test/kotlin/PubCacheReaderTest.kt

@@ -40,6 +40,9 @@ class PubCacheReaderTest : WordSpec({
     val gitPackageCacheDir = tmpPubCacheDir.resolve("git/$PACKAGE_NAME-$RESOLVED_REF")
     val gitPackageWithPathCacheDir = tmpPubCacheDir.resolve("git/$PACKAGE_NAME-$RESOLVED_REF/$PACKAGE_NAME")
     val hostedPackageCacheDir = tmpPubCacheDir.resolve("hosted/oss-review-toolkit.org/$PACKAGE_NAME-$PACKAGE_VERSION")
+    val customPackageCacheDir = tmpPubCacheDir.resolve(
+        "hosted/oss-review-toolkit.org%47api%47pub%47repository%47/$PACKAGE_NAME-$PACKAGE_VERSION"
+    )
     val localPackagePathAbsolute = ABSOLUTE_PATH
     val localPackagePathRelative = ABSOLUTE_PATH.resolve(RELATIVE_PATH)
 
@@ -49,6 +52,7 @@ class PubCacheReaderTest : WordSpec({
         gitPackageCacheDir.safeMkdirs()
         gitPackageWithPathCacheDir.safeMkdirs()
         hostedPackageCacheDir.safeMkdirs()
+        customPackageCacheDir.safeMkdirs()
     }
 
     "findProjectRoot()" should {
@@ -81,6 +85,21 @@ class PubCacheReaderTest : WordSpec({
             reader.findProjectRoot(packageInfo, ABSOLUTE_PATH) shouldBe gitPackageWithPathCacheDir
         }
 
+        "resolve the path of a Git dependency with special path" {
+            val packageInfo = PackageInfo(
+                dependency = "direct main",
+                description = PackageInfo.Description(
+                    path = ".",
+                    resolvedRef = RESOLVED_REF,
+                    url = "https://github.com/oss-review-toolkit/$PACKAGE_NAME.git"
+                ),
+                source = "git",
+                version = "9.9.9"
+            )
+
+            reader.findProjectRoot(packageInfo, ABSOLUTE_PATH) shouldBe gitPackageCacheDir
+        }
+
         "resolve the path of a hosted dependency" {
             val packageInfo = PackageInfo(
                 dependency = "transitive",
@@ -95,6 +114,20 @@ class PubCacheReaderTest : WordSpec({
             reader.findProjectRoot(packageInfo, ABSOLUTE_PATH) shouldBe hostedPackageCacheDir
         }
 
+        "resolve the path of a custom package repository dependency" {
+            val packageInfo = PackageInfo(
+                dependency = "transitive",
+                description = PackageInfo.Description(
+                    name = PACKAGE_NAME,
+                    url = "https://oss-review-toolkit.org/api/pub/repository/"
+                ),
+                source = "hosted",
+                version = PACKAGE_VERSION
+            )
+
+            reader.findProjectRoot(packageInfo, ABSOLUTE_PATH) shouldBe customPackageCacheDir
+        }
+
         "resolve the relative path of a local dependency" {
             val packageInfo = PackageInfo(
                 dependency = "transitive",