feat: update migrations to support pg18+

Also refactor common calls for DRY and simplifying any later standard
collation updates

Signed-off-by: Anton Melser <[email protected]>

Author: AntonOfTheWoods

openedx_learning/apps/authoring/collections/migrations/0001_initial.py

@@ -19,8 +19,8 @@ class Migration(migrations.Migration):
             name='Collection',
             fields=[
                 ('id', models.AutoField(primary_key=True, serialize=False)),
-                ('name', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, db_index=True, help_text='The name of the collection.', max_length=255)),
-                ('description', openedx_learning.lib.fields.MultiCollationCharField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, help_text='Provides extra information for the user about this collection.', max_length=10000)),
+                ('name', openedx_learning.lib.fields.case_insensitive_char_field(db_index=True, help_text='The name of the collection.', max_length=255)),
+                ('description', openedx_learning.lib.fields.case_insensitive_char_field(blank=True, help_text='Provides extra information for the user about this collection.', max_length=10000)),
                 ('enabled', models.BooleanField(default=True, help_text='Whether the collection is enabled or not.')),
                 ('created', models.DateTimeField(auto_now_add=True)),
                 ('modified', models.DateTimeField(auto_now=True)),

openedx_learning/apps/authoring/collections/migrations/0002_remove_collection_name_collection_created_by_and_more.py

@@ -28,7 +28,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='collection',
             name='title',
-            field=openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, default='Collection', help_text='The title of the collection.', max_length=500),
+            field=openedx_learning.lib.fields.case_insensitive_char_field(default='Collection', help_text='The title of the collection.', max_length=500),
             preserve_default=False,
         ),
         migrations.AlterField(
@@ -39,7 +39,7 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='collection',
             name='description',
-            field=openedx_learning.lib.fields.MultiCollationTextField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, default='', help_text='Provides extra information for the user about this collection.', max_length=10000),
+            field=openedx_learning.lib.fields.case_insensitive_text_field(blank=True, default='', help_text='Provides extra information for the user about this collection.', max_length=10000),
         ),
         migrations.AlterField(
             model_name='collection',

openedx_learning/apps/authoring/collections/migrations/0004_collection_key.py

@@ -33,8 +33,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='collection',
             name='key',
-            field=openedx_learning.lib.fields.MultiCollationCharField(
-                db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'},
+            field=openedx_learning.lib.fields.case_sensitive_char_field(
                 db_column='_key', max_length=500, null=True, blank=True),
             preserve_default=False,
         ),
@@ -44,8 +43,7 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='collection',
             name='key',
-            field=openedx_learning.lib.fields.MultiCollationCharField(
-                db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'},
+            field=openedx_learning.lib.fields.case_sensitive_char_field(
                 db_column='_key', max_length=500, null=False, blank=False),
             preserve_default=False,
         ),

openedx_learning/apps/authoring/components/migrations/0001_initial.py

@@ -22,7 +22,7 @@ class Migration(migrations.Migration):
             name='Component',
             fields=[
                 ('publishable_entity', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, primary_key=True, serialize=False, to='oel_publishing.publishableentity')),
-                ('local_key', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=500)),
+                ('local_key', openedx_learning.lib.fields.case_sensitive_char_field(max_length=500)),
             ],
             options={
                 'verbose_name': 'Component',
@@ -33,8 +33,8 @@ class Migration(migrations.Migration):
             name='ComponentType',
             fields=[
                 ('id', models.AutoField(primary_key=True, serialize=False)),
-                ('namespace', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=100)),
-                ('name', openedx_learning.lib.fields.MultiCollationCharField(blank=True, db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=100)),
+                ('namespace', openedx_learning.lib.fields.case_sensitive_char_field(max_length=100)),
+                ('name', openedx_learning.lib.fields.case_sensitive_char_field(blank=True, max_length=100)),
             ],
         ),
         migrations.CreateModel(
@@ -53,7 +53,7 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True, verbose_name='UUID')),
-                ('key', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=500)),
+                ('key', openedx_learning.lib.fields.case_sensitive_char_field(max_length=500)),
                 ('learner_downloadable', models.BooleanField(default=False)),
                 ('component_version', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='oel_components.componentversion')),
                 ('content', models.ForeignKey(on_delete=django.db.models.deletion.RESTRICT, to='oel_contents.content')),

openedx_learning/apps/authoring/components/migrations/0002_alter_componentversioncontent_key.py

@@ -15,6 +15,6 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='componentversioncontent',
             name='key',
-            field=openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_column='_key', max_length=500),
+            field=openedx_learning.lib.fields.case_sensitive_char_field(db_column='_key', max_length=500),
         ),
     ]

openedx_learning/apps/authoring/contents/migrations/0001_initial.py

@@ -24,7 +24,7 @@ class Migration(migrations.Migration):
                 ('size', models.PositiveBigIntegerField(validators=[django.core.validators.MaxValueValidator(50000000)])),
                 ('hash_digest', models.CharField(editable=False, max_length=40)),
                 ('has_file', models.BooleanField()),
-                ('text', openedx_learning.lib.fields.MultiCollationTextField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, max_length=50000, null=True)),
+                ('text', openedx_learning.lib.fields.case_insensitive_text_field(blank=True, max_length=50000, null=True)),
                 ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])),
             ],
             options={
@@ -36,9 +36,9 @@ class Migration(migrations.Migration):
             name='MediaType',
             fields=[
                 ('id', models.AutoField(primary_key=True, serialize=False)),
-                ('type', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, max_length=127)),
-                ('sub_type', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, max_length=127)),
-                ('suffix', openedx_learning.lib.fields.MultiCollationCharField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, max_length=127)),
+                ('type', openedx_learning.lib.fields.case_insensitive_char_field(max_length=127)),
+                ('sub_type', openedx_learning.lib.fields.case_insensitive_char_field(max_length=127)),
+                ('suffix', openedx_learning.lib.fields.case_insensitive_char_field(blank=True, max_length=127)),
             ],
         ),
         migrations.AddConstraint(

openedx_learning/apps/authoring/publishing/migrations/0001_initial.py

@@ -25,9 +25,9 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.AutoField(primary_key=True, serialize=False)),
                 ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True, verbose_name='UUID')),
-                ('key', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=500)),
-                ('title', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, max_length=500)),
-                ('description', openedx_learning.lib.fields.MultiCollationTextField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, default='', max_length=10000)),
+                ('key', openedx_learning.lib.fields.case_sensitive_char_field(max_length=500)),
+                ('title', openedx_learning.lib.fields.case_insensitive_char_field(max_length=500)),
+                ('description', openedx_learning.lib.fields.case_insensitive_text_field(blank=True, default='', max_length=10000)),
                 ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])),
                 ('updated', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])),
             ],
@@ -41,7 +41,7 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True, verbose_name='UUID')),
-                ('key', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=500)),
+                ('key', openedx_learning.lib.fields.case_sensitive_char_field(max_length=500)),
                 ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])),
                 ('created_by', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)),
                 ('learning_package', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='publishable_entities', to='oel_publishing.learningpackage')),
@@ -56,7 +56,7 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True, verbose_name='UUID')),
-                ('title', openedx_learning.lib.fields.MultiCollationCharField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, default='', max_length=500)),
+                ('title', openedx_learning.lib.fields.case_insensitive_char_field(blank=True, default='', max_length=500)),
                 ('version_num', models.PositiveIntegerField(validators=[django.core.validators.MinValueValidator(1)])),
                 ('created', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])),
                 ('created_by', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)),
@@ -72,7 +72,7 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True, verbose_name='UUID')),
-                ('message', openedx_learning.lib.fields.MultiCollationCharField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, default='', max_length=500)),
+                ('message', openedx_learning.lib.fields.case_insensitive_char_field(blank=True, default='', max_length=500)),
                 ('published_at', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])),
                 ('learning_package', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='oel_publishing.learningpackage')),
                 ('published_by', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)),

openedx_learning/apps/authoring/publishing/migrations/0002_alter_learningpackage_key_and_more.py

@@ -15,11 +15,11 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='learningpackage',
             name='key',
-            field=openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_column='_key', max_length=500),
+            field=openedx_learning.lib.fields.case_sensitive_char_field(db_column='_key', max_length=500),
         ),
         migrations.AlterField(
             model_name='publishableentity',
             name='key',
-            field=openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, db_column='_key', max_length=500),
+            field=openedx_learning.lib.fields.case_sensitive_char_field(db_column='_key', max_length=500),
         ),
     ]

openedx_learning/lib/fields.py

@@ -36,20 +36,8 @@ def create_hash_digest(data_bytes: bytes) -> str:
     return hashlib.blake2b(data_bytes, digest_size=20).hexdigest()
 
 
-def case_insensitive_char_field(**kwargs) -> MultiCollationCharField:
-    """
-    Return a case-insensitive ``MultiCollationCharField``.
-
-    This means that entries will sort in a case-insensitive manner, and that
-    unique indexes will be case insensitive, e.g. you would not be able to
-    insert "abc" and "ABC" into the same table field if you put a unique index
-    on this field.
-
-    You may override any argument that you would normally pass into
-    ``MultiCollationCharField`` (which is itself a subclass of ``CharField``).
-    """
-    # Set our default arguments
-    final_kwargs = {
+def default_case_insensitive_collations_args(**kwargs):
+    return {
         "null": False,
         "db_collations": {
             "sqlite": "NOCASE",
@@ -67,11 +55,40 @@ def case_insensitive_char_field(**kwargs) -> MultiCollationCharField:
             # This gives us behavior similar to MySQL's utf8mb4_unicode_ci.
             "postgresql": "case_insensitive",
         },
+        **kwargs,
     }
-    # Override our defaults with whatever is passed in.
-    final_kwargs.update(kwargs)
 
-    return MultiCollationCharField(**final_kwargs)
+
+def default_case_sensitive_collations_args(**kwargs):
+    return {
+        "null": False,
+        "db_collations": {
+            "sqlite": "BINARY",
+            "mysql": "utf8mb4_bin",
+            # PostgreSQL: Using "C" collation for case-sensitive, byte-order comparisons.
+            # This is the fastest collation and provides strict case-sensitive matching
+            # similar to MySQL's utf8mb4_bin and SQLite's BINARY.
+            # The "C" collation is always available in PostgreSQL and doesn't depend on
+            # locale settings.
+            "postgresql": "C",
+        },
+        **kwargs,
+    }
+
+
+def case_insensitive_char_field(**kwargs) -> MultiCollationCharField:
+    """
+    Return a case-insensitive ``MultiCollationCharField``.
+
+    This means that entries will sort in a case-insensitive manner, and that
+    unique indexes will be case insensitive, e.g. you would not be able to
+    insert "abc" and "ABC" into the same table field if you put a unique index
+    on this field.
+
+    You may override any argument that you would normally pass into
+    ``MultiCollationCharField`` (which is itself a subclass of ``CharField``).
+    """
+    return MultiCollationCharField(**default_case_insensitive_collations_args(**kwargs))
 
 
 def case_sensitive_char_field(**kwargs) -> MultiCollationCharField:
@@ -86,24 +103,27 @@ def case_sensitive_char_field(**kwargs) -> MultiCollationCharField:
     You may override any argument that you would normally pass into
     ``MultiCollationCharField`` (which is itself a subclass of ``CharField``).
     """
-    # Set our default arguments
-    final_kwargs = {
-        "null": False,
-        "db_collations": {
-            "sqlite": "BINARY",
-            "mysql": "utf8mb4_bin",
-            # PostgreSQL: Using "C" collation for case-sensitive, byte-order comparisons.
-            # This is the fastest collation and provides strict case-sensitive matching
-            # similar to MySQL's utf8mb4_bin and SQLite's BINARY.
-            # The "C" collation is always available in PostgreSQL and doesn't depend on
-            # locale settings.
-            "postgresql": "C",
-        },
-    }
-    # Override our defaults with whatever is passed in.
-    final_kwargs.update(kwargs)
+    return MultiCollationCharField(**default_case_sensitive_collations_args(**kwargs))
 
-    return MultiCollationCharField(**final_kwargs)
+
+def case_insensitive_text_field(**kwargs) -> MultiCollationTextField:
+    """
+    Return a case-insensitive ``MultiCollationTextField``.
+
+    You may override any argument that you would normally pass into
+    ``MultiCollationTextField`` (which is itself a subclass of ``TextField``).
+    """
+    return MultiCollationTextField(**default_case_insensitive_collations_args(**kwargs))
+
+
+def case_sensitive_text_field(**kwargs) -> MultiCollationTextField:
+    """
+    Return a case-sensitive ``MultiCollationTextField``.
+
+    You may override any argument that you would normally pass into
+    ``MultiCollationTextField`` (which is itself a subclass of ``TextField``).
+    """
+    return MultiCollationTextField(**default_case_sensitive_collations_args(**kwargs))
 
 
 def immutable_uuid_field() -> models.UUIDField: