firebase / firebase/firebase-functions-python
Firebase Functions Python build cannot reliably install private Artifact Registry packages
- 主要語言
- Python
- 星號
- 167
- 分支
- 34
- PR 合併指標
- 30 天內沒有已合併 PR
描述
## Summary
Deploying Firebase Functions written in Python cannot reliably install private Python packages hosted in Google Artifact Registry using the documented authentication mechanism.
Although Artifact Registry supports authentication via the `keyrings.google-artifactregistry-auth` backend, the Firebase Functions build process installs dependencies in a single `pip` invocation. This creates a bootstrapping problem where the authentication backend must already be installed before pip attempts to resolve private dependencies.
As a result, private packages cannot be consumed out-of-the-box during function deployment causing deployment issues and ultimately meaning private packages cannot be consumed in firebase functions. Private Python packages are a common pattern for shared internal libraries, and the current limitation makes this workflow difficult.
## Expected Behaviour
A Firebase Functions deployment should be able to install private Python packages hosted in Artifact Registry without requiring custom build pipelines, vendored wheels, or containerization.
For example, the following requirements.txt should work:
```
--extra-index-url https://-python.pkg.dev///simple/
private-package==0.0.1
```
provided that:
- the Cloud Build service account has artifactregistry.reader
- the repository contains the package
## Actual Behaviour
The Artifact Registry authentication mechanism requires the keyring backend to be present before pip attempts to fetch packages.
However pip resolves and downloads packages before installing their dependencies, meaning that adding the backend as a dependency does not help.
Example attempt:
```
--extra-index-url https://-python.pkg.dev///simple/
keyring
keyrings.google-artifactregistry-auth
private-package==0.0.1
```
This still fails because pip attempts to resolve `private-package` before installing the keyring backend. This creates a bootstrap race condition
## Why this is a Problem
The current behavior makes it effectively impossible to use private Artifact Registry Python packages with Firebase Functions without workarounds such as:
- vendoring wheels into the repository
- migrating to cloud run where the build process can be controlled
## Environment Details
Builder image:
```
europe-west2-docker.pkg.dev/serverless-runtimes/google-22-full/builder/python:python_20260224_RC00_lightweight
```
Buildpacks used:
```
google.utils.archive-source
google.python.runtime
google.python.functions-framework
google.python.pip
google.utils.label-image
google.python.link-runtime
```
The pip step is executed as:
```
python3 -m pip install --requirement requirements.txt
```
Python runtime:
```
Python 3.13.12
```
## Suggested Solutions
### Option 1: Preinstall Artifact Registry authentication backend
Ensure the build environment includes:
```
keyring
keyrings.google-artifactregistry-auth
```
before the pip install step.
### Option 2: Two-phase dependency install
Modify the Python buildpack to run:
```
pip install keyring keyrings.google-artifactregistry-auth
pip install -r requirements.txt
```
貢獻指南
研究方向
首先檢查指定 builder image 中列出的 google.python.pip buildpack,以及指令 `python3 -m pip install --requirement requirements.txt`。使用範例 requirements.txt 重現失敗,並驗證 Cloud Build 服務帳戶的權限。當 Firebase Functions 部署能夠在不進行 vendoring、不使用自訂管線或容器化的情況下安裝私有 Artifact Registry 套件時,即視為完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- google-cloud, python
- 領域
- build-system, cloud
- Issue 類型
- 缺陷
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100