github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-05-06 02:48:13 -05:00
Code Issues 1.1k Packages Projects Releases 126 Wiki Activity

[PR #15328] [MERGED] feat : Retry acquiring usage cleanup lock to handle potential stale locks #39424

New Issue
Closed
opened 2026-04-25 12:00:59 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-25 12:00:59 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15328
Author: @acwoo97
Created: 6/26/2025
Status: ✅ Merged
Merged: 6/27/2025
Merged by: @tjbck

Base: dev ← Head: feat/lock

📝 Commits (1)

  • 789e6a0 feat : Retry acquiring usage cleanup lock to handle potential stale locks

📊 Changes

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

View changed files

📝 backend/open_webui/socket/main.py (+22 -4)

📄 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

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:
    • fix

Changelog Entry

Description

  • This PR improves the robustness of the usage pool cleanup process by introducing a short retry mechanism for acquiring the Redis lock. This helps prevent cleanup tasks from being skipped when a stale lock remains due to unexpected pod termination or crashes.

Added

  • Retry logic (up to 2 retries) with randomized delay when acquiring the usage cleanup lock.
  • Warning log message if lock acquisition fails after all retry attempts.

Changed

  • Lock acquisition for usage pool cleanup now uses a retry loop instead of a single attempt.

Deprecated

  • N/A

Removed

  • N/A

Fixed

  • Cases where the usage pool cleanup was skipped due to a leftover/stale lock not being released by a previous pod.

Security

  • N/A

Breaking Changes

  • BREAKING CHANGE: N/A

Additional Information

  • When a pod terminates abnormally or fails to release a Redis lock cleanly, the next pod may fail to acquire the lock immediately. This change introduces a short randomized retry window to account for such scenarios where the lock may soon expire.

  • Related code: periodic_usage_pool_cleanup

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/15328 **Author:** [@acwoo97](https://github.com/acwoo97) **Created:** 6/26/2025 **Status:** ✅ Merged **Merged:** 6/27/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `feat/lock` --- ### 📝 Commits (1) - [`789e6a0`](https://github.com/open-webui/open-webui/commit/789e6a0db3b5e2f05ed8281b5649756053998c95) feat : Retry acquiring usage cleanup lock to handle potential stale locks ### 📊 Changes **1 file changed** (+22 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/socket/main.py` (+22 -4) </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:** - [ ] **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 # 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: - **fix** # Changelog Entry ### Description - This PR improves the robustness of the usage pool cleanup process by introducing a short retry mechanism for acquiring the Redis lock. This helps prevent cleanup tasks from being skipped when a stale lock remains due to unexpected pod termination or crashes. ### Added - Retry logic (up to 2 retries) with randomized delay when acquiring the usage cleanup lock. - Warning log message if lock acquisition fails after all retry attempts. ### Changed - Lock acquisition for usage pool cleanup now uses a retry loop instead of a single attempt. ### Deprecated - N/A ### Removed - N/A ### Fixed - Cases where the usage pool cleanup was skipped due to a leftover/stale lock not being released by a previous pod. ### Security - N/A ### Breaking Changes - **BREAKING CHANGE**: N/A --- ### Additional Information - When a pod terminates abnormally or fails to release a Redis lock cleanly, the next pod may fail to acquire the lock immediately. This change introduces a short randomized retry window to account for such scenarios where the lock may soon expire. - Related code: `periodic_usage_pool_cleanup` ### 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 2026-04-25 12:00:59 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
confirmed
confirmed issue
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#39424
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?