Add search index support check in search indexes

Author: WaVEV

django_mongodb_backend/indexes.py

@@ -1,7 +1,7 @@
 import itertools
 from collections import defaultdict
 
-from django.core.checks import Error
+from django.core.checks import Error, Warning
 from django.db import NotSupportedError
 from django.db.models import DecimalField, FloatField, Index
 from django.db.models.lookups import BuiltinLookup
@@ -107,6 +107,23 @@ def where_node_idx(self, compiler, connection):
 
 class SearchIndex(Index):
     suffix = "six"
+    _error_id_prefix = "django_mongodb_backend.indexes.SearchIndex"
+
+    def check(self, model, connection):
+        errors = []
+        if not connection.features.supports_search_indexes:
+            errors.append(
+                Warning(
+                    "This version of MongoDB does not support search indexes.",
+                    hint=(
+                        "The index won't be created. Silence this warning if you "
+                        "don't care about it."
+                    ),
+                    obj=self,
+                    id=f"{self._error_id_prefix}.W001",
+                )
+            )
+        return errors
 
     # Maps Django internal type to atlas search index type.
     # Reference: https://www.mongodb.com/docs/atlas/atlas-search/define-field-mappings/#data-types
@@ -144,14 +161,14 @@ def get_pymongo_index_model(
 class VectorSearchIndex(SearchIndex):
     suffix = "vsi"
     ALLOWED_SIMILARITY_FUNCTIONS = frozenset(("euclidean", "cosine", "dotProduct"))
+    _error_id_prefix = "django_mongodb_backend.indexes.VectorSearchIndex"
 
     def __init__(self, *expressions, similarities="cosine", **kwargs):
         super().__init__(*expressions, **kwargs)
         self.similarities = similarities
 
     def check(self, model, connection):
-        errors = []
-        error_id_prefix = "django_mongodb_backend.indexes.VectorSearchIndex"
+        errors = super().check(model, connection)
         similarities = (
             self.similarities if isinstance(self.similarities, list) else [self.similarities]
         )
@@ -162,7 +179,7 @@ def check(self, model, connection):
                         f"{func} isn't a valid similarity function, options "
                         f"are {', '.join(sorted(self.ALLOWED_SIMILARITY_FUNCTIONS))}",
                         obj=self,
-                        id=f"{error_id_prefix}.E004",
+                        id=f"{self._error_id_prefix}.E004",
                     )
                 )
         for field_name, _ in self.fields_orders:
@@ -175,15 +192,15 @@ def check(self, model, connection):
                         Error(
                             "Atlas vector search requires size.",
                             obj=self,
-                            id=f"{error_id_prefix}.E001",
+                            id=f"{self._error_id_prefix}.E001",
                         )
                     )
                 if not isinstance(field_.base_field, FloatField | DecimalField):
                     errors.append(
                         Error(
                             "Base type must be Float or Decimal.",
                             obj=self,
-                            id=f"{error_id_prefix}.E002",
+                            id=f"{self._error_id_prefix}.E002",
                         )
                     )
             else:
@@ -197,7 +214,7 @@ def check(self, model, connection):
                         Error(
                             f"Unsupported filter of type {field_.get_internal_type()}.",
                             obj=self,
-                            id="django_mongodb_backend.indexes.VectorSearchIndex.E003",
+                            id=f"{self._error_id_prefix}.E003",
                         )
                     )
         return errors

tests/system_checks/tests.py

@@ -1,19 +1,50 @@
 from django.core import checks
 from django.db import models
-from django.test import SimpleTestCase
+from django.test import TestCase, skipIfDBFeature, skipUnlessDBFeature
 from django.test.utils import (
     isolate_apps,
     override_system_checks,
 )
 
 from django_mongodb_backend.checks import check_vector_search_indexes
 from django_mongodb_backend.fields import ArrayField
-from django_mongodb_backend.indexes import VectorSearchIndex
+from django_mongodb_backend.indexes import SearchIndex, VectorSearchIndex
 
 
+@skipIfDBFeature("supports_search_indexes")
 @isolate_apps("system_checks", attr_name="apps")
 @override_system_checks([check_vector_search_indexes])
-class InvalidSearchIndexesTest(SimpleTestCase):
+class InvalidSearchIndexesTest(TestCase):
+    def test_search_requires_search_index_support(self):
+        class Article(models.Model):
+            title = models.CharField(max_length=10)
+
+            class Meta:
+                indexes = [
+                    SearchIndex(fields=["title"]),
+                ]
+
+        errors = checks.run_checks(app_configs=self.apps.get_app_configs(), databases={"default"})
+        self.assertEqual(
+            errors,
+            [
+                checks.Warning(
+                    "This version of MongoDB does not support search indexes.",
+                    hint=(
+                        "The index won't be created. Silence this warning if you "
+                        "don't care about it."
+                    ),
+                    obj=Article._meta.indexes[0],
+                    id="django_mongodb_backend.indexes.SearchIndex.W001",
+                )
+            ],
+        )
+
+
+@skipUnlessDBFeature("supports_search_indexes")
+@isolate_apps("system_checks", attr_name="apps")
+@override_system_checks([check_vector_search_indexes])
+class InvalidVectorSearchIndexesTest(TestCase):
     def test_vectorsearch_requires_size(self):
         class Article(models.Model):
             title_embedded = ArrayField(models.FloatField())