User last activity

DEVELOPMENT.md

@@ -1,9 +1,9 @@
 ## Install Prerequisites
 
-* [Java 21](https://openjdk.org/install)
-* [Docker](https://docs.docker.com/engine/install)
-* [Node.js 18](https://nodejs.org/en/download) (or higher)
-* [Intellij Idea](https://www.jetbrains.com/help/idea/installation-guide.html) (optional)
+- [Java 21](https://openjdk.org/install)
+- [Docker](https://docs.docker.com/engine/install)
+- [Node.js 18](https://nodejs.org/en/download) (or higher)
+- [Intellij Idea](https://www.jetbrains.com/help/idea/installation-guide.html) (optional)
 
 ## Clone this repo
 
@@ -14,14 +14,14 @@ git clone --depth 1 [email protected]:tolgee/tolgee-platform.git
 ## Run the stack
 
 1. Run backend
-   * With the prepared Idea run configuration `Backend localhost`
-   * With command line:
+   - With the prepared Idea run configuration `Backend localhost`.
+   - With command line:
      ```shell
      ./gradlew server-app:bootRun --args='--spring.profiles.active=dev'
      ```
 2. Run frontend
-   * With the prepared Idea run configuration `Frontend localhost`
-   * With command line:
+   - With the prepared Idea run configuration `Frontend localhost`.
+   - With command line:
      ```shell
      cd webapp && npm ci && npm run start
      ```
@@ -33,7 +33,7 @@ The backend of Tolgee is tested with unit and integration tests.
 
 ### Backend testing
 
-To run backend tests, you can run Gradle test task
+To run backend tests, you can run Gradle test task:
 
 ```shell
 ./gradlew test
@@ -62,11 +62,29 @@ tolgee:
   file-storage-url: http://localhost:8080
 ```
 
+To enable authentication, add following properties:
+
+```yaml
+tolgee:
+  authentication:
+    enabled: true
+    initial-username: <YOUR_REAL_EMAIL>
+    initial-password: admin
+```
+
 You can check `application-e2e.yaml` for further inspiration.
-To learn more about externalized configuration in Spring boot, read [the docs](https://docs.spring.io/spring-boot/3.4/reference/features/external-config.html).
+To learn more about externalized configuration in Spring Boot, read [its docs](https://docs.spring.io/spring-boot/3.4/reference/features/external-config.html).
 
 Since we set the active profile to `dev`, Spring uses the `application-dev.yaml` configuration file.
 
+## API schema changes
+
+After you change the API schema, you need to have backend running and invoke the webapp schema script to update frontend:
+
+```shell
+cd webapp && npm run schema
+```
+
 ## Updating the database changelog
 
 Tolgee uses Liquibase to handle the database migration. The migrations are run on every app startup. To update the changelog, run:
@@ -77,12 +95,13 @@ Tolgee uses Liquibase to handle the database migration. The migrations are run o
 
 ### Troubleshooting updating the changelog
 
-If you misspell the command and run diffChangelog, it will find the command, but it would fail, since liquibase changed the command name in the past.
-We have enhanced the diffChangeLog (with capital L) command, so you have to run that.
+If you misspell the command and run `diffChangelog`, it will find the command, but it would fail, since Liquibase changed the command name in the past.
+We have enhanced the `diffChangeLog` (with capital `L`) command, so you have to run that.
 
-Sometimes, Gradle cannot find a docker command to start the database instance to generate the changelog against.
-This happens due to some issue with setting the paths for Gradle daemon.
+Sometimes, Gradle cannot find a Docker command to start the database instance to generate the changelog against.
+This happens due to some issue with setting the paths for Gradle Daemon.
 Running the command without daemon fixes the issue:
+
 ```shell
 ./gradlew diffChangeLog --no-daemon
 ```
@@ -91,9 +110,9 @@ Running the command without daemon fixes the issue:
 
 For the frontend, there are npm tasks `prettier` and `eslint`, which you should run before every commit.
 Otherwise, the "Frontend static check" workflow will fail.
-You can also use prettier plugins for VS Code, Idea, or WebStorm.
+You can also use Prettier plugins for VS Code, Idea, or WebStorm.
 
-To fix prettier issues and check everything is fine, run these commands:
+To fix Prettier issues and check everything is fine, run these commands:
 
 ```shell
 cd webapp
@@ -102,7 +121,7 @@ npm run tsc
 npm run eslint
 ```
 
-On the backend, there is Gradle task `ktlintFormat`, which helps you to format Kotlin code.
+On the backend, there is Gradle task `ktlintFormat`, which helps you to format Kotlin code:
 
 ```shell
 ./gradlew ktlintFormat
@@ -122,19 +141,20 @@ VITE_APP_TOLGEE_API_KEY=your-tolgee-api-key
 
 ## Troubleshooting
 
-### Command not found when executing gradle tasks on MacOS
-When running E2e Tests from Idea on Mac, you encounter fails due to command not found.
+### Command not found when executing Gradle tasks on MacOS
 
-Apparentrly this happens because IDEA starts the gradle daemon with wrong path.
+When running E2E tests from Idea on Mac, you encounter fails due to command not found.
 
-The only **workaround** I currently found is killing the gradle daemon and running IDEA from terminal
+Apparently this happens because Idea starts the Gradle Daemon with wrong path.
 
-```bash
+The only **workaround** I currently found is killing the Gradle Daemon and running Idea from terminal:
+
+```shell
 pkill -f '.*GradleDaemon.*'
 open -a 'IntelliJ IDEA Ultimate'
 ```
 
-This way, IDEA is started with correct environment from zsh or bash and so the Gradle Daemon is started correctly.
+This way, Idea is started with correct environment from Zsh or Bash and so the Gradle Daemon is started correctly.
 
 If you don't like this solution (I don't like it too), you can start looking for better solution.
 This thread is a good starting point: https://discuss.gradle.org/t/exec-execute-in-gradle-doesnt-use-path/25598/3
@@ -147,7 +167,8 @@ To monitor business activities in the Tolgee platform, we use PostHog for event
 
 When an activity is stored with a modifying endpoint on the backend, the event is automatically logged. Developers can optionally provide additional metadata using the `businessEventData` property in `ActivityHolder`.
 
-Usually, you don't need to provide the data, but If you really need to, you can do it this way.
+Usually, you don't need to provide the data, but If you really need to, you can do it this way:
+
 ```kotlin
 // Example: Adding business event data to an activity
 @Component
@@ -203,10 +224,10 @@ class YourService(
 
 ### 3. Logging from frontend code
 
-For logging events from the frontend, use the provided React hooks:
+For logging events from the frontend, use the provided React Hooks:
 
 ```typescript
-// Example 1: Using useReportEvent hook for event-triggered reporting
+// Example 1: Using useReportEvent Hook for event-triggered reporting
 import { useReportEvent } from 'tg.hooks/useReportEvent';
 
 function ExampleComponent() {
@@ -222,7 +243,7 @@ function ExampleComponent() {
 ```
 
 ```typescript
-// Example 2: Using useReportOnce hook for reporting on component mount
+// Example 2: Using useReportOnce Hook for reporting on component mount
 import { useReportOnce } from 'tg.hooks/useReportEvent';
 
 function AnotherComponent() {
@@ -233,4 +254,4 @@ function AnotherComponent() {
 }
 ```
 
-These frontend hooks send events through the backend API, ensuring they aren't blocked by ad blockers.
+These frontend Hooks send events through the backend API, ensuring they aren't blocked by ad blockers.

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

@@ -5,12 +5,13 @@ import io.swagger.v3.oas.annotations.tags.Tag
 import io.tolgee.api.v2.controllers.IController
 import io.tolgee.constants.Message
 import io.tolgee.dtos.cacheable.isAdmin
+import io.tolgee.dtos.queryResults.UserAccountAdministrationView
 import io.tolgee.dtos.queryResults.organization.OrganizationView
 import io.tolgee.exceptions.BadRequestException
 import io.tolgee.hateoas.organization.OrganizationModel
 import io.tolgee.hateoas.organization.OrganizationModelAssembler
-import io.tolgee.hateoas.userAccount.UserAccountModel
-import io.tolgee.hateoas.userAccount.UserAccountModelAssembler
+import io.tolgee.hateoas.userAccount.UserAccountAdministrationModel
+import io.tolgee.hateoas.userAccount.UserAccountAdministrationModelAssembler
 import io.tolgee.model.UserAccount
 import io.tolgee.openApiDocs.OpenApiSelfHostedExtension
 import io.tolgee.security.authentication.AuthenticationFacade
@@ -43,18 +44,18 @@ import org.springframework.web.bind.annotation.RestController
   name = "Server Administration",
   description =
     "**Only for self-hosted instances** \n\n" +
-      "Managees global Tolgee Platform instance data e.g., user accounts and organizations.",
+      "Manages global Tolgee Platform instance data, e.g. user accounts and organizations.",
 )
 @OpenApiSelfHostedExtension
 class AdministrationController(
-    private val organizationService: OrganizationService,
-    private val pagedOrganizationResourcesAssembler: PagedResourcesAssembler<OrganizationView>,
-    private val organizationModelAssembler: OrganizationModelAssembler,
-    private val authenticationFacade: AuthenticationFacade,
-    private val userAccountService: UserAccountService,
-    private val pagedResourcesAssembler: PagedResourcesAssembler<UserAccount>,
-    private val userAccountModelAssembler: UserAccountModelAssembler,
-    private val jwtService: JwtService,
+  private val organizationService: OrganizationService,
+  private val pagedOrganizationResourcesAssembler: PagedResourcesAssembler<OrganizationView>,
+  private val organizationModelAssembler: OrganizationModelAssembler,
+  private val authenticationFacade: AuthenticationFacade,
+  private val userAccountService: UserAccountService,
+  private val pagedUserResourcesAssembler: PagedResourcesAssembler<UserAccountAdministrationView>,
+  private val userModelAssembler: UserAccountAdministrationModelAssembler,
+  private val jwtService: JwtService,
 ) : IController {
   @GetMapping(value = ["/organizations"])
   @Operation(summary = "Get all server organizations")
@@ -82,9 +83,9 @@ class AdministrationController(
     @SortDefault(sort = ["name"])
     pageable: Pageable,
       search: String? = null,
-  ): PagedModel<UserAccountModel> {
+  ): PagedModel<UserAccountAdministrationModel> {
     val users = userAccountService.findAllWithDisabledPaged(pageable, search)
-    return pagedResourcesAssembler.toModel(users, userAccountModelAssembler)
+    return pagedUserResourcesAssembler.toModel(users, userModelAssembler)
   }
 
   @DeleteMapping(value = ["/users/{userId}"])
@@ -140,7 +141,7 @@ class AdministrationController(
 
   @GetMapping(value = ["/users/{userId:[0-9]+}/generate-token"])
   @Operation(
-    summary = "Geneate user's JWT token",
+    summary = "Generate user's JWT token",
     description =
       "Generates a JWT token for the user with provided ID. This is useful, when need to debug of the " +
         "user's account. Or when an operation is required to be executed on behalf of the user.",

backend/api/src/main/kotlin/io/tolgee/hateoas/userAccount/UserAccountModel.kt → backend/api/src/main/kotlin/io/tolgee/hateoas/userAccount/UserAccountAdministrationModel.kt

@@ -4,9 +4,10 @@ import io.tolgee.dtos.Avatar
 import io.tolgee.model.UserAccount
 import org.springframework.hateoas.RepresentationModel
 import org.springframework.hateoas.server.core.Relation
+import java.util.Date
 
 @Relation(collectionRelation = "users", itemRelation = "user")
-data class UserAccountModel(
+data class UserAccountAdministrationModel(
   val id: Long,
   val username: String,
   val name: String?,
@@ -16,4 +17,5 @@ data class UserAccountModel(
   val mfaEnabled: Boolean,
   val deleted: Boolean,
   val disabled: Boolean,
-) : RepresentationModel<UserAccountModel>()
+  val lastActivity: Date?,
+) : RepresentationModel<UserAccountAdministrationModel>()

backend/api/src/main/kotlin/io/tolgee/hateoas/userAccount/UserAccountAdministrationModelAssembler.kt

@@ -0,0 +1,34 @@
+package io.tolgee.hateoas.userAccount
+
+import io.tolgee.api.isMfaEnabled
+import io.tolgee.api.v2.controllers.V2UserController
+import io.tolgee.dtos.queryResults.UserAccountAdministrationView
+import io.tolgee.model.UserAccount
+import io.tolgee.service.AvatarService
+import org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport
+import org.springframework.stereotype.Component
+
+@Component
+class UserAccountAdministrationModelAssembler(
+  private val avatarService: AvatarService,
+) : RepresentationModelAssemblerSupport<UserAccountAdministrationView, UserAccountAdministrationModel>(
+    V2UserController::class.java,
+    UserAccountAdministrationModel::class.java,
+  ) {
+  override fun toModel(view: UserAccountAdministrationView): UserAccountAdministrationModel {
+    val avatar = avatarService.getAvatarLinks(view.avatarHash)
+
+    return UserAccountAdministrationModel(
+      id = view.id,
+      username = view.username,
+      name = view.name,
+      emailAwaitingVerification = view.emailAwaitingVerification,
+      avatar = avatar,
+      globalServerRole = view.role ?: UserAccount.Role.USER,
+      mfaEnabled = view.isMfaEnabled,
+      deleted = view.deletedAt != null,
+      disabled = view.disabledAt != null,
+      lastActivity = view.lastActivity,
+    )
+  }
+}