[PR #21071] [CLOSED] fix: AttributeError in citation parser when tool returns error #64768

Closed
opened 2026-05-06 10:26:42 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/21071
Author: @bennixview
Created: 1/31/2026
Status: Closed

Base: devHead: fix/search-web-error-handling


📝 Commits (10+)

📊 Changes

2 files changed (+111 additions, -4 deletions)

View changed files

backend/open_webui/test/util/test_middleware.py (+102 -0)
📝 backend/open_webui/utils/middleware.py (+9 -4)

📄 Description

When builtin tools fail, they return {"error": "..."} instead of their normal response format. The citation parser in middleware.py was not handling this case, causing AttributeError when iterating over error dicts (e.g., search_web expects a list).

Fix: Add generic error detection at the start of
get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result.

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. Not targeting the dev branch will lead to immediate closure of the PR.
  • Description:

When builtin tools fail, they return {"error": "..."} instead of their normal response format. The citation parser in middleware.py was not handling this case, causing AttributeError when iterating over error dicts (e.g., search_web expects a list).

Fix: Add generic error detection at the start of
get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result.

  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.

  • Documentation: not needed

  • Dependencies: no new deps

  • Testing: added new test in test/util/test_middleware.py

  • Agentic AI Code: I run the new tests locally

  • Code review: yes

  • Title Prefix: done

Changelog Entry

Description

When builtin tools fail, they return {"error": "..."} instead of their normal response format. The citation parser in middleware.py was not handling this case, causing AttributeError when iterating over error dicts (e.g., search_web expects a list).

Fix: Add generic error detection at the start of
get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result.

Added

new test in test/util/test_middleware.py

Changed

Add generic error detection at the start of
get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result.

Deprecated

none

Removed

none

Fixed

Add generic error detection at the start of
get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result.

Security

none

Breaking Changes

none


Additional Information

Screenshots or Videos

image

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), 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.


🔄 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/21071 **Author:** [@bennixview](https://github.com/bennixview) **Created:** 1/31/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `fix/search-web-error-handling` --- ### 📝 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 **2 files changed** (+111 additions, -4 deletions) <details> <summary>View changed files</summary> ➕ `backend/open_webui/test/util/test_middleware.py` (+102 -0) 📝 `backend/open_webui/utils/middleware.py` (+9 -4) </details> ### 📄 Description When builtin tools fail, they return {"error": "..."} instead of their normal response format. The citation parser in middleware.py was not handling this case, causing AttributeError when iterating over error dicts (e.g., search_web expects a list). Fix: Add generic error detection at the start of get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result. # 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. **Not targeting the `dev` branch will lead to immediate closure of the PR.** - [x] **Description:** When builtin tools fail, they return {"error": "..."} instead of their normal response format. The citation parser in middleware.py was not handling this case, causing AttributeError when iterating over error dicts (e.g., search_web expects a list). Fix: Add generic error detection at the start of get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result. - [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. - [x] **Documentation:** not needed - [x] **Dependencies:** no new deps - [x] **Testing:** added new test in test/util/test_middleware.py - [x] **Agentic AI Code:** I run the new tests locally - [x] **Code review:** yes - [x] **Title Prefix:** done # Changelog Entry ### Description When builtin tools fail, they return {"error": "..."} instead of their normal response format. The citation parser in middleware.py was not handling this case, causing AttributeError when iterating over error dicts (e.g., search_web expects a list). Fix: Add generic error detection at the start of get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result. ### Added new test in test/util/test_middleware.py ### Changed Add generic error detection at the start of get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result. ### Deprecated none ### Removed none ### Fixed Add generic error detection at the start of get_citation_source_from_tool_result that checks for {"error": ...} pattern and returns empty list. Also refactored to parse JSON once and reuse the result. ### Security none ### Breaking Changes none --- ### Additional Information - ### Screenshots or Videos <img width="1019" height="235" alt="image" src="https://github.com/user-attachments/assets/1eb92e17-7c18-475a-bc4a-f9c6f7bcedba" /> ### Contributor License Agreement 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-05-06 10:26:43 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#64768