feat: Send LIBRARY_CONTAINER_UPDATED signal when updating component of container

Author: ChrisChV

openedx/core/djangoapps/content_libraries/api/libraries.py

@@ -904,6 +904,18 @@ def set_library_block_olx(usage_key: LibraryUsageLocatorV2, new_olx_str: str) ->
         )
     )
 
+    # For each container, trigger LIBRARY_CONTAINER_UPDATED signal and set background=True to trigger
+    # container indexing asynchronously.
+    affected_containers = lib_api.get_containers_contains_component(usage_key)
+    for container in affected_containers:
+        LIBRARY_CONTAINER_UPDATED.send_event(
+            library_container=LibraryContainerData(
+                library_key=usage_key.lib_key,
+                container_key=container.container_pk,
+                background=True,
+            )
+        )
+
     return new_component_version
 
 

openedx/core/djangoapps/content_libraries/library_context.py

@@ -6,8 +6,8 @@
 from django.core.exceptions import PermissionDenied
 from rest_framework.exceptions import NotFound
 
-from openedx_events.content_authoring.data import LibraryBlockData
-from openedx_events.content_authoring.signals import LIBRARY_BLOCK_UPDATED
+from openedx_events.content_authoring.data import LibraryBlockData, LibraryContainerData
+from openedx_events.content_authoring.signals import LIBRARY_BLOCK_UPDATED, LIBRARY_CONTAINER_UPDATED
 from opaque_keys.edx.keys import UsageKeyV2
 from opaque_keys.edx.locator import LibraryUsageLocatorV2, LibraryLocatorV2
 from openedx_learning.api import authoring as authoring_api
@@ -114,3 +114,19 @@ def send_block_updated_event(self, usage_key: UsageKeyV2):
                 usage_key=usage_key,
             )
         )
+
+    def send_container_updated_events(self, usage_key: UsageKeyV2):
+        """
+        Send "container updated" events for containers that contains the library block
+        with the given usage_key.
+        """
+        assert isinstance(usage_key, LibraryUsageLocatorV2)
+        affected_containers = api.get_containers_contains_component(usage_key)
+        for container in affected_containers:
+            LIBRARY_CONTAINER_UPDATED.send_event(
+                library_container=LibraryContainerData(
+                    library_key=usage_key.lib_key,
+                    container_key=container.container_pk,
+                    background=True,
+                )
+            )

openedx/core/djangoapps/content_libraries/tests/test_api.py

@@ -812,14 +812,8 @@ def test_get_containers_contains_component(self):
         assert html_block_containers[1].container_key == self.unit2.container_key
 
 
-    def test_call_container_update_signal_when_delete_component(self):
-        container_update_event_receiver = mock.Mock()
-        LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver)
-
-        api.delete_library_block(self.html_block_usage_key)
-
-        assert container_update_event_receiver.call_count == 2
-
+    def _validate_calls_of_html_block(self, event_mock):
+        assert event_mock.call_count == 2
         self.assertDictContainsSubset(
             {
                 "signal": LIBRARY_CONTAINER_UPDATED,
@@ -830,7 +824,7 @@ def test_call_container_update_signal_when_delete_component(self):
                     background=True,
                 )
             },
-            container_update_event_receiver.call_args_list[0].kwargs,
+            event_mock.call_args_list[0].kwargs,
         )
         self.assertDictContainsSubset(
             {
@@ -842,5 +836,29 @@ def test_call_container_update_signal_when_delete_component(self):
                     background=True,
                 )
             },
-            container_update_event_receiver.call_args_list[1].kwargs,
+            event_mock.call_args_list[1].kwargs,
         )
+
+    def test_call_container_update_signal_when_delete_component(self):
+        container_update_event_receiver = mock.Mock()
+        LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver)
+
+        api.delete_library_block(self.html_block_usage_key)
+        self._validate_calls_of_html_block(container_update_event_receiver)
+        
+
+    def test_call_container_update_signal_when_update_olx(self):
+        block_olx = "<html><b>Hello world!</b></html>"
+        container_update_event_receiver = mock.Mock()
+        LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver)
+
+        self._set_library_block_olx(self.html_block_usage_key, block_olx)
+        self._validate_calls_of_html_block(container_update_event_receiver)
+
+    def test_call_container_update_signal_when_update_component(self):
+        block_olx = "<html><b>Hello world!</b></html>"
+        container_update_event_receiver = mock.Mock()
+        LIBRARY_CONTAINER_UPDATED.connect(container_update_event_receiver)
+
+        self._set_library_block_fields(self.html_block_usage_key, {"data": block_olx, "metadata": {}})
+        self._validate_calls_of_html_block(container_update_event_receiver)

openedx/core/djangoapps/xblock/learning_context/learning_context.py

@@ -76,3 +76,11 @@ def send_block_updated_event(self, usage_key):
 
         usage_key: the UsageKeyV2 subclass used for this learning context
         """
+
+    def send_container_updated_events(self, usage_key):
+        """
+        Send "container updated" events for containers that contains the block with
+        the given usage_key in this context.
+
+        usage_key: the UsageKeyV2 subclass used for this learning context
+        """

openedx/core/djangoapps/xblock/runtime/learning_core_runtime.py

@@ -317,6 +317,7 @@ def save_block(self, block):
         # Signal that we've modified this block
         learning_context = get_learning_context_impl(usage_key)
         learning_context.send_block_updated_event(usage_key)
+        learning_context.send_container_updated_events(usage_key)
 
     def _get_component_from_usage_key(self, usage_key):
         """