Feat/#51 로그 관련 도메인와 로그 API 요청의 필드명 변경 #53

miiiinju1 · 2024-08-14T11:29:36Z

🚀 작업 내용

로그 관련 엔티티와 DTO의 필드명 변경
UUID 변환 유틸리티 클래스 추가, 그리고 application_id를 appKey로 변경하는 작업 수행

📸 이슈 번호

close [🛠 REFACT] Log 도메인 컬럼 이름 변경 #51

👀 Focus Commits [Optional]

ac1b255, cd4a25e : UUID를 DB예 binary를 저장할 때 이용할 util클래스를 만들었습니다.

✍ 궁금한 점

중점적으로 봐줄 내용
변수명 괜찮나요
로직이 좀 더럽나요
가독성이 좀 그런가요?

- CreateLogRequest - logLevel -> level - logData -> data - CreateLogServiceRequest - logLevel -> level - logData -> data - Log - logData -> data - 필드 변경에 따른 테스트 코드 수정

UUID 문자열과 byte 배열 간의 변환을 위한 UUIDUtil 클래스를 구현했습니다. - uuidStringToBytes: UUID 문자열을 byte 배열로 변환 - bytesToUuidString: byte 배열을 UUID 문자열로 변환

UUID 변환을 검증하기 위한 UUIDUtilTest 클래스 생성: - uuidToBytes_ShouldConvertUUIDStringToByteArray: UUID 문자열을 byte 배열로 변환하는 것을 검증 - bytesToUUIDString_ShouldConvertByteArrayToUUIDString: byte 배열을 UUID 문자열로 변환하는 것을 검증

- CreateLogServiceRequest applicationId -> appKey로 변경 - Log 도메인 객체에서 applicationId -> appKey - LogController app-id -> appKey로 변경, Validation NotBlank로 변경 - LogSerivce에서 applicationId -> appKey로 변경 - 관련 테스트 변경

github-actions · 2024-08-14T11:30:28Z

Risk Level 2 - /home/runner/work/Team5-Guys/Team5-Guys/logbat/src/main/java/info/logbat/domain/project/application/AppService.java

The new methods for creating and retrieving apps are well-structured. Ensure that the appType is validated before processing. Example:

if (appTypeStr == null || appTypeStr.isBlank()) {
    throw new IllegalArgumentException(\"appType cannot be null or empty\");
}

Risk Level 2 - /home/runner/work/Team5-Guys/Team5-Guys/logbat/src/main/java/info/logbat/domain/log/application/LogService.java

Consider validating the input parameters (appKey, level, data, timestamp) before creating the Log object to prevent potential NullPointerExceptions. Example:

if (appKey == null || appKey.isBlank()) {
    throw new IllegalArgumentException(\"appKey cannot be null or empty\");
}

Risk Level 2 - /home/runner/work/Team5-Guys/Team5-Guys/logbat/src/main/java/info/logbat/domain/log/domain/Log.java

The validation methods for appKey and timestamp are good. Ensure that the level and data are also validated to prevent invalid states. Example:

if (level == null || level.isBlank()) {
    throw new IllegalArgumentException(\"level cannot be null or empty\");
}

🛠️✅⚠️

Powered by Code Review GPT

tidavid1

리뷰 확인해주세요 :D

전반적인 코드는 좋았습니다!

tidavid1 · 2024-08-14T13:17:06Z

logbat/src/main/java/info/logbat/common/util/UUIDUtil.java

+    ByteBuffer bb = ByteBuffer.wrap(new byte[UUID_BYTE_LENGTH]);
+    bb.putLong(uuid.getMostSignificantBits());
+    bb.putLong(uuid.getLeastSignificantBits());
+    return bb.array();


bb 보다는 byteBuffer로 사용하는게 더 직관적일 것 같아요! :D

tidavid1 · 2024-08-14T13:18:47Z

logbat/src/main/java/info/logbat/domain/log/presentation/LogController.java

성공 실패 응답만 주면 되니까 201로 주는건 어떨까요?

반영하겠습니다~

노션 API 문서도 업데이트 했습니다~

logbat/src/test/java/info/logbat/common/util/UUIDUtilTest.java

tidavid1 · 2024-08-14T13:19:39Z

logbat/src/test/java/info/logbat/common/util/UUIDUtilTest.java

+    assertThat(bytes).isNotNull();
+    assertThat(bytes.length).isEqualTo(16);
+    assertThat(bytes).isEqualTo(expectedBytes);


assertAll() 로 묶는것은 어떨까요?!

tidavid1

고칠 것을 믿고 어풉 냄겨둡니당 :D

LuizyHub · 2024-08-14T15:59:19Z

logbat/src/main/java/info/logbat/domain/log/presentation/LogController.java

@@ -23,16 +23,15 @@ public class LogController {

  @PostMapping


Suggested change

@PostMapping

@PostMapping

LuizyHub

승인입니다!! 제가 드린 제안도한번 생각해봐주시면 감사하겠습니다~

LuizyHub · 2024-08-14T16:00:55Z

logbat/src/main/java/info/logbat/domain/log/presentation/LogController.java

@@ -23,16 +23,15 @@ public class LogController {

  @PostMapping


이렇게 응답 status를 정하는건 어떤가요?
해당 API는 성공했을때 201을 보내야 하니 응답 코드에 대한 명시가 함수 내부에 있는것 보다 함수 정의 바로 위에 있는면이 개인적으로 더 보기 좋다고 생각해서 제안드립니다!

Suggested change

@PostMapping

@PostMapping

@ResponseStatus(HttpStatus.CREATED)

이렇게 하면 함수 리턴타입을 void로 해야할 것 같아요

반영했어요!!

LuizyHub · 2024-08-14T16:13:31Z

logbat/src/main/java/info/logbat/domain/log/domain/Log.java

-    if (applicationId == null) {
-      throw new IllegalArgumentException("applicationId는 null이 될 수 없습니다.");
+  private void validateAppKey(String appKey) {
+    if (appKey == null || appKey.isBlank()) {


저도 항상 고민인 부분인데, 컨트롤러에서도 이것에 대한 검사를 하는것 같아서 두번해도 괜찮나 생각듭니다...!
각자 맡아야 할 책임이 달라서 두군데 모두 있는면이 자연스럽다고 생각합니다!

* refactor: 로그 레벨, 데이터 컬럼명 변경 - CreateLogRequest - logLevel -> level - logData -> data - CreateLogServiceRequest - logLevel -> level - logData -> data - Log - logData -> data - 필드 변경에 따른 테스트 코드 수정 * feat: UUID와 byte 배열 변환을 위한 UUIDUtil 클래스 추가 UUID 문자열과 byte 배열 간의 변환을 위한 UUIDUtil 클래스를 구현했습니다. - uuidStringToBytes: UUID 문자열을 byte 배열로 변환 - bytesToUuidString: byte 배열을 UUID 문자열로 변환 * test: UUID 변환을 검증하는 UUIDUtilTest 클래스 추가 UUID 변환을 검증하기 위한 UUIDUtilTest 클래스 생성: - uuidToBytes_ShouldConvertUUIDStringToByteArray: UUID 문자열을 byte 배열로 변환하는 것을 검증 - bytesToUUIDString_ShouldConvertByteArrayToUUIDString: byte 배열을 UUID 문자열로 변환하는 것을 검증 * refactor: application_id를 appKey로 변경 - CreateLogServiceRequest applicationId -> appKey로 변경 - Log 도메인 객체에서 applicationId -> appKey - LogController app-id -> appKey로 변경, Validation NotBlank로 변경 - LogSerivce에서 applicationId -> appKey로 변경 - 관련 테스트 변경 * refactor: UUIDUtil final 클래스로 변경, 기본 생성자 Private 추가 * feat: LogController 201 반환하도록 변경 * chore: bb -> byteBuffer로 변경 * test: Displayname 추가 * test: created로 response가 변경됨에 따라 테스트코드 변경 * test: 여러 개의 assertThat을 assertAll로 묶음 * refactor: Response 상태 코드를 어노테이션으로 처리 후 리턴 타입으로 void로 수정

miiiinju1 added 5 commits August 14, 2024 19:33

refactor: 로그 레벨, 데이터 컬럼명 변경

a2a77ab

- CreateLogRequest - logLevel -> level - logData -> data - CreateLogServiceRequest - logLevel -> level - logData -> data - Log - logData -> data - 필드 변경에 따른 테스트 코드 수정

feat: UUID와 byte 배열 변환을 위한 UUIDUtil 클래스 추가

cd4a25e

UUID 문자열과 byte 배열 간의 변환을 위한 UUIDUtil 클래스를 구현했습니다. - uuidStringToBytes: UUID 문자열을 byte 배열로 변환 - bytesToUuidString: byte 배열을 UUID 문자열로 변환

refactor: UUIDUtil final 클래스로 변경, 기본 생성자 Private 추가

ac1b255

miiiinju1 requested a review from a team August 14, 2024 11:29

miiiinju1 self-assigned this Aug 14, 2024

miiiinju1 added ⭐️ Feat 새로운 기능이나 요청 🔄 Refactor 코드 리팩토링 labels Aug 14, 2024

tidavid1 reviewed Aug 14, 2024

View reviewed changes

tidavid1 requested a review from LuizyHub August 14, 2024 13:21

miiiinju1 added 2 commits August 14, 2024 23:25

feat: LogController 201 반환하도록 변경

5fb8113

chore: bb -> byteBuffer로 변경

e44b77a

tidavid1 approved these changes Aug 14, 2024

View reviewed changes

miiiinju1 added 3 commits August 14, 2024 23:27

test: Displayname 추가

a07a86c

test: created로 response가 변경됨에 따라 테스트코드 변경

b70a3ff

test: 여러 개의 assertThat을 assertAll로 묶음

8d54562

LuizyHub reviewed Aug 14, 2024

View reviewed changes

LuizyHub approved these changes Aug 14, 2024

View reviewed changes

refactor: Response 상태 코드를 어노테이션으로 처리 후 리턴 타입으로 void로 수정

511f16d

miiiinju1 merged commit a1099c1 into dev Aug 15, 2024
1 check passed

miiiinju1 deleted the feat/#51 branch August 15, 2024 00:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/#51 로그 관련 도메인와 로그 API 요청의 필드명 변경 #53

Feat/#51 로그 관련 도메인와 로그 API 요청의 필드명 변경 #53

miiiinju1 commented Aug 14, 2024 •

edited

Loading

github-actions bot commented Aug 14, 2024 •

edited

Loading

tidavid1 left a comment

tidavid1 Aug 14, 2024

tidavid1 Aug 14, 2024

miiiinju1 Aug 14, 2024

LuizyHub Aug 14, 2024

tidavid1 Aug 14, 2024

tidavid1 left a comment

LuizyHub Aug 14, 2024

LuizyHub left a comment

LuizyHub Aug 14, 2024

LuizyHub Aug 14, 2024

miiiinju1 Aug 15, 2024

LuizyHub Aug 14, 2024

		@@ -23,16 +23,15 @@ public class LogController {

		@PostMapping

Feat/#51 로그 관련 도메인와 로그 API 요청의 필드명 변경 #53

Feat/#51 로그 관련 도메인와 로그 API 요청의 필드명 변경 #53

Conversation

miiiinju1 commented Aug 14, 2024 • edited Loading

🚀 작업 내용

📸 이슈 번호

👀 Focus Commits [Optional]

✍ 궁금한 점

github-actions bot commented Aug 14, 2024 • edited Loading

Powered by Code Review GPT

tidavid1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tidavid1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LuizyHub left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miiiinju1 commented Aug 14, 2024 •

edited

Loading

github-actions bot commented Aug 14, 2024 •

edited

Loading