검색 요청의 순서 뒤집힘 막기, 유지보수할 때 남겨 둘 예제
빠르게 입력한 검색어의 응답보다 이전 검색어의 응답이 늦게 도착할 수 있다. 다시 읽을 수 있는 최소 맥락를 중심으로 작은 예제와 확인 기준을 정리합니다.
빠르게 입력한 검색어의 응답보다 이전 검색어의 응답이 늦게 도착할 수 있다.
시간이 지나면 왜 이렇게 구현했는지보다 어떻게 실행하는지만 남기기 쉽다. 옵션과 제약을 잊은 채 코드를 정리하면 의도했던 동작까지 바뀔 수 있다. 이번에는 작은 예제를 실행 가능한 설명으로 남기고, 구현이 달라져도 유지할 부분을 분리한다.
다시 읽을 수 있는 최소 맥락
새 요청을 시작할 때 이전 요청을 취소하고, 요청의 완료 순서가 화면의 최신 상태를 결정하지 않도록 한다. 취소와 실제 네트워크 오류는 구분해 처리한다.
이번에 확인할 질문: 내부 구조를 바꾸더라도 이 예제가 설명하는 결과는 그대로 유지되어야 하는가?
작게 확인하는 예제
다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.
let previous;
async function search(query) {
previous?.abort();
const controller = new AbortController();
previous = controller;
const response = await fetch(`/api/search?q=${encodeURIComponent(query)}`,
{ signal: controller.signal });
if (!response.ok) throw new Error('검색 요청 실패');
return response.json();
}
첫 요청은 늦게, 두 번째 요청은 빨리 응답하도록 만들어 최신 검색어의 결과가 유지되는지 확인한다.
놓치기 쉬운 조건
요청 취소는 서버에서 이미 시작한 작업까지 반드시 취소한다는 뜻이 아니다. 호출부에서는 AbortError를 사용자에게 보일 실패로 취급하지 않도록 한다.
| 확인할 부분 | 살펴볼 내용 |
|---|---|
| 기준 동작 | 첫 요청은 늦게, 두 번째 요청은 빨리 응답하도록 만들어 최신 검색어의 결과가 유지되는지 확인한다. |
| 비교 조건 | 입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다. |
| 적용 범위 | 예제가 생략한 의존성과 실제 서비스의 제약을 구분한다. |
다음 변경에 적용할 순서
- 구현 세부 사항보다 외부에서 관찰하는 결과를 적는다.
- 예제가 의존하는 입력과 환경을 가까이에 둔다.
- 설명이 실제 동작과 달라지면 코드와 예제를 같은 변경에서 고친다.
오래 남는 문서는 가장 긴 문서가 아니라 다시 확인할 수 있는 문서다. 선택의 이유와 작동하는 예제가 함께 있으면 새로운 구현으로 옮길 때도 기준을 잃지 않는다. 중복 설명을 늘리기보다 정본이 어디인지 분명히 하는 편이 유지 비용을 줄인다.
이 이야기가 도움이 되었나요?