[PR #16658] [CLOSED] fix(tools): broadcast tool updates to all replicas #127857

New Issue

GiteaMirror · 2026-05-21T10:04:35-05:00

GiteaMirror commented

2026-05-21 10:04:35 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/16658
Author: @sihyeonn
Created: 8/16/2025
Status: ❌ Closed

Base: dev ← Head: fix/sh-update-tools

📝 Commits (2)

5a82bd3 fix(tools): broadcast tool updates to all replicas
bcde31d chore: add test for broadcasting on tool update

📊 Changes

3 files changed (+74 additions, -0 deletions)

View changed files

📝 backend/open_webui/routers/tools.py (+13 -0)
➕ backend/open_webui/test/apps/webui/routers/test_tools.py (+50 -0)
📝 src/routes/+layout.svelte (+11 -0)

📄 Description

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

We noticed that after a tool was modified, only the local frontend received the update while other replicas stayed stale.
This patch broadcasts a tools:update socket event from the create, update and delete endpoints, allowing every WebUI instance to reload the tool list in real-time.

Added

tools:update emit in create & delete endpoints (update already existed).
Minimal payload { id, name } to keep Redis traffic low.

Changed

[List any changes, updates, refactorings, or optimizations]

Deprecated

[List any deprecated functionality or features that have been removed]

Removed

[List any removed features, files, or functionalities]

Fixed

Front-end replicas now stay in sync after tool changes.

Security

[List any new or updated security-related changes, including vulnerability fixes]

Breaking Changes

BREAKING CHANGE: [List any breaking changes affecting compatibility or functionality]

Additional Information

This change adds the missing safety guard so multi-replica deployments stay consistent.

Screenshots or Videos

[Attach any relevant screenshots or videos demonstrating the changes]

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.

_{🔄 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/16658 **Author:** [@sihyeonn](https://github.com/sihyeonn) **Created:** 8/16/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `fix/sh-update-tools` --- ### 📝 Commits (2) - [`5a82bd3`](https://github.com/open-webui/open-webui/commit/5a82bd340d3628923d49ea0a4fbf57ecf52a0779) fix(tools): broadcast tool updates to all replicas - [`bcde31d`](https://github.com/open-webui/open-webui/commit/bcde31d2e548b6cd0964dd02797a1d12dbcc8dfc) chore: add test for broadcasting on tool update ### 📊 Changes **3 files changed** (+74 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/routers/tools.py` (+13 -0) ➕ `backend/open_webui/test/apps/webui/routers/test_tools.py` (+50 -0) 📝 `src/routes/+layout.svelte` (+11 -0) </details> ### 📄 Description # 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. - [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [x] **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 We noticed that after a tool was modified, only the local frontend received the update while other replicas stayed stale. This patch broadcasts a `tools:update` socket event from the create, update and delete endpoints, allowing every WebUI instance to reload the tool list in real-time. ### Added * `tools:update` emit in create & delete endpoints (update already existed). * Minimal payload `{ id, name }` to keep Redis traffic low. ### Changed - [List any changes, updates, refactorings, or optimizations] ### Deprecated - [List any deprecated functionality or features that have been removed] ### Removed - [List any removed features, files, or functionalities] ### Fixed * Front-end replicas now stay in sync after tool changes. ### Security - [List any new or updated security-related changes, including vulnerability fixes] ### Breaking Changes - **BREAKING CHANGE**: [List any breaking changes affecting compatibility or functionality] --- ### Additional Information - This change adds the missing safety guard so multi-replica deployments stay consistent. ### Screenshots or Videos - [Attach any relevant screenshots or videos demonstrating the changes] ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/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-05-21 10:04:35 -05:00

GiteaMirror closed this issue

2026-05-21 10:04:38 -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#127857