Backend 개발 중 불편함 감지한 사항들

6주간 Backend 개발을 하면서 협업 process에서 개선해야할 점들을 파악하고 개선 사항에 대하여 공유합니다.

PR.. 언제 Merge 해줄거에요?

• 상황
  • 오전 10시 ~ 오후 11시 동안 4명의 팀원이 공유 오피스에 모여 개발을 진행했다.
  • PR을 보내는 시간은 매번 달랐는데, 퇴근을 하고 집에서 마무리한 기능에 대해 PR을 보내거나, 주말에 PR을 보내는 경우들이 생겼다.
• 불편함 감지

  팀원 A : B님 저 PR 올렸는데 review 및 merge 부탁드립니다!
  팀원 B : 앗 넵! 제가 지금 하던게 있어서 마무리하고 확인 해볼게요!

  • 위의 상황에서 팀원 A는 PR merge가 되기까지 기다리지만 언제 merge가 될지 몰라, 계속 Github를 기웃거린다.
  • PR merge 되었는지 팀원 B에게 물어보기엔 재촉하는 것 같아 미얀하다.
• 개선 방향
  • PR review 후 dev-be branch로 merge를 하면 Github action이 자동으로 Slack 팀 channel에 알림을 주도록 workflow를 작성했다.

Server API Response 뭔가 이상해요 확인해주세요!

전체 일대기는 기술공유의 Server Error Slack bot 만들기 를 참고 부탁드립니다.

• 상황
  • dev-be의 코드를 nCloud에 임시 배포를 한 상태에서, Frontend에서 서버에 보낸 요청으로 unknown 에러를 마주쳤을 때 Backend 담당자에게 말하면 확인하는 방식이었다.
• 불편함 감지
  • Backend에서 Error handling 처리한 문제는 Frontend에서 message를 통해 바로 알 수 있었으나
  • 그 외 bug나 DB 문제의 경우 Backend engineer가 직접 ncloud에 접속하여 로그 확인을 해야했다.
• 개선 방향
  • Error 발생 시, Log를 Slack 에 자동으로 전송해주면 ncloud에 일일히 접속안해도 되겠다! 에서 시작
  • nest interceptor를 통해 error 전달 시 sentry로 error report 및 slack message send

Merge한 파일 오류나는데요? 앗 제가 env 파일 수정했어요..

• 상황
  • env 파일은 github ignore로 설정되어있어, 공용 repository에 올라가지 않았다.
  • A가 env파일을 수정하여 코드를 완성하고 올린 commit을 B가 사용 시에 제대로 동작하지 않는 상황이 발생했다.
• 불편함 감지
  • 위의 상황에서 B는 왜 오류가 나는지 모른채 열심히 오류 원인을 찾게된다.
  • env파일을 수정한 사실을 잊고있던 A는 시간이 지나 env파일 수정 때문에 B가 실행을 못하고 있단 사실을 알아챈다.
• 개선 방향
  • Github Action의 secret : github repository로 가서 하나 씩 추가해줘야하고, 어떤 값을 넣었는지 확인해보고 싶을 때 바로 확인이 불가능하다.
  • Slack bot : env 파일이 수정될 때 개발자가 직접 slack bot 프로그램을 실행시키면 편리하나, slack bot 프로그램을 작성하는데 시간이 더 많이 소요될 것 이다. 한시가 급한 그룹 프로젝트에서 오버엔지니어링으로 판단하였으며, 추후 개발해볼만 하다.
  • Slack env update channel 분리 개설 : env 파일을 update하는 채널을 새로 생성하여, 변경사항이 있을 때 바로바로 update하도록 규칙을 세웠다.

    규칙 : 파일 위치와 해당 파일 전체를 다시 공유