Go chi 버전 업데이트 및 돌봄급구 관련 API를 추가합니다. #22

barabobBOB · 2023-12-02T07:17:44Z

작업 내용

Go chi 버전 업데이트

기존 버전 v1.5.4 -> v5.0.10
따로 마이그레이션없이 버전만 업데이트 해도 문제 없음을 확인하였습니다. [참고자료] (go-chi/chi@v1.5.4...v5.0.0)

돌봄급구 API

테스트 사전 작업

sos_conditions 돌봄급구 조건을 미리 등록해두어야 합니다.

INSERT INTO sos_conditions (id, name, created_at, updated_at, deleted_at)
VALUES
    (1, 'CCTV, 펫캠 촬영 동의', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, NULL),
    (2, '사전 통화 가능 여부', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, NULL),
    (3, '반려 동물 등록 여부', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, NULL);

게시글 업로드 API /post/sos [POST]
request

{
  "care_type": "foster",
  "carer_gender": "male",
  "condition_ids": [
    1, 2, 3
  ],
  "content": "content",
  "date_end_at": "2020-01-15",
  "date_start_at": "2020-01-10",
  "image_ids": [
    1
  ],
  "pet_ids": [
    1
  ],
  "reward": "reward",
  "reward_amount": "hour",
  "time_end_at": "22:00:00",
  "time_start_at": "20:00:00",
  "title": "title"
}

전체 게시글 조회 API /post/sos?page={page}&size={size}&sort_by={sort} [GET]
sort_by 는 newest, deadline 조건이 있으며 각각 최신순, 마감일순을 의미합니다.
작성자 ID로 게시글 조회 API /post/sos/author [GET]
게시글 ID로 게시글 조회 API /post/sos/{id} [GET]
게시글 수정 API /post/sos [PUT]

request

{
  "care_type": "foster",
  "carer_gender": "male",
  "condition_ids": [
    1, 2, 3
  ],
  "content": "update content",
  "date_end_at": "2020-01-15",
  "date_start_at": "2020-01-10",
  "id": 1,
  "image_ids": [
    1
  ],
  "pet_ids": [
    1
  ],
  "reward": "reward",
  "reward_amount": "hour",
  "time_end_at": "22:00:00",
  "time_start_at": "20:00:00",
  "title": "update title"
}

스웨거까지 작업완료했습니다.

litsynp · 2023-12-02T11:50:32Z

sos_conditions 돌봄급구 조건을 미리 등록해두어야 합니다.

이거 배포 전에 마이그레이션 스크립트 만들고 PR 파서 그것부터 배포 나가야할 것 같아요~

https://github.com/pet-sitter/pets-next-door-api/blob/f8f6466/cmd/import_breeds/main.go 이거 참고해주세요.

litsynp · 2023-12-02T11:51:56Z

게시글의 타임존이 있을텐데 타임존은 어느 걸로 참고할건가요?

litsynp · 2023-12-02T11:53:04Z

cmd/server/handler/sos_post_handler.go

+		return
+	}
+
+	res, err := h.sosPostService.UploadSosPost(uid, &uploadSosPostRequest)


nitpicking이긴 하지만 upload보단 create, write 같은게 어떨까요?

저도 지금 생각해보니 upload 표현은 파일 업로드에 좀 더 가깝다고 생각이 드네요 write으로 변경하겠습니다.

litsynp · 2023-12-02T11:54:36Z

cmd/server/handler/sos_post_handler.go

+// findSosPostsByAuthorID godoc
+// @Summary 작성자 ID로 돌봄급구 게시글을 조회합니다.
+// @Description
+// @Tags posts
+// @Accept  json
+// @Produce  json
+// @Param page query int false "페이지 번호" default(1)
+// @Param size query int false "페이지 사이즈" default(20)
+// @Security FirebaseAuth
+// @Success 200 {object} commonviews.PaginatedView[sos_post.FindSosPostResponse]
+// @Router /posts/sos/author [get]
+func (h *SosPostHandler) FindSosPostsByAuthorID(w http.ResponseWriter, r *http.Request) {


이런 검색은 기존 목록 조회 API에 쿼리로 필터링을 하면 좋을 것 같아요
e.g., /posts/sos?author_id={author_id}

사용자의 ID(fid_uid) 값을 파라미터에 담기에 보안적으로 문제가 있을 듯하여 현재 로그인한 사용자의 ID(fid_uid)를 가지고 조회하도록 구현하였습니다. 그래서 /posts/sos?author_id={author_id} author_id에 Boolean 타입으로 필터링을 하거나 기존 그대로 하는 건 어떻게 생각하시나요?

네, boolean(written_by_me?)으로 해도 괜찮긴 한데 그러면 다른 사람이 작성한 글을 필터링 할 수가 없어서, 그냥 int pk(author_id)로 하면 될 것 같아요.

현재 구현된 API에서는 DB author_id 칼럼에 fid_uid가 들어가고 있는데 User 테이블의 PK로 조회하도록 변경하면 될까요?

litsynp · 2023-12-02T12:08:19Z

internal/domain/sos_post/service.go

+		mediaView = append(mediaView, view)
+	}
+
+	conditions, err := service.sosPostStore.FindConditionByID(sosPost.ID)


본인이 작성한 글이 아니라면 확인이 필요할 것 같아요! 403 내려주면 될 것 같습니다.

오 이 부분까진 고려못했는데 반영하도록 하겠습니다 :)

barabobBOB · 2023-12-09T15:20:49Z

혹시 다른 API에서 사용하고 있는 타임존이 있을까요??

litsynp · 2023-12-10T01:24:52Z

혹시 다른 API에서 사용하고 있는 타임존이 있을까요??

한국 서비스라 한국을 쓰긴 하지만 다양한 케이스를 열어두면 좋을 것 같아요.
기존에는 datetime으로 받아오니 어떤 타임존이 오든 처리할 수 있을텐데 이 API는 date, time을 따로 가져와서 timezone이 없어서요. 어쩌면 date_X_at을 datetime으로 받은 다음에 DB 시간을 UTC로 통일해서 계산해서 쪼개야 하지 않을까 싶네요(날짜만으로는 타임존이 바뀌어도 알 수 없으니...). time_X_at은 그대로 두고요!

만약 이렇게 하신다면 request body schema가 바뀌고 DB는 유지될 것 같네요

e.g.,
request -> DB
date_X_at (datetime) -> date (UTC)
time_X_at (time) -> time

litsynp · 2023-12-10T01:29:46Z

리베이스해서 충돌을 해결해주면 좋을 것 같아요!

litsynp

코멘트 남긴 것 확인 부탁드려요! 거의 다 온 것 같습니다 👍

litsynp · 2023-12-12T12:35:13Z

cmd/server/handler/sos_post_handler.go

+// @Success 200 {object} commonviews.PaginatedView[sos_post.FindSosPostResponse]
+// @Router /posts/sos [get]
+func (h *SosPostHandler) FindSosPosts(w http.ResponseWriter, r *http.Request) {
+	authorIDQuery := r.URL.Query().Get("authorID")


변수명은 authorID가 맞지만 쿼리는 컨벤션에 따라 author_id가 좋겠네요. Swagger도 수정되어야 할 것 같아요

litsynp · 2023-12-12T12:37:38Z

internal/domain/sos_post/sos_post.go

+	DateStartAt  string       `field:"date_start_at"`
+	DateEndAt    string       `field:"date_end_at"`
+	TimeStartAt  time.Time    `field:"time_start_at"`
+	TimeEndAt    time.Time    `field:"time_end_at"`


model은 DateXAt이 string이고 TimeXAt이 time.Time인데 Request는 반대인데 의도한거겠죠?

DB에서 TimeXAt 칼럼을 string 타입으로 가져온다고 해도 22:00이 아닌 0000-01-01T20:00:00Z로 반환됩니다. 그래서 22:00 형태로 변환하기 위해 model에서는 TimeXAt을 time.Time 받고 service 단(datetimeToTime)에서 형 변환을 진행했습니다.

추가로 Request의 경우, DateXAt는 날짜, 시간을 비롯한 타임존까지 받아야 하기 때문에 time.Time 타입으로 정의하였습니다. 반대로 TimeXAt는 시간만 받으면 되기에 string 타입으로 정의하였습니다.

코드 레벨에서 형변환 안하고 query 레벨에서 포맷해도 될 것 같긴 한데... 요것은 일단 큰 이슈는 아니니 그렇게 가죠! 나머지는 이해했습니다 👍

쿼리 레벨에서 할 생각은 안해봤었네요 한번 찾아보겠습니다. 장소 추가할때 함께 리팩토링 진행하면 되겠네요 👍🏻

litsynp

근데 리베이스를 했어야 하는데 머지를 한 것 같네요...ㅋㅋㅋ

litsynp · 2023-12-12T12:42:12Z

internal/domain/sos_post/service.go

+}
+
+func datetimeToTime(datetime time.Time) string {
+	return datetime.Format("15:04")


근데 15:04는 어떤 뜻인가요?

시간 포맷 형태를 나타냅니다. 24시간 형태로 출력됩니다.

아래 공식문서 보시면 더 자세하게 나왔습니다 :)

time 패키지 공식 문서

아 상수값에 없어서 "15:04"으로 한거군요.

barabobBOB · 2023-12-15T12:58:26Z

리베이스로 충돌난 건 해결했었는데 추가로 작업한 내용을 커밋하다가 fetch + merge가 되었나봐요 ... 담부턴 주의하도록 하겠습니다

litsynp

고생하셨어요~ 리베이스 머지는 안될 것 같고 머지 후 배포 가보시죠!

litsynp · 2023-12-15T15:39:17Z

internal/domain/sos_post/service.go

+}
+
+func datetimeToTime(datetime time.Time) string {
+	return datetime.Format("15:04")


아 상수값에 없어서 "15:04"으로 한거군요.

barabobBOB · 2023-12-15T15:49:57Z

감사합니다 ~ 코드리뷰하시느라 수고 많으셨어요 🙇🏻‍♂️

barabobBOB added 4 commits November 25, 2023 04:39

fix: update go-chi version

c53bd7a

feat: add resource_media

d978b74

feat: add sos_posts APIs

b57c005

fix: add index

7d459c1

barabobBOB self-assigned this Dec 2, 2023

litsynp reviewed Dec 2, 2023

View reviewed changes

barabobBOB added the feat New feature label Dec 4, 2023

barabobBOB added 2 commits December 10, 2023 02:26

fix: change method name

d61aa85

feat: add Update API error

459fcfe

barabobBOB added 4 commits December 11, 2023 03:54

fix: refactoring the sos-post query API

599bb7c

Merge branch 'main' into feat/sos-post

ca2cac6

fix: add UTC timezone

a7143a8

refactor: remove unnecessary code

53bcf85

litsynp reviewed Dec 12, 2023

View reviewed changes

fix: change parameter to snake_case

db3b83b

litsynp approved these changes Dec 15, 2023

View reviewed changes

barabobBOB merged commit a90b3ae into main Dec 15, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Go chi 버전 업데이트 및 돌봄급구 관련 API를 추가합니다. #22

Go chi 버전 업데이트 및 돌봄급구 관련 API를 추가합니다. #22

barabobBOB commented Dec 2, 2023

litsynp commented Dec 2, 2023 •

edited

Loading

litsynp commented Dec 2, 2023

litsynp Dec 2, 2023

barabobBOB Dec 4, 2023

litsynp Dec 2, 2023

barabobBOB Dec 9, 2023

litsynp Dec 10, 2023

barabobBOB Dec 10, 2023

litsynp Dec 2, 2023

barabobBOB Dec 4, 2023

barabobBOB commented Dec 9, 2023

litsynp commented Dec 10, 2023 •

edited

Loading

litsynp commented Dec 10, 2023

litsynp left a comment

litsynp Dec 12, 2023

litsynp Dec 12, 2023

barabobBOB Dec 15, 2023

litsynp Dec 15, 2023

barabobBOB Dec 15, 2023

litsynp left a comment

litsynp Dec 12, 2023

barabobBOB Dec 15, 2023

litsynp Dec 15, 2023

barabobBOB commented Dec 15, 2023

litsynp left a comment •

edited

Loading

litsynp Dec 15, 2023

barabobBOB commented Dec 15, 2023

Go chi 버전 업데이트 및 돌봄급구 관련 API를 추가합니다. #22

Go chi 버전 업데이트 및 돌봄급구 관련 API를 추가합니다. #22

Conversation

barabobBOB commented Dec 2, 2023

작업 내용