Handle list and string validation errors, not just the dictionary.

Author: adamghill

django_unicorn/views/__init__.py

@@ -6,6 +6,7 @@
 import orjson
 from bs4 import BeautifulSoup
 from django.core.cache import caches
+from django.core.exceptions import NON_FIELD_ERRORS
 from django.forms import ValidationError
 from django.http import HttpRequest, JsonResponse
 from django.http.response import HttpResponseNotModified
@@ -36,6 +37,9 @@
 logger.setLevel(logging.DEBUG)
 
 
+MIN_VALIDATION_ERROR_ARGS = 2
+
+
 def handle_error(view_func):
     """
     Returns a JSON response with an error if necessary.
@@ -130,19 +134,28 @@ def _process_component_request(request: HttpRequest, component_request: Componen
                 is_reset_called = is_reset_called | _is_reset_called
                 validate_all_fields = validate_all_fields | _validate_all_fields
             except ValidationError as e:
-                if hasattr(e, "error_list"):
-                    raise AssertionError("ValidationError must be instantiated with a dictionary") from e
-
-                for field, message in e.message_dict.items():
-                    if not e.args[1]:
-                        raise AssertionError("Error code must be specified") from e
+                if len(e.args) < MIN_VALIDATION_ERROR_ARGS or not e.args[1]:
+                    raise AssertionError("Error code must be specified") from e
 
+                if hasattr(e, "error_list"):
                     error_code = e.args[1]
 
-                    if field in component.errors:
-                        component.errors[field].append({"code": error_code, "message": message})
-                    else:
-                        component.errors[field] = [{"code": error_code, "message": message}]
+                    for error in e.error_list:
+                        if NON_FIELD_ERRORS in component.errors:
+                            component.errors[NON_FIELD_ERRORS].append({"code": error_code, "message": error.message})
+                        else:
+                            component.errors[NON_FIELD_ERRORS] = [{"code": error_code, "message": error.message}]
+                elif hasattr(e, "message_dict"):
+                    for field, message in e.message_dict.items():
+                        if not e.args[1]:
+                            raise AssertionError("Error code must be specified") from e
+
+                        error_code = e.args[1]
+
+                        if field in component.errors:
+                            component.errors[field].append({"code": error_code, "message": message})
+                        else:
+                            component.errors[field] = [{"code": error_code, "message": message}]
         else:
             raise UnicornViewError(f"Unknown action_type '{action.action_type}'")
 

docs/source/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.58.0-dev
+
+- Handle a list of `ValidationError` or just a string instead of requiring a the `dict` version.
+
 ## 0.57.1
 
 - Fix: Correctly serialize forms that have a a field with a Select widget.

docs/source/validation.md

@@ -148,7 +148,7 @@ There is a `unicorn_errors` template tag that shows all errors for the component
 
 ## ValidationError
 
-If you do not want to create a form class or you want to specifically target a nested field you can raise a `ValidationError` inside of an action method. The `ValidationError` must be instantiated with a `dict` with the model name as the key and error message as the value. A `code` keyword argument must also be passed in. The typical error codes used are `required` or `invalid`.
+If you do not want to create a form class or you want to specifically target a nested field you can raise a `ValidationError` inside of an action method. The `ValidationError` can be instantiated with a `dict` with the model name as the key and error message as the value. A `code` keyword argument must also be passed in. The typical error codes used are `required` or `invalid`.
 
 ```python
 # book_validation_error.py

tests/views/fake_components.py

@@ -62,8 +62,14 @@ def test_validation_error_no_code(self):
     def test_validation_error_string(self):
         raise ValidationError("Check is required", code="required")
 
+    def test_validation_error_string_no_code(self):
+        raise ValidationError("Check is required")
+
     def test_validation_error_list(self):
-        raise ValidationError([ValidationError({"check": "Check is required"}, code="required")])
+        raise ValidationError([ValidationError({"check": "Check is required"})], code="required")
+
+    def test_validation_error_list_no_code(self):
+        raise ValidationError([ValidationError({"check": "Check is required"})])
 
 
 class FakeModelForm(forms.ModelForm):

tests/views/message/test_call_method.py

@@ -360,8 +360,15 @@ def test_message_call_method_validation_error(client):
 def test_message_call_method_validation_error_list(client):
     body = _post_to_component(client, "test_validation_error_list")
 
+    assert body["errors"]
+    assert body["errors"]["__all__"] == [{"code": "required", "message": "Check is required"}]
+
+
+def test_message_call_method_validation_error_list_no_code(client):
+    body = _post_to_component(client, "test_validation_error_list_no_code")
+
     assert body["error"]
-    assert body["error"] == "ValidationError must be instantiated with a dictionary"
+    assert body["error"] == "Error code must be specified"
 
 
 def test_message_call_method_validation_error_no_code(client):
@@ -374,5 +381,12 @@ def test_message_call_method_validation_error_no_code(client):
 def test_message_call_method_validation_error_string(client):
     body = _post_to_component(client, "test_validation_error_string")
 
+    assert body["errors"]
+    assert body["errors"]["__all__"] == [{"code": "required", "message": "Check is required"}]
+
+
+def test_message_call_method_validation_error_string_no_code(client):
+    body = _post_to_component(client, "test_validation_error_string_no_code")
+
     assert body["error"]
-    assert body["error"] == "ValidationError must be instantiated with a dictionary"
+    assert body["error"] == "Error code must be specified"