feat: integrate branch-specific tracking into project activity and modified entities handling

Author: dkrizan

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

@@ -20,6 +20,7 @@ import io.tolgee.model.views.activity.ProjectActivityView
 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
@@ -43,15 +44,24 @@ class ProjectActivityController(
   private val modificationResourcesAssembler: PagedResourcesAssembler<ModifiedEntityView>,
   private val projectActivityModelAssembler: ProjectActivityModelAssembler,
   private val modifiedEntityModelAssembler: ModifiedEntityModelAssembler,
+  private val branchService: BranchService,
 ) {
   @Operation(summary = "Get project activity")
   @GetMapping("")
   @RequiresProjectPermissions([Scope.ACTIVITY_VIEW])
   @AllowApiAccess
   fun getActivity(
     @ParameterObject pageable: Pageable,
+    @RequestParam(required = false) branch: String? = null,
   ): PagedModel<ProjectActivityModel> {
-    val views = activityService.findProjectActivity(projectId = projectHolder.project.id, pageable)
+    val branchEntity =
+      branch?.let { branchService.getActiveBranch(projectHolder.project.id, it) }
+    val views =
+      activityService.findProjectActivity(
+        projectId = projectHolder.project.id,
+        pageable = pageable,
+        branchId = branchEntity?.id,
+      )
     return activityPagedResourcesAssembler.toModel(views, projectActivityModelAssembler)
   }
 
@@ -61,9 +71,16 @@ class ProjectActivityController(
   @AllowApiAccess
   fun getSingleRevision(
     @PathVariable revisionId: Long,
+    @RequestParam(required = false) branch: String? = null,
   ): ProjectActivityModel {
+    val branchEntity =
+      branch?.let { branchService.getActiveBranch(projectHolder.project.id, it) }
     val views =
-      activityService.findProjectActivity(projectId = projectHolder.project.id, revisionId)
+      activityService.findProjectActivity(
+        projectId = projectHolder.project.id,
+        revisionId = revisionId,
+        branchId = branchEntity?.id,
+      )
         ?: throw NotFoundException()
     return projectActivityModelAssembler.toModel(views)
   }
@@ -80,13 +97,18 @@ class ProjectActivityController(
     )
     @RequestParam(required = false)
     filterEntityClass: List<String>?,
+    @RequestParam(required = false)
+    branch: String? = null,
   ): PagedModel<ModifiedEntityModel> {
+    val branchEntity =
+      branch?.let { branchService.getActiveBranch(projectHolder.project.id, it) }
     val page =
       activityService.getRevisionModifications(
         projectId = projectHolder.project.id,
         revisionId,
         pageable,
         filterEntityClass,
+        branchEntity?.id,
       )
     return modificationResourcesAssembler.toModel(page, modifiedEntityModelAssembler)
   }

backend/app/src/test/kotlin/io/tolgee/service/ActivityVIewByRevisionsProviderTest.kt

@@ -41,4 +41,49 @@ class ActivityVIewByRevisionsProviderTest : ProjectAuthControllerTest() {
       .size.assert
       .isEqualTo(7)
   }
+
+  @Test
+  fun `it includes default branch modified entities when branchId is null`() {
+    val testData = ImportTestData()
+    testData.setAllResolved()
+    testData.setAllOverride()
+    testData.addDefaultBranch()
+    testDataService.saveTestData(testData.root)
+    val user =
+      testData.root.data.userAccounts[0]
+        .self
+    val projectId = testData.project.id
+    loginAsUser(user.username)
+
+    performAuthPost(
+      "/v2/projects/$projectId/translations",
+      mapOf(
+        "key" to "default_key",
+        "translations" to mapOf(testData.english.tag to "default_text"),
+      ),
+    ).andIsOk
+    val revision =
+      entityManager
+        .createQuery(
+          "from ActivityRevision ar order by ar.id desc limit 1",
+          ActivityRevision::class.java,
+        ).resultList
+
+    val branchIds =
+      entityManager
+        .createQuery(
+          "select ame.branchId from ActivityModifiedEntity ame where ame.activityRevision.id = :revisionId",
+          java.lang.Long::class.java,
+        ).setParameter("revisionId", revision.first().id)
+        .resultList
+
+    branchIds.any { it == testData.defaultBranch.id }.assert.isTrue()
+
+    val views = ActivityViewByRevisionsProvider(applicationContext, revision, null, onlyCountInListAbove = 1).get()
+    views
+      .first()
+      .modifications!!
+      .size.assert
+      .isGreaterThan(0)
+  }
 }

backend/data/src/main/kotlin/io/tolgee/activity/ActivityService.kt

@@ -59,8 +59,8 @@ class ActivityService(
     jdbcTemplate.batchUpdate(
       "INSERT INTO activity_modified_entity " +
         "(entity_class, entity_id, describing_data, " +
-        "describing_relations, modifications, revision_type, activity_revision_id) " +
-        "VALUES (?, ?, ?, ?, ?, ?, ?)",
+        "describing_relations, modifications, revision_type, activity_revision_id, branch_id) " +
+        "VALUES (?, ?, ?, ?, ?, ?, ?, ?)",
       list,
       100,
     ) { ps, entity ->
@@ -71,6 +71,7 @@ class ActivityService(
       ps.setObject(5, getJsonbObject(entity.modifications))
       ps.setInt(6, RevisionType.values().indexOf(entity.revisionType))
       ps.setLong(7, entity.activityRevision.id)
+      ps.setObject(8, entity.branchId)
     }
 
     return list
@@ -113,11 +114,13 @@ class ActivityService(
   fun findProjectActivity(
     projectId: Long,
     pageable: Pageable,
+    branchId: Long? = null,
   ): Page<ProjectActivityView> {
     return ProjectActivityViewByPageableProvider(
       applicationContext = applicationContext,
       projectId = projectId,
       pageable = pageable,
+      branchId = branchId,
     ).get()
   }
 
@@ -126,18 +129,21 @@ class ActivityService(
     return ProjectActivityViewByRevisionProvider(
       applicationContext = applicationContext,
       revisionId = revisionId,
+      branchId = null,
     ).get()
   }
 
   @Transactional
   fun findProjectActivity(
     projectId: Long,
     revisionId: Long,
+    branchId: Long? = null,
   ): ProjectActivityView? {
     return ProjectActivityViewByRevisionProvider(
       applicationContext = applicationContext,
       revisionId = revisionId,
       projectId = projectId,
+      branchId = branchId,
     ).get()
   }
 
@@ -158,9 +164,17 @@ class ActivityService(
     revisionId: Long,
     pageable: Pageable,
     filterEntityClass: List<String>?,
+    branchId: Long? = null,
   ): Page<ModifiedEntityView> {
     val provider =
-      ModificationsByRevisionsProvider(applicationContext, projectId, listOf(revisionId), pageable, filterEntityClass)
+      ModificationsByRevisionsProvider(
+        applicationContext,
+        projectId,
+        listOf(revisionId),
+        pageable,
+        filterEntityClass,
+        branchId,
+      )
     return provider.get()
   }
 

backend/data/src/main/kotlin/io/tolgee/activity/iterceptor/InterceptedEventsManager.kt

@@ -13,10 +13,17 @@ import io.tolgee.activity.propChangesProvider.PropChangesProvider
 import io.tolgee.component.ActivityHolderProvider
 import io.tolgee.events.OnProjectActivityEvent
 import io.tolgee.model.EntityWithId
+import io.tolgee.model.Language
+import io.tolgee.model.Project
 import io.tolgee.model.activity.ActivityDescribingEntity
 import io.tolgee.model.activity.ActivityModifiedEntity
 import io.tolgee.model.activity.ActivityRevision
+import io.tolgee.model.branching.BranchVersionedEntity
+import io.tolgee.model.key.KeyComment
+import io.tolgee.model.key.screenshotReference.KeyScreenshotReference
+import io.tolgee.model.task.Task
 import jakarta.persistence.EntityManager
+import jakarta.persistence.FlushModeType
 import org.apache.commons.lang3.exception.ExceptionUtils.getRootCause
 import org.hibernate.Transaction
 import org.hibernate.action.spi.BeforeTransactionCompletionProcess
@@ -165,9 +172,71 @@ class InterceptedEventsManager(
           ).also { it.revisionType = revisionType }
         }
 
+    activityModifiedEntity.branchId = resolveBranchId(entity)
+
     return activityModifiedEntity
   }
 
+  private fun resolveBranchId(entity: EntityWithId): Long? {
+    val branchableKey =
+      (entity as? BranchVersionedEntity<*, *>)?.resolveKey()
+    if (branchableKey != null) {
+      return branchableKey.branch?.id ?: defaultBranchId(branchableKey.project.id)
+    }
+
+    return when (entity) {
+      is KeyComment -> {
+        entity.keyMeta.key
+          ?.branch
+          ?.id ?: entity.keyMeta.key
+          ?.project
+          ?.id
+          ?.let(::defaultBranchId)
+      }
+
+      is KeyScreenshotReference -> {
+        entity.key.branch?.id ?: defaultBranchId(entity.key.project.id)
+      }
+
+      is Task -> {
+        entity.branch?.id ?: defaultBranchId(entity.project.id)
+      }
+
+      is Project -> {
+        defaultBranchId(entity.id)
+      }
+
+      is Language -> {
+        defaultBranchId(entity.project.id)
+      }
+
+      else -> {
+        null
+      }
+    }
+  }
+
+  private fun defaultBranchId(projectId: Long?): Long? {
+    if (projectId == null) {
+      return null
+    }
+    return entityManager
+      .createQuery(
+        """
+        select b.id
+        from Branch b
+        where b.project.id = :projectId
+          and b.isDefault = true
+          and b.archivedAt is null
+          and b.deletedAt is null
+        """,
+        Long::class.java,
+      ).setParameter("projectId", projectId)
+      .setFlushMode(FlushModeType.COMMIT)
+      .resultList
+      .firstOrNull()
+  }
+
   private fun getChangeEntityDescription(
     entity: EntityWithId,
     activityRevision: ActivityRevision,

backend/data/src/main/kotlin/io/tolgee/activity/projectActivity/ActivityViewByRevisionsProvider.kt

@@ -1,12 +1,15 @@
 package io.tolgee.activity.projectActivity
 
 import io.tolgee.activity.data.ActivityType
+import io.tolgee.model.Project_
 import io.tolgee.model.UserAccount
 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.activity.ActivityRevision_
+import io.tolgee.model.branching.Branch
+import io.tolgee.model.branching.Branch_
 import io.tolgee.model.views.activity.ModifiedEntityView
 import io.tolgee.model.views.activity.ProjectActivityView
 import io.tolgee.repository.activity.ActivityRevisionRepository
@@ -21,6 +24,7 @@ import org.springframework.context.ApplicationContext
 class ActivityViewByRevisionsProvider(
   private val applicationContext: ApplicationContext,
   private val revisions: Collection<ActivityRevision>,
+  private val branchId: Long? = null,
   /**
    * For Activities, which have onlyCountInList = true in io.tolgee.activity.data.ActivityType,
    * this parameter specifies what's the maximum per-entity modification to be included in the list.
@@ -112,7 +116,8 @@ class ActivityViewByRevisionsProvider(
     activityRevisionRepository
       .getModifiedEntityTypeCounts(
         revisionIds = revisionIds,
-        allowedTypes,
+        allowedTypes = allowedTypes,
+        branchId = branchId,
       ).forEach { (revisionId, entityClass, count) ->
         counts
           .computeIfAbsent(revisionId as Long) { mutableMapOf() }
@@ -153,6 +158,7 @@ class ActivityViewByRevisionsProvider(
     val whereConditions = mutableListOf<Predicate>()
     whereConditions.add(filter)
     whereConditions.add(revision.get(ActivityRevision_.id).`in`(revisionIds))
+    whereConditions.add(getBranchPredicate(cb, query, root, revision))
     ActivityType.entries.forEach {
       it.restrictEntitiesInList?.let { restrictEntitiesInList ->
         val restrictedEntityNames = restrictEntitiesInList.map { it.simpleName }
@@ -169,6 +175,32 @@ class ActivityViewByRevisionsProvider(
     return entityManager.createQuery(query).resultList
   }
 
+  private fun getBranchPredicate(
+    cb: CriteriaBuilder,
+    query: jakarta.persistence.criteria.CriteriaQuery<*>,
+    root: Root<ActivityModifiedEntity>,
+    revision: Join<ActivityModifiedEntity, ActivityRevision>,
+  ): Predicate {
+    val branchPath = root.get(ActivityModifiedEntity_.branchId)
+    if (branchId != null) {
+      return cb.equal(branchPath, branchId)
+    }
+
+    val subquery = query.subquery(Long::class.java)
+    val branch = subquery.from(Branch::class.java)
+    subquery.select(branch.get(Branch_.id))
+    subquery.where(
+      cb.equal(branch.get(Branch_.project).get(Project_.id), revision.get(ActivityRevision_.projectId)),
+      cb.isTrue(branch.get(Branch_.isDefault)),
+      cb.isNull(branch.get(Branch_.archivedAt)),
+    )
+
+    return cb.or(
+      cb.isNull(branchPath),
+      branchPath.`in`(subquery),
+    )
+  }
+
   private fun getClassesToExpandFilter(
     cb: CriteriaBuilder,
     revision: Join<ActivityModifiedEntity, ActivityRevision>,

backend/data/src/main/kotlin/io/tolgee/activity/projectActivity/ModificationsByRevisionsProvider.kt

@@ -17,6 +17,7 @@ class ModificationsByRevisionsProvider(
   private val revisionIds: List<Long>,
   private val pageable: Pageable,
   private val filterEntityClass: List<String>?,
+  private val branchId: Long?,
 ) {
   val userAccountService: UserAccountService =
     applicationContext.getBean(UserAccountService::class.java)
@@ -57,6 +58,12 @@ class ModificationsByRevisionsProvider(
   }
 
   private fun getModifiedEntitiesRaw(): Page<ActivityModifiedEntity> {
-    return activityModifiedEntityRepository.getModifiedEntities(projectId, revisionIds, filterEntityClass, pageable)
+    return activityModifiedEntityRepository.getModifiedEntities(
+      projectId,
+      revisionIds,
+      filterEntityClass,
+      pageable,
+      branchId,
+    )
   }
 }