github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-05-06 10:58:17 -05:00
Code Issues 1.2k Packages Projects Releases 126 Wiki Activity

[PR #22638] [CLOSED] fix: make Chroma has_collection robust across list_collections API differences #42421

New Issue
Closed
opened 2026-04-25 14:19:32 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-25 14:19:32 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/22638
Author: @HanFarJR
Created: 3/13/2026
Status: ❌ Closed

Base: dev ← Head: fix-chroma-collection-check

📝 Commits (10+)

📊 Changes

1 file changed (+18 additions, -2 deletions)

View changed files

📝 backend/open_webui/retrieval/vector/dbs/chroma.py (+18 -2)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

Before submitting, make sure you've checked the following:

  • Target branch: Verify that the pull request targets the dev branch. PRs targeting main will be immediately closed.
  • Description: Provide a concise description of the changes made in this pull request down below.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.
  • Dependencies: No new or upgraded dependencies.
  • Testing: Manual testing performed for the affected web-search RAG path.
  • Agentic AI Code: The proposed change was manually reviewed and manually tested before submission.
  • Code review: Self-review completed.
  • Design & Architecture: This PR is a small bugfix and does not introduce new settings or architecture changes.
  • Git Hygiene: PR is atomic and limited to one logical change.
  • Title Prefix: PR title uses the fix: prefix.

Description

This PR fixes a false negative in the Chroma adapter’s has_collection() logic.

In the web-search RAG path, I reproduced cases where:

  • embeddings were generated
  • items were inserted into a web-search-... collection
  • but Open WebUI still treated the collection as missing afterward

The existing implementation relies on:

collection_names = self.client.list_collections()
return collection_name in collection_names

This is fragile across Chroma versions because list_collections() return behavior differs across releases.

This change makes has_collection():

  1. first try get_collection(name=collection_name)
  2. then fall back to compatibility logic for both string-list and object-list list_collections() results

In my testing, this restored the web-search -> embedding -> retrieval -> RAG handoff for Chroma-backed setups.

Changelog Entry

Added

  • None.

Changed

  • Updated backend/open_webui/retrieval/vector/dbs/chroma.py to use get_collection(name=...) as the primary existence check, with a compatibility fallback for different list_collections() return types.

Deprecated

  • None

Removed

  • None.

Fixed

  • Fixed false missing-collection detection for Chroma-backed web-search collections in the RAG handoff path.

Security

  • None

Breaking Changes

  • BREAKING CHANGE: None.

Additional Information

Screenshots or Videos

  • None.

Contributor License Agreement

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/22638 **Author:** [@HanFarJR](https://github.com/HanFarJR) **Created:** 3/13/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `fix-chroma-collection-check` --- ### 📝 Commits (10+) - [`fe6783c`](https://github.com/open-webui/open-webui/commit/fe6783c16699911c7be17392596d579333fb110c) Merge pull request #19030 from open-webui/dev - [`fc05e0a`](https://github.com/open-webui/open-webui/commit/fc05e0a6c5d39da60b603b4d520f800d6e36f748) Merge pull request #19405 from open-webui/dev - [`e3faec6`](https://github.com/open-webui/open-webui/commit/e3faec62c58e3a83d89aa3df539feacefa125e0c) Merge pull request #19416 from open-webui/dev - [`9899293`](https://github.com/open-webui/open-webui/commit/9899293f050ad50ae12024cbebee7e018acd851e) Merge pull request #19448 from open-webui/dev - [`140605e`](https://github.com/open-webui/open-webui/commit/140605e660b8186a7d5c79fb3be6ffb147a2f498) Merge pull request #19462 from open-webui/dev - [`6f1486f`](https://github.com/open-webui/open-webui/commit/6f1486ffd0cb288d0e21f41845361924e0d742b3) Merge pull request #19466 from open-webui/dev - [`d95f533`](https://github.com/open-webui/open-webui/commit/d95f533214e3fe5beb5e41ec1f349940bc4c7043) Merge pull request #19729 from open-webui/dev - [`a727153`](https://github.com/open-webui/open-webui/commit/a7271532f8a38da46785afcaa7e65f9a45e7d753) 0.6.43 (#20093) - [`6adde20`](https://github.com/open-webui/open-webui/commit/6adde203cd292a9e3af9c64a2ae36b603fed096a) Merge pull request #20394 from open-webui/dev - [`f9b0534`](https://github.com/open-webui/open-webui/commit/f9b0534e0c442631d1cb7205169588b9b6204179) Merge pull request #20522 from open-webui/dev ### 📊 Changes **1 file changed** (+18 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/retrieval/vector/dbs/chroma.py` (+18 -2) </details> ### 📄 Description <!-- ⚠️ CRITICAL CHECKS FOR CONTRIBUTORS (READ, DON'T DELETE) ⚠️ 1. Target the `dev` branch. PRs targeting `main` will be automatically closed. 2. Do NOT delete the CLA section at the bottom. It is required for the bot to accept your PR. --> # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **PRs targeting `main` will be immediately closed.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [ ] **Documentation:** Add docs in [Open WebUI Docs Repository](https://github.com/open-webui/docs). Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps. - [x] **Dependencies:** No new or upgraded dependencies. - [x] **Testing:** Manual testing performed for the affected web-search RAG path. - [x] **Agentic AI Code:** The proposed change was manually reviewed and manually tested before submission. - [x] **Code review:** Self-review completed. - [x] **Design & Architecture:** This PR is a small bugfix and does not introduce new settings or architecture changes. - [x] **Git Hygiene:** PR is atomic and limited to one logical change. - [x] **Title Prefix:** PR title uses the `fix:` prefix. ## Description This PR fixes a false negative in the Chroma adapter’s `has_collection()` logic. In the web-search RAG path, I reproduced cases where: - embeddings were generated - items were inserted into a `web-search-...` collection - but Open WebUI still treated the collection as missing afterward The existing implementation relies on: ```python collection_names = self.client.list_collections() return collection_name in collection_names ``` This is fragile across Chroma versions because list_collections() return behavior differs across releases. This change makes `has_collection()`: 1. first try `get_collection(name=collection_name)` 2. then fall back to compatibility logic for both string-list and object-list `list_collections()` results In my testing, this restored the web-search -> embedding -> retrieval -> RAG handoff for Chroma-backed setups. # Changelog Entry ### Added - None. ### Changed - Updated backend/open_webui/retrieval/vector/dbs/chroma.py to use `get_collection(name=...)` as the primary existence check, with a compatibility fallback for different `list_collections()` return types. ### Deprecated - None ### Removed - None. ### Fixed - Fixed false missing-collection detection for Chroma-backed web-search collections in the RAG handoff path. ### Security - None ### Breaking Changes - **BREAKING CHANGE**: None. --- ### Additional Information - This PR is intentionally limited to the Chroma collection-existence fix only. During debugging I also encountered a separate runtime `TEXT_SPLITTER` issue in my local setup, but that is not included in this PR. - Related issue: #13650 - Related discussion: https://github.com/open-webui/open-webui/discussions/22514 ### Screenshots or Videos - None. ### Contributor License Agreement <!-- 🚨 DO NOT DELETE THE TEXT BELOW 🚨 Keep the "Contributor License Agreement" confirmation text intact. Deleting it will trigger the CLA-Bot to INVALIDATE your PR. Your PR will NOT be reviewed or merged until you check the box below confirming that you have read and agree to the terms of the CLA. --> - [x] By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-25 14:19:32 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
confirmed
confirmed issue
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#42421
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?