프리온보딩 9팀

👑 권준	김경훈	김수정
@jun-05	@tirhande	@crystal993

송슬기	오나래	이창훈	전이진
@songseul	@NR0617	@anotheranotherhoon	@pongdang

배포링크

✨ 배포링크

프로젝트의 실행 방법

git clone [email protected]:Wanted-07-team-9/wanted_assignment_01.git

cd wanted-pre-onboarding-frontend

npm install

npm start

open http://localhost:3000

commit msg 규칙

1. 커밋 유형 지정하기

⭐ feat : 새로운 기능에 대한 커밋

🛠 fix : 버그 수정에 대한 커밋

🧱 build : 빌드 관련 파일 수정에 대한 커밋

👏 chore : 그 외 자잘한 수정에 대한 커밋

⚒ refactor :  코드 리팩토링에 대한 커밋

🎨 style : 코드 스타일 혹은 포맷 등에 관한 커밋

✏ docs : 문서 수정에 대한 커밋

💡 ci : CI관련 설정 수정에 대한 커밋

Best Practice

✨ 선정 기준

✨ 선정 이유

작업한 내용

1. Context API를 활용한 라우터 가드 처리 (with HoC)

Context API로 유저의 로그인 상태를 전역에서 관리할 수 있도록 하였고 상태에 따라 접근할 수 있는 라우터를 처리했습니다.

• HoC로 작성된 함수에서 접근 대상에 따른 페이지의 타입(member | guest)을 명시하여 isLogin 상태와 비교합니다.
• 로그인하지 않은 상태(isLogin === false)에서 member들만 접근할 수 있는 페이지(/todo)를 접근하려 한다면 로그인 페이지(/) 로 리다이렉트 시켜줍니다.
• 로그인한 상태(isLogin === true)에서 guest들만 접근할 수 있는 페이지(/, /signup)을 접근하려 한자면 투두 페이지(/todo) 로 리다이렉트 시켜줍니다.

2. Suspense 를 이용한 선언적인 비동기 함수 처리의 로딩처리

Suspense를 활용하면 비동기 함수 호출의 상태에 따라 UI 를 선언적으로 보여줄 수 있습니다.

• Suspense의 원리에 대해 찾아보고, 이를 참고하여 라이브러리(react-query, Relay) 없이 사용할 수 있도록 필요한 부분만 useFetch로 재구현하였습니다.
• 로딩 중일 때는 Promise를 throw 하여 Suspense 에서 fallback 엘리먼트를 렌더링하도록 합니다.
• useFetch 에서 invalidate 함수를 얻어서 특정 쿼리(fetchTodoList)를 다시 refetch 할 수 있습니다.

3. ErrorBoundary 를 이용한 선언적인 에러 처리 (event 에러를 잡기위한 EventErrorHandler 구현)

ErrorBoundary는 error가 발생했을 때 어떤 UI를 보여줄 것인지 설정할 수 있습니다.

• 그러나 이벤트 핸들러(onClick, onChange 등등)에서 발생한 error는 일반적으로 ErrorBoundary에서 catch 하지 못합니다.
• 이벤트 핸들러에서 발생한 에러를 ErrorBoundary에서 catch 하도록 ErrorBoundary 클래스 컴포넌트를 개선하였습니다.
• unhandledrejection/error 라는 이벤트를 이용해 이벤트 핸들러에서 발생한 error를 전파시켜 ErrorBoundary에서 renderFallback 을 이용해 UI 를 보여줄 수 있습니다.

4. form의 유효성을 검사를 위한 useFormField hook을 구현

이전에는 이메일, 비밀번호과 같은 여러 form의 유효성을 검사할 때 상태를 form 의 개수만큼 만들고 그에 따른 change 함수도 작성해야 했습니다.

form을 검증하는 역할을 한 곳에 위임하고자 useFormField hook을 만들었습니다.

const {
  value: password,
  onChange: onChangePassword,
  errorMessage: passwordErrorMessage,
} = useFormField({
  validators: [
    { ok: value => isEmptyValue(value), message: '비밀번호를 입력해주세요' },
    {
      ok: value => isValidPassword(value),
      message: '비밀번호는 8자 이상이어야 합니다',
    },
  ],
});

validators 배열 안에 value의 유효성을 검사하는 함수를 넣어, 그 함수의 결과에 따라 errorMessage 가 반환되도록 했습니다. 또 유효성 관련 함수는 validation 파일 안에 선언하여 import 하여 사용할 수 있습니다.

Best Practice 적용 사항

1. 폴더구조

└─ src
   ├─ api
   ├─ components
   ├─ contexts
   ├─ hooks
   ├─ pages
   ├─ util
   ├─ Router.jsx
   ├─ App.css
   ├─ App.js
   └─ index.js

2. 로그인/회원가입 경로 구분

• 로그인 : /
• 회원가입 :/signup

3. 이메일, 비밀번호 유효성 검사 기능

// util/validation.js

export function isEmptyValue(value) {
  return value.trim() !== '';
}

export function isValidEmail(value) {
  return value.includes('@');
}

export function isValidPassword(value) {
  return value.length >= 8;
}

• 유효성 관련 함수는 다른 파일로 분리하였습니다.

4. 로그인 API 호출 성공시 /todo 이동

ErrorBoundary 로 Error를 관리하여 따로 status 코드에 따라 이동시키는 로직을 작성하지 않아도 됩니다.

await login(user);

navigate('/todo');

5. JWT 토큰값 로컬 스토리지에 저장

• context API로 로그인 상태와 accessToken을 관리합니다.
• token을 get, set, remove 하는 함수를 만들어서 사용합니다.

// contexts/TokenContext.js

const tokenStorage = {
  get: () => {
    return localStorage.getItem('access_token') || '';
  },
  set: accessToken => {
    localStorage.setItem('access_token', accessToken);
  },
  remove: () => {
    localStorage.removeItem('access_token');
  },
};

6. 로그인 여부에 따른 리다이렉트 처리

// components/Redirect.jsx

import { Navigate } from 'react-router-dom';

export function Redirect({ to }) {
  return <Navigate replace to={to} />;
}

• Redirect를 시켜주는 컴포넌트를 만들었습니다.

// util/withAuthGuard.js

import { Redirect } from '../components/Redirect';
import { useTokenContext } from '../contexts/TokenContext';

export function withAuthGuard(type, Component) {
  // eslint-disable-next-line react-hooks/rules-of-hooks
  const { isLogin } = useTokenContext();

  // 로그인을 하지 않았는데 member만 접근할 수 있는 페이지에 접근하려 했을 때
  if (!isLogin && type === 'member') {
    // '/' 페이지로 리다이렉트
    return <Redirect to="/" />;
  }

  // 로그인을 했는데 guest만 접근할 수 있는 페이지에 접근하려 했을 때
  if (isLogin && type === 'guest') {
    // '/todo' 페이지로 리다이렉트
    return <Redirect to="/todo" />;
  }

  return Component;
}

• 로그인 상태와 페이지 타입을 비교하여 올바르지 않은 url로 이동시 리다이렉트 되도록 했습니다.
• 자세한 내용은 작업한 내용의 1. Context API를 활용한 라우터 가드 처리 (with HoC) 에서 확인할 수 있습니다.

7. 투두 리스트 목록 (/todo 접속시)

• useFetch hook을 사용하여 목록을 가져오도록 했습니다.
• 자세하나 내용은 작업한 내용의 2. Suspense 를 이용한 선언적인 비동기 함수 처리의 로딩처리 에서 확인할 수 있습니다.

그 외 기능(옵션)

• 에러 메시지를 모달창으로 확인할 수 있습니다.
• 로그아웃 기능