mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 13:29:19 +08:00
deps!: drop the crewai extra to remove chromadb from the lockfile (#3870)
## Description Removes the `crewai` extra. Every CrewAI release requires `chromadb`, which has unpatched advisories in its server, so the extra kept CrewAI, ChromaDB and about 40 other packages in `uv.lock` and in Headroom's Dependabot alerts. Headroom never imports ChromaDB or runs a ChromaDB server, and the extra was never part of `[all]`, `[sandbox]` or any image. The extra added nothing to the integration itself: the CrewAI adapter only wraps CrewAI tools and uses whatever CrewAI the user has installed. Users install CrewAI alongside Headroom instead. Closes Dependabot alerts #204, #205, #206 (chromadb) and #412, #413 (oauthlib, which came in only through ChromaDB's Kubernetes client). Dependabot PR #3890 (oauthlib bump) becomes moot. ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [x] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - `pyproject.toml`: remove the `crewai` extra, with a comment saying why there is none. - `uv.lock`: 42 packages removed (crewai, chromadb, kubernetes, lancedb, oauthlib and their dependencies). Nothing added or upgraded. - `SECURITY.md`: the CrewAI / ChromaDB section now states the new boundary: Headroom does not lock CrewAI or ChromaDB, and a user who installs CrewAI owns that exposure. It still lists the ChromaDB advisories and server mitigations for those users. - `.github/dependabot.yml`: drop the ChromaDB ignore range, which now matches nothing. The Accelerate range stays. - Installation docs and the integrations docstring now say `pip install headroom-ai crewai`. ## Migration `pip install "headroom-ai[crewai]"` still succeeds, but pip warns about the unknown extra and installs Headroom without CrewAI. Replace it with: ```bash pip install headroom-ai crewai ``` The CrewAI integration (`headroom.integrations.crewai`) is unchanged. Without CrewAI installed it raises an `ImportError` that names the same command. ## Testing - [ ] Unit tests pass (`pytest`) — no code changed; the CrewAI tests skip without CrewAI, as before - [x] Linting passes (`ruff check .`) - [ ] Type checking passes (`mypy headroom`) — no Python code changed - [ ] New tests added for new functionality — not applicable - [x] Manual testing performed ### Test Output ```text $ uv lock --check Resolved 250 packages $ grep -c '^name = "crewai"\|^name = "chromadb"\|^name = "oauthlib"' uv.lock 0 $ python -c "import headroom.integrations" # imports without CrewAI ``` ## Real Behavior Proof - Environment: local, Python 3.14, current main merged in. - Exact command / steps: `uv lock --check`; checked that crewai, chromadb and oauthlib are absent from `uv.lock`; imported `headroom.integrations` without CrewAI installed. - Observed result: lockfile consistent; the three packages are absent; import succeeds. - Not tested: installing CrewAI alongside Headroom in a fresh environment. ## Runtime Rollout Safety - Rollout-managed feature(s): none - Minimum rollout channel: n/a - Stable/default behavior changed: no runtime change; packaging only. The `[crewai]` extra no longer installs CrewAI. - Kill switch / disable path: n/a - Unsafe override required: no - Qualification impact: none - Rollback path: revert this PR. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works — not applicable (packaging change) - [x] New and existing unit tests pass locally with my changes - [x] I did **not** edit `CHANGELOG.md` — it is generated by release-please from my Conventional Commit PR title (a CI guard enforces this) ## Additional Notes Marked breaking (`deps!:`) so release-please records the removal and the migration note above. Addresses the review on this PR: breaking-change classification and migration note, SECURITY.md and Dependabot updated in the same PR, branch brought current with main. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
3080a9d44c
commit
59b8cefc24
@@ -44,11 +44,9 @@ updates:
|
||||
# upgrading silently disables compression (GH #1216).
|
||||
- dependency-name: "tree-sitter-language-pack"
|
||||
versions: [">=1.0.0,<2.0.0"]
|
||||
# These releases do not fix the optional-extra advisories documented in
|
||||
# These releases do not fix the optional-extra advisory documented in
|
||||
# SECURITY.md. Keep future versions eligible for review; do not suppress
|
||||
# alerts or ignore these packages indefinitely.
|
||||
- dependency-name: "chromadb"
|
||||
versions: ["<=1.5.9"]
|
||||
- dependency-name: "accelerate"
|
||||
versions: ["<=1.15.0"]
|
||||
groups:
|
||||
|
||||
+15
-23
@@ -115,28 +115,20 @@ The following public upstream advisories remain unresolved. They are included in
|
||||
`uv.lock` through optional extras; the presence of a package in that universal
|
||||
lockfile does not mean it is installed with every Headroom installation.
|
||||
|
||||
### CrewAI / ChromaDB
|
||||
### CrewAI / ChromaDB (no longer locked)
|
||||
|
||||
The `crewai` extra brings in ChromaDB through CrewAI. The locked ChromaDB 1.1.1
|
||||
and the latest published version, 1.5.9, are affected by:
|
||||
|
||||
- [GHSA-f4j7-r4q5-qw2c](https://github.com/advisories/GHSA-f4j7-r4q5-qw2c):
|
||||
pre-authentication code injection through model repository configuration.
|
||||
- [GHSA-36p7-vc44-83pf](https://github.com/advisories/GHSA-36p7-vc44-83pf):
|
||||
code injection through model repository configuration with `trust_remote_code`.
|
||||
- [GHSA-2wm9-hf6c-p5cr](https://github.com/advisories/GHSA-2wm9-hf6c-p5cr):
|
||||
cross-tenant access to collection data.
|
||||
- [GHSA-xph7-9rjv-w5fr](https://github.com/advisories/GHSA-xph7-9rjv-w5fr):
|
||||
missing resource-scope checks in `SimpleRBACAuthorizationProvider`.
|
||||
|
||||
There is no published patched release. The upstream authorization fix
|
||||
[chroma-core/chroma#7602](https://github.com/chroma-core/chroma/pull/7602)
|
||||
is still open. Upgrading CrewAI alone also retains ChromaDB. Headroom's CrewAI
|
||||
integration wraps tools; it does not start a ChromaDB server or configure its
|
||||
authorization. Deployments that separately expose ChromaDB must not rely on its
|
||||
affected authorization for tenant isolation. Keep it inaccessible to untrusted
|
||||
clients and do not allow untrusted model repository or `trust_remote_code`
|
||||
configuration. These exposure restrictions are mitigations, not upstream fixes.
|
||||
Headroom no longer provides a `crewai` extra, so CrewAI and ChromaDB are not in
|
||||
`uv.lock` and are never installed by Headroom. The CrewAI integration uses
|
||||
whichever CrewAI the user installs (`pip install headroom-ai crewai`), and that
|
||||
installation owns its dependency exposure. Every current CrewAI release requires
|
||||
ChromaDB, which has unpatched advisories in its server
|
||||
([GHSA-f4j7-r4q5-qw2c](https://github.com/advisories/GHSA-f4j7-r4q5-qw2c),
|
||||
[GHSA-36p7-vc44-83pf](https://github.com/advisories/GHSA-36p7-vc44-83pf),
|
||||
[GHSA-2wm9-hf6c-p5cr](https://github.com/advisories/GHSA-2wm9-hf6c-p5cr),
|
||||
[GHSA-xph7-9rjv-w5fr](https://github.com/advisories/GHSA-xph7-9rjv-w5fr)).
|
||||
Headroom's integration only wraps tools and never starts a ChromaDB server. If you
|
||||
run ChromaDB as a server, keep it inaccessible to untrusted clients and follow
|
||||
those advisories.
|
||||
|
||||
### Voice training / Accelerate
|
||||
|
||||
@@ -156,6 +148,6 @@ file-type validation. The proposed fixes
|
||||
merging; the latter also explicitly leaves the named-pipe denial of service
|
||||
unfixed. Keep the alert open until a released fix covers both cases.
|
||||
|
||||
Dependabot ignores only the reviewed unpatched ranges (ChromaDB through 1.5.9
|
||||
and Accelerate through 1.15.0). Later releases remain eligible for review. These
|
||||
Dependabot ignores only the reviewed unpatched Accelerate range (through 1.15.0).
|
||||
Later releases remain eligible for review. These
|
||||
update exceptions do not remediate the advisories or dismiss vulnerability alerts.
|
||||
|
||||
@@ -99,7 +99,7 @@ pip install "headroom-ai[all]"
|
||||
| `langchain` | LangChain `HeadroomChatModel` wrapper; **not in `[all]`** | `pip install "headroom-ai[langchain]"` |
|
||||
| `agno` | Agno `HeadroomAgnoModel` wrapper; **not in `[all]`** | `pip install "headroom-ai[agno]"` |
|
||||
| `strands` | AWS Strands Agents integration; **not in `[all]`** | `pip install "headroom-ai[strands]"` |
|
||||
| `crewai` | CrewAI integration; **not in `[all]`** | `pip install "headroom-ai[crewai]"` |
|
||||
| *(none)* | CrewAI integration: no extra, install CrewAI alongside Headroom | `pip install headroom-ai crewai` |
|
||||
| `autogen` | AutoGen AgentChat integration; **not in `[all]`** | `pip install "headroom-ai[autogen]"` |
|
||||
| `anyllm` | any-llm multi-provider backend (Python 3.11+); **not in `[all]`** | `pip install "headroom-ai[anyllm]"` |
|
||||
| `bedrock` | Native AWS Bedrock credentials/backend support; **not in `[all]`** | `pip install "headroom-ai[bedrock]"` |
|
||||
|
||||
@@ -15,7 +15,7 @@ Agno (pip install agno):
|
||||
- HeadroomPreHook/HeadroomPostHook: Agent-level hooks for tracking
|
||||
- create_headroom_hooks: Convenience function to create hook pairs
|
||||
|
||||
CrewAI (pip install headroom[crewai]):
|
||||
CrewAI (pip install headroom-ai crewai):
|
||||
- HeadroomToolWrapper: Tool output compression for CrewAI agents
|
||||
- wrap_tools_with_headroom: Batch wrapper for CrewAI tools
|
||||
|
||||
|
||||
+4
-4
@@ -235,10 +235,10 @@ agno = [
|
||||
strands = [
|
||||
"strands-agents>=0.1.0",
|
||||
]
|
||||
# CrewAI agent framework integration
|
||||
crewai = [
|
||||
"crewai>=1.15.21",
|
||||
]
|
||||
# CrewAI: no extra on purpose. The integration only wraps CrewAI tools, so it
|
||||
# uses whatever CrewAI the user already has (`pip install headroom-ai crewai`).
|
||||
# An extra here would put CrewAI's own dependency tree (including chromadb,
|
||||
# which has unpatched server-side CVEs) into our lockfile and security alerts.
|
||||
# AutoGen agent framework integration
|
||||
autogen = [
|
||||
"autogen-agentchat>=0.7",
|
||||
|
||||
Reference in New Issue
Block a user