[PR #14314] [MERGED] fix: Correctly handle toggle filters to prevent unintended activation #10238

New Issue

GiteaMirror · 2025-11-11T18:59:47-06:00

GiteaMirror commented

2025-11-11 18:59:47 -06:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/14314
Author: @fl0w1nd
Created: 5/25/2025
Status: ✅ Merged
Merged: 5/26/2025
Merged by: @tjbck

Base: dev ← Head: dev

📝 Commits (1)

332043c fix: Correctly handle toggle filters to prevent unintended activation

📊 Changes

1 file changed (+9 additions, -7 deletions)

View changed files

📝 backend/open_webui/utils/filter.py (+9 -7)

📄 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

This pull request addresses a bug in get_sorted_filter_ids where toggleable filters that were not explicitly enabled could still be considered active if multiple such filters existed. The issue was caused by modifying the active_filter_ids list while iterating over it, leading to some filters being skipped in the evaluation process. The fix refactors this logic to use a list comprehension, ensuring accurate filtering of active toggleable filters.

Added

N/A

Changed

Refactored the filtering logic within get_sorted_filter_ids for active_filter_ids. It now uses a list comprehension with a helper function should_keep_filter to determine if a toggleable filter should remain active, rather than removing items from the list during iteration.
Added a None check for enabled_filter_ids (using enabled_filter_ids or []) within the should_keep_filter logic to prevent potential errors.

Deprecated

N/A

Removed

N/A

Fixed

Resolved a bug where multiple toggleable filters might not be correctly deactivated if they were not present in enabled_filter_ids. This occurred due to modifying a list while iterating over it, causing some elements to be skipped.

Security

N/A

Breaking Changes

N/A

Additional Information

Discussion

Screenshots or Videos

N/A

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/14314 **Author:** [@fl0w1nd](https://github.com/fl0w1nd) **Created:** 5/25/2025 **Status:** ✅ Merged **Merged:** 5/26/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `dev` --- ### 📝 Commits (1) - [`332043c`](https://github.com/open-webui/open-webui/commit/332043c38bbbedeae56b43dcc0d473ae7b610e48) fix: Correctly handle toggle filters to prevent unintended activation ### 📊 Changes **1 file changed** (+9 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/utils/filter.py` (+9 -7) </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. - [ ] **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 - This pull request addresses a bug in `get_sorted_filter_ids` where toggleable filters that were not explicitly enabled could still be considered active if multiple such filters existed. The issue was caused by modifying the `active_filter_ids` list while iterating over it, leading to some filters being skipped in the evaluation process. The fix refactors this logic to use a list comprehension, ensuring accurate filtering of active toggleable filters. ### Added - N/A ### Changed - Refactored the filtering logic within `get_sorted_filter_ids` for `active_filter_ids`. It now uses a list comprehension with a helper function `should_keep_filter` to determine if a toggleable filter should remain active, rather than removing items from the list during iteration. - Added a `None` check for `enabled_filter_ids` (using `enabled_filter_ids or []`) within the `should_keep_filter` logic to prevent potential errors. ### Deprecated - N/A ### Removed - N/A ### Fixed - Resolved a bug where multiple toggleable filters might not be correctly deactivated if they were not present in `enabled_filter_ids`. This occurred due to modifying a list while iterating over it, causing some elements to be skipped. ### Security - N/A ### Breaking Changes - N/A --- ### Additional Information [Discussion](https://github.com/open-webui/open-webui/discussions/14274) ### Screenshots or Videos - N/A ### 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 2025-11-11 18:59:47 -06:00

GiteaMirror closed this issue