[PR #24015] [MERGED] perf: redirect default model profile image to static favicon for cache reuse #43108

New Issue

GiteaMirror · 2026-04-25T14:48:02-05:00

GiteaMirror commented

2026-04-25 14:48:02 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/24015
Author: @jmleksan
Created: 4/22/2026
Status: ✅ Merged
Merged: 4/24/2026
Merged by: @tjbck

Base: dev ← Head: perf/static-redirect

📝 Commits (1)

2752d74 perf: redirect default model profile image to canonical static URL

📊 Changes

1 file changed (+49 additions, -4 deletions)

View changed files

📝 backend/open_webui/routers/models.py (+49 -4)

📄 Description

Pull Request Checklist

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

Target branch: Verify that the pull request targets the dev branch. PRs targeting main will be immediately closed.
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: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.
Dependencies: Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash.
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to make screenshots of the feature/fix and include them 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?
Design & Architecture: Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes.
Git Hygiene: Keep PRs atomic (one logical change). Clean up commits and rebase on dev to ensure no unrelated commits (e.g. from main) are included. Push updates to the existing PR branch instead of closing and reopening.
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 tasks

Changelog Entry

Description

Default model avatars are served from GET /api/v1/models/model/profile/image?id=…. Each distinct model id produced a different URL but the same fallback file (static/favicon.png, ~22 KB). Browsers therefore downloaded that payload multiple times (visible in Lighthouse transfer size / LCP-related loading).

This change returns HTTP 302 to the canonical static URL /static/favicon.png for the default case, and 302 to meta.profile_image_url when it is already a site-relative path under /static/. Custom images (http(s): redirects and data:image inline bodies) are unchanged.

Impact: Fewer redundant bytes on pages that show several model avatars; better cache reuse for the default icon. API behavior: clients that expected 200 with a PNG body for the default case now receive a redirect (standard for browsers loading <img src="…">).

Added

Redirect handling for meta.profile_image_url values that start with /static/.

Changed

Default and missing-model branches of get_model_profile_image now respond with RedirectResponse to /static/favicon.png instead of FileResponse of the same file from the API route.

Fixed

Redundant repeated downloads of the default model profile image when multiple models share the fallback asset.

Security

Redirect targets are limited to /static/… for stored relative paths, or the fixed default /static/favicon.png (no open redirect to arbitrary hosts).

Breaking Changes

BREAKING CHANGE: Non-browser or custom clients that called GET …/model/profile/image and assumed a 200 response with an image body for models without a custom image will now receive 302 to /static/favicon.png instead. Browsers and typical <img> usage follow redirects by default.

Additional Information

Before: Open DevTools → Network → filter profile/image → load chat/home with multiple default model pills; observe multiple ~22 KB responses (one per id).
After: First request may still fetch /static/favicon.png; subsequent avatars should reuse cache after redirect (depending on cache headers), and per-model responses are small 302s instead of full PNG bodies.
Docs: No Open WebUI docs repo change required; this is an internal HTTP behavior optimization, not a new user-facing setting or env var.
Dependencies: None.

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.

_{🔄 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/24015 **Author:** [@jmleksan](https://github.com/jmleksan) **Created:** 4/22/2026 **Status:** ✅ Merged **Merged:** 4/24/2026 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `perf/static-redirect` --- ### 📝 Commits (1) - [`2752d74`](https://github.com/open-webui/open-webui/commit/2752d749033da5d167a6be30bd88a949267841da) perf: redirect default model profile image to canonical static URL ### 📊 Changes **1 file changed** (+49 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/routers/models.py` (+49 -4) </details> ### 📄 Description  # Pull Request Checklist  **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **PRs targeting `main` will be immediately closed.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [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:** Add docs in [Open WebUI Docs Repository](https://github.com/open-webui/docs). Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps. - [x] **Dependencies:** Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash. - [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to **make screenshots of the feature/fix and include them in the PR description**. - [x] **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. - [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] **Design & Architecture:** Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes. - [x] **Git Hygiene:** Keep PRs atomic (one logical change). Clean up commits and rebase on `dev` to ensure no unrelated commits (e.g. from `main`) are included. Push updates to the existing PR branch instead of closing and reopening. - [x] **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 tasks # Changelog Entry ### Description Default model avatars are served from `GET /api/v1/models/model/profile/image?id=…`. Each distinct model id produced a **different URL** but the **same fallback file** (`static/favicon.png`, ~22 KB). Browsers therefore downloaded that payload multiple times (visible in Lighthouse transfer size / LCP-related loading). This change returns **HTTP 302** to the canonical static URL `/static/favicon.png` for the default case, and **302** to `meta.profile_image_url` when it is already a site-relative path under `/static/`. Custom images (`http(s):` redirects and `data:image` inline bodies) are unchanged. **Impact:** Fewer redundant bytes on pages that show several model avatars; better cache reuse for the default icon. **API behavior:** clients that expected `200` with a PNG body for the default case now receive a redirect (standard for browsers loading `<img src="…">`). ### Added - Redirect handling for `meta.profile_image_url` values that start with `/static/`. ### Changed - Default and missing-model branches of `get_model_profile_image` now respond with `RedirectResponse` to `/static/favicon.png` instead of `FileResponse` of the same file from the API route. ### Fixed - Redundant repeated downloads of the default model profile image when multiple models share the fallback asset. ### Security - Redirect targets are limited to `/static/…` for stored relative paths, or the fixed default `/static/favicon.png` (no open redirect to arbitrary hosts). ### Breaking Changes - **BREAKING CHANGE**: Non-browser or custom clients that called `GET …/model/profile/image` and assumed a `200` response with an image body for models without a custom image will now receive `302` to `/static/favicon.png` instead. Browsers and typical `<img>` usage follow redirects by default. --- ### Additional Information - **Before:** Open DevTools → Network → filter `profile/image` → load chat/home with multiple default model pills; observe multiple ~22 KB responses (one per `id`). - **After:** First request may still fetch `/static/favicon.png`; subsequent avatars should reuse cache after redirect (depending on cache headers), and per-model responses are small 302s instead of full PNG bodies. - **Docs:** No Open WebUI docs repo change required; this is an internal HTTP behavior optimization, not a new user-facing setting or env var. - **Dependencies:** None. ### Contributor License Agreement  - [x] By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), 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. --- <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-04-25 14:48:02 -05:00

GiteaMirror closed this issue

2026-04-25 14:48:03 -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#43108