Merge pull request #234 from modelix/fix/escape-slashes-in-url-for-branches-and-repositories

Fix/escape slashes in url for branches and repositories

Author: Oleksandr Dzhychko

model-client/src/commonMain/kotlin/org/modelix/model/client2/ModelClientV2.kt

@@ -24,6 +24,7 @@ import io.ktor.client.request.post
 import io.ktor.client.request.setBody
 import io.ktor.client.statement.bodyAsText
 import io.ktor.http.ContentType
+import io.ktor.http.URLBuilder
 import io.ktor.http.appendPathSegments
 import io.ktor.http.contentType
 import io.ktor.http.takeFrom
@@ -90,7 +91,7 @@ class ModelClientV2(
         val response = httpClient.post {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", repository.id, "init")
+                appendPathSegmentsEncodingSlash("repositories", repository.id, "init")
             }
         }
         val delta = response.body<VersionDelta>()
@@ -110,7 +111,7 @@ class ModelClientV2(
         return httpClient.get {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", repository.id, "branches")
+                appendPathSegmentsEncodingSlash("repositories", repository.id, "branches")
             }
         }.bodyAsText().lines().map { repository.getBranchReference(it) }
     }
@@ -138,7 +139,7 @@ class ModelClientV2(
         val response = httpClient.post {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", branch.repositoryId.id, "branches", branch.branchName)
+                appendPathSegmentsEncodingSlash("repositories", branch.repositoryId.id, "branches", branch.branchName)
             }
             contentType(ContentType.Application.Json)
             val body = VersionDelta(version.getContentHash(), null, objectsMap = objects)
@@ -154,7 +155,7 @@ class ModelClientV2(
         val response = httpClient.get {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", branch.repositoryId.id, "branches", branch.branchName)
+                appendPathSegmentsEncodingSlash("repositories", branch.repositoryId.id, "branches", branch.branchName)
                 if (lastKnownVersion != null) {
                     parameters["lastKnown"] = lastKnownVersion.hash
                 }
@@ -170,7 +171,7 @@ class ModelClientV2(
         val response = httpClient.get {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", branch.repositoryId.id, "branches", branch.branchName, "poll")
+                appendPathSegmentsEncodingSlash("repositories", branch.repositoryId.id, "branches", branch.branchName, "poll")
                 if (lastKnownVersion != null) {
                     parameters["lastKnown"] = lastKnownVersion.hash
                 }
@@ -280,5 +281,8 @@ expect class ModelClientV2PlatformSpecificBuilder() : ModelClientV2Builder
 fun VersionDelta.checkObjectHashes() {
     HashUtil.checkObjectHashes(objectsMap)
 }
+private fun URLBuilder.appendPathSegmentsEncodingSlash(vararg components: String): URLBuilder {
+    return appendPathSegments(components.toList(), true)
+}
 
 fun VersionDelta.getAllObjects(): Map<String, String> = objectsMap + objects.associateBy { HashUtil.sha256(it) }

model-server/src/main/kotlin/org/modelix/model/server/handlers/RepositoryOverview.kt

@@ -1,11 +1,13 @@
 package org.modelix.model.server.handlers
 
+import io.ktor.http.encodeURLPathPart
 import io.ktor.server.application.Application
 import io.ktor.server.application.call
 import io.ktor.server.html.respondHtmlTemplate
 import io.ktor.server.routing.get
 import io.ktor.server.routing.routing
 import kotlinx.html.FlowContent
+import kotlinx.html.FlowOrInteractiveOrPhrasingContent
 import kotlinx.html.a
 import kotlinx.html.h1
 import kotlinx.html.i
@@ -74,9 +76,7 @@ class RepositoryOverview(private val repoManager: RepositoriesManager) {
                                         }
                                     }
                                     td {
-                                        a("../history/${branch.repositoryId.id}/${branch.branchName}/") {
-                                            +"Show History"
-                                        }
+                                        buildHistoryLink(branch.repositoryId.id, branch.branchName)
                                     }
                                     td {
                                         val latestVersion = repoManager.getVersion(branch)
@@ -94,3 +94,9 @@ class RepositoryOverview(private val repoManager: RepositoriesManager) {
         }
     }
 }
+
+fun FlowOrInteractiveOrPhrasingContent.buildHistoryLink(repositoryId: String, branchName: String) {
+    a("../history/${repositoryId.encodeURLPathPart()}/${branchName.encodeURLPathPart()}/") {
+        +"Show History"
+    }
+}

model-server/src/test/kotlin/org/modelix/model/server/ModelClientV2Test.kt

@@ -86,4 +86,19 @@ class ModelClientV2Test {
             setOf(repositoryId.getBranchReference(), branchId),
         )
     }
+
+    @Test
+    fun testSlashesInPathSegmentsFromRepositoryIdAndBranchId() = runTest {
+        val url = "http://localhost/v2"
+        val client = ModelClientV2.builder().url(url).client(client).build()
+        client.init()
+        val repositoryId = RepositoryId("repo/v1")
+        val initialVersion = client.initRepository(repositoryId)
+        val branchId = repositoryId.getBranchReference("my-branch/v1")
+        client.push(branchId, initialVersion, null)
+        assertEquals(
+            client.listBranches(repositoryId).toSet(),
+            setOf(repositoryId.getBranchReference(), branchId),
+        )
+    }
 }

model-server/src/test/kotlin/org/modelix/model/server/handlers/RepositoryOverviewTest.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2023.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.modelix.model.server.handlers
+
+import kotlinx.html.span
+import kotlinx.html.stream.createHTML
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class RepositoryOverviewTest {
+
+    @Test
+    fun testSlashesInPathSegmentsFromRepositoryIdAndBranchId() {
+        val html = createHTML().span {
+            buildHistoryLink("repository/v1", "branch/v2")
+        }
+        assertEquals("<span><a href=\"../history/repository%2Fv1/branch%2Fv2/\">Show History</a></span>", html)
+    }
+}