diff --git a/src/main/kotlin/edu/ntnu/idi/idatt/backend/classroom/infrastructure/ClassroomAverageTotalScoreView.kt b/src/main/kotlin/edu/ntnu/idi/idatt/backend/classroom/infrastructure/ClassroomAverageTotalScoreView.kt new file mode 100644 index 00000000..301fce6a --- /dev/null +++ b/src/main/kotlin/edu/ntnu/idi/idatt/backend/classroom/infrastructure/ClassroomAverageTotalScoreView.kt @@ -0,0 +1,10 @@ +package edu.ntnu.idi.idatt.backend.classroom.infrastructure + +/** + * Projection for classroom average total score aggregates. + */ +interface ClassroomAverageTotalScoreView { + val classroomId: Long + val classroomTitle: String + val averageTotalScore: Double +} diff --git a/src/main/kotlin/edu/ntnu/idi/idatt/backend/classroom/infrastructure/ClassroomRepository.kt b/src/main/kotlin/edu/ntnu/idi/idatt/backend/classroom/infrastructure/ClassroomRepository.kt index e814bf04..f730ca95 100644 --- a/src/main/kotlin/edu/ntnu/idi/idatt/backend/classroom/infrastructure/ClassroomRepository.kt +++ b/src/main/kotlin/edu/ntnu/idi/idatt/backend/classroom/infrastructure/ClassroomRepository.kt @@ -2,6 +2,7 @@ package edu.ntnu.idi.idatt.backend.classroom.infrastructure import edu.ntnu.idi.idatt.backend.classroom.domain.Classroom import org.springframework.data.jpa.repository.JpaRepository +import org.springframework.data.jpa.repository.Query import org.springframework.stereotype.Repository @Repository @@ -21,4 +22,29 @@ interface ClassroomRepository : JpaRepository { * explicit classroom id. */ fun findFirstByOwnerTeacherIdOrderByIdAsc(ownerTeacherId: Long): Classroom? + + /** + * Returns all classrooms with the average total score across their pupils. + * + * Classrooms without matching pupil progress rows are included with an + * average score of `0.0`. + */ + @Query( + value = """ + SELECT + c.id AS classroomId, + c.title AS classroomTitle, + COALESCE(AVG(pgp.total_score), 0) AS averageTotalScore + FROM classrooms c + LEFT JOIN classroom_pupils cp + ON cp.classroom_id = c.id + LEFT JOIN pupil_game_progress pgp + ON pgp.classroom_id = cp.classroom_id + AND pgp.pupil_user_id = cp.pupil_user_id + GROUP BY c.id, c.title + ORDER BY c.id ASC + """, + nativeQuery = true, + ) + fun findAllWithAverageTotalScore(): List } diff --git a/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardApiMappings.kt b/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardApiMappings.kt index 3726d461..097d3d82 100644 --- a/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardApiMappings.kt +++ b/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardApiMappings.kt @@ -12,15 +12,9 @@ fun List.toLeaderboardResponse(): LeaderboardResponse = entries = map { entry -> LeaderboardEntryResponse( rank = entry.rank, - pupilUserId = entry.pupilUserId, - displayName = entry.displayName, - totalScore = entry.totalScore, - totalXp = entry.totalXp, - currentLevel = entry.currentLevel, - completedStopsCount = entry.completedStopsCount, - completedTasksCount = entry.completedTasksCount, - finalBossCompleted = entry.finalBossCompleted, - lastActivityAt = entry.lastActivityAt, + classroomId = entry.classroomId, + classroomTitle = entry.classroomTitle, + averageTotalScore = entry.averageTotalScore, ) }, ) diff --git a/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardController.kt b/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardController.kt index e4709552..3fbc68f8 100644 --- a/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardController.kt +++ b/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardController.kt @@ -18,14 +18,14 @@ class LeaderboardController( private val leaderboardService: LeaderboardService, ) { /** - * Returns the leaderboard for the authenticated user's resolved classroom. + * Returns the classroom leaderboard visible to the authenticated user. * * @param currentUser authenticated principal resolved from the JWT access token - * @return ordered leaderboard entries for the resolved classroom + * @return ordered classroom leaderboard entries */ @GetMapping fun getLeaderboard( @AuthenticationPrincipal currentUser: CurrentUser, ): LeaderboardResponse = - leaderboardService.getClassLeaderboardList(currentUser).toLeaderboardResponse() + leaderboardService.getLeaderboardList(currentUser).toLeaderboardResponse() } diff --git a/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardResponse.kt b/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardResponse.kt index 1e4501d4..ab8fdc2a 100644 --- a/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardResponse.kt +++ b/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/api/LeaderboardResponse.kt @@ -1,7 +1,5 @@ package edu.ntnu.idi.idatt.backend.leaderboard.api -import java.time.Instant - /** * Response payload for a classroom leaderboard. * @@ -15,25 +13,13 @@ data class LeaderboardResponse( * Public leaderboard row exposed to clients. * * @property rank one-based position in the ordered leaderboard - * @property pupilUserId persisted pupil id for the row - * @property displayName pupil display name shown in the product - * @property totalScore total accumulated score within the classroom - * @property totalXp total accumulated XP within the classroom - * @property currentLevel current level reached by the pupil - * @property completedStopsCount number of completed stops - * @property completedTasksCount number of completed tasks - * @property finalBossCompleted whether the final boss has been completed - * @property lastActivityAt timestamp of the latest tracked classroom activity + * @property classroomId persisted classroom id for the row + * @property classroomTitle classroom title shown in the product + * @property averageTotalScore average pupil total score within the classroom */ data class LeaderboardEntryResponse( val rank: Int, - val pupilUserId: Long, - val displayName: String, - val totalScore: Int, - val totalXp: Int, - val currentLevel: Int, - val completedStopsCount: Int, - val completedTasksCount: Int, - val finalBossCompleted: Boolean, - val lastActivityAt: Instant, + val classroomId: Long, + val classroomTitle: String, + val averageTotalScore: Double, ) diff --git a/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/application/LeaderboardService.kt b/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/application/LeaderboardService.kt index 3bf0676f..da28b054 100644 --- a/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/application/LeaderboardService.kt +++ b/src/main/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/application/LeaderboardService.kt @@ -1,28 +1,24 @@ package edu.ntnu.idi.idatt.backend.leaderboard.application -import edu.ntnu.idi.idatt.backend.game.gameProgress.infrastructure.PupilGameProgressRepository +import edu.ntnu.idi.idatt.backend.classroom.infrastructure.ClassroomRepository import edu.ntnu.idi.idatt.backend.iam.application.CurrentUserResolver import edu.ntnu.idi.idatt.backend.iam.security.CurrentUser -import edu.ntnu.idi.idatt.backend.users.profile.infrastructure.PupilProfileRepository import org.springframework.stereotype.Service import org.springframework.transaction.annotation.Transactional /** - * Application service for classroom-scoped leaderboard lookups. + * Application service for leaderboard lookups across classrooms. * - * The classroom is resolved from the authenticated user: - * pupils use their current classroom, while teachers use an owned classroom - * resolved by [CurrentUserResolver]. + * The leaderboard is built from classroom-level average total scores and is + * available to authenticated users. */ @Service class LeaderboardService( - private val pupilGameProgressRepository: PupilGameProgressRepository, + private val classroomRepository: ClassroomRepository, private val currentUserResolver: CurrentUserResolver, - private val pupilProfileRepository: PupilProfileRepository, ) { - /** - * Returns leaderboard entries for the authenticated user's classroom. + * Returns leaderboard entries for all classrooms ranked by average total score. * * Entries are sorted so the leaderboard is deterministic. * @@ -30,48 +26,24 @@ class LeaderboardService( * @return classroom leaderboard entries ordered by rank */ @Transactional(readOnly = true) - fun getClassLeaderboardList(currentUser: CurrentUser): List { - val classroom = currentUserResolver.getClassroomByUser(currentUser) - - val progressEntries = pupilGameProgressRepository - .findAllByClassroomIdOrderByTotalScoreDescTotalXpDescCurrentLevelDescLastActivityAtDesc(classroom.id) - - val pupilUserIds = progressEntries.mapNotNull { it.pupil?.id }.toSet() - val displayNamesByUserId = pupilProfileRepository.findAllByUserIdIn(pupilUserIds) - .associateBy({ requireNotNull(it.userId) { "Pupil profile is missing user id" } }, { it.displayName }) - - return progressEntries.mapIndexed { index, progress -> - val pupil = requireNotNull(progress.pupil) { "Leaderboard row is missing pupil relation" } - val pupilUserId = requireNotNull(pupil.id) { "Leaderboard row pupil is missing id" } - - LeaderboardEntry( - rank = index + 1, - pupilUserId = pupilUserId, - displayName = displayNamesByUserId[pupilUserId] ?: pupil.username ?: "Unknown pupil", - totalScore = progress.totalScore, - totalXp = progress.totalXp, - currentLevel = progress.currentLevel, - completedStopsCount = progress.completedStopsCount, - completedTasksCount = progress.completedTasksCount, - finalBossCompleted = progress.finalBossCompleted, - lastActivityAt = progress.lastActivityAt, - ) - } + fun getLeaderboardList(currentUser: CurrentUser): List { + currentUserResolver.requireUser(currentUser.subject) + + return classroomRepository.findAllWithAverageTotalScore() + .mapIndexed { index, classroom -> + LeaderboardEntry( + rank = index + 1, + classroomId = classroom.classroomId, + classroomTitle = classroom.classroomTitle, + averageTotalScore = classroom.averageTotalScore, + ) + } } } -/** - * Internal leaderboard row projection enriched with pupil profile data. - */ data class LeaderboardEntry( val rank: Int, - val pupilUserId: Long, - val displayName: String, - val totalScore: Int, - val totalXp: Int, - val currentLevel: Int, - val completedStopsCount: Int, - val completedTasksCount: Int, - val finalBossCompleted: Boolean, - val lastActivityAt: java.time.Instant, + val classroomId: Long, + val classroomTitle: String, + val averageTotalScore: Double, ) diff --git a/src/test/kotlin/edu/ntnu/idi/idatt/backend/classroom/ClassroomIntegrationTests.kt b/src/test/kotlin/edu/ntnu/idi/idatt/backend/classroom/ClassroomIntegrationTests.kt index 013a1bad..ee96895f 100644 --- a/src/test/kotlin/edu/ntnu/idi/idatt/backend/classroom/ClassroomIntegrationTests.kt +++ b/src/test/kotlin/edu/ntnu/idi/idatt/backend/classroom/ClassroomIntegrationTests.kt @@ -3,6 +3,8 @@ package edu.ntnu.idi.idatt.backend.classroom import com.fasterxml.jackson.databind.json.JsonMapper import edu.ntnu.idi.idatt.backend.classroom.domain.Classroom import edu.ntnu.idi.idatt.backend.classroom.domain.ClassroomStatus +import edu.ntnu.idi.idatt.backend.game.gameProgress.domain.PupilGameProgress +import edu.ntnu.idi.idatt.backend.game.gameProgress.domain.PupilGameProgressId import edu.ntnu.idi.idatt.backend.classroom.infrastructure.ClassroomRepository import edu.ntnu.idi.idatt.backend.game.gameProgress.infrastructure.PupilGameProgressRepository import edu.ntnu.idi.idatt.backend.iam.domain.User @@ -202,6 +204,61 @@ class ClassroomIntegrationTests { } } + @Test + fun `repository returns average total score for all classrooms`() { + val firstClassroom = createClassroom("AVG101") + val secondClassroom = createClassroom("AVG202") + val emptyClassroom = createClassroom("AVG303") + + val firstPupil = userRepository.save(activePupil(username = "avg-first")) + val secondPupil = userRepository.save(activePupil(username = "avg-second")) + val thirdPupil = userRepository.save(activePupil(username = "avg-third")) + + firstClassroom.addPupilMembership(firstPupil) + firstClassroom.addPupilMembership(secondPupil) + secondClassroom.addPupilMembership(thirdPupil) + classroomRepository.saveAll(listOf(firstClassroom, secondClassroom)) + + pupilGameProgressRepository.saveAll( + listOf( + PupilGameProgress( + id = PupilGameProgressId( + pupilUserId = requireNotNull(firstPupil.id), + classroomId = firstClassroom.id, + ), + pupil = firstPupil, + classroom = firstClassroom, + totalScore = 10, + ), + PupilGameProgress( + id = PupilGameProgressId( + pupilUserId = requireNotNull(secondPupil.id), + classroomId = firstClassroom.id, + ), + pupil = secondPupil, + classroom = firstClassroom, + totalScore = 20, + ), + PupilGameProgress( + id = PupilGameProgressId( + pupilUserId = requireNotNull(thirdPupil.id), + classroomId = secondClassroom.id, + ), + pupil = thirdPupil, + classroom = secondClassroom, + totalScore = 30, + ), + ), + ) + + val averages = classroomRepository.findAllWithAverageTotalScore() + + assertEquals(3, averages.size) + assertEquals(15.0, averages.first { it.classroomId == firstClassroom.id }.averageTotalScore) + assertEquals(30.0, averages.first { it.classroomId == secondClassroom.id }.averageTotalScore) + assertEquals(0.0, averages.first { it.classroomId == emptyClassroom.id }.averageTotalScore) + } + private fun createClassroom(classroomCode: String): Classroom { val owner = userRepository.save(activeTeacher(email = "owner-$classroomCode@example.com")) return classroomRepository.save( diff --git a/src/test/kotlin/edu/ntnu/idi/idatt/backend/game/TeacherGamePreviewIntegrationTests.kt b/src/test/kotlin/edu/ntnu/idi/idatt/backend/game/TeacherGamePreviewIntegrationTests.kt index 7c83aa33..6c14f20c 100644 --- a/src/test/kotlin/edu/ntnu/idi/idatt/backend/game/TeacherGamePreviewIntegrationTests.kt +++ b/src/test/kotlin/edu/ntnu/idi/idatt/backend/game/TeacherGamePreviewIntegrationTests.kt @@ -331,7 +331,7 @@ class TeacherGamePreviewIntegrationTests { } @Test - fun `preview leaderboard uses the preview classroom`() { + fun `leaderboard returns ranked classrooms with average total scores`() { val teacher = userRepository.save(activeTeacher("owner@example.com")) val firstClassroom = createClassroom(teacher, "PREVIEW11") val previewClassroom = createClassroom(teacher, "PREVIEW12") @@ -374,9 +374,15 @@ class TeacherGamePreviewIntegrationTests { header(HttpHeaders.AUTHORIZATION, "Bearer ${previewSession.accessToken}") }.andExpect { status { isOk() } - jsonPath("$.entries.length()") { value(1) } - jsonPath("$.entries[0].displayName") { value("leaderboard_preview") } - jsonPath("$.entries[0].totalScore") { value(90) } + jsonPath("$.entries.length()") { value(2) } + jsonPath("$.entries[0].rank") { value(1) } + jsonPath("$.entries[0].classroomId") { value(firstClassroom.id.toInt()) } + jsonPath("$.entries[0].classroomTitle") { value(firstClassroom.title) } + jsonPath("$.entries[0].averageTotalScore") { value(10.0) } + jsonPath("$.entries[1].rank") { value(2) } + jsonPath("$.entries[1].classroomId") { value(previewClassroom.id.toInt()) } + jsonPath("$.entries[1].classroomTitle") { value(previewClassroom.title) } + jsonPath("$.entries[1].averageTotalScore") { value(90.0) } } } diff --git a/src/test/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/LeaderboardIntegrationTests.kt b/src/test/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/LeaderboardIntegrationTests.kt new file mode 100644 index 00000000..1762709e --- /dev/null +++ b/src/test/kotlin/edu/ntnu/idi/idatt/backend/leaderboard/LeaderboardIntegrationTests.kt @@ -0,0 +1,167 @@ +package edu.ntnu.idi.idatt.backend.leaderboard + +import com.fasterxml.jackson.databind.json.JsonMapper +import edu.ntnu.idi.idatt.backend.classroom.domain.Classroom +import edu.ntnu.idi.idatt.backend.classroom.domain.ClassroomStatus +import edu.ntnu.idi.idatt.backend.classroom.infrastructure.ClassroomRepository +import edu.ntnu.idi.idatt.backend.game.gameProgress.domain.PupilGameProgress +import edu.ntnu.idi.idatt.backend.game.gameProgress.domain.PupilGameProgressId +import edu.ntnu.idi.idatt.backend.game.gameProgress.infrastructure.PupilGameProgressRepository +import edu.ntnu.idi.idatt.backend.iam.domain.User +import edu.ntnu.idi.idatt.backend.iam.domain.UserRole +import edu.ntnu.idi.idatt.backend.iam.domain.UserStatus +import edu.ntnu.idi.idatt.backend.iam.infrastructure.RefreshTokenRepository +import edu.ntnu.idi.idatt.backend.iam.infrastructure.UserRepository +import edu.ntnu.idi.idatt.backend.users.avatar.infrastructure.UserAvatarRepository +import edu.ntnu.idi.idatt.backend.users.profile.infrastructure.PupilProfileRepository +import edu.ntnu.idi.idatt.backend.users.profile.infrastructure.TeacherProfileRepository +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.context.SpringBootTest +import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc +import org.springframework.http.HttpHeaders +import org.springframework.http.MediaType +import org.springframework.security.crypto.password.PasswordEncoder +import org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.csrf +import org.springframework.test.web.servlet.MockMvc +import org.springframework.test.web.servlet.get +import org.springframework.test.web.servlet.post + +@SpringBootTest +@AutoConfigureMockMvc +class LeaderboardIntegrationTests { + @Autowired + private lateinit var mockMvc: MockMvc + + @Autowired + private lateinit var userRepository: UserRepository + + @Autowired + private lateinit var classroomRepository: ClassroomRepository + + @Autowired + private lateinit var pupilGameProgressRepository: PupilGameProgressRepository + + @Autowired + private lateinit var refreshTokenRepository: RefreshTokenRepository + + @Autowired + private lateinit var userAvatarRepository: UserAvatarRepository + + @Autowired + private lateinit var pupilProfileRepository: PupilProfileRepository + + @Autowired + private lateinit var teacherProfileRepository: TeacherProfileRepository + + @Autowired + private lateinit var passwordEncoder: PasswordEncoder + + private val jsonMapper = JsonMapper.builder().build() + + @BeforeEach + fun setUp() { + refreshTokenRepository.deleteAll() + pupilGameProgressRepository.deleteAll() + classroomRepository.deleteAll() + userAvatarRepository.deleteAll() + pupilProfileRepository.deleteAll() + teacherProfileRepository.deleteAll() + userRepository.deleteAll() + } + + @Test + fun `teacher can fetch classroom leaderboard`() { + val teacher = userRepository.save(activeTeacher("owner@example.com")) + val firstClassroom = createClassroom(teacher, "LB101") + val secondClassroom = createClassroom(teacher, "LB202") + + val firstPupil = userRepository.save(activePupil("leaderboard_first")) + val secondPupil = userRepository.save(activePupil("leaderboard_second")) + val thirdPupil = userRepository.save(activePupil("leaderboard_third")) + + firstClassroom.addPupilMembership(firstPupil) + firstClassroom.addPupilMembership(secondPupil) + secondClassroom.addPupilMembership(thirdPupil) + classroomRepository.saveAll(listOf(firstClassroom, secondClassroom)) + + pupilGameProgressRepository.saveAll( + listOf( + PupilGameProgress( + id = PupilGameProgressId(requireNotNull(firstPupil.id), firstClassroom.id), + pupil = firstPupil, + classroom = firstClassroom, + totalScore = 10, + ), + PupilGameProgress( + id = PupilGameProgressId(requireNotNull(secondPupil.id), firstClassroom.id), + pupil = secondPupil, + classroom = firstClassroom, + totalScore = 20, + ), + PupilGameProgress( + id = PupilGameProgressId(requireNotNull(thirdPupil.id), secondClassroom.id), + pupil = thirdPupil, + classroom = secondClassroom, + totalScore = 30, + ), + ), + ) + + val accessToken = teacherAccessToken("owner@example.com", "secret123") + + mockMvc.get("/api/v1/leaderboard") { + header(HttpHeaders.AUTHORIZATION, "Bearer $accessToken") + }.andExpect { + status { isOk() } + jsonPath("$.entries.length()") { value(2) } + jsonPath("$.entries[0].rank") { value(1) } + jsonPath("$.entries[0].classroomId") { value(firstClassroom.id.toInt()) } + jsonPath("$.entries[0].classroomTitle") { value(firstClassroom.title) } + jsonPath("$.entries[0].averageTotalScore") { value(15.0) } + jsonPath("$.entries[1].rank") { value(2) } + jsonPath("$.entries[1].classroomId") { value(secondClassroom.id.toInt()) } + jsonPath("$.entries[1].classroomTitle") { value(secondClassroom.title) } + jsonPath("$.entries[1].averageTotalScore") { value(30.0) } + } + } + + private fun teacherAccessToken(email: String, password: String): String = + jsonMapper.readTree( + mockMvc.post("/api/v1/auth/teacher/login") { + with(csrf()) + contentType = MediaType.APPLICATION_JSON + content = """{"email":"$email","password":"$password"}""" + }.andExpect { + status { isOk() } + }.andReturn().response.contentAsString, + ).get("accessToken").asText() + + private fun createClassroom(owner: User, joinCode: String): Classroom = + classroomRepository.save( + Classroom( + ownerTeacherId = requireNotNull(owner.id), + title = "Class $joinCode", + description = "Leaderboard classroom", + joinCode = joinCode, + status = ClassroomStatus.ACTIVE, + ), + ) + + private fun activeTeacher(email: String): User = + User( + email = email, + passwordHash = requireNotNull(passwordEncoder.encode("secret123")), + role = UserRole.TEACHER, + status = UserStatus.ACTIVE, + ) + + private fun activePupil(username: String): User = + User( + username = username, + passwordHash = requireNotNull(passwordEncoder.encode("secret123")), + role = UserRole.PUPIL, + status = UserStatus.ACTIVE, + ) +}