feat: handle branch in key/translation operations

dkrizan · dkrizan · commit fb570b53580a · 2025-09-17T22:25:28.000+02:00
diff --git a/backend/api/src/main/kotlin/io/tolgee/api/v2/controllers/translation/TranslationsController.kt b/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,
diff --git a/backend/api/src/main/kotlin/io/tolgee/controllers/ExportController.kt b/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,
               '.',
             )
diff --git a/backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/translations/v2TranslationsController/TranslationsControllerViewTest.kt b/backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/translations/v2TranslationsController/TranslationsControllerViewTest.kt
@@ -105,6 +105,50 @@ 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.")
+      }
+    }
+  }
+
   @Test
   @ProjectJWTAuthTestMethod
   fun `returns correct comment counts`() {
diff --git a/backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/v2KeyController/KeyControllerTest.kt b/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 {
diff --git a/backend/app/src/test/kotlin/io/tolgee/service/TranslationServiceTest.kt b/backend/app/src/test/kotlin/io/tolgee/service/TranslationServiceTest.kt
@@ -18,8 +18,9 @@ class TranslationServiceTest : AbstractSpringTest() {
     val id = dbPopulator.populate().project.id
     val data =
       translationService.getTranslations(
-        languageTags = HashSet(Arrays.asList("en", "de")),
+        languageTags = HashSet(listOf("en", "de")),
         namespace = null,
+        branch = null,
         projectId = id,
         structureDelimiter = '.',
       )
@@ -35,8 +36,9 @@ class TranslationServiceTest : AbstractSpringTest() {
 
     val viewData =
       translationService.getTranslations(
-        languageTags = HashSet(Arrays.asList("en", "de")),
+        languageTags = HashSet(listOf("en", "de")),
         namespace = null,
+        branch = null,
         projectId = project.id,
         structureDelimiter = '.',
       )
@@ -78,4 +80,53 @@ class TranslationServiceTest : AbstractSpringTest() {
     assertThat(translation.auto).isFalse
     assertThat(translation.mtProvider).isNull()
   }
+
+  @Test
+  fun `returns translations for default branch`() {
+    val testData = TranslationsTestData()
+    testData.generateBranchedData(10)
+    testDataService.saveTestData(testData.root)
+    val translations = translationService.getTranslations(
+      languageTags = HashSet(listOf("en", "de")),
+      namespace = null,
+      branch = null,
+      projectId = testData.project.id,
+      structureDelimiter = '.',
+    )
+    assertThat(translations).hasSize(2)
+    assertThat(translations["en"] as LinkedHashMap<*, *>).hasSize(1)
+  }
+
+  @Test
+  @Transactional
+  fun `returns translations for feature branch`() {
+    val testData = TranslationsTestData()
+    testData.generateBranchedData(10)
+    testDataService.saveTestData(testData.root)
+    val translations = translationService.getTranslations(
+      languageTags = HashSet(listOf("en", "de")),
+      namespace = null,
+      branch = "feature-branch",
+      projectId = testData.project.id,
+      structureDelimiter = '.',
+    )
+    assertThat(translations).hasSize(2)
+    assertThat(translations["en"] as LinkedHashMap<*, *>).hasSize(10)
+  }
+
+  @Test
+  @Transactional
+  fun `returns empty translations for invalid branch name`() {
+    val testData = TranslationsTestData()
+    testData.generateBranchedData(5)
+    testDataService.saveTestData(testData.root)
+    val translations = translationService.getTranslations(
+      languageTags = HashSet(listOf("en", "de")),
+      namespace = null,
+      branch = "invalid-branch",
+      projectId = testData.project.id,
+      structureDelimiter = '.',
+    )
+    assertThat(translations).hasSize(0)
+  }
 }
diff --git a/backend/data/src/main/kotlin/io/tolgee/constants/Message.kt b/backend/data/src/main/kotlin/io/tolgee/constants/Message.kt
@@ -312,6 +312,7 @@ enum class Message {
   BRANCH_NOT_FOUND,
   CANNOT_DELETE_DEFAULT_BRANCH,
   BRANCH_ALREADY_EXISTS,
+  ORIGIN_BRANCH_NOT_FOUND,
   ;
 
   val code: String
diff --git a/backend/data/src/main/kotlin/io/tolgee/development/testDataBuilder/data/KeysTestData.kt b/backend/data/src/main/kotlin/io/tolgee/development/testDataBuilder/data/KeysTestData.kt
@@ -127,6 +127,22 @@ class KeysTestData {
     }
   }
 
+  fun addNBranchedKeys(n: Int, branchName: String = "feature") {
+    projectBuilder.apply {
+      addBranch {
+        name = branchName
+        project = projectBuilder.self
+      }.build {
+        (1..n).forEach {
+          addKey {
+            name = "branch_key_$it"
+            this.branch = self
+          }
+        }
+      }
+    }
+  }
+
   fun addThirdKey(): Key {
     return projectBuilder.addKey("third_key").self
   }
diff --git a/backend/data/src/main/kotlin/io/tolgee/development/testDataBuilder/data/TranslationsTestData.kt b/backend/data/src/main/kotlin/io/tolgee/development/testDataBuilder/data/TranslationsTestData.kt
@@ -248,6 +248,32 @@ class TranslationsTestData {
     }
   }
 
+  fun generateBranchedData(count: Long, branchName: String = "feature-branch", isBranchDefault: Boolean = false) {
+    root.data.projects[0].apply {
+      addBranch {
+        name = branchName
+        project = this@apply.self
+        isDefault = isBranchDefault
+      }.build {
+        (1..count).forEach {
+          addKey {
+            name = "key from branch $branchName $it"
+            branch = this@build.self
+          }.build {
+            addTranslation {
+              language = germanLanguage
+              text = "I am key $it's german translation from branch $branchName."
+            }
+            addTranslation {
+              language = englishLanguage
+              text = "I am key $it's english translation from branch $branchName."
+            }
+          }
+        }
+      }
+    }
+  }
+
   fun addFewKeysWithTags() {
     root.data.projects[0].apply {
       addKey {
diff --git a/backend/data/src/main/kotlin/io/tolgee/dtos/request/translation/TranslationFilters.kt b/backend/data/src/main/kotlin/io/tolgee/dtos/request/translation/TranslationFilters.kt
@@ -157,4 +157,9 @@ To filter default namespace, set to empty string.
     description = "Filter keys with no suggestions in lang",
   )
   var filterHasNoSuggestionsInLang: List<String>? = null
+
+  @field:Parameter(
+    description = "Selects only keys from specified branch",
+  )
+  var branch: String? = null
 }
diff --git a/backend/data/src/main/kotlin/io/tolgee/repository/KeyRepository.kt b/backend/data/src/main/kotlin/io/tolgee/repository/KeyRepository.kt
@@ -139,7 +139,8 @@ interface KeyRepository : JpaRepository<Key, Long> {
     """,
     countQuery = """
       select count(k) from Key k 
-      where k.project.id = :projectId
+      left join k.branch b
+      where k.project.id = :projectId and (k.branch.id is null or b.isDefault)
     """,
   )
   fun getAllByProjectId(
diff --git a/backend/data/src/main/kotlin/io/tolgee/repository/TranslationRepository.kt b/backend/data/src/main/kotlin/io/tolgee/repository/TranslationRepository.kt
@@ -22,11 +22,13 @@ interface TranslationRepository : JpaRepository<Translation, Long> {
     """select t.text as text, l.tag as languageTag, k.name as key
         from Translation t
         join t.key k
+        left join k.branch b
         left join k.namespace n
         left join k.keyMeta km
         left join km.tags kmt
         join t.language l
         where t.key.project.id = :projectId
+         and (b.name = :branch or (:branch is null and (b is null or b.isDefault))) 
          and l.tag in :languages
          and ((n.name is null and :namespace is null) or n.name = :namespace)
          and (:filterTags is null or kmt.name in :filterTags)
@@ -37,6 +39,7 @@ interface TranslationRepository : JpaRepository<Translation, Long> {
   fun getTranslations(
     languages: Set<String>,
     namespace: String?,
+    branch: String?,
     projectId: Long,
     filterTags: List<String>?,
   ): List<SimpleTranslationView>
diff --git a/backend/data/src/main/kotlin/io/tolgee/service/branching/BranchService.kt b/backend/data/src/main/kotlin/io/tolgee/service/branching/BranchService.kt
@@ -6,4 +6,6 @@ import org.springframework.data.domain.Pageable
 
 interface BranchService {
   fun getAllBranches(projectId: Long, page: Pageable, search: String? = null): Page<Branch>
+  fun createBranch(projectId: Long, name: String, originBranchId: Long): Branch
+  fun deleteBranch(projectId: Long, branchId: Long)
 }
diff --git a/backend/data/src/main/kotlin/io/tolgee/service/branching/BranchServiceOssStub.kt b/backend/data/src/main/kotlin/io/tolgee/service/branching/BranchServiceOssStub.kt
@@ -8,4 +8,11 @@ class BranchServiceOssStub : BranchService {
   override fun getAllBranches(projectId: Long, page: Pageable, search: String?): Page<Branch> {
     return Page.empty()
   }
+  override fun createBranch(projectId: Long, name: String, originBranchId: Long): Branch {
+    throw UnsupportedOperationException()
+  }
+
+  override fun deleteBranch(projectId: Long, branchId: Long) {
+    throw UnsupportedOperationException()
+  }
 }
diff --git a/backend/data/src/main/kotlin/io/tolgee/service/queryBuilders/translationViewBuilder/QueryGlobalFiltering.kt b/backend/data/src/main/kotlin/io/tolgee/service/queryBuilders/translationViewBuilder/QueryGlobalFiltering.kt
@@ -6,6 +6,7 @@ import io.tolgee.model.activity.ActivityDescribingEntity_
 import io.tolgee.model.activity.ActivityModifiedEntity
 import io.tolgee.model.activity.ActivityModifiedEntity_
 import io.tolgee.model.activity.ActivityRevision_
+import io.tolgee.model.branching.Branch_
 import io.tolgee.model.key.Key
 import io.tolgee.model.key.KeyMeta_
 import io.tolgee.model.key.Key_
@@ -43,6 +44,7 @@ class QueryGlobalFiltering(
     filterRevisionId()
     filterFailedTargets()
     filterTask()
+    filterBranch()
   }
 
   private fun filterFailedTargets() {
@@ -261,4 +263,18 @@ class QueryGlobalFiltering(
       )
     }
   }
+
+  private fun filterBranch() {
+    val branchJoin = queryBase.root.join(Key_.branch, JoinType.LEFT)
+    if (params.branch.isNullOrEmpty()) {
+      queryBase.whereConditions.add(
+        cb.or(
+          branchJoin.get(Branch_.id).isNull,
+          cb.isTrue(branchJoin.get(Branch_.isDefault))
+        )
+      )
+    } else {
+      queryBase.whereConditions.add(cb.equal(branchJoin.get(Branch_.name), cb.literal(params.branch)))
+    }
+  }
 }
diff --git a/backend/data/src/main/kotlin/io/tolgee/service/translation/TranslationService.kt b/backend/data/src/main/kotlin/io/tolgee/service/translation/TranslationService.kt
@@ -72,12 +72,14 @@ class TranslationService(
   fun getTranslations(
     languageTags: Set<String>,
     namespace: String?,
+    branch: String?,
     projectId: Long,
     structureDelimiter: Char?,
     filterTag: List<String>? = null,
   ): Map<String, Any> {
     val safeNamespace = if (namespace == "") null else namespace
-    val allByLanguages = translationRepository.getTranslations(languageTags, safeNamespace, projectId, filterTag)
+    val allByLanguages =
+      translationRepository.getTranslations(languageTags, safeNamespace, branch, projectId, filterTag)
     val langTranslations: HashMap<String, Any> = LinkedHashMap()
     for (translation in allByLanguages) {
       val map =
@@ -128,7 +130,7 @@ class TranslationService(
     keyId: Long,
     languageId: Long,
     projectId: Long? = null,
-    ): Translation {
+  ): Translation {
     val key = keyService.findOptional(keyId).orElseThrow { NotFoundException() }
     if (projectId != null && key.project.id != projectId) {
       throw BadRequestException(Message.KEY_NOT_FROM_PROJECT)
diff --git a/ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/controllers/branching/BranchController.kt b/ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/controllers/branching/BranchController.kt
@@ -5,13 +5,13 @@ import io.swagger.v3.oas.annotations.tags.Tag
 import io.tolgee.ee.api.v2.hateoas.assemblers.BranchModelAssembler
 import io.tolgee.ee.api.v2.hateoas.model.branching.BranchModel
 import io.tolgee.ee.api.v2.hateoas.model.branching.CreateBranchModel
-import io.tolgee.ee.service.branching.BranchServiceImpl
 import io.tolgee.model.branching.Branch
 import io.tolgee.model.enums.Scope
 import io.tolgee.openApiDocs.OpenApiOrderExtension
 import io.tolgee.security.ProjectHolder
 import io.tolgee.security.authentication.AllowApiAccess
 import io.tolgee.security.authorization.RequiresProjectPermissions
+import io.tolgee.service.branching.BranchService
 import org.springdoc.core.annotations.ParameterObject
 import org.springframework.data.domain.Pageable
 import org.springframework.data.web.PagedResourcesAssembler
@@ -37,7 +37,7 @@ import org.springframework.web.bind.annotation.RestController
 @OpenApiOrderExtension(8)
 @Tag(name = "Branches", description = "Branching operations")
 class BranchController(
-  private val branchService: BranchServiceImpl,
+  private val branchService: BranchService,
   private val projectHolder: ProjectHolder,
   private val branchModelAssembler: BranchModelAssembler,
   private val pagedResourceAssembler: PagedResourcesAssembler<Branch>,
@@ -63,7 +63,11 @@ class BranchController(
   @RequiresProjectPermissions([Scope.KEYS_EDIT])
   @OpenApiOrderExtension(2)
   fun create(@RequestBody branch: CreateBranchModel): BranchModel {
-    val branch = branchService.createBranch(projectHolder.project.id, branch)
+    val branch = branchService.createBranch(
+      projectHolder.project.id,
+      branch.name,
+      branch.originBranchId
+    )
     return branchModelAssembler.toModel(branch)
   }
 
diff --git a/ee/backend/app/src/main/kotlin/io/tolgee/ee/service/branching/BranchServiceImpl.kt b/ee/backend/app/src/main/kotlin/io/tolgee/ee/service/branching/BranchServiceImpl.kt

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,7 @@ class ExportController(`
`64`	`64`	`translationService.getTranslations(`
`65`	`65`	`allLanguages.map { it.tag }.toSet(),`
`66`	`66`	`null,`
	`67`	`+ null,`
`67`	`68`	`projectHolder.project.id,`
`68`	`69`	`'.',`
`69`	`70`	`)`
Original file line number	Diff line number	Diff line change
`@@ -312,6 +312,7 @@ enum class Message {`
`312`	`312`	`BRANCH_NOT_FOUND,`
`313`	`313`	`CANNOT_DELETE_DEFAULT_BRANCH,`
`314`	`314`	`BRANCH_ALREADY_EXISTS,`
	`315`	`+ ORIGIN_BRANCH_NOT_FOUND,`
`315`	`316`	`;`
`316`	`317`
`317`	`318`	`val code: String`
Original file line number	Diff line number	Diff line change
`@@ -157,4 +157,9 @@ To filter default namespace, set to empty string.`
`157`	`157`	`description = "Filter keys with no suggestions in lang",`
`158`	`158`	`)`
`159`	`159`	`var filterHasNoSuggestionsInLang: List<String>? = null`
	`160`	`+`
	`161`	`+ @field:Parameter(`
	`162`	`+ description = "Selects only keys from specified branch",`
	`163`	`+ )`
	`164`	`+ var branch: String? = null`
`160`	`165`	`}`