898b65a fix: sanatizeResponseContent for stop token display
📊 Changes
1 file changed (+8 additions, -8 deletions)
View changed files
📝src/lib/utils/index.ts (+8 -8)
📄 Description
Pull Request Checklist
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
Fixed an issue where specific model "stop" tokens (e.g., <|system|>, <|user|>) in model descriptions were not displayed correctly. Previously, these tokens were being inadvertently removed or corrupted by an overzealous sanitization rule, making model descriptions appear incomplete or malformed.
Changed
Updated the sanitizeResponseContent utility function (src/lib/utils/index.ts) to reorder string replacement operations. Specifically, the general HTML entity escaping for < and > characters is now performed after specific regex-based cleanups, ensuring that essential tokens are properly escaped for rendering rather than being removed or altered.
Fixed
Corrected the display of special tokens (e.g., <|system|>, <|user|>, <|end|>, <|assistant|>) within model descriptions in ChatPlaceholder.svelte and Placeholder.svelte, ensuring they are now rendered literally as intended.
Additional Information
The issue was traced to the sanitizeResponseContent function where a replaceAll(/<\|[a-z]+\|>/g, ' ') operation was occurring before the general HTML escaping for < and > characters. By moving this specific replaceAll operation to occur after the HTML escaping, the tokens are now correctly converted to their HTML entity equivalents (<|token|>) and displayed as plain text by the browser, rather than being replaced with a space.
Related files: src/lib/utils/index.ts, src/lib/components/chat/ChatPlaceholder.svelte, src/lib/components/chat/Placeholder.svelte
Screenshots or Videos
Before fix:
After fix:
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/15094
**Author:** [@silentoplayz](https://github.com/silentoplayz)
**Created:** 6/18/2025
**Status:** ✅ Merged
**Merged:** 6/18/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `small-fix`
---
### 📝 Commits (1)
- [`898b65a`](https://github.com/open-webui/open-webui/commit/898b65a65338a2dcfed183785f4d0d1c200874b5) fix: sanatizeResponseContent for stop token display
### 📊 Changes
**1 file changed** (+8 additions, -8 deletions)
<details>
<summary>View changed files</summary>
📝 `src/lib/utils/index.ts` (+8 -8)
</details>
### 📄 Description
# Pull Request Checklist
**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
- Fixed an issue where specific model "stop" tokens (e.g., `<|system|>`, `<|user|>`) in model descriptions were not displayed correctly. Previously, these tokens were being inadvertently removed or corrupted by an overzealous sanitization rule, making model descriptions appear incomplete or malformed.
### Changed
- Updated the `sanitizeResponseContent` utility function (`src/lib/utils/index.ts`) to reorder string replacement operations. Specifically, the general HTML entity escaping for `<` and `>` characters is now performed *after* specific regex-based cleanups, ensuring that essential tokens are properly escaped for rendering rather than being removed or altered.
### Fixed
- Corrected the display of special tokens (e.g., `<|system|>`, `<|user|>`, `<|end|>`, `<|assistant|>`) within model descriptions in `ChatPlaceholder.svelte` and `Placeholder.svelte`, ensuring they are now rendered literally as intended.
---
### Additional Information
- The issue was traced to the `sanitizeResponseContent` function where a `replaceAll(/<\|[a-z]+\|>/g, ' ')` operation was occurring *before* the general HTML escaping for `<` and `>` characters. By moving this specific `replaceAll` operation to occur *after* the HTML escaping, the tokens are now correctly converted to their HTML entity equivalents (`<|token|>`) and displayed as plain text by the browser, rather than being replaced with a space.
- Related files: `src/lib/utils/index.ts`, `src/lib/components/chat/ChatPlaceholder.svelte`, `src/lib/components/chat/Placeholder.svelte`
### Screenshots or Videos
## Before fix:
## After fix:
### 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>
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/15094
Author: @silentoplayz
Created: 6/18/2025
Status: ✅ Merged
Merged: 6/18/2025
Merged by: @tjbck
Base:
dev← Head:small-fix📝 Commits (1)
898b65afix: sanatizeResponseContent for stop token display📊 Changes
1 file changed (+8 additions, -8 deletions)
View changed files
📝
src/lib/utils/index.ts(+8 -8)📄 Description
Pull Request Checklist
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
<|system|>,<|user|>) in model descriptions were not displayed correctly. Previously, these tokens were being inadvertently removed or corrupted by an overzealous sanitization rule, making model descriptions appear incomplete or malformed.Changed
sanitizeResponseContentutility function (src/lib/utils/index.ts) to reorder string replacement operations. Specifically, the general HTML entity escaping for<and>characters is now performed after specific regex-based cleanups, ensuring that essential tokens are properly escaped for rendering rather than being removed or altered.Fixed
<|system|>,<|user|>,<|end|>,<|assistant|>) within model descriptions inChatPlaceholder.svelteandPlaceholder.svelte, ensuring they are now rendered literally as intended.Additional Information
sanitizeResponseContentfunction where areplaceAll(/<\|[a-z]+\|>/g, ' ')operation was occurring before the general HTML escaping for<and>characters. By moving this specificreplaceAlloperation to occur after the HTML escaping, the tokens are now correctly converted to their HTML entity equivalents (<|token|>) and displayed as plain text by the browser, rather than being replaced with a space.src/lib/utils/index.ts,src/lib/components/chat/ChatPlaceholder.svelte,src/lib/components/chat/Placeholder.svelteScreenshots or Videos
Before fix:
After fix:
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.