[PR #23615] [CLOSED] Fix: Enable outlet filters for direct API clients by integrating /chat/completed processing into /chat/completion #98315

New Issue

GiteaMirror · 2026-05-16T01:06:45-05:00

GiteaMirror commented

2026-05-16 01:06:45 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/23615
Author: @pfn
Created: 4/12/2026
Status: ❌ Closed

Base: dev ← Head: completed-in-completion

📝 Commits (1)

d10bd1d Re-implement /chat/completed in /chat/completion, make completed no-op

📊 Changes

2 files changed (+222 additions, -13 deletions)

View changed files

📝 backend/open_webui/main.py (+8 -13)
📝 backend/open_webui/utils/middleware.py (+214 -0)

📄 Description

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. 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.
[N] Documentation: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.
[N] 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 work

Changelog Entry

Description

This PR fixes a long-standing issue where direct API clients (e.g., opencode, cline, openclaw, Langfuse integrations) could not trigger outlet filters because they don't call the /api/chat/completed endpoint. Now, outlet filters run universally for all completion requests, regardless of the client type.

Added

Added run_outlet_filters() function (middleware.py)

Changed

Integrated outlet filters into completion handlers (middleware.py)

Deprecated

Made /api/chat/completed a no-op (main.py)

Removed

[List any removed features, files, or functionalities]

Fixed

bug: File upload error-'NoneType' object is not iterable (#3237)

Security

N/A

Breaking Changes

BREAKING CHANGE: Unknown

Additional Information

Problem

Previously, outlet filters (used for logging, analytics, content moderation, etc.) only executed when the /api/chat/completed endpoint was called. The Web UI calls this endpoint after receiving a completion response, but direct API clients typically don't know about this endpoint and never call it. This meant:

Outlet filters never ran for direct API clients
Logging/analytics tools like Langfuse couldn't capture complete conversation data
Inconsistent behavior between Web UI and API clients
Custom filter outlet functions were silently skipped

Solution

Outlet filter processing has been moved from /api/chat/completed into the /api/chat/completion endpoint itself. Outlet filters now run as the final step of the completion flow, after background tasks (title generation, tag generation, etc.) but before the response is returned to the client.

Key Decision: Outlet filters run after background tasks (not before). This ensures that title and tag generation complete first, so outlet filters see the final state. An alternative design could run outlet filters before background tasks, but that would mean filters wouldn't see generated titles/tags. This matches the behavior as if calling /chat/completed

Testing

Basic testing has been performed with the following scenarios:

Normal chat with Web UI (outlet filters run)
Temporary chat (now triggers outlet filters where it didn't before). Temporary chats remain temporary and are not saved.
Direct API clients (opencode, cline, openclaw)
Streaming and non-streaming responses
Outlet filters with both pipeline and custom filter functions

All of these scenarios have been verified to show up in langfuse (pipeline filter) and work correctly with my own filters that I have installed.

Backward Compatibility

Web UI behavior preserved: Web UI continues to work as before (can decide to remove completed later if desired)
/api/chat/completed remains functional: Returns input payload unchanged (no-op)
No breaking changes: All existing functionality is preserved (as far as I've tested locally)
Filter compatibility: Existing outlet filters work without modification (the ones I've tested)

Performance Considerations

The stream fallback path accumulates all chunks in memory before running outlet filters. This could cause memory pressure for very long streams.
Response latency may increase slightly due to inline outlet filter execution (filters now run during the request instead of after response is sent).
No formal performance benchmarks have been conducted.

Notes

- Community Distribution: This fix is being made primarily being made available for the community to apply to their own installations, as the core Open WebUI project does not seem eager to adopt this change.

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 (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/23615 **Author:** [@pfn](https://github.com/pfn) **Created:** 4/12/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `completed-in-completion` --- ### 📝 Commits (1) - [`d10bd1d`](https://github.com/open-webui/open-webui/commit/d10bd1de2581bf76e381afb751f09c78d3c234a3) Re-implement /chat/completed in /chat/completion, make completed no-op ### 📊 Changes **2 files changed** (+222 additions, -13 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/main.py` (+8 -13) 📝 `backend/open_webui/utils/middleware.py` (+214 -0) </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) 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:** - [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. - [N] **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. - [N] **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 work # Changelog Entry ### Description This PR fixes a long-standing issue where direct API clients (e.g., opencode, cline, openclaw, Langfuse integrations) could not trigger outlet filters because they don't call the /api/chat/completed endpoint. Now, outlet filters run universally for all completion requests, regardless of the client type. ### Added - Added run_outlet_filters() function (middleware.py) ### Changed - Integrated outlet filters into completion handlers (middleware.py) ### Deprecated - Made /api/chat/completed a no-op (main.py) ### Removed - [List any removed features, files, or functionalities] ### Fixed - #3237 ### Security - N/A ### Breaking Changes - **BREAKING CHANGE**: Unknown --- ### Additional Information #### Problem Previously, outlet filters (used for logging, analytics, content moderation, etc.) only executed when the `/api/chat/completed` endpoint was called. The Web UI calls this endpoint after receiving a completion response, but direct API clients typically don't know about this endpoint and never call it. This meant: - Outlet filters never ran for direct API clients - Logging/analytics tools like Langfuse couldn't capture complete conversation data - Inconsistent behavior between Web UI and API clients - Custom filter outlet functions were silently skipped #### Solution Outlet filter processing has been moved from `/api/chat/completed` into the `/api/chat/completion` endpoint itself. Outlet filters now run as the final step of the completion flow, after background tasks (title generation, tag generation, etc.) but before the response is returned to the client. **Key Decision:** Outlet filters run **after** background tasks (not before). This ensures that title and tag generation complete first, so outlet filters see the final state. An alternative design could run outlet filters before background tasks, but that would mean filters wouldn't see generated titles/tags. This matches the behavior as if calling /chat/completed #### Testing Basic testing has been performed with the following scenarios: - Normal chat with Web UI (outlet filters run) - Temporary chat (now triggers outlet filters where it didn't before). Temporary chats remain temporary and are not saved. - Direct API clients (opencode, cline, openclaw) - Streaming and non-streaming responses - Outlet filters with both pipeline and custom filter functions All of these scenarios have been verified to show up in langfuse (pipeline filter) and work correctly with my own filters that I have installed. #### Backward Compatibility - **Web UI behavior preserved:** Web UI continues to work as before (can decide to remove completed later if desired) - **`/api/chat/completed` remains functional:** Returns input payload unchanged (no-op) - **No breaking changes:** All existing functionality is preserved (as far as I've tested locally) - **Filter compatibility:** Existing outlet filters work without modification (the ones I've tested) #### Performance Considerations - The stream fallback path accumulates all chunks in memory before running outlet filters. This could cause memory pressure for very long streams. - Response latency may increase slightly due to inline outlet filter execution (filters now run during the request instead of after response is sent). - No formal performance benchmarks have been conducted. #### Notes - - **Community Distribution:** This fix is being made primarily being made available for the community to apply to their own installations, as the core Open WebUI project does not seem eager to adopt this change. ### Screenshots or Videos - N/A ### 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-05-16 01:06:45 -05:00

GiteaMirror closed this issue

2026-05-16 01:06:48 -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#98315