9669cd3 fix: use run_in_threadpool for search_web to prevent blocking
📊 Changes
1 file changed (+5 additions, -2 deletions)
View changed files
📝backend/open_webui/routers/retrieval.py (+5 -2)
📄 Description
Used fastapi's run_in_threadpool function to execute the search_web function, preventing the synchronous function from blocking the entire web search process.
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Changelog Entry
Description
Enhanced web search functionality by implementing thread-based execution, preventing synchronous operations from blocking the application flow and improving overall responsiveness.
Added
None
Changed
Modified web search implementation to use FastAPI's run_in_threadpool function for non-blocking execution
Deprecated
None
Removed
None
Fixed
Fixed performance bottleneck where synchronous search_web function was blocking the entire web search process
Security
None
Breaking Changes
None
Additional Information
This change improves application responsiveness by moving potentially slow network operations to background threads
Related to performance optimization initiative for web search functionality
Addresses user reports of application becoming unresponsive during web searches
Screenshots or Videos
N/A
🔄 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/12958
**Author:** [@Youggls](https://github.com/Youggls)
**Created:** 4/17/2025
**Status:** ✅ Merged
**Merged:** 4/18/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `fix_search_web`
---
### 📝 Commits (1)
- [`9669cd3`](https://github.com/open-webui/open-webui/commit/9669cd3454fd2b259bff86e59ef5b7cf5f71de0c) fix: use run_in_threadpool for search_web to prevent blocking
### 📊 Changes
**1 file changed** (+5 additions, -2 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/routers/retrieval.py` (+5 -2)
</details>
### 📄 Description
Used fastapi's run_in_threadpool function to execute the search_web function, preventing the synchronous function from blocking the entire web search process.
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [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:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Have you written and run sufficient tests to validate the changes?
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
- Enhanced web search functionality by implementing thread-based execution, preventing synchronous operations from blocking the application flow and improving overall responsiveness.
### Added
- None
### Changed
- Modified web search implementation to use FastAPI's `run_in_threadpool` function for non-blocking execution
### Deprecated
- None
### Removed
- None
### Fixed
- Fixed performance bottleneck where synchronous `search_web` function was blocking the entire web search process
### Security
- None
### Breaking Changes
- None
---
### Additional Information
- This change improves application responsiveness by moving potentially slow network operations to background threads
- Related to performance optimization initiative for web search functionality
- Addresses user reports of application becoming unresponsive during web searches
### Screenshots or Videos
- N/A
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/12958
Author: @Youggls
Created: 4/17/2025
Status: ✅ Merged
Merged: 4/18/2025
Merged by: @tjbck
Base:
dev← Head:fix_search_web📝 Commits (1)
9669cd3fix: use run_in_threadpool for search_web to prevent blocking📊 Changes
1 file changed (+5 additions, -2 deletions)
View changed files
📝
backend/open_webui/routers/retrieval.py(+5 -2)📄 Description
Used fastapi's run_in_threadpool function to execute the search_web function, preventing the synchronous function from blocking the entire web search process.
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
Added
Changed
run_in_threadpoolfunction for non-blocking executionDeprecated
Removed
Fixed
search_webfunction was blocking the entire web search processSecurity
Breaking Changes
Additional Information
Screenshots or Videos
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.