빌드 캐시의 입력을 빠뜨리지 않기, 실패를 설명할 단서 남기기

오래된 산출물이 캐시에서 복원되면 코드가 수정됐는데도 변경이 반영되지 않을 수 있다. 캐시 키는 결과에 영향을 주는 입력을 설명해야 한다.

실패했다는 사실만으로는 다음 행동을 정하기 어렵다. 어떤 입력으로 어디까지 진행했으며 무엇을 기대했는지가 함께 있어야 한다. 이번에는 성공 여부를 표시하는 데서 한 걸음 더 나아가, 다음 사람이 같은 조건을 확인할 수 있도록 관찰 항목을 정리한다.

결과와 원인을 구분하는 기록

런타임, 플랫폼, 잠금 파일, 관련 설정을 캐시 키에 포함한다. 복원한 캐시가 없어도 동일한 결과를 만들 수 있는 설치와 빌드 경로를 유지한다.

이번에 확인할 질문: 결과만 전달받은 사람이 원래 입력과 기대 동작을 복원할 수 있는가?

작게 확인하는 예제

다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.

cache key inputs
- operating system and architecture
- runtime version
- lockfile digest
- build configuration digest

잠금 파일과 빌드 설정을 각각 바꿨을 때 캐시가 적절히 무효화되는지 확인한다.

놓치기 쉬운 조건

사용자 비밀 값이나 개인 경로를 캐시 내용에 포함하지 않도록 한다. 서로 다른 브랜치가 같은 쓰기 가능한 캐시를 덮어쓸 때의 충돌도 고려한다.

확인할 부분	살펴볼 내용
기준 동작	잠금 파일과 빌드 설정을 각각 바꿨을 때 캐시가 적절히 무효화되는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 기대 결과와 실제 결과를 서로 다른 칸에 적는다.
2. 개인정보나 비밀값을 제외하고 재현에 필요한 조건만 남긴다.
3. 관찰 사실과 원인에 대한 가설을 구분해 후속 확인을 정한다.

기록을 많이 남기는 것과 유용하게 남기는 것은 다르다. 원인을 좁히는 데 쓰이지 않는 항목은 줄이고, 누락 때문에 다시 묻게 되는 조건은 보완한다. 관찰할 수 있는 범위가 분명해지면 실패한 상황에서도 다음 실험을 작게 잡을 수 있다.