07 비동기 호출
7.4 API 모킹
프론트엔드 개발을 하다보면 서버 API가 완성되기 전에 개발을 진행해야 하는 일이 종종 생긴다.
기획이 완료되고 서버 API가 완성된 다음에 프론트엔드 개발을 한 후 QA를 진행할 수 있다면 좋겠지만, 현실에서는 프론트엔드 개발이 서버 개발보다 먼저 이루어지거나 서버와 프론트엔드 개발이 동시에 이루어지는 경우가 더 많다.
그렇다면 이러한 상황에서 프론트엔드 개발을 어떻게 진행할 수 있을까?
단순하게는 개발 중인 코드에 TEMP_DELIVERY_STATUS_TEXT = “배달 중이에요.”와 같이 임시 변수를 만들어서 우선 UI를 구현할 수 있을 것이다.
그런데 리뷰 작성, 주문하기와 같은 POST 요청을 보내야 한다면 그리고 요청 응답에 따라 각기 다른 팝업을 보여주어야 한다면 어떻게 해야 할까?
서버가 별도의 가짜 서버(Mock Server)를 제공한다고 하더라도 프론트엔드 개발 과정에서 발생할 수 있는 모든 예외 사항을 처리하는 것은 쉽지 않다.
또한 매번 테스트를 위해 구현을 반복해야 하기 때문에 번거로울 수 있다.
이럴 때 모킹(Mocking)이라는 방법을 활용할 수 있다.
모킹은 가짜 모듈을 활용하는 것을 말한다.
API를 사용하는 함수 또는 컴포넌트에 대한 테스트를 작성해봤다면 한 번쯤은 jest.fn()과 같은 방법으로 API 함수를 모킹해봤을 것이다.
모킹은 테스트할 때뿐 아니라 개발할 때도 사용할 수 있다.
모킹을 활용하면 앞서 제시한 상황에서 유연하게 대처할 수 있게 된다.
또한 dev 서버가 불안정하거나 AWS 등에 문제가 생겼을 때와 같은 서버 상태에 문제가 발생한 경우에도 서버의 영향을 받지 않고 프론트엔드 개발을 할 수 있게 된다.
이외에도 이슈가 생겼을 때 charles 등의 도구를 활용하면 응답 값을 그대로 복사하여 이슈 발생 상황을 재현하는 데 도움이 된다.
또한 개발하면서 다양한 예외 케이스의 응답을 편하게 테스트해볼 수 있다.
우아한형제들 프론트엔드에서는 axios-mock-adapter, NextApiHandler 등을 활용하여 API를 모킹해서 사용하고 있다.
1. JSON 파일 불러오기
간단한 조회만 필요한 경우에는 *.json 파일을 만들거나 자바스크립트 파일 안에 JSON 형식의 정보를 저장하고 익스포트(export)해주는 방식을 사용하면 된다.
이후 GET 요청에 파일 경로를 삽입해주면 조회 응답으로 원하는 값을 받을 수 있다.
그러나 실제 API URL로 요청하는 것이 아니기 때문에 추후에 요청 경로를 바꿔야 한다.
2. NextApiHandler 활용하기
프로젝트에서 Next.js를 사용하고 있다면 NextApiHandler를 활용할 수 있다.
NextApiHandler는 하나의 파일 안에 하나의 핸들러를 디폴트 익스포트(default export)로 구현해야 하며 파일의 경로가 요청 경로가 된다.
핸들러를 정의하는 것은 간단하다.
응답하고자 하는 값을 정의하고 핸들러 안에서 요청에 대한 응답을 정의한다.
핸들러를 사용하는 경우 단순히 파일을 불러오는 것과 다르게 중간 과정에 응답 처리 로직을 추가할 수 있다.
Next.js
리액트 기반의 프론트엔드 프레임워크다.
리액트 애플리케이션을 쉽게 구축하고 운영하기 위한 도구를 제공하는 프레임워크로서, 서버 사이드 렌더링, 정적 사이트 생성, 코드 스플리팅 등의 기능을 내장하고 있다.
// api/mock/brand
import { NextApiHandler } from 'next'
const BRANDS: Brand[] = [
{
id: 1,
label: '배민스토어',
},
{
id: 2,
label: '비마트',
},
]
const handler: NextApiHandler = (req, res) => {
// request 유효성 검증
res.json(BRANDS)
}
export default handler
3. API 요청 핸들러에 분기 추가하기
요청 경로를 수정하지 않고 평소에 개발할 때 필요한 경우에만 실제 요청을 보내고 그 외에는 목업을 사용하여 개발하고 싶다면 다음과 같이 처리할 수도 있다.
API 요청을 훅 또는 별도 함수로 선언해준 다음 조건에 따라 목업 함수를 내보내거나 실제 요청 함수를 내보낼 수 있다.
const mockFetchBrands = (): Promise<FetchBrandsResponse> => new Promise((resolve) => {
setTimeout(() => {
resolve({
status: 'SUCCESS',
message: null,
data: [
{
id: 1,
label: '배민스토어',
},
{
id: 2,
label: '비마트',
},
],
})
}, 500)
})
const fetchBrands = () => {
if (useMock) {
return mockFetchBrands()
}
return requester.get('/brands')
}
이 방법을 사용하면 개발이 완료된 이후에도 유지보수할 때 목업 함수를 사용할 수 있다.
필요한 경우에만 실제 API에 요청을 보내고 평소에는 서버에 의존하지 않고 개발할 수 있게 된다.
그러나 모든 API 요청 함수에 if 분기문을 추가해야 하므로 번거롭게 느껴질 수도 있다.
4. axios-mock-adapter로 모킹하기
서비스 함수에 분기문이 추가되는 것을 바라지 않는다면 라이브러리를 사용하면 된다.
axios-mock-adapter는 Axios 요청을 가로채서 요청에 대한 응답 값을 대신 반환한다.
먼저 MockAdapter 객체를 생성하고, 해당 객체를 사용하여 모킹할 수 있다.
앞선 2가지 방법과 다르게 mock API의 주소가 필요하지 않다.
앞의 방법과 비슷하게 조회 요청에 대한 목업을 작성하면 다음과 같다.
// mock/index.ts
import axios from 'axios'
import MockAdapter from 'axios-mock-adapter'
import fetchOrderListSuccessResponse from 'fetchOrderListSuccessResponse.json'
interface MockResult {
status?: number;
delay?: number;
use?: boolean;
}
const mock = new MockAdapter(axios, { onNoMatch: 'passthrough' })
export const fetchOrderListMock = () =>
mock
.onGet(/\/order\/list/)
.reply(200, fetchOrderListSuccessResponse)
// fetchOrderListSuccessResponse.json
{
"data": [
{
"orderNo": "ORDER1234",
"orderDate": "2022-02-02",
"shop": {
"shopNo": "SHOP1234",
"name": "가게이름1234",
},
"deliveryStatus": "DELIVERY",
}
]
}
단순히 응답 바디만 모킹할 수도 있지만 상태 코드, 응답 지연 시간 등을 추가로 설정할 수도 있다.
이에 따라 다양한 HTTP 상태 코드에 대한 목업을 정의할 수 있고, API별로 지연 시간을 다르게 설정할 수 있다.
이렇게 응답 처리를 하는 부분을 별도 함수로 구현하면 여러 mock 함수에서 사용할 수 있다.
export const lazyData = (
status: number = Math.floor(Math.random() * 10) > 0 ? 200 : 200,
successData: unknown = defaultSuccessData,
failData: unknown = defaultFailData,
time = Math.floor(Math.random() * 1000)
): Promise<any> =>
new Promise((resolve) => {
setTimeout(() => {
resolve([status, status === 200 ? successData : failData])
}, time)
})
export const fetchOrderListMock = ({
status = 200,
time = 100,
use = true
}: MockResult) =>
use &&
mock
.onGet(/\/order\/list/)
.reply(() =>
lazyData(status, fetchOrderListSuccessResponse, undefined, time)
)
axios-mock-adapter를 사용하면 GET뿐만 아니라 POST, PUT, DELETE 등 다른 HTTP 메서드에 대한 목업을 작성할 수 있게 된다.
또한 networkError, timeoutError 등을 메서드로 제공하기 때문에 다음처럼 임의로 에러를 발생시킬 수도 있다.
export const fetchOrderListMock = () => mock.onPost(/\/order\/list/).networkError()
5. 목업 사용 여부 제어하기
로컬에서는 목업을 사용하고 dev나 운영 환경에서는 사용하지 않으려면 간단한 설정을 해주면 되는데 플래그를 사용하여 목업으로 개발할 때와 개발하지 않을 때를 구분할 수 있다.
이렇게 하면 프로덕션에서 사용되는 코드와 목업을 위한 코드를 분리할 필요가 없다.
프론트엔드 코드를 작성하고 요청을 보낼 때 실제 엔드포인트를 쓸 수 있으므로 새로운 기능을 개발할 때 말고도 유지보수할 때도 작성해둔 목업을 사용할 수 있다.
이렇게 로컬에서 개발할 때는 주로 목업을 사용하고, dev 서버 환경이 필요할 때는 dev 서버를 바라보도록 설정할 수 있다.
이런 식으로 프론트엔드와 서버를 독립시킬 수 있고 혹여나 dev 서버에 문제가 생기더라도 로컬에서 진행되는 프론트엔드 개발에는 영향을 주지 않는다.
const useMock = Object.is(REACT_APP_MOCK, 'true')
const mockFn = ({ status = 200, time = 100, use = true }: MockResult) => use &&
mock.onGet(/\/order\/list/).reply(() =>
new Promise((resolve) =>
setTimeout(() => {
resolve([
status,
status === 200 ? fetchOrderListSuccessResponse : undefined,
])
}, time)
)
)
if (useMock) {
mockFn({ status: 200, time: 100, use: true })
}
다음처럼 플래그에 따라 mockFn을 제어할 수 있는데 매개변수를 넘겨 특정 mock 함수만 동작하게 하거나 동작하지 않게 할 수 있다.
스크립트 실행 시 구분 짓고자 한다면 package.json에 관련 스크립트를 추가해줄 수 있다.
// package.json
{
...,
"scripts": {
...
"start:mock": "REACT_APP_MOCK=true npm run start",
"start": "REACT_APP_MOCK=false npm run start",
},
...
}
이렇게 자바스크립트 코드의 실행 여부를 제어하지 않고 config 파일을 별도로 구성하거나 프록시를 사용할 수도 있다.
axios-mock-adapter를 사용하는 경우에는 API 요청을 중간에 가로채는 것이기 때문에 실제로 API 요청을 주고받지 않는다.
따라서 브라우저가 제공하는 개발자 도구의 네트워크 탭에서는 확인하기 어렵다.
API 요청의 흐름을 파악하고 싶다면 react-query-devtools 혹은 redux test tool과 같이 별도의 도구를 사용해야 한다.
목업을 사용할 때 네트워크 요청을 확인하고 싶을 때는 네트워크에 보낸 요청을 변경해주는 Cypress 같은 도구의 웹훅을 사용하면 된다.
Cypress
프론트엔드 테스트를 위한 오픈 소스 자바스크립트 엔드 투 엔드 테스트 도구다.
주로 웹 애플리케이션의 동작을 시뮬레이션하고 테스트하는 데 사용된다.
Cypress는 사용하기 쉽고 강력한 기능을 제공하여 웹 애플리케이션을 더욱 견고하고 안정적으로 개발할 수 있도록 도와준다.
앞에서 소개한 모킹 방식 외에도 최근에는 서비스워커를 활용하는 라이브러리인 MSW를 도입한 팀도 있다.
MSW를 사용하면 모킹 시 개발 환경과 운영 환경을 분리할 수 있으며, 개발자 도구의 네트워크 탭에서 API 통신을 확인할 수 있다.