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
@@ -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
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -21,4 +22,29 @@ interface ClassroomRepository : JpaRepository<Classroom, Long> {
* 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<ClassroomAverageTotalScoreView>
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,9 @@ fun List<LeaderboardEntry>.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,
)
},
)
Original file line number Diff line number Diff line change
Expand Up @@ -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()
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
package edu.ntnu.idi.idatt.backend.leaderboard.api

import java.time.Instant

/**
* Response payload for a classroom leaderboard.
*
Expand All @@ -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,
)
Original file line number Diff line number Diff line change
@@ -1,77 +1,49 @@
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.
*
* @param currentUser authenticated principal from the access token
* @return classroom leaderboard entries ordered by rank
*/
@Transactional(readOnly = true)
fun getClassLeaderboardList(currentUser: CurrentUser): List<LeaderboardEntry> {
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<LeaderboardEntry> {
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,
)
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down Expand Up @@ -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) }
}
}

Expand Down
Loading