[PR #17165] [MERGED] perf: fix N+1 query issue in tools access control checking #24344

Closed
opened 2026-04-20 05:21:18 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/17165
Author: @sihyeonn
Created: 9/2/2025
Status: Merged
Merged: 9/3/2025
Merged by: @tjbck

Base: devHead: perf/sh-tools-router


📝 Commits (1)

  • 0503fbd perf: fix N+1 query issue in tools access control checking

📊 Changes

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

View changed files

📝 backend/open_webui/routers/tools.py (+3 -1)
📝 backend/open_webui/utils/access_control.py (+6 -3)

📄 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

Fixed a critical N+1 query performance issue in the tools router where user group information was being fetched repeatedly for each tool during access control validation. This optimization pre-fetches user groups once per request and reuses the data for all subsequent access control checks, significantly reducing database load.

The fix leverages the existing optional user_group_ids parameter in the has_access function to avoid redundant group queries when validating permissions for multiple tools.

Changed

  • Modified get_tools endpoint to pre-fetch user group IDs once per request
  • Updated has_access calls to pass pre-fetched user_group_ids parameter
  • Reduced database query count from 1+N to 1+1 pattern for tools access control validation
  • Leveraged existing conditional query logic in has_access function

Fixed

  • Fixed N+1 query problem causing excessive database load when validating access to multiple tools
  • Improved response times for tools listing endpoint through optimized group queries
  • Enhanced scalability for users with access to many tools
  • Reduced database connection overhead during access control validation

Additional Information

  • Files affected:
    • backend/open_webui/routers/tools.py (lines 75, 80)
    • backend/open_webui/utils/access_control.py (function signature already supported optimization)
  • Query optimization: Changed from 1 + N queries to 1 + 1 queries
  • Performance impact: Up to 99%+ reduction in database queries for users with multiple tool access
  • Scope: Affects tools listing with access control validation

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/17165 **Author:** [@sihyeonn](https://github.com/sihyeonn) **Created:** 9/2/2025 **Status:** ✅ Merged **Merged:** 9/3/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `perf/sh-tools-router` --- ### 📝 Commits (1) - [`0503fbd`](https://github.com/open-webui/open-webui/commit/0503fbd2e347f34353f4cde218eee70ff67928a4) perf: fix N+1 query issue in tools access control checking ### 📊 Changes **2 files changed** (+9 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/routers/tools.py` (+3 -1) 📝 `backend/open_webui/utils/access_control.py` (+6 -3) </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 Fixed a critical N+1 query performance issue in the tools router where user group information was being fetched repeatedly for each tool during access control validation. This optimization pre-fetches user groups once per request and reuses the data for all subsequent access control checks, significantly reducing database load. The fix leverages the existing optional `user_group_ids` parameter in the `has_access` function to avoid redundant group queries when validating permissions for multiple tools. ### Changed - Modified `get_tools` endpoint to pre-fetch user group IDs once per request - Updated `has_access` calls to pass pre-fetched `user_group_ids` parameter - Reduced database query count from 1+N to 1+1 pattern for tools access control validation - Leveraged existing conditional query logic in `has_access` function ### Fixed - Fixed N+1 query problem causing excessive database load when validating access to multiple tools - Improved response times for tools listing endpoint through optimized group queries - Enhanced scalability for users with access to many tools - Reduced database connection overhead during access control validation --- ### Additional Information - **Files affected:** - `backend/open_webui/routers/tools.py` (lines 75, 80) - `backend/open_webui/utils/access_control.py` (function signature already supported optimization) - **Query optimization:** Changed from `1 + N` queries to `1 + 1` queries - **Performance impact:** Up to 99%+ reduction in database queries for users with multiple tool access - **Scope:** Affects tools listing with access control validation ### 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-20 05:21:18 -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#24344