Add an error message for fields that don't support queries

Author: timgraham

django_mongodb_backend/fields/encryption.py

@@ -32,6 +32,13 @@ def deconstruct(self):
  return name, path, args, kwargs
 
 
+class NoQueriesMixin:
+ def __init__(self, *args, **kwargs):
+ if "queries" in kwargs:
+ raise ValueError(f"{self.__class__.__name__} does not support the queries argument.")
+ super().__init__(*args, **kwargs)
+
+
 # Django fields
 class EncryptedBinaryField(EncryptedFieldMixin, models.BinaryField):
  pass
@@ -114,15 +121,17 @@ class EncryptedUUIDField(EncryptedFieldMixin, models.UUIDField):
 
 
 # MongoDB fields
-class EncryptedArrayField(EncryptedFieldMixin, ArrayField):
+class EncryptedArrayField(NoQueriesMixin, EncryptedFieldMixin, ArrayField):
  pass
 
 
-class EncryptedEmbeddedModelArrayField(EncryptedFieldMixin, EmbeddedModelArrayField):
+class EncryptedEmbeddedModelArrayField(
+ NoQueriesMixin, EncryptedFieldMixin, EmbeddedModelArrayField
+):
  pass
 
 
-class EncryptedEmbeddedModelField(EncryptedFieldMixin, EmbeddedModelField):
+class EncryptedEmbeddedModelField(NoQueriesMixin, EncryptedFieldMixin, EmbeddedModelField):
  pass
 
 

docs/ref/models/encrypted-fields.rst

@@ -72,6 +72,11 @@ for use with Queryable Encryption.
 | ``EncryptedObjectIdField`` | :class:`~.fields.ObjectIdField` |
 +----------------------------------------+------------------------------------------------------+
 
+These fields don't support the ``queries`` argument::
+- ``EncryptedArrayField``
+- ``EncryptedEmbeddedModelArrayField``
+- ``EncryptedEmbeddedModelField``
+
 The following fields are supported by Django MongoDB Backend but not supported
 by Queryable Encryption.
 

tests/encryption_/test_fields.py

@@ -4,7 +4,13 @@
 
 from bson import ObjectId
 
-from django_mongodb_backend.fields import EncryptedCharField, EncryptedIntegerField
+from django_mongodb_backend.fields import (
+ EncryptedArrayField,
+ EncryptedCharField,
+ EncryptedEmbeddedModelArrayField,
+ EncryptedEmbeddedModelField,
+ EncryptedIntegerField,
+)
 
 from .models import (
  Actor,
@@ -249,3 +255,15 @@ def test_deconstruct_preserves_queries_and_rewrites_path(self):
  self.assertEqual(new_field.queries, field.queries)
  self.assertIsNot(new_field, field)
  self.assertEqual(new_field.max_length, field.max_length)
+
+ def test_fields_without_queries(self):
+ """Some field types (array, object) can't be queried."""
+ for field in (
+ EncryptedArrayField,
+ EncryptedEmbeddedModelField,
+ EncryptedEmbeddedModelArrayField,
+ ):
+ with self.subTest(field=field):
+ msg = f"{field.__name__} does not support the queries argument."
+ with self.assertRaisesMessage(ValueError, msg):
+ field(Actor, queries={})