빌드 캐시의 입력을 빠뜨리지 않기, 경계 조건에서 다시 살펴보기

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

대표 예제 하나가 통과해도 기능의 경계가 명확해진 것은 아니다. 값이 없거나 예상보다 많을 때, 실행이 늦어지거나 순서가 바뀔 때 다른 규칙이 숨어 있을 수 있다. 이번 기록에서는 정상 경로를 유지한 채 입력 범위를 넓혀 보고 무엇을 허용할지 구분한다.

정상 경로 밖의 입력

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

이번에 확인할 질문: 예상 범위를 벗어난 입력은 조용히 다른 결과를 만들지 않고 구분되는가?

작게 확인하는 예제

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

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

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

놓치기 쉬운 조건

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

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

다음 변경에 적용할 순서

1. 빈 값과 최소 크기부터 확인 범위를 넓힌다.
2. 한 번에 여러 경계를 섞지 않고 각각의 결과를 기록한다.
3. 지원하지 않는 조건은 허용 범위와 함께 분명하게 설명한다.

모든 입력을 성공시켜야 좋은 인터페이스가 되는 것은 아니다. 지원 범위를 예측할 수 있고 실패 이유가 분명한 편이 더 다루기 쉽다. 경계 조건을 문서와 예제에 함께 남겨야 다음 구현에서도 같은 기준을 적용할 수 있다.