feat: branching

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/api/v2/controllers/translation/CreateOrUpdateTranslationsFacade.kt

@@ -32,7 +32,7 @@ class CreateOrUpdateTranslationsFacade(
     @RequestBody @Valid
     dto: SetTranslationsWithKeyDto,
   ): SetTranslationsResponseModel {
-    val key = keyService.find(projectHolder.projectEntity.id, dto.key, dto.namespace) ?: return create(dto)
+    val key = keyService.find(projectHolder.projectEntity.id, dto.key, dto.namespace, dto.branch) ?: return create(dto)
     return setTranslations(dto, key)
   }
 
@@ -74,7 +74,7 @@ class CreateOrUpdateTranslationsFacade(
     dto: SetTranslationsWithKeyDto,
     key: Key? = null,
   ): SetTranslationsResponseModel {
-    val keyNotNull = key ?: keyService.get(projectHolder.project.id, dto.key, dto.namespace)
+    val keyNotNull = key ?: keyService.get(projectHolder.project.id, dto.key, dto.namespace, dto.branch)
     securityService.checkLanguageTranslatePermissionsByTag(
       dto.translations.keys,
       projectHolder.project.id,

backend/api/src/main/kotlin/io/tolgee/api/v2/controllers/translation/TranslationsController.kt

@@ -160,6 +160,8 @@ When null, resulting file will be a flat key-value object.
     )
     @RequestParam(value = "filterTag", required = false)
     filterTag: List<String>? = null,
+    @Parameter(description = "Branch name to return translations from")
+    branch: String? = null,
     request: WebRequest,
   ): ResponseEntity<Map<String, Any>>? {
     val lastModified: Long = projectTranslationLastModifiedManager.getLastModified(projectHolder.project.id)
@@ -176,6 +178,7 @@ When null, resulting file will be a flat key-value object.
       translationService.getTranslations(
         languageTags = permittedTags,
         namespace = ns,
+        branch = branch,
         projectId = projectHolder.project.id,
         structureDelimiter = request.getStructureDelimiter(),
         filterTag = filterTag,

backend/api/src/main/kotlin/io/tolgee/component/KeyComplexEditHelper.kt

@@ -148,7 +148,7 @@ class KeyComplexEditHelper(
     }
 
     if (isKeyNameModified || isNamespaceChanged) {
-      edited = keyService.edit(key, dto.name, dto.namespace)
+      edited = keyService.edit(key, dto.name, dto.namespace, dto.branch)
     }
 
     return keyWithDataModelAssembler.toModel(edited)

backend/api/src/main/kotlin/io/tolgee/controllers/ExportController.kt

@@ -64,6 +64,7 @@ class ExportController(
             translationService.getTranslations(
               allLanguages.map { it.tag }.toSet(),
               null,
+              null,
               projectHolder.project.id,
               '.',
             )

backend/api/src/main/kotlin/io/tolgee/hateoas/contentDelivery/ContentDeliveryConfigModel.kt

@@ -37,4 +37,5 @@ class ContentDeliveryConfigModel(
   override var messageFormat: ExportMessageFormat? = null
   override var supportArrays: Boolean = false
   override var fileStructureTemplate: String? = null
+  override var filterBranch: String? = null
 }

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/api/src/main/kotlin/io/tolgee/hateoas/key/KeyWithDataModel.kt

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

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

@@ -32,5 +32,6 @@ class KeyWithDataModelAssembler(
       isPlural = entity.isPlural,
       pluralArgName = entity.pluralArgName,
       custom = entity.keyMeta?.custom ?: mapOf(),
+      branch = entity.branch?.name,
     )
 }

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

@@ -34,6 +34,7 @@ class KeyWithScreenshotsModelAssembler(
       isPlural = entity.isPlural,
       pluralArgName = entity.pluralArgName,
       custom = entity.keyMeta?.custom ?: mapOf(),
+      branch = entity.branch?.name,
     )
   }
 }

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/translations/v2TranslationsController/TranslationsControllerModificationTest.kt

@@ -7,6 +7,7 @@ import io.tolgee.dtos.request.translation.SetTranslationsWithKeyDto
 import io.tolgee.fixtures.andAssertThatJson
 import io.tolgee.fixtures.andIsBadRequest
 import io.tolgee.fixtures.andIsForbidden
+import io.tolgee.fixtures.andIsNotFound
 import io.tolgee.fixtures.andIsOk
 import io.tolgee.fixtures.andPrettyPrint
 import io.tolgee.fixtures.isValidId
@@ -390,6 +391,56 @@ class TranslationsControllerModificationTest : ProjectAuthControllerTest("/v2/pr
     testOutdated(translation, true)
   }
 
+  @ProjectJWTAuthTestMethod
+  @Test
+  fun `sets translations for existing key in branch`() {
+    saveTestData()
+    performProjectAuthPut(
+      "/translations",
+      SetTranslationsWithKeyDto(
+        "branch key",
+        null,
+        mutableMapOf("en" to "English branch key"),
+        branch = "test-branch",
+      ),
+    ).andIsOk
+      .andAssertThatJson {
+        node("translations.en.text").isEqualTo("English branch key")
+        node("translations.en.id").isValidId
+        node("keyId").isValidId
+        node("keyName").isEqualTo("branch key")
+      }
+  }
+
+  @ProjectJWTAuthTestMethod
+  @Test
+  fun `cannot set translations for key in branch without branch provided`() {
+    saveTestData()
+    performProjectAuthPut(
+      "/translations",
+      SetTranslationsWithKeyDto(
+        "branch key",
+        null,
+        mutableMapOf("en" to "Cannot do that"),
+      ),
+    ).andIsNotFound
+  }
+
+  @ProjectJWTAuthTestMethod
+  @Test
+  fun `cannot set translations for key in default branch with different branch provided`() {
+    saveTestData()
+    performProjectAuthPut(
+      "/translations",
+      SetTranslationsWithKeyDto(
+        "A key",
+        null,
+        mutableMapOf("en" to "Cannot do that"),
+        branch = "test-branch",
+      ),
+    ).andIsNotFound
+  }
+
   private fun testOutdated(
     translation: Translation,
     state: Boolean,

backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/translations/v2TranslationsController/TranslationsControllerViewTest.kt

@@ -42,10 +42,11 @@ class TranslationsControllerViewTest : ProjectAuthControllerTest("/v2/projects/"
   @Test
   fun `returns correct data`() {
     testData.generateLotOfData()
+    testData.addDeletedBranch()
     testDataService.saveTestData(testData.root)
     userAccount = testData.user
     performProjectAuthGet("/translations?sort=id").andPrettyPrint.andIsOk.andAssertThatJson {
-      node("page.totalElements").isNumber.isGreaterThan(BigDecimal(100))
+      node("page.totalElements").isNumber.isEqualTo(BigDecimal(101))
       node("page.size").isEqualTo(20)
       node("selectedLanguages") {
         isArray.hasSize(2)
@@ -105,6 +106,67 @@ class TranslationsControllerViewTest : ProjectAuthControllerTest("/v2/projects/"
     }
   }
 
+  @Test
+  @ProjectJWTAuthTestMethod
+  fun `return translations from non-branched keys`() {
+    testData.generateBranchedData(10)
+    testDataService.saveTestData(testData.root)
+    userAccount = testData.user
+    performProjectAuthGet("/translations?sort=id").andPrettyPrint.andIsOk.andAssertThatJson {
+      // 2 keys from the default branch, 10 keys from the feature branch should be filtered out
+      node("_embedded.keys").isArray.hasSize(2)
+    }
+  }
+
+  @Test
+  @ProjectJWTAuthTestMethod
+  fun `return translations from default branch only`() {
+    testData.generateBranchedData(5, "main", true)
+    testData.generateBranchedData(10)
+    testDataService.saveTestData(testData.root)
+    userAccount = testData.user
+    performProjectAuthGet("/translations?sort=id").andPrettyPrint.andIsOk.andAssertThatJson {
+      // 2 non-branched keys + 5 keys from the default branch, 10 keys from the feature branch should be filtered out
+      node("_embedded.keys").isArray.hasSize(7)
+    }
+  }
+
+  @Test
+  @ProjectJWTAuthTestMethod
+  fun `return translations from featured branch only`() {
+    testData.generateBranchedData(10)
+    testDataService.saveTestData(testData.root)
+    userAccount = testData.user
+    performProjectAuthGet("/translations?sort=id&branch=feature-branch").andPrettyPrint.andIsOk.andAssertThatJson {
+      // 10 keys from the feature branch should be returned
+      node("_embedded.keys").isArray.hasSize(10)
+      node("_embedded.keys[0].keyName").isEqualTo("key from branch feature-branch 1")
+      node("_embedded.keys[0].translations.en") {
+        node("text").isEqualTo("I am key 1's english translation from branch feature-branch.")
+      }
+      node("_embedded.keys[1].translations.de") {
+        node("text").isEqualTo("I am key 2's german translation from branch feature-branch.")
+      }
+    }
+  }
+
+  /**
+   * Edge-case testing returning correct translations if there is soft-deleted branch with same name as active branch
+   * (deleted is in the process of hard-deleting)
+   */
+  @Test
+  @ProjectJWTAuthTestMethod
+  fun `return translations from active branch only`() {
+    testData.generateBranchedData(10)
+    testData.addDeletedBranch()
+    testDataService.saveTestData(testData.root)
+    userAccount = testData.user
+    performProjectAuthGet("/translations?sort=id&branch=feature-branch").andPrettyPrint.andIsOk.andAssertThatJson {
+      // 10 keys from feature-branch (translation from soft-deleted feature-branch is ignored)
+      node("_embedded.keys").isArray.hasSize(10)
+    }
+  }
+
   @Test
   @ProjectJWTAuthTestMethod
   fun `returns correct comment counts`() {

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

@@ -111,6 +111,7 @@ class SingleStepImportControllerTest : ProjectAuthControllerTest("/v2/projects/"
       listOf(Pair(jsonFileName, simpleJson)),
       params = mapOf("createNewKeys" to false),
     )
+
     executeInNewTransaction {
       keyService.find(testData.project.id, "test", null).assert.isNull()
     }

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

@@ -62,6 +62,7 @@ class KeyControllerCreationTest : ProjectAuthControllerTest("/v2/projects/") {
       .andIsCreated.andPrettyPrint.andAssertThatJson {
         node("id").isValidId
         node("name").isEqualTo("super_key")
+        node("branch").isEqualTo("main")
       }
   }
 
@@ -82,6 +83,17 @@ class KeyControllerCreationTest : ProjectAuthControllerTest("/v2/projects/") {
     }
   }
 
+  @ProjectJWTAuthTestMethod
+  @Test
+  fun `creates key with default branch (branch parameter not provided)`() {
+    performProjectAuthPost("keys", CreateKeyDto(name = "super_key_to_main_branch", branch = "dev"))
+      .andIsCreated.andAssertThatJson {
+        node("id").isValidId
+        node("name").isEqualTo("super_key_to_main_branch")
+        node("branch").isEqualTo("dev")
+      }
+  }
+
   @ProjectJWTAuthTestMethod
   @Test
   fun `validates description`() {

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

@@ -144,4 +144,13 @@ class KeyControllerKeySearchTest : ProjectAuthControllerTest("/v2/projects/"), L
       time.assert.isLessThan(4000)
     }
   }
+
+  @Test
+  @ProjectJWTAuthTestMethod
+  fun `it search in default branch only`() {
+    saveAndPrepare()
+    performProjectAuthGet("keys/search?search=this-is-branched-key&languageTag=de").andAssertThatJson {
+      node("_embedded").isAbsent()
+    }
+  }
 }

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

@@ -23,6 +23,7 @@ import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
 import org.springframework.boot.test.context.SpringBootTest
+import java.math.BigDecimal
 
 @SpringBootTest
 @AutoConfigureMockMvc
@@ -43,6 +44,7 @@ class KeyControllerTest : ProjectAuthControllerTest("/v2/projects/") {
   @Test
   fun `returns all keys`() {
     testData.addNKeys(120)
+    testData.addNBranchedKeys(10)
     saveTestDataAndPrepare()
     performProjectAuthGet("keys")
       .andIsOk.andAssertThatJson {
@@ -53,6 +55,7 @@ class KeyControllerTest : ProjectAuthControllerTest("/v2/projects/") {
           node("[2].namespace").isEqualTo("null")
           node("[1].description").isEqualTo("description")
         }
+        node("page.totalElements").isNumber.isEqualTo(BigDecimal(123))
       }
     performProjectAuthGet("keys?page=1")
       .andIsOk.andAssertThatJson {
@@ -65,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`() {