[PR #15120] [CLOSED] fix: use hash for remote server tools #46772

Closed
opened 2026-04-29 21:42:41 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15120
Author: @signorettif
Created: 6/18/2025
Status: Closed

Base: devHead: fs-remote-tools-hash


📝 Commits (4)

📊 Changes

4 files changed (+122 additions, -81 deletions)

View changed files

.node-version (+1 -0)
📝 backend/open_webui/routers/tools.py (+29 -29)
📝 backend/open_webui/utils/tools.py (+59 -45)
📝 src/lib/components/chat/Chat.svelte (+33 -7)

📄 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

This PR makes it so the "in-memory" ID associated to remote server tools does not rely on its positional index inside the list. We use a cheap hash that allows us to persist the reference across tool changes. This is essential to ensure that

Added

  • [List any new features, functionalities, or additions]

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

  • [List any fixes, corrections, or bug fixes]

Security

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

Breaking Changes

This is a somewhat breaking change since the definition of "models" saves the currently determined ID of the server tools in its definition. Therefore, any existing model implementation will reference no longer valid tools. This is something I have considered but omitted, given the current definition is extremely error prone.

We have however maintained backwards compatibility by checking if the segment after server: is a number and shorter than 8 digits. This makes sure old model configs are working. But de-facto we have no idea if the selected tools are the intended ones. A warning has been added to incentivise the users to update their model config.

image

Additional Information

  • [Insert any additional context, notes, or explanations for the changes]
    • [Reference any related issues, commits, or other relevant information]

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/15120 **Author:** [@signorettif](https://github.com/signorettif) **Created:** 6/18/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `fs-remote-tools-hash` --- ### 📝 Commits (4) - [`8aa2ad5`](https://github.com/open-webui/open-webui/commit/8aa2ad514d1c123cf65344f321d7e02633bac6c0) feat: use hash for remote server tools - [`6d8ef10`](https://github.com/open-webui/open-webui/commit/6d8ef10b11b53d3ab9b66e76f886651406c90cbf) cleanup - [`37c79b4`](https://github.com/open-webui/open-webui/commit/37c79b4d8d03a4afee46bb035aa1002bcbd19a84) handle in the frontend - [`955f95c`](https://github.com/open-webui/open-webui/commit/955f95c9b142230badfae97c68a0f13ba80829db) consisten encoding ### 📊 Changes **4 files changed** (+122 additions, -81 deletions) <details> <summary>View changed files</summary> ➕ `.node-version` (+1 -0) 📝 `backend/open_webui/routers/tools.py` (+29 -29) 📝 `backend/open_webui/utils/tools.py` (+59 -45) 📝 `src/lib/components/chat/Chat.svelte` (+33 -7) </details> ### 📄 Description # Pull Request Checklist - Related discussion https://github.com/open-webui/open-webui/discussions/15121 **Before submitting, make sure you've checked the following:** - [x] **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](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? - [ ] **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 This PR makes it so the "in-memory" ID associated to remote server tools does not rely on its positional index inside the list. We use a cheap hash that allows us to persist the reference across tool changes. This is essential to ensure that ### Added - [List any new features, functionalities, or additions] ### 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 - [List any fixes, corrections, or bug fixes] ### Security - [List any new or updated security-related changes, including vulnerability fixes] ### Breaking Changes This is a somewhat breaking change since the definition of "models" saves the currently determined ID of the server tools in its definition. Therefore, any existing model implementation will reference no longer valid tools. This is something I have considered but omitted, given the current definition is extremely error prone. We have however maintained backwards compatibility by checking if the segment after `server:` is a number and shorter than 8 digits. This makes sure old model configs are working. But de-facto we have no idea if the selected tools are the intended ones. A warning has been added to incentivise the users to update their model config. <img width="615" alt="image" src="https://github.com/user-attachments/assets/328d5ced-160b-4c4c-8ba5-c17a89b6e433" /> --- ### Additional Information - [Insert any additional context, notes, or explanations for the changes] - [Reference any related issues, commits, or other relevant information] ### 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-04-29 21:42:41 -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#46772