Merge pull request #4 from Styria-Digital/feature/optional_checksum_check

Feature/optional checksum check

Author: ntuckovic

README.md

@@ -12,7 +12,8 @@ Releasing as an installable package is planned only for a private repo for now,
 
 Available additional settings that can be set to `UNICORN` dict in settings.py which are not part of official package.
 
-- `USE_CSRF_TOKEN` - default: `True` - If set to `False`, unicorn does not check or send `csrf` token value so `{% csrf_token %}` is not mandatory in the templates. This is added due the fact to additional page caching system like `Varnish` does not operate effective if `Cookie` value is present in `Vary` header. 
+- `USE_CSRF_TOKEN` - default: `True` - If set to `False`, unicorn does not check or send `csrf` token value so `{% csrf_token %}` is not mandatory in the templates. This is added due the fact to additional page caching system like `Varnish` does not operate effective if `Cookie` value is present in `Vary` header.
+- `CHECK_CHECKSUM_MATCH` - default: `True` - If set to `False`, `unicorn` does not perform data checksum check on each request.
 
 ## Deployment
 
@@ -24,6 +25,10 @@ Available additional settings that can be set to `UNICORN` dict in settings.py w
 
 ## Customization changelog
 
+### 0.58.1.2 - (2024-01-10)
+
+- add optional `CHECK_CHECKSUM_MATCH` setting which is set by default to True. If turned off, `unicorn` does not perform data checksum check on each request.
+
 ### 0.58.1.1 - (2024-01-10)
 
 - No customizations, just sync with main package.

django_unicorn/views/objects.py

@@ -5,6 +5,7 @@
 from django_unicorn.components import HashUpdate, LocationUpdate, PollUpdate
 from django_unicorn.errors import UnicornViewError
 from django_unicorn.serializer import JSONDecodeError, dumps, loads
+from django_unicorn.settings import get_setting
 from django_unicorn.utils import generate_checksum, is_int
 
 logger = logging.getLogger(__name__)
@@ -88,6 +89,9 @@ def validate_checksum(self):
         """
         Validates that the checksum in the request matches the data.
 
+        If `CHECK_CHECKSUM_MATCH` is set to False,
+        checking of matching checksum is avoided.
+
         Returns:
             Raises `AssertionError` if the checksums don't match.
         """
@@ -97,11 +101,14 @@ def validate_checksum(self):
             # TODO: Raise specific exception
             raise AssertionError("Missing checksum")
 
-        generated_checksum = generate_checksum(self.data)
+        check_checksum_match = get_setting("CHECK_CHECKSUM_MATCH", True)
 
-        if checksum != generated_checksum:
-            # TODO: Raise specific exception
-            raise AssertionError("Checksum does not match")
+        if check_checksum_match:
+            generated_checksum = generate_checksum(self.data)
+
+            if checksum != generated_checksum:
+                # TODO: Raise specific exception
+                raise AssertionError("Checksum does not match")
 
 
 class Return:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-unicorn-loosened"
-version = "0.58.1.1"
+version = "0.58.1.2"
 description = "An alternate version of a magical full-stack framework for Django."
 authors = ["Adam Hill <[email protected]>", "Styria Digital Development <[email protected]>"]
 license = "MIT"