refactor: no, really, changing the migrations now

Author: ormsbee

openedx_learning/apps/authoring/publishing/migrations/0006_draftchangelog.py

@@ -0,0 +1,68 @@
+# Generated by Django 4.2.18 on 2025-03-28 02:21
+
+import uuid
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+import openedx_learning.lib.validators
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('oel_publishing', '0005_alter_entitylistrow_options'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='DraftChangeLog',
+            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')),
+                ('changed_at', models.DateTimeField(validators=[openedx_learning.lib.validators.validate_utc_datetime])),
+                ('changed_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, to='oel_publishing.learningpackage')),
+            ],
+            options={
+                'verbose_name': 'Draft Change Log',
+                'verbose_name_plural': 'Draft Change Logs',
+            },
+        ),
+        migrations.CreateModel(
+            name='DraftChangeLogRecord',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('draft_change_log', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='changes', to='oel_publishing.draftchangelog')),
+                ('entity', models.ForeignKey(on_delete=django.db.models.deletion.RESTRICT, to='oel_publishing.publishableentity')),
+                ('new_version', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.RESTRICT, to='oel_publishing.publishableentityversion')),
+                ('old_version', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.RESTRICT, related_name='+', to='oel_publishing.publishableentityversion')),
+            ],
+            options={
+                'verbose_name': 'Draft Log',
+                'verbose_name_plural': 'Draft Log',
+            },
+        ),
+        migrations.CreateModel(
+            name='DraftSideEffect',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('cause', models.ForeignKey(on_delete=django.db.models.deletion.RESTRICT, related_name='causes', to='oel_publishing.draftchangelogrecord')),
+                ('effect', models.ForeignKey(on_delete=django.db.models.deletion.RESTRICT, related_name='caused_by', to='oel_publishing.draftchangelogrecord')),
+            ],
+        ),
+        migrations.AddConstraint(
+            model_name='draftsideeffect',
+            constraint=models.UniqueConstraint(fields=('cause', 'effect'), name='oel_pub_dse_uniq_c_e'),
+        ),
+        migrations.AddIndex(
+            model_name='draftchangelogrecord',
+            index=models.Index(fields=['entity', '-draft_change_log'], name='oel_dlr_idx_entity_rdcl'),
+        ),
+        migrations.AddConstraint(
+            model_name='draftchangelogrecord',
+            constraint=models.UniqueConstraint(fields=('draft_change_log', 'entity'), name='oel_dlr_uniq_dcl'),
+        ),
+    ]

openedx_learning/apps/authoring/publishing/migrations/0007_bootstrap_draftchangelog.py

@@ -0,0 +1,94 @@
+"""
+Bootstrap DraftChangeLogs
+
+DraftChangeLog and DraftChangeLogRecord are being introduced after Drafts, so
+we're going to retroactively make entries for all the changes that were in our
+Learning Packages.
+
+This migration will try to reconstruct create, edit, reset-to-published, and
+delete operations, but it won't be fully accurate because we only have the
+create dates of the versions and the current state of active Drafts to go on.
+This means we won't accurately capture when things were deleted and then reset,
+or when reset and then later edited. We're also missing the user for a number of
+these operations, so we'll add those with null created_by entries. Addressing
+these gaps is a big part of why we created DraftChangeLogs in the first place.
+"""
+# Generated by Django 4.2.18 on 2025-03-13 10:29
+import logging
+from datetime import datetime, timezone
+
+from django.db import migrations
+
+logger = logging.getLogger(__name__)
+
+
+def bootstrap_draft_change_logs(apps, schema_editor):
+    """
+    Create a fake DraftChangeSet that encompasses the state of current Drafts.
+    """
+    LearningPackage = apps.get_model("oel_publishing", "LearningPackage")
+    PublishableEntityVersion = apps.get_model("oel_publishing", "PublishableEntityVersion")
+
+    Draft = apps.get_model("oel_publishing", "Draft")
+    DraftChangeLogRecord = apps.get_model("oel_publishing", "DraftChangeLogRecord")
+    DraftChangeLog = apps.get_model("oel_publishing", "DraftChangeLog")
+    now = datetime.now(tz=timezone.utc)
+
+    for learning_package in LearningPackage.objects.all().order_by("key"):
+        logger.info(f"Creating bootstrap DraftChangeLogs for {learning_package.key}")
+        pub_ent_versions = PublishableEntityVersion.objects.filter(
+                               entity__learning_package=learning_package
+                           ).select_related("entity")
+
+        # First cycle though all the simple create/edit operations...
+        last_version_seen = {}  # PublishableEntity.id -> PublishableEntityVersion.id
+        for pub_ent_version in pub_ent_versions.order_by("pk"):
+            draft_change_log = DraftChangeLog.objects.create(
+                learning_package=learning_package,
+                changed_at=pub_ent_version.created,
+                changed_by=pub_ent_version.created_by,
+            )
+            DraftChangeLogRecord.objects.create(
+                draft_change_log=draft_change_log,
+                entity=pub_ent_version.entity,
+                old_version_id=last_version_seen.get(pub_ent_version.entity.id),
+                new_version_id=pub_ent_version.id,
+            )
+            last_version_seen[pub_ent_version.entity.id] = pub_ent_version.id
+
+        # Now that we've created change sets for create/edit operations, we look
+        # at the latest state of the Draft model in order to determine whether
+        # we need to apply deletes or resets.
+        for draft in Draft.objects.filter(entity__learning_package=learning_package).order_by("entity_id"):
+            last_version_id = last_version_seen.get(draft.entity_id)
+            if draft.version_id == last_version_id:
+                continue
+            # We don't really know who did this or when, so we use None and now.
+            draft_change_log = DraftChangeLog.objects.create(
+                learning_package=learning_package,
+                changed_at=now,
+                changed_by=None,
+            )
+            DraftChangeLogRecord.objects.create(
+                draft_change_log=draft_change_log,
+                entity_id=draft.entity_id,
+                old_version_id=last_version_id,
+                new_version_id=draft.version_id,
+            )
+
+
+def delete_draft_change_logs(apps, schema_editor):
+    logger.info(f"Deleting all DraftChangeLogs (reverse migration)")
+    DraftChangeLog = apps.get_model("oel_publishing", "DraftChangeLog")
+    DraftChangeLog.objects.all().delete()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oel_publishing', '0006_draftchangelog'),
+    ]
+
+    operations = [
+        migrations.RunPython(bootstrap_draft_change_logs, reverse_code=delete_draft_change_logs)
+    ]