Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ fun CurrentUserProfile.toCurrentUserProfileResponse(): CurrentUserProfileRespons
PupilProfileResponse(
displayName = it.displayName,
currentClassroomId = it.currentClassroomId,
totalXp = it.totalXp,
currentLevel = it.currentLevel,
)
},
teacherProfile = teacherProfile?.let {
Expand All @@ -38,6 +40,8 @@ fun PupilProfileDetails.toPupilProfileResponse(): PupilProfileResponse =
PupilProfileResponse(
displayName = displayName,
currentClassroomId = currentClassroomId,
totalXp = totalXp,
currentLevel = currentLevel,
)

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,14 @@ data class CurrentUserProfileResponse(
*
* @property displayName pupil name shown in the product
* @property currentClassroomId current classroom id, or `null` when unassigned
* @property totalXp classroom-scoped XP for the active classroom, or `0` when unavailable
* @property currentLevel classroom-scoped level for the active classroom, or `1` when unavailable
*/
data class PupilProfileResponse(
val displayName: String,
val currentClassroomId: Long?,
val totalXp: Int,
val currentLevel: Int,
)

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package edu.ntnu.idi.idatt.backend.users.profile.application

import edu.ntnu.idi.idatt.backend.game.gameProgress.infrastructure.PupilGameProgressRepository
import edu.ntnu.idi.idatt.backend.iam.application.CurrentUserResolver
import edu.ntnu.idi.idatt.backend.iam.domain.UserRole
import edu.ntnu.idi.idatt.backend.users.profile.domain.PupilProfile
Expand All @@ -15,12 +16,14 @@ import org.springframework.web.server.ResponseStatusException
*
* @property currentUserResolver resolver to authenticate users
* @property pupilProfileRepository repository used to load pupil profile data
* @property pupilGameProgressRepository repository used to load classroom-scoped game progress
* @property teacherProfileRepository repository used to load the teacher profile data
*/
@Service
class CurrentUserProfileService(
private val currentUserResolver: CurrentUserResolver,
private val pupilProfileRepository: PupilProfileRepository,
private val pupilGameProgressRepository: PupilGameProgressRepository,
private val teacherProfileRepository: TeacherProfileRepository,
) {
/**
Expand All @@ -37,9 +40,13 @@ class CurrentUserProfileService(
val pupilProfile = if (user.role == UserRole.PUPIL) {
pupilProfileRepository.findById(userId)
.map {
val progress = getCurrentClassroomProgress(userId, it.currentClassroomId)

PupilProfileDetails(
displayName = it.displayName,
currentClassroomId = it.currentClassroomId,
totalXp = progress?.totalXp ?: 0,
currentLevel = progress?.currentLevel ?: 1,
)
}
.orElseThrow {
Expand Down Expand Up @@ -89,12 +96,15 @@ class CurrentUserProfileService(
val user = currentUserResolver.requirePupil(authenticatedSubject)
val userId = requireNotNull(user.id) { "Authenticated user is missing an id" }
val pupilProfile = findPupilProfile(userId)
val progress = getCurrentClassroomProgress(userId, pupilProfile.currentClassroomId)
pupilProfile.displayName = command.displayName.trim()
val savedProfile = pupilProfileRepository.save(pupilProfile)

return PupilProfileDetails(
displayName = savedProfile.displayName,
currentClassroomId = savedProfile.currentClassroomId,
totalXp = progress?.totalXp ?: 0,
currentLevel = progress?.currentLevel ?: 1,
)
}

Expand All @@ -109,6 +119,9 @@ class CurrentUserProfileService(
.orElseThrow {
ResponseStatusException(HttpStatus.NOT_FOUND, "Pupil profile was not found")
}

private fun getCurrentClassroomProgress(userId: Long, classroomId: Long?) =
classroomId?.let { pupilGameProgressRepository.findByPupilIdAndClassroomId(userId, it) }
}

/**
Expand Down Expand Up @@ -136,6 +149,8 @@ data class CurrentUserProfile(
data class PupilProfileDetails(
val displayName: String,
val currentClassroomId: Long?,
val totalXp: Int,
val currentLevel: Int,
)

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package edu.ntnu.idi.idatt.backend.users.profile

import edu.ntnu.idi.idatt.backend.game.gameProgress.domain.PupilGameProgress
import edu.ntnu.idi.idatt.backend.game.gameProgress.infrastructure.PupilGameProgressRepository
import edu.ntnu.idi.idatt.backend.iam.application.CurrentUserResolver
import edu.ntnu.idi.idatt.backend.iam.domain.User
import edu.ntnu.idi.idatt.backend.iam.domain.UserRole
Expand All @@ -23,10 +25,12 @@ class CurrentUserProfileServiceTests {
fun `get current user profile returns pupil profile for pupil user`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val user = pupilUser(42L)
Expand All @@ -40,6 +44,9 @@ class CurrentUserProfileServiceTests {

Mockito.`when`(currentUserResolver.requireUser("42")).thenReturn(user)
Mockito.`when`(pupilProfileRepository.findById(42L)).thenReturn(Optional.of(pupilProfile))
Mockito.`when`(pupilGameProgressRepository.findByPupilIdAndClassroomId(42L, 101L)).thenReturn(
PupilGameProgress(totalXp = 480, currentLevel = 4),
)

val resolvedProfile = service.getCurrentUserProfile("42")

Expand All @@ -49,17 +56,83 @@ class CurrentUserProfileServiceTests {
assertNull(resolvedProfile.email)
assertEquals("Ada", resolvedProfile.pupilProfile?.displayName)
assertEquals(101L, resolvedProfile.pupilProfile?.currentClassroomId)
assertEquals(480, resolvedProfile.pupilProfile?.totalXp)
assertEquals(4, resolvedProfile.pupilProfile?.currentLevel)
assertNull(resolvedProfile.teacherProfile)
}

@Test
fun `get current user profile returns default progress when pupil has no current classroom`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val user = pupilUser(42L)
val pupilProfile = PupilProfile(
user = user,
displayName = "Ada",
currentClassroomId = null,
).apply {
userId = 42L
}

Mockito.`when`(currentUserResolver.requireUser("42")).thenReturn(user)
Mockito.`when`(pupilProfileRepository.findById(42L)).thenReturn(Optional.of(pupilProfile))

val resolvedProfile = service.getCurrentUserProfile("42")

assertEquals(0, resolvedProfile.pupilProfile?.totalXp)
assertEquals(1, resolvedProfile.pupilProfile?.currentLevel)
Mockito.verifyNoInteractions(pupilGameProgressRepository)
}

@Test
fun `get current user profile returns default progress when classroom progress row is missing`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val user = pupilUser(42L)
val pupilProfile = PupilProfile(
user = user,
displayName = "Ada",
currentClassroomId = 101L,
).apply {
userId = 42L
}

Mockito.`when`(currentUserResolver.requireUser("42")).thenReturn(user)
Mockito.`when`(pupilProfileRepository.findById(42L)).thenReturn(Optional.of(pupilProfile))
Mockito.`when`(pupilGameProgressRepository.findByPupilIdAndClassroomId(42L, 101L)).thenReturn(null)

val resolvedProfile = service.getCurrentUserProfile("42")

assertEquals(0, resolvedProfile.pupilProfile?.totalXp)
assertEquals(1, resolvedProfile.pupilProfile?.currentLevel)
}

@Test
fun `get current user profile returns teacher shell for teacher user`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val user = teacherUser(7L)
Expand Down Expand Up @@ -89,10 +162,12 @@ class CurrentUserProfileServiceTests {
fun `get current user profile rejects invalid authenticated subject`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val exception = ResponseStatusException(HttpStatus.UNAUTHORIZED, "Invalid authenticated user subject")
Expand All @@ -110,10 +185,12 @@ class CurrentUserProfileServiceTests {
fun `get current user profile rejects unknown authenticated user`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val exception = ResponseStatusException(HttpStatus.UNAUTHORIZED, "Authenticated user was not found")
Expand All @@ -131,10 +208,12 @@ class CurrentUserProfileServiceTests {
fun `get current user profile rejects pupil without profile row`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val user = pupilUser(42L)
Expand All @@ -153,10 +232,12 @@ class CurrentUserProfileServiceTests {
fun `get current user profile rejects teacher without profile row`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val user = teacherUser(7L)
Expand All @@ -175,10 +256,12 @@ class CurrentUserProfileServiceTests {
fun `update current user display name persists submitted value for pupil`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val user = pupilUser(42L)
Expand All @@ -195,24 +278,32 @@ class CurrentUserProfileServiceTests {
Mockito.`when`(pupilProfileRepository.save(Mockito.any(PupilProfile::class.java))).thenAnswer { invocation ->
invocation.arguments[0] as PupilProfile
}
Mockito.`when`(pupilGameProgressRepository.findByPupilIdAndClassroomId(42L, 101L)).thenReturn(
PupilGameProgress(totalXp = 480, currentLevel = 4),
)

val updatedProfile = service.updateCurrentUserDisplayName(
"42",
UpdateCurrentUserDisplayNameCommand(displayName = " Ada Lovelace "),
)

assertEquals("Ada Lovelace", updatedProfile.displayName)
assertEquals(101L, updatedProfile.currentClassroomId)
assertEquals(480, updatedProfile.totalXp)
assertEquals(4, updatedProfile.currentLevel)
assertEquals("Ada Lovelace", pupilProfile.displayName)
}

@Test
fun `update current user display name rejects teacher user`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val exception = ResponseStatusException(HttpStatus.FORBIDDEN, "Only pupils are allowed")
Expand All @@ -233,10 +324,12 @@ class CurrentUserProfileServiceTests {
fun `update current user display name rejects pupil without profile row`() {
val currentUserResolver = Mockito.mock(CurrentUserResolver::class.java)
val pupilProfileRepository = Mockito.mock(PupilProfileRepository::class.java)
val pupilGameProgressRepository = Mockito.mock(PupilGameProgressRepository::class.java)
val teacherProfileRepository = Mockito.mock(TeacherProfileRepository::class.java)
val service = CurrentUserProfileService(
currentUserResolver,
pupilProfileRepository,
pupilGameProgressRepository,
teacherProfileRepository,
)
val user = pupilUser(42L)
Expand Down
Loading