-
-
Notifications
You must be signed in to change notification settings - Fork 7.1k
Fix #8839: Use USERNAME_FIELD instead of hardcoded 'username' in AuthTokenSerializer #9932
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| from django.contrib.auth import authenticate | ||
| from django.contrib.auth import authenticate, get_user_model | ||
| from django.utils.translation import gettext_lazy as _ | ||
|
|
||
| from rest_framework import serializers | ||
|
|
@@ -20,13 +20,33 @@ class AuthTokenSerializer(serializers.Serializer): | |
| read_only=True | ||
| ) | ||
|
|
||
| def __init__(self, *args, **kwargs): | ||
| super().__init__(*args, **kwargs) | ||
| User = get_user_model() | ||
| username_field = User.USERNAME_FIELD | ||
| if username_field != 'username' and 'username' in self.fields: | ||
| # Rebuild the fields mapping to preserve the original position | ||
| # of the login field when renaming it. | ||
| original_items = list(self.fields.items()) | ||
| new_fields = self.fields.__class__(self) | ||
| for name, field in original_items: | ||
| if name == 'username': | ||
| name = username_field | ||
| field.label = _(username_field.capitalize()) | ||
| new_fields[name] = field | ||
| self.fields = new_fields | ||
|
|
||
| def validate(self, attrs): | ||
| username = attrs.get('username') | ||
| User = get_user_model() | ||
| username_field = User.USERNAME_FIELD | ||
| username = attrs.get(username_field) | ||
| password = attrs.get('password') | ||
|
|
||
| if username and password: | ||
| user = authenticate(request=self.context.get('request'), | ||
| username=username, password=password) | ||
| user = authenticate( | ||
| request=self.context.get('request'), | ||
| **{username_field: username, 'password': password} | ||
| ) | ||
|
|
||
| # The authenticate call simply returns None for is_active=False | ||
| # users. (Assuming the default ModelBackend authentication | ||
|
|
@@ -35,7 +55,7 @@ def validate(self, attrs): | |
| msg = _('Unable to log in with provided credentials.') | ||
| raise serializers.ValidationError(msg, code='authorization') | ||
| else: | ||
| msg = _('Must include "username" and "password".') | ||
| msg = _(f'Must include "{username_field}" and "password".') | ||
| raise serializers.ValidationError(msg, code='authorization') | ||
|
Comment on lines
57
to
59
|
||
|
|
||
| attrs['user'] = user | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The local variable name
usernameis now potentially an email/phone/etc (depending onUSERNAME_FIELD), which makes the control flow harder to follow. Consider renaming it to something neutral likeidentifier/login(and similarly forusername_fieldif you store it onself).