de8492d fix: GitHub OAuth email retrieval when public email is not set
📊 Changes
1 file changed (+29 additions, -3 deletions)
View changed files
📝backend/open_webui/utils/oauth.py (+29 -3)
📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
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
When someone's github public email is not set, user_data.get(email_claim, "") will get a "None" ，which will lead to AttributeError: 'NoneType' object has no attribute 'lower' ,and return Internal Server Error.
When email is None and provide is github ,use the api to get the emails and select the primary email as the user's email
Fixed
When github pubic email is not set ,oauth failed
🔄 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/10410
**Author:** [@xinhai-ai](https://github.com/xinhai-ai)
**Created:** 2/20/2025
**Status:** ✅ Merged
**Merged:** 2/20/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `dev`
---
### 📝 Commits (1)
- [`de8492d`](https://github.com/open-webui/open-webui/commit/de8492de345145be73f1a088ddcf7f0c2908f3ad) fix: GitHub OAuth email retrieval when public email is not set
### 📊 Changes
**1 file changed** (+29 additions, -3 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/utils/oauth.py` (+29 -3)
</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) and describe your changes before submitting a pull request.
**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
When someone's github public email is not set, ``user_data.get(email_claim, "")`` will get a "None" ，which will lead to ``AttributeError: 'NoneType' object has no attribute 'lower'`` ,and return Internal Server Error.
This commit use [github List email addresses for the authenticated user](https://docs.github.com/zh/rest/users/emails?apiVersion=2022-11-28#list-email-addresses-for-the-authenticated-user) to get user's emails and select the primary email as email,to avoid the error
### Changed
When email is ``None`` and provide is ``github`` ,use the api to get the emails and select the primary email as the user's email
### Fixed
When github pubic email is not set ,oauth failed
---
---
<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/10410
Author: @xinhai-ai
Created: 2/20/2025
Status: ✅ Merged
Merged: 2/20/2025
Merged by: @tjbck
Base:
dev← Head:dev📝 Commits (1)
de8492dfix: GitHub OAuth email retrieval when public email is not set📊 Changes
1 file changed (+29 additions, -3 deletions)
View changed files
📝
backend/open_webui/utils/oauth.py(+29 -3)📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
When someone's github public email is not set,
user_data.get(email_claim, "")will get a "None" ，which will lead toAttributeError: 'NoneType' object has no attribute 'lower',and return Internal Server Error.This commit use github List email addresses for the authenticated user to get user's emails and select the primary email as email,to avoid the error
Changed
When email is
Noneand provide isgithub,use the api to get the emails and select the primary email as the user's emailFixed
When github pubic email is not set ,oauth failed
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.