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
fixed crash happening with IPv6 and some IPv4 setups where the backend crashes
backend/main.py returns 500 Internal Server Error, since data["session_id"] does not exist in the JSON payload
the JSON of the api/chat/completed POST request made by the chatCompletedHandler in src/lib/components/chat/Chat.svelte does not contain a session_id field
this is because $socket?.id yields undefined (with IPv6)
this seems to be caused by const _socket = io('${WEBUI_BASE_URL}', { in src/routes/+layout.svelte
WEBUI_BASE_URL is empty because of its definition in src/lib/constants.ts
fix: if io is initialized with a default url according to its docs to window.location.host everything seems to work without errors again
Fixed
fixed socket.io client url causing backend crashes with IPv6 and some IPv4 setups
🔄 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/4138
**Author:** [@ther0bster](https://github.com/ther0bster)
**Created:** 7/26/2024
**Status:** ✅ Merged
**Merged:** 7/27/2024
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `fix-socket-io-url`
---
### 📝 Commits (2)
- [`02b104f`](https://github.com/open-webui/open-webui/commit/02b104f56b3207157471f8178d081e9e2ab45632) fix: socket.io client url
- [`a53f5d0`](https://github.com/open-webui/open-webui/commit/a53f5d01aaddfabb12c2af4eec3f3c2f90bbc820) fix: don't break dev tests
### 📊 Changes
**1 file changed** (+1 additions, -1 deletions)
<details>
<summary>View changed files</summary>
📝 `src/routes/+layout.svelte` (+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.
- [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 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
Thanks for the great work on this project!
- does not break dev env now :)
- fixes #4025
- fixed crash happening with IPv6 and some IPv4 setups where the backend crashes
- `backend/main.py` returns `500 Internal Server Error`, since `data["session_id"]` does not exist in the JSON payload
- the JSON of the `api/chat/completed` POST request made by the chatCompletedHandler in `src/lib/components/chat/Chat.svelte` does not contain a `session_id` field
- this is because `$socket?.id` yields undefined (with IPv6)
- this seems to be caused by `const _socket = io('${WEBUI_BASE_URL}', {` in `src/routes/+layout.svelte`
- `WEBUI_BASE_URL` is empty because of its definition in `src/lib/constants.ts`
- fix: if io is initialized with a default url according to its [docs](https://socket.io/docs/v4/client-api/#iourl) to `window.location.host` everything seems to work without errors again
### Fixed
- fixed socket.io client url causing backend crashes with IPv6 and some IPv4 setups
---
<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/4138
Author: @ther0bster
Created: 7/26/2024
Status: ✅ Merged
Merged: 7/27/2024
Merged by: @tjbck
Base:
dev← Head:fix-socket-io-url📝 Commits (2)
02b104ffix: socket.io client urla53f5d0fix: don't break dev tests📊 Changes
1 file changed (+1 additions, -1 deletions)
View changed files
📝
src/routes/+layout.svelte(+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:
devbranch.Changelog Entry
Description
Thanks for the great work on this project!
does not break dev env now :)
fixes #4025
fixed crash happening with IPv6 and some IPv4 setups where the backend crashes
backend/main.pyreturns500 Internal Server Error, sincedata["session_id"]does not exist in the JSON payloadapi/chat/completedPOST request made by the chatCompletedHandler insrc/lib/components/chat/Chat.sveltedoes not contain asession_idfield$socket?.idyields undefined (with IPv6)const _socket = io('${WEBUI_BASE_URL}', {insrc/routes/+layout.svelteWEBUI_BASE_URLis empty because of its definition insrc/lib/constants.tsfix: if io is initialized with a default url according to its docs to
window.location.hosteverything seems to work without errors againFixed
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.