feat: MySQLSafeUUIDField for migrating to Django 5 on MariaDB

Set USE_CHAR32_UUIDS=True in settings.py to enable

Author: miggol

dev/dev_project/settings.py

@@ -141,6 +141,9 @@
     }
 }
 
+# Set to true if migrating to Django 5 from MariaDB/MySQL
+USE_CHAR32_UUIDS = False
+
 # Default primary key field type
 # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
 

src/cdh/files/db/models.py

@@ -9,6 +9,7 @@
 from cdh.files.db.wrappers import FileWrapper
 
 
+USE_CHAR32_UUIDS = getattr(settings, "USE_CHAR32_UUIDS", False,)
 logger = logging.getLogger('cdh.files')
 
 
@@ -29,14 +30,44 @@ def __set__(self, instance, value):
         instance._file_wrapper_cache = value
 
 
+class MySQLSafeUUIDField(models.UUIDField,):
+    """
+    Workaround class.
+
+    Django 5.0 switched from DB column type for UUID's on MySQL/MariaDB.
+    The standard UUIDField is not aware of this change, and will fail to
+    insert UUID's into the char(32) columns. For applications that run into
+    this problem, this UUID field is provided which respects the setting
+    USE_CHAR32_UUIDS in settings.py to support older fields.
+
+    Details: https://docs.djangoproject.com/en/6.0/releases/5.0/#migrating-existing-uuidfield-on-mariadb-10-7
+    """
+
+    def __init__(self, *args, **kwargs):
+        self.use_char32_uuids = USE_CHAR32_UUIDS
+        super().__init__(*args, **kwargs)
+
+    def db_type(self, connection):
+        if self.use_char32_uuids:
+            return "char(32)"
+        return super().db_type(connection)
+
+    def get_db_prep_value(self, value, connection, prepared=False):
+        value = super().get_db_prep_value(value, connection, prepared)
+        breakpoint()
+        if self.use_char32_uuids and value is not None:
+            value = value.hex
+        return value
+
+
 class BaseFile(models.Model):
     class Meta:
         abstract = True
 
     objects = manager.FileManager()
 
     # Human-facing PK; Also acts as the filename on disk
-    uuid = models.UUIDField(
+    uuid = MySQLSafeUUIDField(
         "Universally Unique IDentifier",
         unique=True,
         default=uuid.uuid4,