Skip to content
Open
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,17 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/** 이 엔드포인트가 성공하든 실패하든 관리자 작업 기록을 하나 남긴다. */
@Target(ElementType.METHOD) // 메서드에만 붙일 수 있다. 클래스나 필드에 붙이면 컴파일 오류.
@Retention(RetentionPolicy.RUNTIME) // 실행 중에도 남겨 둔다. 빼면 기본값 CLASS가 되어 실행 중에 읽을 수 없고,
// 기록 코드가 항상 null을 받아 아무것도 남지 않는다(오류도 안 난다).
public @interface AdminAction {
/** 무슨 작업인지 */
AdminActionType value();
/** 대상의 식별자를 담은 경로 변수 이름. 예: "requestId" */
String targetId();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog;

public enum AdminActionType {
// 신청 — /api/admin/requests/{requestId}/...
REQUEST_APPROVE(AdminTargetType.REQUEST),
REQUEST_REJECT(AdminTargetType.REQUEST),
REQUEST_MIGRATE(AdminTargetType.REQUEST),
REQUEST_RESTART(AdminTargetType.REQUEST),
CONTAINER_DELETE(AdminTargetType.REQUEST),
CONTAINER_FORCE_COMPLETE(AdminTargetType.REQUEST),

// 사용자 — /api/admin/users/{id}/... , /api/admin/users/{userId}/warnings...
USER_ACTIVATION_CHANGE(AdminTargetType.USER),
USER_ROLE_CHANGE(AdminTargetType.USER),
USER_PASSWORD_RESET(AdminTargetType.USER),
USER_GROUP_REMOVE(AdminTargetType.USER),
UBUNTU_ACCOUNT_DELETE(AdminTargetType.USER),
WARNING_GRANT(AdminTargetType.USER),
WARNING_DEDUCT(AdminTargetType.USER),
WARNING_CANCEL(AdminTargetType.USER),

// 변경 신청 — /api/admin/change-requests/{changeRequestId}/...
CHANGE_REQUEST_APPROVE(AdminTargetType.CHANGE_REQUEST),
CHANGE_REQUEST_REJECT(AdminTargetType.CHANGE_REQUEST),

// Pod — /api/admin/pods/{podName}
ORPHAN_POD_DELETE(AdminTargetType.POD),

// 그룹 탈퇴 신청 — /api/admin/group-leave-requests/{leaveRequestId}/...
GROUP_LEAVE_APPROVE(AdminTargetType.GROUP_LEAVE_REQUEST),
GROUP_LEAVE_REJECT(AdminTargetType.GROUP_LEAVE_REQUEST);

private final AdminTargetType targetType;

AdminActionType(AdminTargetType targetType) {
this.targetType = targetType;
}

public AdminTargetType targetType() {
return targetType;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog;

public enum AdminTargetType {
REQUEST, USER, CHANGE_REQUEST, POD, GROUP_LEAVE_REQUEST
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog.controller;

import DGU_AI_LAB.admin_be.domain.adminActionLog.controller.docs.AdminActionLogApi;
import DGU_AI_LAB.admin_be.domain.adminActionLog.dto.AdminActionLogSearchRequestDTO;
import DGU_AI_LAB.admin_be.domain.adminActionLog.service.AdminActionLogQueryService;
import DGU_AI_LAB.admin_be.global.common.SuccessResponse;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/admin/action-logs")
public class AdminActionLogController implements AdminActionLogApi {

private final AdminActionLogQueryService queryService;

@GetMapping
public ResponseEntity<SuccessResponse<?>> search(@ModelAttribute @Valid AdminActionLogSearchRequestDTO condition) {
return SuccessResponse.ok(queryService.search(condition));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog.controller.docs;

import DGU_AI_LAB.admin_be.domain.adminActionLog.dto.AdminActionLogSearchRequestDTO;
import DGU_AI_LAB.admin_be.global.common.SuccessResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springdoc.core.annotations.ParameterObject;
import org.springframework.http.ResponseEntity;

@Tag(name = "관리자 작업 기록", description = "관리자 작업 기록 조회 API")
public interface AdminActionLogApi {

@Operation(
summary = "관리자 작업 기록 조회",
description = "최신부터 커서 방식으로 돌려줍니다. 대상으로 찾으려면 targetType·targetId 를, 관리자로 찾으려면 "
+ "adminId·from·to 를 줍니다. failedOnly=true 면 실패(4xx·5xx)만 돌려줍니다.다음 페이지는 응답의 nextCursor 를 cursor 로 넘깁니다. "
+ "result 는 상태 코드로 계산한 값(2xx SUCCESS, 4xx REJECTED, 5xx ERROR)이며, 202 로 등록된 비동기 "
+ "작업의 최종 결과는 각 작업의 진행 상태 API 에서 확인합니다."
)
@ApiResponse(responseCode = "200", description = "성공")
@ApiResponse(responseCode = "400", description = "조건이 잘못됨(targetType 없이 targetId, size 범위 밖 등)")
ResponseEntity<SuccessResponse<?>> search(@ParameterObject AdminActionLogSearchRequestDTO condition);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog.dto;

import java.util.List;

/** 최신부터 한 페이지. 다음 페이지는 nextCursor 를 cursor 로 넘겨 받는다. 마지막 페이지면 nextCursor 가 없다. */
public record AdminActionLogPageResponseDTO(List<AdminActionLogResponseDTO> items, Long nextCursor) {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog.dto;

import DGU_AI_LAB.admin_be.domain.adminActionLog.entity.AdminActionLog;
import DGU_AI_LAB.admin_be.domain.adminActionLog.entity.AdminActionResult;
import com.fasterxml.jackson.databind.JsonNode;

import java.time.LocalDateTime;

/** 기록 한 줄. 결과(result)는 저장된 값이 아니라 상태 코드로 계산한 값이다. */
public record AdminActionLogResponseDTO(
Long id,
LocalDateTime createdAt,
String action,
String targetType,
String targetId,
Long adminId,
String adminName,
AdminActionResult result,
int httpStatus,
String errorCode,
String httpMethod,
String requestUri,
JsonNode pathVariables,
JsonNode queryParams,
JsonNode requestBody
) {
public static AdminActionLogResponseDTO of(AdminActionLog log, JsonNode pathVariables, JsonNode queryParams,
JsonNode requestBody) {
return new AdminActionLogResponseDTO(
log.getAdminActionLogId(), log.getCreatedAt(), log.getAction(), log.getTargetType(),
log.getTargetId(), log.getAdminId(), log.getAdminName(), log.result(), log.getHttpStatus(),
log.getErrorCode(), log.getHttpMethod(), log.getRequestUri(),
pathVariables, queryParams, requestBody);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog.dto;

import DGU_AI_LAB.admin_be.domain.adminActionLog.AdminActionType;
import DGU_AI_LAB.admin_be.domain.adminActionLog.AdminTargetType;
import jakarta.validation.constraints.Max;
import jakarta.validation.constraints.Min;
import org.springframework.format.annotation.DateTimeFormat;

import java.time.LocalDateTime;

/**
* 기록 조회 조건. 모두 선택이며 비어 있으면 거르지 않는다.
*
* @param targetId 대상 식별자. targetType 과 함께 써야 한다
* @param from 이 시각 이후(포함)
* @param to 이 시각 이전(미포함)
* @param failedOnly true 면 실패한 요청(http_status 400 이상: REJECTED·ERROR)만
* @param cursor 이전 페이지의 nextCursor
* @param size 한 번에 가져올 건수. 기본 20, 최대 100
*/
public record AdminActionLogSearchRequestDTO(
AdminTargetType targetType,
String targetId,
Long adminId,
AdminActionType action,
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) LocalDateTime from,
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) LocalDateTime to,
Boolean failedOnly,
Long cursor,
@Min(1) @Max(100) Integer size
) {
public static final int DEFAULT_SIZE = 20;

public boolean isFailedOnly() {
return Boolean.TRUE.equals(failedOnly);
}

public int sizeOrDefault() {
return size == null ? DEFAULT_SIZE : size;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog.entity;

import jakarta.persistence.*;
import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import org.hibernate.annotations.Immutable;

import java.time.LocalDateTime;

/**
* 관리자 작업 기록의 한 줄. 쌓기만 하고 고치거나 지우지 않는다 — {@link Immutable}이라 JPA가 UPDATE를 내지 않고,
* 저장소도 저장·조회만 연다. 결과는 저장하지 않고 {@link #result()}가 상태 코드로 계산한다.
* 관리자는 번호와 이름을 그때 값으로 복사해 둔다(외래 키 없음).
*/
@Entity
@Immutable
@Getter
@Table(name = "admin_action_logs", indexes = {
@Index(name = "idx_admin_action_logs_target", columnList = "target_type, target_id, admin_action_log_id"),
@Index(name = "idx_admin_action_logs_admin_created", columnList = "admin_id, created_at")
})
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class AdminActionLog {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "admin_action_log_id")
private Long adminActionLogId;

/** 요청이 들어온 시각. */
@Column(name = "created_at", nullable = false, updatable = false)
private LocalDateTime createdAt;

/** {@code AdminActionType} 이름. */
@Column(name = "action", nullable = false, length = 50)
private String action;

/** {@code AdminTargetType} 이름. */
@Column(name = "target_type", nullable = false, length = 30)
private String targetType;

/** 대상 경로 변수 값. 파드 이름처럼 숫자가 아닐 수 있어 문자열이다. */
@Column(name = "target_id", length = 100)
private String targetId;

@Column(name = "admin_id", nullable = false)
private Long adminId;

@Column(name = "admin_name", nullable = false, length = 100)
private String adminName;

@Column(name = "http_method", nullable = false, length = 10)
private String httpMethod;

@Column(name = "request_uri", nullable = false, length = 500)
private String requestUri;

@Column(name = "http_status", nullable = false)
private int httpStatus;

/** 실패 응답의 {@code code}. 성공이면 없다. */
@Column(name = "error_code", length = 64)
private String errorCode;

@Column(name = "path_variables", columnDefinition = "longtext")
private String pathVariables;

/** 가린 뒤의 쿼리 파라미터. */
@Column(name = "query_params", columnDefinition = "longtext")
private String queryParams;

/** 가린 뒤의 요청 본문. 본문이 없거나 객체로 읽지 못했으면 없다. */
@Column(name = "request_body", columnDefinition = "longtext")
private String requestBody;

@Builder
private AdminActionLog(LocalDateTime createdAt, String action, String targetType, String targetId,
Long adminId, String adminName, String httpMethod, String requestUri,
int httpStatus, String errorCode,
String pathVariables, String queryParams, String requestBody) {
this.createdAt = createdAt;
this.action = action;
this.targetType = targetType;
this.targetId = targetId;
this.adminId = adminId;
this.adminName = adminName;
this.httpMethod = httpMethod;
this.requestUri = requestUri;
this.httpStatus = httpStatus;
this.errorCode = errorCode;
this.pathVariables = pathVariables;
this.queryParams = queryParams;
this.requestBody = requestBody;
}

public AdminActionResult result() {
return AdminActionResult.of(httpStatus);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog.entity;

/**
* 기록 한 줄의 결과. 저장하지 않고 상태 코드로 계산한다.
*
* <pre>
* 2xx → SUCCESS (202도 여기. 비동기 작업은 "등록까지 성공"이며 최종 결과는 기존 진행 상태 API로 본다)
* 4xx → REJECTED (요청이 규칙에 막힘. 사유는 error_code)
* 5xx → ERROR (서버 쪽 오류)
* </pre>
*/
public enum AdminActionResult {
SUCCESS, REJECTED, ERROR;

public static AdminActionResult of(int httpStatus) {
if (httpStatus >= 500) {
return ERROR;
}
if (httpStatus >= 400) {
return REJECTED;
}
return SUCCESS;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package DGU_AI_LAB.admin_be.domain.adminActionLog.repository;

import DGU_AI_LAB.admin_be.domain.adminActionLog.entity.AdminActionLog;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.query.Param;

import java.time.LocalDateTime;
import java.util.List;

/**
* 기록은 저장과 조회만 연다. {@code JpaRepository}를 쓰지 않아 delete·saveAll 같은 메서드가 아예 없다.
*/
public interface AdminActionLogRepository extends Repository<AdminActionLog, Long> {

AdminActionLog save(AdminActionLog log);

/**
* 최신부터 커서 방식으로 읽는다. {@code cursor}보다 작은 번호만, {@code pageable}의 건수만큼.
* 조건은 비어 있으면 거르지 않는다. {@code minStatus}를 400으로 주면 실패(4xx·5xx)만 나온다.대상으로 찾을 때는 (target_type, target_id),
* 관리자로 찾을 때는 (admin_id, created_at) 인덱스를 탄다.
*/
@Query("""
select l from AdminActionLog l
where (:targetType is null or l.targetType = :targetType)
and (:targetId is null or l.targetId = :targetId)
and (:adminId is null or l.adminId = :adminId)
and (:action is null or l.action = :action)
and (:from is null or l.createdAt >= :from)
and (:to is null or l.createdAt < :to)
and (:minStatus is null or l.httpStatus >= :minStatus)
and (:cursor is null or l.adminActionLogId < :cursor)
order by l.adminActionLogId desc
""")
List<AdminActionLog> search(@Param("targetType") String targetType,
@Param("targetId") String targetId,
@Param("adminId") Long adminId,
@Param("action") String action,
@Param("from") LocalDateTime from,
@Param("to") LocalDateTime to,
@Param("minStatus") Integer minStatus,
@Param("cursor") Long cursor,
Pageable pageable);
}
Loading
Loading