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
Initialization of the websocket after user is authenticated. The connection should not be open before that.
Added
n/a
Changed
Extracted setupSocket function to a separate file to be easily available for other modules globally.
breaking connection attempt in the connect event handler if there is no auth data
setupSocket called after user authenticates
Deprecated
n/a
Removed
n/a
Fixed
n/a
Security
n/a
Breaking Changes
n/a
Additional Information
Originally the motivation was to hide user-list events from not-logged users, these are no longer visible in the console log but still the websocket connection should be started only after user enters the app (logs in).
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, 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/13364
**Author:** [@shcodenick](https://github.com/shcodenick)
**Created:** 4/30/2025
**Status:** ✅ Merged
**Merged:** 4/30/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `websocket-behind-auth`
---
### 📝 Commits (1)
- [`4c81b6e`](https://github.com/open-webui/open-webui/commit/4c81b6ebc5702a7d75206a45affb55f2938e7cd2) hiding websocket initalization behind authentication
### 📊 Changes
**5 files changed** (+66 additions, -50 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/routers/auths.py` (+1 -1)
📝 `backend/open_webui/socket/main.py` (+3 -0)
➕ `src/lib/utils/websocket.ts` (+56 -0)
📝 `src/routes/+layout.svelte` (+2 -49)
📝 `src/routes/auth/+page.svelte` (+4 -0)
</details>
### 📄 Description
# Pull Request Checklist
[discussion #12850](https://github.com/open-webui/open-webui/discussions/12850)
### 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 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?
- [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
- Initialization of the websocket after user is authenticated. The connection should not be open before that.
### Added
n/a
### Changed
- Extracted setupSocket function to a separate file to be easily available for other modules globally.
- breaking connection attempt in the connect event handler if there is no auth data
- setupSocket called after user authenticates
### Deprecated
n/a
### Removed
n/a
### Fixed
n/a
### Security
n/a
### Breaking Changes
- n/a
---
### Additional Information
Originally the motivation was to hide user-list events from not-logged users, these are no longer visible in the console log but still the websocket connection should be started only after user enters the app (logs in).
### 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](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>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/13364
Author: @shcodenick
Created: 4/30/2025
Status: ✅ Merged
Merged: 4/30/2025
Merged by: @tjbck
Base:
dev← Head:websocket-behind-auth📝 Commits (1)
4c81b6ehiding websocket initalization behind authentication📊 Changes
5 files changed (+66 additions, -50 deletions)
View changed files
📝
backend/open_webui/routers/auths.py(+1 -1)📝
backend/open_webui/socket/main.py(+3 -0)➕
src/lib/utils/websocket.ts(+56 -0)📝
src/routes/+layout.svelte(+2 -49)📝
src/routes/auth/+page.svelte(+4 -0)📄 Description
Pull Request Checklist
discussion #12850
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:
devbranch.Changelog Entry
Description
Added
n/a
Changed
Deprecated
n/a
Removed
n/a
Fixed
n/a
Security
n/a
Breaking Changes
Additional Information
Originally the motivation was to hide user-list events from not-logged users, these are no longer visible in the console log but still the websocket connection should be started only after user enters the app (logs in).
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, 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.