feat: Slack integration (tolgee#2247)

Co-authored-by: Ivan Manzhosov <[email protected]>
Co-authored-by: Ivan <[email protected]>
Co-authored-by: Štěpán Granát <[email protected]>

Author: 3 people

.gitignore

@@ -68,3 +68,5 @@ backend/app/src/main/resources/application-js-e2e.properties
 
 /webapp/src/branch.json
 
+ngrok.yml
+ngrok.local.yml

backend/api/build.gradle

@@ -67,6 +67,11 @@ dependencies {
     api libs.postHog
     implementation libs.kotlinReflect
     implementation libs.jacksonModuleKotlin
+
+    /**
+     * SLACK SDK
+     */
+    api libs.slackApiClient
 }
 
 sourceSets {

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

@@ -5,11 +5,17 @@
 package io.tolgee.api.v2.controllers
 
 import io.swagger.v3.oas.annotations.Operation
+import io.swagger.v3.oas.annotations.Parameter
+import io.swagger.v3.oas.annotations.media.ExampleObject
 import io.swagger.v3.oas.annotations.tags.Tag
 import io.tolgee.activity.ActivityService
+import io.tolgee.exceptions.NotFoundException
+import io.tolgee.hateoas.activity.ModifiedEntityModel
+import io.tolgee.hateoas.activity.ModifiedEntityModelAssembler
 import io.tolgee.hateoas.activity.ProjectActivityModel
 import io.tolgee.hateoas.activity.ProjectActivityModelAssembler
 import io.tolgee.model.enums.Scope
+import io.tolgee.model.views.activity.ModifiedEntityView
 import io.tolgee.model.views.activity.ProjectActivityView
 import io.tolgee.security.ProjectHolder
 import io.tolgee.security.authentication.AllowApiAccess
@@ -21,7 +27,9 @@ import org.springframework.hateoas.MediaTypes
 import org.springframework.hateoas.PagedModel
 import org.springframework.web.bind.annotation.CrossOrigin
 import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PathVariable
 import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RequestParam
 import org.springframework.web.bind.annotation.RestController
 
 @Suppress("MVCPathVariableInspection", "SpringJavaInjectionPointsAutowiringInspection")
@@ -32,8 +40,10 @@ import org.springframework.web.bind.annotation.RestController
 class ProjectActivityController(
   private val activityService: ActivityService,
   private val projectHolder: ProjectHolder,
-  private val pagedResourcesAssembler: PagedResourcesAssembler<ProjectActivityView>,
+  private val activityPagedResourcesAssembler: PagedResourcesAssembler<ProjectActivityView>,
+  private val modificationResourcesAssembler: PagedResourcesAssembler<ModifiedEntityView>,
   private val projectActivityModelAssembler: ProjectActivityModelAssembler,
+  private val modifiedEntityModelAssembler: ModifiedEntityModelAssembler,
 ) {
   @Operation(summary = "Get project activity")
   @GetMapping("", produces = [MediaTypes.HAL_JSON_VALUE])
@@ -42,7 +52,43 @@ class ProjectActivityController(
   fun getActivity(
     @ParameterObject pageable: Pageable,
   ): PagedModel<ProjectActivityModel> {
-    val views = activityService.getProjectActivity(projectId = projectHolder.project.id, pageable)
-    return pagedResourcesAssembler.toModel(views, projectActivityModelAssembler)
+    val views = activityService.findProjectActivity(projectId = projectHolder.project.id, pageable)
+    return activityPagedResourcesAssembler.toModel(views, projectActivityModelAssembler)
+  }
+
+  @Operation(summary = "Get one revision data")
+  @GetMapping("/revisions/{revisionId}", produces = [MediaTypes.HAL_JSON_VALUE])
+  @RequiresProjectPermissions([Scope.ACTIVITY_VIEW])
+  @AllowApiAccess
+  fun getSingleRevision(
+    @PathVariable revisionId: Long,
+  ): ProjectActivityModel {
+    val views =
+      activityService.findProjectActivity(projectId = projectHolder.project.id, revisionId)
+        ?: throw NotFoundException()
+    return projectActivityModelAssembler.toModel(views)
+  }
+
+  @Operation(summary = "Get modified entities in revision")
+  @GetMapping("/revisions/{revisionId}/modified-entities")
+  @RequiresProjectPermissions([Scope.ACTIVITY_VIEW])
+  fun getModifiedEntitiesByRevision(
+    @ParameterObject pageable: Pageable,
+    @PathVariable revisionId: Long,
+    @Parameter(
+      description = "Filters results by specific entity class",
+      examples = [ExampleObject(value = "Key"), ExampleObject(value = "Translation")],
+    )
+    @RequestParam(required = false)
+    filterEntityClass: List<String>?,
+  ): PagedModel<ModifiedEntityModel> {
+    val page =
+      activityService.getRevisionModifications(
+        projectId = projectHolder.project.id,
+        revisionId,
+        pageable,
+        filterEntityClass,
+      )
+    return modificationResourcesAssembler.toModel(page, modifiedEntityModelAssembler)
   }
 }

backend/api/src/main/kotlin/io/tolgee/configuration/PublicConfigurationDTO.kt

@@ -8,8 +8,7 @@ import io.tolgee.dtos.response.PublicBillingConfigurationDTO
 
 @Suppress("MemberVisibilityCanBePrivate", "unused")
 class PublicConfigurationDTO(
-  @Schema(hidden = true)
-  properties: TolgeeProperties,
+  @Schema(hidden = true) properties: TolgeeProperties,
   val machineTranslationServices: MtServicesDTO,
   val billing: PublicBillingConfigurationDTO,
   val version: String,
@@ -34,7 +33,14 @@ class PublicConfigurationDTO(
   val postHogApiKey: String? = properties.postHog.apiKey
   val postHogHost: String? = properties.postHog.host
   val contentDeliveryConfigured: Boolean = properties.contentDelivery.publicUrlPrefix != null
-  val userSourceField: Boolean = properties.userSourceField
+  val slack: SlackDTO =
+    SlackDTO(
+      enabled = (
+        properties.slack.signingSecret != null &&
+          (properties.slack.clientId != null || properties.slack.token != null)
+      ),
+      connected = properties.slack.token != null,
+    )
 
   class AuthMethodsDTO(
     val github: OAuthPublicConfigDTO,
@@ -64,6 +70,11 @@ class PublicConfigurationDTO(
     val defaultEnabledForProject: Boolean,
   )
 
+  data class SlackDTO(
+    val enabled: Boolean,
+    val connected: Boolean,
+  )
+
   init {
     if (authentication) {
       authMethods =

backend/api/src/main/kotlin/io/tolgee/hateoas/SlackUserInfoModel.kt

@@ -0,0 +1,9 @@
+package io.tolgee.hateoas
+
+class SlackUserInfoModel(
+  val teamName: String,
+  val slackName: String?,
+  val slackId: String,
+  val slackRealName: String?,
+  val slackAvatar: String,
+)

backend/api/src/main/kotlin/io/tolgee/hateoas/activity/ModifiedEntityModel.kt

@@ -3,11 +3,15 @@ package io.tolgee.hateoas.activity
 import io.tolgee.activity.data.ExistenceEntityDescription
 import io.tolgee.activity.data.PropertyModification
 import io.tolgee.api.IModifiedEntityModel
+import org.springframework.hateoas.RepresentationModel
+import org.springframework.hateoas.server.core.Relation
 
+@Relation(collectionRelation = "modifiedEntities", itemRelation = "modifiedEntity")
 data class ModifiedEntityModel(
+  override val entityClass: String,
   override val entityId: Long,
   override val description: Map<String, Any?>? = null,
   override var modifications: Map<String, PropertyModification>? = null,
   override var relations: Map<String, ExistenceEntityDescription>? = null,
   override val exists: Boolean? = null,
-) : IModifiedEntityModel
+) : IModifiedEntityModel, RepresentationModel<ModifiedEntityModel>()

backend/api/src/main/kotlin/io/tolgee/hateoas/activity/ModifiedEntityModelAssembler.kt

@@ -0,0 +1,19 @@
+package io.tolgee.hateoas.activity
+
+import io.tolgee.model.views.activity.ModifiedEntityView
+import org.springframework.hateoas.server.RepresentationModelAssembler
+import org.springframework.stereotype.Component
+
+@Component
+class ModifiedEntityModelAssembler : RepresentationModelAssembler<ModifiedEntityView, ModifiedEntityModel> {
+  override fun toModel(view: ModifiedEntityView): ModifiedEntityModel {
+    return ModifiedEntityModel(
+      entityClass = view.entityClass,
+      entityId = view.entityId,
+      description = view.description,
+      modifications = view.modifications,
+      relations = view.describingRelations,
+      exists = view.exists,
+    )
+  }
+}

backend/api/src/main/kotlin/io/tolgee/hateoas/activity/ProjectActivityModelAssembler.kt

@@ -10,6 +10,7 @@ import org.springframework.stereotype.Component
 @Component
 class ProjectActivityModelAssembler(
   private val avatarService: AvatarService,
+  private val modifiedEntityModelAssembler: ModifiedEntityModelAssembler,
 ) : RepresentationModelAssemblerSupport<ProjectActivityView, ProjectActivityModel>(
     ApiKeyController::class.java,
     ProjectActivityModel::class.java,
@@ -43,13 +44,7 @@ class ProjectActivityModelAssembler(
       ?.map { entry ->
         entry.key to
           entry.value.map {
-            ModifiedEntityModel(
-              entityId = it.entityId,
-              description = it.description,
-              modifications = it.modifications,
-              relations = it.describingRelations,
-              exists = it.exists,
-            )
+            modifiedEntityModelAssembler.toModel(it)
           }
       }?.toMap()
 }

backend/api/src/main/kotlin/io/tolgee/hateoas/organization/slack/ConnectToSlackUrlModel.kt

@@ -0,0 +1,5 @@
+package io.tolgee.hateoas.organization.slack
+
+data class ConnectToSlackUrlModel(
+  val url: String,
+)

backend/api/src/main/kotlin/io/tolgee/hateoas/organization/slack/WorkspaceModel.kt

@@ -0,0 +1,11 @@
+package io.tolgee.hateoas.organization.slack
+
+import org.springframework.hateoas.RepresentationModel
+import org.springframework.hateoas.server.core.Relation
+
+@Relation(collectionRelation = "workspaces", itemRelation = "workspace")
+open class WorkspaceModel(
+  val id: Long,
+  val slackTeamName: String,
+  val slackTeamId: String,
+) : RepresentationModel<WorkspaceModel>()