fix: code cleanup and refactoring - part 3

Author: Anty0

ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/controllers/glossary/GlossaryTermController.kt

@@ -4,11 +4,11 @@ import io.swagger.v3.oas.annotations.Operation
 import io.swagger.v3.oas.annotations.tags.Tag
 import io.tolgee.component.enabledFeaturesProvider.EnabledFeaturesProvider
 import io.tolgee.constants.Feature
-import io.tolgee.ee.api.v2.hateoas.assemblers.glossary.GlossaryTermModelAssembler
 import io.tolgee.ee.api.v2.hateoas.assemblers.glossary.GlossaryTermTranslationModelAssembler
-import io.tolgee.ee.api.v2.hateoas.assemblers.glossary.GlossaryTermWithTranslationsModelAssembler
-import io.tolgee.ee.api.v2.hateoas.model.glossary.GlossaryTermModel
-import io.tolgee.ee.api.v2.hateoas.model.glossary.GlossaryTermWithTranslationsModel
+import io.tolgee.ee.api.v2.hateoas.assemblers.glossary.SimpleGlossaryTermModelAssembler
+import io.tolgee.ee.api.v2.hateoas.assemblers.glossary.SimpleGlossaryTermWithTranslationsModelAssembler
+import io.tolgee.ee.api.v2.hateoas.model.glossary.SimpleGlossaryTermModel
+import io.tolgee.ee.api.v2.hateoas.model.glossary.SimpleGlossaryTermWithTranslationsModel
 import io.tolgee.ee.data.glossary.CreateGlossaryTermWithTranslationRequest
 import io.tolgee.ee.data.glossary.CreateUpdateGlossaryTermResponse
 import io.tolgee.ee.data.glossary.DeleteMultipleGlossaryTermsRequest
@@ -36,8 +36,8 @@ import org.springframework.web.bind.annotation.*
 @Tag(name = "Glossary term")
 class GlossaryTermController(
   private val glossaryTermService: GlossaryTermService,
-  private val glossaryTermModelAssembler: GlossaryTermModelAssembler,
-  private val glossaryTermWithTranslationsModelAssembler: GlossaryTermWithTranslationsModelAssembler,
+  private val simpleGlossaryTermModelAssembler: SimpleGlossaryTermModelAssembler,
+  private val simpleGlossaryTermWithTranslationsModelAssembler: SimpleGlossaryTermWithTranslationsModelAssembler,
   private val glossaryTermTranslationModelAssembler: GlossaryTermTranslationModelAssembler,
   private val pagedAssembler: PagedResourcesAssembler<GlossaryTerm>,
   private val organizationHolder: OrganizationHolder,
@@ -63,7 +63,7 @@ class GlossaryTermController(
 
     val (term, translation) = glossaryTermService.createWithTranslation(organizationId, glossaryId, dto)
     return CreateUpdateGlossaryTermResponse(
-      term = glossaryTermModelAssembler.toModel(term),
+      term = simpleGlossaryTermModelAssembler.toModel(term),
       translation = translation?.let { glossaryTermTranslationModelAssembler.toModel(translation) },
     )
   }
@@ -104,7 +104,7 @@ class GlossaryTermController(
 
     val (term, translation) = glossaryTermService.updateWithTranslation(organizationId, glossaryId, termId, dto)
     return CreateUpdateGlossaryTermResponse(
-      term = glossaryTermModelAssembler.toModel(term),
+      term = simpleGlossaryTermModelAssembler.toModel(term),
       translation = translation?.let { glossaryTermTranslationModelAssembler.toModel(translation) },
     )
   }
@@ -135,14 +135,14 @@ class GlossaryTermController(
     @PathVariable organizationId: Long,
     @PathVariable glossaryId: Long,
     @PathVariable termId: Long,
-  ): GlossaryTermModel {
+  ): SimpleGlossaryTermModel {
     enabledFeaturesProvider.checkFeatureEnabled(
       organizationHolder.organization.id,
       Feature.GLOSSARY,
     )
 
     val glossaryTerm = glossaryTermService.get(organizationId, glossaryId, termId)
-    return glossaryTermModelAssembler.toModel(glossaryTerm)
+    return simpleGlossaryTermModelAssembler.toModel(glossaryTerm)
   }
 
   @GetMapping("/terms")
@@ -155,14 +155,14 @@ class GlossaryTermController(
     @ParameterObject pageable: Pageable,
     @RequestParam("search", required = false) search: String?,
     @RequestParam("languageTags", required = false) languageTags: List<String>?,
-  ): PagedModel<GlossaryTermModel> {
+  ): PagedModel<SimpleGlossaryTermModel> {
     enabledFeaturesProvider.checkFeatureEnabled(
       organizationHolder.organization.id,
       Feature.GLOSSARY,
     )
 
     val terms = glossaryTermService.findAllPaged(organizationId, glossaryId, pageable, search, languageTags?.toSet())
-    return pagedAssembler.toModel(terms, glossaryTermModelAssembler)
+    return pagedAssembler.toModel(terms, simpleGlossaryTermModelAssembler)
   }
 
   @GetMapping("/termsWithTranslations")
@@ -175,21 +175,21 @@ class GlossaryTermController(
     @ParameterObject pageable: Pageable,
     @RequestParam("search", required = false) search: String?,
     @RequestParam("languageTags", required = false) languageTags: List<String>?,
-  ): PagedModel<GlossaryTermWithTranslationsModel> {
+  ): PagedModel<SimpleGlossaryTermWithTranslationsModel> {
     enabledFeaturesProvider.checkFeatureEnabled(
       organizationHolder.organization.id,
       Feature.GLOSSARY,
     )
 
     val terms =
-      glossaryTermService.findAllPaged(
+      glossaryTermService.findAllWithTranslationsPaged(
         organizationId,
         glossaryId,
         pageable,
         search,
         languageTags?.toSet(),
       )
-    return pagedAssembler.toModel(terms, glossaryTermWithTranslationsModelAssembler)
+    return pagedAssembler.toModel(terms, simpleGlossaryTermWithTranslationsModelAssembler)
   }
 
   @GetMapping("/termsIds")

ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/controllers/glossary/GlossaryTermHighlightsController.kt

@@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.Operation
 import io.swagger.v3.oas.annotations.tags.Tag
 import io.tolgee.component.enabledFeaturesProvider.EnabledFeaturesProvider
 import io.tolgee.constants.Feature
-import io.tolgee.ee.api.v2.hateoas.assemblers.glossary.GlossaryTermWithTranslationsModelAssembler
+import io.tolgee.ee.api.v2.hateoas.assemblers.glossary.GlossaryTermModelAssembler
 import io.tolgee.ee.data.glossary.GlossaryTermHighlightDto
 import io.tolgee.ee.service.glossary.GlossaryTermService
 import io.tolgee.model.enums.Scope
@@ -27,7 +27,7 @@ import org.springframework.web.bind.annotation.RestController
 class GlossaryTermHighlightsController(
   private val projectHolder: ProjectHolder,
   private val glossaryTermService: GlossaryTermService,
-  private val modelAssembler: GlossaryTermWithTranslationsModelAssembler,
+  private val modelAssembler: GlossaryTermModelAssembler,
   private val organizationHolder: OrganizationHolder,
   private val enabledFeaturesProvider: EnabledFeaturesProvider,
 ) {

ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/hateoas/assemblers/glossary/GlossaryTermModelAssembler.kt

@@ -9,6 +9,7 @@ import org.springframework.stereotype.Component
 @Component
 class GlossaryTermModelAssembler(
   private val glossaryModelAssembler: GlossaryModelAssembler,
+  private val glossaryTermTranslationModelAssembler: GlossaryTermTranslationModelAssembler,
 ) : RepresentationModelAssemblerSupport<GlossaryTerm, GlossaryTermModel>(
     GlossaryTermController::class.java,
     GlossaryTermModel::class.java,
@@ -22,6 +23,7 @@ class GlossaryTermModelAssembler(
       flagCaseSensitive = entity.flagCaseSensitive,
       flagAbbreviation = entity.flagAbbreviation,
       flagForbiddenTerm = entity.flagForbiddenTerm,
+      translations = entity.translations.map { glossaryTermTranslationModelAssembler.toModel(it) },
     )
   }
 }

ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/hateoas/assemblers/glossary/SimpleGlossaryTermModelAssembler.kt

@@ -0,0 +1,25 @@
+package io.tolgee.ee.api.v2.hateoas.assemblers.glossary
+
+import io.tolgee.ee.api.v2.controllers.glossary.GlossaryTermController
+import io.tolgee.ee.api.v2.hateoas.model.glossary.SimpleGlossaryTermModel
+import io.tolgee.model.glossary.GlossaryTerm
+import org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
+import org.springframework.stereotype.Component
+
+@Component
+class SimpleGlossaryTermModelAssembler :
+  RepresentationModelAssemblerSupport<GlossaryTerm, SimpleGlossaryTermModel>(
+    GlossaryTermController::class.java,
+    SimpleGlossaryTermModel::class.java,
+  ) {
+  override fun toModel(entity: GlossaryTerm): SimpleGlossaryTermModel {
+    return SimpleGlossaryTermModel(
+      id = entity.id,
+      description = entity.description,
+      flagNonTranslatable = entity.flagNonTranslatable,
+      flagCaseSensitive = entity.flagCaseSensitive,
+      flagAbbreviation = entity.flagAbbreviation,
+      flagForbiddenTerm = entity.flagForbiddenTerm,
+    )
+  }
+}

ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/hateoas/assemblers/glossary/GlossaryTermWithTranslationsModelAssembler.kt renamed to ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/hateoas/assemblers/glossary/SimpleGlossaryTermWithTranslationsModelAssembler.kt

@@ -1,23 +1,21 @@
 package io.tolgee.ee.api.v2.hateoas.assemblers.glossary
 
 import io.tolgee.ee.api.v2.controllers.glossary.GlossaryTermController
-import io.tolgee.ee.api.v2.hateoas.model.glossary.GlossaryTermWithTranslationsModel
+import io.tolgee.ee.api.v2.hateoas.model.glossary.SimpleGlossaryTermWithTranslationsModel
 import io.tolgee.model.glossary.GlossaryTerm
 import org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
 import org.springframework.stereotype.Component
 
 @Component
-class GlossaryTermWithTranslationsModelAssembler(
-  private val glossaryModelAssembler: GlossaryModelAssembler,
+class SimpleGlossaryTermWithTranslationsModelAssembler(
   private val glossaryTermTranslationModelAssembler: GlossaryTermTranslationModelAssembler,
-) : RepresentationModelAssemblerSupport<GlossaryTerm, GlossaryTermWithTranslationsModel>(
+) : RepresentationModelAssemblerSupport<GlossaryTerm, SimpleGlossaryTermWithTranslationsModel>(
     GlossaryTermController::class.java,
-    GlossaryTermWithTranslationsModel::class.java,
+    SimpleGlossaryTermWithTranslationsModel::class.java,
   ) {
-  override fun toModel(entity: GlossaryTerm): GlossaryTermWithTranslationsModel {
-    return GlossaryTermWithTranslationsModel(
+  override fun toModel(entity: GlossaryTerm): SimpleGlossaryTermWithTranslationsModel {
+    return SimpleGlossaryTermWithTranslationsModel(
       id = entity.id,
-      glossary = glossaryModelAssembler.toModel(entity.glossary),
       description = entity.description,
       flagNonTranslatable = entity.flagNonTranslatable,
       flagCaseSensitive = entity.flagCaseSensitive,

ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/hateoas/model/glossary/GlossaryTermModel.kt

@@ -12,4 +12,5 @@ class GlossaryTermModel(
   val flagCaseSensitive: Boolean,
   val flagAbbreviation: Boolean,
   val flagForbiddenTerm: Boolean,
+  val translations: List<GlossaryTermTranslationModel>,
 ) : RepresentationModel<GlossaryTermModel>()

ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/hateoas/model/glossary/SimpleGlossaryTermModel.kt

@@ -0,0 +1,14 @@
+package io.tolgee.ee.api.v2.hateoas.model.glossary
+
+import org.springframework.hateoas.RepresentationModel
+import org.springframework.hateoas.server.core.Relation
+
+@Relation(collectionRelation = "glossaryTerms", itemRelation = "glossaryTerm")
+class SimpleGlossaryTermModel(
+  val id: Long,
+  val description: String?,
+  val flagNonTranslatable: Boolean,
+  val flagCaseSensitive: Boolean,
+  val flagAbbreviation: Boolean,
+  val flagForbiddenTerm: Boolean,
+) : RepresentationModel<SimpleGlossaryTermModel>()

ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/hateoas/model/glossary/GlossaryTermWithTranslationsModel.kt renamed to ee/backend/app/src/main/kotlin/io/tolgee/ee/api/v2/hateoas/model/glossary/SimpleGlossaryTermWithTranslationsModel.kt

@@ -4,13 +4,12 @@ import org.springframework.hateoas.RepresentationModel
 import org.springframework.hateoas.server.core.Relation
 
 @Relation(collectionRelation = "glossaryTerms", itemRelation = "glossaryTerm")
-class GlossaryTermWithTranslationsModel(
+class SimpleGlossaryTermWithTranslationsModel(
   val id: Long,
-  val glossary: GlossaryModel,
   val description: String?,
   val flagNonTranslatable: Boolean,
   val flagCaseSensitive: Boolean,
   val flagAbbreviation: Boolean,
   val flagForbiddenTerm: Boolean,
   val translations: List<GlossaryTermTranslationModel>,
-) : RepresentationModel<GlossaryTermWithTranslationsModel>()
+) : RepresentationModel<SimpleGlossaryTermWithTranslationsModel>()

ee/backend/app/src/main/kotlin/io/tolgee/ee/data/glossary/CreateGlossaryTermRequest.kt

@@ -1,9 +1,11 @@
 package io.tolgee.ee.data.glossary
 
+import io.swagger.v3.oas.annotations.media.Schema
 import jakarta.validation.constraints.Size
 
 open class CreateGlossaryTermRequest {
-  @field:Size(min = 0, max = 500)
+  @Schema(example = "", description = "Glossary term description")
+  @field:Size(max = 500)
   var description: String? = null
 
   var flagNonTranslatable: Boolean = false

ee/backend/app/src/main/kotlin/io/tolgee/ee/data/glossary/CreateUpdateGlossaryTermResponse.kt

@@ -1,9 +1,9 @@
 package io.tolgee.ee.data.glossary
 
-import io.tolgee.ee.api.v2.hateoas.model.glossary.GlossaryTermModel
 import io.tolgee.ee.api.v2.hateoas.model.glossary.GlossaryTermTranslationModel
+import io.tolgee.ee.api.v2.hateoas.model.glossary.SimpleGlossaryTermModel
 
 data class CreateUpdateGlossaryTermResponse(
-  val term: GlossaryTermModel,
+  val term: SimpleGlossaryTermModel,
   val translation: GlossaryTermTranslationModel?,
 )

ee/backend/app/src/main/kotlin/io/tolgee/ee/data/glossary/GlossaryTermHighlightDto.kt

@@ -1,8 +1,8 @@
 package io.tolgee.ee.data.glossary
 
-import io.tolgee.ee.api.v2.hateoas.model.glossary.GlossaryTermWithTranslationsModel
+import io.tolgee.ee.api.v2.hateoas.model.glossary.GlossaryTermModel
 
 data class GlossaryTermHighlightDto(
   val position: Position,
-  val value: GlossaryTermWithTranslationsModel,
+  val value: GlossaryTermModel,
 )

ee/backend/app/src/main/kotlin/io/tolgee/ee/data/glossary/UpdateGlossaryTermRequest.kt

@@ -3,7 +3,7 @@ package io.tolgee.ee.data.glossary
 import jakarta.validation.constraints.Size
 
 open class UpdateGlossaryTermRequest {
-  @field:Size(min = 0, max = 500)
+  @field:Size(max = 500)
   var description: String? = null
 
   var flagNonTranslatable: Boolean? = null

ee/backend/app/src/main/kotlin/io/tolgee/ee/repository/glossary/GlossaryRepository.kt

@@ -13,8 +13,6 @@ import java.util.Date
 @Repository
 @Lazy
 interface GlossaryRepository : JpaRepository<Glossary, Long> {
-  // TODO: rework - use only glossary id for query, check organization id in service?
-
   @Query(
     """
     from Glossary
@@ -45,7 +43,7 @@ interface GlossaryRepository : JpaRepository<Glossary, Long> {
     where organizationOwner.id = :organizationId
       and organizationOwner.deletedAt is null
       and deletedAt is null
-      and (:search is null or lower(name) like lower(concat('%', cast(:search as text), '%')))
+      and (:search is null or lower(name) like lower(concat('%', coalesce(:search, ''), '%'))) 
   """,
   )
   fun findByOrganizationIdPaged(

ee/backend/app/src/main/kotlin/io/tolgee/ee/repository/glossary/GlossaryTermRepository.kt

@@ -41,8 +41,8 @@ interface GlossaryTermRepository : JpaRepository<GlossaryTerm, Long> {
       and te.glossary.id = :glossaryId
       and te.glossary.deletedAt is null
       and (:search is null or
-        lower(te.description) like lower(concat('%', cast(:search as text), '%')) or
-        lower(tr.text) like lower(concat('%', cast(:search as text), '%'))
+        lower(te.description) like lower(concat('%', coalesce(:search, ''), '%')) or
+        lower(tr.text) like lower(concat('%', coalesce(:search, '') , '%'))
       )
   """,
   )
@@ -63,8 +63,8 @@ interface GlossaryTermRepository : JpaRepository<GlossaryTerm, Long> {
     where te.glossary = :glossary
       and (
         :search is null or
-        lower(te.description) like lower(concat('%', cast(:search as text), '%')) or
-        lower(tr.text) like lower(concat('%', cast(:search as text), '%'))
+        lower(te.description) like lower(concat('%', coalesce(:search, ''), '%')) or
+        lower(tr.text) like lower(concat('%', ccoalesce(:search, ''), '%'))
       )
   """,
   )
@@ -75,6 +75,28 @@ interface GlossaryTermRepository : JpaRepository<GlossaryTerm, Long> {
     languageTags: Set<String>?,
   ): Page<GlossaryTerm>
 
+  @Query(
+    """
+    from GlossaryTerm te
+    join fetch te.translations
+    left join GlossaryTermTranslation tr on tr.term.id = te.id
+      and tr.languageTag = te.glossary.baseLanguageTag
+      and (:languageTags is null or tr.languageTag in :languageTags)
+    where te.glossary = :glossary
+      and (
+        :search is null or
+        lower(te.description) like lower(concat('%', coalesce(:search, ''), '%')) or
+        lower(tr.text) like lower(concat('%', ccoalesce(:search, ''), '%'))
+      )
+  """,
+  )
+  fun findByGlossaryWithTranslationsPaged(
+    glossary: Glossary,
+    pageable: Pageable,
+    search: String?,
+    languageTags: Set<String>?,
+  ): Page<GlossaryTerm>
+
   @Query(
     """
     select te.id from GlossaryTerm te
@@ -84,8 +106,8 @@ interface GlossaryTermRepository : JpaRepository<GlossaryTerm, Long> {
     where te.glossary = :glossary
       and (
         :search is null or
-        lower(te.description) like lower(concat('%', cast(:search as text), '%')) or
-        lower(tr.text) like lower(concat('%', cast(:search as text), '%'))
+        lower(te.description) like lower(concat('%', coalesce(:search, ''), '%')) or
+        lower(tr.text) like lower(concat('%', coalesce(:search, ''), '%'))
       )
   """,
   )

ee/backend/app/src/main/kotlin/io/tolgee/ee/repository/glossary/GlossaryTermTranslationRepository.kt

@@ -1,9 +1,11 @@
 package io.tolgee.ee.repository.glossary
 
+import io.tolgee.model.glossary.Glossary
 import io.tolgee.model.glossary.GlossaryTerm
 import io.tolgee.model.glossary.GlossaryTermTranslation
 import org.springframework.context.annotation.Lazy
 import org.springframework.data.jpa.repository.JpaRepository
+import org.springframework.data.jpa.repository.Modifying
 import org.springframework.data.jpa.repository.Query
 import org.springframework.stereotype.Repository
 
@@ -66,4 +68,20 @@ interface GlossaryTermTranslationRepository : JpaRepository<GlossaryTermTranslat
     assignedProjectId: Long,
     organizationId: Long,
   ): Set<GlossaryTermTranslation>
+
+  @Modifying
+  @Query(
+    """
+      update GlossaryTermTranslation gtt
+      set gtt.languageTag = :newBaseLanguageTag
+      where gtt.term.glossary = :glossary
+       and gtt.languageTag = :oldBaseLanguageTag
+       and gtt.term.flagNonTranslatable = true
+    """,
+  )
+  fun updateBaseLanguage(
+    glossary: Glossary,
+    oldBaseLanguageTag: String?,
+    newBaseLanguageTag: String?,
+  )
 }