fixup! feat: Adds a way to find the difference in Meiliseach state and come up with a migration plan and configuration plan depending on the state. This introduces a mechanism it or a drift engine which drill down the Meiliseach configuration and figures out what has changed:

Author: farhaanbukhsh

openedx/core/djangoapps/content/search/api.py

@@ -12,7 +12,7 @@
 from functools import wraps
 from typing import Callable, Generator, cast  # noqa: UP035
 
-from attrs import define, field
+from attrs import define
 from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.core.cache import cache
@@ -383,13 +383,13 @@ class IndexDrift:
     """
 
     exists: bool
-    is_empty: bool | None = field(default=None)  # None if index doesn't exist
-    primary_key_correct: bool | None = field(default=None)  # None if index doesn't exist
-    distinct_attribute_match: bool | None = field(default=None)
-    filterable_attributes_match: bool | None = field(default=None)
-    searchable_attributes_match: bool | None = field(default=None)
-    sortable_attributes_match: bool | None = field(default=None)
-    ranking_rules_match: bool | None = field(default=None)
+    is_empty: bool | None = None  # None if index doesn't exist
+    primary_key_correct: bool | None = None  # None if index doesn't exist
+    distinct_attribute_match: bool | None = None
+    filterable_attributes_match: bool | None = None
+    searchable_attributes_match: bool | None = None
+    sortable_attributes_match: bool | None = None
+    ranking_rules_match: bool | None = None
 
     @property
     def is_settings_drifted(self) -> bool:
@@ -405,16 +405,6 @@ def is_settings_drifted(self) -> bool:
             )
         )
 
-    @property
-    def is_drifted(self) -> bool:
-        """True if settings are drifted OR primary key is incorrect."""
-        return self.is_settings_drifted or self.primary_key_correct is False
-
-    @property
-    def is_configured(self) -> bool:
-        """True if all settings match AND primary key is correct."""
-        return not self.is_drifted
-
 
 def _detect_index_drift(index_name: str) -> IndexDrift:
     """
@@ -527,7 +517,7 @@ def reconcile_index(
     if not drift.exists:
         status_cb("Studio search index not found. Creating and configuring...")
         reset_index(status_cb)
-        status_cb("Index created. Run ./manage.py cms reindex_studio to populate.")
+        status_cb("Index created. Run './manage.py cms' reindex_studio to populate.")
         return
 
     # CASE: Primary key mismatch (must recreate regardless of population state)
@@ -539,20 +529,20 @@ def reconcile_index(
                 f"PRIMARY KEY MISMATCH on populated index '{STUDIO_INDEX_NAME}'. "
                 "Index must be recreated (data loss is unavoidable for primary key changes)."
             )
-            warn_cb("Dropping and recreating index. Repopulate with: ./manage.py cms reindex_studio")
+            warn_cb("Dropping and recreating index. Repopulate with: './manage.py cms' reindex_studio")
         reset_index(status_cb)
-        warn_cb("Index recreated empty. Run ./manage.py cms reindex_studio to repopulate.")
+        warn_cb("Index recreated empty. Run './manage.py cms' reindex_studio to repopulate.")
         return
 
     # CASE: Index empty
     if drift.is_empty:
         if drift.is_settings_drifted:
             status_cb("Empty index has drifted settings. Reconfiguring...")
             _apply_settings_with_waits(STUDIO_INDEX_NAME, status_cb)
-            status_cb("Reconfigured. Run ./manage.py cms reindex_studio to populate.")
+            status_cb("Reconfigured. Run './manage.py cms' reindex_studio to populate.")
         else:
             status_cb(
-                "Index exists and is correctly configured but empty. Run ./manage.py cms reindex_studio to populate."
+                "Index exists and is correctly configured but empty. Run './manage.py cms' reindex_studio to populate."
             )
         return
 
@@ -573,7 +563,7 @@ def reconcile_index(
         _apply_settings_with_waits(STUDIO_INDEX_NAME, status_cb)
         warn_cb(
             "Settings applied. Meilisearch will re-index documents in the background. "
-            "Consider running ./manage.py cms reindex_studio for a full rebuild "
+            "Consider running './manage.py cms' reindex_studio for a full rebuild "
             "if search quality is affected."
         )
     else:

openedx/core/djangoapps/content/search/tests/test_reconcile.py

@@ -1,6 +1,7 @@
 """
 Tests for the Meilisearch index reconciliation logic.
 """
+
 from __future__ import annotations
 
 from unittest.mock import MagicMock, Mock, patch
@@ -37,7 +38,7 @@
 class TestIndexDrift(TestCase):
     """Tests for the IndexDrift dataclass."""
 
-    def test_not_drifted_when_all_match(self):
+    def test_all_fields_match(self):
         drift = IndexDrift(
             exists=True,
             is_empty=False,
@@ -48,9 +49,15 @@ def test_not_drifted_when_all_match(self):
             sortable_attributes_match=True,
             ranking_rules_match=True,
         )
-        assert not drift.is_drifted
+        assert drift.exists is True
+        assert drift.is_empty is False
+        assert drift.primary_key_correct is True
+        assert drift.distinct_attribute_match is True
+        assert drift.filterable_attributes_match is True
+        assert drift.searchable_attributes_match is True
+        assert drift.sortable_attributes_match is True
+        assert drift.ranking_rules_match is True
         assert not drift.is_settings_drifted
-        assert drift.is_configured
 
     def test_settings_drifted_when_one_setting_false(self):
         drift = IndexDrift(
@@ -63,11 +70,11 @@ def test_settings_drifted_when_one_setting_false(self):
             sortable_attributes_match=True,
             ranking_rules_match=True,
         )
+        assert drift.primary_key_correct is True
+        assert drift.filterable_attributes_match is False
         assert drift.is_settings_drifted
-        assert drift.is_drifted
-        assert not drift.is_configured
 
-    def test_drifted_when_primary_key_wrong(self):
+    def test_primary_key_wrong_without_settings_drift(self):
         drift = IndexDrift(
             exists=True,
             is_empty=False,
@@ -78,16 +85,25 @@ def test_drifted_when_primary_key_wrong(self):
             sortable_attributes_match=True,
             ranking_rules_match=True,
         )
+        assert drift.primary_key_correct is False
+        assert drift.distinct_attribute_match is True
+        assert drift.filterable_attributes_match is True
+        assert drift.searchable_attributes_match is True
+        assert drift.sortable_attributes_match is True
+        assert drift.ranking_rules_match is True
         assert not drift.is_settings_drifted
-        assert drift.is_drifted
-        assert not drift.is_configured
 
-    def test_not_drifted_when_index_missing(self):
+    def test_missing_index_leaves_optional_fields_unset(self):
         drift = IndexDrift(exists=False)
-        # When index doesn't exist, settings fields are None, so is_settings_drifted is False
+        assert drift.exists is False
+        assert drift.is_empty is None
+        assert drift.primary_key_correct is None
+        assert drift.distinct_attribute_match is None
+        assert drift.filterable_attributes_match is None
+        assert drift.searchable_attributes_match is None
+        assert drift.sortable_attributes_match is None
+        assert drift.ranking_rules_match is None
         assert not drift.is_settings_drifted
-        # But is_drifted checks primary_key_correct is None (not False), so also not drifted
-        assert not drift.is_drifted
 
     def test_multiple_settings_drifted(self):
         drift = IndexDrift(
@@ -100,8 +116,12 @@ def test_multiple_settings_drifted(self):
             sortable_attributes_match=False,
             ranking_rules_match=True,
         )
+        assert drift.distinct_attribute_match is False
+        assert drift.filterable_attributes_match is False
+        assert drift.searchable_attributes_match is True
+        assert drift.sortable_attributes_match is False
+        assert drift.ranking_rules_match is True
         assert drift.is_settings_drifted
-        assert drift.is_drifted
 
 
 @skip_unless_cms
@@ -118,6 +138,7 @@ def setUp(self):
     def test_index_missing(self, mock_meilisearch):
         """When the index doesn't exist, returns exists=False with all other fields None."""
         from meilisearch.errors import MeilisearchApiError
+
         mock_meilisearch.return_value.get_index.side_effect = MeilisearchApiError(
             "Not found", Mock(text='{"code":"index_not_found"}')
         )
@@ -146,10 +167,14 @@ def test_all_settings_match(self, mock_meilisearch):
         drift = _detect_index_drift("test_index")
 
         assert drift.exists
-        assert not drift.is_empty
-        assert drift.primary_key_correct
-        assert not drift.is_drifted
-        assert drift.is_configured
+        assert drift.is_empty is False
+        assert drift.primary_key_correct is True
+        assert drift.distinct_attribute_match is True
+        assert drift.filterable_attributes_match is True
+        assert drift.searchable_attributes_match is True
+        assert drift.sortable_attributes_match is True
+        assert drift.ranking_rules_match is True
+        assert not drift.is_settings_drifted
 
     def test_filterable_attributes_mismatch(self, mock_meilisearch):
         """Detects when filterable attributes differ."""
@@ -212,7 +237,8 @@ def test_filterable_attributes_order_independent(self, mock_meilisearch):
         assert drift.filterable_attributes_match is True
         assert drift.searchable_attributes_match is True
         assert drift.sortable_attributes_match is True
-        assert not drift.is_drifted
+        assert drift.primary_key_correct is True
+        assert not drift.is_settings_drifted
 
     def test_primary_key_mismatch(self, mock_meilisearch):
         """Detects primary key mismatch."""
@@ -230,8 +256,9 @@ def test_primary_key_mismatch(self, mock_meilisearch):
 
         drift = _detect_index_drift("test_index")
 
+        assert drift.exists is True
+        assert drift.is_empty is False
         assert drift.primary_key_correct is False
-        assert drift.is_drifted
         # Settings themselves are fine
         assert not drift.is_settings_drifted
 
@@ -349,8 +376,7 @@ def test_index_empty_configured(self, mock_drift, mock_meilisearch):
         reconcile_index(status_cb=status_cb)
 
         status_cb.assert_any_call(
-            "Index exists and is correctly configured but empty. "
-            "Run ./manage.py cms reindex_studio to populate."
+            "Index exists and is correctly configured but empty. Run './manage.py cms' reindex_studio to populate."
         )
 
     @patch("openedx.core.djangoapps.content.search.api._detect_index_drift")
@@ -461,9 +487,7 @@ def test_index_populated_wrong_pk(self, mock_reset, mock_drift, mock_meilisearch
 
         mock_reset.assert_called_once()
         # Should warn about data loss
-        warn_cb.assert_any_call(
-            "Index recreated empty. Run ./manage.py cms reindex_studio to repopulate."
-        )
+        warn_cb.assert_any_call("Index recreated empty. Run './manage.py cms' reindex_studio to repopulate.")
 
     @override_settings(MEILISEARCH_ENABLED=False)
     def test_meilisearch_disabled(self, mock_meilisearch):
@@ -553,9 +577,7 @@ def test_signal_connected(self, mock_meilisearch):
 
         # Check that the handler is in the receivers
         receiver_funcs = [r[1]() for r in post_migrate.receivers if r[1]() is not None]
-        assert handler_fn in receiver_funcs, (
-            "handle_post_migrate should be connected to post_migrate signal"
-        )
+        assert handler_fn in receiver_funcs, "handle_post_migrate should be connected to post_migrate signal"
 
 
 @skip_unless_cms