Use the DRF default setting for NON_FIELD_ERRORS_KEY

Author: Korben11

rest_registration/api/views/login.py

@@ -30,6 +30,10 @@ def login(request):
     try:
         user = login_authenticator(serializer.validated_data, serializer=serializer)
     except UserNotFound:
+        if registration_settings.USE_NON_FIELD_ERRORS_KEY_FROM_DRF_SETTINGS:
+            raise LoginInvalid({
+                api_settings.NON_FIELD_ERRORS_KEY: [LoginInvalid.default_detail]
+            }) from None
         raise LoginInvalid() from None
 
     extra_data = perform_login(request, user)

rest_registration/api/views/register.py

@@ -4,6 +4,7 @@
 from rest_framework import serializers, status
 from rest_framework.decorators import api_view, permission_classes
 from rest_framework.response import Response
+from rest_framework.settings import api_settings
 
 from rest_registration import signals
 from rest_registration.api.views.login import perform_login
@@ -46,7 +47,10 @@ def register(request):
         email_field_name = get_user_email_field_name()
         if (email_field_name not in serializer.validated_data
                 or not serializer.validated_data[email_field_name]):
-            raise BadRequest(_("User without email cannot be verified"))
+            detail = _("User without email cannot be verified")
+            if registration_settings.USE_NON_FIELD_ERRORS_KEY_FROM_DRF_SETTINGS:
+                raise BadRequest({api_settings.NON_FIELD_ERRORS_KEY: [detail]})
+            raise BadRequest(detail)
 
     with transaction.atomic():
         user = serializer.save(**kwargs)

rest_registration/api/views/register_email.py

@@ -3,6 +3,7 @@
 from rest_framework import serializers
 from rest_framework.decorators import api_view, permission_classes
 from rest_framework.permissions import IsAuthenticated
+from rest_framework.settings import api_settings
 
 from rest_registration import signals
 from rest_registration.decorators import (
@@ -68,7 +69,10 @@ def register_email(request):
             notification_data, template_config_data, custom_user_address=email)
     else:
         if email_already_used:
-            raise BadRequest(_("This email is already registered."))
+            detail = _("This email is already registered.")
+            if registration_settings.USE_NON_FIELD_ERRORS_KEY_FROM_DRF_SETTINGS:
+                raise BadRequest({api_settings.NON_FIELD_ERRORS_KEY: [detail]})
+            raise BadRequest(detail)
 
         email_field_name = get_user_email_field_name()
         old_email = getattr(user, email_field_name)
@@ -118,7 +122,10 @@ def process_verify_email_data(input_data, serializer_context=None):
     new_email = data['email']
 
     if is_user_email_field_unique() and user_with_email_exists(new_email):
-        raise BadRequest(_("This email is already registered."))
+        detail = _("This email is already registered.")
+        if registration_settings.USE_NON_FIELD_ERRORS_KEY_FROM_DRF_SETTINGS:
+            raise BadRequest({api_settings.NON_FIELD_ERRORS_KEY: [detail]})
+        raise BadRequest(detail)
 
     email_field_name = get_user_email_field_name()
     user = get_user_by_verification_id(data['user_id'])

rest_registration/settings_fields.py

@@ -363,6 +363,10 @@ def __new__(
         default='rest_registration.utils.responses.build_default_success_response',  # noqa: E501
         import_string=True,
     ),
+    Field(
+        'USE_NON_FIELD_ERRORS_KEY_FROM_DRF_SETTINGS',
+        default=False
+    ),
 ]
 
 PERMISSIONS_SETTINGS_FIELDS = [

tests/api/views/login/test_login.py

@@ -80,6 +80,22 @@ def test_when_faulty_auth_token_manager_then_login_fails(
     assert_response_is_bad_request(response)
 
 
+@override_rest_registration_settings({
+    'USE_NON_FIELD_ERRORS_KEY_FROM_DRF_SETTINGS': True,
+})
+def test_invalid_non_field_errors(
+        settings_minimal,
+        user, password_change, api_view_provider, api_factory):
+    request = api_factory.create_post_request({
+        'login': user.username,
+        'password': "blah",
+    })
+    api_factory.add_session_to_request(request)
+    response = api_view_provider.view_func(request)
+    assert "non_field_errors" in response.data
+    assert_response_is_bad_request(response)
+
+
 @override_rest_registration_settings({
     'LOGIN_SERIALIZER_CLASS': 'tests.testapps.custom_serializers.serializers.DefaultDeprecatedLoginSerializer',  # noqa: E501
 })