Declare Box.deleted_on as ZeroDateTimeField

Author: pylipp

back/boxtribute_server/models/definitions/box.py

@@ -2,7 +2,7 @@
 
 from ...db import db
 from ...enums import BoxState as BoxStateEnum
-from ..fields import UIntForeignKeyField
+from ..fields import UIntForeignKeyField, ZeroDateTimeField
 from .box_state import BoxState
 from .distribution_event import DistributionEvent
 from .location import Location
@@ -44,7 +44,7 @@ class Box(db.Model):  # type: ignore
         on_delete="SET NULL",
         on_update="CASCADE",
     )
-    deleted_on = DateTimeField(column_name="deleted", null=True, default=None)
+    deleted_on = ZeroDateTimeField(column_name="deleted", null=True, default=None)
     distribution_event = UIntForeignKeyField(
         column_name="distro_event_id",
         field="id",

back/boxtribute_server/models/fields.py

@@ -77,7 +77,11 @@ class UIntForeignKeyField(ForeignKeyField):
 
 
 class ZeroDateTimeField(DateTimeField):
-    """Custom class to convert MySQL zero DATETIME field value into None."""
+    """Custom class to convert MySQL zero DATETIME field value into None.
+    If this is not used, peewee will return the zero datetime as string, and the
+    conversion in `graph_ql.scalars` will fail with the message 'GraphQLError:
+    str.replace() takes no keyword arguments'.
+    """
 
     def adapt(self, value):
         if value == "0000-00-00 00:00:00":

back/test/integration_tests/test_operations.py

@@ -20,9 +20,9 @@ def _assert_successful_request(*args, **kwargs):
     queried_box = _assert_successful_request(auth0_client, query)["box"]
     assert queried_box == {"id": "100000000"}
 
-    query = """query { box(labelIdentifier: "328765") { state size { id } } }"""
+    query = 'query { box(labelIdentifier: "328765") { deletedOn state size { id } } }'
     queried_box = _assert_successful_request(auth0_client, query)
-    assert queried_box == {"state": "Donated", "size": {"id": "68"}}
+    assert queried_box == {"state": "Donated", "size": {"id": "68"}, "deletedOn": None}
 
     query = """query { beneficiary(id: 100000001) { dateOfBirth } }"""
     queried_beneficiary = _assert_successful_request(auth0_client, query)