feat: KeyController branching modifications

Author: dkrizan

backend/api/src/main/kotlin/io/tolgee/api/v2/controllers/keys/KeyController.kt

@@ -129,8 +129,10 @@ class KeyController(
     @ParameterObject
     @SortDefault("id")
     pageable: Pageable,
+    @RequestParam
+    branch: String? = null,
   ): PagedModel<KeyModel> {
-    val data = keyService.getPaged(projectHolder.project.id, pageable)
+    val data = keyService.getPaged(projectHolder.project.id, branch, pageable)
     return keyPagedResourcesAssembler.toModel(data, keyModelAssembler)
   }
 
@@ -150,7 +152,8 @@ class KeyController(
     key.checkInProject()
     checkNamespaceFeature(dto.namespace)
     keyService.edit(id, dto)
-    val view = KeyView(key.id, key.name, key?.namespace?.name, key.keyMeta?.description, key.keyMeta?.custom)
+    val view =
+      KeyView(key.id, key.name, key?.namespace?.name, key.keyMeta?.description, key.keyMeta?.custom, key.branch?.name)
     return keyModelAssembler.toModel(view)
   }
 

backend/api/src/main/kotlin/io/tolgee/hateoas/key/KeyModel.kt

@@ -21,4 +21,6 @@ open class KeyModel(
   val description: String?,
   @Schema(description = "Custom values of the key")
   val custom: Map<String, Any?>?,
+  @Schema(description = "Branch of key", example = "dev")
+  val branch: String?,
 ) : RepresentationModel<KeyModel>(), Serializable

backend/api/src/main/kotlin/io/tolgee/hateoas/key/KeyModelAssembler.kt

@@ -18,5 +18,6 @@ class KeyModelAssembler : RepresentationModelAssemblerSupport<KeyView, KeyModel>
       namespace = view.namespace,
       description = view.description,
       custom = view.custom as? Map<String, Any?>?,
+      branch = view.branch,
     )
 }

backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/AllKeysControllerTest.kt

@@ -31,12 +31,18 @@ class AllKeysControllerTest : ProjectAuthControllerTest("/v2/projects/") {
   fun `returns all keys sorted`() {
     performProjectAuthGet("all-keys").andPrettyPrint.andIsOk.andAssertThatJson {
       node("_embedded.keys") {
-        isArray.hasSize(3)
+        isArray.hasSize(4)
         node("[0]") {
           node("id").isValidId
           node("namespace").isNull()
           node("name").isEqualTo("first_key")
         }
+        node("[3]") {
+          node("id").isValidId
+          node("namespace").isNull()
+          node("name").isEqualTo("first_key")
+          node("branch").isEqualTo("dev")
+        }
       }
     }
   }

backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/v2KeyController/KeyControllerTest.kt

@@ -68,6 +68,34 @@ class KeyControllerTest : ProjectAuthControllerTest("/v2/projects/") {
       }
   }
 
+  @ProjectJWTAuthTestMethod
+  @Test
+  fun `returns all keys from branch`() {
+    testData.addNKeys(5)
+    testData.addNBranchedKeys(110)
+    saveTestDataAndPrepare()
+    performProjectAuthGet("keys?branch=feature")
+      .andIsOk.andAssertThatJson {
+        node("_embedded.keys") {
+          isArray.hasSize(20)
+          node("[0].id").isValidId
+          node("[1].name").isEqualTo("branch_key_2")
+          node("[1].description").isEqualTo("description of branched key")
+          node("[2].namespace").isEqualTo("null")
+        }
+        node("page.totalElements").isNumber.isEqualTo(BigDecimal(110))
+      }
+    performProjectAuthGet("keys?page=1&branch=feature")
+      .andIsOk.andAssertThatJson {
+        node("_embedded.keys") {
+          isArray.hasSize(20)
+          node("[0].id").isValidId
+          node("[1].name").isEqualTo("branch_key_22 ")
+          node("[2].namespace").isEqualTo("null")
+        }
+      }
+  }
+
   @ProjectJWTAuthTestMethod
   @Test
   fun `returns single key`() {

backend/data/src/main/kotlin/io/tolgee/development/testDataBuilder/TestDataService.kt

@@ -593,7 +593,7 @@ class TestDataService(
   }
 
   private fun saveBranches(builder: ProjectBuilder) {
-    builder.data.branches.forEach {
+    builder.data.branches.filter { it.self.id == 0L }.forEach {
       entityManager.persist(it.self)
     }
   }

backend/data/src/main/kotlin/io/tolgee/development/testDataBuilder/data/KeysTestData.kt

@@ -104,6 +104,15 @@ class KeysTestData {
               custom = mutableMapOf("custom" to "value")
             }
           }
+
+          addBranch {
+            name = "dev"
+          }.build {
+            addKey {
+              name = "first_key"
+              branch = self
+            }
+          }
         }
 
       addUserAccountWithoutOrganization {
@@ -137,6 +146,8 @@ class KeysTestData {
           addKey {
             name = "branch_key_$it"
             this.branch = self
+          }.build {
+            setDescription("description of branched key")
           }
         }
       }

backend/data/src/main/kotlin/io/tolgee/dtos/RelatedKeyDto.kt

@@ -6,4 +6,5 @@ data class RelatedKeyDto(
   var namespace: String? = null,
   @field:NotEmpty
   var keyName: String = "",
+  var branch: String? = null,
 )

backend/data/src/main/kotlin/io/tolgee/dtos/queryResults/KeyIdFindResult.kt

@@ -4,4 +4,5 @@ data class KeyIdFindResult(
   val id: Long,
   val namespace: String?,
   val name: String,
+  val branch: String?,
 )

backend/data/src/main/kotlin/io/tolgee/dtos/queryResults/KeyView.kt

@@ -6,4 +6,5 @@ data class KeyView(
   val namespace: String?,
   val description: String?,
   val custom: Any?,
+  val branch: String?,
 )