[FEAT] 커뮤니티 게시글 작성 API #347

jokj624 · 2024-03-31T09:28:57Z

closes [FEAT] 커뮤니티 글 작성 API #344

작업 내용

커뮤니티 게시글 작성 API 구현
- 카테고리 id 에 일치하는 카테고리 없을 시 400 BAD REQUEST
- community_post 생성 후 community_category_post 연결
express-validator 사용해 req validator 구현
- 기존에 너무 컨트롤러 내부에서 if 문에 의존해 validation 하고 있어서 express-validator 를 사용해 middleware 단에서 검증하는 부분 추가해봤습니다. 관련해서 많은 의견 부탁드려요

jokj624 · 2024-03-31T09:30:21Z

functions/constants/validator/communityValidator.js

+const createCommunityPostValidator = [
+  body('communityCategoryIds')
+    .isArray()
+    .notEmpty()
+    .withMessage('Invalid communityCategoryIds field'),
+  body('title').isString().notEmpty().withMessage('Invalid title field'),
+  body('body').isString().notEmpty().withMessage('Invalid body field'),
+  body('contentUrl').isString().notEmpty().withMessage('Invalid contentUrl field'),
+  body('contentTitle').isString().notEmpty().withMessage('Invalid contentTitle field'),
+];


이 validator 를 어느 폴더에 넣어야 알맞을까 고민하다 다 애매해서 constants 로 넣었는데 조언 부탁드립니다.

다 애매하긴 하네요..
middleware 단에서 검증하는 부분이니까 middlewares/validator로 폴더 위치를 지정해주는건 어떨까요?

저도 middlewares 하위가 좋은 것 같습니다!

오늘 수정하겠습니다!

수정했습니다.

jokj624 · 2024-03-31T09:35:59Z

functions/db/community.js

+      SELECT element
+      FROM unnest($1::int[]) AS element
+      LEFT JOIN community_category ON community_category.id = element
+      WHERE community_category.id IS NULL;


주어진 배열(카테고리 id 배열)을 unnest 메서드 사용해 행집합으로 변환하고

element

1

2

3

community_category 테이블과 join

join 결과 테이블에서 community_category id가 없는 경우의 element 조회 == 존재하지 않는 커뮤니티 카테고리

SELECT unnest($1::int[]) EXCEPT SELECT id FROM community_category;

저는 차집합을 구할 때 주로 EXCEPT를 사용하는 편인데요, LEFT JOIN을 사용하신 이유가 따로 있는지 궁금합니다 -!

방금 찾아보니 EXCEPT는 중복을 제거하기 때문에 정렬하는 과정이 추가돼서 성능 저하가 발생할 수도 있다고 하네요..!

배열에 있는 id가 있는지 없는지 판별하는 로직인 것 같은데, WHERE IN 조건은 어떨까요? 문법 정확하지는 않을텐데 대략 이런식으로

SELECT element FROM community_category cc WHERE cc.id IN $1::INT[]

혹시 WHERE IN 조건이 해당 쿼리에 비해 성능이 좋을까요? 특별히 바꿔야하는 이유가 있을지 궁금합니다.

정확히 성능 비교는 해보지 않았는데, 우리 카테고리 수가 많지도 않고, 가독성 면에서는 더 직관적인 것 같아서 제안해봤습니다

음 제가 SQL이 좀 떨어져서 ㅠ 잘 이해한건지 모르겠는데 대충 아래같은 쿼리를 말하신거죠?

select cc.id from community_category cc where cc.id in (1, 10, 11); // 1, 10, 11 은 배열 원소 예시

IN, NOT IN 쿼리로 조회하면 지금은 배열 -> 카테고리 테이블에 존재하지 않는 값 조회에서 반대 (카테고리 테이블에서 배열에 존재하거나/존재하지 않는 값 조회) 가 돼서 의미가 더 어려워지는 것 같은데
위에 유빈이가 언급한 차집합 연산자(EXCEPT) 나 JOIN을 사용하는게 의미상 더 좋아보입니다.

참고로 MySQL에서는 EXCEPT 연산자가 없어서 보통 JOIN 으로 차집합 연산을 구현해서 Postgres 에 따로 차집합 연산이 존재하는 걸 이제 알았네요 @yubinquitous

성능 이슈가 크지 않다면

select unnest($1::int[]) except select id FROM community_category;

요게 더 직관적이긴 하네욥 except 써보는 것도 좋을 것 같아요

좋습니다!

jokj624 · 2024-03-31T09:36:54Z

functions/middlewares/validation.js

+const validate = (req, res, next) => {
+  const errors = validationResult(req);
+  if (errors.isEmpty()) {
+    return next();
+  }
+
+  const validatorErrorMessage = errors.array()[1] ? errors.array()[1].msg : errors.array()[1].msg;
+
+  const detailError = {
+    statusCode: statusCode.BAD_REQUEST,
+    responseMessage: responseMessage.NULL_VALUE,
+    validatorErrorMessage,
+  };
+
+  errorHandler(detailError, req, res, next);
+};


validate 결과에 error 가 있을 경우 errorHandler 로 400 에러 객체를 보내는 미들웨어

errorHandler 를 명시적으로 호출하면, Sentry 미들웨어가 스킵될 수도 있을 것 같은데, 혹시 한 번 확인해볼 수 있을까요?

이거 next(detailError) 이렇게 보내도 sentry 에서 안잡혀서 일단 머지하고 제가 좀 더 테스트해볼게요

jokj624 · 2024-03-31T09:37:33Z

functions/api/routes/community/index.js

@@ -116,6 +118,7 @@ router.get(
 router.post(
  '/posts',
  checkUser,
+  [...communityValidator.createCommunityPostValidator, validate],


라우터 미들웨어 단에서 validatior와 전역 validate 함수 같이 추가해주면 됩니다.

같은 validation 역할을 하는 미들웨어들이라 배열로 묶고 spread 한 걸까요?

createCommunityPostValidator 자체가 express-validator 에서 제공하는 ValidationChain[] 타입이어서 그냥 넣으면 이중 배열이라 spread 했습니다.
validator와 validate 는 단일 구조의 미들웨어로 묶으려고 배열 사용했습니다.

yubinquitous

고생하셨슴당 덕분에 깔끔하게 request validation을 할 수 있게 됐네요 👍 !

HYOSITIVE

의견 간단하게 몇 개 남겼습니다. 전체적으로 좋아보입니다! 고생하셨어요~!

HYOSITIVE · 2024-04-01T02:14:37Z

functions/db/community.js

+  );
+};
+
+const verifyExistCategories = async (client, communityCategoryIds) => {


Nit: verifyCategoriesExist는 어떠신가요?

HYOSITIVE · 2024-04-01T02:16:06Z

functions/middlewares/validation.js

+    return next();
+  }
+
+  const validatorErrorMessage = errors.array()[1] ? errors.array()[1].msg : errors.array()[1].msg;


ternary 앞 뒤 조건이 모두 errors.array()[1].msg로 동일한 것 같은데 의도된 부분일까요?

아 오타입니다. custom message 가 1번 위치라 없으면 기본 메시지 출력하려고 [0] 을 넣어야하는데 오타 발생

HYOSITIVE · 2024-04-01T02:19:00Z

functions/middlewares/validation.js

+const validate = (req, res, next) => {
+  const errors = validationResult(req);
+  if (errors.isEmpty()) {
+    return next();
+  }
+
+  const validatorErrorMessage = errors.array()[1] ? errors.array()[1].msg : errors.array()[1].msg;
+
+  const detailError = {
+    statusCode: statusCode.BAD_REQUEST,
+    responseMessage: responseMessage.NULL_VALUE,
+    validatorErrorMessage,
+  };
+
+  errorHandler(detailError, req, res, next);
+};


errorHandler 를 명시적으로 호출하면, Sentry 미들웨어가 스킵될 수도 있을 것 같은데, 혹시 한 번 확인해볼 수 있을까요?

HYOSITIVE · 2024-04-01T02:22:15Z

functions/db/community.js

+      SELECT element
+      FROM unnest($1::int[]) AS element
+      LEFT JOIN community_category ON community_category.id = element
+      WHERE community_category.id IS NULL;


배열에 있는 id가 있는지 없는지 판별하는 로직인 것 같은데, WHERE IN 조건은 어떨까요? 문법 정확하지는 않을텐데 대략 이런식으로

SELECT element FROM community_category cc WHERE cc.id IN $1::INT[]

HYOSITIVE · 2024-04-01T02:23:30Z

functions/api/routes/community/index.js

@@ -116,6 +118,7 @@ router.get(
 router.post(
  '/posts',
  checkUser,
+  [...communityValidator.createCommunityPostValidator, validate],


같은 validation 역할을 하는 미들웨어들이라 배열로 묶고 spread 한 걸까요?

HYOSITIVE · 2024-04-01T02:24:35Z

functions/api/routes/community/communityPostPOST.js

+  const dbConnection = await db.connect(req);
+  req.dbConnection = dbConnection;
+
+  const notExistCategoryIds = await communityDB.verifyExistCategories(


Nit: notExistingCategoryIds는 어떨까요?

jokj624 added 4 commits March 31, 2024 18:24

[CHORE]: express-validator 추가

7b04f32

[CHORE]: prettier printWidth 수정

c413006

[FEAT] req validator 추가

f204c5d

[FEAT] 커뮤니티 게시글 작성 API

f7b2a01

jokj624 added 🚀 enhancement New feature or request 🥱 jobchae labels Mar 31, 2024

jokj624 self-assigned this Mar 31, 2024

jokj624 requested review from HYOSITIVE and yubinquitous March 31, 2024 09:29

jokj624 commented Mar 31, 2024

View reviewed changes

yubinquitous approved these changes Mar 31, 2024

View reviewed changes

HYOSITIVE approved these changes Apr 1, 2024

View reviewed changes

jokj624 added 5 commits April 4, 2024 02:12

[REFACTOR] 변수명 수정

8422ab7

[FIX] validator 위치 middleware로 이동

c5e20c1

[REFACTOR] validation msg nullish operator 사용하도록 수정

9fe349e

[REFACTOR] validation msg type error 방지

f53a548

Merge branch 'develop' into feature/344

c4eae6b

jokj624 merged commit 7d23202 into develop Apr 8, 2024

jokj624 deleted the feature/344 branch April 8, 2024 16:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEAT] 커뮤니티 게시글 작성 API #347

[FEAT] 커뮤니티 게시글 작성 API #347

jokj624 commented Mar 31, 2024

jokj624 Mar 31, 2024

yubinquitous Mar 31, 2024

HYOSITIVE Apr 1, 2024

jokj624 Apr 2, 2024

jokj624 Apr 3, 2024

jokj624 Mar 31, 2024

yubinquitous Mar 31, 2024

yubinquitous Mar 31, 2024

HYOSITIVE Apr 1, 2024

jokj624 Apr 2, 2024

HYOSITIVE Apr 2, 2024

jokj624 Apr 3, 2024

jokj624 Apr 3, 2024

HYOSITIVE Apr 4, 2024

jokj624 Mar 31, 2024

HYOSITIVE Apr 1, 2024

jokj624 Apr 3, 2024

jokj624 Mar 31, 2024

HYOSITIVE Apr 1, 2024

jokj624 Apr 3, 2024

yubinquitous left a comment

HYOSITIVE left a comment

HYOSITIVE Apr 1, 2024

HYOSITIVE Apr 1, 2024

jokj624 Apr 3, 2024

HYOSITIVE Apr 1, 2024

HYOSITIVE Apr 1, 2024

HYOSITIVE Apr 1, 2024

HYOSITIVE Apr 1, 2024

[FEAT] 커뮤니티 게시글 작성 API #347

[FEAT] 커뮤니티 게시글 작성 API #347

Conversation

jokj624 commented Mar 31, 2024

작업 내용

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yubinquitous left a comment

Choose a reason for hiding this comment

HYOSITIVE 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment