feat: add branch filter to controllers related to keys/translations & handle branch in services

Author: dkrizan

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/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/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/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/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/service/LanguageServiceTest.kt

@@ -175,6 +175,6 @@ class LanguageServiceTest : AbstractSpringTest() {
       )
         .setParameter("type", ActivityType.HARD_DELETE_LANGUAGE)
         .resultList
-    result.assert.hasSize(3)
+    result.assert.hasSize(6)
   }
 }

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

@@ -284,6 +284,7 @@ class TestDataService(
     savePermissions(builder)
     saveMtServiceConfigs(builder)
     saveAllNamespaces(builder)
+    saveBranches(builder)
     saveKeyData(builder)
     saveTranslationData(builder)
     saveImportData(builder)
@@ -304,7 +305,6 @@ class TestDataService(
     saveAiPlaygroundResults(builder)
     saveLabels(builder)
     saveSuggestions(builder)
-    saveBranches(builder)
   }
 
   private fun saveImportSettings(builder: ProjectBuilder) {

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

@@ -59,27 +59,34 @@ class TranslationsTestData {
             originalName = "Deutsch"
           }.self
 
-        addKey {
-          name = "A key"
-          aKey = this
+        aKey = addBasicKey()
+        aKeyGermanTranslation = aKey.translations.first()
+        addBranch {
+          name = "test-branch"
+          project = this@project.self
         }.build {
-          setDescription("A key description")
-          addTranslation {
-            language = germanLanguage
-            text = "Z translation"
-            state = TranslationState.REVIEWED
-            auto = true
-            outdated = true
-            mtProvider = MtServiceType.GOOGLE
-            aKeyGermanTranslation = this
+          addKey {
+            name = "branch key"
+            branch = this@build.self
           }.build {
-            addComment {
-              author = user
-              text = "Comment"
-              state = TranslationCommentState.RESOLVED
+            addTranslation {
+              language = germanLanguage
+              text = "Branched german key."
+            }
+            addTranslation {
+              language = englishLanguage
+              text = "Branched english key."
             }
           }
-          addTag("Cool tag")
+        }
+        // create same key as in different branch
+        addBranch {
+          name = "from-default"
+          project = this@project.self
+        }.build {
+          addBasicKey().apply {
+            branch = self
+          }
         }
 
         val zKeyBuilder =
@@ -101,6 +108,30 @@ class TranslationsTestData {
       }.self
     }
 
+  private fun ProjectBuilder.addBasicKey(): Key {
+    return addKey {
+      name = "A key"
+    }.build key@{
+      setDescription("A key description")
+      addTranslation {
+        language = germanLanguage
+        text = "Z translation"
+        state = TranslationState.REVIEWED
+        auto = true
+        outdated = true
+        mtProvider = MtServiceType.GOOGLE
+        self.translations.add(this)
+      }.build {
+        addComment {
+          author = user
+          text = "Comment"
+          state = TranslationCommentState.RESOLVED
+        }
+      }
+      addTag("Cool tag")
+    }.self
+  }
+
   fun addKeysViewOnlyUser() {
     root.apply {
       addUserAccountWithoutOrganization {

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

@@ -70,4 +70,8 @@ but in Android format. (e.g., en-rUS)
   const val HTML_ESCAPE_DESCRIPTION = """If true, HTML tags are escaped in the exported file. (Supported in the XLIFF format only).
 
 e.g. Key <b>hello</b> will be exported as &lt;b&gt;hello&lt;/b&gt;"""
+
+  const val FILTER_BRANCH_DESCRIPTION = """Filter translations with branch. 
+
+By default, default branch is exported."""
 }

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

@@ -19,6 +19,7 @@ import io.tolgee.dtos.ExportParamsDocs.LANGUAGES_EXAMPLE
 import io.tolgee.dtos.ExportParamsDocs.MESSAGE_FORMAT_DESCRIPTION
 import io.tolgee.dtos.ExportParamsDocs.STRUCTURE_DELIMITER_DESCRIPTION
 import io.tolgee.dtos.ExportParamsDocs.SUPPORT_ARRAYS_DESCRIPTION
+import io.tolgee.dtos.ExportParamsDocs.FILTER_BRANCH_DESCRIPTION
 import io.tolgee.formats.ExportFormat
 import io.tolgee.formats.ExportMessageFormat
 import io.tolgee.model.enums.TranslationState
@@ -100,6 +101,11 @@ interface IExportParams {
   )
   var escapeHtml: Boolean?
 
+  @get:Schema(
+    description = FILTER_BRANCH_DESCRIPTION,
+  )
+  var filterBranch: String?
+
   fun copyPropsFrom(other: IExportParams) {
     this.languages = other.languages
     this.format = other.format