빌드 캐시의 입력을 빠뜨리지 않기, 작은 재현 예제로 좁혀 가기

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

화면이나 실행 결과가 예상과 다를 때 전체 시스템을 한꺼번에 설명하려 하면 단서가 흐려진다. 관련 없는 의존성을 덜어 내고 조건을 하나씩 바꾸면 어느 가정이 깨졌는지 볼 수 있다. 이번에는 원인을 단정하기 전에 비교 가능한 최소 예제를 만드는 과정을 정리한다.

변수를 줄이는 순서

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

이번에 확인할 질문: 한 가지 조건만 바꾸었을 때 관찰 결과도 함께 바뀌는가?

작게 확인하는 예제

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

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

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

놓치기 쉬운 조건

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

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

다음 변경에 적용할 순서

1. 문제가 드러나는 입력과 순서를 먼저 고정한다.
2. 의존성이나 옵션을 하나씩 제거하고 같은 결과가 남는지 확인한다.
3. 원인을 설명하는 가장 작은 차이를 회귀 확인 항목으로 남긴다.

재현 예제의 목적은 짧은 코드를 자랑하는 데 있지 않다. 설명에 필요한 조건을 남기는 것이 목적이다. 실제 경로로 돌아왔을 때도 같은 원인과 해결책이 성립하는지 마지막으로 확인해야 재현 과정이 유용한 기록이 된다.