[PR #13358] [MERGED] fix: install external requirements of tools and functions to prevent deactivation #38794

New Issue

GiteaMirror · 2026-04-25T11:38:03-05:00

GiteaMirror commented

2026-04-25 11:38:03 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/13358
Author: @almajo
Created: 4/30/2025
Status: ✅ Merged
Merged: 4/30/2025
Merged by: @tjbck

Base: dev ← Head: fix/load_ext_dependencies_on_startup

📝 Commits (1)

e80ed32 fix: install external requirements of admin functions and tools on startups

📊 Changes

2 files changed (+40 additions, -2 deletions)

View changed files

📝 backend/open_webui/main.py (+9 -1)
📝 backend/open_webui/utils/plugin.py (+31 -1)

📄 Description

Pull Request Checklist

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

Bug: #12121

This PR installs requirements of active functions and admin tools on startup. This prevents automatically deactivating due to missing requirements them after the container has been restarted.

I'm happy to discuss the decisions I made here.

Decisions

Blocking call

I decided to go for a blocking operation, i.e. the API is only functional after the requirements are installed or it failed with an error log. The reason is to prevent conurruency issues with users. When the get_models is called and the function is not working because of missing requirements it will get automatically deactivated. All while the requirements are actually installed in the background.

This should not be noticeable at all in practice, maybe add an extra startup time of 1-10 seconds to the applications (if many requirements are present.

Only active functions and admin tools

I decided to only go for active functions in order to be able to deactivate a (maybe not-working) function at any time and not have any impact of active functions. This reduces the risk of dependency problems between the tools and functions.

Only installing requirements of admin functions (user.role == admin), we prevent possible dependency resolution issues or dependency injections from user tools, directly on startup.

Changed

On startup external dependencies are installed before the API accepts requests.

Fixed

Tests

Following the reproduction steps in #12121 I was able to solve this issue and active functions with requirements remain active and working while others remain untouched.

If anything fails in this method, it is only logged and there is no change to before this PR.

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the CONTRIBUTOR_LICENSE_AGREEMENT, and I am providing my contributions under its terms.

_{🔄 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/13358 **Author:** [@almajo](https://github.com/almajo) **Created:** 4/30/2025 **Status:** ✅ Merged **Merged:** 4/30/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `fix/load_ext_dependencies_on_startup` --- ### 📝 Commits (1) - [`e80ed32`](https://github.com/open-webui/open-webui/commit/e80ed32aeb58173b72082ad5f316585ec3ca1645) fix: install external requirements of admin functions and tools on startups ### 📊 Changes **2 files changed** (+40 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/main.py` (+9 -1) 📝 `backend/open_webui/utils/plugin.py` (+31 -1) </details> ### 📄 Description # Pull Request Checklist **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 Bug: #12121 This PR installs requirements of **active** functions and **admin** tools on startup. This prevents automatically deactivating due to missing requirements them after the container has been restarted. I'm happy to discuss the decisions I made here. #### Decisions ##### Blocking call I decided to go for a blocking operation, i.e. the API is only functional after the requirements are installed or it failed with an error log. The reason is to prevent conurruency issues with users. When the get_models is called and the function is not working because of missing requirements it will get automatically deactivated. All while the requirements are actually installed in the background. This should not be noticeable at all in practice, maybe add an extra startup time of 1-10 seconds to the applications (if many requirements are present. ##### Only active functions and admin tools I decided to only go for active functions in order to be able to deactivate a (maybe not-working) function at any time and not have any impact of active functions. This reduces the risk of dependency problems between the tools and functions. Only installing requirements of admin functions (`user.role == admin`), we prevent possible dependency resolution issues or dependency injections from user tools, directly on startup. ### Changed - On startup external dependencies are installed before the API accepts requests. ### Fixed - #12121 - #12314 - #12888 --- ### Tests Following the reproduction steps in #12121 I was able to solve this issue and active functions with requirements remain active and working while others remain untouched. If anything fails in this method, it is only logged and there is no change to before this PR. ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [CONTRIBUTOR_LICENSE_AGREEMENT](CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <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 11:38:03 -05:00

GiteaMirror closed this issue

2026-04-25 11:38:05 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#38794