[PR #8740] [CLOSED] fix: Treat empty string as None when checking config_value #9076

New Issue

GiteaMirror · 2025-11-11T18:13:32-06:00

GiteaMirror commented

2025-11-11 18:13:32 -06:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/8740
Author: @hurxxxx
Created: 1/22/2025
Status: ❌ Closed

Base: dev ← Head: dev

📝 Commits (1)

d29b314 fix: Treat empty string as None when checking config_value

📊 Changes

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

View changed files

📝 backend/open_webui/config.py (+1 -1)

📄 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 for validating 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 cleary 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

Updated conditional logic to treat None and an empty string ("") as equivalent when evaluating self.config_value.

This update addresses the following issues:

An environment variable of type string defined in .env is not applied correctly. For example, when defining a prompt for QUERY_GENERATION_PROMPT_TEMPLATE, it is not properly reflected in the application.
The function get_config_value(task.query.prompt_template) returns an empty string ("") and stores it as an empty string in the config table in the database.
The code if self.config_value is not None: does not account for empty strings, preventing the use of values from os.env.
This fix ensures that both None and empty strings are treated consistently, allowing the appropriate fallback to environment variables.

If there was another intent behind not evaluating "", I will withdraw the PR.

Added

Changed

Deprecated

Removed

Fixed

backend/open_webui/config.py

Security

Breaking Changes

Additional Information

Screenshots or Videos

_{🔄 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/8740 **Author:** [@hurxxxx](https://github.com/hurxxxx) **Created:** 1/22/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `dev` --- ### 📝 Commits (1) - [`d29b314`](https://github.com/open-webui/open-webui/commit/d29b3147ef4e020d7f974ed008776582feabb310) fix: Treat empty string as None when checking config_value ### 📊 Changes **1 file changed** (+1 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+1 -1) </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. - [ ] **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 for validating 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 cleary 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 Updated conditional logic to treat None and an empty string ("") as equivalent when evaluating self.config_value. This update addresses the following issues: An environment variable of type string defined in .env is not applied correctly. For example, when defining a prompt for QUERY_GENERATION_PROMPT_TEMPLATE, it is not properly reflected in the application. The function get_config_value(task.query.prompt_template) returns an empty string ("") and stores it as an empty string in the config table in the database. The code ```if self.config_value is not None:``` does not account for empty strings, preventing the use of values from os.env. This fix ensures that both None and empty strings are treated consistently, allowing the appropriate fallback to environment variables. If there was another intent behind not evaluating "", I will withdraw the PR. ### Added ### Changed ### Deprecated ### Removed ### Fixed - backend/open_webui/config.py ### Security ### Breaking Changes --- ### Additional Information ### Screenshots or Videos --- <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:13:32 -06:00

GiteaMirror closed this issue

2025-11-11 18:13:32 -06: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#9076