[PR #16693] [CLOSED] feat: Session TTL management, periodic cleanup #63066

New Issue

GiteaMirror · 2026-05-06T07:37:19-05:00

GiteaMirror commented

2026-05-06 07:37:19 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/16693
Author: @sihyeonn
Created: 8/17/2025
Status: ❌ Closed

Base: dev ← Head: feat/sh-manage-session-with-ttl

📝 Commits (2)

0470353 feat: Session TTL management, periodic cleanup
a09fcf1 chore: add tests for session ttl management, periodic cleanup

📊 Changes

5 files changed (+194 additions, -3 deletions)

View changed files

📝 backend/open_webui/main.py (+2 -0)
📝 backend/open_webui/socket/main.py (+64 -2)
➕ backend/open_webui/socket/test_main.py (+49 -0)
➕ backend/open_webui/socket/test_utils.py (+28 -0)
📝 backend/open_webui/socket/utils.py (+51 -1)

📄 Description

Handling #16219.

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 PR migrates Session Survival to a pure TTL-based approach that works in both Redis and local modes.

InMemoryTTLStore – lightweight in-memory replacement for Redis SETEX; async-friendly and auto-expires keys.
SESSION_EXPIRY_POOL – single abstraction used by the socket layer; points to Redis or InMemoryTTLStore depending on WEBSOCKET_MANAGER.
periodic_session_ttl_cleanup – background task started during FastAPI startup; removes stale sessions and keeps SESSION_POOL / USER_POOL in sync.
Refactors & clean-ups – simplified disconnect logic, removed the unused MemorySetexManager alias.
Tests – added unit tests for the new store and for the periodic cleanup loop.

Added

open_webui.socket.utils.InMemoryTTLStore
open_webui.socket.main.periodic_session_ttl_cleanup
Tests
- backend/open_webui/socket/test_utils.py
- backend/open_webui/socket/test_main.py

Changed

socket/main.py – uses SESSION_EXPIRY_POOL; startup scheduling on FastAPI lifespan.
socket/utils.py – new store implementation, background thread removed.
backend/open_webui/main.py – schedules the new periodic cleanup task.

Deprecated

[List any deprecated functionality or features that have been removed]

Removed

[List any removed features, files, or functionalities]

Fixed

Stale sessions were not purged in local mode.
Potential SESSION_POOL / USER_POOL inconsistencies in Redis mode.

Security

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

Breaking Changes

BREAKING CHANGE: [List any breaking changes affecting compatibility or functionality]

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/16693 **Author:** [@sihyeonn](https://github.com/sihyeonn) **Created:** 8/17/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feat/sh-manage-session-with-ttl` --- ### 📝 Commits (2) - [`0470353`](https://github.com/open-webui/open-webui/commit/04703538d66b0e56334a230ddb1fd8cd2f235dab) feat: Session TTL management, periodic cleanup - [`a09fcf1`](https://github.com/open-webui/open-webui/commit/a09fcf129b9329f78990d4695a188d75b723e32e) chore: add tests for session ttl management, periodic cleanup ### 📊 Changes **5 files changed** (+194 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/main.py` (+2 -0) 📝 `backend/open_webui/socket/main.py` (+64 -2) ➕ `backend/open_webui/socket/test_main.py` (+49 -0) ➕ `backend/open_webui/socket/test_utils.py` (+28 -0) 📝 `backend/open_webui/socket/utils.py` (+51 -1) </details> ### 📄 Description Handling #16219. # 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 This PR migrates Session Survival to a pure TTL-based approach that works in both Redis and local modes. - InMemoryTTLStore – lightweight in-memory replacement for Redis SETEX; async-friendly and auto-expires keys. - SESSION_EXPIRY_POOL – single abstraction used by the socket layer; points to Redis or InMemoryTTLStore depending on WEBSOCKET_MANAGER. - periodic_session_ttl_cleanup – background task started during FastAPI startup; removes stale sessions and keeps SESSION_POOL / USER_POOL in sync. - Refactors & clean-ups – simplified disconnect logic, removed the unused MemorySetexManager alias. - Tests – added unit tests for the new store and for the periodic cleanup loop. ### Added - open_webui.socket.utils.InMemoryTTLStore - open_webui.socket.main.periodic_session_ttl_cleanup - Tests - backend/open_webui/socket/test_utils.py - backend/open_webui/socket/test_main.py ### Changed - socket/main.py – uses SESSION_EXPIRY_POOL; startup scheduling on FastAPI lifespan. - socket/utils.py – new store implementation, background thread removed. - backend/open_webui/main.py – schedules the new periodic cleanup task. ### Deprecated - [List any deprecated functionality or features that have been removed] ### Removed - [List any removed features, files, or functionalities] ### Fixed - Stale sessions were not purged in local mode. - Potential SESSION_POOL / USER_POOL inconsistencies in Redis mode. ### Security - [List any new or updated security-related changes, including vulnerability fixes] ### Breaking Changes - **BREAKING CHANGE**: [List any breaking changes affecting compatibility or functionality] --- ### 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-05-06 07:37:19 -05:00

GiteaMirror closed this issue

2026-05-06 07:37:20 -05: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#63066