Bazel 잠금 파일

Bazel의 lockfile 기능을 사용하면 프로젝트에 필요한 소프트웨어 라이브러리 또는 패키지의 특정 버전 또는 종속 항목을 기록할 수 있습니다. 이를 위해 모듈 확인 및 확장 평가의 결과를 저장합니다. 락파일은 재현 가능한 빌드를 촉진하여 일관된 개발 환경을 보장합니다. 또한 Bazel이 프로젝트 종속 항목 변경의 영향을 받지 않는 해결 프로세스 부분을 건너뛰도록 허용하여 빌드 효율성을 향상시킵니다. 또한 잠금 파일은 외부 라이브러리의 예상치 못한 업데이트나 중단 변경사항을 방지하여 안정성을 개선하여 버그가 도입될 위험을 줄입니다.

잠금 파일 생성

잠금 파일은 작업공간 루트 아래에 MODULE.bazel.lock라는 이름으로 생성됩니다. 빌드 프로세스 중에, 특히 모듈 확인 및 확장 프로그램 평가 후에 생성되거나 업데이트됩니다. 여기에는 빌드의 현재 호출에 포함된 종속 항목만 포함됩니다.

프로젝트에서 종속 항목에 영향을 미치는 변경사항이 발생하면 잠금 파일이 새 상태를 반영하도록 자동으로 업데이트됩니다. 이렇게 하면 잠금 파일이 현재 빌드에 필요한 특정 종속 항목 세트에 초점을 맞춰 프로젝트의 해결된 종속 항목을 정확하게 나타낼 수 있습니다.

Lockfile 사용

잠금 파일은 --lockfile_mode 플래그로 제어하여 프로젝트 상태가 lockfile과 다른 경우 Bazel의 동작을 맞춤설정할 수 있습니다. 사용 가능한 모드는 다음과 같습니다.

update (기본값): 잠금 파일에 있는 정보를 사용하여 알려진 레지스트리 파일의 다운로드를 건너뛰고 결과가 아직 최신 상태인 확장 프로그램을 재평가하지 않습니다. 정보가 누락된 경우 잠금 파일에 추가됩니다. 이 모드에서 Bazel은 변경되지 않은 종속 항목의 변경 가능한 정보(예: 취소된 버전)를 새로고침하지도 않습니다.
refresh: update와 같지만 변경 가능한 정보는 이 모드로 전환할 때마다 그리고 이 모드에 있는 동안 대략 1시간마다 항상 새로고침됩니다.
error: update와 같지만 정보가 누락되거나 오래된 경우 Bazel이 오류와 함께 실패합니다. 이 모드는 확인 중에 잠금 파일을 변경하거나 네트워크 요청을 실행하지 않습니다. 스스로 reproducible로 표시한 모듈 확장 프로그램은 여전히 네트워크 요청을 실행할 수 있지만 항상 동일한 결과를 생성합니다.
off: 잠금 파일이 확인 또는 업데이트되지 않았습니다.

잠금 파일 혜택

잠금 파일은 여러 가지 이점을 제공하며 다양한 방법으로 활용할 수 있습니다.

재현 가능한 빌드. 소프트웨어 라이브러리의 특정 버전 또는 종속 항목을 캡처하여 락파일은 다양한 환경에서 시간 경과에 따라 빌드를 재현할 수 있도록 합니다. 개발자는 프로젝트를 빌드할 때 일관되고 예측 가능한 결과를 사용할 수 있습니다.
해상도가 빠르게 증가합니다. 잠금 파일을 사용하면 Bazel에서 이전 빌드에서 이미 사용된 레지스트리 파일을 다운로드하지 않아도 됩니다. 이렇게 하면 특히 해결하는 데 시간이 걸릴 수 있는 시나리오에서 빌드 효율성이 크게 개선됩니다.
안정성 및 위험 감소. 잠금 파일은 외부 라이브러리의 예상치 못한 업데이트나 중단을 방지하여 안정성을 유지하는 데 도움이 됩니다. 종속 항목을 특정 버전으로 고정하면 호환되지 않거나 테스트되지 않은 업데이트로 인해 버그가 발생할 위험이 줄어듭니다.

Lockfile 콘텐츠

잠금 파일에는 프로젝트 상태가 변경되었는지 확인하는 데 필요한 모든 정보가 포함되어 있습니다. 또한 현재 상태에서 프로젝트를 빌드한 결과도 포함됩니다. 잠금 파일은 다음 두 가지 주요 부분으로 구성됩니다.

모듈 확인의 입력인 모든 원격 파일의 해시입니다.
각 모듈 확장자에 대해, bzlTransitiveDigest, usagesDigest 및 기타 필드로 표시되는 이에 영향을 미치는 입력과 generatedRepoSpecs라고 하는 해당 확장 프로그램 실행의 출력이 포함된 잠금 파일이 있습니다.

다음은 각 섹션에 관한 설명과 함께 잠금 파일의 구조를 보여주는 예입니다.

{
  "lockFileVersion": 10,
  "registryFileHashes": {
    "https://bcr.bazel.build/bazel_registry.json": "8a28e4af...5d5b3497",
    "https://bcr.bazel.build/modules/foo/1.0/MODULE.bazel": "7cd0312e...5c96ace2",
    "https://bcr.bazel.build/modules/foo/2.0/MODULE.bazel": "70390338... 9fc57589",
    "https://bcr.bazel.build/modules/foo/2.0/source.json": "7e3a9adf...170d94ad",
    "https://registry.mycorp.com/modules/foo/1.0/MODULE.bazel": "not found",
    ...
  },
  "selectedYankedVersions": {
    "foo@2.0": "Yanked for demo purposes"
  },
  "moduleExtensions": {
    "//:extension.bzl%lockfile_ext": {
      "general": {
        "bzlTransitiveDigest": "oWDzxG/aLnyY6Ubrfy....+Jp6maQvEPxn0pBM=",
        "usagesDigest": "aLmqbvowmHkkBPve05yyDNGN7oh7QE9kBADr3QIZTZs=",
        ...,
        "generatedRepoSpecs": {
          "hello": {
            "bzlFile": "@@//:extension.bzl",
            ...
          }
        }
      }
    },
    "//:extension.bzl%lockfile_ext2": {
      "os:macos": {
        "bzlTransitiveDigest": "oWDzxG/aLnyY6Ubrfy....+Jp6maQvEPxn0pBM=",
        "usagesDigest": "aLmqbvowmHkkBPve05y....yDNGN7oh7r3QIZTZs=",
        ...,
        "generatedRepoSpecs": {
          "hello": {
            "bzlFile": "@@//:extension.bzl",
            ...
          }
        }
      },
      "os:linux": {
        "bzlTransitiveDigest": "eWDzxG/aLsyY3Ubrto....+Jp4maQvEPxn0pLK=",
        "usagesDigest": "aLmqbvowmHkkBPve05y....yDNGN7oh7r3QIZTZs=",
        ...,
        "generatedRepoSpecs": {
          "hello": {
            "bzlFile": "@@//:extension.bzl",
            ...
          }
        }
      }
    }
  }
}

레지스트리 파일 해시

registryFileHashes 섹션에는 모듈 확인 중에 액세스한 원격 레지스터의 모든 파일 해시가 포함되어 있습니다. 동일한 입력이 주어지고 모든 원격 입력이 해싱된 경우 해상도 알고리즘은 완전히 결정론적이므로 잠금 파일에서 원격 정보가 과도하게 중복되는 것을 방지하면서 완전히 재현 가능한 해상도 결과를 보장합니다. 특정 레지스트리에 특정 모듈이 포함되어 있지 않지만 우선순위가 더 낮은 레지스트리에 포함되어 있는 경우에도 기록해야 합니다(예시의 'not found' 항목 참고). 기본적으로 변경 가능한 이 정보는 bazel mod deps --lockfile_mode=refresh를 통해 업데이트할 수 있습니다.

Bazel은 잠금 파일의 해시를 사용하여 저장소 캐시에서 레지스트리 파일을 검색한 후 다운로드하기 때문에 후속 확인 속도가 빨라집니다.

선택한 취소된 버전

selectedYankedVersions 섹션에는 모듈 해상도에서 선택된 야크된 버전의 모듈이 포함되어 있습니다. 이는 일반적으로 빌드하려고 할 때 오류가 발생하므로 이 섹션은 --allow_yanked_versions 또는 BZLMOD_ALLOW_YANKED_VERSIONS를 통해 삭제된 버전이 명시적으로 허용된 경우에만 비어 있지 않습니다.

이 필드는 모듈 파일과 비교하여 취소된 버전 정보는 본질적으로 변경 가능하므로 해시에서 참조할 수 없으므로 필요합니다. 이 정보는 bazel mod deps --lockfile_mode=refresh를 통해 업데이트할 수 있습니다.

모듈 확장 프로그램

moduleExtensions 섹션은 현재 호출에서 사용되었거나 이전에 호출된 확장 프로그램만 포함하고 더 이상 사용되지 않는 확장 프로그램은 제외하는 맵입니다. 즉, 종속 항목 그래프에서 더 이상 확장자가 사용되지 않으면 moduleExtensions 맵에서 삭제됩니다.

확장 프로그램이 운영체제 또는 아키텍처 유형과 무관한 경우 이 섹션에는 '일반' 항목이 하나만 표시됩니다. 그렇지 않으면 OS, 아키텍처 또는 둘 다의 이름을 따서 명명된 여러 항목이 포함되며, 각 항목은 이러한 세부정보에서 확장 프로그램을 평가한 결과에 해당합니다.

확장 프로그램 맵의 각 항목은 사용된 확장 프로그램에 해당하며 포함된 파일 및 이름으로 식별됩니다. 각 항목의 상응하는 값에는 해당 확장 프로그램과 관련된 정보가 포함됩니다.

bzlTransitiveDigest는 확장 프로그램 구현 및 이로부터 전이적으로 로드된 .bzl 파일의 다이제스트입니다.
usagesDigest는 종속 항목 그래프에서 확장 프로그램의 사용의 다이제스트로, 모든 태그가 포함됩니다.
확장 프로그램의 다른 입력을 추적하는 추가로 지정되지 않은 필드(예: 읽는 파일 또는 디렉터리의 콘텐츠 또는 사용하는 환경 변수)
generatedRepoSpecs는 현재 입력으로 확장 프로그램에서 만든 저장소를 인코딩합니다.
선택사항인 moduleExtensionMetadata 필드에는 확장 프로그램에서 제공하는 메타데이터(예: 확장 프로그램에서 만든 특정 저장소를 루트 모듈에서 use_repo를 통해 가져와야 하는지 여부)가 포함됩니다. 이 정보는 bazel mod tidy 명령어의 기반이 됩니다.

모듈 확장 프로그램은 반환 메타데이터를 reproducible = True로 설정하여 잠금 파일에 포함되지 않도록 선택할 수 있습니다. 이렇게 하면 동일한 입력이 주어질 때 항상 동일한 저장소를 생성할 것을 약속합니다.

권장사항

락파일 기능의 이점을 극대화하려면 다음 권장사항을 고려하세요.

프로젝트 종속 항목 또는 구성의 변경사항을 반영하도록 정기적으로 잠금 파일을 업데이트합니다. 이렇게 하면 후속 빌드가 가장 최신이며 정확한 종속 항목 세트를 기반으로 합니다. 모든 확장 프로그램을 한 번에 잠그려면 bazel mod deps --lockfile_mode=update를 실행합니다.
버전 제어에 잠금 파일을 포함하여 공동작업을 용이하게 하고 모든 팀원이 동일한 잠금 파일에 액세스할 수 있도록 하여 프로젝트 전반에서 일관된 개발 환경을 조성합니다.
bazelisk를 사용하여 Bazel을 실행하고, 잠금 파일에 해당하는 Bazel 버전을 지정하는 .bazelversion 파일을 버전 제어에 포함합니다. Bazel 자체가 빌드의 종속 항목이므로 잠금 파일은 Bazel 버전에 따라 다르며 하위 호환 Bazel 출시 간에조차 변경됩니다. bazelisk를 사용하면 모든 개발자가 잠금 파일과 일치하는 Bazel 버전을 사용하게 됩니다.

이러한 권장사항을 따르면 Bazel의 lockfile 기능을 효과적으로 활용하여 보다 효율적이고 안정적이며 협업적인 소프트웨어 개발 워크플로를 만들 수 있습니다.

병합 충돌

잠금 파일 형식은 병합 충돌을 최소화하도록 설계되었지만 충돌이 발생할 수 있습니다.

자동 해결

Bazel은 이러한 충돌을 자동으로 해결할 수 있도록 커스텀 git 병합 드라이버를 제공합니다.

git 저장소의 루트에 있는 .gitattributes 파일에 다음 줄을 추가하여 드라이버를 설정합니다.

# A custom merge driver for the Bazel lockfile.
# https://bazel.build/external/lockfile#automatic-resolution
MODULE.bazel.lock merge=bazel-lockfile-merge

그런 다음 드라이버를 사용하려는 각 개발자는 다음 단계에 따라 드라이버를 한 번 등록해야 합니다.

jq (1.5 이상)를 설치합니다.
다음 명령어를 실행합니다.

jq_script=$(curl https://raw.githubusercontent.com/bazelbuild/bazel/master/scripts/bazel-lockfile-merge.jq)
printf '%s\n' "${jq_script}" | less # to optionally inspect the jq script
git config --global merge.bazel-lockfile-merge.name   "Merge driver for the Bazel lockfile (MODULE.bazel.lock)"
git config --global merge.bazel-lockfile-merge.driver "jq -s '${jq_script}' -- %O %A %B > %A.jq_tmp && mv %A.jq_tmp %A"

수동 해결

registryFileHashes 및 selectedYankedVersions 필드의 간단한 병합 충돌은 충돌의 양쪽에서 모든 항목을 유지하여 안전하게 해결할 수 있습니다.

다른 유형의 병합 충돌은 수동으로 해결해서는 안 됩니다. 다음을 수행합니다.

git reset MODULE.bazel.lock && git checkout MODULE.bazel.lock를 통해 잠금 파일의 이전 상태를 복원합니다.
MODULE.bazel 파일의 충돌을 해결합니다.
bazel mod deps를 실행하여 잠금 파일을 업데이트합니다.