Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FE] feat : 회원용 리뷰 그룹 생성 API 연결 및 관련 목서버 셋팅 수정 #1072

Merged
merged 15 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
de753af
feat : 회원용 리뷰 리뷰 생성 폼 API 연결
BadaHertz52 Jan 22, 2025
e1bb55c
feat : ReviewLinkDashboard 리뷰 링크 생성 폼 - 회원용으로 변경
BadaHertz52 Jan 22, 2025
374c27f
refactor : gettingPath 함수로 회원 전용 여부를 path에 표시
BadaHertz52 Jan 22, 2025
fdadd37
refactor : 회원 전용 페이지의 Amplitude용 페이지 이름 변경
BadaHertz52 Jan 22, 2025
27aec28
Merge branch 'fe/refactor/1069-logged-in-path' into fe/feat/1068-logg…
BadaHertz52 Jan 22, 2025
7c780b7
refactor : route path 만드는 함수명 변경
BadaHertz52 Jan 22, 2025
237139b
Merge branch 'fe/refactor/1069-logged-in-path' into fe/feat/1068-logg…
BadaHertz52 Jan 22, 2025
a4ade66
fix : groupAccessCode에 따른 reviewRequestCode 요청 body 변경 오류 수정
BadaHertz52 Jan 23, 2025
720b134
feat : 목킹 핸들러에서 request.body를 분석하는 유틸 함수 구현
BadaHertz52 Jan 23, 2025
99878dc
feat : reviewRequestCode 요청 목킹 핸들러에서 회원용 reviewRequsetCode 반환
BadaHertz52 Jan 23, 2025
0d4eec6
test : 회원용 reviewRequestCode 테스트 추가
BadaHertz52 Jan 23, 2025
b9978ac
refactor: DataForReviewRequestCode 위치 변경
BadaHertz52 Jan 23, 2025
ebf9de8
refactor : 반복되는 usePostDataForReviewRequestCode 테스트 코드 추상화
BadaHertz52 Jan 23, 2025
11178c5
refactoor : 목서버 유효한 리뷰 요청 코드 변수 추상화
BadaHertz52 Jan 23, 2025
3475641
Merge remote-tracking branch 'origin' into fe/feat/1068-loggined-revi…
BadaHertz52 Feb 2, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions frontend/src/apis/group.ts
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
import { ERROR_BOUNDARY_IGNORE_ERROR, INVALID_REVIEW_PASSWORD_MESSAGE } from '@/constants';
import { PasswordResponse, ReviewGroupData } from '@/types';
import { DataForReviewRequestCode, PasswordResponse, ReviewGroupData } from '@/types';

import createApiErrorMessage from './apiErrorMessageCreator';
import endPoint from './endpoints';

export interface DataForReviewRequestCode {
revieweeName: string;
projectName: string;
groupAccessCode?: string;
}
export const postDataForReviewRequestCodeApi = async ({
groupAccessCode,
...commonRequestData
}: DataForReviewRequestCode) => {
const requestData = groupAccessCode ? { ...commonRequestData, groupAccessCode } : commonRequestData;

export const postDataForReviewRequestCodeApi = async (dataForReviewRequestCode: DataForReviewRequestCode) => {
const response = await fetch(endPoint.postingDataForReviewRequestCode, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
// TODO : 회원 리뷰 링크 API 문서 나오면 비밀번호 관련해 변경해야함
body: JSON.stringify(dataForReviewRequestCode),
body: JSON.stringify(requestData),
});

if (!response.ok) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { DataForReviewRequestCode } from '@/apis/group';
import { Button } from '@/components';
import { HOM_EVENT_NAME } from '@/constants';
import { DataForReviewRequestCode } from '@/types';
import { debounce, trackEventInAmplitude } from '@/utils';

import usePostDataForReviewRequestCode, {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { useMutation, useQueryClient } from '@tanstack/react-query';

import { DataForReviewRequestCode, postDataForReviewRequestCodeApi } from '@/apis/group';
import { postDataForReviewRequestCodeApi } from '@/apis/group';
import { GROUP_QUERY_KEY } from '@/constants';
import { DataForReviewRequestCode } from '@/types';
export interface UsePostDataForReviewRequestCodeProps {
handleAPISuccess: (data: any) => void;
handleAPIError: (error: Error) => void;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,14 @@
import { renderHook, act, waitFor } from '@testing-library/react';

import { VALID_REVIEW_GROUP_REVIEW_REQUEST_CODE } from '@/mocks/mockData/group';
import { VALID_REVIEW_REQUEST_CODE } from '@/mocks/mockData/group';
import QueryClientWrapper from '@/queryTestSetup/QueryClientWrapper';
import { DataForReviewRequestCode } from '@/types';

import usePostDataForReviewRequestCode from '.';

describe('usePostDataForReviewRequestCode', () => {
it('ReviewRequestCode를 발급받을 수 있다.', async () => {
// given
const dataForReviewRequestCode = {
revieweeName: 'ollie',
projectName: 'review-me',
groupAccessCode: '1234',
};

// 공통 로직: renderHook 호출 및 초기화
const setupHook = () => {
const { result } = renderHook(
() =>
usePostDataForReviewRequestCode({
Expand All @@ -24,15 +19,38 @@ describe('usePostDataForReviewRequestCode', () => {
}),
{ wrapper: QueryClientWrapper },
);
return result;
};

// 공통 테스트 로직
const testReviewRequestCode = async (dataForReviewRequestCode: DataForReviewRequestCode, expectedCode: string) => {
const result = setupHook();

// when
act(() => {
result.current.mutate(dataForReviewRequestCode);
});

await waitFor(() => expect(result.current.isSuccess).toBe(true));

// then
expect(result.current.data.reviewRequestCode).toEqual(VALID_REVIEW_GROUP_REVIEW_REQUEST_CODE);
expect(result.current.data.reviewRequestCode).toEqual(expectedCode);
};

it('비회원 - ReviewRequestCode를 발급받을 수 있다.', async () => {
const dataForReviewRequestCode = {
revieweeName: 'ollie',
projectName: 'review-me',
groupAccessCode: '1234',
};

await testReviewRequestCode(dataForReviewRequestCode, VALID_REVIEW_REQUEST_CODE.nonMember);
});

it('회원용 - ReviewRequestCode를 발급받을 수 있다.', async () => {
const dataForReviewRequestCode = {
revieweeName: 'ollie',
projectName: 'review-me',
};

await testReviewRequestCode(dataForReviewRequestCode, VALID_REVIEW_REQUEST_CODE.member);
});
});
4 changes: 2 additions & 2 deletions frontend/src/constants/amplitudeEventName.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ export const PAGE_VISITED_EVENT_NAME: { [key in Exclude<PageName, undefined>]: s
detailedReview: '[page] 리뷰 상세 보기 페이지',
reviewWriting: '[page] 리뷰 작성 페이지',
reviewWritingComplete: '[page] 리뷰 작성 완료 페이지',
reviewLinks: '[page] 리뷰 링크 관리 페이지',
writtenReview: '[page] 작성한 리뷰 확인 페이지',
reviewLinks: '[page] 회원 전용 - 리뷰 링크 관리 페이지',
writtenReview: '[page] 회원 전용 - 작성한 리뷰 확인 페이지',
};

export const REVIEW_WRITING_EVENT_NAME = {
Expand Down
19 changes: 10 additions & 9 deletions frontend/src/constants/route.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
// TODO: ROUTE -> ROUTE 및 상수 인덱스에 추가하기
import { makeRoutePath } from '@/utils';

export const ROUTE = {
home: '/',
reviewList: 'user/review-list',
reviewWriting: 'user/review-writing',
reviewWritingComplete: 'user/review-writing-complete',
detailedReview: 'user/detailed-review',
reviewZone: 'user/review-zone',
reviewCollection: 'user/review-collection',
reviewLinks: 'user/review-links',
writtenReview: 'user/written-review',
reviewList: makeRoutePath('review-list'),
reviewWriting: makeRoutePath('review-writing'),
reviewWritingComplete: makeRoutePath('review-writing-complete'),
detailedReview: makeRoutePath('detailed-review'),
reviewZone: makeRoutePath('review-zone'),
reviewCollection: makeRoutePath('review-collection'),
reviewLinks: makeRoutePath('review-links', true),
writtenReview: makeRoutePath('written-review', true),
};
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import { renderHook, waitFor } from '@testing-library/react';

import { VALID_REVIEW_GROUP_REVIEW_REQUEST_CODE } from '@/mocks/mockData';
import { VALID_REVIEW_REQUEST_CODE } from '@/mocks/mockData';
import QueryClientWrapper from '@/queryTestSetup/QueryClientWrapper';

import useGetReviewGroupData from '.';

describe('리뷰 연결 페이지 리뷰 그룹 데이터 요청 테스트', () => {
it('유효한 reviewRequestCode여야 라뷰 상세 페이지 데이터를 불러온다.', async () => {
const { result } = renderHook(
() => useGetReviewGroupData({ reviewRequestCode: VALID_REVIEW_GROUP_REVIEW_REQUEST_CODE }),
() => useGetReviewGroupData({ reviewRequestCode: VALID_REVIEW_REQUEST_CODE.nonMember }),
{
wrapper: QueryClientWrapper,
},
Expand Down
29 changes: 18 additions & 11 deletions frontend/src/mocks/handlers/group.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,39 @@ import { http, HttpResponse } from 'msw';

import endPoint, { REVIEW_GROUP_DATA_API_PARAMS, REVIEW_GROUP_DATA_API_URL } from '@/apis/endpoints';
import { API_ERROR_MESSAGE, INVALID_REVIEW_PASSWORD_MESSAGE } from '@/constants';
import { getRequestBody } from '@/utils/mockingUtils';

import {
MOCK_AUTH_TOKEN_NAME,
REVIEW_GROUP_DATA,
VALID_REVIEW_GROUP_REVIEW_REQUEST_CODE,
VALID_REVIEW_REQUEST_CODE,
VALIDATED_PASSWORD,
} from '../mockData/group';

// NOTE: reviewRequestCode 생성 정상 응답
const postDataForReviewRequestCode = () => {
return http.post(endPoint.postingDataForReviewRequestCode, async () => {
return HttpResponse.json({ reviewRequestCode: VALID_REVIEW_GROUP_REVIEW_REQUEST_CODE }, { status: 200 });
return http.post(endPoint.postingDataForReviewRequestCode, async ({ request }) => {
// request body의 존재 검증
const bodyResult = await getRequestBody(request);

if (bodyResult instanceof Error) return HttpResponse.json({ error: bodyResult.message }, { status: 400 });
const { nonMember: nonMemberReviewRequestCode, member: memberReviewRequestCode } = VALID_REVIEW_REQUEST_CODE;
return HttpResponse.json(
{
reviewRequestCode: 'groupAccessCode' in bodyResult ? nonMemberReviewRequestCode : memberReviewRequestCode,
},
{ status: 200 },
);
});
};

const postPassWordValidation = () => {
return http.post(endPoint.checkingPassword, async ({ request, cookies }) => {
// request body의 존재 검증
if (!request.body) return HttpResponse.json({ error: API_ERROR_MESSAGE[400] }, { status: 400 });

const rawBody = await request.body.getReader().read();
const textDecoder = new TextDecoder();
const bodyText = textDecoder.decode(rawBody.value);
const bodyResult = await getRequestBody(request);
if (bodyResult instanceof Error) return HttpResponse.json({ error: bodyResult.message }, { status: 400 });

// request에 포함된 값들의 검증 시작
const { reviewRequestCode, groupAccessCode: password } = JSON.parse(bodyText);
const { reviewRequestCode, groupAccessCode: password } = bodyResult;

// 유효하지 않은 비밀번호인 경우
if (password !== VALIDATED_PASSWORD) {
Expand Down Expand Up @@ -67,7 +74,7 @@ const getReviewGroupData = () => {
//요청 url에서 reviewRequestCode 추출
const reviewRequestCode = params.get(queryString.reviewRequestCode);

if (reviewRequestCode === VALID_REVIEW_GROUP_REVIEW_REQUEST_CODE) {
if (reviewRequestCode) {
return HttpResponse.json(REVIEW_GROUP_DATA);
}

Expand Down
5 changes: 4 additions & 1 deletion frontend/src/mocks/mockData/group.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,7 @@ export const REVIEW_GROUP_DATA: ReviewGroupData = {
};

/**리뷰 연결 페이지에서 유효한 reviewRequestCode */
export const VALID_REVIEW_GROUP_REVIEW_REQUEST_CODE = `ABCD1234`;
export const VALID_REVIEW_REQUEST_CODE = {
nonMember: `ABCD1234`,
member: 'MEMBER1234',
};
Comment on lines +15 to +18
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

구분이 더 잘 되는 것 같아서 좋네요👍

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const ReviewLinkDashboard = () => {
return (
<S.ReviewLinkDashboardContainer>
<S.FormSection>
<URLGeneratorForm />
<URLGeneratorForm isMember={true} />
</S.FormSection>
<S.Separator />
<S.LinkSection>
Expand Down
6 changes: 6 additions & 0 deletions frontend/src/types/reviewGroup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,9 @@ export interface ReviewGroupData {
revieweeName: string;
projectName: string;
}

export interface DataForReviewRequestCode {
revieweeName: string;
projectName: string;
groupAccessCode?: string;
}
1 change: 1 addition & 0 deletions frontend/src/utils/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ export * from './highlight/index';
export * from './testUtils';
export * from './analytics';
export * from './validateInput';
export * from './path';
19 changes: 19 additions & 0 deletions frontend/src/utils/mockingUtils.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { DefaultBodyType, StrictRequest } from 'msw';

import { API_ERROR_MESSAGE } from '@/constants';

/**
* api 요청 body를 탐색해 결과를 반환하는 함수
* @param request mock handler의 request
* @returns request body가 있다면 경우 body 객체 반환, 그렇지 않을 경우 Error 반환
*/
export const getRequestBody = async (request: StrictRequest<DefaultBodyType>) => {
// request body의 존재 검증
if (!request.body) return new Error(API_ERROR_MESSAGE[400]);

const rawBody = await request.body.getReader().read();
const textDecoder = new TextDecoder();
const bodyText = textDecoder.decode(rawBody.value);

return JSON.parse(bodyText);
};
5 changes: 5 additions & 0 deletions frontend/src/utils/path.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export const makeRoutePath = (pageName: string, isForMember: boolean = false) => {
let basic = 'user';
if (isForMember) basic += '/logged-in';
return `${basic}/${pageName}`;
};
Loading