#2406 Add lastVisit field and set it when user logs in

src/main/kotlin/com/epam/brn/auth/filter/FirebaseTokenAuthenticationFilter.kt

@@ -37,9 +37,16 @@ class FirebaseTokenAuthenticationFilter(
         filterChain: FilterChain
     ) {
         verifyToken(request)
+        markVisit()
         filterChain.doFilter(request, response)
     }
 
+    private fun markVisit() {
+        if (SecurityContextHolder.getContext().authentication != null) {
+            userAccountService.markVisitForCurrentUser()
+        }
+    }
+
     private fun verifyToken(request: HttpServletRequest) {
         val token: String? = tokenHelperUtils.getBearerToken(request)
         try {

src/main/kotlin/com/epam/brn/dto/UserAccountDto.kt

@@ -16,6 +16,7 @@ data class UserAccountDto(
     var active: Boolean = true,
     val created: LocalDateTime = LocalDateTime.now(ZoneOffset.UTC),
     val changed: LocalDateTime = LocalDateTime.now(ZoneOffset.UTC),
+    val lastVisit: LocalDateTime? = null,
     var avatar: String? = null,
     val photo: String? = null,
     val description: String? = null,

src/main/kotlin/com/epam/brn/model/UserAccount.kt

@@ -45,6 +45,8 @@ data class UserAccount(
     @LastModifiedBy
     @Column(name = "changed_by")
     var changedBy: String = "",
+    @Column(name = "last_visit")
+    var lastVisit: LocalDateTime? = null,
     var avatar: String? = null,
     var photo: String? = null,
     var description: String? = null,
@@ -81,6 +83,7 @@ data class UserAccount(
         gender = gender?.let { BrnGender.valueOf(it) },
         created = created,
         changed = changed,
+        lastVisit = lastVisit,
         avatar = avatar,
         photo = photo,
         description = description,

src/main/kotlin/com/epam/brn/repo/UserAccountRepository.kt

@@ -4,8 +4,11 @@ import com.epam.brn.model.UserAccount
 import org.springframework.data.domain.Page
 import org.springframework.data.domain.Pageable
 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
+import org.springframework.transaction.annotation.Transactional
+import java.time.LocalDateTime
 import java.util.Optional
 
 @Repository
@@ -50,4 +53,12 @@ interface UserAccountRepository : JpaRepository<UserAccount, Long> {
             left JOIN FETCH u.headphones where roles.name = :roleName"""
     )
     fun findUsersAccountsByRole(roleName: String): List<UserAccount>
+
+    @Transactional
+    @Modifying
+    @Query(
+        """update UserAccount u SET u.lastVisit = :lastVisit
+            where u.email = :email"""
+    )
+    fun updateLastVisitByEmail(email: String, lastVisit: LocalDateTime)
 }

src/main/kotlin/com/epam/brn/service/UserAccountService.kt

@@ -34,4 +34,6 @@ interface UserAccountService {
     fun updateDoctorForPatient(userId: Long, doctorId: Long): UserAccount
     fun removeDoctorFromPatient(userId: Long): UserAccount
     fun getPatientsForDoctor(doctorId: Long): List<UserAccountDto>
+
+    fun markVisitForCurrentUser()
 }

src/main/kotlin/com/epam/brn/service/impl/UserAccountServiceImpl.kt

@@ -11,6 +11,7 @@ import com.epam.brn.model.UserAccount
 import com.epam.brn.repo.UserAccountRepository
 import com.epam.brn.service.HeadphonesService
 import com.epam.brn.service.RoleService
+import com.epam.brn.service.TimeService
 import com.epam.brn.service.UserAccountService
 import com.google.firebase.auth.UserRecord
 import org.springframework.data.domain.Pageable
@@ -24,7 +25,8 @@ import java.security.Principal
 class UserAccountServiceImpl(
     private val userAccountRepository: UserAccountRepository,
     private val roleService: RoleService,
-    private val headphonesService: HeadphonesService
+    private val headphonesService: HeadphonesService,
+    private val timeService: TimeService
 ) : UserAccountService {
 
     override fun findUserByEmail(email: String): UserAccountDto =
@@ -67,12 +69,17 @@ class UserAccountServiceImpl(
             .toSet()
 
     override fun getCurrentUser(): UserAccount {
-        val authentication = SecurityContextHolder.getContext().authentication
-        val email = authentication.name ?: getNameFromPrincipals(authentication)
+        val email = getCurrentUserEmail()
         return userAccountRepository.findUserAccountByEmail(email)
             .orElseThrow { EntityNotFoundException("No user was found for email=$email") }
     }
 
+    override fun markVisitForCurrentUser() {
+        val email = getCurrentUserEmail()
+        val lastVisit = timeService.now()
+        return userAccountRepository.updateLastVisitByEmail(email, lastVisit)
+    }
+
     override fun getCurrentUserDto(): UserAccountDto =
         getCurrentUser().toDto()
 
@@ -149,6 +156,11 @@ class UserAccountServiceImpl(
         return this
     }
 
+    private fun getCurrentUserEmail(): String {
+        val authentication = SecurityContextHolder.getContext().authentication
+        return authentication.name ?: getNameFromPrincipals(authentication)
+    }
+
     private fun getNameFromPrincipals(authentication: Authentication): String {
         val principal = authentication.principal
         if (principal is UserDetails)

src/main/resources/db/migration/V220230119_2406.sql

@@ -0,0 +1 @@
+alter table user_account add column if not exists last_visit timestamp;

src/test/kotlin/com/epam/brn/auth/filter/FirebaseTokenAuthenticationFilterTest.kt

@@ -18,6 +18,7 @@ import io.mockk.every
 import io.mockk.impl.annotations.InjectMockKs
 import io.mockk.impl.annotations.MockK
 import io.mockk.junit5.MockKExtension
+import io.mockk.justRun
 import io.mockk.mockk
 import io.mockk.verify
 import org.amshove.kluent.shouldBeInstanceOf
@@ -85,6 +86,8 @@ internal class FirebaseTokenAuthenticationFilterTest {
         every { firebaseAuth.verifyIdToken(token, true) } returns firebaseTokenMock
         every { firebaseTokenMock.email } returns email
         every { brainUpUserDetailsService.loadUserByUsername(email) } returns customUserDetailsMock
+        justRun { userAccountService.markVisitForCurrentUser() }
+
         // WHEN
         firebaseTokenAuthenticationFilter.doFilter(request, response, filterChain)
         // THEN
@@ -97,6 +100,7 @@ internal class FirebaseTokenAuthenticationFilterTest {
         verify(exactly = 1) { tokenHelperUtils.getBearerToken(request) }
         verify(exactly = 1) { firebaseAuth.verifyIdToken(token, true) }
         verify(exactly = 1) { brainUpUserDetailsService.loadUserByUsername(email) }
+        verify(exactly = 1) { userAccountService.markVisitForCurrentUser() }
         verify(exactly = 0) { firebaseUserService.getUserByUuid(any()) }
         verify(exactly = 0) { userAccountService.createUser(any()) }
     }
@@ -124,6 +128,7 @@ internal class FirebaseTokenAuthenticationFilterTest {
             gender = null,
             name = fullName
         )
+        justRun { userAccountService.markVisitForCurrentUser() }
 
         // WHEN
         firebaseTokenAuthenticationFilter.doFilter(requestMock, responseMock, filterChain)
@@ -139,6 +144,7 @@ internal class FirebaseTokenAuthenticationFilterTest {
         verify(exactly = 2) { brainUpUserDetailsService.loadUserByUsername(email) }
         verify(exactly = 1) { firebaseUserService.getUserByUuid(uuid) }
         verify(exactly = 1) { userAccountService.createUser(any()) }
+        verify(exactly = 1) { userAccountService.markVisitForCurrentUser() }
     }
 
     @Test
@@ -163,6 +169,7 @@ internal class FirebaseTokenAuthenticationFilterTest {
         verify(exactly = 0) { brainUpUserDetailsService.loadUserByUsername(any()) }
         verify(exactly = 0) { firebaseUserService.getUserByUuid(any()) }
         verify(exactly = 0) { userAccountService.createUser(any()) }
+        verify(exactly = 0) { userAccountService.markVisitForCurrentUser() }
     }
 
     @Test
@@ -187,6 +194,7 @@ internal class FirebaseTokenAuthenticationFilterTest {
         verify(exactly = 0) { brainUpUserDetailsService.loadUserByUsername(any()) }
         verify(exactly = 0) { firebaseUserService.getUserByUuid(any()) }
         verify(exactly = 0) { userAccountService.createUser(any()) }
+        verify(exactly = 0) { userAccountService.markVisitForCurrentUser() }
     }
 
     @Test
@@ -216,6 +224,7 @@ internal class FirebaseTokenAuthenticationFilterTest {
         verify(exactly = 1) { firebaseAuth.verifyIdToken(tokenMock, true) }
         verify(exactly = 1) { brainUpUserDetailsService.loadUserByUsername(email) }
         verify(exactly = 1) { firebaseUserService.getUserByUuid(uuid) }
+        verify(exactly = 0) { userAccountService.markVisitForCurrentUser() }
         verify(exactly = 0) { userAccountService.createUser(any()) }
     }
 

src/test/kotlin/com/epam/brn/integration/repo/UserAccountRepositoryTest.kt

@@ -0,0 +1,69 @@
+package com.epam.brn.integration.repo
+
+import com.epam.brn.model.UserAccount
+import com.epam.brn.repo.UserAccountRepository
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Assertions.assertDoesNotThrow
+import org.junit.jupiter.api.DisplayName
+import org.junit.jupiter.api.Tag
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.TestInstance
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase
+import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest
+import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager
+import java.time.LocalDateTime
+import java.time.temporal.ChronoUnit
+
+@DataJpaTest
+@Tag("integration-test")
+@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
+@DisplayName("UserAccountRepository tests")
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+class UserAccountRepositoryTest {
+
+    @Autowired
+    private lateinit var repository: UserAccountRepository
+
+    @Autowired
+    private lateinit var testEntityManager: TestEntityManager
+
+    @Test
+    fun `should update lastVisit date of user`() {
+        // GIVEN
+        val yesterday = LocalDateTime.now().minusDays(1).truncatedTo(ChronoUnit.MILLIS)
+        val today = LocalDateTime.now().truncatedTo(ChronoUnit.MILLIS)
+
+        val email = "[email protected]"
+        val user = UserAccount(
+            email = email,
+            fullName = "John Doe",
+            lastVisit = yesterday
+        )
+        val savedUser = testEntityManager.persistAndFlush(user)
+
+        // WHEN
+        repository.updateLastVisitByEmail(email, today)
+
+        testEntityManager.flush()
+        testEntityManager.clear()
+
+        // THEN
+        val retrievedUser = testEntityManager.find(UserAccount::class.java, savedUser.id)
+        assertThat(retrievedUser).isNotNull
+        val actualLastVisit = retrievedUser.lastVisit?.truncatedTo(ChronoUnit.MILLIS)
+        assertThat(actualLastVisit).isEqualTo(today)
+    }
+
+    @Test
+    fun `should not throw error when user doesn't exist`() {
+        // GIVEN
+        val today = LocalDateTime.now().truncatedTo(ChronoUnit.MILLIS)
+        val email = "[email protected]"
+
+        // WHEN & THEN
+        assertDoesNotThrow {
+            repository.updateLastVisitByEmail(email, today)
+        }
+    }
+}

src/test/kotlin/com/epam/brn/service/UserAccountServiceTest.kt

@@ -15,11 +15,13 @@ import com.epam.brn.service.impl.UserAccountServiceImpl
 import com.google.firebase.auth.UserRecord
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.matchers.shouldBe
+import io.mockk.Runs
 import io.mockk.every
 import io.mockk.impl.annotations.InjectMockKs
 import io.mockk.impl.annotations.MockK
 import io.mockk.junit5.MockKExtension
 import io.mockk.mockkClass
+import io.mockk.just
 import io.mockk.slot
 import io.mockk.verify
 import org.apache.commons.lang3.math.NumberUtils
@@ -33,6 +35,7 @@ import org.springframework.security.core.Authentication
 import org.springframework.security.core.context.SecurityContext
 import org.springframework.security.core.context.SecurityContextHolder
 import java.time.LocalDateTime
+import java.time.ZoneOffset
 import java.util.Optional
 import kotlin.test.assertFailsWith
 import kotlin.test.assertNotNull
@@ -78,6 +81,9 @@ internal class UserAccountServiceTest {
     @MockK
     lateinit var pageable: Pageable
 
+    @MockK
+    lateinit var timeService: TimeService
+
     @Nested
     @DisplayName("Tests for getting users")
     inner class GetUserAccounts {
@@ -295,6 +301,25 @@ internal class UserAccountServiceTest {
             assertThat(userForSave.fullName).isEqualTo("newName")
             assertThat(userForSave.id).isEqualTo(userAccount.id)
         }
+
+        @Test
+        fun `should mark visit for current session user`() {
+            // GIVEN
+            val email = "[email protected]"
+            val now = LocalDateTime.now(ZoneOffset.UTC)
+
+            SecurityContextHolder.setContext(securityContext)
+            every { securityContext.authentication } returns authentication
+            every { authentication.name } returns email
+            every { timeService.now() } returns now
+            every { userAccountRepository.updateLastVisitByEmail(email, now) } just Runs
+
+            // WHEN
+            userAccountService.markVisitForCurrentUser()
+
+            // THEN
+            verify { userAccountRepository.updateLastVisitByEmail(email, now) }
+        }
     }
 
     @Nested