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
Changelog Entry
Description
Unified the logic about selecting the model into the new function get_model that throws a consistent exception in case the model is not defined. This also fixes the issue that in some instances the model selection wasn't properly throwing a descriptive exception.
Unified the logic that transforms an exception into a JSONResponse handling both the HTTPException object and the generic Exception object. This fixes the issue that sometimes the e.args tuple did not contain enough items to properly construct the JSONResponse
Added
Unified logic for selecting the model in get_model
Unified the logic that transforms an exception into a JSONResponse in exception_json_response
Changed
Updated the code to take advantage of the new functions get_model and exception_json_response
Fixed
Selecting an undefined model returns an informative error message
Base exceptions are now properly handled and they don't result into an index error for the tuple e.args
🔄 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/4392
**Author:** [@simon3z](https://github.com/simon3z)
**Created:** 8/5/2024
**Status:** ❌ Closed
**Base:** `dev` ← **Head:** `main`
---
### 📝 Commits (1)
- [`811386b`](https://github.com/open-webui/open-webui/commit/811386b67f2099228d4b86673d80641c7c83afd0) fix: improve exception handling
### 📊 Changes
**1 file changed** (+35 additions, -61 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/main.py` (+35 -61)
</details>
### 📄 Description
# Pull Request Checklist
As first-time contributor I described the issue here: https://github.com/open-webui/open-webui/discussions/4390
**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.
- ~[ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?~
- ~[ ] **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
- Unified the logic about selecting the model into the new function `get_model` that throws a consistent exception in case the model is not defined. This also fixes the issue that in some instances the model selection wasn't properly throwing a descriptive exception.
- Unified the logic that transforms an exception into a `JSONResponse` handling both the `HTTPException` object and the generic `Exception` object. This fixes the issue that sometimes the `e.args` tuple did not contain enough items to properly construct the `JSONResponse`
### Added
- Unified logic for selecting the model in `get_model`
- Unified the logic that transforms an exception into a `JSONResponse` in `exception_json_response`
### Changed
- Updated the code to take advantage of the new functions `get_model` and `exception_json_response`
### Fixed
- Selecting an undefined model returns an informative error message
- Base exceptions are now properly handled and they don't result into an index error for the tuple `e.args`
---
<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/4392
Author: @simon3z
Created: 8/5/2024
Status: ❌ Closed
Base:
dev← Head:main📝 Commits (1)
811386bfix: improve exception handling📊 Changes
1 file changed (+35 additions, -61 deletions)
View changed files
📝
backend/main.py(+35 -61)📄 Description
Pull Request Checklist
As first-time contributor I described the issue here: https://github.com/open-webui/open-webui/discussions/4390
Before submitting, make sure you've checked the following:
devbranch.[ ] 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?Changelog Entry
Description
get_modelthat throws a consistent exception in case the model is not defined. This also fixes the issue that in some instances the model selection wasn't properly throwing a descriptive exception.JSONResponsehandling both theHTTPExceptionobject and the genericExceptionobject. This fixes the issue that sometimes thee.argstuple did not contain enough items to properly construct theJSONResponseAdded
get_modelJSONResponseinexception_json_responseChanged
get_modelandexception_json_responseFixed
e.args🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.