feat: emit a bulk change event when multiple entities are edited at once

Author: bradenmacdonald

src/openedx_content/applets/publishing/api.py

@@ -9,6 +9,7 @@
 
 from contextlib import nullcontext
 from datetime import datetime, timezone
+from functools import partial
 from typing import ContextManager, Optional, cast
 
 from django.core.exceptions import ObjectDoesNotExist
@@ -1419,5 +1420,6 @@ def bulk_draft_changes_for(
         changed_by=changed_by,
         exit_callbacks=[
             _create_side_effects_for_change_log,
+            partial(_emit_event_for_change_log, time_stamp=changed_at, user_id=changed_by),
         ]
     )

tests/openedx_content/applets/publishing/test_signals.py

@@ -25,7 +25,9 @@ def test_single_entity_changed() -> None:
     """
     learning_package = api.create_learning_package(key="lp1", title="Test LP 📦")
 
-    entity = api.create_publishable_entity(learning_package.id, key="entity1", created=now_time, created_by=None)
+    # Note: creating an entity does not emit any events until we create a version of that entity.
+    with capture_events(expected_count=0):
+        entity = api.create_publishable_entity(learning_package.id, key="entity1", created=now_time, created_by=None)
 
     NEW_VERSION_NUM = 3  # Just for fun let's use a version number other than 1
 
@@ -70,3 +72,56 @@ def test_single_entity_changed_abort() -> None:
                 raise DeliberateRollbackException()
         except DeliberateRollbackException:
             pass
+
+
+def test_multiple_entites_changed() -> None:
+    """
+    Test that LEARNING_PACKAGE_ENTITIES_CHANGED is emitted when we change
+    several publishable entities in a single edit.
+    """
+    learning_package = api.create_learning_package(key="lp1", title="Test LP 📦")
+
+    # Entity 1 will have no initial version:
+    entity1 = api.create_publishable_entity(learning_package.id, key="entity1", created=now_time, created_by=None)
+    # Entity 2 will have an initial version:
+    entity2 = api.create_publishable_entity(learning_package.id, key="entity2", created=now_time, created_by=None)
+    api.create_publishable_entity_version(
+        entity2.id, version_num=1, title="Entity 2 V1", created=now_time, created_by=None
+    )
+    # Entity 3 will have an initial version that later gets deleted:
+    entity3 = api.create_publishable_entity(learning_package.id, key="entity3", created=now_time, created_by=None)
+    api.create_publishable_entity_version(
+        entity3.id, version_num=1, title="Entity 3 V1", created=now_time, created_by=None
+    )
+
+    with capture_events(expected_count=1) as captured:
+        with api.bulk_draft_changes_for(learning_package.id, changed_by=None, changed_at=now_time) as draft_change_log:
+            # Create two versions of entity1:
+            api.create_publishable_entity_version(
+                entity1.id, version_num=1, title="Entity 1 V1", created=now_time, created_by=None
+            )
+            api.create_publishable_entity_version(
+                entity1.id, version_num=2, title="Entity 1 V2", created=now_time, created_by=None
+            )
+            # Create a version 2 of entity 2:
+            api.create_publishable_entity_version(
+                entity2.id, version_num=2, title="Entity 2 V2", created=now_time, created_by=None
+            )
+            # Delete entity 3:
+            api.set_draft_version(entity3.id, None, set_at=now_time, set_by=None)
+
+    event = captured[0]
+    assert event.signal is api.signals.LEARNING_PACKAGE_ENTITIES_CHANGED
+    assert event.kwargs["learning_package"].id == learning_package.id
+    assert event.kwargs["learning_package"].title == "Test LP 📦"
+    assert event.kwargs["changed_by"].user_id is None
+    assert event.kwargs["change_log"].draft_change_log_id == draft_change_log.id
+    assert event.kwargs["change_log"].changes == [
+        # Entity 1 jumps from no version to version 2:
+        api.signals.ChangeLogRecordData(entity_id=entity1.id, old_version=None, new_version=2),
+        # Entity 2 jumps v1 -> v2:
+        api.signals.ChangeLogRecordData(entity_id=entity2.id, old_version=1, new_version=2),
+        # Entity 3 gets deleted:
+        api.signals.ChangeLogRecordData(entity_id=entity3.id, old_version=1, new_version=None),
+    ]
+    assert event.kwargs["metadata"].time == now_time