Skip to content

114 학생 활동 상세 조회 api 개발 #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Nov 12, 2023
Merged

114 학생 활동 상세 조회 api 개발 #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
eadca2e
create :: student activity detail response
KimTaeO Nov 10, 2023
0e754ed
add :: student activity detail response
KimTaeO Nov 10, 2023
fa09e24
add :: 주석 추가
KimTaeO Nov 10, 2023
fe05ac5
add :: student activity detail controller
KimTaeO Nov 10, 2023
9d1834e
add :: security config
KimTaeO Nov 10, 2023
697aaf5
add :: 에러 로그에 학생 활동 id
KimTaeO Nov 10, 2023
3148dff
update :: 트랜잭션 속성 readOnly true
KimTaeO Nov 10, 2023
40dff6d
update :: response 클래스명 통일
KimTaeO Nov 10, 2023
427d8e2
add :: else일 경우 처리
KimTaeO Nov 10, 2023
0de932d
update :: else문 대체
KimTaeO Nov 10, 2023
3d2abb0
Update bitgouel-api/src/main/kotlin/team/msg/domain/student/service/S…
KimTaeO Nov 11, 2023
57e8c99
Merge branch 'master' of https://github.com/GSM-MSG/Bitgouel-Server i…
KimTaeO Nov 11, 2023
8996998
Merge branch '114-feat/student-activity-detail-api' of https://github…
KimTaeO Nov 11, 2023
a19ccb7
update :: forbiddenStudentActivity로 변경
KimTaeO Nov 11, 2023
e271f52
chore :: detail -> details
KimTaeO Nov 12, 2023
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
13 changes: 10 additions & 3 deletions ...uel-api/src/main/kotlin/team/msg/domain/student/presentation/StudentActivityController.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController
import team.msg.domain.student.mapper.StudentActivityMapper
import team.msg.domain.student.presentation.data.response.AllStudentActivitiesResponse
import team.msg.domain.student.presentation.data.response.StudentActivitiesByStudentResponse
import team.msg.domain.student.presentation.data.response.StudentActivitiesResponse
import team.msg.domain.student.presentation.data.response.StudentActivityDetailsResponse
import team.msg.domain.student.presentation.data.web.CreateStudentActivityWebRequest
import team.msg.domain.student.presentation.data.web.UpdateStudentActivityWebRequest
import team.msg.domain.student.service.StudentActivityService
Expand Down Expand Up @@ -65,14 +66,20 @@ class StudentActivityController(
}

@GetMapping("/{student_id}")
fun queryStudentActivitiesByStudent(@PathVariable("student_id") studentId: UUID, pageable: Pageable): ResponseEntity<StudentActivitiesByStudentResponse> {
fun queryStudentActivitiesByStudent(@PathVariable("student_id") studentId: UUID, pageable: Pageable): ResponseEntity<StudentActivitiesResponse> {
val response = studentActivityService.queryStudentActivitiesByStudent(studentId, pageable)
return ResponseEntity.status(HttpStatus.OK).body(response)
}

@GetMapping("/my")
fun queryMyStudentActivities(pageable: Pageable): ResponseEntity<StudentActivitiesByStudentResponse> {
fun queryMyStudentActivities(pageable: Pageable): ResponseEntity<StudentActivitiesResponse> {
val response = studentActivityService.queryMyStudentActivities(pageable)
return ResponseEntity.status(HttpStatus.OK).body(response)
}

@GetMapping("/{id}/detail")
fun queryStudentActivityDetail(@PathVariable id: UUID): ResponseEntity<StudentActivityDetailsResponse> {
val response = studentActivityService.queryStudentActivityDetail(id)
return ResponseEntity.status(HttpStatus.OK).body(response)
}
}
21 changes: 20 additions & 1 deletion ...main/kotlin/team/msg/domain/student/presentation/data/response/StudentActivityResponse.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import org.springframework.data.domain.Page
import team.msg.common.enums.ApproveStatus
import team.msg.domain.student.model.StudentActivity
import team.msg.domain.user.model.User
import java.time.LocalDateTime
import java.util.*

data class StudentActivityResponse(
Expand All @@ -25,13 +26,31 @@ data class StudentActivityResponse(
)
}

fun detailOf(studentActivity: StudentActivity): StudentActivityDetailsResponse =
StudentActivityDetailsResponse(
id = studentActivity.id,
title = studentActivity.title,
content = studentActivity.content,
credit = studentActivity.credit,
activityDate = studentActivity.activityDate,
modifiedAt = studentActivity.modifiedAt
)
}
}

data class AllStudentActivitiesResponse(
val activities: Page<StudentActivityResponse>
)

data class StudentActivitiesByStudentResponse(
data class StudentActivitiesResponse(
val activities: Page<StudentActivityResponse>
)

data class StudentActivityDetailsResponse(
val id: UUID,
val title: String,
val content: String,
val credit: Int,
val activityDate: LocalDateTime,
val modifiedAt: LocalDateTime
)
8 changes: 5 additions & 3 deletions bitgouel-api/src/main/kotlin/team/msg/domain/student/service/StudentActivityService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ import org.springframework.data.domain.Pageable
import team.msg.domain.student.presentation.data.request.CreateStudentActivityRequest
import team.msg.domain.student.presentation.data.request.UpdateStudentActivityRequest
import team.msg.domain.student.presentation.data.response.AllStudentActivitiesResponse
import team.msg.domain.student.presentation.data.response.StudentActivitiesByStudentResponse
import team.msg.domain.student.presentation.data.response.StudentActivitiesResponse
import team.msg.domain.student.presentation.data.response.StudentActivityDetailsResponse
import java.util.*

interface StudentActivityService {
Expand All @@ -14,6 +15,7 @@ interface StudentActivityService {
fun rejectStudentActivity(id: UUID)
fun approveStudentActivity(id: UUID)
fun queryAllStudentActivities(pageable: Pageable): AllStudentActivitiesResponse
fun queryStudentActivitiesByStudent(studentId: UUID, pageable: Pageable): StudentActivitiesByStudentResponse
fun queryMyStudentActivities(pageable: Pageable): StudentActivitiesByStudentResponse
fun queryStudentActivitiesByStudent(studentId: UUID, pageable: Pageable): StudentActivitiesResponse
fun queryMyStudentActivities(pageable: Pageable): StudentActivitiesResponse
fun queryStudentActivityDetail(id: UUID): StudentActivityDetailsResponse
}
49 changes: 44 additions & 5 deletions bitgouel-api/src/main/kotlin/team/msg/domain/student/service/StudentActivityServiceImpl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,26 @@ import org.springframework.stereotype.Service
import org.springframework.transaction.annotation.Transactional
import team.msg.common.enums.ApproveStatus
import team.msg.common.util.UserUtil
import team.msg.domain.bbozzak.model.Bbozzak
import team.msg.domain.company.model.CompanyInstructor
import team.msg.domain.government.model.Government
import team.msg.domain.professor.model.Professor
import team.msg.domain.student.event.UpdateStudentActivityEvent
import team.msg.domain.student.exception.ForbiddenStudentActivityException
import team.msg.domain.student.exception.StudentActivityNotFoundException
import team.msg.domain.student.exception.StudentNotFoundException
import team.msg.domain.student.model.Student
import team.msg.domain.student.model.StudentActivity
import team.msg.domain.student.presentation.data.request.CreateStudentActivityRequest
import team.msg.domain.student.presentation.data.request.UpdateStudentActivityRequest
import team.msg.domain.student.presentation.data.response.AllStudentActivitiesResponse
import team.msg.domain.student.presentation.data.response.StudentActivitiesByStudentResponse
import team.msg.domain.student.presentation.data.response.StudentActivitiesResponse
import team.msg.domain.student.presentation.data.response.StudentActivityDetailsResponse
import team.msg.domain.student.presentation.data.response.StudentActivityResponse
import team.msg.domain.student.repository.StudentActivityRepository
import team.msg.domain.student.repository.StudentRepository
import team.msg.domain.teacher.exception.TeacherNotFoundException
import team.msg.domain.teacher.model.Teacher
import team.msg.domain.teacher.repository.TeacherRepository
import java.util.*

Expand Down Expand Up @@ -186,7 +193,7 @@ class StudentActivityServiceImpl(
* @param 학생활동을 조회하기 위한 학생 id 및 페이징을 처리하기 위한 pageable
*/
@Transactional(readOnly = true)
override fun queryStudentActivitiesByStudent(studentId: UUID, pageable: Pageable): StudentActivitiesByStudentResponse {
override fun queryStudentActivitiesByStudent(studentId: UUID, pageable: Pageable): StudentActivitiesResponse {
val user = userUtil.queryCurrentUser()

val student = studentRepository.findStudentById(studentId)
Expand All @@ -200,7 +207,7 @@ class StudentActivityServiceImpl(

val studentActivities = studentActivityRepository.findAllByStudent(student, pageable)

val response = StudentActivitiesByStudentResponse(
val response = StudentActivitiesResponse(
StudentActivityResponse.pageOf(studentActivities, student.user!!)
)

Expand All @@ -212,19 +219,51 @@ class StudentActivityServiceImpl(
* @param 페이징을 처리하기 위한 pageable
*/
@Transactional(readOnly = true)
override fun queryMyStudentActivities(pageable: Pageable): StudentActivitiesByStudentResponse {
override fun queryMyStudentActivities(pageable: Pageable): StudentActivitiesResponse {
val user = userUtil.queryCurrentUser()

val student = studentRepository.findByUser(user)
?: throw StudentNotFoundException("학생을 찾을 수 없습니다. info : [ userId = ${user.id}, username = ${user.name} ]")

val studentActivities = studentActivityRepository.findAllByStudent(student, pageable)

val response = StudentActivitiesByStudentResponse(
val response = StudentActivitiesResponse(
StudentActivityResponse.pageOf(studentActivities, user)
)

return response
}

/**
* 학생 활동의 상세 정보를 조회하는 비즈니스 로직
* @param 학생 활동을 조회하기 위한 id
*/
@Transactional(readOnly = true)
override fun queryStudentActivityDetail(id: UUID): StudentActivityDetailsResponse {
val user = userUtil.queryCurrentUser()

val entity = userUtil.getAuthorityEntityAndOrganization(user).first

val studentActivity = studentActivityRepository.findByIdOrNull(id)
?: throw StudentActivityNotFoundException("학생 활동을 찾을 수 없습니다. info : [ studentActivityId = $id ]")

when(entity) {
is Student -> {
if(entity != studentActivity.student)
throw ForbiddenStudentActivityException("해당 학생 활동에 대한 권한이 없습니다. info : [ userId = ${user.id} ]")
}
is Teacher -> {
if(entity != studentActivity.teacher)
throw ForbiddenStudentActivityException("해당 학생 활동에 대한 권한이 없습니다. info : [ userId = ${user.id} ]")
}
Comment on lines +250 to +258
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

else일때도 처리해줘야하지 않을까요?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

else 분기도 처리하였는데 검증로직이 따로 필요 없는 어드민의 경우에는 아무것도 수행하지 않도록 하였는데 어떻게 처리할지 좋은 생각이 있으시다면 피드백 부탁드립니다
427d8e2

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

else일때 말고 그럼 GOVERNMENT, COMPANY_INSTRUCTOR .... -> forbidden 이런식으로 가도 되고 when 대신 assert나 require, check 사용해서 해결해도 될거같네요

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0de932d
변경했는데 현재 InvalidRoleException이 401에러를 띄워주고 있는 상태인데 403이 더 적절한 상태코드 인것 같아서 수정하려고 하는데 괜찮을까요

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

InvalidRoleException을 던지는 것 보단 ForbiddenStudentActivityException을 던지는게 맞지 않을까 싶어요

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

변경했습니다
a19ccb7

is Bbozzak,
is Professor,
is CompanyInstructor,
is Government -> throw ForbiddenStudentActivityException("유효하지 않은 권한입니다. info : [ userAuthority = ${user.authority} ]")
}

val response = StudentActivityResponse.detailOf(studentActivity)

return response
}
}
1 change: 1 addition & 0 deletions bitgouel-api/src/main/kotlin/team/msg/global/security/SecurityConfig.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ class SecurityConfig(
.mvcMatchers(HttpMethod.GET, "/activity").hasRole(ADMIN)
.mvcMatchers(HttpMethod.GET, "/activity/my").hasRole(STUDENT)
.mvcMatchers(HttpMethod.GET, "/activity/{student_id}").hasRole(TEACHER)
.mvcMatchers(HttpMethod.GET, "/activity/{id}/detail").hasAnyRole(STUDENT, TEACHER, ADMIN)

// lecture
.mvcMatchers(HttpMethod.POST, "/lecture").hasAnyRole(PROFESSOR, COMPANY_INSTRUCTOR, GOVERNMENT)
Expand Down