ca1af / sbug Goto Github PK

문서

개선해야 할 부분만 정리하였습니다😄

• 역할분담, 마일스톤 등의 프로젝트 일정관리에 대한 계획을 추가해야 함
• 추가 선택 기능에서 MSA는 고려하지 않는 게 좋음. (개발 복잡도가 높아지고 정해진 시간 내에 구현 하기 쉽지 않다.)

추가적으로 다른 조의 SA를 보고 피드백을 받았던 것들 중 참고할만한 사항들을 정리했습니다.

• Redis 사용하여 로그아웃 기능
• 검색/정렬 기능
• 쿠폰, 기프트 카드의 동시성 문제 + 배포 기간 중의 대규모 트래픽 고려하는 문제
• 용어집을 정리하여 개발, 회의 때 사용하기 (한국어, 영어, 설명순)
• PR 작성 시 Approve가 과반수가 되면 Merge 되도록 하기

Login Test 성공

그러나 Register Schedule 리퀘스트를 보내자 400 응답
detail에 Failed to read request라 되어 있어서 request 형식의 문제라 생각해
RequestDto가 날짜를 받는 형식을 바꿔봤으나 결과는 같습니다.

로그를 보면 AccessToken은 로그인때 받은대로 다시 전달이 된거 같습니다. 저 문구 전후로 select * from user 쿼리가 나갑니다

마지막 로그 메세지는 WebSocket 관련입니다.

App 구동을 멈추고 gradle clean 후 다시 gradle compileJava (소스코드 컴파일) 했을 때 로그입니다.
컴파일은 잘 되는데 WebSocketSecurityConfig에서 deprecated API를 쓰고 있다는 메세지가 뜹니다.

혹시 웹소켓 쪽의 수정사항이 develop branch에 반영 안된 것이 있는걸까요?
웹소켓이 Schedule entity쪽이랑 전혀 관련이 없을것 같은데 로그 메세지에 웹소켓이 자꾸 언급됩니다.
(develop branch에서 merge 받은후 바로 feat/schedule 브랜치에서 작업했습니다.)

위 문제로 EntityManagerFactory 가 해당 Q클래스의 근원이 되는 Entity의 Path를 찾지 못하고 있습니다.

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'entityManagerFactory' defined in class path resource [org/springframework/boot/autoconfigure/orm/jpa/HibernateJpaConfiguration.class]: com/sparta/sbug/chatroom/entity/ChatRoom

에러 메시지 입니다.

Error creating bean with name 'entityManagerFactory' ...
com/sparta/sbug/chatroom/entity/ChatRoom

간략한 버전입니다. 해결책 찾고 있습니다.

응답값(String)은 잘 옵니다.

헤더에 Key값 (Authorization)도 잘 오지만, value가 null로 오고 있는 상황입니다.

• ChatRoom ⬅️(One 양방향 Many)➡️ UserChatRoom ⬅️(Many 양방향 One)-- User
• Chat(Message) ➡️ UserChatRoom
  (단방향 ManyToOne)

초기 설계시 이렇게 네 데이터가 연관 관계를 맺도록 하였으나
두 유저가 주고 받은 메세지들을 조회하거나, 두 유저의 채팅방을 찾는 쿼리를 작성하고 보니
Depth가 2 이상인 Join과 Sub Query를 동시에 사용해야 해서 굉장히 복잡하고 비효율적인 쿼리가 수행됐었습니다.

그래서 구조적으로 다음과 같이 수정하여 더 간단하고 효율적인 쿼리를 작성할 수 있었습니다.

• Chat ➡️ User
  (단방향 ManyToOne)

ChatRoom과 UserChatRoom은 필요가 없어져 삭제하였고
Chat 엔터티는 receiver와 sender 두 가지 유저를 속성으로 갖게 되었습니다.

1. Batchsize 만큼의 in절이 날아간다.
2. delete 쿼리의 개수만큼 같은 내용의 select 쿼리가 나간다.
   UserChannelUpperLayerService 부분에서 문제가 발생 중입니다. ChannelController 에서 참조하는 매서드입니다.

    private ChatResponseDto(Chat chat) {
        this.id = chat.getId();
        this.sender = chat.getSender().getNickname();
        this.message = chat.getMessage();
        this.receiver = chat.getReceiver().getNickname();
        this.status = chat.getStatus().toString();
    }
    public static ChatResponseDto of(Chat chat){
        return new ChatResponseDto(chat);
    }

위와 같은 형태로 생성자는 private 하게 막아두고, public한 스태틱 매서드를 오픈합니다.

401 에러가 나오는 상황이고, 브레이크 포인트 여러군데 찍어봐도 해결이 안 되고 있는 상황이라서 월요일 튜터님 오시면 해결해놓겠습니다. 현재 디벨롭 브랜치에서는 WebSecurityConfig 부분 주석처리가 되어있어서 정상적으로 테스트 가능하실 것 같습니다. 안되는 부분은 이슈로 남겨주시면 확인하는대로 해결하겠습니다!

환경 변수는 다음과 같이 설정합니다.

로그인하는 HTTP Request의 Test에 아래와 같이 입력해주세요

const responseJson = pm.response.json();
pm.environment.set('atk', responseJson.atk);
pm.environment.set('rtk', responseJson.rtk);

값이 필요한 Request의 Header에 다음과 같이 입력해주시면 됩니다.

Authorization {{atk}}
RTK {{rtk}}

코드 컨벤션

1. 가독성을 최우선으로 합니다.
2. 다른 이유가 없다면 기본적으로 통합 개발 환경(intelliJ)의 자동 서식을 따릅니다.
   • Window: ctrl + alt + L
   • MAC: Option + Cmd + L
3. [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) 를 참고하여 아래와 같은 규칙을 작성하였습니다.

• 규칙

  • 줄 바꿈은 여러 OS 환경을 고려하여 다음과 같이 작성합니다.

    System.lineSeparator();

  • 탭(tab)은 IntelliJ의 기본 값을 사용하거나 띄어쓰기 4칸을 사용합니다.

  • 중괄호{} 는 본문이 비어 있거나 단일 문만 포함하는 경우에도 반드시 사용됩니다.

    if (count == 0) { 
    	system.out.println("is Zero") 
    }

    또한 중괄호 블록은 Kernighan 및 Ritchie 스타일(이집트 대괄호)을 따릅니다.

    • 여는 중괄호 앞에는 줄 바꿈이 없습니다.

    • 여는 중괄호 뒤에 줄 바꿈

    • 닫는 중괄호 앞의 줄 바꿈

    • 닫는 중괄호 뒤의 줄 바꿈은 해당 중괄호가 명령문을 종료하거나 메서드, 생성자 또는 명명된 클래스의 본문을 종료하는 경우에만 해당됩니다.

      예) if … else

    • 빈 블록은 간결할 수 있습니다.

      void doNothing() { }

  • 클래스 내용과 순서는 논리적 순서를 사용합니다. 순서에 대한 설명을 요청 시 작성자가 설명할 수 있어야 합니다.

    예) 새로운 메서드는 클래스의 끝에 습관적으로 추가되는 것이 아니라, 작성된 순서로 나열했기 때문입니다.

  • 패키지 이름은 소문자와 숫자만 사용합니다, 연속된 단어는 단순히 함께 연결됩니다.

    예) com.example.deepspace → Yes

    예) com.example.deepSpace, com.example.deep_space → No

  • 클래스 이름은 UpperCamelCase로 작성합니다. 일반적으로 명사 또는 명사구로 작성하지만 경우에 따라 형용사 또는 형용사구로 작성해도 허용합니다.

    예) MemoProject

  • 메소드 이름은 동사, lowerCamelCase로 작성합니다. 일반적으로 동사 또는 동사구로 작성합니다.

    예) doSomething

  • 상수가 아닌 필드 이름은 lowerCamelCase로 작성합니다.

    • 상수는 UPPER_SNAKE_CASE로 작성합니다.

      예) IMMUTABLE_NUMBER

  • 그 외 매개변수, 지역 변수는 lowerCamelCase로 작성합니다.

  • @Override 는 꼭 사용합니다.

  • long 정수 리터럴은 접미사로 반드시 대문자를 사용합니다. (숫자 1과의 혼동을 피하기 위해)

    예) 111111111l → No

registerSchedule (일정 등록)

• 정상작동
• Null값, 공백문자 테스트 필요
• 시간이 중복되는 일정이 등록되는 문제 (예외처리 필요)

updateSchedule (일정 변경)

• 정상작동
• Null값, 공백문자 테스트 필요
• 시간이 중복되는 일정이 저장되는 문제 (예외처리 필요)

completeSchedule (일정 완료 표시)

• 정상작동
• 이미 일정완료인 경우 예외처리 필요

incompleteSchedule (일정 미완 표시)

• 정상작동
• 이미 일정미완인 경우 예외처리 필요

deleteSchedule (일정 삭제)

• 정상작동

getMySchedules

• 정상작동
• Page 크기 조절 필요해보임
• Page 크기 초과된 양에 대해 Paging 잘되는지
  테스트 필요
• Json output에 Page 정보가 중복되는 문제

getPeriodSchedules

• 정상작동
• Page 문제는 위와 동일

-- 정상작동이라는건 평범한 case에 대해 코드가 의도하는대로
작동한다는 뜻입니다.
-- 경계값이나 Null값에 대한 Test는 전부 필요한 상황입니다.
-- 몇가지 예외처리가 더 필요한 상황입니다.

1. 회원가입

• email 또는 nickname에 NULL 이 전달 될 때, 이메일이 중복될 때 -> 오류 메세지 표시 (현재 401로 나타남)
• email과 password에 정규표현식 적용 필요 -> email과 password에 공백 문자 들어갈 우려 있음

2. 로그인

• 사용자를 찾을 수 없을 때 (이메일이나 비밀번호가 틀렸을 때) 401이 나타남

3. 회원 탈퇴

• 문제 발견 못함

4. 내 정보 수정

• 값에 null 이 전달 됐을 때의 에러로 401이 나타남
• 값에 공백 문자가 전달 됐을 때 처리 필요 -> 자연스러운 것은 공백 문자가 전달되면 값이 업데이트 되지 않는 것임 (ex: 닉네임이 공백 문자고 password에 적절한 값이 들어오면 password만 변경)
• 정규표현식 적용 이후에 패스워드에 정규표현식을 지키지 않고 값을 넣으려고 할 때 에러가 나는지 확인 필요

5. 모든 사용자 조회
6. 내 정보 보기
7. 유저가 가입된 채널 조회

• 문제 발견 못함

** 1. 쓰레드 작성 시 **

• null 값을 전달 시 예외처리 되지 않음 (401 반환됨)
• 공백 문자 전달 시 쓰레드 작성이 돼버림
• 내가 속하지 않은 채널에도 쓰레드를 작성할 수 있음

** 2. 쓰레드 수정

• null 값을 전달 시 예외처리 되지 않음 (401 반환됨)
• 공백 문자 전달 시 수정이 돼버림
• 자신이 작성한 쓰레드가 아닐 때, 401 에러가 반환 됨 (🤔적절한 걸지도 모르지만 토큰을 생각하면..)
• 없는 쓰레드를 수정하려고 하면 401 에러가 반환 됨 (그리고 또 NoSuchElementException.. 메세지를 넣어주는 방법도 있음)

** 3. 쓰레드 삭제

• 내가 작성한 글이 아니여도 삭제 됨
• 없는 쓰레드를 삭제하려고 하면 401 반환 (콘솔에서는 제대로 예외가 나타남)

   @Override
    public String unregister(User user) {
        userRepository.deleteByEmail(user.getEmail());
        return "home";
    }

위처럼 패러미터로 User를 받아와도 되는가? 에 대해서 고민했습니다.

Controller - Service 계층간 데이터 주고 받을 시 엔티티를 주고 받아도 되는가?

** 1. 댓글 생성 **

• null 값 전달 시 401 에러 (콘솔에서도 예외처리 X)
• 공백 문자 전달 시 만들어짐
• 내가 속하지 않은 채널의 게시글에도 댓글을 작성할 수 있음
• 없는 게시글에 댓글을 다려고 할 때 401 에러 (콘솔에서도 제대로 예외처리 X)

** 2. 댓글 수정 **

• null 값 전달 시 401 에러 (콘솔에서도 예외처리 X)
• 공백 문자 전달 시 수정 됨
• 내가 작성하지 않은 댓글도 수정할 수 있음
• 없는 댓글을 수정하려고 할 때 401 에러 (콘솔에서도 제대로 예외처리 X)
• 정상 수정이 되지 않음 (ID로 댓글을 찾을 수가 없었음)

** 3. 댓글 삭제 **

• 정상 삭제가 되지 않음 (ID로 댓글을 찾을 수가 없었음)

통합 테스트 순서

유저

1. User 회원 가입

• null 값 혹은 빈 칸 혹은 공백 문자를 전달하면?
• 같은 e-mail로 가입 되는지? (정규표현식 적용하여 email 및 password 규칙 만들어야 함)

2. User 로그인

3. 회원 탈퇴

4. 회원 정보 수정

• null 값을 전달하면 어떻게 되는지

5. 전체 사용자 정보 조회

6. 내 정보 조회

채널

1. 채널 생성

• null 값 혹은 빈 칸 혹은 공백 문자를 전달하면?

2. 채널 초대하기

• 이미 초대되어 있는 유저를 초대하면?

3. 채널명 수정

• 채널 어드민이 아닌 사람이 채널을 수정하려 하면?
• null 값 혹은 빈 칸 혹은 공백 문자를 전달하면?

4. 채널 삭제

• 채널 어드민이 아닌 사람이 채널을 삭제하려 하면?

5. 채널 내 게시글 전체 조회

• 페이징 기능 테스트 해야함..

게시글

1. 게시글 생성

• null 값 혹은 빈 칸 혹은 공백 문자를 전달하면?
• 채널에 초대된 사람이 아닌데 게시글을 쓰려고 하면?

2. 게시글 수정

• null 값 혹은 빈 칸 혹은 공백 문자를 전달하면?
• 게시글의 주인이 아닌 사람이 수정하려고 하면?
• 없는 댓글을 수정하려고 하면?

3. 게시글 삭제

• 게시글의 주인이 아닌 사람이 삭제하려고 하면?
• 없는 댓글을 삭제하려고 하면?

4. 게시글 아래 댓글 전체 조회(페이징)
-> 단일 게시글을 조회했을 때 그 게시글 정보와 함께 댓글 정보도 함께 불러와지는 게 자연스러워보임

• 페이징 기능... 아..

댓글

1. 댓글 생성

• null 값 혹은 빈 칸 혹은 공백 문자를 전달하면?
• 채널에 초대된 사람이 아닌데 댓글을 쓰려고 하면?

2. 댓글 수정

• null 값 혹은 빈 칸 혹은 공백 문자를 전달하면?
• 댓글의 주인이 아닌 사람이 수정하려고 하면?
• 없는 댓글을 수정하려고 하면?

3. 댓글 삭제

• 댓글의 주인이 아닌 사람이 삭제하려고 하면?
• 없는 댓글을 삭제하려고 하면?

이모지

1. 게시글에 이모지를 남기기

• 채널에 초대되지 않은 사람이 이모지를 남기려고 하면?

2. 게시글에 이모지를 삭제하기

• 채널에 초대되지 않은 사람이 이모지를 삭제하려고 하면?
• 이모지를 남기지 않은 사람이 이모지를 삭제하려고 하면?

3. 댓글에 이모지를 남기기

• 채널에 초대되지 않은 사람이 이모지를 남기려고 하면?

4. 댓글에 이모지를 삭제하기

• 이모지를 남기지 않은 사람이 이모지를 삭제하려고 하면?
• 채널에 초대되지 않은 사람이 이모지를 삭제하려고 하면?

401 에러 스테이터스는 확인되지만 에러 메시지는 없는 상황입니다. 오늘 여기까지 해서 마치고 내일 살펴볼게요!

1. 채널 생성

• null 값을 전달하면 401 에러가 나타납니다.
• 채널 이름에 공백이 들어가도 생성되고 있습니다.

** 2. 유저 채널에 초대하기 **

• 없는 채널에 초대하려고 하면 401 에러가 나타납니다.
• 없는 유저를 채널에 초대하려고 하면 401 에러가 나타납니다.
• 나 자신이 채널을 만들었을 때 채널에 가입되지 않는 에러가 있었습니다.

3. 채널명 수정

• 권한 없을 때 -> 401
• null 전달 할 때 -> 401
• 없는 채널을 수정하려고 할 때 -> 401

4. 채널명 삭제

• 권한 없을 때 -> 401
• 없는 채널을 수정하려고 할 때 -> 401
• 유저-채널은 삭제 되는데 채널은 삭제되지 않음

5. 특정 채널 조회

• 없는 채널을 조회하려고 할 때 에러

• 🤔채널 조회하는 로직에 채널 이름만 표시되면 될지

• 채널 서비스에 대상 채널에 가입되어 있는 사용자인지 검사하는 메서드가 추가됐습니다.
  (이제 Thread와 Comment에 이모지 반응을 남길 때도 권한을 체크합니다)

• 대상 채널의 전체 쓰레드를 읽어올 때 쓰레드에 남겨진 이모지 반응 정보도 읽어옵니다.

• 대상 채널의 전체 쓰레드를 읽어올 때 채널에 가입됐는지 검사합니다

• 대상 채널의 특정 쓰레드를 읽어올 때도 마찬가지로 유저가 채널에 가입됐는지 검사합니다

• Thread에 이모지 반응을 남기는 api와 삭제하는 api가 통합되었습니다.

• Comment에 이모지 반응을 남기는 api와 삭제하는 api가 통합되었습니다.

• 이모지 열거형 이름이 바뀌었습니다 (SMILE, CRY, HEART, LIKE)

일정의 내용과 예정일을 변경하던 하나의 메소드를 내용을 변경하는 메소드와 예정을 변경하는 메소드 두개로 분리하였습니다. (컨트롤러도 분리되었습니다.)

또, 이번 달 일정을 조회하는 기능과 완료 체크를 하는 기능을 추가하였습니다.

변경 중에 _레포지토리를 통해 ID로 Schedule 객체를 조회하여 가져오는 부분_의 코드가 중복되어 정리하였습니다.

아래와 같은 DTO를 만들어 반환하는 코드도 함수의 반환 값을 변수에 받은 후 반환할 필요 없이 바로 함수의 반환 값을 반환할 수 있을 것 같습니다.