종속 항목 관리

문제 신고 소스 보기

이전 페이지를 살펴보면 한 가지 테마가 계속해서 반복됩니다. 자체 코드를 관리하는 것은 매우 간단하지만 종속 항목을 관리하는 것이 훨씬 더 어렵습니다. 모든 종속 항목이 있습니다. 작업에 대한 종속 항목(예: '출시를 완료로 표시하기 전에 문서 푸시')과 아티팩트에 대한 종속 항목(예: '코드를 빌드하려면 최신 버전의 컴퓨터 비전 라이브러리가 필요합니다')이 있습니다. 코드베이스의 다른 부분에 내부 종속 항목이 있거나 코드 또는 외부 조직에 외부 종속 항목이 있는 경우도 있습니다. 어떤 경우든 '사용 가능해야 합니다'라는 개념은 빌드 시스템 설계에서 반복적으로 발생하고 있으며 종속 항목 관리는 빌드 시스템의 가장 기본적인 작업일 수 있습니다.

모듈 및 종속 항목 처리

Bazel과 같은 아티팩트 기반 빌드 시스템을 사용하는 프로젝트는 모듈 집합으로 나뉘며 모듈은 BUILD 파일을 통해 서로의 종속 항목을 표현합니다. 이러한 모듈과 종속 항목을 제대로 구성하면 빌드 시스템의 성능과 유지관리에 필요한 작업에 큰 영향을 미칠 수 있습니다.

세분화된 모듈 및 1:1:1 규칙 사용

아티팩트 기반 빌드를 구조화할 때 첫 번째로 떠오르는 질문은 개별 모듈이 얼마나 많은 기능을 포함해야 하는지 결정하는 것입니다. Bazel에서 모듈java_library 또는 go_binary와 같은 빌드 가능한 단위를 지정하는 대상으로 표시됩니다. 극단적으로는 전체 프로젝트에 하나의 BUILD 파일을 루트에 배치하고 해당 프로젝트의 모든 소스 파일을 재귀적으로 합쳐서 단일 모듈에 포함할 수 있습니다. 다른 극단적인 경우, 거의 모든 소스 파일을 자체 모듈로 만들 수 있으므로 실질적으로 각 파일을 사용하는 다른 모든 파일을 BUILD 파일에 나열해야합니다.

대부분의 프로젝트는 이러한 극단적인 부분 사이에 있으며, 성능과 유지관리 가능성 사이에서 절충점을 선택합니다. 전체 프로젝트에 단일 모듈을 사용하면 외부 종속 항목을 추가하는 경우를 제외하고 BUILD 파일을 수정할 필요가 없을 수 있지만 빌드 시스템은 항상 전체 프로젝트를 한 번에 빌드해야 합니다. 즉, 빌드의 일부를 병렬로 배포하거나 배포할 수 없으며 이미 빌드된 부분을 캐시할 수도 없습니다. 파일당 모듈 1은 그 반대입니다. 빌드 시스템은 빌드의 캐싱 및 일정 예약 단계에서 최대한의 유연성을 발휘하지만, 엔지니어는 어느 파일이 어느 파일을 참조하는지 변경할 때마다 종속 항목 목록을 유지관리하는 데 더 많은 노력을 기울여야 합니다.

정확한 세부사항은 언어 및 언어 내에서도 다양하지만 Google에서는 일반적으로 작업 기반 빌드 시스템에서 작성할 때보다 훨씬 작은 모듈을 선호하는 경향이 있습니다. Google의 일반적인 프로덕션 바이너리는 종종 수만 개의 대상에 종속되며 보통 규모의 팀도 코드베이스 내에서 수백 개의 타겟을 소유할 수 있습니다. 패키징과 같은 강력한 기본 제공 개념이 있는 자바와 같은 언어의 경우 각 디렉터리에는 일반적으로 단일 패키지, 타겟 및 BUILD 파일이 포함됩니다 (Bazel을 기반으로 하는 또 다른 빌드 시스템인 Pants에서는 이를 1:1:1 규칙이라고 함). 패키징 규칙이 약한 언어는 BUILD 파일당 타겟을 여러 개 정의하는 경우가 많습니다.

작은 빌드 대상의 이점은 더 큰 분산 빌드로 이어지고 대상을 다시 빌드해야 하는 경우가 적기 때문에 규모에 맞게 표시되기 시작합니다. 테스트가 그림에 진입한 후의 이점은 훨씬 더 강력해집니다. 더 세부적인 타겟을 통해 빌드 시스템은 지정된 변경사항의 영향을 받을 수 있는 제한된 하위 집합의 테스트만 실행하는 것이 훨씬 더 지능적일 수 있습니다. Google은 더 작은 타겟을 사용할 때 시스템상 이점이 있다고 믿기 때문에 BUILD 파일을 자동으로 관리하여 개발자에게 부담을 주지 않도록 도구에 투자함으로써 부정적인 영향을 완화할 수 있었습니다.

buildifierbuildozer와 같은 이러한 도구는 buildtools 디렉터리의 Bazel과 함께 사용할 수 있습니다.

모듈 공개 상태 최소화

Bazel 및 기타 빌드 시스템을 사용하면 각 대상이 공개 상태를 지정할 수 있습니다. 가시성은 이 대상에 종속될 수 있는 다른 대상을 결정하는 속성입니다. 비공개 타겟은 자체 BUILD 파일 내에서만 참조할 수 있습니다. 타겟은 명시적으로 정의된 BUILD 파일 목록의 대상에 관한 광범위한 가시성을 부여할 수 있습니다. 공개 가시성의 경우에는 작업공간의 모든 대상에 더 넓은 가시성을 부여할 수도 있습니다.

대부분의 프로그래밍 언어와 마찬가지로, 가시성을 최대한 최소화하는 것이 좋습니다. 일반적으로 Google팀은 이러한 타겟이 Google의 모든 팀에서 널리 사용되는 라이브러리를 나타내는 경우에만 타겟을 공개합니다. 코드를 사용하기 전에 다른 팀의 협조를 구하는 팀은 대상의 공개 상태로 고객 대상의 허용 목록을 유지합니다. 각 팀의 내부 구현 대상은 팀이 소유한 디렉터리로 제한되며 대부분의 BUILD 파일에는 비공개가 아닌 타겟이 하나만 있습니다.

종속 항목 관리

모듈은 서로를 참조할 수 있어야 합니다. 코드베이스를 세분화된 모듈로 분할할 때의 단점은 모듈 간의 종속 항목을 관리해야 한다는 것입니다 (도구는 이를 자동화하는 데 도움이 될 수 있음). 이러한 종속 항목을 표현하면 일반적으로 BUILD 파일에 있는 콘텐츠의 대량이 됩니다.

내부 종속 항목

세분화된 모듈로 분할된 대규모 프로젝트에서는 대부분의 종속 항목이 동일한 내부 저장소에 정의되고 빌드된 다른 대상에 종속될 가능성이 높습니다. 내부 종속 항목은 빌드를 실행하는 동안 사전 빌드된 아티팩트로 다운로드되는 것이 아니라 소스에서 빌드된다는 점에서 외부 종속 항목과 다릅니다. 또한, 내부 종속 항목에 대한 '버전' 개념도 없습니다. 즉, 대상과 모든 내부 종속 항목은 항상 저장소에서 동일한 커밋/버전에 빌드됩니다. 내부 종속 항목과 관련하여 신중하게 처리해야 하는 문제 중 하나는 전이 종속 항목을 처리하는 방법입니다 (그림 1). 타겟 A가 공통 라이브러리 타겟 C에 종속되는 타겟 B에 종속된다고 가정해 보겠습니다. 타겟 A가 타겟 C에 정의된 클래스를 사용할 수 있어야 하나요?

전이 종속 항목

그림 1. 전이 종속 항목

기본 도구와 관련된 경우에는 문제가 없습니다. 빌드될 때 B와 C 모두 타겟 A에 연결되므로 C에 정의된 모든 기호는 A로 알려져 있습니다. Bazel은 수년 동안 이를 허용했지만 Google이 성장함에 따라 문제가 발생하기 시작했습니다. B가 더 이상 C에 종속될 필요가 없도록 리팩터링되었다고 가정합니다. 그런 다음 B에 대한 C의 종속 항목이 삭제되면 A와 B의 종속 항목을 통해 C를 사용한 다른 대상이 중단됩니다. 실질적으로 타겟의 종속 항목은 공개 계약의 일부였으며 안전하게 변경할 수 없었습니다. 즉, 시간이 지남에 따라 종속 항목이 누적되고 Google에서 빌드가 느려지기 시작했습니다.

Google은 Bazel에 '엄격한 전이적 종속 항목 모드'를 도입하여 이 문제를 해결했습니다. 이 모드에서 Bazel은 대상이 기호에 직접 의존하지 않고 참조하려고 시도하는지 여부를 감지하려고 하면 실패하며, 종속 항목을 자동으로 삽입하는 데 사용할 수 있는 셸 명령어와 함께 실패합니다. 이 변경사항을 Google의 전체 코드베이스에 적용하고 수백만 개의 빌드 타겟 중 하나를 리팩터링하여 종속 항목을 명시적으로 나열한 것은 수년 간의 노력이었지만 그만한 가치가 있었습니다. 타겟의 불필요한 종속 항목이 적기 때문에 빌드가 훨씬 빨라졌으며 엔지니어는 타겟에 종속된 타겟을 손상시키지 않고 불필요한 종속 항목을 삭제할 수 있습니다.

평소와 같이 엄격한 전이 종속 항목을 적용하면 절충해야 합니다. 이제 자주 사용되는 라이브러리를 실수로 가져오는 대신 여러 위치에 명시적으로 나열해야 하고 엔지니어가 BUILD 파일에 종속 항목을 추가하는 데 더 많은 노력을 들여야 했으므로 빌드 파일이 더 상세해졌습니다. 그 이후로 Google은 누락된 여러 종속 항목을 자동으로 감지하고 개발자의 개입 없이 BUILD 파일에 추가하여 이러한 수작업을 줄이는 도구를 개발했습니다. 하지만 이러한 도구가 없어도 코드베이스가 확장됨에 따라 절충할 만한 가치가 있는 것으로 나타났습니다. BUILD 파일에 종속 항목을 명시적으로 추가하는 것은 일회성 비용이지만 빌드 대상이 존재하는 한 암시적 전이 종속 항목을 처리하는 경우 지속적인 문제가 발생할 수 있습니다. Bazel은 기본적으로 자바 코드에 엄격한 전이 종속 항목을 적용합니다.

외부 종속 항목

종속 항목이 내부 요소가 아니라면 외부에 있어야 합니다. 외부 종속 항목은 빌드 시스템 외부에서 빌드되어 저장된 아티팩트의 종속 항목입니다. 종속 항목은 아티팩트 저장소 (일반적으로 인터넷을 통해 액세스)에서 직접 가져오며 소스에서 빌드되지 않고 그대로 사용됩니다. 외부 종속 항목과 내부 종속 항목의 가장 큰 차이점 중 하나는 외부 종속 항목에 버전이 있고 이러한 버전이 프로젝트의 소스 코드와 관계없이 존재한다는 점입니다.

자동 종속 항목과 수동 종속 항목 관리 비교

빌드 시스템을 사용하면 외부 종속 항목의 버전을 수동 또는 자동으로 관리할 수 있습니다. 수동으로 관리되는 경우 빌드 파일은 아티팩트 저장소에서 다운로드하려는 버전을 명시적으로 나열하며 주로 1.1.4와 같은 시맨틱 버전 문자열을 사용합니다. 자동으로 관리되는 경우 소스 파일은 허용되는 버전의 범위를 지정하며 빌드 시스템은 항상 최신 버전을 다운로드합니다. 예를 들어, Gradle은 주 버전이 1인 한 종속 항목의 부 버전 또는 패치 버전이 허용됨을 나타내기 위해 종속 항목 버전을 '1.+'로 선언할 수 있습니다.

자동으로 관리되는 종속 항목은 소규모 프로젝트에 편리할 수 있지만 일반적으로 크기가 작거나 여러 엔지니어가 작업 중인 프로젝트의 재해에 대한 레시피입니다. 자동으로 관리되는 종속 항목의 문제는 버전이 업데이트되는 시점을 제어할 수 없다는 것입니다. 시맨틱 버전 관리를 사용한다고 주장하는 경우에도 외부 당사자가 브레이킹 체인지를 방지한다고 보장할 수는 없으므로, 어느 날 효과가 있었던 빌드가 다음에는 손상될 수 있습니다. 변경된 사항을 쉽게 감지하거나 작업 상태로 롤백할 수 있는 방법이 없기 때문입니다. 빌드가 중단되지 않더라도 추적할 수 없는 미묘한 동작이나 성능 변경사항이 있을 수 있습니다.

반면 수동으로 관리되는 종속 항목은 소스 제어를 변경해야 하므로 쉽게 검색하고 롤백할 수 있으며 이전 버전의 저장소를 체크아웃하여 이전 종속 항목으로 빌드할 수 있습니다. Bazel을 사용하려면 모든 종속 항목의 버전을 수동으로 지정해야 합니다. 적당한 규모로도 수동 버전 관리의 오버헤드가 제공하는 안정성 측면에서 충분히 가치가 있습니다.

단일 버전 규칙

라이브러리의 여러 버전은 일반적으로 다양한 아티팩트로 표현되므로 이론적으로는 동일한 외부 종속 항목의 여러 버전을 빌드 시스템에서 서로 다른 이름으로 선언할 수 없는 이유는 없습니다. 이렇게 하면 각 타겟에서 사용하려는 종속 항목의 버전을 선택할 수 있습니다. 실제로 많은 문제가 발생하므로 Google은 코드베이스의 모든 서드 파티 종속 항목에 엄격한 단일 버전 규칙을 적용합니다.

여러 버전을 허용할 때 가장 큰 문제는 다이아몬드 종속 항목 문제입니다. 타겟 A가 타겟 B와 외부 라이브러리의 v1에 종속된다고 가정해 보겠습니다. 나중에 타겟 B가 동일한 외부 라이브러리의 v2에 종속 항목을 추가하도록 리팩터링되면 타겟 A가 암시적으로 동일 라이브러리의 두 가지 다른 버전에 암시적으로 종속됩니다. 실제로 타겟의 새 종속 항목을 여러 버전이 있는 서드 파티 라이브러리에 추가하는 것은 안전하지 않습니다. 대상의 사용자가 이미 다른 버전에 종속될 수 있기 때문입니다. 한 버전 규칙을 따르면 이러한 충돌이 불가능합니다. 대상이 서드 파티 라이브러리에 종속 항목을 추가하면 기존 종속 항목은 이미 동일한 버전에 있으므로 함께 공존할 수 있습니다.

전이 외부 종속 항목

외부 종속 항목의 전이 종속 항목을 처리하는 것은 특히 어려울 수 있습니다. Maven Central과 같은 많은 아티팩트 저장소에서 아티팩트가 저장소에서 다른 아티팩트의 특정 버전에 대한 종속 항목을 지정할 수 있도록 허용합니다. Maven 또는 Gradle과 같은 빌드 도구는 기본적으로 각 전이 종속 항목을 반복적으로 다운로드합니다. 즉, 프로젝트에 단일 종속 항목을 추가하면 총 수십 개의 아티팩트가 다운로드될 수 있습니다.

이 기능은 매우 편리합니다. 새 라이브러리에 종속 항목을 추가할 때 각 라이브러리의 전이 종속 항목을 추적하고 수동으로 모두 추가해야 하는 것은 매우 번거로운 일입니다. 하지만 서로 다른 라이브러리가 동일한 서드 파티 라이브러리의 서로 다른 버전에 종속될 수 있다는 단점도 있습니다. 이 전략은 단일 버전 규칙을 반드시 위반하고 다이아몬드 종속 항목 문제를 일으킵니다. 타겟이 동일한 종속 항목의 서로 다른 버전을 사용하는 외부 라이브러리 두 개에 종속되는 경우 어떤 라이브러리를 가져올지 알 수 없습니다. 즉, 새 버전에서 일부 종속 항목의 충돌하는 버전을 가져오기 시작하면 코드베이스 전체에서 관련이 없어 보이는 장애가 발생할 수 있습니다.

이러한 이유로 Bazel은 전이 종속 항목을 자동으로 다운로드하지 않습니다. 안타깝게도 Bazel의 대안은 저장소의 외부 종속 항목을 모두 나열하는 전역 파일과 저장소 전체에서 이 종속 항목에 사용되는 명시적 버전을 요구하는 것입니다. 다행히 Bazel은 Maven 아티팩트 세트의 전이 종속 항목이 포함된 이러한 파일을 자동으로 생성할 수 있는 도구를 제공합니다. 이 도구를 한 번 실행하여 프로젝트의 초기 WORKSPACE 파일을 생성한 다음, 이 파일을 수동으로 업데이트하여 각 종속 항목의 버전을 조정할 수 있습니다.

하지만 선택의 편리성과 확장성 중 하나를 선택해야 합니다. 소규모 프로젝트는 전이 종속 항목 관리를 걱정할 필요가 없으며 자동 전이 종속 항목을 사용하지 않아도 될 수 있습니다. 이 전략은 조직과 코드베이스가 성장함에 따라 흥미를 떨어뜨리며 충돌과 예상치 못한 결과가 점점 더 자주 발생합니다. 대규모 종속 항목의 수동 관리 비용은 자동 종속 항목 관리로 인한 문제를 처리하는 비용보다 훨씬 적습니다.

외부 종속 항목을 사용하여 빌드 결과 캐싱

외부 종속 항목은 아마도 소스 코드를 제공하지 않고 라이브러리의 안정화 버전을 출시하는 서드 파티에서 제공하는 경우가 많습니다. 일부 조직은 자체 코드 중 일부를 아티팩트로 사용하도록 선택할 수도 있으며, 이 경우 다른 코드 조각이 내부 종속 항목이 아닌 타사로 종속될 수 있습니다. 이론적으로 아티팩트 빌드가 느리지만 다운로드 속도가 빠른 경우 빌드 속도를 높일 수 있습니다.

그러나 이로 인해 많은 오버헤드와 복잡성이 발생합니다. 즉, 각 아티팩트를 빌드하고 아티팩트 저장소에 업로드해야 하며 클라이언트가 최신 버전으로 최신 상태를 유지하도록 해야 합니다. 또한 시스템의 여러 부분이 저장소의 여러 지점에서 빌드되었고 소스 트리에 대한 일관된 뷰가 없기 때문에 디버깅이 훨씬 더 어려워집니다.

빌드에 오랜 시간이 걸리는 아티팩트 문제를 해결하는 더 좋은 방법은 앞서 설명한 것처럼 원격 캐싱을 지원하는 빌드 시스템을 사용하는 것입니다. 이러한 빌드 시스템은 모든 빌드에서 생성된 아티팩트를 엔지니어 간에 공유되는 위치에 저장하므로, 개발자가 최근 다른 사람이 빌드한 아티팩트를 사용하는 경우 빌드 시스템은 아티팩트를 빌드하는 대신 자동으로 다운로드합니다. 이렇게 하면 아티팩트에 직접 의존하여 얻을 수 있는 모든 성능 이점을 제공하면서도 빌드가 항상 동일한 소스에서 빌드된 것처럼 일관성이 유지됩니다. 이는 Google에서 내부적으로 사용하는 전략이며 원격 캐시를 사용하도록 Bazel을 구성할 수 있습니다.

외부 종속 항목의 보안 및 안정성

서드 파티 소스의 아티팩트에 따라 본질적으로 위험이 발생할 수 있습니다. 외부 종속 항목을 다운로드할 수 없는 경우 전체 빌드가 중지될 수 있으므로 서드 파티 소스 (예: 아티팩트 저장소)가 다운되면 가용성 위험이 발생합니다. 또한 보안 위험이 있습니다. 타사 시스템이 공격자의 공격을 받으면 공격자가 참조된 아티팩트를 자체 설계 중 하나로 교체하여 빌드에 임의의 코드를 삽입할 수 있습니다. 사용하는 모든 아티팩트를 개발자가 제어하는 서버에 미러링하고 빌드 시스템이 Maven Central과 같은 타사 아티팩트 저장소에 액세스하지 못하도록 차단하여 두 문제를 모두 완화할 수 있습니다. 단, 미러를 유지하려면 노력과 리소스가 필요하므로 프로젝트 사용 여부에 따라 미러 사용 여부를 선택하게 되는 경우가 많습니다. 또한 각 서드 파티 아티팩트의 해시를 소스 저장소에 지정해야 하므로 아티팩트를 조작하면 빌드가 실패하여 보안 오버헤드가 거의 없이 완전히 방지될 수 있습니다. 이 문제를 완전히 회피하는 또 다른 방법은 프로젝트의 종속 항목을 벤더링하는 것입니다. 프로젝트는 종속 항목을 벤더링할 때 프로젝트의 소스 코드(소스 또는 바이너리)와 함께 소스 제어에 체크인합니다. 즉, 프로젝트의 모든 외부 종속 항목이 내부 종속 항목으로 변환됩니다. Google은 이 접근 방식을 내부적으로 사용하여 Google 전반에서 참조되는 모든 서드 파티 라이브러리를 Google 소스 트리 루트의 third_party 디렉터리에 확인합니다. 하지만 Google의 소스 제어 시스템은 매우 큰 모노저장소를 처리하도록 커스텀 빌드되므로 공급업체가 Google을 사용하지 않는 경우도 있습니다.