Skip to content

Comments

Merge pull request open-webui#19030 from open-webui/dev#111

Merged
Classic298 merged 14 commits intoimage_urlfrom
claude/analyze-image-storage-WVojf
Dec 17, 2025
Merged

Merge pull request open-webui#19030 from open-webui/dev#111
Classic298 merged 14 commits intoimage_urlfrom
claude/analyze-image-storage-WVojf

Conversation

@Classic298
Copy link
Owner

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

Before submitting, make sure you've checked the following:

  • Target branch: Verify that the pull request targets the dev branch. Not targeting the dev branch will lead to immediate closure of the PR.
  • Description: Provide a concise description of the changes made in this pull request down below.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: If necessary, update relevant documentation Open WebUI Docs like environment variables, the tutorials, or other documentation sources.
  • Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
  • Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description.
  • Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
  • 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?
  • Title 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

  • [Concisely describe the changes made in this pull request, including any relevant motivation and impact (e.g., fixing a bug, adding a feature, or improving performance)]

Added

  • [List any new features, functionalities, or additions]

Changed

  • [List any changes, updates, refactorings, or optimizations]

Deprecated

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

Removed

  • [List any removed features, files, or functionalities]

Fixed

  • [List any fixes, corrections, or bug fixes]

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.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

tjbck and others added 14 commits November 23, 2025 22:10
- Analyze current implementation of ENABLE_CHAT_RESPONSE_BASE64_IMAGE_URL_CONVERSION
- Document how response images are converted from base64 to file URLs
- Identify missing implementation for user input images
- Explain access control for image files
- Provide solution approach for converting user input images
- Document expected performance improvements

Related to GitHub discussion open-webui#13122
This implements Phase 1 of the solution for GitHub discussion open-webui#13122,
which addresses the performance issue where large base64 images embedded
in session data cause slow load times and poor browser performance.

## Changes Made

### Backend Changes:

1. **Environment Variable** (backend/open_webui/env.py)
   - Added ENABLE_CHAT_INPUT_BASE64_IMAGE_URL_CONVERSION (default: True)
   - Controls whether user input images are converted from base64 to file URLs

2. **Image Conversion Function** (backend/open_webui/utils/files.py)
   - Added convert_message_content_images() function
   - Handles both string content (markdown) and array content (OpenAI format)
   - Converts base64 images > 1024 chars to file URLs via upload_image()
   - Returns /api/v1/files/{id}/content URLs

3. **Chat History Converter** (backend/open_webui/models/chats.py)
   - Added _convert_chat_images() helper method
   - Processes both chat.messages[] and chat.history.messages{}
   - Applies conversion to all messages with image content
   - Includes error handling to prevent conversion failures from breaking chats

4. **Router Integration** (backend/open_webui/routers/chats.py)
   - Updated create_new_chat() - converts images on chat creation
   - Updated update_chat_by_id() - converts images on chat updates
   - Updated import_chats() - converts images in imported chats
   - All endpoints now accept Request parameter for conversion

5. **Documentation** (IMAGE_STORAGE_ANALYSIS.md)
   - Added implementation summary section
   - Documented all code changes with file locations and line numbers
   - Provided configuration instructions
   - Explained how the conversion works end-to-end

## Expected Performance Improvements

- Session JSON size reduced from 100MB+ to <1MB
- Chat load time improved from several seconds to <1 second
- Images loaded on-demand with full browser caching support
- Memory usage reduced (images not kept in memory)

## Backward Compatibility

- Existing chats with base64 images continue to work
- Conversion only applies to new/updated chats
- Feature can be disabled via environment variable
- Access control enforced via existing file permissions system

Related to: open-webui#13122
- Simplified convert_message_content_images with early returns
- Reduced nesting in _convert_chat_images using helper function
- Removed redundant comments from router endpoints
- Moved module imports from function body to top of file
- Cleaner, more maintainable code structure
- Use .get() with defaults instead of isinstance before accessing
- Chain .get() calls for nested dict access
- Trust data structure with appropriate defaults
- Cleaner, more Pythonic code
Move Chats imports from module-level to local scope to break circular
dependency chain: models.chats → utils.files → routers.images →
routers.files → models.users → models.chats

Changes:
- models/users.py: Move Chats import into delete_user_by_id() method
- retrieval/utils.py: Move Chats import into chat type handler block

This prevents ImportError at runtime while maintaining functionality.
@Classic298 Classic298 merged commit 0ad1f51 into image_url Dec 17, 2025
@Classic298 Classic298 deleted the claude/analyze-image-storage-WVojf branch December 17, 2025 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants