La función de archivo de bloqueo en Bazel permite registrar versiones o dependencias específicas de bibliotecas o paquetes de software que requiere un proyecto. Esto se logra almacenando el resultado de la resolución del módulo y la evaluación de la extensión. El archivo de bloqueo promueve compilaciones reproducibles, lo que garantiza entornos de desarrollo coherentes. Además, mejora la eficiencia de la compilación, ya que permite que Bazel omita el proceso de resolución cuando no hay cambios en las dependencias del proyecto. Además, el archivo de bloqueo mejora la estabilidad, ya que evita actualizaciones inesperadas o cambios rotundos en las bibliotecas externas, lo que reduce el riesgo de introducir errores.
Generación de archivos de bloqueo
El archivo de bloqueo se genera en la raíz del espacio de trabajo con el nombre MODULE.bazel.lock. Se crea o actualiza durante el proceso de compilación, específicamente después de la resolución del módulo y la evaluación de la extensión. El archivo de bloqueo captura el estado actual del proyecto, incluido el archivo MODULE, las marcas, las anulaciones y otra información pertinente. Es importante destacar que solo incluye las dependencias que se incluyen en la invocación actual de la compilación.
Cuando se producen cambios en el proyecto que afectan sus dependencias, el archivo de bloqueo se actualiza automáticamente para reflejar el nuevo estado. Esto garantiza que el archivo de bloqueo se centre en el conjunto específico de dependencias necesarias para la compilación actual, lo que proporciona una representación precisa de las dependencias resueltas del proyecto.
Uso de lockfile
El archivo de bloqueo se puede controlar con la marca --lockfile_mode para personalizar el comportamiento de Bazel cuando el estado del proyecto difiere del archivo de bloqueo. Los modos disponibles son los siguientes:
update(predeterminado): Si el estado del proyecto coincide con el archivo de bloqueo, el resultado de la resolución se devuelve de inmediato desde el archivo de bloqueo. De lo contrario, se ejecuta la resolución y se actualiza el archivo de bloqueo para reflejar el estado actual.error: Si el estado del proyecto coincide con el archivo de bloqueo, el resultado de la resolución se devuelve desde el archivo de bloqueo. De lo contrario, Bazel arroja un error que indica las variaciones entre el proyecto y el archivo de bloqueo. Este modo es particularmente útil cuando deseas asegurarte de que las dependencias de tu proyecto permanezcan sin cambios y cualquier diferencia se trate como un error.off: El archivo de bloqueo no se verifica en absoluto.
Beneficios del archivo de bloqueo
El archivo de bloqueo ofrece varios beneficios y se puede utilizar de diversas maneras:
Compilaciones reproducibles: Al capturar las versiones o dependencias específicas de las bibliotecas de software, el archivo de bloqueo garantiza que las compilaciones sean reproducibles en diferentes entornos y a lo largo del tiempo. Los desarrolladores pueden confiar en resultados coherentes y predecibles cuando crean sus proyectos.
Omisión eficiente de la resolución. El archivo de bloqueo permite que Bazel omita el proceso de resolución si no hay cambios en las dependencias del proyecto desde la última compilación. Esto mejora significativamente la eficiencia de la compilación, especialmente en situaciones en las que la resolución puede llevar mucho tiempo.
Estabilidad y reducción de riesgos El archivo de bloqueo ayuda a mantener la estabilidad, ya que evita actualizaciones inesperadas o cambios rotundos en las bibliotecas externas. Al bloquear las dependencias en versiones específicas, se reduce el riesgo de introducir errores debido a actualizaciones incompatibles o no probadas.
Contenido del archivo de bloqueo
El archivo de bloqueo contiene toda la información necesaria para determinar si el estado del proyecto cambió. También incluye el resultado de la compilación del proyecto en el estado actual. El archivo de bloqueo consta de dos partes principales:
- Son las entradas de la resolución del módulo, como
moduleFileHash,flagsylocalOverrideHashes, así como la salida de la resolución, que esmoduleDepGraph. - Para cada extensión del módulo, el archivo de bloqueo incluye las entradas que lo afectan, representadas por
transitiveDigest, y el resultado de ejecutar esa extensión, al que se hace referencia comogeneratedRepoSpecs.
A continuación, se muestra un ejemplo que demuestra la estructura del archivo de bloqueo, junto con explicaciones de cada sección:
{
"lockFileVersion": 1,
"moduleFileHash": "b0f47b98a67ee15f9.......8dff8721c66b721e370",
"flags": {
"cmdRegistries": [
"https://bcr.bazel.build/"
],
"cmdModuleOverrides": {},
"allowedYankedVersions": [],
"envVarAllowedYankedVersions": "",
"ignoreDevDependency": false,
"directDependenciesMode": "WARNING",
"compatibilityMode": "ERROR"
},
"localOverrideHashes": {
"bazel_tools": "b5ae1fa37632140aff8.......15c6fe84a1231d6af9"
},
"moduleDepGraph": {
"<root>": {
"name": "",
"version": "",
"executionPlatformsToRegister": [],
"toolchainsToRegister": [],
"extensionUsages": [
{
"extensionBzlFile": "extension.bzl",
"extensionName": "lockfile_ext"
}
],
...
}
},
"moduleExtensions": {
"//:extension.bzl%lockfile_ext": {
"transitiveDigest": "oWDzxG/aLnyY6Ubrfy....+Jp6maQvEPxn0pBM=",
"generatedRepoSpecs": {
"hello": {
"bzlFile": "@@//:extension.bzl",
...
}
}
}
}
}
Hash del archivo del módulo
El moduleFileHash representa el hash del contenido del archivo MODULE.bazel. Si se produce algún cambio en este archivo, el valor de hash será diferente.
Marcas
El objeto Flags almacena todos los parámetros que pueden afectar el resultado de la resolución.
Hashes de anulación local
Si el módulo raíz incluye local_path_overrides, esta sección almacena el hash del archivo MODULE.bazel en el repositorio local. Permite hacer un seguimiento de los cambios en esta dependencia.
Gráfico de dependencias del módulo
El objeto moduleDepGraph representa el resultado del proceso de resolución con las entradas mencionadas anteriormente. Forma el gráfico de dependencias de todos los módulos necesarios para ejecutar el proyecto.
Extensiones de módulos
La sección moduleExtensions es un mapa que incluye solo las extensiones que se usaron en la invocación actual o en invocaciones anteriores, y excluye las extensiones que ya no se utilizan. En otras palabras, si ya no se usa una extensión en el gráfico de dependencias, se quita del mapa de moduleExtensions.
Cada entrada de este mapa corresponde a una extensión utilizada y se identifica por su archivo y nombre contenedores. El valor correspondiente a cada entrada contiene la información pertinente asociada a esa extensión:
transitiveDigestes el resumen de la implementación de la extensión y sus archivos .bzl transitivos.- El
generatedRepoSpecses el resultado de ejecutar esa extensión con la entrada actual.
Otro factor que puede afectar los resultados de las extensiones es su uso. Aunque no se almacenan en el archivo de bloqueo, los usos se tienen en cuenta cuando se compara el estado actual de la extensión con el del archivo de bloqueo.
Prácticas recomendadas
Para maximizar los beneficios de la función de archivo de bloqueo, considera las siguientes prácticas recomendadas:
Actualiza el archivo de bloqueo con regularidad para reflejar los cambios en las dependencias o la configuración del proyecto. Esto garantiza que las compilaciones posteriores se basen en el conjunto de dependencias más actualizado y preciso.
Incluye el archivo de bloqueo en el control de versiones para facilitar la colaboración y garantizar que todos los miembros del equipo tengan acceso al mismo archivo de bloqueo, lo que promueve entornos de desarrollo coherentes en todo el proyecto.
Si sigues estas prácticas recomendadas, podrás utilizar de manera eficaz la función de archivo de bloqueo en Bazel, lo que generará flujos de trabajo de desarrollo de software más eficientes, confiables y colaborativos.