Merge pull request #695 from open-craft/rpenido/navin/component-colle…

…ction-api-fix-meilisearch fix: circuvent meilisearch bug with empty objects
open-craft · Oct 15, 2024 · 557b176 · 557b176
2 parents c4ce75f + 4248639
commit 557b176
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/openedx/core/djangoapps/content/search/documents.py b/openedx/core/djangoapps/content/search/documents.py
@@ -267,6 +267,13 @@ def _collections_for_content_object(object_id: UsageKey | LearningContextKey) ->
         }
 
     """
+    result = {
+        Fields.collections: {
+            Fields.collections_display_name: [],
+            Fields.collections_key: [],
+        }
+    }
+
     # Gather the collections associated with this object
     collections = None
     try:
@@ -279,14 +286,8 @@ def _collections_for_content_object(object_id: UsageKey | LearningContextKey) ->
         log.warning(f"No component found for {object_id}")
 
     if not collections:
-        return {Fields.collections: {}}
+        return result
 
-    result = {
-        Fields.collections: {
-            Fields.collections_display_name: [],
-            Fields.collections_key: [],
-        }
-    }
     for collection in collections:
         result[Fields.collections][Fields.collections_display_name].append(collection.title)
         result[Fields.collections][Fields.collections_key].append(collection.key)

diff --git a/openedx/core/djangoapps/content/search/tests/test_api.py b/openedx/core/djangoapps/content/search/tests/test_api.py
@@ -219,10 +219,10 @@ def test_reindex_meilisearch(self, mock_meilisearch):
         doc_vertical["tags"] = {}
         doc_problem1 = copy.deepcopy(self.doc_problem1)
         doc_problem1["tags"] = {}
-        doc_problem1["collections"] = {}
+        doc_problem1["collections"] = {'display_name': [], 'key': []}
         doc_problem2 = copy.deepcopy(self.doc_problem2)
         doc_problem2["tags"] = {}
-        doc_problem2["collections"] = {}
+        doc_problem2["collections"] = {'display_name': [], 'key': []}
         doc_collection = copy.deepcopy(self.collection_dict)
         doc_collection["tags"] = {}
 
@@ -263,7 +263,7 @@ def test_reindex_meilisearch_library_block_error(self, mock_meilisearch):
         doc_vertical["tags"] = {}
         doc_problem2 = copy.deepcopy(self.doc_problem2)
         doc_problem2["tags"] = {}
-        doc_problem2["collections"] = {}
+        doc_problem2["collections"] = {'display_name': [], 'key': []}
 
         orig_from_component = library_api.LibraryXBlockMetadata.from_component
 
@@ -662,7 +662,7 @@ def test_delete_collection(self, mock_meilisearch):
 
         doc_problem_without_collection = {
             "id": self.doc_problem1["id"],
-            "collections": {},
+            "collections": {'display_name': [], 'key': []},
         }
 
         # Should delete the collection document